codeant-ai-for-open-source[bot] commented on code in PR #39922: URL: https://github.com/apache/superset/pull/39922#discussion_r3482319702
########## superset/mcp_service/chart/plugins/handlebars.py: ########## @@ -0,0 +1,193 @@ +# 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. + +"""Handlebars chart type plugin.""" + +from __future__ import annotations + +from typing import Any + +from superset.mcp_service.chart.chart_utils import ( + _handlebars_chart_what, + _summarize_filters, + map_handlebars_config, +) +from superset.mcp_service.chart.plugin import BaseChartPlugin +from superset.mcp_service.chart.schemas import ColumnRef, HandlebarsChartConfig +from superset.mcp_service.chart.validation.dataset_validator import DatasetValidator +from superset.mcp_service.common.error_schemas import ChartGenerationError + + +class HandlebarsChartPlugin(BaseChartPlugin): + """Plugin for handlebars chart type (custom HTML template charts).""" + + chart_type = "handlebars" + display_name = "Handlebars (Custom Template)" + native_viz_types = { + "handlebars": "Custom Template Chart", + } + + def pre_validate( + self, + config: dict[str, Any], + ) -> ChartGenerationError | None: + if "handlebars_template" not in config: + return ChartGenerationError( + error_type="missing_handlebars_template", + message="Handlebars chart missing required field: handlebars_template", + details=( + "Handlebars charts require a 'handlebars_template' string " + "containing Handlebars HTML template markup" + ), + suggestions=[ + "Add 'handlebars_template' with a Handlebars HTML template", + "Data is available as {{data}} array in the template", + "Example: '<ul>{{#each data}}<li>{{this.name}}: " + "{{this.value}}</li>{{/each}}</ul>'", + ], + error_code="MISSING_HANDLEBARS_TEMPLATE", + ) + + template = config.get("handlebars_template") + if not isinstance(template, str) or not template.strip(): + return ChartGenerationError( + error_type="invalid_handlebars_template", + message="Handlebars template must be a non-empty string", + details=( + "The 'handlebars_template' field must be a non-empty string " + "containing valid Handlebars HTML template markup" + ), + suggestions=[ + "Ensure handlebars_template is a non-empty string", + "Example: '<ul>{{#each data}}<li>{{this.name}}</li>{{/each}}</ul>'", + ], + error_code="INVALID_HANDLEBARS_TEMPLATE", + ) + + query_mode = config.get("query_mode", "aggregate") + if query_mode not in ("aggregate", "raw"): + return ChartGenerationError( + error_type="invalid_query_mode", + message="Invalid query_mode for handlebars chart", + details="query_mode must be either 'aggregate' or 'raw'", + suggestions=[ + "Use 'aggregate' for aggregated data (default)", + "Use 'raw' for individual rows", + ], + error_code="INVALID_QUERY_MODE", + ) + + if query_mode == "raw" and not config.get("columns"): + return ChartGenerationError( + error_type="missing_raw_columns", + message="Handlebars chart in 'raw' mode requires 'columns'", + details=( + "When query_mode is 'raw', you must specify which columns " + "to include in the query results" + ), + suggestions=[ + "Add 'columns': [{'name': 'column_name'}] for raw mode", + "Or use query_mode='aggregate' with 'metrics' and optional 'groupby'", # noqa: E501 + ], + error_code="MISSING_RAW_COLUMNS", + ) + + if query_mode == "aggregate" and not config.get("metrics"): + return ChartGenerationError( + error_type="missing_aggregate_metrics", + message="Handlebars chart in 'aggregate' mode requires 'metrics'", + details=( + "When query_mode is 'aggregate' (default), you must specify " + "at least one metric with an aggregate function" + ), + suggestions=[ + "Add 'metrics': [{'name': 'column', 'aggregate': 'SUM'}]", + "Or use query_mode='raw' with 'columns' for individual rows", + ], + error_code="MISSING_AGGREGATE_METRICS", + ) + + return None + + def extract_column_refs(self, config: Any) -> list[ColumnRef]: + if not isinstance(config, HandlebarsChartConfig): + return [] + refs: list[ColumnRef] = [] + if config.columns: + refs.extend(config.columns) + if config.metrics: + refs.extend(config.metrics) + if config.groupby: + refs.extend(config.groupby) + 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_handlebars_config(config) + + def generate_name(self, config: Any, dataset_name: str | None = None) -> str: + what = _handlebars_chart_what(config) + context = _summarize_filters(getattr(config, "filters", None)) + return self._with_context(what, context) + + def resolve_viz_type(self, config: Any) -> str: + return "handlebars" + + def normalize_column_refs(self, config: Any, dataset_context: Any) -> Any: + config_dict = config.model_dump() + + def _norm_list(key: str) -> None: + if config_dict.get(key): + for col in config_dict[key]: + if col.get("saved_metric"): + col["name"] = DatasetValidator._get_canonical_metric_name( + col["name"], dataset_context + ) + else: + col["name"] = DatasetValidator._get_canonical_column_name( + col["name"], dataset_context + ) Review Comment: **Suggestion:** SQL-expression metrics can have `name=None` (the schema explicitly allows SQL metrics without a name), but this normalization code always calls canonical-name lookup on `col["name"]` unless `saved_metric` is set. For SQL metrics this triggers a `None.lower()` path in `DatasetValidator._get_canonical_column_name`, causing normalization to fail and silently fall back to unnormalized config. Skip normalization when `sql_expression` is present (as done in other chart plugins) before touching `name`. [null pointer] <details> <summary><b>Severity Level:</b> Major ⚠️</summary> ```mdx - ❌ Column normalization fails for handlebars SQL-expression metrics. - ⚠️ Handlebars charts use non-canonical column/metric name casing. ``` </details> <details> <summary><b>Steps of Reproduction ✅ </b></summary> ```mdx 1. Call the MCP `generate_chart` tool implemented in `superset/mcp_service/chart/tool/generate_chart.py`, passing a `GenerateChartRequest` (schema in `superset/mcp_service/chart/schemas.py:1890-2009`) whose `config` is a Handlebars chart with `chart_type="handlebars"` and `metrics=[{"sql_expression": "SUM(revenue)", "label": "Total Revenue"}]` (no `name` field). 2. Inside `generate_chart`, the request is validated via `ValidationPipeline.validate_request_with_warnings(request.model_dump())` at `superset/mcp_service/chart/tool/generate_chart.py:220-239`, which calls `SchemaValidator.validate_request` (`superset/mcp_service/chart/validation/schema_validator.py:20-43`) to build a typed `GenerateChartRequest` and `HandlebarsChartConfig`. 3. `ValidationPipeline.validate_request_with_warnings` then runs layer 4 column normalization by calling `_normalize_column_names` at `superset/mcp_service/chart/validation/pipeline.py:70-79`, which delegates to `DatasetValidator.normalize_column_names(config, request.dataset_id, dataset_context)` at `superset/mcp_service/chart/validation/dataset_validator.py:120-168`. 4. `DatasetValidator.normalize_column_names` looks up the `HandlebarsChartPlugin` from the registry and calls its `normalize_column_refs` (`superset/mcp_service/chart/plugins/handlebars.py:154-173`); for the SQL metric entry, `config.model_dump()` produces a dict where `sql_expression` is set and `name` is absent or `None`, so `_norm_list("metrics")` at lines 157-167 executes the `else` branch and calls `DatasetValidator._get_canonical_column_name(col["name"], dataset_context)` with `col["name"]` missing/None, causing a `KeyError` or `TypeError` in `_get_canonical_column_name` (`superset/mcp_service/chart/validation/dataset_validator.py:53-71` when it does `column_name.lower()`), which is caught by `_normalize_column_names` (`pipeline.py:93-113`), logging "Column name normalization failed" and returning the unnormalized request. ``` </details> [](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=cb7fb6bcf6894e2ab3680d1e6c82ed69&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset) [](https://app.codeant.ai/fix-in-ide?tool=vscode-claude&prompt_id=cb7fb6bcf6894e2ab3680d1e6c82ed69&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/handlebars.py **Line:** 160:167 **Comment:** *Null Pointer: SQL-expression metrics can have `name=None` (the schema explicitly allows SQL metrics without a name), but this normalization code always calls canonical-name lookup on `col["name"]` unless `saved_metric` is set. For SQL metrics this triggers a `None.lower()` path in `DatasetValidator._get_canonical_column_name`, causing normalization to fail and silently fall back to unnormalized config. Skip normalization when `sql_expression` is present (as done in other chart plugins) before touching `name`. 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=d2d85613dd0a2a551af428b94daadfa9d781ed615c5d306232de312640795499&reaction=like'>👍</a> | <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F39922&comment_hash=d2d85613dd0a2a551af428b94daadfa9d781ed615c5d306232de312640795499&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]
