codeant-ai-for-open-source[bot] commented on code in PR #40958: URL: https://github.com/apache/superset/pull/40958#discussion_r3493331176
########## superset/mcp_service/dashboard/tool/remove_chart_from_dashboard.py: ########## @@ -0,0 +1,490 @@ +# 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: remove_chart_from_dashboard + +This tool removes a chart from an existing dashboard. It is the inverse of +add_chart_to_existing_dashboard: it deletes the chart's CHART component(s) +from position_json (pruning ROW/COLUMN containers that become empty), +removes the chart from the dashboard's slices relationship, and cleans +stale references to the chart from json_metadata (expanded_slices, +timed_refresh_immune_slices, filter_scopes, default_filters). +""" + +import logging +from typing import Any, Dict + +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, + RemoveChartFromDashboardRequest, + RemoveChartFromDashboardResponse, + serialize_chart_summary, +) +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__) + +# Container types that should be deleted once they have no children left. +# TAB/TABS/GRID/ROOT containers are intentionally kept even when empty — +# deleting a TAB would silently change the dashboard's visible structure. +_PRUNABLE_TYPES = ("ROW", "COLUMN") + + +def _find_chart_keys(layout: Dict[str, Any], chart_id: int) -> list[str]: + """Return all layout keys of CHART components referencing *chart_id*. + + A chart can legitimately appear more than once in a layout (e.g. under + multiple tabs), so all occurrences are returned. + """ + # Accept both int and string chartId — position_json is user/frontend-authored + # and imported or hand-edited layouts may store chartId as a string. + return [ + key + for key, node in layout.items() + if isinstance(node, dict) + and node.get("type") == "CHART" + and (node.get("meta") or {}).get("chartId") in (chart_id, str(chart_id)) + ] + + +def _find_parent_key(layout: Dict[str, Any], component_key: str) -> str | None: + """Find the component whose children list contains *component_key*. + + The reverse lookup scans children lists instead of trusting the + ``parents`` metadata on the node, which can be stale in hand-edited or + programmatically generated layouts. + """ + for key, node in layout.items(): + if not isinstance(node, dict): + continue + children = node.get("children") + if isinstance(children, list) and component_key in children: + return key + return None + + +def _remove_component_and_prune( + layout: Dict[str, Any], component_key: str +) -> list[str]: + """Remove *component_key* from the layout and prune empty containers. + + Walks up the parent chain deleting ROW/COLUMN containers that become + empty as a result of the removal, so no orphaned wrapper nodes are left + behind. Returns the list of removed layout keys. + """ + removed: list[str] = [] + parent_key = _find_parent_key(layout, component_key) + + layout.pop(component_key, None) + removed.append(component_key) + + child_key = component_key + while parent_key is not None: + parent = layout.get(parent_key) + if not isinstance(parent, dict): + break + children = parent.get("children") + if isinstance(children, list): + parent["children"] = [c for c in children if c != child_key] + if parent.get("type") in _PRUNABLE_TYPES and not parent.get("children"): + grandparent_key = _find_parent_key(layout, parent_key) + layout.pop(parent_key, None) + removed.append(parent_key) + child_key = parent_key + parent_key = grandparent_key + else: + break + + return removed + + +def _remove_chart_from_layout(layout: Dict[str, Any], chart_id: int) -> list[str]: + """Remove every CHART component for *chart_id* from the layout. + + Returns all removed layout keys (charts plus pruned containers). + """ + removed: list[str] = [] + for chart_key in _find_chart_keys(layout, chart_id): + # The chart key may already be gone if it shared a pruned container. + if chart_key in layout: + removed.extend(_remove_component_and_prune(layout, chart_key)) + return removed + + +def _remove_id_from_list(values: Any, chart_id: int) -> tuple[Any, bool]: + """Return (new_list, changed) with *chart_id* removed from a list of IDs. + + Handles both int and str representations since json_metadata is + user/frontend-authored and not strictly typed. + """ + if not isinstance(values, list): + return values, False + filtered = [v for v in values if v != chart_id and v != str(chart_id)] + return filtered, len(filtered) != len(values) + + +def _clean_json_metadata(metadata: Dict[str, Any], chart_id: int) -> bool: + """Remove stale references to *chart_id* from a json_metadata dict. + + Cleans ``expanded_slices`` (dict keyed by chart ID), ``filter_scopes`` + (dict keyed by filter chart ID, with per-column ``immune`` ID lists), + ``timed_refresh_immune_slices`` (list of chart IDs), and + ``default_filters`` (a JSON-encoded string whose keys are chart IDs). + Mutates *metadata* in place and returns True when anything changed. + """ + changed = False + chart_key = str(chart_id) + + expanded_slices = metadata.get("expanded_slices") + if isinstance(expanded_slices, dict) and chart_key in expanded_slices: + del expanded_slices[chart_key] + changed = True + + immune_slices, immune_changed = _remove_id_from_list( + metadata.get("timed_refresh_immune_slices"), chart_id + ) + if immune_changed: + metadata["timed_refresh_immune_slices"] = immune_slices + changed = True + + filter_scopes = metadata.get("filter_scopes") + if isinstance(filter_scopes, dict): + if chart_key in filter_scopes: + del filter_scopes[chart_key] + changed = True + for column_scopes in filter_scopes.values(): + if not isinstance(column_scopes, dict): + continue + for column_config in column_scopes.values(): + if not isinstance(column_config, dict): + continue + immune, immune_changed = _remove_id_from_list( + column_config.get("immune"), chart_id + ) + if immune_changed: + column_config["immune"] = immune + changed = True + + # default_filters is stored as a JSON-encoded string within json_metadata, + # with chart IDs as string keys (mirrors DashboardDAO.set_dash_metadata). + default_filters_raw = metadata.get("default_filters") + if isinstance(default_filters_raw, str): + try: + default_filters = json.loads(default_filters_raw) + if isinstance(default_filters, dict) and chart_key in default_filters: + del default_filters[chart_key] + metadata["default_filters"] = json.dumps(default_filters) + changed = True + except (json.JSONDecodeError, TypeError): + pass + elif isinstance(default_filters_raw, dict) and chart_key in default_filters_raw: + del default_filters_raw[chart_key] + changed = True + + return changed + + +def _find_and_authorize_dashboard( + dashboard_id: int, +) -> tuple[Any, RemoveChartFromDashboardResponse | None]: + """Return (dashboard, None) on success or (None, error_response) on failure. + + Handles both the not-found case and the ownership check so the main tool + function doesn't need two separate branches for these pre-conditions. + """ + 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, RemoveChartFromDashboardResponse( + dashboard=None, + dashboard_url=None, + 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, RemoveChartFromDashboardResponse( + dashboard=None, + dashboard_url=None, + permission_denied=True, + error=( + f"You don't have permission to edit dashboard " + f"'{dashboard.dashboard_title}' (ID: {dashboard_id}). " + "Inform the user and do not attempt a workaround without " + "their confirmation." + ), + ) + + return dashboard, None + + +@tool( + tags=["mutate"], + class_permission_name="Dashboard", + method_permission_name="write", + annotations=ToolAnnotations( + title="Remove chart from dashboard", + readOnlyHint=False, + destructiveHint=True, + ), +) +def remove_chart_from_dashboard( # noqa: C901 — complexity is structural (layout traversal + multi-step authorization), not accidental + request: RemoveChartFromDashboardRequest, ctx: Context +) -> RemoveChartFromDashboardResponse: + """ + Remove a chart from an existing dashboard. + + Deletes the chart's layout component(s) from the dashboard (all + occurrences, including under tabs), prunes rows/columns left empty by + the removal, detaches the chart from the dashboard, and cleans stale + chart references from dashboard metadata (expanded_slices, + timed_refresh_immune_slices, filter_scopes, default_filters). The chart + itself is NOT deleted and remains available to other dashboards. + """ + try: + from superset import db + from superset.commands.dashboard.update import UpdateDashboardCommand + + # Validate dashboard exists and user has edit permission + with event_logger.log_context( + action="mcp.remove_chart_from_dashboard.validation" + ): + dashboard, auth_error = _find_and_authorize_dashboard(request.dashboard_id) + if auth_error is not None: + return auth_error + + # Remove the chart from the layout tree + with event_logger.log_context(action="mcp.remove_chart_from_dashboard.layout"): + try: + current_layout = json.loads(dashboard.position_json or "{}") + except (json.JSONDecodeError, TypeError): + current_layout = {} + if not isinstance(current_layout, dict): + current_layout = {} + + remaining_slices = [ + slc for slc in dashboard.slices if slc.id != request.chart_id + ] + chart_in_slices = len(remaining_slices) != len(dashboard.slices) + + removed_keys = _remove_chart_from_layout(current_layout, request.chart_id) + + if not removed_keys and not chart_in_slices: + return RemoveChartFromDashboardResponse( + dashboard=None, + dashboard_url=None, + error=( + f"Chart {request.chart_id} is not in dashboard " + f"{request.dashboard_id}. Use get_dashboard_info to " + "see which charts the dashboard contains." + ), + ) + + # Update the dashboard + with event_logger.log_context( + action="mcp.remove_chart_from_dashboard.db_write" + ): + update_data: dict[str, Any] = { + "position_json": json.dumps(current_layout), + "slices": remaining_slices, # Pass ORM objects, not IDs + } + + # Clean stale chart references from json_metadata without routing + # through UpdateDashboardCommand: that path calls + # DashboardDAO.set_dash_metadata which, when "positions" is + # present in the metadata blob, overwrites dashboard.slices from + # layout data and silently drops charts attached via the slices + # relationship but absent from position_json. + try: + metadata = json.loads(dashboard.json_metadata or "{}") + except (json.JSONDecodeError, TypeError): + metadata = None + metadata_changed = isinstance(metadata, dict) and _clean_json_metadata( + metadata, request.chart_id + ) + + command = UpdateDashboardCommand(request.dashboard_id, update_data) + updated_dashboard = command.run() + Review Comment: **Suggestion:** This flow reads `json_metadata` before `command.run()` and later writes that old snapshot back in a second commit, which creates a race condition: concurrent edits to dashboard metadata between those two points can be silently overwritten. Re-read and merge cleanup against the latest persisted metadata (or perform update+cleanup atomically in one transaction/locked row) before committing. [race condition] <details> <summary><b>Severity Level:</b> Major ⚠️</summary> ```mdx - ❌ Concurrent dashboard edits can lose json_metadata changes silently. - ⚠️ Dashboard filters or settings unexpectedly revert after MCP removal. ``` </details> <details> <summary><b>Steps of Reproduction ✅ </b></summary> ```mdx 1. One user (or process) updates a dashboard’s metadata through the main REST API by issuing `PUT /api/v1/dashboard/<pk>` to `DashboardRestApi.put` at `superset/dashboards/api.py:14-73`, which deserializes the body with `edit_model_schema` and calls `UpdateDashboardCommand(pk, item).run()` at line 73; inside `UpdateDashboardCommand.run` (`superset/commands/dashboard/update.py:58-79`), `DashboardDAO.update` and `DashboardDAO.set_dash_metadata` write a new `json_metadata` value (call this M1). 2. Around the same time, an MCP client calls `remove_chart_from_dashboard` via the MCP server, as done in `_call_remove` at `tests/unit_tests/mcp_service/dashboard/tool/test_remove_chart_from_dashboard.py:256-264`, which routes the request into `remove_chart_from_dashboard` in `superset/mcp_service/dashboard/tool/remove_chart_from_dashboard.py:2-15`. 3. In the MCP tool, after computing `update_data`, the code in the db-write block reads the dashboard’s existing `json_metadata` into a local `metadata` snapshot and computes `metadata_changed` before any dashboard update is executed (lines `329-335`): it runs `metadata = json.loads(dashboard.json_metadata or "{}")` and `_clean_json_metadata(metadata, request.chart_id)` while `dashboard` still reflects the older state (M0) from `_find_and_authorize_dashboard`, not necessarily the concurrent REST update M1. 4. If the REST `PUT` request commits its M1 changes before the MCP tool reaches the secondary metadata write, the MCP tool then calls `UpdateDashboardCommand(request.dashboard_id, update_data).run()` at `337-338` to update layout/slices, and afterwards, when `metadata_changed` is true, executes the cleanup commit at `142-147` that sets `updated_dashboard.json_metadata = json.dumps(metadata)` using the stale snapshot derived from M0 and commits. This final commit overwrites the column containing M1 with a version that only has chart references cleaned, silently discarding any unrelated metadata changes made by the concurrent REST update. ``` </details> [](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=11944667a6cf4355b33c413ef3b624bd&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=11944667a6cf4355b33c413ef3b624bd&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:** superset/mcp_service/dashboard/tool/remove_chart_from_dashboard.py **Line:** 329:338 **Comment:** *Race Condition: This flow reads `json_metadata` before `command.run()` and later writes that old snapshot back in a second commit, which creates a race condition: concurrent edits to dashboard metadata between those two points can be silently overwritten. Re-read and merge cleanup against the latest persisted metadata (or perform update+cleanup atomically in one transaction/locked row) before committing. 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%2F40958&comment_hash=175b4e84a63f6e5baa8c563c5d7b2e3f4ecf414181da7954b3ac013f4c1b4559&reaction=like'>👍</a> | <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F40958&comment_hash=175b4e84a63f6e5baa8c563c5d7b2e3f4ecf414181da7954b3ac013f4c1b4559&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]
