Skip to content

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

Fix Sankey click data for extra columns (#74283)

Anderson482d1dbea596
diff --git a/frontend/src/metabase/visualizations/echarts/graph/sankey/option/tooltip.tsx b/frontend/src/metabase/visualizations/echarts/graph/sankey/option/tooltip.tsx
index 1dc88a845ae..408d1d4705d 100644
--- a/frontend/src/metabase/visualizations/echarts/graph/sankey/option/tooltip.tsx
+++ b/frontend/src/metabase/visualizations/echarts/graph/sankey/option/tooltip.tsx
@@ -44,7 +44,11 @@ const ChartItemTooltip = ({ chartModel, params }: ChartItemTooltipProps) => {
const targetNode = chartModel.data.nodes.find(
(node) => node.rawName === data.target,
);
- header = `${formatters.source(node.displayName)} → ${formatters.target(targetNode?.displayName ?? data.target)}`;
+ const headerSource = formatters.source(node?.displayName ?? data.source);
+ const headerTarget = formatters.target(
+ targetNode?.displayName ?? data.target,
+ );
+ header = `${headerSource} → ${headerTarget}`;
}
if (!node) {
diff --git a/frontend/src/metabase/visualizations/visualizations/SankeyChart/events.ts b/frontend/src/metabase/visualizations/visualizations/SankeyChart/events.ts
index d1cf43b053e..59e8a6aa813 100644
--- a/frontend/src/metabase/visualizations/visualizations/SankeyChart/events.ts
+++ b/frontend/src/metabase/visualizations/visualizations/SankeyChart/events.ts
@@ -17,12 +17,7 @@ import type {
import type { EChartsEventHandler } from "metabase/visualizations/types/echarts";
import Question from "metabase-lib/v1/Question";
import { getColumnKey } from "metabase-lib/v1/queries/utils/column-key";
-import type {
- Card,
- DatasetColumn,
- RawSeries,
- RowValue,
-} from "metabase-types/api";
+import type { Card, RawSeries, RowValue } from "metabase-types/api";
const getSankeyClickData = (
[
@@ -31,9 +26,8 @@ const getSankeyClickData = (
},
]: RawSeries,
columnValues: Record<ColumnKey, RowValue>,
- predicate: (col: DatasetColumn, index: number) => boolean = () => true,
) => {
- return cols.filter(predicate).map((col) => {
+ return cols.map((col) => {
return {
col,
value: columnValues[getColumnKey(col)],
@@ -69,31 +63,28 @@ export const createSankeyClickData = (
if (isSankeyNodeEvent(event)) {
const source = sankeyColumns.source;
const target = sankeyColumns.target;
+ const columnValues = event.data.hasInputs
+ ? event.data.inputColumnValues
+ : event.data.outputColumnValues;
clickData.column = event.data.hasInputs ? target.column : source.column;
clickData.value = event.data.rawName;
- clickData.data = getSankeyClickData(
- rawSeries,
- event.data.inputColumnValues,
- (_col, index) => index === source.index || index === target.index,
- );
+ clickData.data = getSankeyClickData(rawSeries, columnValues);
} else if (isSankeyEdgeEvent(event)) {
- if (isNativeQuery(rawSeries[0].card)) {
- return null;
- }
-
clickData.data = getSankeyClickData(rawSeries, event.data.columnValues);
- clickData.dimensions = [
- {
- column: sankeyColumns.source.column,
- value: event.data.source,
- },
- {
- column: sankeyColumns.target.column,
- value: event.data.target,
- },
- ];
+ if (!isNativeQuery(rawSeries[0].card)) {
+ clickData.dimensions = [
+ {
+ column: sankeyColumns.source.column,
+ value: event.data.source,
+ },
+ {
+ column: sankeyColumns.target.column,
+ value: event.data.target,
+ },
+ ];
+ }
}
return clickData;
diff --git a/frontend/src/metabase/visualizations/visualizations/SankeyChart/events.unit.spec.ts b/frontend/src/metabase/visualizations/visualizations/SankeyChart/events.unit.spec.ts
index c644c91df9b..ce011ba5de8 100644
--- a/frontend/src/metabase/visualizations/visualizations/SankeyChart/events.unit.spec.ts
+++ b/frontend/src/metabase/visualizations/visualizations/SankeyChart/events.unit.spec.ts
@@ -1,6 +1,9 @@
import type { EChartsSeriesMouseEvent } from "metabase/visualizations/echarts/types";
import { getColumnKey } from "metabase-lib/v1/queries/utils/column-key";
-import { createMockCard } from "metabase-types/api/mocks/card";
+import {
+ createMockCard,
+ createMockNativeCard,
+} from "metabase-types/api/mocks/card";
import {
createMockColumn,
createMockDatasetData,
@@ -25,13 +28,18 @@ describe("createSankeyClickData", () => {
display_name: "Amount",
base_type: "type/Number",
}),
+ createMockColumn({
+ name: "Raw Vendor",
+ display_name: "Raw Vendor",
+ base_type: "type/Text",
+ }),
];
const rawSeries = [
{
card: createMockCard(),
data: createMockDatasetData({
- rows: [["A", "B", 10]],
+ rows: [["A", "B", 10, "Vendor 1"]],
cols: columns,
}),
},
@@ -50,7 +58,7 @@ describe("createSankeyClickData", () => {
},
} as unknown as EChartsSeriesMouseEvent["event"];
- it("should create click data for node events without inputs", () => {
+ it("should create click data for node events without inputs (#72932)", () => {
const nodeEvent = {
dataType: "node",
data: {
@@ -60,12 +68,13 @@ describe("createSankeyClickData", () => {
hasInputs: false,
hasOutputs: true,
origin: "both" as const,
- inputColumnValues: {
+ inputColumnValues: {},
+ outputColumnValues: {
[getColumnKey(columns[0])]: "A",
[getColumnKey(columns[1])]: "B",
[getColumnKey(columns[2])]: 10,
+ [getColumnKey(columns[3])]: "Vendor 1",
},
- outputColumnValues: {},
outputLinkByTarget: new Map(),
},
event: mockEvent,
@@ -88,11 +97,14 @@ describe("createSankeyClickData", () => {
data: expect.arrayContaining([
expect.objectContaining({ col: columns[0], value: "A" }),
expect.objectContaining({ col: columns[1], value: "B" }),
+ expect.objectContaining({ col: columns[2], value: 10 }),
+ expect.objectContaining({ col: columns[3], value: "Vendor 1" }),
]),
});
+ expect(clickData?.data).toHaveLength(columns.length);
});
- it("should create click data for node events with inputs", () => {
+ it("should create click data for node events with inputs (#72932)", () => {
const nodeEvent = {
dataType: "node",
data: {
@@ -106,6 +118,7 @@ describe("createSankeyClickData", () => {
[getColumnKey(columns[0])]: "A",
[getColumnKey(columns[1])]: "B",
[getColumnKey(columns[2])]: 10,
+ [getColumnKey(columns[3])]: "Vendor 1",
},
outputColumnValues: {},
outputLinkByTarget: new Map(),
@@ -130,8 +143,11 @@ describe("createSankeyClickData", () => {
data: expect.arrayContaining([
expect.objectContaining({ col: columns[0], value: "A" }),
expect.objectContaining({ col: columns[1], value: "B" }),
+ expect.objectContaining({ col: columns[2], value: 10 }),
+ expect.objectContaining({ col: columns[3], value: "Vendor 1" }),
]),
});
+ expect(clickData?.data).toHaveLength(columns.length);
});
it("should create click data for edge events", () => {
@@ -167,6 +183,7 @@ describe("createSankeyClickData", () => {
[getColumnKey(columns[0])]: "A",
[getColumnKey(columns[1])]: "B",
[getColumnKey(columns[2])]: 10,
+ [getColumnKey(columns[3])]: "Vendor 1",
},
sourceNode,
targetNode,
@@ -194,7 +211,79 @@ describe("createSankeyClickData", () => {
expect.objectContaining({ col: columns[0], value: "A" }),
expect.objectContaining({ col: columns[1], value: "B" }),
expect.objectContaining({ col: columns[2], value: 10 }),
+ expect.objectContaining({ col: columns[3], value: "Vendor 1" }),
+ ]),
+ });
+ expect(clickData?.data).toHaveLength(columns.length);
+ });
+
+ it("should create click data for native query edge events (#72932)", () => {
+ const sourceNode = {
+ rawName: "A",
+ displayName: "A",
+ level: 0,
+ hasInputs: false,
+ hasOutputs: true,
+ inputColumnValues: {},
+ outputColumnValues: {},
+ outputLinkByTarget: new Map(),
+ };
+
+ const targetNode = {
+ rawName: "B",
+ displayName: "B",
+ level: 1,
+ hasInputs: true,
+ hasOutputs: false,
+ inputColumnValues: {},
+ outputColumnValues: {},
+ outputLinkByTarget: new Map(),
+ };
+
+ const edgeEvent = {
+ dataType: "edge",
+ data: {
+ source: "A",
+ target: "B",
+ value: 10,
+ columnValues: {
+ [getColumnKey(columns[0])]: "A",
+ [getColumnKey(columns[1])]: "B",
+ [getColumnKey(columns[2])]: 10,
+ [getColumnKey(columns[3])]: "Vendor 1",
+ },
+ sourceNode,
+ targetNode,
+ },
+ event: mockEvent,
+ value: 10,
+ seriesType: "sankey",
+ };
+
+ const nativeRawSeries = [
+ {
+ ...rawSeries[0],
+ card: createMockNativeCard(),
+ },
+ ];
+
+ const clickData = createSankeyClickData(
+ edgeEvent,
+ sankeyColumns,
+ nativeRawSeries,
+ settings,
+ );
+
+ expect(clickData).toEqual({
+ event: mockEvent.event,
+ settings,
+ data: expect.arrayContaining([
+ expect.objectContaining({ col: columns[0], value: "A" }),
+ expect.objectContaining({ col: columns[1], value: "B" }),
+ expect.objectContaining({ col: columns[2], value: 10 }),
+ expect.objectContaining({ col: columns[3], value: "Vendor 1" }),
]),
});
+ expect(clickData?.data).toHaveLength(columns.length);
});
});