Skip to content

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

original card description should be provided to visualizer (#64197)

Aleksandr Lesnenkocfa62e4b8bec
diff --git a/frontend/src/metabase/visualizer/utils/get-initial-state-for-card-data-source.ts b/frontend/src/metabase/visualizer/utils/get-initial-state-for-card-data-source.ts
index 9f8a17e145a..667cfc9fab7 100644
--- a/frontend/src/metabase/visualizer/utils/get-initial-state-for-card-data-source.ts
+++ b/frontend/src/metabase/visualizer/utils/get-initial-state-for-card-data-source.ts
@@ -113,6 +113,10 @@ export function getInitialStateForCardDataSource(
datasetFallbacks: { [card.id]: dataset },
};
+ if (card.description != null) {
+ state.settings["card.description"] = card.description;
+ }
+
const dataSource = createDataSource("card", card.id, card.name);
if (card.display === "scalar" || card.display === "gauge") {
@@ -225,5 +229,9 @@ export function getInitialStateForCardDataSource(
"card.title": card.name,
};
+ if (card.description != null) {
+ state.settings["card.description"] = card.description;
+ }
+
return state;
}
diff --git a/frontend/src/metabase/visualizer/utils/get-initial-state-for-card-data-source.unit.spec.ts b/frontend/src/metabase/visualizer/utils/get-initial-state-for-card-data-source.unit.spec.ts
index 02acc54d535..567d9da825f 100644
--- a/frontend/src/metabase/visualizer/utils/get-initial-state-for-card-data-source.unit.spec.ts
+++ b/frontend/src/metabase/visualizer/utils/get-initial-state-for-card-data-source.unit.spec.ts
@@ -18,6 +18,7 @@ describe("getInitialStateForCardDataSource", () => {
card: createMockCard({
display: "smartscalar",
name: "ScalarMcSmartface",
+ description: null,
visualization_settings: {
"scalar.compact_primary_number": true,
},
@@ -72,6 +73,7 @@ describe("getInitialStateForCardDataSource", () => {
const card = createMockCard({
display: "table",
name: "TablyMcTableface",
+ description: null,
visualization_settings: {},
});
@@ -101,6 +103,20 @@ describe("getInitialStateForCardDataSource", () => {
});
});
+ it("should include card description in settings (metabase#63863)", () => {
+ const card = createMockCard({
+ display: "table",
+ name: "Test Card",
+ description: "This is a test description",
+ });
+
+ const state = getInitialStateForCardDataSource(card, dataset);
+
+ expect(state.settings["card.description"]).toEqual(
+ "This is a test description",
+ );
+ });
+
it("should ignore superfluous columns when the original card is a combo chart", () => {
const dataset = createMockDataset({
data: createMockDatasetData({
@@ -137,6 +153,7 @@ describe("getInitialStateForCardDataSource", () => {
const card = createMockCard({
display: "combo",
name: "ComboMcComboface",
+ description: null,
visualization_settings: {
"graph.metrics": ["sum", "sum_2"],
"graph.dimensions": ["CREATED_AT"],
@@ -230,6 +247,7 @@ describe("getInitialStateForCardDataSource", () => {
const card = createMockCard({
name: `${vizType} card`,
display: vizType,
+ description: null,
});
const initialState = getInitialStateForCardDataSource(card, dataset);
diff --git a/frontend/src/metabase/visualizer/utils/get-initial-state-for-multiple-series.ts b/frontend/src/metabase/visualizer/utils/get-initial-state-for-multiple-series.ts
index 8bb0ca8edd6..217e9ebadaf 100644
--- a/frontend/src/metabase/visualizer/utils/get-initial-state-for-multiple-series.ts
+++ b/frontend/src/metabase/visualizer/utils/get-initial-state-for-multiple-series.ts
@@ -170,5 +170,9 @@ export function getInitialStateForMultipleSeries(rawSeries: RawSeries) {
"card.title": mainCard.name,
};
+ if (mainCard.description != null) {
+ state.settings["card.description"] = mainCard.description;
+ }
+
return state;
}
diff --git a/frontend/src/metabase/visualizer/utils/get-initial-state-for-multiple-series.unit.spec.ts b/frontend/src/metabase/visualizer/utils/get-initial-state-for-multiple-series.unit.spec.ts
index c0781851548..82746dede5f 100644
--- a/frontend/src/metabase/visualizer/utils/get-initial-state-for-multiple-series.unit.spec.ts
+++ b/frontend/src/metabase/visualizer/utils/get-initial-state-for-multiple-series.unit.spec.ts
@@ -18,6 +18,7 @@ describe("getInitialVisualizerStateForMultipleSeries", () => {
id: 1,
name: "First Series",
display: "line",
+ description: null,
visualization_settings: {
"graph.metrics": ["Revenue"],
"graph.dimensions": ["Date"],
@@ -28,6 +29,7 @@ describe("getInitialVisualizerStateForMultipleSeries", () => {
id: 2,
name: "Second Series",
display: "line",
+ description: null,
visualization_settings: {
"graph.metrics": ["Profit"],
"graph.dimensions": ["Date"],
@@ -95,4 +97,34 @@ describe("getInitialVisualizerStateForMultipleSeries", () => {
"card.title": "First Series",
});
});
+
+ it("should include card description in settings (metabase#63863)", () => {
+ const firstCard = createMockCard({
+ id: 1,
+ name: "Test Series",
+ description: "Test description",
+ display: "line",
+ visualization_settings: {
+ "graph.metrics": ["Revenue"],
+ "graph.dimensions": ["Date"],
+ },
+ });
+
+ const rawSeries = [
+ createMockSingleSeries(firstCard, {
+ data: createMockDatasetData({
+ cols: [
+ createMockColumn({ name: "Date" }),
+ createMockColumn({ name: "Revenue" }),
+ ],
+ }),
+ }),
+ ];
+
+ const initialState = getInitialStateForMultipleSeries(rawSeries);
+
+ expect(initialState.settings["card.description"]).toEqual(
+ "Test description",
+ );
+ });
});