Skip to content

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

fix: stacked bar chart crashes when card has multiple same-type aggregations (#68903)

Maksym Yakubychc3715127e2c4
diff --git a/e2e/test/scenarios/visualizations-charts/visualizations-charts-reproductions.cy.spec.ts b/e2e/test/scenarios/visualizations-charts/visualizations-charts-reproductions.cy.spec.ts
index 735b11f40c7..400b9b88250 100644
--- a/e2e/test/scenarios/visualizations-charts/visualizations-charts-reproductions.cy.spec.ts
+++ b/e2e/test/scenarios/visualizations-charts/visualizations-charts-reproductions.cy.spec.ts
@@ -468,7 +468,7 @@ describe("issue 59830", () => {
H.createQuestion(questionDetails, { visitQuestion: true });
cy.icon("warning").should("not.exist");
- cy.findByTestId("visualization-placeholder").should("be.visible");
+ cy.findByTestId("chart-container").should("be.visible");
});
});
@@ -849,3 +849,66 @@ describe("UXW-2696", () => {
});
});
});
+
+describe("issue #68819", () => {
+ beforeEach(() => {
+ H.restore();
+ cy.signInAsAdmin();
+ });
+
+ it("should not crash when renaming an aggregation changes sibling column deduplication (metabase#68819)", () => {
+ // Create a question with two Sum of Total aggregations
+ // These will be deduplicated as "sum" and "sum_2"
+ const questionDetails: StructuredQuestionDetails = {
+ display: "bar" as const,
+ query: {
+ "source-table": ORDERS_ID,
+ aggregation: [
+ ["sum", ["field", ORDERS.TOTAL, null]],
+ ["sum", ["field", ORDERS.TOTAL, null]],
+ ],
+ breakout: [
+ ["field", ORDERS.CREATED_AT, { "temporal-unit": "month" }],
+ ["field", PRODUCTS.CATEGORY, { "source-field": ORDERS.PRODUCT_ID }],
+ ],
+ },
+ visualization_settings: {
+ "stackable.stack_type": "stacked",
+ "graph.dimensions": ["CREATED_AT", "CATEGORY"],
+ "graph.metrics": ["sum", "sum_2"],
+ },
+ };
+
+ H.createQuestion(questionDetails, { visitQuestion: true });
+
+ H.echartsContainer().should("be.visible");
+
+ H.openNotebook();
+
+ H.getNotebookStep("summarize")
+ .findByTestId("aggregate-step")
+ .findAllByTestId("notebook-cell-item")
+ .first()
+ .click();
+
+ cy.findByLabelText("Back").click();
+
+ H.popover().findByText("Custom Expression").click();
+
+ H.CustomExpressionEditor.nameInput().clear().type("Sum");
+ H.popover().button("Update").click();
+
+ H.saveSavedQuestion();
+
+ cy.button("Visualize").click();
+
+ // The bug would cause: TypeError: cannot read properties of undefined (reading 'name')
+ H.echartsContainer().should("be.visible");
+ cy.findByTestId("query-builder-main")
+ .findByText(/error/i)
+ .should("not.exist");
+
+ cy.reload();
+ H.echartsContainer().should("be.visible");
+ });
+});
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingSeriesMultiple.unit.spec.js b/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingSeriesMultiple.unit.spec.js
index bf92052c9fb..fb5c9322380 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingSeriesMultiple.unit.spec.js
+++ b/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingSeriesMultiple.unit.spec.js
@@ -27,7 +27,14 @@ function getSeries(display, index, changeSeriesName) {
["a", 1],
["b", 2],
],
- cols: [{ name: "foo" }, { name: "bar" }],
+ cols: [
+ { name: "foo", display_name: "Foo", source: "breakout" },
+ {
+ name: `Test ${index}`,
+ display_name: `Test ${index}`,
+ source: "aggregation",
+ },
+ ],
},
};
}
diff --git a/frontend/src/metabase/visualizations/lib/utils.js b/frontend/src/metabase/visualizations/lib/utils.js
index b60f9d4a41f..40ff2b4b7ba 100644
--- a/frontend/src/metabase/visualizations/lib/utils.js
+++ b/frontend/src/metabase/visualizations/lib/utils.js
@@ -292,12 +292,6 @@ export function getSingleSeriesDimensionsAndMetrics(
);
if (
dimensionNotMetricColumns.length <= maxDimensions &&
- metricColumns.length === 1
- ) {
- dimensions = dimensionNotMetricColumns;
- metrics = metricColumns;
- } else if (
- dimensionNotMetricColumns.length === 1 &&
metricColumns.length <= maxMetrics
) {
dimensions = dimensionNotMetricColumns;
diff --git a/frontend/src/metabase/visualizations/shared/settings/cartesian-chart.ts b/frontend/src/metabase/visualizations/shared/settings/cartesian-chart.ts
index 950b1f15b16..04553e66f0a 100644
--- a/frontend/src/metabase/visualizations/shared/settings/cartesian-chart.ts
+++ b/frontend/src/metabase/visualizations/shared/settings/cartesian-chart.ts
@@ -60,18 +60,32 @@ export function getDefaultDimensions(
rawSeries: RawSeries,
settings: ComputedVisualizationSettings,
) {
- const mainSeriesColumns = rawSeries[0]?.data?.cols;
- const prevDimensions = (settings["graph.dimensions"] ?? [])
- .filter(isNotNull)
- .filter((columnName) =>
- mainSeriesColumns.some((col) => col.name === columnName),
- );
+ const [{ card, data }] = rawSeries;
+ const mainSeriesColumns = data?.cols ?? [];
+ const hasData = mainSeriesColumns.length > 0;
+ const prevDimensionsRaw = (settings["graph.dimensions"] ?? []).filter(
+ isNotNull,
+ );
+ const prevDimensions = hasData
+ ? prevDimensionsRaw.filter((columnName: string) =>
+ mainSeriesColumns.some((col: DatasetColumn) => col.name === columnName),
+ )
+ : prevDimensionsRaw;
const defaultDimensions = getDefaultColumns(rawSeries).dimensions;
- if (
+ const canReusePrevious =
prevDimensions.length > 0 &&
defaultDimensions.length > 0 &&
- defaultDimensions[0] == null
- ) {
+ defaultDimensions[0] == null &&
+ (!hasData ||
+ (columnsAreValid(
+ prevDimensionsRaw,
+ data,
+ getDefaultDimensionFilter(card.display),
+ ) &&
+ prevDimensionsRaw.filter((colName) => colName !== null).length ===
+ prevDimensionsRaw.length));
+
+ if (canReusePrevious) {
return prevDimensions;
}
@@ -82,14 +96,24 @@ export function getDefaultMetrics(
rawSeries: RawSeries,
settings: ComputedVisualizationSettings,
) {
- const [{ card }] = rawSeries;
+ const [{ card, data }] = rawSeries;
+ const hasData = (data?.cols ?? []).length > 0;
const prevMetrics = settings["graph.metrics"] ?? [];
const defaultMetrics = getDefaultColumns(rawSeries).metrics;
- if (
+ const canReusePrevious =
prevMetrics.length > 0 &&
defaultMetrics.length > 0 &&
- defaultMetrics[0] == null
- ) {
+ defaultMetrics[0] == null &&
+ (!hasData ||
+ (columnsAreValid(
+ prevMetrics,
+ data,
+ getDefaultMetricFilter(card.display),
+ ) &&
+ prevMetrics.filter((metric) => metric !== null).length ===
+ prevMetrics.length));
+
+ if (canReusePrevious) {
return prevMetrics;
}
return defaultMetrics.slice(0, getMaxMetricsSupported(card.display));
diff --git a/frontend/src/metabase/visualizations/shared/settings/cartesian-chart.unit.spec.ts b/frontend/src/metabase/visualizations/shared/settings/cartesian-chart.unit.spec.ts
index 5c6970fddd4..783ef135b54 100644
--- a/frontend/src/metabase/visualizations/shared/settings/cartesian-chart.unit.spec.ts
+++ b/frontend/src/metabase/visualizations/shared/settings/cartesian-chart.unit.spec.ts
@@ -1,9 +1,138 @@
import {
+ getDefaultColumns,
+ getDefaultDimensions,
+ getDefaultMetrics,
+} from "metabase/visualizations/shared/settings/cartesian-chart";
+import type { DatasetData, VisualizationDisplay } from "metabase-types/api";
+import {
+ createMockCard,
createMockColumn,
+ createMockDatasetData,
createMockSingleSeries,
} from "metabase-types/api/mocks";
-import { getDefaultColumns } from "./cartesian-chart";
+const createSeries = ({
+ display,
+ cols,
+ rows = [
+ [1, "a", 10],
+ [2, "b", 20],
+ ],
+}: {
+ display: VisualizationDisplay;
+ cols: DatasetData["cols"];
+ rows?: DatasetData["rows"];
+}) => {
+ return [
+ {
+ card: createMockCard({ display }),
+ data: createMockDatasetData({
+ cols,
+ rows,
+ }),
+ },
+ ];
+};
+
+describe("cartesian-chart defaults", () => {
+ it("ignores previous metrics that reference missing columns", () => {
+ const cols = [
+ createMockColumn({
+ name: "created_at",
+ display_name: "Created At",
+ source: "breakout",
+ }),
+ createMockColumn({
+ name: "sum",
+ display_name: "Sum",
+ base_type: "type/Integer",
+ source: "aggregation",
+ }),
+ ];
+ const series = createSeries({ display: "bar", cols });
+
+ const result = getDefaultMetrics(series, {
+ "graph.metrics": ["missing_metric"],
+ });
+
+ expect(result).toEqual(["sum"]);
+ });
+
+ it("ignores previous dimensions that reference missing columns", () => {
+ const cols = [
+ createMockColumn({
+ name: "created_at",
+ display_name: "Created At",
+ source: "breakout",
+ }),
+ createMockColumn({
+ name: "sum",
+ display_name: "Sum",
+ base_type: "type/Integer",
+ source: "aggregation",
+ }),
+ ];
+ const series = createSeries({ display: "bar", cols });
+
+ const result = getDefaultDimensions(series, {
+ "graph.dimensions": ["missing_dimension"],
+ });
+
+ expect(result).toEqual(["created_at"]);
+ });
+
+ it("reuses previous dimensions when defaults are unavailable but columns are valid", () => {
+ const cols = [
+ createMockColumn({
+ name: "dim",
+ display_name: "Dim",
+ source: "breakout",
+ }),
+ createMockColumn({
+ name: "m1",
+ display_name: "M1",
+ base_type: "type/Integer",
+ source: "aggregation",
+ }),
+ createMockColumn({
+ name: "m2",
+ display_name: "M2",
+ base_type: "type/Integer",
+ source: "aggregation",
+ }),
+ ];
+ const series = createSeries({ display: "scatter", cols });
+
+ const result = getDefaultDimensions(series, {
+ "graph.dimensions": ["dim"],
+ });
+
+ expect(result).toEqual(["dim"]);
+ });
+
+ it("reuses previous metrics when defaults are unavailable but columns are valid", () => {
+ const cols = [
+ createMockColumn({
+ name: "dim",
+ display_name: "Dim",
+ source: "breakout",
+ }),
+ createMockColumn({
+ name: "m1",
+ display_name: "M1",
+ base_type: "type/Integer",
+ source: "aggregation",
+ }),
+ ];
+ const series = createSeries({ display: "scatter", cols });
+
+ const result = getDefaultMetrics(series, {
+ "graph.metrics": ["m1"],
+ });
+
+ expect(result).toEqual(["m1"]);
+ });
+});
const COLS = [
createMockColumn({