aminghadersohi commented on code in PR #43480: URL: https://github.com/apache/superset/pull/43480#discussion_r3873342448
########## superset/mcp_service/chart/plugins/interactive_pivot.py: ########## @@ -0,0 +1,225 @@ +# 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 Review Comment: Fixed in c60d5daad5. The mapper now emits both `granularity_sqla` and `temporal_columns_lookup` for the explicitly selected grouped `temporal_column`, and validation requires `time_grain` to identify a temporal column present in rows or columns. Updated examples and regression tests cover the generated form data. ########## superset/mcp_service/chart/schemas.py: ########## @@ -1094,6 +1094,136 @@ def reject_sql_expression_on_dimensions(self) -> "PivotTableChartConfig": return self +class InteractivePivotChartConfig(BaseChartConfig): + """Config for Preset's AG Grid interactive pivot visualization. + + This is intentionally separate from :class:`PivotTableChartConfig`, which + targets the OSS ``pivot_table_v2`` visualization. + """ + + model_config = ConfigDict(extra="ignore", populate_by_name=True) + + chart_type: Literal["interactive_pivot"] = "interactive_pivot" + rows: List[ColumnRef] = Field( + ..., + min_length=1, + description=( + "Dimensions placed in the AG Grid Rows side-panel bucket, in nesting order" + ), + ) + columns: List[ColumnRef] = Field( + default_factory=list, + description=( + "Dimensions placed in the AG Grid Column Labels side-panel bucket" + ), + ) + metrics: List[ColumnRef] = Field( + ..., + min_length=1, + description=( + "Value columns. Each metric's aggregate controls the SQL aggregation " + "and its AG Grid group rollup (AVG/MIN/MAX map to avg/min/max; additive " + "aggregates roll up with sum)." + ), + ) + time_grain: TimeGrain | None = Field( + None, + description="PT1H, P1D, P1W, P1M, P3M, or P1Y for temporal dimensions", + validation_alias=AliasChoices("time_grain", "time_grain_sqla"), + ) + filters: List[FilterConfig] | None = Field( + None, + description=( + "Structured filters (column/op/value). Do NOT use adhoc_filters or " + "raw SQL expressions." + ), + ) + series_limit: int | None = Field( + None, + description="Maximum number of pivot series", + ge=0, + le=50000, + ) + series_limit_metric: ColumnRef | None = Field( + None, + description="Metric used to rank series when a series/cell limit applies", + ) Review Comment: Fixed in c60d5daad5. `series_limit_metric` now rejects plain dimensions and requires an explicit aggregate, saved metric, or SQL metric expression. Added regression coverage for the invalid plain-dimension shape. -- 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]
