Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

UXW-69 Avoid persisting non-dashboard settings (#67592)

Gabriel Morenofe7668963cd8
diff --git a/frontend/src/metabase/visualizations/components/ChartSettings/DashboardChartSettings/DashboardChartSettings.tsx b/frontend/src/metabase/visualizations/components/ChartSettings/DashboardChartSettings/DashboardChartSettings.tsx
index 6d91204817e..61588435b1a 100644
--- a/frontend/src/metabase/visualizations/components/ChartSettings/DashboardChartSettings/DashboardChartSettings.tsx
+++ b/frontend/src/metabase/visualizations/components/ChartSettings/DashboardChartSettings/DashboardChartSettings.tsx
@@ -3,7 +3,9 @@ import _ from "underscore";
import { useDashboardContext } from "metabase/dashboard/context";
import { Divider, Flex } from "metabase/ui";
+import { getVisualizationRaw } from "metabase/visualizations";
import { getClickBehaviorSettings } from "metabase/visualizations/lib/settings";
+import { sanitizeDashcardSettings } from "metabase/visualizations/lib/settings/typed-utils";
import { getSettingsWidgetsForSeries } from "metabase/visualizations/lib/settings/visualization";
import type { VisualizationSettings } from "metabase-types/api";
@@ -39,9 +41,20 @@ export const DashboardChartSettings = ({
});
const handleDone = useCallback(() => {
- onChange?.(chartSettings ?? tempSettings ?? {});
+ const allSettings = chartSettings ?? tempSettings ?? {};
+
+ // Filter out settings with dashboard: false to avoid persisting
+ // settings that are hidden from dashboard UI
+ const visualization = getVisualizationRaw(series);
+ const vizSettingsDefs = visualization?.settings ?? {};
+ const settingsToSave = sanitizeDashcardSettings(
+ allSettings,
+ vizSettingsDefs,
+ );
+
+ onChange?.(settingsToSave);
onClose?.();
- }, [chartSettings, onChange, onClose, tempSettings]);
+ }, [chartSettings, onChange, onClose, tempSettings, series]);
const handleResetSettings = useCallback(() => {
const originalCardSettings = dashcard?.card.visualization_settings;
diff --git a/frontend/src/metabase/visualizations/lib/settings/typed-utils.ts b/frontend/src/metabase/visualizations/lib/settings/typed-utils.ts
index bdca5bf112d..28f0a4237d6 100644
--- a/frontend/src/metabase/visualizations/lib/settings/typed-utils.ts
+++ b/frontend/src/metabase/visualizations/lib/settings/typed-utils.ts
@@ -71,6 +71,24 @@ export const isSettingHiddenOnDashboards = (
return vizSettingDefinition.dashboard === false;
};
+/**
+ * Filters out visualization settings that should not be persisted in dashcards.
+ * Settings with `dashboard: false` are hidden from dashboard UI and should not
+ * be saved to avoid overriding the card's settings (like graph.dimensions, graph.metrics).
+ */
+export function sanitizeDashcardSettings(
+ settings: VisualizationSettings,
+ vizSettingsDefs: Record<
+ string,
+ VisualizationSettingDefinition<unknown, unknown>
+ >,
+): VisualizationSettings {
+ return _.pick(settings, (_, key) => {
+ const settingDef = vizSettingsDefs[key];
+ return !settingDef || !isSettingHiddenOnDashboards(settingDef);
+ });
+}
+
export function extendCardWithDashcardSettings(
card: Card | VirtualCard,
dashcardSettings?: VisualizationSettings,
diff --git a/frontend/src/metabase/visualizations/lib/settings/typed-utils.unit.spec.ts b/frontend/src/metabase/visualizations/lib/settings/typed-utils.unit.spec.ts
index e4ba8c58277..68ba7aa5e13 100644
--- a/frontend/src/metabase/visualizations/lib/settings/typed-utils.unit.spec.ts
+++ b/frontend/src/metabase/visualizations/lib/settings/typed-utils.unit.spec.ts
@@ -5,7 +5,11 @@ import {
createMockTableColumnOrderSetting,
} from "metabase-types/api/mocks";
-import { extendCardWithDashcardSettings, mergeSettings } from "./typed-utils";
+import {
+ extendCardWithDashcardSettings,
+ mergeSettings,
+ sanitizeDashcardSettings,
+} from "./typed-utils";
// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(BarChart);
@@ -172,3 +176,93 @@ describe("extendCardWithDashcardSettings", () => {
});
});
});
+
+describe("sanitizeDashcardSettings", () => {
+ it("should filter out settings with dashboard: false", () => {
+ const settings = {
+ "graph.dimensions": ["TAX"],
+ "graph.metrics": ["count"],
+ "graph.goal_label": "My Goal",
+ "card.title": "Custom Title",
+ };
+
+ const vizSettingsDefs = {
+ "graph.dimensions": { dashboard: false },
+ "graph.metrics": { dashboard: false },
+ "graph.goal_label": { dashboard: true },
+ "card.title": { dashboard: true },
+ } as any;
+
+ const result = sanitizeDashcardSettings(settings, vizSettingsDefs);
+
+ expect(result).toEqual({
+ "graph.goal_label": "My Goal",
+ "card.title": "Custom Title",
+ });
+ });
+
+ it("should keep settings that have no definition", () => {
+ const settings = {
+ "graph.dimensions": ["TAX"],
+ unknownSetting: "value",
+ };
+
+ const vizSettingsDefs = {
+ "graph.dimensions": { dashboard: false },
+ } as any;
+
+ const result = sanitizeDashcardSettings(settings, vizSettingsDefs);
+
+ expect(result).toEqual({
+ unknownSetting: "value",
+ });
+ });
+
+ it("should keep settings where dashboard is not explicitly false", () => {
+ const settings = {
+ "graph.dimensions": ["TAX"],
+ "graph.goal_value": 100,
+ "card.description": "Description",
+ };
+
+ const vizSettingsDefs = {
+ "graph.dimensions": { dashboard: false },
+ "graph.goal_value": {}, // no dashboard property
+ "card.description": { dashboard: undefined },
+ } as any;
+
+ const result = sanitizeDashcardSettings(settings, vizSettingsDefs);
+
+ expect(result).toEqual({
+ "graph.goal_value": 100,
+ "card.description": "Description",
+ });
+ });
+
+ it("should return empty object when all settings are dashboard: false", () => {
+ const settings = {
+ "graph.dimensions": ["TAX"],
+ "graph.metrics": ["count"],
+ };
+
+ const vizSettingsDefs = {
+ "graph.dimensions": { dashboard: false },
+ "graph.metrics": { dashboard: false },
+ } as any;
+
+ const result = sanitizeDashcardSettings(settings, vizSettingsDefs);
+
+ expect(result).toEqual({});
+ });
+
+ it("should handle empty settings", () => {
+ const settings = {};
+ const vizSettingsDefs = {
+ "graph.dimensions": { dashboard: false },
+ } as any;
+
+ const result = sanitizeDashcardSettings(settings, vizSettingsDefs);
+
+ expect(result).toEqual({});
+ });
+});