codeant-ai-for-open-source[bot] commented on code in PR #40960: URL: https://github.com/apache/superset/pull/40960#discussion_r3482399921
########## tests/unit_tests/mcp_service/dashboard/tool/test_manage_native_filters.py: ########## @@ -0,0 +1,706 @@ +# 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. + +""" +Unit tests for the manage_native_filters MCP tool. + +Follows the pattern from test_add_chart_to_existing_dashboard.py: +- Tests run through the async MCP Client (not direct function calls) +- Patches applied at source locations (superset.daos.dashboard.*, etc.) +- auth is mocked via the autouse mock_auth fixture + +Covers: +- Adding a filter_select filter (full config shape, scope translation) +- Adding a filter_time filter (with default time range) +- Updating a filter (merge produces a FULL config, not a delta) +- Update validation (duplicate update IDs, update+remove conflict) +- Removing a filter +- Reordering filters (including incomplete-reorder validation) +- Invalid dataset / column errors +- LLM-context sanitization of user-controlled filter names / targets +- Dashboard not found +- Permission denied (DashboardForbiddenError) +""" + +import logging +from collections.abc import Callable, Iterator +from typing import Any +from unittest.mock import Mock, patch + +import pytest +from fastmcp import Client + +from superset.commands.dashboard.exceptions import DashboardForbiddenError +from superset.mcp_service.app import mcp +from superset.utils import json + +logging.basicConfig(level=logging.DEBUG) +logger = logging.getLogger(__name__) + +DAO_FIND_BY_ID = "superset.daos.dashboard.DashboardDAO.find_by_id" +DATASET_FIND_BY_ID = "superset.daos.dataset.DatasetDAO.find_by_id" +COMMAND_PATH = "superset.commands.dashboard.update.UpdateDashboardNativeFiltersCommand" + + [email protected] +def mcp_server() -> object: + """Return the FastMCP app instance for use in MCP client tests.""" + return mcp + + [email protected](autouse=True) +def mock_auth() -> Iterator[Mock]: + """Mock authentication for all tests.""" + with patch("superset.mcp_service.auth.get_user_from_request") as mock_get_user: + mock_user = Mock() + mock_user.id = 1 + mock_user.username = "admin" + mock_get_user.return_value = mock_user + yield mock_get_user + + +# --------------------------------------------------------------------------- +# Helpers +# --------------------------------------------------------------------------- + + +EXISTING_SELECT_FILTER = { + "id": "NATIVE_FILTER-existing1", + "type": "NATIVE_FILTER", + "filterType": "filter_select", + "name": "Region", + "description": "", + "scope": {"rootPath": ["ROOT_ID"], "excluded": []}, + "targets": [{"datasetId": 5, "column": {"name": "region"}}], + "controlValues": { + "multiSelect": True, + "defaultToFirstItem": False, + "enableEmptyFilter": False, + "searchAllOptions": False, + }, + "defaultDataMask": {"filterState": {"value": None}, "extraFormData": {}}, + "cascadeParentIds": [], +} + +EXISTING_TIME_FILTER = { + "id": "NATIVE_FILTER-existing2", + "type": "NATIVE_FILTER", + "filterType": "filter_time", + "name": "Time Range", + "description": "", + "scope": {"rootPath": ["ROOT_ID"], "excluded": []}, + "targets": [{}], + "controlValues": {}, + "defaultDataMask": {"filterState": {"value": None}, "extraFormData": {}}, + "cascadeParentIds": [], +} + + +def _mock_dashboard( + id: int = 1, + filters: list[dict[str, Any]] | None = None, + chart_ids: list[int] | None = None, +) -> Mock: Review Comment: **Suggestion:** Add a docstring to this new helper function describing what it builds and returns. [custom_rule] **Severity Level:** Minor ⚠️ <details> <summary><b>Why it matters? 🤔 </b></summary> This helper function is newly added and does not include a docstring immediately under the definition. The custom rule explicitly requires docstrings for newly added Python functions. </details> [](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=502f41aad84f41d1b40a0a33b66edae4&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=502f41aad84f41d1b40a0a33b66edae4&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:** tests/unit_tests/mcp_service/dashboard/tool/test_manage_native_filters.py **Line:** 113:117 **Comment:** *Custom Rule: Add a docstring to this new helper function describing what it builds and returns. 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%2F40960&comment_hash=1b4439315c19f5b2d74e5edd0cbffc0a28b0594084dc9e92d7adf872079069a3&reaction=like'>👍</a> | <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F40960&comment_hash=1b4439315c19f5b2d74e5edd0cbffc0a28b0594084dc9e92d7adf872079069a3&reaction=dislike'>👎</a> ########## tests/unit_tests/mcp_service/dashboard/tool/test_manage_native_filters.py: ########## @@ -0,0 +1,706 @@ +# 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. + +""" +Unit tests for the manage_native_filters MCP tool. + +Follows the pattern from test_add_chart_to_existing_dashboard.py: +- Tests run through the async MCP Client (not direct function calls) +- Patches applied at source locations (superset.daos.dashboard.*, etc.) +- auth is mocked via the autouse mock_auth fixture + +Covers: +- Adding a filter_select filter (full config shape, scope translation) +- Adding a filter_time filter (with default time range) +- Updating a filter (merge produces a FULL config, not a delta) +- Update validation (duplicate update IDs, update+remove conflict) +- Removing a filter +- Reordering filters (including incomplete-reorder validation) +- Invalid dataset / column errors +- LLM-context sanitization of user-controlled filter names / targets +- Dashboard not found +- Permission denied (DashboardForbiddenError) +""" + +import logging +from collections.abc import Callable, Iterator +from typing import Any +from unittest.mock import Mock, patch + +import pytest +from fastmcp import Client + +from superset.commands.dashboard.exceptions import DashboardForbiddenError +from superset.mcp_service.app import mcp +from superset.utils import json + +logging.basicConfig(level=logging.DEBUG) +logger = logging.getLogger(__name__) + +DAO_FIND_BY_ID = "superset.daos.dashboard.DashboardDAO.find_by_id" +DATASET_FIND_BY_ID = "superset.daos.dataset.DatasetDAO.find_by_id" +COMMAND_PATH = "superset.commands.dashboard.update.UpdateDashboardNativeFiltersCommand" + + [email protected] +def mcp_server() -> object: + """Return the FastMCP app instance for use in MCP client tests.""" + return mcp + + [email protected](autouse=True) +def mock_auth() -> Iterator[Mock]: + """Mock authentication for all tests.""" + with patch("superset.mcp_service.auth.get_user_from_request") as mock_get_user: + mock_user = Mock() + mock_user.id = 1 + mock_user.username = "admin" + mock_get_user.return_value = mock_user + yield mock_get_user + + +# --------------------------------------------------------------------------- +# Helpers +# --------------------------------------------------------------------------- + + +EXISTING_SELECT_FILTER = { + "id": "NATIVE_FILTER-existing1", + "type": "NATIVE_FILTER", + "filterType": "filter_select", + "name": "Region", + "description": "", + "scope": {"rootPath": ["ROOT_ID"], "excluded": []}, + "targets": [{"datasetId": 5, "column": {"name": "region"}}], + "controlValues": { + "multiSelect": True, + "defaultToFirstItem": False, + "enableEmptyFilter": False, + "searchAllOptions": False, + }, + "defaultDataMask": {"filterState": {"value": None}, "extraFormData": {}}, + "cascadeParentIds": [], +} + +EXISTING_TIME_FILTER = { + "id": "NATIVE_FILTER-existing2", + "type": "NATIVE_FILTER", + "filterType": "filter_time", + "name": "Time Range", + "description": "", + "scope": {"rootPath": ["ROOT_ID"], "excluded": []}, + "targets": [{}], + "controlValues": {}, + "defaultDataMask": {"filterState": {"value": None}, "extraFormData": {}}, + "cascadeParentIds": [], +} + + +def _mock_dashboard( + id: int = 1, + filters: list[dict[str, Any]] | None = None, + chart_ids: list[int] | None = None, +) -> Mock: + dashboard = Mock() + dashboard.id = id + dashboard.dashboard_title = "Test Dashboard" + dashboard.json_metadata = json.dumps({"native_filter_configuration": filters or []}) + slices = [] + for chart_id in chart_ids or [10, 11]: + slc = Mock() + slc.id = chart_id + slices.append(slc) + dashboard.slices = slices + return dashboard + + +def _mock_dataset(columns: list[str] | None = None) -> Mock: + """Build a mock dataset whose columns expose the given column names.""" + dataset = Mock() + dataset.id = 5 + cols = [] + for name in columns or ["region", "country", "ds"]: + col = Mock() + col.column_name = name + cols.append(col) + dataset.columns = cols + return dataset + + +def _mock_command(captured: dict[str, Any]) -> Callable[[int, dict[str, Any]], Mock]: + """Build a mock UpdateDashboardNativeFiltersCommand class. + + Captures constructor args and returns the modified configuration + the way the real DAO would (existing filters with substitutions, + new filters appended, deletions removed). + """ + + def command_factory(dashboard_id: int, payload: dict[str, Any]) -> Mock: + captured["dashboard_id"] = dashboard_id + captured["payload"] = payload + + command = Mock() + + def run() -> list[dict[str, Any]]: + current = captured.get("current_config", []) + deleted = payload.get("deleted", []) + modified = payload.get("modified", []) + result = [] + for conf in current: + if conf["id"] in deleted: + continue + replacement = next((m for m in modified if m["id"] == conf["id"]), None) + result.append(replacement if replacement else conf) + for m in modified: + if m["id"] not in [c["id"] for c in result]: + result.append(m) + if reordered := list(payload.get("reordered", [])): + for m in modified: + if m["id"] not in reordered: + reordered.append(m["id"]) + by_id = {c["id"]: c for c in result} + result = [by_id[fid] for fid in reordered if fid in by_id] + captured["result"] = result + return result + + command.run = run + return command + + return command_factory + + +async def _call(mcp_server: object, request: dict[str, Any]) -> dict[str, Any]: + async with Client(mcp_server) as client: + result = await client.call_tool("manage_native_filters", {"request": request}) + return json.loads(result.content[0].text) + + +# --------------------------------------------------------------------------- +# Add +# --------------------------------------------------------------------------- + + [email protected] +async def test_add_filter_select(mcp_server): Review Comment: **Suggestion:** Add explicit type annotations for the `mcp_server` parameter and the return type on this new async test function so it is fully typed. [custom_rule] **Severity Level:** Minor ⚠️ <details> <summary><b>Why it matters? 🤔 </b></summary> This is a new async Python test function, and it omits both the parameter type hint for `mcp_server` and the return type annotation. The rule requires new Python functions to be fully typed, so this is a real violation. </details> [](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=10f1c9177ffa4053a56c89e6655cbff4&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=10f1c9177ffa4053a56c89e6655cbff4&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:** tests/unit_tests/mcp_service/dashboard/tool/test_manage_native_filters.py **Line:** 198:198 **Comment:** *Custom Rule: Add explicit type annotations for the `mcp_server` parameter and the return type on this new async test function so it is fully typed. 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%2F40960&comment_hash=df310ffa8e8ce5cb2a263979aeaccfb0b1fd47d61b6fbd305cd785f3dd691449&reaction=like'>👍</a> | <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F40960&comment_hash=df310ffa8e8ce5cb2a263979aeaccfb0b1fd47d61b6fbd305cd785f3dd691449&reaction=dislike'>👎</a> ########## tests/unit_tests/mcp_service/dashboard/tool/test_manage_native_filters.py: ########## @@ -0,0 +1,706 @@ +# 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. + +""" +Unit tests for the manage_native_filters MCP tool. + +Follows the pattern from test_add_chart_to_existing_dashboard.py: +- Tests run through the async MCP Client (not direct function calls) +- Patches applied at source locations (superset.daos.dashboard.*, etc.) +- auth is mocked via the autouse mock_auth fixture + +Covers: +- Adding a filter_select filter (full config shape, scope translation) +- Adding a filter_time filter (with default time range) +- Updating a filter (merge produces a FULL config, not a delta) +- Update validation (duplicate update IDs, update+remove conflict) +- Removing a filter +- Reordering filters (including incomplete-reorder validation) +- Invalid dataset / column errors +- LLM-context sanitization of user-controlled filter names / targets +- Dashboard not found +- Permission denied (DashboardForbiddenError) +""" + +import logging +from collections.abc import Callable, Iterator +from typing import Any +from unittest.mock import Mock, patch + +import pytest +from fastmcp import Client + +from superset.commands.dashboard.exceptions import DashboardForbiddenError +from superset.mcp_service.app import mcp +from superset.utils import json + +logging.basicConfig(level=logging.DEBUG) +logger = logging.getLogger(__name__) + +DAO_FIND_BY_ID = "superset.daos.dashboard.DashboardDAO.find_by_id" +DATASET_FIND_BY_ID = "superset.daos.dataset.DatasetDAO.find_by_id" +COMMAND_PATH = "superset.commands.dashboard.update.UpdateDashboardNativeFiltersCommand" + + [email protected] +def mcp_server() -> object: + """Return the FastMCP app instance for use in MCP client tests.""" + return mcp + + [email protected](autouse=True) +def mock_auth() -> Iterator[Mock]: + """Mock authentication for all tests.""" + with patch("superset.mcp_service.auth.get_user_from_request") as mock_get_user: + mock_user = Mock() + mock_user.id = 1 + mock_user.username = "admin" + mock_get_user.return_value = mock_user + yield mock_get_user + + +# --------------------------------------------------------------------------- +# Helpers +# --------------------------------------------------------------------------- + + +EXISTING_SELECT_FILTER = { + "id": "NATIVE_FILTER-existing1", + "type": "NATIVE_FILTER", + "filterType": "filter_select", + "name": "Region", + "description": "", + "scope": {"rootPath": ["ROOT_ID"], "excluded": []}, + "targets": [{"datasetId": 5, "column": {"name": "region"}}], + "controlValues": { + "multiSelect": True, + "defaultToFirstItem": False, + "enableEmptyFilter": False, + "searchAllOptions": False, + }, + "defaultDataMask": {"filterState": {"value": None}, "extraFormData": {}}, + "cascadeParentIds": [], +} + +EXISTING_TIME_FILTER = { + "id": "NATIVE_FILTER-existing2", + "type": "NATIVE_FILTER", + "filterType": "filter_time", + "name": "Time Range", + "description": "", + "scope": {"rootPath": ["ROOT_ID"], "excluded": []}, + "targets": [{}], + "controlValues": {}, + "defaultDataMask": {"filterState": {"value": None}, "extraFormData": {}}, + "cascadeParentIds": [], +} + + +def _mock_dashboard( + id: int = 1, + filters: list[dict[str, Any]] | None = None, + chart_ids: list[int] | None = None, +) -> Mock: + dashboard = Mock() + dashboard.id = id + dashboard.dashboard_title = "Test Dashboard" + dashboard.json_metadata = json.dumps({"native_filter_configuration": filters or []}) + slices = [] + for chart_id in chart_ids or [10, 11]: + slc = Mock() + slc.id = chart_id + slices.append(slc) + dashboard.slices = slices + return dashboard + + +def _mock_dataset(columns: list[str] | None = None) -> Mock: + """Build a mock dataset whose columns expose the given column names.""" + dataset = Mock() + dataset.id = 5 + cols = [] + for name in columns or ["region", "country", "ds"]: + col = Mock() + col.column_name = name + cols.append(col) + dataset.columns = cols + return dataset + + +def _mock_command(captured: dict[str, Any]) -> Callable[[int, dict[str, Any]], Mock]: + """Build a mock UpdateDashboardNativeFiltersCommand class. + + Captures constructor args and returns the modified configuration + the way the real DAO would (existing filters with substitutions, + new filters appended, deletions removed). + """ + + def command_factory(dashboard_id: int, payload: dict[str, Any]) -> Mock: + captured["dashboard_id"] = dashboard_id + captured["payload"] = payload + + command = Mock() + + def run() -> list[dict[str, Any]]: + current = captured.get("current_config", []) + deleted = payload.get("deleted", []) + modified = payload.get("modified", []) + result = [] + for conf in current: + if conf["id"] in deleted: + continue + replacement = next((m for m in modified if m["id"] == conf["id"]), None) + result.append(replacement if replacement else conf) + for m in modified: + if m["id"] not in [c["id"] for c in result]: + result.append(m) + if reordered := list(payload.get("reordered", [])): + for m in modified: + if m["id"] not in reordered: + reordered.append(m["id"]) + by_id = {c["id"]: c for c in result} + result = [by_id[fid] for fid in reordered if fid in by_id] + captured["result"] = result + return result + + command.run = run + return command + + return command_factory + + +async def _call(mcp_server: object, request: dict[str, Any]) -> dict[str, Any]: + async with Client(mcp_server) as client: + result = await client.call_tool("manage_native_filters", {"request": request}) + return json.loads(result.content[0].text) + + +# --------------------------------------------------------------------------- +# Add +# --------------------------------------------------------------------------- + + [email protected] +async def test_add_filter_select(mcp_server): + captured: dict = {"current_config": []} + dashboard = _mock_dashboard(filters=[], chart_ids=[10, 11, 12]) + + with ( + patch(DAO_FIND_BY_ID, return_value=dashboard), + patch(DATASET_FIND_BY_ID, return_value=_mock_dataset()), + patch(COMMAND_PATH, side_effect=_mock_command(captured)), + ): + data = await _call( + mcp_server, + { + "dashboard_id": 1, + "add": [ + { + "filter_type": "filter_select", + "name": "Region", + "dataset_id": 5, + "column": "region", + "multi_select": False, + "default_to_first_item": True, + "enable_empty_filter": True, + "sort_ascending": False, + "search_all_options": True, + "scope_chart_ids": [10, 11], + } + ], + }, + ) + + assert data["error"] is None + assert len(data["added_filter_ids"]) == 1 + new_id = data["added_filter_ids"][0] + assert new_id.startswith("NATIVE_FILTER-") + + payload = captured["payload"] + assert "deleted" not in payload + assert "reordered" not in payload + assert len(payload["modified"]) == 1 + config = payload["modified"][0] + assert config == { + "id": new_id, + "type": "NATIVE_FILTER", + "filterType": "filter_select", + "name": "Region", + "description": "", + "scope": {"rootPath": ["ROOT_ID"], "excluded": [12]}, + "targets": [{"datasetId": 5, "column": {"name": "region"}}], + "controlValues": { + "multiSelect": False, + "defaultToFirstItem": True, + "enableEmptyFilter": True, + "searchAllOptions": True, + "sortAscending": False, + }, + "defaultDataMask": {"filterState": {"value": None}, "extraFormData": {}}, + "cascadeParentIds": [], + } + assert data["filters"][0]["id"] == new_id + assert data["filters"][0]["filter_type"] == "filter_select" + + [email protected] +async def test_add_filter_time(mcp_server): Review Comment: **Suggestion:** Add explicit type annotations for the `mcp_server` parameter and the return type on this new async test function to satisfy full typing requirements. [custom_rule] **Severity Level:** Minor ⚠️ <details> <summary><b>Why it matters? 🤔 </b></summary> This new async test function also lacks type annotations for `mcp_server` and the return type. That directly violates the rule requiring new Python code to be fully typed. </details> [](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=ef92190d15b345a4b3e9eedb11204280&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=ef92190d15b345a4b3e9eedb11204280&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:** tests/unit_tests/mcp_service/dashboard/tool/test_manage_native_filters.py **Line:** 261:261 **Comment:** *Custom Rule: Add explicit type annotations for the `mcp_server` parameter and the return type on this new async test function to satisfy full typing requirements. 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%2F40960&comment_hash=36074d4e6200c1d9b8fca5be778552856df50c2dab3a9443f84408a8823cc90f&reaction=like'>👍</a> | <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F40960&comment_hash=36074d4e6200c1d9b8fca5be778552856df50c2dab3a9443f84408a8823cc90f&reaction=dislike'>👎</a> ########## tests/unit_tests/mcp_service/dashboard/tool/test_manage_native_filters.py: ########## @@ -0,0 +1,706 @@ +# 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. + +""" +Unit tests for the manage_native_filters MCP tool. + +Follows the pattern from test_add_chart_to_existing_dashboard.py: +- Tests run through the async MCP Client (not direct function calls) +- Patches applied at source locations (superset.daos.dashboard.*, etc.) +- auth is mocked via the autouse mock_auth fixture + +Covers: +- Adding a filter_select filter (full config shape, scope translation) +- Adding a filter_time filter (with default time range) +- Updating a filter (merge produces a FULL config, not a delta) +- Update validation (duplicate update IDs, update+remove conflict) +- Removing a filter +- Reordering filters (including incomplete-reorder validation) +- Invalid dataset / column errors +- LLM-context sanitization of user-controlled filter names / targets +- Dashboard not found +- Permission denied (DashboardForbiddenError) +""" + +import logging +from collections.abc import Callable, Iterator +from typing import Any +from unittest.mock import Mock, patch + +import pytest +from fastmcp import Client + +from superset.commands.dashboard.exceptions import DashboardForbiddenError +from superset.mcp_service.app import mcp +from superset.utils import json + +logging.basicConfig(level=logging.DEBUG) +logger = logging.getLogger(__name__) + +DAO_FIND_BY_ID = "superset.daos.dashboard.DashboardDAO.find_by_id" +DATASET_FIND_BY_ID = "superset.daos.dataset.DatasetDAO.find_by_id" +COMMAND_PATH = "superset.commands.dashboard.update.UpdateDashboardNativeFiltersCommand" + + [email protected] +def mcp_server() -> object: + """Return the FastMCP app instance for use in MCP client tests.""" + return mcp + + [email protected](autouse=True) +def mock_auth() -> Iterator[Mock]: + """Mock authentication for all tests.""" + with patch("superset.mcp_service.auth.get_user_from_request") as mock_get_user: + mock_user = Mock() + mock_user.id = 1 + mock_user.username = "admin" + mock_get_user.return_value = mock_user + yield mock_get_user + + +# --------------------------------------------------------------------------- +# Helpers +# --------------------------------------------------------------------------- + + +EXISTING_SELECT_FILTER = { + "id": "NATIVE_FILTER-existing1", + "type": "NATIVE_FILTER", + "filterType": "filter_select", + "name": "Region", + "description": "", + "scope": {"rootPath": ["ROOT_ID"], "excluded": []}, + "targets": [{"datasetId": 5, "column": {"name": "region"}}], + "controlValues": { + "multiSelect": True, + "defaultToFirstItem": False, + "enableEmptyFilter": False, + "searchAllOptions": False, + }, + "defaultDataMask": {"filterState": {"value": None}, "extraFormData": {}}, + "cascadeParentIds": [], +} + +EXISTING_TIME_FILTER = { + "id": "NATIVE_FILTER-existing2", + "type": "NATIVE_FILTER", + "filterType": "filter_time", + "name": "Time Range", + "description": "", + "scope": {"rootPath": ["ROOT_ID"], "excluded": []}, + "targets": [{}], + "controlValues": {}, + "defaultDataMask": {"filterState": {"value": None}, "extraFormData": {}}, + "cascadeParentIds": [], +} + + +def _mock_dashboard( + id: int = 1, + filters: list[dict[str, Any]] | None = None, + chart_ids: list[int] | None = None, +) -> Mock: + dashboard = Mock() + dashboard.id = id + dashboard.dashboard_title = "Test Dashboard" + dashboard.json_metadata = json.dumps({"native_filter_configuration": filters or []}) + slices = [] + for chart_id in chart_ids or [10, 11]: + slc = Mock() + slc.id = chart_id + slices.append(slc) + dashboard.slices = slices + return dashboard + + +def _mock_dataset(columns: list[str] | None = None) -> Mock: + """Build a mock dataset whose columns expose the given column names.""" + dataset = Mock() + dataset.id = 5 + cols = [] + for name in columns or ["region", "country", "ds"]: + col = Mock() + col.column_name = name + cols.append(col) + dataset.columns = cols + return dataset + + +def _mock_command(captured: dict[str, Any]) -> Callable[[int, dict[str, Any]], Mock]: + """Build a mock UpdateDashboardNativeFiltersCommand class. + + Captures constructor args and returns the modified configuration + the way the real DAO would (existing filters with substitutions, + new filters appended, deletions removed). + """ + + def command_factory(dashboard_id: int, payload: dict[str, Any]) -> Mock: + captured["dashboard_id"] = dashboard_id + captured["payload"] = payload + + command = Mock() + + def run() -> list[dict[str, Any]]: + current = captured.get("current_config", []) + deleted = payload.get("deleted", []) + modified = payload.get("modified", []) + result = [] + for conf in current: + if conf["id"] in deleted: + continue + replacement = next((m for m in modified if m["id"] == conf["id"]), None) + result.append(replacement if replacement else conf) + for m in modified: + if m["id"] not in [c["id"] for c in result]: + result.append(m) + if reordered := list(payload.get("reordered", [])): + for m in modified: + if m["id"] not in reordered: + reordered.append(m["id"]) + by_id = {c["id"]: c for c in result} + result = [by_id[fid] for fid in reordered if fid in by_id] + captured["result"] = result + return result + + command.run = run + return command + + return command_factory + + +async def _call(mcp_server: object, request: dict[str, Any]) -> dict[str, Any]: Review Comment: **Suggestion:** Add a docstring to this newly added async helper function to document its purpose and expected behavior. [custom_rule] **Severity Level:** Minor ⚠️ <details> <summary><b>Why it matters? 🤔 </b></summary> This is a new async helper function and it has no docstring. That matches the custom rule for newly added Python functions needing inline documentation. </details> [](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=e94c02b464e94fc2bd18e415089c97c4&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=e94c02b464e94fc2bd18e415089c97c4&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:** tests/unit_tests/mcp_service/dashboard/tool/test_manage_native_filters.py **Line:** 186:186 **Comment:** *Custom Rule: Add a docstring to this newly added async helper function to document its purpose and expected behavior. 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%2F40960&comment_hash=bf6c4c172ed7562440cf3357df6cf78e573afc82d092bff0298b09e28614d6cc&reaction=like'>👍</a> | <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F40960&comment_hash=bf6c4c172ed7562440cf3357df6cf78e573afc82d092bff0298b09e28614d6cc&reaction=dislike'>👎</a> ########## tests/unit_tests/mcp_service/dashboard/tool/test_manage_native_filters.py: ########## @@ -0,0 +1,706 @@ +# 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. + +""" +Unit tests for the manage_native_filters MCP tool. + +Follows the pattern from test_add_chart_to_existing_dashboard.py: +- Tests run through the async MCP Client (not direct function calls) +- Patches applied at source locations (superset.daos.dashboard.*, etc.) +- auth is mocked via the autouse mock_auth fixture + +Covers: +- Adding a filter_select filter (full config shape, scope translation) +- Adding a filter_time filter (with default time range) +- Updating a filter (merge produces a FULL config, not a delta) +- Update validation (duplicate update IDs, update+remove conflict) +- Removing a filter +- Reordering filters (including incomplete-reorder validation) +- Invalid dataset / column errors +- LLM-context sanitization of user-controlled filter names / targets +- Dashboard not found +- Permission denied (DashboardForbiddenError) +""" + +import logging +from collections.abc import Callable, Iterator +from typing import Any +from unittest.mock import Mock, patch + +import pytest +from fastmcp import Client + +from superset.commands.dashboard.exceptions import DashboardForbiddenError +from superset.mcp_service.app import mcp +from superset.utils import json + +logging.basicConfig(level=logging.DEBUG) +logger = logging.getLogger(__name__) + +DAO_FIND_BY_ID = "superset.daos.dashboard.DashboardDAO.find_by_id" +DATASET_FIND_BY_ID = "superset.daos.dataset.DatasetDAO.find_by_id" +COMMAND_PATH = "superset.commands.dashboard.update.UpdateDashboardNativeFiltersCommand" + + [email protected] +def mcp_server() -> object: + """Return the FastMCP app instance for use in MCP client tests.""" + return mcp + + [email protected](autouse=True) +def mock_auth() -> Iterator[Mock]: + """Mock authentication for all tests.""" + with patch("superset.mcp_service.auth.get_user_from_request") as mock_get_user: + mock_user = Mock() + mock_user.id = 1 + mock_user.username = "admin" + mock_get_user.return_value = mock_user + yield mock_get_user + + +# --------------------------------------------------------------------------- +# Helpers +# --------------------------------------------------------------------------- + + +EXISTING_SELECT_FILTER = { + "id": "NATIVE_FILTER-existing1", + "type": "NATIVE_FILTER", + "filterType": "filter_select", + "name": "Region", + "description": "", + "scope": {"rootPath": ["ROOT_ID"], "excluded": []}, + "targets": [{"datasetId": 5, "column": {"name": "region"}}], + "controlValues": { + "multiSelect": True, + "defaultToFirstItem": False, + "enableEmptyFilter": False, + "searchAllOptions": False, + }, + "defaultDataMask": {"filterState": {"value": None}, "extraFormData": {}}, + "cascadeParentIds": [], +} + +EXISTING_TIME_FILTER = { + "id": "NATIVE_FILTER-existing2", + "type": "NATIVE_FILTER", + "filterType": "filter_time", + "name": "Time Range", + "description": "", + "scope": {"rootPath": ["ROOT_ID"], "excluded": []}, + "targets": [{}], + "controlValues": {}, + "defaultDataMask": {"filterState": {"value": None}, "extraFormData": {}}, + "cascadeParentIds": [], +} + + +def _mock_dashboard( + id: int = 1, + filters: list[dict[str, Any]] | None = None, + chart_ids: list[int] | None = None, +) -> Mock: + dashboard = Mock() + dashboard.id = id + dashboard.dashboard_title = "Test Dashboard" + dashboard.json_metadata = json.dumps({"native_filter_configuration": filters or []}) + slices = [] + for chart_id in chart_ids or [10, 11]: + slc = Mock() + slc.id = chart_id + slices.append(slc) + dashboard.slices = slices + return dashboard + + +def _mock_dataset(columns: list[str] | None = None) -> Mock: + """Build a mock dataset whose columns expose the given column names.""" + dataset = Mock() + dataset.id = 5 + cols = [] + for name in columns or ["region", "country", "ds"]: + col = Mock() + col.column_name = name + cols.append(col) + dataset.columns = cols + return dataset + + +def _mock_command(captured: dict[str, Any]) -> Callable[[int, dict[str, Any]], Mock]: + """Build a mock UpdateDashboardNativeFiltersCommand class. + + Captures constructor args and returns the modified configuration + the way the real DAO would (existing filters with substitutions, + new filters appended, deletions removed). + """ + + def command_factory(dashboard_id: int, payload: dict[str, Any]) -> Mock: + captured["dashboard_id"] = dashboard_id + captured["payload"] = payload + + command = Mock() + + def run() -> list[dict[str, Any]]: + current = captured.get("current_config", []) + deleted = payload.get("deleted", []) + modified = payload.get("modified", []) + result = [] + for conf in current: + if conf["id"] in deleted: + continue + replacement = next((m for m in modified if m["id"] == conf["id"]), None) + result.append(replacement if replacement else conf) + for m in modified: + if m["id"] not in [c["id"] for c in result]: + result.append(m) + if reordered := list(payload.get("reordered", [])): + for m in modified: + if m["id"] not in reordered: + reordered.append(m["id"]) + by_id = {c["id"]: c for c in result} + result = [by_id[fid] for fid in reordered if fid in by_id] + captured["result"] = result + return result + + command.run = run + return command + + return command_factory + + +async def _call(mcp_server: object, request: dict[str, Any]) -> dict[str, Any]: + async with Client(mcp_server) as client: + result = await client.call_tool("manage_native_filters", {"request": request}) + return json.loads(result.content[0].text) + + +# --------------------------------------------------------------------------- +# Add +# --------------------------------------------------------------------------- + + [email protected] +async def test_add_filter_select(mcp_server): + captured: dict = {"current_config": []} + dashboard = _mock_dashboard(filters=[], chart_ids=[10, 11, 12]) + + with ( + patch(DAO_FIND_BY_ID, return_value=dashboard), + patch(DATASET_FIND_BY_ID, return_value=_mock_dataset()), + patch(COMMAND_PATH, side_effect=_mock_command(captured)), + ): + data = await _call( + mcp_server, + { + "dashboard_id": 1, + "add": [ + { + "filter_type": "filter_select", + "name": "Region", + "dataset_id": 5, + "column": "region", + "multi_select": False, + "default_to_first_item": True, + "enable_empty_filter": True, + "sort_ascending": False, + "search_all_options": True, + "scope_chart_ids": [10, 11], + } + ], + }, + ) + + assert data["error"] is None + assert len(data["added_filter_ids"]) == 1 + new_id = data["added_filter_ids"][0] + assert new_id.startswith("NATIVE_FILTER-") + + payload = captured["payload"] + assert "deleted" not in payload + assert "reordered" not in payload + assert len(payload["modified"]) == 1 + config = payload["modified"][0] + assert config == { + "id": new_id, + "type": "NATIVE_FILTER", + "filterType": "filter_select", + "name": "Region", + "description": "", + "scope": {"rootPath": ["ROOT_ID"], "excluded": [12]}, + "targets": [{"datasetId": 5, "column": {"name": "region"}}], + "controlValues": { + "multiSelect": False, + "defaultToFirstItem": True, + "enableEmptyFilter": True, + "searchAllOptions": True, + "sortAscending": False, + }, + "defaultDataMask": {"filterState": {"value": None}, "extraFormData": {}}, + "cascadeParentIds": [], + } + assert data["filters"][0]["id"] == new_id + assert data["filters"][0]["filter_type"] == "filter_select" + + [email protected] +async def test_add_filter_time(mcp_server): + captured: dict = {"current_config": []} + dashboard = _mock_dashboard(filters=[]) + + with ( + patch(DAO_FIND_BY_ID, return_value=dashboard), + patch(COMMAND_PATH, side_effect=_mock_command(captured)), + ): + data = await _call( + mcp_server, + { + "dashboard_id": 1, + "add": [ + { + "filter_type": "filter_time", + "name": "Time Range", + "default_time_range": "Last week", + } + ], + }, + ) + + assert data["error"] is None + new_id = data["added_filter_ids"][0] + config = captured["payload"]["modified"][0] + assert config["id"] == new_id + assert config["type"] == "NATIVE_FILTER" + assert config["filterType"] == "filter_time" + assert config["targets"] == [{}] + assert config["controlValues"] == {} + assert config["scope"] == {"rootPath": ["ROOT_ID"], "excluded": []} + assert config["defaultDataMask"] == { + "filterState": {"value": "Last week"}, + "extraFormData": {"time_range": "Last week"}, + } + + +# --------------------------------------------------------------------------- +# Update +# --------------------------------------------------------------------------- + + [email protected] +async def test_update_merge_produces_full_config(mcp_server): Review Comment: **Suggestion:** Add a docstring to this new test function so newly added functions are documented inline. [custom_rule] **Severity Level:** Minor ⚠️ <details> <summary><b>Why it matters? 🤔 </b></summary> This newly added test function lacks a docstring, so it violates the rule requiring new Python functions and classes to be documented inline. </details> [](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=028a2dea21e044d592953fc76188f6c7&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=028a2dea21e044d592953fc76188f6c7&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:** tests/unit_tests/mcp_service/dashboard/tool/test_manage_native_filters.py **Line:** 304:304 **Comment:** *Custom Rule: Add a docstring to this new test function so newly added functions are documented inline. 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%2F40960&comment_hash=0dce89ecf3ffc6f32a6598138aa03f241c7ed6804d0664d33e5f66d1bee52d15&reaction=like'>👍</a> | <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F40960&comment_hash=0dce89ecf3ffc6f32a6598138aa03f241c7ed6804d0664d33e5f66d1bee52d15&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]
