Skip to content

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

UXW-2448 fix untime error with viz settings (#66657)

Denis Berezin486132311297
diff --git a/frontend/src/metabase-types/api/card.ts b/frontend/src/metabase-types/api/card.ts
index 34abb08cf7a..3ee063703e8 100644
--- a/frontend/src/metabase-types/api/card.ts
+++ b/frontend/src/metabase-types/api/card.ts
@@ -283,7 +283,7 @@ export type VisualizationSettings = {
"graph.metrics"?: string[];
// Series settings
- series_settings?: Record<string, SeriesSettings>;
+ series_settings?: Record<string, SeriesSettings | undefined>;
"graph.series_order"?: SeriesOrderSetting[];
diff --git a/frontend/src/metabase/visualizations/shared/utils/colors.ts b/frontend/src/metabase/visualizations/shared/utils/colors.ts
index 67978c4f89f..8b7645a2e28 100644
--- a/frontend/src/metabase/visualizations/shared/utils/colors.ts
+++ b/frontend/src/metabase/visualizations/shared/utils/colors.ts
@@ -11,7 +11,7 @@ export const getSeriesColors = <TDatum, TSeriesInfo>(
settings.series_settings ?? {},
).reduce(
(mapping, [seriesName, seriesSettings]) => {
- if (typeof seriesSettings.color === "string") {
+ if (typeof seriesSettings?.color === "string") {
mapping[seriesName] = seriesSettings.color;
}
diff --git a/frontend/src/metabase/visualizations/shared/utils/colors.unit.spec.ts b/frontend/src/metabase/visualizations/shared/utils/colors.unit.spec.ts
new file mode 100644
index 00000000000..dfb88ca9704
--- /dev/null
+++ b/frontend/src/metabase/visualizations/shared/utils/colors.unit.spec.ts
@@ -0,0 +1,133 @@
+import { getColorsForValues } from "metabase/lib/colors/charts";
+import type { VisualizationSettings } from "metabase-types/api";
+
+import { getSeriesColors } from "./colors";
+
+jest.mock("metabase/lib/colors/charts");
+
+const mockGetColorsForValues = getColorsForValues as jest.MockedFunction<
+ typeof getColorsForValues
+>;
+
+describe("getSeriesColors", () => {
+ beforeEach(() => {
+ jest.clearAllMocks();
+ mockGetColorsForValues.mockReturnValue({
+ "Series 1": "#509EE3",
+ "Series 2": "#88BF4D",
+ });
+ });
+
+ it("should handle undefined series_settings entries (metabase#66490)", () => {
+ const settings: Partial<VisualizationSettings> = {
+ series_settings: {
+ "Series 1": undefined,
+ "Series 2": { color: "#FF0000" },
+ },
+ };
+
+ const series = [
+ {
+ seriesKey: "Series 1",
+ seriesName: "Series 1",
+ xAccessor: (d: any) => d.x,
+ yAccessor: (d: any) => d.y,
+ },
+ {
+ seriesKey: "Series 2",
+ seriesName: "Series 2",
+ xAccessor: (d: any) => d.x,
+ yAccessor: (d: any) => d.y,
+ },
+ ];
+
+ const result = getSeriesColors(settings, series);
+
+ // Verify getColorsForValues was called with correct parameters
+ expect(mockGetColorsForValues).toHaveBeenCalledWith(
+ ["Series 1", "Series 2"],
+ {
+ "Series 2": "#FF0000",
+ },
+ );
+
+ expect(result).toEqual({
+ "Series 1": "#509EE3",
+ "Series 2": "#88BF4D",
+ });
+ });
+
+ it("should filter out undefined values from settings color mapping", () => {
+ const settings = {
+ series_settings: {
+ "Series 1": undefined,
+ "Series 2": undefined,
+ "Series 3": { color: undefined },
+ },
+ };
+
+ const series = [
+ {
+ seriesKey: "Series 1",
+ seriesName: "Series 1",
+ xAccessor: (d: any) => d.x,
+ yAccessor: (d: any) => d.y,
+ },
+ {
+ seriesKey: "Series 2",
+ seriesName: "Series 2",
+ xAccessor: (d: any) => d.x,
+ yAccessor: (d: any) => d.y,
+ },
+ {
+ seriesKey: "Series 3",
+ seriesName: "Series 3",
+ xAccessor: (d: any) => d.x,
+ yAccessor: (d: any) => d.y,
+ },
+ ];
+
+ getSeriesColors(settings, series);
+
+ // When all series_settings are undefined or have undefined colors,
+ // the mapping should be empty
+ expect(mockGetColorsForValues).toHaveBeenCalledWith(
+ ["Series 1", "Series 2", "Series 3"],
+ {},
+ );
+ });
+
+ it("should work with valid series_settings", () => {
+ const settings = {
+ series_settings: {
+ "Series 1": { color: "#FF0000" },
+ "Series 2": { color: "#00FF00" },
+ },
+ };
+
+ const series = [
+ {
+ seriesKey: "Series 1",
+ seriesName: "Series 1",
+ xAccessor: (d: any) => d.x,
+ yAccessor: (d: any) => d.y,
+ },
+ {
+ seriesKey: "Series 2",
+ seriesName: "Series 2",
+ xAccessor: (d: any) => d.x,
+ yAccessor: (d: any) => d.y,
+ },
+ ];
+
+ getSeriesColors(settings, series);
+
+ expect(mockGetColorsForValues).toHaveBeenCalledWith(
+ ["Series 1", "Series 2"],
+ {
+ "Series 1": "#FF0000",
+ "Series 2": "#00FF00",
+ },
+ );
+ });
+});
diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/chart-definition.ts b/frontend/src/metabase/visualizations/visualizations/CartesianChart/chart-definition.ts
index 3ef5d3bd390..969c7c7dbc2 100644
--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/chart-definition.ts
+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/chart-definition.ts
@@ -23,7 +23,7 @@ import type {
VisualizationSettingsDefinitions,
} from "metabase/visualizations/types";
import { isDimension, isMetric } from "metabase-lib/v1/types/utils/isa";
-import type { SeriesSettings } from "metabase-types/api";
+import type { VisualizationSettings } from "metabase-types/api";
import { transformSeries } from "./chart-definition-legacy";
@@ -64,11 +64,13 @@ export const getCartesianChartDefinition = (
}
const newSettings = _.omit(settings, SERIES_SETTING_KEY);
- const newSeriesSettings: Record<string, SeriesSettings> = {};
+ const newSeriesSettings: VisualizationSettings["series_settings"] = {};
Object.entries(settings[SERIES_SETTING_KEY]).forEach(
([key, seriesSettings]) => {
- const newSingleSeriesSettings = _.omit(seriesSettings, "display");
+ const newSingleSeriesSettings = seriesSettings
+ ? _.omit(seriesSettings, "display")
+ : seriesSettings;
if (!_.isEmpty(newSingleSeriesSettings)) {
newSeriesSettings[key] = newSingleSeriesSettings;