aminghadersohi commented on code in PR #39922:
URL: https://github.com/apache/superset/pull/39922#discussion_r3314803988
##########
superset/mcp_service/chart/validation/runtime/__init__.py:
##########
@@ -98,61 +85,28 @@ def validate_runtime_issues(
return True, None
@staticmethod
- def _validate_format_compatibility(config: XYChartConfig) -> List[str]:
- """Validate format-type compatibility."""
- warnings: List[str] = []
-
- try:
- # Import here to avoid circular imports
- from .format_validator import FormatTypeValidator
-
- is_valid, format_warnings = (
- FormatTypeValidator.validate_format_compatibility(config)
- )
- if format_warnings:
- warnings.extend(format_warnings)
- except ImportError:
- logger.warning("Format validator not available")
- except Exception as e:
- logger.warning("Format validation failed: %s", e)
-
- return warnings
-
- @staticmethod
- def _validate_cardinality(
- config: XYChartConfig, dataset_id: int | str
- ) -> Tuple[List[str], List[str]]:
- """Validate cardinality issues."""
- warnings: List[str] = []
- suggestions: List[str] = []
+ def _validate_plugin_runtime(
+ config: ChartConfig, dataset_id: int | str
+ ) -> List[str]:
+ """Delegate per-chart-type runtime warnings to the plugin registry.
+ Each plugin's get_runtime_warnings() method returns chart-type-specific
+ warnings (e.g. format/cardinality for XY). The registry dispatch
removes
+ the previous isinstance(config, XYChartConfig) hardcoding.
+ """
try:
- # Import here to avoid circular imports
- from .cardinality_validator import CardinalityValidator
-
- # Determine chart type for cardinality thresholds
- chart_type = config.kind if hasattr(config, "kind") else "default"
-
- # Check X-axis cardinality
- if config.x is None:
- return warnings, suggestions
- is_ok, cardinality_info = CardinalityValidator.check_cardinality(
- dataset_id=dataset_id,
- x_column=config.x.name,
- chart_type=chart_type,
- group_by_column=config.group_by[0].name if config.group_by
else None,
- )
-
- if not is_ok and cardinality_info:
- warnings.extend(cardinality_info.get("warnings", []))
- suggestions.extend(cardinality_info.get("suggestions", []))
-
- except ImportError:
- logger.warning("Cardinality validator not available")
- except Exception as e:
- logger.warning("Cardinality validation failed: %s", e)
-
- return warnings, suggestions
+ from superset.mcp_service.chart.registry import get_registry
+
+ chart_type = getattr(config, "chart_type", None)
+ if chart_type is None:
+ return []
+ plugin = get_registry().get(chart_type)
+ if plugin is None:
+ return []
+ return plugin.get_runtime_warnings(config, dataset_id)
+ except Exception as exc:
Review Comment:
By design — this is the safety net at the plugin dispatch boundary. is
user/plugin code that could raise any exception (plugin bugs, infrastructure
errors). The broad catch ensures runtime warning collection never blocks chart
generation. Same fail-closed pattern as `_ensure_plugins_loaded` and
`_is_plugin_enabled`.
##########
superset/mcp_service/chart/plugins/xy.py:
##########
@@ -0,0 +1,196 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+"""XY chart type plugin (line, bar, area, scatter)."""
+
+from __future__ import annotations
+
+import logging
+from typing import Any
+
+from superset.mcp_service.chart.chart_utils import (
+ _xy_chart_context,
+ _xy_chart_what,
+ map_xy_config,
+)
+from superset.mcp_service.chart.plugin import BaseChartPlugin
+from superset.mcp_service.chart.schemas import ColumnRef, XYChartConfig
+from superset.mcp_service.chart.validation.dataset_validator import
DatasetValidator
+from superset.mcp_service.chart.validation.runtime.cardinality_validator
import (
+ CardinalityValidator,
+)
+from superset.mcp_service.chart.validation.runtime.format_validator import (
+ FormatTypeValidator,
+)
+from superset.mcp_service.common.error_schemas import ChartGenerationError
+
+logger = logging.getLogger(__name__)
+
+
+class XYChartPlugin(BaseChartPlugin):
+ """Plugin for xy chart type (line, bar, area, scatter)."""
+
+ chart_type = "xy"
+ display_name = "Line / Bar / Area / Scatter Chart"
+ native_viz_types = {
+ "echarts_timeseries_line": "Line Chart",
+ "echarts_timeseries_bar": "Bar Chart",
+ "echarts_area": "Area Chart",
+ "echarts_timeseries_scatter": "Scatter Plot",
+ }
+
+ def pre_validate(
+ self,
+ config: dict[str, Any],
+ ) -> ChartGenerationError | None:
+ # x is optional — defaults to dataset's main_dttm_col in map_xy_config
+ if "y" not in config and "metrics" not in config:
+ return ChartGenerationError(
+ error_type="missing_xy_fields",
+ message="XY chart missing required field: 'y' (Y-axis
metrics)",
+ details=(
+ "XY charts require Y-axis (metrics) specifications. "
+ "X-axis is optional and defaults to the dataset's primary "
+ "datetime column when omitted."
+ ),
+ suggestions=[
+ "Add 'y' field: [{'name': 'metric_column', 'aggregate':
'SUM'}]",
+ "Example: {'chart_type': 'xy', 'x': {'name': 'date'}, "
+ "'y': [{'name': 'sales', 'aggregate': 'SUM'}]}",
+ ],
+ error_code="MISSING_XY_FIELDS",
+ )
+
+ if not isinstance(config.get("y", []), list):
+ return ChartGenerationError(
+ error_type="invalid_y_format",
+ message="Y-axis must be a list of metrics",
+ details="The 'y' field must be an array of metric
specifications",
+ suggestions=[
+ "Wrap Y-axis metric in array: 'y': [{'name': 'column', "
+ "'aggregate': 'SUM'}]",
+ "Multiple metrics supported: 'y': [metric1, metric2, ...]",
+ ],
+ error_code="INVALID_Y_FORMAT",
+ )
+
+ return None
+
+ def extract_column_refs(self, config: Any) -> list[ColumnRef]:
+ if not isinstance(config, XYChartConfig):
+ return []
+ refs: list[ColumnRef] = []
+ if config.x is not None:
+ refs.append(config.x)
+ refs.extend(config.y)
+ if config.group_by:
+ refs.extend(config.group_by)
+ if config.filters:
+ for f in config.filters:
+ refs.append(ColumnRef(name=f.column))
+ return refs
+
+ def to_form_data(
+ self, config: Any, dataset_id: int | str | None = None
+ ) -> dict[str, Any]:
+ return map_xy_config(config, dataset_id=dataset_id)
+
+ def normalize_column_refs(self, config: Any, dataset_context: Any) -> Any:
+ config_dict = config.model_dump()
+ get_canonical = DatasetValidator._get_canonical_column_name
+ get_canonical_metric = DatasetValidator._get_canonical_metric_name
+
+ if config_dict.get("x"):
+ config_dict["x"]["name"] = get_canonical(
+ config_dict["x"]["name"], dataset_context
+ )
+ for y_col in config_dict.get("y") or []:
+ if y_col.get("saved_metric"):
+ y_col["name"] = get_canonical_metric(y_col["name"],
dataset_context)
+ else:
+ y_col["name"] = get_canonical(y_col["name"], dataset_context)
+ for gb_col in config_dict.get("group_by") or []:
+ gb_col["name"] = get_canonical(gb_col["name"], dataset_context)
+
+ DatasetValidator._normalize_filters(config_dict, dataset_context)
+ return XYChartConfig.model_validate(config_dict)
+
+ def generate_name(self, config: Any, dataset_name: str | None = None) ->
str:
+ what = _xy_chart_what(config)
+ context = _xy_chart_context(config)
+ return self._with_context(what, context)
+
+ def resolve_viz_type(self, config: Any) -> str:
+ kind = getattr(config, "kind", "line")
+ return {
+ "line": "echarts_timeseries_line",
+ "bar": "echarts_timeseries_bar",
+ "area": "echarts_area",
+ "scatter": "echarts_timeseries_scatter",
+ }.get(kind, "echarts_timeseries_line")
+
+ def get_runtime_warnings(self, config: Any, dataset_id: int | str) ->
list[str]:
+ """Return format-compatibility and cardinality warnings for XY
charts."""
+ if not isinstance(config, XYChartConfig):
+ return []
+
+ warnings: list[str] = []
+
+ try:
+ _valid, format_warnings =
FormatTypeValidator.validate_format_compatibility(
+ config
+ )
+ if format_warnings:
+ warnings.extend(format_warnings)
+ except Exception as exc:
+ logger.warning("XY format validation failed: %s", exc)
+
+ try:
+ chart_kind = config.kind
+ group_by_col = config.group_by[0].name if config.group_by else None
+ if config.x is not None:
+ _ok, card_info = CardinalityValidator.check_cardinality(
+ dataset_id=dataset_id,
+ x_column=config.x.name,
+ chart_type=chart_kind,
+ group_by_column=group_by_col,
+ )
+ if not _ok and card_info:
+ warnings.extend(card_info.get("warnings", []))
+ warnings.extend(card_info.get("suggestions", []))
+ except Exception as exc:
Review Comment:
By design — `CardinalityValidator.check_cardinality()` performs database
queries and can raise SQLAlchemy errors, connection timeouts, or other
infrastructure exceptions that `ValueError`/`TypeError` would not catch.
Runtime warnings are optional and non-blocking; silently returning no warnings
is the correct failure mode here.
##########
superset/mcp_service/chart/plugins/xy.py:
##########
@@ -0,0 +1,196 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+"""XY chart type plugin (line, bar, area, scatter)."""
+
+from __future__ import annotations
+
+import logging
+from typing import Any
+
+from superset.mcp_service.chart.chart_utils import (
+ _xy_chart_context,
+ _xy_chart_what,
+ map_xy_config,
+)
+from superset.mcp_service.chart.plugin import BaseChartPlugin
+from superset.mcp_service.chart.schemas import ColumnRef, XYChartConfig
+from superset.mcp_service.chart.validation.dataset_validator import
DatasetValidator
+from superset.mcp_service.chart.validation.runtime.cardinality_validator
import (
+ CardinalityValidator,
+)
+from superset.mcp_service.chart.validation.runtime.format_validator import (
+ FormatTypeValidator,
+)
+from superset.mcp_service.common.error_schemas import ChartGenerationError
+
+logger = logging.getLogger(__name__)
+
+
+class XYChartPlugin(BaseChartPlugin):
+ """Plugin for xy chart type (line, bar, area, scatter)."""
+
+ chart_type = "xy"
+ display_name = "Line / Bar / Area / Scatter Chart"
+ native_viz_types = {
+ "echarts_timeseries_line": "Line Chart",
+ "echarts_timeseries_bar": "Bar Chart",
+ "echarts_area": "Area Chart",
+ "echarts_timeseries_scatter": "Scatter Plot",
+ }
+
+ def pre_validate(
+ self,
+ config: dict[str, Any],
+ ) -> ChartGenerationError | None:
+ # x is optional — defaults to dataset's main_dttm_col in map_xy_config
+ if "y" not in config and "metrics" not in config:
+ return ChartGenerationError(
+ error_type="missing_xy_fields",
+ message="XY chart missing required field: 'y' (Y-axis
metrics)",
+ details=(
+ "XY charts require Y-axis (metrics) specifications. "
+ "X-axis is optional and defaults to the dataset's primary "
+ "datetime column when omitted."
+ ),
+ suggestions=[
+ "Add 'y' field: [{'name': 'metric_column', 'aggregate':
'SUM'}]",
+ "Example: {'chart_type': 'xy', 'x': {'name': 'date'}, "
+ "'y': [{'name': 'sales', 'aggregate': 'SUM'}]}",
+ ],
+ error_code="MISSING_XY_FIELDS",
+ )
+
+ if not isinstance(config.get("y", []), list):
+ return ChartGenerationError(
+ error_type="invalid_y_format",
+ message="Y-axis must be a list of metrics",
+ details="The 'y' field must be an array of metric
specifications",
+ suggestions=[
+ "Wrap Y-axis metric in array: 'y': [{'name': 'column', "
+ "'aggregate': 'SUM'}]",
+ "Multiple metrics supported: 'y': [metric1, metric2, ...]",
+ ],
+ error_code="INVALID_Y_FORMAT",
+ )
+
+ return None
+
+ def extract_column_refs(self, config: Any) -> list[ColumnRef]:
+ if not isinstance(config, XYChartConfig):
+ return []
+ refs: list[ColumnRef] = []
+ if config.x is not None:
+ refs.append(config.x)
+ refs.extend(config.y)
+ if config.group_by:
+ refs.extend(config.group_by)
+ if config.filters:
+ for f in config.filters:
+ refs.append(ColumnRef(name=f.column))
+ return refs
+
+ def to_form_data(
+ self, config: Any, dataset_id: int | str | None = None
+ ) -> dict[str, Any]:
+ return map_xy_config(config, dataset_id=dataset_id)
+
+ def normalize_column_refs(self, config: Any, dataset_context: Any) -> Any:
+ config_dict = config.model_dump()
+ get_canonical = DatasetValidator._get_canonical_column_name
+ get_canonical_metric = DatasetValidator._get_canonical_metric_name
+
+ if config_dict.get("x"):
+ config_dict["x"]["name"] = get_canonical(
+ config_dict["x"]["name"], dataset_context
+ )
+ for y_col in config_dict.get("y") or []:
+ if y_col.get("saved_metric"):
+ y_col["name"] = get_canonical_metric(y_col["name"],
dataset_context)
+ else:
+ y_col["name"] = get_canonical(y_col["name"], dataset_context)
+ for gb_col in config_dict.get("group_by") or []:
+ gb_col["name"] = get_canonical(gb_col["name"], dataset_context)
+
+ DatasetValidator._normalize_filters(config_dict, dataset_context)
+ return XYChartConfig.model_validate(config_dict)
+
+ def generate_name(self, config: Any, dataset_name: str | None = None) ->
str:
+ what = _xy_chart_what(config)
+ context = _xy_chart_context(config)
+ return self._with_context(what, context)
+
+ def resolve_viz_type(self, config: Any) -> str:
+ kind = getattr(config, "kind", "line")
+ return {
+ "line": "echarts_timeseries_line",
+ "bar": "echarts_timeseries_bar",
+ "area": "echarts_area",
+ "scatter": "echarts_timeseries_scatter",
+ }.get(kind, "echarts_timeseries_line")
+
+ def get_runtime_warnings(self, config: Any, dataset_id: int | str) ->
list[str]:
+ """Return format-compatibility and cardinality warnings for XY
charts."""
+ if not isinstance(config, XYChartConfig):
+ return []
+
+ warnings: list[str] = []
+
+ try:
+ _valid, format_warnings =
FormatTypeValidator.validate_format_compatibility(
+ config
+ )
+ if format_warnings:
+ warnings.extend(format_warnings)
+ except Exception as exc:
+ logger.warning("XY format validation failed: %s", exc)
+
+ try:
+ chart_kind = config.kind
+ group_by_col = config.group_by[0].name if config.group_by else None
+ if config.x is not None:
+ _ok, card_info = CardinalityValidator.check_cardinality(
+ dataset_id=dataset_id,
+ x_column=config.x.name,
+ chart_type=chart_kind,
+ group_by_column=group_by_col,
+ )
+ if not _ok and card_info:
+ warnings.extend(card_info.get("warnings", []))
+ warnings.extend(card_info.get("suggestions", []))
+ except Exception as exc:
Review Comment:
By design — same as above. The cardinality check involves database queries
that can raise infrastructure exceptions beyond ValueError/TypeError.
Non-blocking safety net is correct here.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
