gabotorresruiz commented on code in PR #43268: URL: https://github.com/apache/superset/pull/43268#discussion_r3831813229
########## superset/mcp_service/chart/plugins/interactive_pivot.py: ########## @@ -0,0 +1,230 @@ +# 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. + +"""Preset AG Grid interactive pivot chart plugin.""" + +from __future__ import annotations + +from collections.abc import Mapping +from typing import Any, ClassVar + +from superset.extensions import feature_flag_manager +from superset.mcp_service.chart.chart_utils import ( + _add_adhoc_filters, + _summarize_filters, + add_currency_format, + create_metric_object, +) +from superset.mcp_service.chart.plugin import BaseChartPlugin +from superset.mcp_service.chart.schemas import ColumnRef, InteractivePivotChartConfig +from superset.mcp_service.chart.validation.dataset_validator import DatasetValidator +from superset.mcp_service.common.error_schemas import ChartGenerationError + +AG_GRID_PIVOT_FEATURE_FLAG = "AG_GRID_PIVOT_TABLE_ENABLED" +_AG_GRID_AGGREGATION = { + "AVG": "avg", + "MIN": "min", + "MAX": "max", +} + + +def _metric_label(metric: dict[str, Any] | str) -> str: + """Return the label AG Grid uses as a metric column identifier.""" + return metric if isinstance(metric, str) else str(metric["label"]) + + +def _grid_aggregation(metric: ColumnRef) -> str: + """Map a Superset metric aggregate to AG Grid's group rollup function.""" + return _AG_GRID_AGGREGATION.get((metric.aggregate or "SUM").upper(), "sum") + + +def map_interactive_pivot_config( + config: InteractivePivotChartConfig, +) -> dict[str, Any]: + """Map the MCP config to Preset's ``ag-grid-pivot-table`` form data.""" + metrics = [create_metric_object(metric) for metric in config.metrics] + rows = [column.name for column in config.rows] + columns = [column.name for column in config.columns] + + form_data: dict[str, Any] = { + "viz_type": "ag-grid-pivot-table", + # The Preset control panel stores every dimension in groupby. AG Grid's + # persisted state assigns each one to the Rows or Column Labels bucket. + "groupby": [*rows, *columns], + "metrics": metrics, + "row_limit": config.row_limit, + "order_desc": config.sort_descending, + "rowGroupCounts": config.show_row_group_counts, + "rowTotals": config.show_row_totals, + "colTotals": config.show_column_totals, + "colSubTotals": config.show_column_subtotals, + "valueFormat": config.value_format, + "allow_render_html": config.allow_render_html, + "expand_pivot_groups": config.expand_pivot_groups, + "pivot_table_state": { + "rowGroup": {"groupColIds": rows}, + "pivot": {"pivotMode": True, "pivotColIds": columns}, + "aggregation": { + "aggregationModel": [ + { + "colId": _metric_label(mapped_metric), + "aggFunc": _grid_aggregation(metric), + } + for metric, mapped_metric in zip( + config.metrics, metrics, strict=True + ) + ] + }, + }, + } + + if config.time_grain: + # Preset's hidden temporal_columns_lookup control identifies temporal + # dimensions in groupby, and its buildQuery applies this grain to each + # one. A single granularity_sqla is neither required nor sufficient for + # a pivot that can contain multiple temporal dimensions. + form_data["time_grain_sqla"] = config.time_grain.value + if config.series_limit is not None: + form_data["series_limit"] = config.series_limit + if config.series_limit_metric is not None: + form_data["series_limit_metric"] = create_metric_object( + config.series_limit_metric + ) + if config.date_format: + form_data["date_format"] = config.date_format + if config.column_sort: + form_data["colOrder"] = config.column_sort + if config.comparison_period and config.comparison_type: Review Comment: This block worries me a bit. I traced `time_compare` and `comparison_type` into the ag-grid pivot plugin and could not find a consumer: its buildQuery never maps `time_compare` into `time_offsets` (unlike the Interactive Table's buildQuery, which does), and neither transformProps nor the control panel reference `comparison_type` at all. I verified on this branch that generate_chart returns success and persists `time_compare: ['1 year ago']` and `comparison_type: 'percentage'` into the saved slice params, so the model gets a success response for a comparison the chart will silently not render, and the paired-fields validator plus the schema examples actively teach it that comparisons work. Are we certain the visualization consumes these fields, or is viz-side support in flight? If not, I would drop comparison_period and comparison_type from the schema, examples, and docs until it does, and add a test asserting the mapped form_data contains no comparison keys. Or am I misunderstanding something 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]
