Skip to content

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

Fixed metrics not being translated in guest embeds (#70484)

Sébastien2390c28119b4
diff --git a/enterprise/frontend/src/metabase-enterprise/content_translation/tests/utils.unit.spec.ts b/enterprise/frontend/src/metabase-enterprise/content_translation/tests/utils.unit.spec.ts
index 62691577181..8a578225184 100644
--- a/enterprise/frontend/src/metabase-enterprise/content_translation/tests/utils.unit.spec.ts
+++ b/enterprise/frontend/src/metabase-enterprise/content_translation/tests/utils.unit.spec.ts
@@ -444,7 +444,7 @@ describe("content translation utils", () => {
it("should return the original series if no translations are available", () => {
const series = createMockSeries();
- const result = translateFieldValuesInSeries(series, leaveUntranslated);
+ const result = translateFieldValuesInSeries(leaveUntranslated)(series);
expect(result).toEqual(series);
});
@@ -462,7 +462,7 @@ describe("content translation utils", () => {
];
series[0].data.rows = [["a", "b"]];
- const result = translateFieldValuesInSeries(series, mockTC);
+ const result = translateFieldValuesInSeries(mockTC)(series);
expect(result[0].data.rows).toEqual([
["mock translation of a", "mock translation of b"],
@@ -481,7 +481,7 @@ describe("content translation utils", () => {
it("translates card names in a series", () => {
const series = createMockSeries([{ name: "a" }, { name: "b" }]);
- const result = translateCardNames(series, mockTC);
+ const result = translateCardNames(mockTC)(series);
expect(result[0].card.name).toEqual("mock translation of a");
});
});
diff --git a/enterprise/frontend/src/metabase-enterprise/content_translation/utils.ts b/enterprise/frontend/src/metabase-enterprise/content_translation/utils.ts
index 7f09236045e..59769a9eab6 100644
--- a/enterprise/frontend/src/metabase-enterprise/content_translation/utils.ts
+++ b/enterprise/frontend/src/metabase-enterprise/content_translation/utils.ts
@@ -13,6 +13,7 @@ import type {
MaybeTranslatedSeries,
RowValue,
Series,
+ SeriesSettings,
} from "metabase-types/api";
import { hasTranslations, useTranslateContent } from "./use-translate-content";
@@ -203,94 +204,155 @@ export const useTranslateFieldValuesInHoveredObject = (
};
export const translateFieldValuesInSeries = (
- series: Series,
tc: ContentTranslationFunction,
-): MaybeTranslatedSeries => {
+): ((series: Series) => MaybeTranslatedSeries) => {
if (!hasTranslations(tc)) {
- return series;
+ return (series) => series;
}
- return series.map((singleSeries) => {
- if (!singleSeries.data) {
- return singleSeries;
- }
- const untranslatedRows = singleSeries.data.rows.concat();
-
- const defaultFn = () => {
- return singleSeries.data.rows.map((row) => row.map((value) => tc(value)));
- };
-
- const translatedRows: RowValue[][] = match(singleSeries.card?.display)
- .with("pie", () => {
- const pieRows =
- singleSeries.card.visualization_settings?.["pie.rows"] ?? [];
- const keyToNameMap = Object.fromEntries(
- pieRows.map((row) => [row.key, row.name]),
- );
+ return (series) =>
+ series.map((singleSeries) => {
+ if (!singleSeries.data) {
+ return singleSeries;
+ }
+ const untranslatedRows = singleSeries.data.rows.concat();
- // The pie chart relies on the rows to generate its legend,
- // which is why we need to translate them too
- // They're in the format of:
- // [
- // ["Doohickey", 123],
- // ["Widget", 456],
- // ...
- // ]
- //
+ const defaultFn = () => {
return singleSeries.data.rows.map((row) =>
- row.map((value) => {
- if (
- typeof value === "string" &&
- keyToNameMap[value] !== undefined
- ) {
- return tc(keyToNameMap[value]);
- }
- return tc(value);
- }),
+ row.map((value) => tc(value)),
);
- })
- .with(P.when(isCartesianChart), () => {
- // cartesian charts have series settings that can provide display names
- // for fields, which we should translate if available
- const seriesSettings =
- singleSeries.card.visualization_settings?.series_settings ?? {};
+ };
- return singleSeries.data.rows.map((row) =>
- row.map((value) => {
- if (
- typeof value === "string" &&
- seriesSettings[value]?.title !== undefined
- ) {
- return tc(seriesSettings[value].title);
- }
- return tc(value);
- }),
- );
- })
- .otherwise(defaultFn);
-
- return {
- ...singleSeries,
- data: {
- ...singleSeries.data,
- untranslatedRows,
- rows: translatedRows,
- },
- };
- });
+ const translatedRows: RowValue[][] = match(singleSeries.card?.display)
+ .with("pie", () => {
+ const pieRows =
+ singleSeries.card.visualization_settings?.["pie.rows"] ?? [];
+ const keyToNameMap = Object.fromEntries(
+ pieRows.map((row) => [row.key, row.name]),
+ );
+
+ // The pie chart relies on the rows to generate its legend,
+ // which is why we need to translate them too
+ // They're in the format of:
+ // [
+ // ["Doohickey", 123],
+ // ["Widget", 456],
+ // ...
+ // ]
+ //
+ return singleSeries.data.rows.map((row) =>
+ row.map((value) => {
+ if (
+ typeof value === "string" &&
+ keyToNameMap[value] !== undefined
+ ) {
+ return tc(keyToNameMap[value]);
+ }
+ return tc(value);
+ }),
+ );
+ })
+ .with(P.when(isCartesianChart), () => {
+ // cartesian charts have series settings that can provide display names
+ // for fields, which we should translate if available
+ const seriesSettings =
+ singleSeries.card.visualization_settings?.series_settings ?? {};
+
+ return singleSeries.data.rows.map((row) =>
+ row.map((value) => {
+ if (
+ typeof value === "string" &&
+ seriesSettings[value]?.title !== undefined
+ ) {
+ return tc(seriesSettings[value].title);
+ }
+ return tc(value);
+ }),
+ );
+ })
+ .otherwise(defaultFn);
+
+ return {
+ ...singleSeries,
+ data: {
+ ...singleSeries.data,
+ untranslatedRows,
+ rows: translatedRows,
+ },
+ };
+ });
};
-export const translateCardNames = (
- series: Series,
- tc: ContentTranslationFunction,
-) => {
+export const translateCardNames = (tc: ContentTranslationFunction) => {
if (!hasTranslations(tc)) {
- return series;
+ return (series: Series) => series;
}
- return series.map((s) =>
- s.card?.name ? I.setIn(s, ["card", "name"], tc(s.card.name)) : s,
- );
+ return (series: Series) =>
+ series.map((s) =>
+ s.card?.name ? I.setIn(s, ["card", "name"], tc(s.card.name)) : s,
+ );
+};
+
+/** Translate the `title` in each metric's `series_settings` entry.
+ *
+ * Only keys listed in `graph.metrics` are translated; other
+ * `series_settings` entries (e.g. dimension keys) are left untouched.
+ *
+ * @example
+ * // Given series_settings: { revenue: { title: "Revenue" } }
+ * // and graph.metrics: ["revenue"]
+ * // ➜ series_settings: { revenue: { title: tc("Revenue") } }
+ */
+export const translateSeriesNames = (tc: ContentTranslationFunction) => {
+ return (series: Series) => {
+ if (!hasTranslations(tc)) {
+ return series;
+ }
+
+ return series.map((singleSeries) => {
+ const seriesSettings =
+ singleSeries.card?.visualization_settings?.series_settings;
+ const metrics =
+ singleSeries.card?.visualization_settings["graph.metrics"];
+
+ if (!seriesSettings || !metrics) {
+ return singleSeries;
+ }
+
+ const translated = Object.fromEntries(
+ metrics
+ .filter((metric) => seriesSettings[metric])
+ .map((metric) => [
+ metric,
+ {
+ ...seriesSettings[metric],
+ title: tc(seriesSettings[metric]!.title),
+ },
+ ]),
+ );
+
+ return I.updateIn(
+ singleSeries,
+ ["card", "visualization_settings", "series_settings"],
+ (settings: Record<string, SeriesSettings>) => ({
+ ...settings,
+ ...translated,
+ }),
+ );
+ });
+ };
};
+const curriedTranslatedDisplayNames = (
+ tc: ContentTranslationFunction,
+ locale: string,
+) => {
+ return (series: Series) => {
+ return translateDisplayNames({ obj: series, tc, locale });
+ };
+};
+
+const identity = (series: Series) => series;
+
export const useTranslateSeries = (series: Series) => {
const tc = useTranslateContent();
const { locale } = useLocale();
@@ -299,24 +361,16 @@ export const useTranslateSeries = (series: Series) => {
if (!hasTranslations(tc)) {
return series;
}
- const withTranslatedDisplayNames = translateDisplayNames({
- obj: series,
- tc,
- locale,
- });
- const withTranslatedCardNames = translateCardNames(
- withTranslatedDisplayNames,
- tc,
- );
-
- // Do not translate field values here if display is a map, since this can
- // break the map
- if (series?.[0]?.card?.display === "map") {
- return withTranslatedCardNames;
- }
+ const isMap = series?.[0]?.card?.display === "map";
- return translateFieldValuesInSeries(withTranslatedCardNames, tc);
+ return [
+ curriedTranslatedDisplayNames(tc, locale),
+ translateCardNames(tc),
+ translateSeriesNames(tc),
+ // Do not translate field values for maps, since this can break the map
+ isMap ? identity : translateFieldValuesInSeries(tc),
+ ].reduce((result, fn) => fn(result), series);
}, [series, tc, locale]);
};
diff --git a/enterprise/frontend/src/metabase-enterprise/content_translation/utils.unit.spec.ts b/enterprise/frontend/src/metabase-enterprise/content_translation/utils.unit.spec.ts
index e23c795293d..4a37b3affc4 100644
--- a/enterprise/frontend/src/metabase-enterprise/content_translation/utils.unit.spec.ts
+++ b/enterprise/frontend/src/metabase-enterprise/content_translation/utils.unit.spec.ts
@@ -7,12 +7,16 @@ import type {
SingleSeries,
VisualizationDisplay,
} from "metabase-types/api";
-import { createMockDatasetData } from "metabase-types/api/mocks";
+import {
+ createMockDatasetData,
+ createMockSingleSeries,
+} from "metabase-types/api/mocks";
import { leaveUntranslated } from "./use-translate-content";
import {
translateColumnDisplayName,
translateFieldValuesInSeries,
+ translateSeriesNames,
} from "./utils";
registerVisualizations();
@@ -41,9 +45,8 @@ describe("translateFieldValuesInSeries", () => {
];
const result = translateFieldValuesInSeries(
- series,
mockTranslateWithoutTranslations,
- );
+ )(series);
expect(result).toBe(series);
});
@@ -55,9 +58,8 @@ describe("translateFieldValuesInSeries", () => {
} as SingleSeries,
];
- const result = translateFieldValuesInSeries(
+ const result = translateFieldValuesInSeries(mockTranslateWithTranslations)(
series,
- mockTranslateWithTranslations,
);
expect(result).toEqual([
@@ -80,9 +82,8 @@ describe("translateFieldValuesInSeries", () => {
} as SingleSeries,
];
- const result = translateFieldValuesInSeries(
+ const result = translateFieldValuesInSeries(mockTranslateWithTranslations)(
series,
- mockTranslateWithTranslations,
) as MaybeTranslatedSeries;
expect(result[0].data?.rows).toEqual([
@@ -109,9 +110,8 @@ describe("translateFieldValuesInSeries", () => {
} as SingleSeries,
];
- const result = translateFieldValuesInSeries(
+ const result = translateFieldValuesInSeries(mockTranslateWithTranslations)(
series,
- mockTranslateWithTranslations,
) as MaybeTranslatedSeries;
expect(result[0].data?.rows).toEqual([
@@ -146,9 +146,8 @@ describe("translateFieldValuesInSeries", () => {
];
const result = translateFieldValuesInSeries(
- series,
mockTranslateWithTranslations,
- ) as MaybeTranslatedSeries;
+ )(series) as MaybeTranslatedSeries;
expect(result[0].data?.rows).toEqual([
["translated_Apple", 10],
@@ -175,9 +174,8 @@ describe("translateFieldValuesInSeries", () => {
];
const result = translateFieldValuesInSeries(
- series,
mockTranslateWithTranslations,
- ) as MaybeTranslatedSeries;
+ )(series) as MaybeTranslatedSeries;
expect(result[0].data?.rows).toEqual([
["translated_apple", 10],
@@ -219,9 +217,8 @@ describe("translateFieldValuesInSeries", () => {
];
const result = translateFieldValuesInSeries(
- series,
mockTranslateWithTranslations,
- ) as MaybeTranslatedSeries;
+ )(series) as MaybeTranslatedSeries;
expect(result[0].data?.rows).toEqual([
["translated_Apple", 100, 30],
@@ -248,9 +245,8 @@ describe("translateFieldValuesInSeries", () => {
];
const result = translateFieldValuesInSeries(
- series,
mockTranslateWithTranslations,
- ) as MaybeTranslatedSeries;
+ )(series) as MaybeTranslatedSeries;
expect(result[0].data?.rows).toEqual([
["translated_Apple", 100, 30],
@@ -274,9 +270,8 @@ describe("translateFieldValuesInSeries", () => {
} as SingleSeries,
];
- const result = translateFieldValuesInSeries(
+ const result = translateFieldValuesInSeries(mockTranslateWithTranslations)(
series,
- mockTranslateWithTranslations,
) as MaybeTranslatedSeries;
expect(result).toHaveLength(2);
@@ -293,9 +288,8 @@ describe("translateFieldValuesInSeries", () => {
} as SingleSeries,
];
- const result = translateFieldValuesInSeries(
+ const result = translateFieldValuesInSeries(mockTranslateWithTranslations)(
series,
- mockTranslateWithTranslations,
) as MaybeTranslatedSeries;
expect(result[0].data?.rows).toEqual([]);
@@ -698,3 +692,140 @@ describe("translateColumnDisplayName", () => {
);
});
});
+
+describe("translateSeriesNames", () => {
+ it("should return original series unchanged when tc has no translations", () => {
+ const series: Series = [
+ createMockSingleSeries({
+ visualization_settings: {
+ series_settings: { metric1: { title: "Revenue" } },
+ "graph.metrics": ["metric1"],
+ },
+ }),
+ ];
+
+ const result = translateSeriesNames(mockTranslateWithoutTranslations)(
+ series,
+ );
+
+ expect(result).toBe(series);
+ });
+
+ it("should return series item unchanged when visualization_settings has no series_settings", () => {
+ const series: Series = [
+ createMockSingleSeries({
+ visualization_settings: {
+ "graph.metrics": ["metric1"],
+ },
+ }),
+ ];
+
+ const result = translateSeriesNames(mockTranslateWithTranslations)(series);
+
+ expect(result[0]).toBe(series[0]);
+ });
+
+ it("should return series item unchanged when visualization_settings has no graph.metrics", () => {
+ const series: Series = [
+ createMockSingleSeries({
+ visualization_settings: {
+ series_settings: { metric1: { title: "Revenue" } },
+ },
+ }),
+ ];
+
+ const result = translateSeriesNames(mockTranslateWithTranslations)(series);
+
+ expect(result[0]).toBe(series[0]);
+ });
+
+ it("should translate titles of metric series settings", () => {
+ const series: Series = [
+ createMockSingleSeries({
+ visualization_settings: {
+ series_settings: {
+ metric1: { title: "Revenue" },
+ metric2: { title: "Profit" },
+ },
+ "graph.metrics": ["metric1", "metric2"],
+ },
+ }),
+ ];
+
+ const result = translateSeriesNames(mockTranslateWithTranslations)(series);
+
+ expect(
+ result[0].card.visualization_settings.series_settings?.metric1?.title,
+ ).toBe("translated_Revenue");
+ expect(
+ result[0].card.visualization_settings.series_settings?.metric2?.title,
+ ).toBe("translated_Profit");
+ });
+
+ it("should skip metrics without corresponding series_settings entry", () => {
+ const series: Series = [
+ createMockSingleSeries({
+ visualization_settings: {
+ series_settings: {
+ metric1: { title: "Revenue" },
+ },
+ "graph.metrics": ["metric1", "metric_missing"],
+ },
+ }),
+ ];
+
+ const result = translateSeriesNames(mockTranslateWithTranslations)(series);
+
+ expect(
+ result[0].card.visualization_settings.series_settings?.metric1?.title,
+ ).toBe("translated_Revenue");
+ expect(
+ result[0].card.visualization_settings.series_settings?.metric_missing,
+ ).toBeUndefined();
+ });
+
+ it("should preserve other settings properties like color", () => {
+ const series: Series = [
+ createMockSingleSeries({
+ visualization_settings: {
+ series_settings: {
+ metric1: { title: "Revenue", color: "#ff0000" },
+ },
+ "graph.metrics": ["metric1"],
+ },
+ }),
+ ];
+
+ const result = translateSeriesNames(mockTranslateWithTranslations)(series);
+
+ const settings =
+ result[0].card.visualization_settings.series_settings?.metric1;
+ expect(settings?.title).toBe("translated_Revenue");
+ expect(settings?.color).toBe("#ff0000");
+ });
+
+ it("should preserve settings for non-metric keys", () => {
+ const series: Series = [
+ createMockSingleSeries({
+ visualization_settings: {
+ series_settings: {
+ metric1: { title: "Revenue" },
+ non_metric: { title: "Other", color: "#00ff00" },
+ },
+ "graph.metrics": ["metric1"],
+ },
+ }),
+ ];
+
+ const result = translateSeriesNames(mockTranslateWithTranslations)(series);
+
+ expect(
+ result[0].card.visualization_settings.series_settings?.metric1?.title,
+ ).toBe("translated_Revenue");
+ // non_metric should be preserved untouched
+ const nonMetric =
+ result[0].card.visualization_settings.series_settings?.non_metric;
+ expect(nonMetric?.title).toBe("Other");
+ expect(nonMetric?.color).toBe("#00ff00");
+ });
+});