Skip to content

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

GDGT-3185 Replace document viz settings instead of merging them (#81889)

Kamil Mielnikbbef4a31a250
diff --git a/frontend/src/metabase/documents/components/EmbedQuestionSettingsSidebar.tsx b/frontend/src/metabase/documents/components/EmbedQuestionSettingsSidebar.tsx
index c7e42c1a9a2..e47823d612d 100644
--- a/frontend/src/metabase/documents/components/EmbedQuestionSettingsSidebar.tsx
+++ b/frontend/src/metabase/documents/components/EmbedQuestionSettingsSidebar.tsx
@@ -24,8 +24,8 @@ import type {
import {
closeSidebar,
+ replaceVizSettings,
updateVisualizationType,
- updateVizSettings,
} from "../documents.slice";
import { useCardData } from "../hooks/use-card-data";
import { useDraftCardOperations } from "../hooks/use-draft-card-operations";
@@ -76,18 +76,9 @@ export const EmbedQuestionSettingsSidebar = ({
const handleSettingsChange = (settings: VisualizationSettings) => {
if (selectedEmbedIndex !== null) {
if (!draftCard) {
- const baseCard = card;
- const newSettings = {
- ...baseCard?.visualization_settings,
- ...settings,
- };
- const actualCardId = ensureDraftCard(
- { visualization_settings: newSettings },
- true,
- );
- dispatch(updateVizSettings({ cardId: actualCardId, settings }));
+ ensureDraftCard({ visualization_settings: settings }, true);
} else {
- dispatch(updateVizSettings({ cardId, settings }));
+ dispatch(replaceVizSettings({ cardId, settings }));
}
}
};
diff --git a/frontend/src/metabase/documents/documents.slice.ts b/frontend/src/metabase/documents/documents.slice.ts
index b52dad825f1..a9d9fb093d6 100644
--- a/frontend/src/metabase/documents/documents.slice.ts
+++ b/frontend/src/metabase/documents/documents.slice.ts
@@ -13,6 +13,7 @@ import type {
} from "metabase/redux/store/documents";
import type {
Card,
+ CardId,
Document,
TimelineEvent,
TimelineEventId,
@@ -116,7 +117,7 @@ const documentsSlice = createSlice({
updateVizSettings: (
state,
action: PayloadAction<{
- cardId: number;
+ cardId: CardId;
settings: VisualizationSettings;
}>,
) => {
@@ -128,9 +129,21 @@ const documentsSlice = createSlice({
};
}
},
+ replaceVizSettings: (
+ state,
+ action: PayloadAction<{
+ cardId: CardId;
+ settings: VisualizationSettings;
+ }>,
+ ) => {
+ const { cardId, settings } = action.payload;
+ if (state.draftCards[cardId]) {
+ state.draftCards[cardId].visualization_settings = settings;
+ }
+ },
updateVisualizationType: (
state,
- action: PayloadAction<{ cardId: number; display: VisualizationDisplay }>,
+ action: PayloadAction<{ cardId: CardId; display: VisualizationDisplay }>,
) => {
const { cardId, display } = action.payload;
if (state.draftCards[cardId]) {
@@ -207,6 +220,7 @@ export const {
deselectTimelineEvents,
clearFocusedTimelineEvents,
updateVizSettings,
+ replaceVizSettings,
updateVisualizationType,
closeSidebar,
setCardEmbeds,
diff --git a/frontend/src/metabase/documents/documents.slice.unit.spec.ts b/frontend/src/metabase/documents/documents.slice.unit.spec.ts
new file mode 100644
index 00000000000..00817571b22
--- /dev/null
+++ b/frontend/src/metabase/documents/documents.slice.unit.spec.ts
@@ -0,0 +1,85 @@
+import type { DocumentsState } from "metabase/redux/store/documents";
+import type { VisualizationSettings } from "metabase-types/api";
+import { createMockCard } from "metabase-types/api/mocks";
+
+import {
+ documentsReducer,
+ initialState,
+ replaceVizSettings,
+ updateVizSettings,
+} from "./documents.slice";
+
+const DRAFT_CARD_ID = -1;
+
+describe("documents slice", () => {
+ describe("updateVizSettings", () => {
+ it("merges the payload into the draft card's settings", () => {
+ const state = documentsReducer(
+ createStateWithDraftCard({ "card.title": "Title", threshold: 42 }),
+ updateVizSettings({
+ cardId: DRAFT_CARD_ID,
+ settings: { threshold: 43 },
+ }),
+ );
+
+ expect(getDraftCardSettings(state)).toEqual({
+ "card.title": "Title",
+ threshold: 43,
+ });
+ });
+
+ it("ignores cards without a draft", () => {
+ const initial = createStateWithDraftCard({ threshold: 42 });
+ const state = documentsReducer(
+ initial,
+ updateVizSettings({ cardId: 1, settings: { threshold: 43 } }),
+ );
+
+ expect(state).toBe(initial);
+ });
+ });
+
+ describe("replaceVizSettings", () => {
+ it("drops keys missing from the payload", () => {
+ const state = documentsReducer(
+ createStateWithDraftCard({ "card.title": "Title", threshold: 42 }),
+ replaceVizSettings({
+ cardId: DRAFT_CARD_ID,
+ settings: { "custom-viz:plugin:threshold": 43 },
+ }),
+ );
+
+ expect(getDraftCardSettings(state)).toEqual({
+ "custom-viz:plugin:threshold": 43,
+ });
+ });
+
+ it("ignores cards without a draft", () => {
+ const initial = createStateWithDraftCard({ threshold: 42 });
+ const state = documentsReducer(
+ initial,
+ replaceVizSettings({ cardId: 1, settings: { threshold: 43 } }),
+ );
+
+ expect(state).toBe(initial);
+ });
+ });
+});
+
+function createStateWithDraftCard(
+ visualization_settings: VisualizationSettings,
+): DocumentsState {
+ return {
+ ...initialState,
+ draftCards: {
+ [DRAFT_CARD_ID]: createMockCard({
+ id: DRAFT_CARD_ID,
+ visualization_settings,
+ }),
+ },
+ };
+}
+
+function getDraftCardSettings(state: DocumentsState) {
+ return state.draftCards[DRAFT_CARD_ID].visualization_settings;
+}