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
series limit for row chart (#67419)
Aleksandr Lesnenko2c01e5063b99
diff --git a/e2e/test/scenarios/visualizations-charts/rows.cy.spec.js b/e2e/test/scenarios/visualizations-charts/rows.cy.spec.jsindex ae6f17144e7..e0745c90689 100644--- a/e2e/test/scenarios/visualizations-charts/rows.cy.spec.js+++ b/e2e/test/scenarios/visualizations-charts/rows.cy.spec.js@@ -1,5 +1,6 @@import _ from "underscore";+import { SAMPLE_DB_ID } from "e2e/support/cypress_data";import { SAMPLE_DATABASE } from "e2e/support/cypress_sample_database";const { H } = cy;@@ -154,4 +155,64 @@ describe("scenarios > visualizations > rows", () => {.should("be.gt", 500);});});++ it("should display an error message when there are more series than the chart supports", () => {+ H.visitQuestionAdhoc({+ display: "row",+ dataset_query: {+ database: SAMPLE_DB_ID,+ type: "query",+ query: {+ "source-table": PRODUCTS_ID,+ aggregation: [["count"]],+ breakout: [+ ["field", PRODUCTS.CREATED_AT, { "temporal-unit": "year" }],+ ["field", PRODUCTS.TITLE, null],+ ],+ },+ },+ visualization_settings: {+ "graph.dimensions": ["CREATED_AT", "TITLE"],+ "graph.metrics": ["count"],+ },+ });++ H.main().findByText(+ "This chart type doesn't support more than 100 series of data.",+ );+ });++ it("should show error when adding high-cardinality breakout via UI (metabase#64086)", () => {+ const { ORDERS, ORDERS_ID } = SAMPLE_DATABASE;++ H.visitQuestionAdhoc({+ display: "row",+ dataset_query: {+ database: SAMPLE_DB_ID,+ type: "query",+ query: {+ "source-table": ORDERS_ID,+ aggregation: [["count"]],+ breakout: [+ ["field", ORDERS.CREATED_AT, { "temporal-unit": "minute" }],+ ["field", ORDERS.ID, null],+ ],+ },+ },+ visualization_settings: {+ "graph.dimensions": ["CREATED_AT"],+ "graph.metrics": ["count"],+ },+ });++ H.openVizSettingsSidebar();+ H.leftSidebar().within(() => {+ cy.findByText("Data").click();+ cy.findByText("Add series breakout").click();+ });++ H.main().findByText(+ "This chart type doesn't support more than 100 series of data.",+ );+ });});diff --git a/frontend/src/metabase/visualizations/lib/settings/graph.js b/frontend/src/metabase/visualizations/lib/settings/graph.jsindex 974addd2191..c895914c70c 100644--- a/frontend/src/metabase/visualizations/lib/settings/graph.js+++ b/frontend/src/metabase/visualizations/lib/settings/graph.js@@ -12,6 +12,7 @@ import { dimensionIsNumeric } from "metabase/visualizations/lib/numeric";import { columnSettings } from "metabase/visualizations/lib/settings/column";import { seriesSetting } from "metabase/visualizations/lib/settings/series";import { getOptionFromColumn } from "metabase/visualizations/lib/settings/utils";+import { getBreakoutCardinality } from "metabase/visualizations/lib/settings/validation";import { dimensionIsTimeseries } from "metabase/visualizations/lib/timeseries";import { MAX_SERIES, columnsAreValid } from "metabase/visualizations/lib/utils";import {@@ -164,11 +165,13 @@ export const GRAPH_DATA_SETTINGS = {truncateAfter: 10,};},- getHidden: (_series, settings, extra) => {- const seriesCount = extra.transformedSeries?.length ?? 0;- return (- settings["graph.dimensions"]?.length < 2 || seriesCount > MAX_SERIES- );+ getHidden: (rawSeries, settings) => {+ const { cols, rows } = rawSeries?.[0]?.data ?? {};+ if (!cols || !rows) {+ return true;+ }+ const cardinality = getBreakoutCardinality(cols, rows, settings);+ return cardinality == null || cardinality > MAX_SERIES;},dashboard: false,readDependencies: [diff --git a/frontend/src/metabase/visualizations/lib/settings/validation.js b/frontend/src/metabase/visualizations/lib/settings/validation.jsindex 5f535551c8f..02e85569e88 100644--- a/frontend/src/metabase/visualizations/lib/settings/validation.js+++ b/frontend/src/metabase/visualizations/lib/settings/validation.js@@ -6,6 +6,8 @@ import {ChartSettingsError,MinRowsError,} from "metabase/visualizations/lib/errors";+import { getCartesianChartColumns } from "metabase/visualizations/lib/graph/columns";+import { MAX_SERIES } from "metabase/visualizations/lib/utils";export const validateDatasetRows = (series) => {const singleSeriesHasNoRows = ({ data: { rows } }) => rows.length === 0;@@ -44,3 +46,37 @@ export const validateStacking = (settings) => {);}};++export const getBreakoutCardinality = (cols, rows, settings) => {+ const dimensions = (settings["graph.dimensions"] || []).filter(isNotNull);+ if (dimensions.length < 2) {+ return null;+ }++ const chartColumns = getCartesianChartColumns(cols, settings);+ if (!("breakout" in chartColumns)) {+ return null;+ }++ const breakoutIndex = chartColumns.breakout.index;+ const uniqueValues = new Set(rows.map((row) => row[breakoutIndex]));+ return uniqueValues.size;+};++export const validateBreakoutSeriesCount = (series, settings) => {+ const [+ {+ data: { cols, rows },+ },+ ] = series;+ const cardinality = getBreakoutCardinality(cols, rows, settings);+ const exceedsLimit =+ series.length > MAX_SERIES ||+ (cardinality != null && cardinality > MAX_SERIES);++ if (exceedsLimit) {+ throw new Error(+ t`This chart type doesn't support more than ${MAX_SERIES} series of data.`,+ );+ }+};diff --git a/frontend/src/metabase/visualizations/shared/utils/data.ts b/frontend/src/metabase/visualizations/shared/utils/data.tsindex f86fac7643b..14a41c14193 100644--- a/frontend/src/metabase/visualizations/shared/utils/data.ts+++ b/frontend/src/metabase/visualizations/shared/utils/data.ts@@ -173,20 +173,20 @@ const getBreakoutDistinctValues = (data: DatasetData,breakout: ColumnDescriptor,columnFormatter: ColumnFormatter,-) => {+): string[] => {const formattedDistinctValues: string[] = [];const usedRawValues = new Set<RowValue>();- data.rows.forEach((row) => {+ for (const row of data.rows) {const rawValue = row[breakout.index];if (usedRawValues.has(rawValue)) {- return;+ continue;}usedRawValues.add(rawValue);formattedDistinctValues.push(columnFormatter(rawValue, breakout.column));- });+ }return formattedDistinctValues;};diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/CartesianChart.tsx b/frontend/src/metabase/visualizations/visualizations/CartesianChart/CartesianChart.tsxindex 02200d4c890..4e49fb61dbb 100644--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/CartesianChart.tsx+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/CartesianChart.tsx@@ -1,12 +1,5 @@import type { EChartsType } from "echarts/core";-import {- type MouseEvent,- useCallback,- useEffect,- useMemo,- useRef,- useState,-} from "react";+import { type MouseEvent, useCallback, useMemo, useRef, useState } from "react";import React from "react";import { useSet } from "react-use";@@ -28,7 +21,7 @@ import { useChartEvents } from "metabase/visualizations/visualizations/Cartesianimport { useChartDebug } from "./use-chart-debug";import { useModelsAndOption } from "./use-models-and-option";-import { getGridSizeAdjustedSettings, validateChartModel } from "./utils";+import { getGridSizeAdjustedSettings } from "./utils";const HIDE_X_AXIS_LABEL_WIDTH_THRESHOLD = 360;const HIDE_Y_AXIS_LABEL_WIDTH_THRESHOLD = 200;@@ -100,10 +93,6 @@ function _CartesianChart(props: VisualizationProps) {);const hasLegend = legendItems.length > 0;- useEffect(() => {- validateChartModel(chartModel);- }, [chartModel]);-const handleInit = useCallback((chart: EChartsType) => {chartRef.current = chart;diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/chart-definition-legacy.js b/frontend/src/metabase/visualizations/visualizations/CartesianChart/chart-definition-legacy.jsindex 4cbb5a0d26b..de6d46218d3 100644--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/chart-definition-legacy.js+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/chart-definition-legacy.js@@ -4,6 +4,7 @@ import { NULL_DISPLAY_VALUE } from "metabase/lib/constants";import { formatValue } from "metabase/lib/formatting";import { isEmpty } from "metabase/lib/validate";import { getComputedSettingsForSeries } from "metabase/visualizations/lib/settings/visualization";+import { MAX_SERIES } from "metabase/visualizations/lib/utils";// TODO: this series transformation is used only for the visualization settings computation which is excessive.// Replace this with defining settings models per visualization type which will contain all necessary info@@ -68,6 +69,10 @@ function transformSingleSeries(s, series, seriesIndex) {if (!seriesRows) {breakoutRowsByValue.set(seriesValue, (seriesRows = []));breakoutValues.push(seriesValue);++ if (breakoutValues.length > MAX_SERIES) {+ return [s];+ }}const newRow = rowColumnIndexes.map((columnIndex) => row[columnIndex]);diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/chart-definition.ts b/frontend/src/metabase/visualizations/visualizations/CartesianChart/chart-definition.tsindex 969c7c7dbc2..9a2ad2a8eb1 100644--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/chart-definition.ts+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/chart-definition.ts@@ -13,6 +13,7 @@ import {TOOLTIP_SETTINGS,} from "metabase/visualizations/lib/settings/graph";import {+ validateBreakoutSeriesCount,validateChartDataSettings,validateDatasetRows,validateStacking,@@ -50,6 +51,7 @@ export const getCartesianChartDefinition = (checkRenderable(series, settings) {validateDatasetRows(series);+ validateBreakoutSeriesCount(series, settings);validateChartDataSettings(settings);validateStacking(settings);},diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/utils.ts b/frontend/src/metabase/visualizations/visualizations/CartesianChart/utils.tsindex 7f554a5c199..623d68a3b80 100644--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/utils.ts+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/utils.ts@@ -1,9 +1,7 @@import type { EChartsCoreOption } from "echarts/core";-import { t } from "ttag";import { isNotNull } from "metabase/lib/types";import type {- BaseCartesianChartModel,DataKey,SeriesModel,} from "metabase/visualizations/echarts/cartesian/model/types";@@ -55,16 +53,6 @@ export const getGridSizeAdjustedSettings = (return newSettings;};-export const MAX_SERIES = 100;--export const validateChartModel = (chartModel: BaseCartesianChartModel) => {- if (chartModel.seriesModels.length > MAX_SERIES) {- throw new Error(- t`This chart type doesn't support more than ${MAX_SERIES} series of data.`,- );- }-};-export const getHoveredSeriesDataKey = (seriesModels: SeriesModel[],hovered: HoveredObject | null | undefined,diff --git a/frontend/src/metabase/visualizations/visualizations/RowChart/RowChart.tsx b/frontend/src/metabase/visualizations/visualizations/RowChart/RowChart.tsxindex 44d6a0e3198..87c581f1e4f 100644--- a/frontend/src/metabase/visualizations/visualizations/RowChart/RowChart.tsx+++ b/frontend/src/metabase/visualizations/visualizations/RowChart/RowChart.tsx@@ -14,11 +14,14 @@ import { getChartGoal } from "metabase/visualizations/lib/settings/goal";import { GRAPH_DATA_SETTINGS } from "metabase/visualizations/lib/settings/graph";import { getStackOffset } from "metabase/visualizations/lib/settings/stacking";import {+ getBreakoutCardinality,+ validateBreakoutSeriesCount,validateChartDataSettings,validateDatasetRows,validateStacking,} from "metabase/visualizations/lib/settings/validation";import { getComputedSettingsForSeries } from "metabase/visualizations/lib/settings/visualization";+import { MAX_SERIES } from "metabase/visualizations/lib/utils";import type { RowChartProps } from "metabase/visualizations/shared/components/RowChart";import { RowChart } from "metabase/visualizations/shared/components/RowChart";import type { BarData } from "metabase/visualizations/shared/components/RowChart/types";@@ -39,6 +42,7 @@ import {getMinSize,} from "metabase/visualizations/shared/utils/sizes";import type {+ ComputedVisualizationSettings,RemappingHydratedChartData,VisualizationProps,} from "metabase/visualizations/types";@@ -372,39 +376,46 @@ RowChartVisualization.settings["graph.dimensions"] = {*/RowChartVisualization.transformSeries = (originalMultipleSeries: any) => {const [series] = originalMultipleSeries;- const settings: any = getComputedSettingsForSeries(originalMultipleSeries);+ const settings: ComputedVisualizationSettings = getComputedSettingsForSeries(+ originalMultipleSeries,+ );const { card, data } = series;- if (series.card._transformed || !hasValidColumnsSelected(settings, data)) {+ if (card._transformed || !hasValidColumnsSelected(settings, data)) {return originalMultipleSeries;}- const chartColumns = getCartesianChartColumns(data.cols, settings);+ const cardinality = getBreakoutCardinality(data.cols, data.rows, settings);+ if (cardinality != null && cardinality > MAX_SERIES) {+ return originalMultipleSeries;+ }- const computedSeries = getSeries(+ const chartColumns = getCartesianChartColumns(data.cols, settings);+ const seriesDefinitions = getSeries(data,chartColumns,getColumnValueFormatter(),- ).map((series) => {- const seriesCard = {+ );++ const transformedSeries = seriesDefinitions.map((seriesDef) => ({+ card: {...card,- name: series.seriesName,- _seriesKey: series.seriesKey,+ name: seriesDef.seriesName,+ _seriesKey: seriesDef.seriesKey,_transformed: true,- };-- const newData = {+ },+ data: {...data,cols: [- series.seriesInfo?.dimensionColumn,- series.seriesInfo?.metricColumn,+ seriesDef.seriesInfo?.dimensionColumn,+ seriesDef.seriesInfo?.metricColumn,],- };-- return { card: seriesCard, data: newData };- });+ },+ }));- return computedSeries.length > 0 ? computedSeries : originalMultipleSeries;+ return transformedSeries.length > 0+ ? transformedSeries+ : originalMultipleSeries;};RowChartVisualization.checkRenderable = (@@ -412,6 +423,7 @@ RowChartVisualization.checkRenderable = (settings: VisualizationSettings,) => {validateDatasetRows(series);+ validateBreakoutSeriesCount(series, settings);validateChartDataSettings(settings);validateStacking(settings);};