aminghadersohi commented on code in PR #40957: URL: https://github.com/apache/superset/pull/40957#discussion_r3417078834
########## superset/mcp_service/dashboard/tool/update_dashboard.py: ########## @@ -0,0 +1,352 @@ +# 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. + +""" +MCP tool: update_dashboard + +This tool performs a partial update of dashboard metadata (title, slug, +published state, certification, roles, tags, CSS, theme, and selected +json_metadata settings). +""" + +import logging +from typing import Any + +from fastmcp import Context +from sqlalchemy.exc import SQLAlchemyError +from superset_core.mcp.decorators import tool, ToolAnnotations + +from superset.commands.exceptions import CommandException +from superset.extensions import event_logger +from superset.mcp_service.dashboard.schemas import ( + DashboardInfo, + serialize_chart_summary, + UpdateDashboardRequest, + UpdateDashboardResponse, +) +from superset.mcp_service.privacy import user_can_view_data_model_metadata +from superset.mcp_service.utils.url_utils import get_superset_base_url +from superset.utils import json + +logger = logging.getLogger(__name__) + +# Direct dashboard columns accepted by UpdateDashboardCommand +# (subset of DashboardPutSchema). +_DIRECT_FIELDS = ( + "dashboard_title", + "slug", + "published", + "css", + "theme_id", + "certified_by", + "certification_details", + "roles", + "tags", +) + +# Convenience fields stored inside the dashboard's json_metadata blob. +_METADATA_FIELDS = ( + "color_scheme", + "cross_filters_enabled", + "refresh_frequency", + "filter_bar_orientation", +) + + +def _build_update_properties( + request: UpdateDashboardRequest, dashboard: Any +) -> tuple[dict[str, Any], list[str]]: + """Build the UpdateDashboardCommand properties dict from the request. + + Returns ``(properties, updated_fields)`` where *updated_fields* lists + the request fields that will be changed. + + json_metadata is a stringified JSON blob and + ``DashboardDAO.set_dash_metadata`` resets absent keys to defaults + (e.g. ``expanded_slices`` -> {}). To avoid silently destroying state, + the dashboard's FULL current json_metadata is read, the requested + changes are merged in, and the complete blob is written back. + """ + properties: dict[str, Any] = {} + updated_fields: list[str] = [] + + for field in _DIRECT_FIELDS: + value = getattr(request, field) + if value is not None: + properties[field] = value + updated_fields.append(field) Review Comment: Fixed in 8c0114428593607f7438f639784f8eea322c5a16. Confirmed the gap: `validate_css` is wired through the marshmallow `DashboardPutSchema`, which this tool bypasses by building command properties directly, and `UpdateDashboardCommand.validate()` has no CSS check. Added a `validate_css` call in the tool before persisting `css`, so the MCP path now rejects the same constructs (`@import`, script-scheme URLs, `expression(`, etc.) as the REST path. Covered by `test_update_rejects_dangerous_css`. ########## superset/mcp_service/dashboard/tool/update_dashboard.py: ########## @@ -0,0 +1,352 @@ +# 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. + +""" +MCP tool: update_dashboard + +This tool performs a partial update of dashboard metadata (title, slug, +published state, certification, roles, tags, CSS, theme, and selected +json_metadata settings). +""" + +import logging +from typing import Any + +from fastmcp import Context +from sqlalchemy.exc import SQLAlchemyError +from superset_core.mcp.decorators import tool, ToolAnnotations + +from superset.commands.exceptions import CommandException +from superset.extensions import event_logger +from superset.mcp_service.dashboard.schemas import ( + DashboardInfo, + serialize_chart_summary, + UpdateDashboardRequest, + UpdateDashboardResponse, +) +from superset.mcp_service.privacy import user_can_view_data_model_metadata +from superset.mcp_service.utils.url_utils import get_superset_base_url +from superset.utils import json + +logger = logging.getLogger(__name__) + +# Direct dashboard columns accepted by UpdateDashboardCommand +# (subset of DashboardPutSchema). +_DIRECT_FIELDS = ( + "dashboard_title", + "slug", + "published", + "css", + "theme_id", + "certified_by", + "certification_details", + "roles", + "tags", +) + +# Convenience fields stored inside the dashboard's json_metadata blob. +_METADATA_FIELDS = ( + "color_scheme", + "cross_filters_enabled", + "refresh_frequency", + "filter_bar_orientation", +) + + +def _build_update_properties( + request: UpdateDashboardRequest, dashboard: Any +) -> tuple[dict[str, Any], list[str]]: + """Build the UpdateDashboardCommand properties dict from the request. + + Returns ``(properties, updated_fields)`` where *updated_fields* lists + the request fields that will be changed. + + json_metadata is a stringified JSON blob and + ``DashboardDAO.set_dash_metadata`` resets absent keys to defaults + (e.g. ``expanded_slices`` -> {}). To avoid silently destroying state, + the dashboard's FULL current json_metadata is read, the requested + changes are merged in, and the complete blob is written back. + """ + properties: dict[str, Any] = {} + updated_fields: list[str] = [] + + for field in _DIRECT_FIELDS: + value = getattr(request, field) + if value is not None: + properties[field] = value + updated_fields.append(field) + + metadata_changes = { + field: value + for field in _METADATA_FIELDS + if (value := getattr(request, field)) is not None + } + if metadata_changes: + try: + current_metadata = json.loads(dashboard.json_metadata or "{}") + except (ValueError, TypeError): + logger.warning( + "Failed to parse existing json_metadata for dashboard %s; " + "starting from an empty metadata object", + dashboard.id, + ) + current_metadata = {} + if not isinstance(current_metadata, dict): + current_metadata = {} + properties["json_metadata"] = json.dumps( + {**current_metadata, **metadata_changes} + ) + updated_fields.extend(metadata_changes) + + return properties, updated_fields + + +def _find_and_authorize_dashboard( + dashboard_id: int, +) -> tuple[Any, UpdateDashboardResponse | None]: + """Return (dashboard, None) on success or (None, error_response) on failure.""" + from superset import security_manager + from superset.daos.dashboard import DashboardDAO + from superset.exceptions import SupersetSecurityException + + dashboard = DashboardDAO.find_by_id(dashboard_id) + if not dashboard: + return None, UpdateDashboardResponse( + error=( + f"Dashboard with ID {dashboard_id} not found." + " Use list_dashboards to get valid dashboard IDs." + ), + ) + + try: + security_manager.raise_for_ownership(dashboard) + except SupersetSecurityException: + return None, UpdateDashboardResponse( + permission_denied=True, + error=( + f"You don't have permission to edit dashboard " + f"'{dashboard.dashboard_title}' (ID: {dashboard_id})." + ), + ) + + return dashboard, None + + +def _serialize_updated_dashboard( + updated_dashboard: Any, updated_fields: list[str] +) -> UpdateDashboardResponse: + """Build the success response, re-fetching with eager-loaded relationships. + + The preceding command commit may invalidate the session in multi-tenant + environments; on re-fetch failure, return a minimal response using only + scalar attributes that are already loaded — relationship fields (tags, + slices) would trigger lazy-loading on the same dead session. + """ + from sqlalchemy.orm import subqueryload + + from superset import db + from superset.daos.dashboard import DashboardDAO + from superset.models.dashboard import Dashboard + from superset.models.slice import Slice + + dashboard_url = ( + f"{get_superset_base_url()}/superset/dashboard/{updated_dashboard.id}/" + ) + + try: + updated_dashboard = ( + DashboardDAO.find_by_id( + updated_dashboard.id, + query_options=[ + subqueryload(Dashboard.slices).subqueryload(Slice.tags), + subqueryload(Dashboard.tags), + ], + ) + or updated_dashboard + ) + except SQLAlchemyError: + logger.warning( + "Re-fetch of dashboard %s failed; returning minimal response", + updated_dashboard.id, + exc_info=True, + ) + try: + db.session.rollback() # pylint: disable=consider-using-transaction + except SQLAlchemyError: + logger.warning( + "Database rollback failed during dashboard re-fetch error handling", + exc_info=True, + ) + return UpdateDashboardResponse( + dashboard=DashboardInfo( + id=updated_dashboard.id, + dashboard_title=updated_dashboard.dashboard_title, + published=updated_dashboard.published, + url=dashboard_url, + ), + dashboard_url=dashboard_url, + updated_fields=updated_fields, + error=None, + ) + + from superset.mcp_service.dashboard.schemas import serialize_tag_object + + include_data_model_metadata = user_can_view_data_model_metadata() + dashboard_info = DashboardInfo( + id=updated_dashboard.id, + dashboard_title=updated_dashboard.dashboard_title, + slug=updated_dashboard.slug, + description=updated_dashboard.description, + css=updated_dashboard.css, + certified_by=updated_dashboard.certified_by, + certification_details=updated_dashboard.certification_details, + published=updated_dashboard.published, + created_on=updated_dashboard.created_on, + changed_on=updated_dashboard.changed_on, + uuid=str(updated_dashboard.uuid) if updated_dashboard.uuid else None, + url=dashboard_url, + chart_count=len(updated_dashboard.slices), + tags=[ + serialize_tag_object(tag) + for tag in getattr(updated_dashboard, "tags", []) + if serialize_tag_object(tag) is not None + ], Review Comment: Fixed in 8c0114428593607f7438f639784f8eea322c5a16 — each tag is now serialized once via a walrus assignment, matching the adjacent `charts` comprehension. ########## tests/unit_tests/mcp_service/dashboard/tool/test_update_dashboard.py: ########## @@ -0,0 +1,620 @@ +# 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 update_dashboard MCP tool. + +Follows the same pattern used in 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: +- Dashboard not found +- Permission denied (user does not own the dashboard) -> permission_denied=True +- No fields provided -> error +- Successful direct-field updates (title, publish/certification, roles/tags) +- json_metadata merge preserves existing keys (the set_dash_metadata gotcha) +- Command failure -> error response +- Schema-level validation (title sanitization, filter_bar_orientation literal) +""" + +import logging +from typing import Any +from unittest.mock import Mock, patch + +import pytest +from fastmcp import Client + +from superset.mcp_service.app import mcp +from superset.utils import json + +logging.basicConfig(level=logging.DEBUG) +logger = logging.getLogger(__name__) + + +# --------------------------------------------------------------------------- +# Fixtures +# --------------------------------------------------------------------------- + + [email protected] +def mcp_server() -> object: + """Return the FastMCP app instance for use in MCP client tests.""" + return mcp + + [email protected](autouse=True) Review Comment: Fixed in 8c0114428593607f7438f639784f8eea322c5a16 — annotated the fixture as `-> Iterator[Mock]`. ########## tests/unit_tests/mcp_service/dashboard/tool/test_update_dashboard.py: ########## @@ -0,0 +1,620 @@ +# 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 update_dashboard MCP tool. + +Follows the same pattern used in 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: +- Dashboard not found +- Permission denied (user does not own the dashboard) -> permission_denied=True +- No fields provided -> error +- Successful direct-field updates (title, publish/certification, roles/tags) +- json_metadata merge preserves existing keys (the set_dash_metadata gotcha) +- Command failure -> error response +- Schema-level validation (title sanitization, filter_bar_orientation literal) +""" + +import logging +from typing import Any +from unittest.mock import Mock, patch + +import pytest +from fastmcp import Client + +from superset.mcp_service.app import mcp +from superset.utils import json + +logging.basicConfig(level=logging.DEBUG) +logger = logging.getLogger(__name__) + + +# --------------------------------------------------------------------------- +# Fixtures +# --------------------------------------------------------------------------- + + [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(): + """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 +# --------------------------------------------------------------------------- + + +def _mock_dashboard( + id: int = 1, + title: str = "Sales Dashboard", + json_metadata: str | None = None, +) -> Mock: + """Create a minimal mock Dashboard object.""" + dashboard = Mock() + dashboard.id = id + dashboard.dashboard_title = title + dashboard.slug = f"test-dashboard-{id}" + dashboard.description = None + dashboard.published = True + dashboard.created_on = None + dashboard.changed_on = None + dashboard.uuid = f"dashboard-uuid-{id}" + dashboard.slices = [] + dashboard.owners = [] + dashboard.tags = [] + dashboard.roles = [] + dashboard.position_json = "{}" + dashboard.json_metadata = json_metadata + dashboard.css = None + dashboard.certified_by = None + dashboard.certification_details = None + dashboard.is_managed_externally = False + dashboard.external_url = None + return dashboard + + +async def _call_update(mcp_server: object, request: dict[str, Any]) -> dict[str, Any]: + async with Client(mcp_server) as client: + result = await client.call_tool("update_dashboard", {"request": request}) + return result.structured_content Review Comment: Fixed in 8c0114428593607f7438f639784f8eea322c5a16 — added a docstring to the `_call_update` helper. -- 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]
