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 setting graph.tooltip_columns warnings (#74237)
Nick Fitzpatrick81c537181dbf
diff --git a/frontend/src/metabase/visualizations/echarts/cartesian/model/index.ts b/frontend/src/metabase/visualizations/echarts/cartesian/model/index.tsindex 176989f7b3d..a0e8298d90b 100644--- a/frontend/src/metabase/visualizations/echarts/cartesian/model/index.ts+++ b/frontend/src/metabase/visualizations/echarts/cartesian/model/index.ts@@ -19,7 +19,10 @@ import {getFormatters,} from "metabase/visualizations/echarts/cartesian/model/series";import type { CartesianChartModel } from "metabase/visualizations/echarts/cartesian/model/types";-import { getCartesianChartColumns } from "metabase/visualizations/lib/graph/columns";+import {+ getCartesianChartColumns,+ getReferencedColumns,+} from "metabase/visualizations/lib/graph/columns";import { getSingleSeriesDimensionsAndMetrics } from "metabase/visualizations/lib/utils";import { getAreDimensionsAndMetricsValid } from "metabase/visualizations/shared/settings/cartesian-chart";import type {@@ -81,6 +84,23 @@ export const getCardsColumns = (});};+// Like `getCardsColumns`, but returns the columns referenced by each card's+// `graph.dimensions` / `graph.metrics` settings without requiring a full+// chart-shape to be buildable. Use this when you need to know which columns+// are spoken for, regardless of whether a chart can render.+export const getCardsReferencedColumns = (+ rawSeries: RawSeries,+ settings: ComputedVisualizationSettings,+) => {+ return rawSeries.map((series) => {+ const shouldUseIndividualCardSettings = rawSeries.length > 1;+ const cardSettings = shouldUseIndividualCardSettings+ ? getSettingsWithDefaultMetricsAndDimensions(series)+ : settings;+ return getReferencedColumns(series.data.cols, cardSettings);+ });+};+export const getCartesianChartModel = (rawSeries: RawSeries,settings: ComputedVisualizationSettings,diff --git a/frontend/src/metabase/visualizations/echarts/cartesian/model/index.unit.spec.ts b/frontend/src/metabase/visualizations/echarts/cartesian/model/index.unit.spec.tsnew file mode 100644index 00000000000..c89281da80b--- /dev/null+++ b/frontend/src/metabase/visualizations/echarts/cartesian/model/index.unit.spec.ts@@ -0,0 +1,87 @@+import type { ComputedVisualizationSettings } from "metabase/visualizations/types";+import type { SingleSeries } from "metabase-types/api";+import {+ createMockCard,+ createMockColumn,+ createMockDatasetData,+} from "metabase-types/api/mocks";++import { getCardsReferencedColumns } from "./index";++describe("getCardsReferencedColumns", () => {+ const dimensionA = createMockColumn({+ name: "created_at",+ base_type: "type/DateTime",+ source: "breakout",+ });+ const metricA = createMockColumn({+ name: "count",+ base_type: "type/Integer",+ source: "aggregation",+ });+ const extraA = createMockColumn({ name: "extra_a" });+ const dimensionB = createMockColumn({+ name: "category",+ base_type: "type/Text",+ source: "breakout",+ });+ const metricB = createMockColumn({+ name: "sum",+ base_type: "type/Integer",+ source: "aggregation",+ });+ const extraB = createMockColumn({ name: "extra_b" });++ const cardA: SingleSeries = {+ card: createMockCard({+ id: 1,+ visualization_settings: {+ "graph.dimensions": ["created_at"],+ "graph.metrics": ["count"],+ },+ }),+ data: createMockDatasetData({+ cols: [dimensionA, metricA, extraA],+ rows: [["2024", 1, "x"]],+ }),+ };+ const cardB: SingleSeries = {+ card: createMockCard({+ id: 2,+ visualization_settings: {+ "graph.dimensions": ["category"],+ "graph.metrics": ["sum"],+ },+ }),+ data: createMockDatasetData({+ cols: [dimensionB, metricB, extraB],+ rows: [["a", 2, "y"]],+ }),+ };++ it("uses the passed-in settings for a single-card series", () => {+ const settings: ComputedVisualizationSettings = {+ "graph.dimensions": ["created_at"],+ "graph.metrics": ["count"],+ };+ expect(getCardsReferencedColumns([cardA], settings)).toEqual([+ [dimensionA, metricA],+ ]);+ });++ it("uses each card's own visualization_settings when multiple cards are combined", () => {+ // Computed settings only reflect the first card, but each card needs to+ // resolve against its own stored settings so referenced columns are+ // correct per card.+ const computedSettings: ComputedVisualizationSettings = {+ "graph.dimensions": ["created_at"],+ "graph.metrics": ["count"],+ };+ expect(getCardsReferencedColumns([cardA, cardB], computedSettings)).toEqual(+ [+ [dimensionA, metricA],+ [dimensionB, metricB],+ ],+ );+ });+});diff --git a/frontend/src/metabase/visualizations/lib/graph/columns.ts b/frontend/src/metabase/visualizations/lib/graph/columns.tsindex 6fd0ea388ab..86c00da69b1 100644--- a/frontend/src/metabase/visualizations/lib/graph/columns.ts+++ b/frontend/src/metabase/visualizations/lib/graph/columns.ts@@ -33,6 +33,23 @@ export const getColumnDescriptors = <TColumn extends DatasetColumn>(return result;};+// Returns the subset of `cols` referenced by `graph.dimensions` or+// `graph.metrics` settings that successfully resolve in the dataset.+// In breakout shape (2 dimensions) only the first metric is rendered, so the+// remaining metrics stay available as additional columns.+export const getReferencedColumns = <TColumn extends DatasetColumn>(+ cols: TColumn[],+ settings: Pick<VisualizationSettings, "graph.dimensions" | "graph.metrics">,+): TColumn[] => {+ const dimensions = (settings["graph.dimensions"] ?? []).filter(isNotNull);+ const metrics = (settings["graph.metrics"] ?? []).filter(isNotNull);+ const referencedMetrics =+ dimensions.length >= 2 ? metrics.slice(0, 1) : metrics;+ return [...dimensions, ...referencedMetrics]+ .map((name) => cols.find((col) => col.name === name))+ .filter(isNotNull);+};+export const hasValidColumnsSelected = (visualizationSettings: VisualizationSettings,data: DatasetData,diff --git a/frontend/src/metabase/visualizations/lib/graph/columns.unit.spec.ts b/frontend/src/metabase/visualizations/lib/graph/columns.unit.spec.tsindex dcdf00fbd3c..8511de46256 100644--- a/frontend/src/metabase/visualizations/lib/graph/columns.unit.spec.ts+++ b/frontend/src/metabase/visualizations/lib/graph/columns.unit.spec.ts@@ -1,6 +1,6 @@import { createMockColumn } from "metabase-types/api/mocks";-import { getCartesianChartColumns } from "./columns";+import { getCartesianChartColumns, getReferencedColumns } from "./columns";describe("getCartesianChartColumns", () => {it("should ignore duplicated metrics in settings while preserving the order", () => {@@ -24,3 +24,90 @@ describe("getCartesianChartColumns", () => {});});});++describe("getReferencedColumns", () => {+ const dimension = createMockColumn({ name: "created_at" });+ const breakout = createMockColumn({ name: "category" });+ const metric = createMockColumn({ name: "count" });+ const metric2 = createMockColumn({ name: "sum" });+ const extra = createMockColumn({ name: "extra" });+ const cols = [dimension, breakout, metric, metric2, extra];++ it("returns columns referenced by graph.dimensions and graph.metrics", () => {+ expect(+ getReferencedColumns(cols, {+ "graph.dimensions": ["created_at"],+ "graph.metrics": ["count"],+ }),+ ).toEqual([dimension, metric]);+ });++ it("returns dimensions before metrics", () => {+ expect(+ getReferencedColumns(cols, {+ "graph.dimensions": ["created_at"],+ "graph.metrics": ["count", "sum"],+ }),+ ).toEqual([dimension, metric, metric2]);+ });++ it("only includes the first metric in breakout shape (2 dimensions)", () => {+ // With 2 dimensions only metrics[0] is rendered; the rest stay available+ // as additional columns.+ expect(+ getReferencedColumns(cols, {+ "graph.dimensions": ["created_at", "category"],+ "graph.metrics": ["count", "sum"],+ }),+ ).toEqual([dimension, breakout, metric]);+ });++ it("filters out names that don't resolve against the dataset", () => {+ expect(+ getReferencedColumns(cols, {+ "graph.dimensions": ["created_at", "missing_dimension"],+ "graph.metrics": ["count", "missing_metric"],+ }),+ ).toEqual([dimension, metric]);+ });++ it("returns resolved metrics when the stored dimension is missing", () => {+ // Regression test for UXW-4069: this is the scenario where+ // getCartesianChartColumns would return null (no chart shape), but+ // referenced columns still need to reflect what's spoken for.+ expect(+ getReferencedColumns(cols, {+ "graph.dimensions": ["missing_dimension"],+ "graph.metrics": ["count"],+ }),+ ).toEqual([metric]);+ });++ it("returns an empty array when no settings are provided", () => {+ expect(getReferencedColumns(cols, {})).toEqual([]);+ });++ it("returns an empty array when cols is empty", () => {+ expect(+ getReferencedColumns([], {+ "graph.dimensions": ["created_at"],+ "graph.metrics": ["count"],+ }),+ ).toEqual([]);+ });++ it("ignores null entries in settings arrays", () => {+ // The filter(isNotNull) in getReferencedColumns is defensive against+ // legacy settings data where arrays could contain nulls. The current type+ // disallows it, so cast through unknown to verify the runtime behavior.+ const settingsWithNulls = {+ "graph.dimensions": ["created_at", null],+ "graph.metrics": [null, "count"],+ } as unknown as Parameters<typeof getReferencedColumns>[1];++ expect(getReferencedColumns(cols, settingsWithNulls)).toEqual([+ dimension,+ metric,+ ]);+ });+});diff --git a/frontend/src/metabase/visualizations/shared/settings/cartesian-chart.ts b/frontend/src/metabase/visualizations/shared/settings/cartesian-chart.tsindex 2aeb4ab06a7..286ee951c3a 100644--- a/frontend/src/metabase/visualizations/shared/settings/cartesian-chart.ts+++ b/frontend/src/metabase/visualizations/shared/settings/cartesian-chart.ts@@ -6,7 +6,10 @@ import {getMaxDimensionsSupported,getMaxMetricsSupported,} from "metabase/visualizations";-import { getCardsColumns } from "metabase/visualizations/echarts/cartesian/model";+import {+ getCardsColumns,+ getCardsReferencedColumns,+} from "metabase/visualizations/echarts/cartesian/model";import { getCardsSeriesModels } from "metabase/visualizations/echarts/cartesian/model/series";import {MAX_SERIES,@@ -456,8 +459,6 @@ export function getAvailableAdditionalColumns(rawSeries: RawSeries,settings: ComputedVisualizationSettings,): DatasetColumn[] {- const alreadyIncludedColumns = new Set<DatasetColumn>();-if (_.isEmpty(settings["graph.dimensions"]?.filter(isNotNull)) ||_.isEmpty(settings["graph.metrics"]?.filter(isNotNull))@@ -465,22 +466,12 @@ export function getAvailableAdditionalColumns(return [];}- getCardsColumns(rawSeries, settings).forEach((cardColumns) => {- alreadyIncludedColumns.add(cardColumns.dimension.column);- if ("breakout" in cardColumns) {- alreadyIncludedColumns.add(cardColumns.breakout.column);- alreadyIncludedColumns.add(cardColumns.metric.column);- } else {- cardColumns.metrics.forEach((columnDescriptor) =>- alreadyIncludedColumns.add(columnDescriptor.column),- );- }- });+ const alreadyIncludedColumns = new Set<DatasetColumn>(+ getCardsReferencedColumns(rawSeries, settings).flat(),+ );return rawSeries- .flatMap((singleSeries) => {- return singleSeries.data.cols;- })+ .flatMap((singleSeries) => singleSeries.data.cols).filter((column) => !alreadyIncludedColumns.has(column));}