The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Fix static viz Row Chart failures on remapped columns (#82684)
Kevin Kelleher40ebe0bb9f0b
diff --git a/frontend/src/metabase-types/api/dataset.ts b/frontend/src/metabase-types/api/dataset.tsindex 373f3291c65..4e506c84f64 100644--- a/frontend/src/metabase-types/api/dataset.ts+++ b/frontend/src/metabase-types/api/dataset.ts@@ -90,7 +90,7 @@ export interface DatasetColumn {fk_target_field_id?: FieldId | null;should_index?: boolean;- remapping?: Map<RowValue, string | number>;+ remapping?: Map<RowValue, RowValue>;}export interface ResultsMetadata {diff --git a/frontend/src/metabase/static-viz/components/RowChart/RowChart.tsx b/frontend/src/metabase/static-viz/components/RowChart/RowChart.tsxindex 0389526ca2c..c7c47cc7012 100644--- a/frontend/src/metabase/static-viz/components/RowChart/RowChart.tsx+++ b/frontend/src/metabase/static-viz/components/RowChart/RowChart.tsx@@ -17,9 +17,7 @@ import {getXValueRange,} from "metabase/visualizations/visualizations/RowChart/utils/settings";import {- type RemappingHydratedChartData,RowChart,- extractRemappedColumns,getChartGoal,getGroupedDataset,getStackOffset,@@ -61,10 +59,7 @@ export const StaticRowChart = ({hasDevWatermark = false,fitWithinBounds = false,}: StaticChartProps) => {- // Unjustified type cast. FIXME- const data = extractRemappedColumns(- rawSeries[0].data,- ) as RemappingHydratedChartData;+ const data = rawSeries[0].data;const { getColor } = renderingContext;const columnValueFormatter = getColumnValueFormatter();diff --git a/frontend/src/metabase/static-viz/components/TreemapChart/TreemapChart.tsx b/frontend/src/metabase/static-viz/components/TreemapChart/TreemapChart.tsxindex 21611bd0497..a2bb26598bf 100644--- a/frontend/src/metabase/static-viz/components/TreemapChart/TreemapChart.tsx+++ b/frontend/src/metabase/static-viz/components/TreemapChart/TreemapChart.tsx@@ -8,7 +8,6 @@ import {type RenderingContext,type TreemapChartOptionConfig,type TreemapTree,- extractRemappings,getStaticTreemapOption,getTreemapChartColumns,getTreemapColors,@@ -41,20 +40,14 @@ export function TreemapChart({height,fitWithinBounds = false,}: StaticChartProps) {- const rawSeriesWithRemappings = extractRemappings(rawSeries);- const cols = rawSeriesWithRemappings[0]?.data?.cols ?? [];+ const cols = rawSeries[0]?.data?.cols ?? [];const treemapColumns = getTreemapChartColumns(cols, settings);if (!treemapColumns) {return null;}const treemapRows = settings["treemap.rows"];- const tree = getTreemapData(- rawSeriesWithRemappings,- treemapColumns,- treemapRows,- settings,- );+ const tree = getTreemapData(rawSeries, treemapColumns, treemapRows, settings);const colors = getTreemapColors(tree, treemapRows);const formatters = getTreemapFormatters(treemapColumns, settings, tree);diff --git a/frontend/src/metabase/static-viz/index.unit.spec.tsx b/frontend/src/metabase/static-viz/index.unit.spec.tsxindex 425062905b5..8233e5777c6 100644--- a/frontend/src/metabase/static-viz/index.unit.spec.tsx+++ b/frontend/src/metabase/static-viz/index.unit.spec.tsx@@ -72,3 +72,65 @@ describe("static viz chart colors", () => {expect(svg).not.toContain(INSTANCE_ACCENT_3);});});++const remappedStackedRowSeries = (): RawSeries<Card> => [+ {+ card: createMockCard({+ display: "row",+ visualization_settings: {+ "graph.dimensions": ["team", "category_id"],+ "graph.metrics": ["sum"],+ "stackable.stack_type": "stacked",+ },+ }),+ data: createMockDatasetData({+ cols: [+ createMockColumn({+ name: "category_id",+ display_name: "Category ID",+ base_type: "type/Integer",+ semantic_type: "type/Category",+ remapped_to: "Category label",+ }),+ createMockColumn({+ name: "team",+ display_name: "Team",+ base_type: "type/Text",+ }),+ createMockColumn({+ name: "sum",+ display_name: "Sum",+ base_type: "type/Float",+ semantic_type: "type/Number",+ }),+ createMockColumn({+ name: "Category label",+ display_name: "Category label",+ base_type: "type/Text",+ remapped_from: "category_id",+ }),+ ],+ rows: [+ [1, "Team A", 10, "Type A"],+ [1, "Team B", 20, "Type A"],+ [2, "Team C", 30, "Type B"],+ [2, "Team D", 40, "Type B"],+ ],+ }),+ },+];++describe("static viz remapped row charts", () => {+ it("renders a stacked row chart with remapped category labels", () => {+ const { type, content } = renderChart({+ rawSeries: remappedStackedRowSeries(),+ dashcardSettings: {},+ options: makeOptions(),+ });++ expect(type).toBe("svg");+ expect(content).toContain("Type A");+ expect(content).toContain("Type B");+ expect(content).toContain("Team A");+ });+});diff --git a/frontend/src/metabase/viz-core/lib/remapping.ts b/frontend/src/metabase/viz-core/lib/remapping.tsindex e5803e0af22..e5bd366360a 100644--- a/frontend/src/metabase/viz-core/lib/remapping.ts+++ b/frontend/src/metabase/viz-core/lib/remapping.ts@@ -2,17 +2,33 @@ import _ from "underscore";import type { DatasetData, Series } from "metabase-types/api";-import type { RemappingHydratedDatasetColumn } from "../types";+import type {+ RemappingHydratedChartData,+ RemappingHydratedDatasetColumn,+} from "../types";++const getRemapping = (col: RemappingHydratedDatasetColumn) => {+ // copy existing entries so this is idempotent, without mutating the caller's Map+ if (col.remapping) {+ return new Map(col.remapping);+ }+ if (col.remapped_to != null) {+ return new Map();+ }+ return undefined;+};// removes columns with `remapped_from` property and adds a `remapping` to the appropriate column-export const extractRemappedColumns = (data: DatasetData) => {+export const extractRemappedColumns = (+ data: DatasetData,+): RemappingHydratedChartData => {const cols: RemappingHydratedDatasetColumn[] = data.cols.map((col) => ({...col,remapped_from_index:col.remapped_from != null? _.findIndex(data.cols, (c) => c.name === col.remapped_from): undefined,- remapping: col.remapped_to != null ? new Map() : undefined,+ remapping: getRemapping(col),}));const rows = data.rows.map((row) =>diff --git a/frontend/src/metabase/viz-core/lib/remapping.unit.spec.ts b/frontend/src/metabase/viz-core/lib/remapping.unit.spec.tsnew file mode 100644index 00000000000..86f60813ca4--- /dev/null+++ b/frontend/src/metabase/viz-core/lib/remapping.unit.spec.ts@@ -0,0 +1,127 @@+import type { DatasetData } from "metabase-types/api";+import {+ createMockColumn,+ createMockDatasetData,+} from "metabase-types/api/mocks";++import { extractRemappedColumns } from "./remapping";++const remappedCategoryData = (): DatasetData =>+ createMockDatasetData({+ cols: [+ createMockColumn({+ name: "category_id",+ display_name: "Category ID",+ base_type: "type/Integer",+ semantic_type: "type/Category",+ remapped_to: "Category label",+ }),+ createMockColumn({+ name: "team",+ display_name: "Team",+ base_type: "type/Text",+ }),+ createMockColumn({+ name: "sum",+ display_name: "Sum",+ base_type: "type/Float",+ semantic_type: "type/Number",+ }),+ createMockColumn({+ name: "Category label",+ display_name: "Category label",+ base_type: "type/Text",+ remapped_from: "category_id",+ }),+ ],+ rows: [+ [1, "Team A", 10, "Type A"],+ [1, "Team B", 20, "Type A"],+ [2, "Team C", 30, "Type B"],+ [2, "Team D", 40, "Type B"],+ ],+ });++describe("extractRemappedColumns", () => {+ it("folds the companion column into a remapping Map and drops it", () => {+ const result = extractRemappedColumns(remappedCategoryData());++ expect(result.cols.map((col) => col.name)).toEqual([+ "category_id",+ "team",+ "sum",+ ]);+ expect(result.rows).toEqual([+ [1, "Team A", 10],+ [1, "Team B", 20],+ [2, "Team C", 30],+ [2, "Team D", 40],+ ]);+ expect(result.cols[0]?.remapping).toEqual(+ new Map([+ [1, "Type A"],+ [2, "Type B"],+ ]),+ );+ });++ it("preserves an existing remapping when called a second time", () => {+ const first = extractRemappedColumns(remappedCategoryData());+ const second = extractRemappedColumns(first);++ expect(second.cols.map((col) => col.name)).toEqual([+ "category_id",+ "team",+ "sum",+ ]);+ expect(second.cols[0]?.remapping).toEqual(+ new Map([+ [1, "Type A"],+ [2, "Type B"],+ ]),+ );+ });++ it("does not mutate the input column's remapping Map", () => {+ const existingRemapping = new Map([[1, "Type A"]]);+ const data = remappedCategoryData();+ data.cols[0] = createMockColumn({+ ...data.cols[0],+ remapping: existingRemapping,+ });++ const result = extractRemappedColumns(data);++ expect(existingRemapping).toEqual(new Map([[1, "Type A"]]));+ expect(result.cols[0]?.remapping).not.toBe(existingRemapping);+ expect(result.cols[0]?.remapping).toEqual(+ new Map([+ [1, "Type A"],+ [2, "Type B"],+ ]),+ );+ });++ it("leaves columns without remapped_to unchanged", () => {+ const data = createMockDatasetData({+ cols: [+ createMockColumn({ name: "team", base_type: "type/Text" }),+ createMockColumn({+ name: "sum",+ base_type: "type/Float",+ semantic_type: "type/Number",+ }),+ ],+ rows: [+ ["Team A", 10],+ ["Team B", 20],+ ],+ });++ const result = extractRemappedColumns(data);++ expect(result.cols.map((col) => col.name)).toEqual(["team", "sum"]);+ expect(result.cols[0]?.remapping).toBeUndefined();+ expect(result.rows).toEqual(data.rows);+ });+});diff --git a/frontend/src/metabase/viz-core/types/columns.ts b/frontend/src/metabase/viz-core/types/columns.tsindex 4a900ba2bcc..c6f1adde30d 100644--- a/frontend/src/metabase/viz-core/types/columns.ts+++ b/frontend/src/metabase/viz-core/types/columns.ts@@ -4,7 +4,6 @@ import type { DatasetColumn, DatasetData, RowValues } from "metabase-types/api";export type RemappingHydratedDatasetColumn = DatasetColumn & {remapped_from_index?: number;remapped_to_column?: DatasetColumn;- remapping?: Map<any, any>;};export type RemappingHydratedChartData = DatasetData & {