codeant-ai-for-open-source[bot] commented on code in PR #42070:
URL: https://github.com/apache/superset/pull/42070#discussion_r3605441312
##########
superset/mcp_service/chart/schemas.py:
##########
@@ -2019,13 +2125,14 @@ def validate_percentiles_and_dimensions(self) ->
"BoxPlotChartConfig":
| HandlebarsChartConfig
| BigNumberChartConfig
| HistogramChartConfig
- | BoxPlotChartConfig,
+ | BoxPlotChartConfig
+ | WaterfallChartConfig,
Review Comment:
✅ **Customized review instruction saved!**
**Instruction:**
> Keep `waterfall` as its own chart category in the chart
recommendation/classification mapping; do not fold it into the `bar` family
when deduping recommendations.
**Applied to:**
- `superset/mcp_service/chart/**`
---
💡 *To manage or update this instruction, visit: [CodeAnt AI
Settings](https://app.codeant.ai/org/settings/learnings)*
##########
tests/unit_tests/mcp_service/chart/test_waterfall_chart.py:
##########
@@ -0,0 +1,257 @@
+# 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.
+
+"""Tests for the waterfall chart type plugin.
+
+Schema validation, form_data mapping (matching the frontend Waterfall
+buildQuery/transformProps contract for viz_type ``waterfall``), native
+vocabulary aliases, and registry integration.
+"""
+
+import pytest
+from pydantic import TypeAdapter, ValidationError
+
+from superset.mcp_service.chart.chart_utils import map_waterfall_config
+from superset.mcp_service.chart.schemas import ChartConfig,
WaterfallChartConfig
+
+
+class TestWaterfallChartConfigSchema:
+ """WaterfallChartConfig schema validation."""
+
+ def test_basic_waterfall_config(self) -> None:
+ config = WaterfallChartConfig(
Review Comment:
✅ **Customized review instruction saved!**
**Instruction:**
> Avoid flagging missing explicit type annotations for inferable local
variables in test files; rely on type inference when mypy already passes.
**Applied to:**
- `**/test/**`
- `**/tests/**`
- `**/*test*.py`
---
💡 *To manage or update this instruction, visit: [CodeAnt AI
Settings](https://app.codeant.ai/org/settings/learnings)*
##########
tests/unit_tests/mcp_service/chart/test_waterfall_chart.py:
##########
@@ -0,0 +1,257 @@
+# 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.
+
+"""Tests for the waterfall chart type plugin.
+
+Schema validation, form_data mapping (matching the frontend Waterfall
+buildQuery/transformProps contract for viz_type ``waterfall``), native
+vocabulary aliases, and registry integration.
+"""
+
+import pytest
+from pydantic import TypeAdapter, ValidationError
+
+from superset.mcp_service.chart.chart_utils import map_waterfall_config
+from superset.mcp_service.chart.schemas import ChartConfig,
WaterfallChartConfig
+
+
+class TestWaterfallChartConfigSchema:
+ """WaterfallChartConfig schema validation."""
+
+ def test_basic_waterfall_config(self) -> None:
+ config = WaterfallChartConfig(
+ chart_type="waterfall",
+ x_axis={"name": "month"},
+ metric={"name": "revenue_delta", "aggregate": "SUM"},
+ )
+ assert config.x_axis.name == "month"
+ assert config.breakdown is None
+ assert config.show_total is True # frontend controlPanel default
+
+ def test_waterfall_missing_x_axis(self) -> None:
+ with pytest.raises(ValidationError):
+ WaterfallChartConfig(
+ chart_type="waterfall",
+ metric={"name": "revenue", "aggregate": "SUM"},
+ )
+
+ def test_waterfall_missing_metric(self) -> None:
+ with pytest.raises(ValidationError):
+ WaterfallChartConfig(chart_type="waterfall", x_axis={"name":
"month"})
+
+ def test_waterfall_rejects_extra_fields(self) -> None:
+ with pytest.raises(ValidationError):
+ WaterfallChartConfig(
+ chart_type="waterfall",
+ x_axis={"name": "month"},
+ metric={"name": "revenue", "aggregate": "SUM"},
+ bogus=1,
+ )
+
+ def test_waterfall_breakdown_rejects_saved_metric(self) -> None:
+ """The breakdown is a dimension, not a metric."""
+ with pytest.raises(ValidationError):
+ WaterfallChartConfig(
+ chart_type="waterfall",
+ x_axis={"name": "month"},
+ metric={"name": "revenue", "aggregate": "SUM"},
+ breakdown={"name": "count", "saved_metric": True},
+ )
+
+ def test_waterfall_x_axis_rejects_saved_metric(self) -> None:
+ with pytest.raises(ValidationError):
+ WaterfallChartConfig(
+ chart_type="waterfall",
+ x_axis={"name": "count", "saved_metric": True},
+ metric={"name": "revenue", "aggregate": "SUM"},
+ )
+
+ def test_groupby_alias_for_breakdown(self) -> None:
+ """Superset-native 'groupby' is accepted for the breakdown field."""
+ config = WaterfallChartConfig.model_validate(
+ {
+ "chart_type": "waterfall",
+ "x_axis": {"name": "month"},
+ "metric": {"name": "revenue", "aggregate": "SUM"},
+ "groupby": {"name": "region"},
+ }
+ )
+ assert config.breakdown is not None
+ assert config.breakdown.name == "region"
+
+ def test_chart_config_union_dispatches_waterfall(self) -> None:
+ config = TypeAdapter(ChartConfig).validate_python(
+ {
+ "chart_type": "waterfall",
+ "x_axis": {"name": "month"},
+ "metric": {"name": "revenue", "aggregate": "SUM"},
+ }
+ )
+ assert isinstance(config, WaterfallChartConfig)
+
+
+class TestMapWaterfallConfig:
+ """form_data mapping must match the frontend Waterfall buildQuery."""
+
+ def test_basic_waterfall_form_data(self) -> None:
+ config = WaterfallChartConfig(
+ chart_type="waterfall",
+ x_axis={"name": "month"},
+ metric={"name": "revenue_delta", "aggregate": "SUM"},
+ )
+ form_data = map_waterfall_config(config)
Review Comment:
✅ **Customized review instruction saved!**
**Instruction:**
> Avoid flagging concrete type annotations for inferable local variables and
constants in Python; rely on type inference, especially in tests.
**Applied to:**
- `**/*.py`
---
💡 *To manage or update this instruction, visit: [CodeAnt AI
Settings](https://app.codeant.ai/org/settings/learnings)*
##########
tests/unit_tests/mcp_service/chart/test_waterfall_chart.py:
##########
@@ -0,0 +1,257 @@
+# 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.
+
+"""Tests for the waterfall chart type plugin.
+
+Schema validation, form_data mapping (matching the frontend Waterfall
+buildQuery/transformProps contract for viz_type ``waterfall``), native
+vocabulary aliases, and registry integration.
+"""
+
+import pytest
+from pydantic import TypeAdapter, ValidationError
+
+from superset.mcp_service.chart.chart_utils import map_waterfall_config
+from superset.mcp_service.chart.schemas import ChartConfig,
WaterfallChartConfig
+
+
+class TestWaterfallChartConfigSchema:
+ """WaterfallChartConfig schema validation."""
+
+ def test_basic_waterfall_config(self) -> None:
+ config = WaterfallChartConfig(
+ chart_type="waterfall",
+ x_axis={"name": "month"},
+ metric={"name": "revenue_delta", "aggregate": "SUM"},
+ )
+ assert config.x_axis.name == "month"
+ assert config.breakdown is None
+ assert config.show_total is True # frontend controlPanel default
+
+ def test_waterfall_missing_x_axis(self) -> None:
+ with pytest.raises(ValidationError):
+ WaterfallChartConfig(
+ chart_type="waterfall",
+ metric={"name": "revenue", "aggregate": "SUM"},
+ )
+
+ def test_waterfall_missing_metric(self) -> None:
+ with pytest.raises(ValidationError):
+ WaterfallChartConfig(chart_type="waterfall", x_axis={"name":
"month"})
+
+ def test_waterfall_rejects_extra_fields(self) -> None:
+ with pytest.raises(ValidationError):
+ WaterfallChartConfig(
+ chart_type="waterfall",
+ x_axis={"name": "month"},
+ metric={"name": "revenue", "aggregate": "SUM"},
+ bogus=1,
+ )
+
+ def test_waterfall_breakdown_rejects_saved_metric(self) -> None:
+ """The breakdown is a dimension, not a metric."""
+ with pytest.raises(ValidationError):
+ WaterfallChartConfig(
+ chart_type="waterfall",
+ x_axis={"name": "month"},
+ metric={"name": "revenue", "aggregate": "SUM"},
+ breakdown={"name": "count", "saved_metric": True},
+ )
+
+ def test_waterfall_x_axis_rejects_saved_metric(self) -> None:
+ with pytest.raises(ValidationError):
+ WaterfallChartConfig(
+ chart_type="waterfall",
+ x_axis={"name": "count", "saved_metric": True},
+ metric={"name": "revenue", "aggregate": "SUM"},
+ )
+
+ def test_groupby_alias_for_breakdown(self) -> None:
+ """Superset-native 'groupby' is accepted for the breakdown field."""
+ config = WaterfallChartConfig.model_validate(
+ {
+ "chart_type": "waterfall",
+ "x_axis": {"name": "month"},
+ "metric": {"name": "revenue", "aggregate": "SUM"},
+ "groupby": {"name": "region"},
+ }
+ )
+ assert config.breakdown is not None
+ assert config.breakdown.name == "region"
+
+ def test_chart_config_union_dispatches_waterfall(self) -> None:
+ config = TypeAdapter(ChartConfig).validate_python(
+ {
+ "chart_type": "waterfall",
+ "x_axis": {"name": "month"},
+ "metric": {"name": "revenue", "aggregate": "SUM"},
+ }
+ )
+ assert isinstance(config, WaterfallChartConfig)
+
+
+class TestMapWaterfallConfig:
+ """form_data mapping must match the frontend Waterfall buildQuery."""
+
+ def test_basic_waterfall_form_data(self) -> None:
+ config = WaterfallChartConfig(
+ chart_type="waterfall",
+ x_axis={"name": "month"},
+ metric={"name": "revenue_delta", "aggregate": "SUM"},
+ )
+ form_data = map_waterfall_config(config)
+ assert form_data["viz_type"] == "waterfall"
+ assert form_data["x_axis"] == "month"
+ assert form_data["groupby"] == []
+ assert form_data["metric"]["label"] == "SUM(revenue_delta)"
+ assert form_data["show_total"] is True
+
+ def test_waterfall_form_data_with_breakdown_and_filters(self) -> None:
+ config = WaterfallChartConfig(
+ chart_type="waterfall",
+ x_axis={"name": "month"},
+ metric={"name": "revenue", "aggregate": "SUM"},
+ breakdown={"name": "region"},
+ filters=[{"column": "year", "op": "=", "value": 2026}],
+ show_total=False,
+ )
+ form_data = map_waterfall_config(config)
+ # single breakdown maps to the groupby list (frontend multi: false)
+ assert form_data["groupby"] == ["region"]
+ assert form_data["show_total"] is False
+ assert form_data["adhoc_filters"], "filters must map to adhoc_filters"
+
+
+class TestWaterfallPluginRegistry:
+ """Plugin registration and viz-type resolution."""
+
+ def test_waterfall_plugin_registered(self) -> None:
+ from superset.mcp_service.chart import registry
+
+ plugin = registry.get("waterfall")
+ assert plugin is not None
Review Comment:
✅ **Customized review instruction saved!**
**Instruction:**
> Do not flag inferable local variables or constants for explicit type
annotations when the codebase intentionally leaves them unannotated and mypy
already passes.
**Applied to:**
- `**/*.py`
---
💡 *To manage or update this instruction, visit: [CodeAnt AI
Settings](https://app.codeant.ai/org/settings/learnings)*
--
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]
