fix(dashboard): import with overwrite flag replaces charts instead of merging by rusackas · Pull Request #36551 · apache/superset

rusackas · 2025-12-11T23:31:21Z

SUMMARY

When importing dashboards via /api/v1/dashboard/import/ with overwrite=True, the dashboard's chart associations were being merged with existing charts instead of being replaced. This made it impossible to use the import API for proper source control workflows where the imported dashboard should exactly match the import file.

Root Cause:
The ImportDashboardsCommand._import() method was only adding new chart relationships without removing existing ones when overwrite=True. In contrast, the ImportAssetsCommand._import() method (from PR #22208) correctly deletes existing relationships before inserting new ones.

The Fix:
This PR mirrors the behavior of the assets import API by:

Deleting all existing dashboard-slice relationships when overwrite=True before inserting the new ones from the import
Only querying existing relationships when overwrite=False (performance optimization)
Changing break to continue when encountering unknown chart UUIDs so all valid charts are processed instead of stopping at the first unknown one (also identified in PR fix(dashboard): Dashboard import commands not correctly replacing charts #25102 review)

Files Changed:

superset/commands/dashboard/importers/v1/__init__.py - Core fix implementation
tests/unit_tests/dashboards/commands/importers/v1/import_command_test.py - New tests for overwrite behavior

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

N/A - Backend API behavior change

TESTING INSTRUCTIONS

Create a dashboard with 2 charts (chartA and chartB)
Export the dashboard
Extract the ZIP and remove chartB references:
- Delete charts/chartB.yaml
- Remove chartB from dashboards/dashboard.yaml position JSON

Re-ZIP and import with overwrite=true:

curl -X POST "http://localhost:8088/api/v1/dashboard/import/" \
  -H "Authorization: Bearer $TOKEN" \
  -F "formData=@modified_dashboard.zip;type=application/zip" \
  -F "overwrite=true"

Before fix: Dashboard has both chartA and chartB (merged)
After fix: Dashboard has only chartA (replaced)

ADDITIONAL INFORMATION

Has associated issue: Import dashboard/assets with overwrite flag does not replace dashboards #22127
Required feature flags:
Changes UI
Includes DB Migration
Introduces new feature or API
Removes existing feature or API

Related PRs:

fix(assets api): import replaces dashboard #22208 - Original fix for assets API (merged)
fix:#22127 #23489 - Previous attempt at this fix (closed)
fix(dashboard): Dashboard import commands not correctly replacing charts #25102 - Another attempt at this fix (closed draft)

Generated with Claude Code

… merging Fixes #22127 When importing dashboards via /api/v1/dashboard/import/ with overwrite=True, the dashboard's chart associations were being merged with existing charts instead of being replaced. This made it impossible to use the import API for proper source control workflows where the imported dashboard should exactly match the import file. The fix mirrors the behavior of the assets import API (PR #22208) by: 1. Deleting all existing dashboard-slice relationships when overwrite=True before inserting the new ones from the import 2. Only querying existing relationships when overwrite=False (optimization) 3. Changing break to continue when encountering unknown chart UUIDs so all valid charts are processed instead of stopping at the first unknown one Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>

Copilot

Pull request overview

This PR fixes a bug where importing dashboards with overwrite=True was merging chart associations instead of replacing them, preventing proper source control workflows. The fix aligns the dashboard import behavior with the assets import API by deleting existing chart relationships before inserting new ones when overwriting.

Key changes:

Deletes all existing dashboard-slice relationships before inserting new ones when overwrite=True
Changes break to continue to process all valid charts instead of stopping at first unknown UUID
Adds comprehensive unit tests verifying overwrite and merge behaviors

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
superset/commands/dashboard/importers/v1/init.py	Core fix: deletes existing chart relationships when overwriting and processes all valid chart UUIDs
tests/unit_tests/dashboards/commands/importers/v1/import_command_test.py	New test file with 4 tests covering overwrite replacement, merge behavior, and edge cases

Copilot · 2025-12-15T18:33:27Z

+        if dashboard_chart_ids:
+            values = [
+                {"dashboard_id": dashboard_id, "slice_id": chart_id}
+                for (dashboard_id, chart_id) in dashboard_chart_ids


The check if dashboard_chart_ids: guards against inserting an empty list, but the main issue is that when overwrite=True and the imported dashboard has no charts, the old relationships are deleted (line 189-193) but nothing prevents the code from attempting an insert with an empty list. While SQLAlchemy typically handles empty inserts gracefully, this check should be placed before both the delete operation and the insert to maintain consistency and avoid unnecessary database operations when there are no chart relationships to manage.

Copilot · 2025-12-15T18:33:27Z

+    expected_number_of_dashboards = len(dashboards_config_1)
+    expected_number_of_charts = len(charts_config_1)


The variable names expected_number_of_dashboards and expected_number_of_charts are misleading. These represent the count of dashboard configurations and chart configurations in the import, not necessarily the expected number after import (especially for charts, which counts chart-dashboard associations in this test, not unique charts). Consider renaming to import_config_dashboard_count and import_config_chart_count, or add assertions that clarify what these values represent in the context of the test.

mistercrunch

LGTM

… merging (#36551) Co-authored-by: Claude <noreply@anthropic.com> (cherry picked from commit 52c711b)

… merging (#36551) Co-authored-by: Claude <noreply@anthropic.com>

… merging (apache#36551) Co-authored-by: Claude <noreply@anthropic.com> (cherry picked from commit 52c711b)

Cover remaining 6.1 features across existing and new pages: MCP server: - Add MCP_PARSE_REQUEST_ENABLED to configuration reference - Add Audit Events section (MCP tool calls appear in Action Log) - Add Tool Pagination section documenting cursor-based pagination (#37674) Using AI with Superset: - Expand Available Tools Reference into categorized sections covering all new tools added in the MCP tool library expansion - Document preview-first workflow for generate_chart / update_chart Creating Your First Dashboard: - AG Grid server-side column filters (#35683): filter types, AND/OR logic, pagination interaction - Time Shift for AG Grid Interactive Table (#37072) - Dynamic currency formatting via currency_code_column dataset field (#36416) - ECharts option editor in Explore for JSON overrides (#37868) - Table chart: export behavior with search filter active (#36281) - Dataset folders: organizing datasets into groups (#36239) - PWA file handler: opening CSV/XLS/Parquet from OS file manager (#36191) - Share database connection option when adding a new database (#37940) Exploring Data: - Dialect-aware Format SQL (applies selected database dialect) (#39393) - SQL Lab tips section and time range natural language expressions (consolidates content from batch 4 for master branch) Importing/Exporting: - Dashboard import overwrite behavior: charts are replaced not duplicated (#36551) - UUID in REST API POST responses for dataset/chart/dashboard (#37806) New pages: - docs/docs/using-superset/embedding.mdx: embedded SDK quick start, resolvePermalinkUrl callback (#36924), DISABLE_EMBEDDED_SUPERSET_LOGOUT feature flag (#37537), URL parameters, guest token security notes - docs/admin_docs/configuration/aws-iam.mdx: cross-account IAM authentication for Aurora and Redshift via STS AssumeRole (#37585), configuration reference, trust policy setup guide Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

… merging (apache#36551) Co-authored-by: Claude <noreply@anthropic.com>

pull-request-size Bot added the size/L label Dec 11, 2025

dosubot Bot added api Related to the REST API change:backend Requires changing the backend labels Dec 11, 2025

chore: trigger CI re-run

d6baff4

github-actions Bot removed the api Related to the REST API label Dec 11, 2025

rusackas requested review from betodealmeida, Copilot and michael-s-molina December 15, 2025 18:32

Copilot AI reviewed Dec 15, 2025

View reviewed changes

mistercrunch approved these changes Dec 15, 2025

View reviewed changes

dpgaspar approved these changes Dec 16, 2025

View reviewed changes

rusackas merged commit 52c711b into master Dec 16, 2025
56 checks passed

rusackas deleted the fix-22127-dashboard-import-overwrite branch December 16, 2025 17:09

sadpandajoe pushed a commit that referenced this pull request Dec 17, 2025

fix(dashboard): import with overwrite flag replaces charts instead of…

cffaffd

… merging (#36551) Co-authored-by: Claude <noreply@anthropic.com> (cherry picked from commit 52c711b)

sadpandajoe added the v6.0 Label added by the release manager to track PRs to be included in the 6.0 branch label Dec 17, 2025

betodealmeida pushed a commit that referenced this pull request Dec 19, 2025

fix(dashboard): import with overwrite flag replaces charts instead of…

ecc974d

… merging (#36551) Co-authored-by: Claude <noreply@anthropic.com>

ramiroaquinoromero mentioned this pull request Jan 27, 2026

fix(dashboard-import): dashboard import fails with keyerror when referencing deleted charts in expanded_slices metadata #37042

Closed

9 tasks

rusackas mentioned this pull request Apr 17, 2026

docs: Superset 6.1 documentation catch-up — batch 5 #39454

Merged

6 tasks

qfcwell pushed a commit to qfcwell/superset that referenced this pull request May 12, 2026

fix(dashboard): import with overwrite flag replaces charts instead of…

adf1988

… merging (apache#36551) Co-authored-by: Claude <noreply@anthropic.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(dashboard): import with overwrite flag replaces charts instead of merging#36551

fix(dashboard): import with overwrite flag replaces charts instead of merging#36551
rusackas merged 2 commits into
masterfrom
fix-22127-dashboard-import-overwrite

rusackas commented Dec 11, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Dec 15, 2025

Uh oh!

Copilot AI Dec 15, 2025

Uh oh!

mistercrunch left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

		expected_number_of_dashboards = len(dashboards_config_1)
		expected_number_of_charts = len(charts_config_1)

Conversation

rusackas commented Dec 11, 2025

SUMMARY

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

mistercrunch left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants