codeant-ai-for-open-source[bot] commented on code in PR #39922: URL: https://github.com/apache/superset/pull/39922#discussion_r3398659228
########## superset/mcp_service/chart/plugins/pie.py: ########## @@ -0,0 +1,137 @@ +# 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. + +"""Pie chart type plugin.""" + +from __future__ import annotations + +from typing import Any + +from superset.mcp_service.chart.chart_utils import ( + _pie_chart_what, + _summarize_filters, + map_pie_config, +) +from superset.mcp_service.chart.plugin import BaseChartPlugin +from superset.mcp_service.chart.schemas import ColumnRef, PieChartConfig +from superset.mcp_service.chart.validation.dataset_validator import DatasetValidator +from superset.mcp_service.common.error_schemas import ChartGenerationError + + +class PieChartPlugin(BaseChartPlugin): + """Plugin for pie chart type.""" + + chart_type = "pie" + display_name = "Pie / Donut Chart" + native_viz_types = { + "pie": "Pie Chart", + } + + def pre_validate( + self, + config: dict[str, Any], + ) -> ChartGenerationError | None: + missing_fields = [] + + if "dimension" not in config: + missing_fields.append("'dimension' (category column for slices)") + if "metric" not in config: + missing_fields.append("'metric' (value metric for slice sizes)") + + if missing_fields: + return ChartGenerationError( + error_type="missing_pie_fields", + message=( + f"Pie chart missing required fields: {', '.join(missing_fields)}" + ), + details=( + "Pie charts require a dimension (categories) and a metric (values)" + ), + suggestions=[ + "Add 'dimension' field: {'name': 'category_column'}", + "Add 'metric' field: {'name': 'value_column', 'aggregate': 'SUM'}", + "Example: {'chart_type': 'pie', 'dimension': {'name': 'product'}, " + "'metric': {'name': 'revenue', 'aggregate': 'SUM'}}", + ], + error_code="MISSING_PIE_FIELDS", + ) + + return None + + def extract_column_refs(self, config: Any) -> list[ColumnRef]: + if not isinstance(config, PieChartConfig): + return [] + refs: list[ColumnRef] = [config.dimension, config.metric] + 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_pie_config(config) + + def generate_name(self, config: Any, dataset_name: str | None = None) -> str: + what = _pie_chart_what(config) + context = _summarize_filters(config.filters) + return self._with_context(what, context) + + def resolve_viz_type(self, config: Any) -> str: + return "pie" + + def normalize_column_refs(self, config: Any, dataset_context: Any) -> Any: + config_dict = config.model_dump() + + if config_dict.get("dimension"): + config_dict["dimension"]["name"] = ( + DatasetValidator._get_canonical_column_name( + config_dict["dimension"]["name"], dataset_context + ) + ) + if config_dict.get("metric"): + if config_dict["metric"].get("saved_metric"): + config_dict["metric"]["name"] = ( + DatasetValidator._get_canonical_metric_name( + config_dict["metric"]["name"], dataset_context + ) + ) + else: + config_dict["metric"]["name"] = ( + DatasetValidator._get_canonical_column_name( + config_dict["metric"]["name"], dataset_context + ) + ) Review Comment: **Suggestion:** This branch assumes every non-saved metric has a non-null `name`, but SQL-expression metrics are valid and intentionally have `name=None`. Calling canonical-name resolution with `None` triggers an AttributeError (`None.lower()`), causing normalization to fail and skip remaining normalization work for the request. [null pointer] <details> <summary><b>Severity Level:</b> Major ⚠️</summary> ```mdx - ❌ Pie charts with SQL metrics skip canonical name normalization. - ⚠️ generate_explore_link logs normalization errors for pie charts. - ⚠️ Case-mismatched columns persist in form_data generation. ``` </details> <details> <summary><b>Steps of Reproduction ✅ </b></summary> ```mdx 1. Invoke the MCP `generate_explore_link` tool (`superset/mcp_service/explore/tool/generate_explore_link.py:7-39, 180-38`) with `request.config.chart_type = "pie"` and `request.config.metric` defined as a SQL-expression `ColumnRef` (set `sql_expression` and `label`, omit `name` so it is `None`), while `dimension` is a normal column, as allowed by `PieChartConfig.metric: ColumnRef` (`superset/mcp_service/chart/schemas.py:283-297`). 2. Inside `generate_explore_link`, after basic setup, the code logs progress and then calls `DatasetValidator.normalize_column_names(config, request.dataset_id)` in a try/except block (`generate_explore_link.py:13-22`) to canonicalize column names before mapping to `form_data`. 3. `DatasetValidator.normalize_column_names` (`superset/mcp_service/chart/validation/dataset_validator.py:120-167`) resolves the `"pie"` plugin via the registry and invokes `PieChartPlugin.normalize_column_refs(config, dataset_context)` (`superset/mcp_service/chart/plugins/pie.py:97-120`), which operates on a `config_dict` from `config.model_dump()`, where the SQL-expression metric has `config_dict["metric"]["name"] = None` and `saved_metric` is `False`. 4. In `normalize_column_refs`, the metric branch at `pie.py:106-118` executes the `else` clause at lines 113-118 for this metric, passing `None` into `DatasetValidator._get_canonical_column_name()`. That method (`dataset_validator.py:53-84`) calls `column_name.lower()`, raising `AttributeError` for `None`; the exception is caught by `generate_explore_link`'s normalization try/except (`generate_explore_link.py:15-23`), which logs a "Column name normalization failed" warning and falls back to `normalized_config = config`, so no column names (including filters or dimension) in this pie chart are normalized. ``` </details> [Fix in Cursor](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=7ffcc91dfbeb4be6a7b01f4f1d1e967a&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset) | [Fix in VSCode Claude](https://app.codeant.ai/fix-in-ide?tool=vscode-claude&prompt_id=7ffcc91dfbeb4be6a7b01f4f1d1e967a&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset) *(Use Cmd/Ctrl + Click for best experience)* <details> <summary><b>Prompt for AI Agent 🤖 </b></summary> ```mdx This is a comment left during a code review. **Path:** superset/mcp_service/chart/plugins/pie.py **Line:** 113:118 **Comment:** *Null Pointer: This branch assumes every non-saved metric has a non-null `name`, but SQL-expression metrics are valid and intentionally have `name=None`. Calling canonical-name resolution with `None` triggers an AttributeError (`None.lower()`), causing normalization to fail and skip remaining normalization work for the request. Validate the correctness of the flagged issue. If correct, How can I resolve this? If you propose a fix, implement it and please make it concise. Once fix is implemented, also check other comments on the same PR, and ask user if the user wants to fix the rest of the comments as well. if said yes, then fetch all the comments validate the correctness and implement a minimal fix ``` </details> <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F39922&comment_hash=bcb7bdc05fcb28d7ccf69a220a6702f906b72dcadd3c29bdf0a076234497daf9&reaction=like'>👍</a> | <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F39922&comment_hash=bcb7bdc05fcb28d7ccf69a220a6702f906b72dcadd3c29bdf0a076234497daf9&reaction=dislike'>👎</a> -- 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]
