Skip to content

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

Reduce UI imports from `viz-core` (#79684)

Fraserc917cb51a513
diff --git a/frontend/src/metabase/common/hooks/use-memoized-callback.ts b/frontend/src/metabase/common/hooks/use-memoized-callback.ts
index 2350de3a296..ed2d3b99698 100644
--- a/frontend/src/metabase/common/hooks/use-memoized-callback.ts
+++ b/frontend/src/metabase/common/hooks/use-memoized-callback.ts
@@ -1,51 +1,6 @@
import { useMemo } from "react";
-type MapLike<K, V> = Map<K, V> | WeakMap<WeakKey, V>;
-
-function getWithFallback<K, V>(
- map: MapLike<K, V>,
- key: K,
- fallback: () => V,
-): V {
- // Unjustified type cast. FIXME
- if ("has" in map && map.has(key as any)) {
- // Unjustified type cast. FIXME
- return map.get(key as any)!;
- } else {
- const value = fallback();
- // Unjustified type cast. FIXME
- map.set(key as any, value);
- return value;
- }
-}
-
-type CacheValue = unknown;
-type CacheMap = Map<unknown, CacheValue | CacheMap>;
-
-const rootCache = new WeakMap<object, CacheMap>();
-const createMap = (): CacheMap => new Map();
-
-export function memoize<T extends (...args: any[]) => any>(fn: T): T {
- const memoized = (...args: Parameters<T>): ReturnType<T> => {
- const [first, ...rest] = [fn, args.length, ...args];
- const lastKey = rest.pop()!;
-
- let currentMap = getWithFallback(rootCache, first, createMap);
- for (const key of rest) {
- const nextMap = getWithFallback(currentMap, key, createMap);
- if (nextMap instanceof Map) {
- currentMap = nextMap;
- } else {
- throw new Error("Invalid cache structure");
- }
- }
-
- return getWithFallback(currentMap, lastKey, () => fn(...args));
- };
-
- // Unjustified type cast. FIXME
- return memoized as T;
-}
+import { memoize } from "metabase/utils/memoize";
export function useMemoizedCallback<T extends (...args: any[]) => any>(
callback: T,
diff --git a/frontend/src/metabase/common/hooks/use-memoized-callback.unit.spec.ts b/frontend/src/metabase/common/hooks/use-memoized-callback.unit.spec.ts
index 82407e8ad49..6e2e3d0ffd6 100644
--- a/frontend/src/metabase/common/hooks/use-memoized-callback.unit.spec.ts
+++ b/frontend/src/metabase/common/hooks/use-memoized-callback.unit.spec.ts
@@ -1,4 +1,4 @@
-import { memoize } from "./use-memoized-callback";
+import { memoize } from "metabase/utils/memoize";
describe("memoize", () => {
it("should return same result for same arguments", () => {
diff --git a/frontend/src/metabase/utils/memoize.ts b/frontend/src/metabase/utils/memoize.ts
index 3c4b41e32d7..885369a5817 100644
--- a/frontend/src/metabase/utils/memoize.ts
+++ b/frontend/src/metabase/utils/memoize.ts
@@ -1,5 +1,52 @@
type Constructor<T> = new (...args: any[]) => T;
+type MapLike<K, V> = Map<K, V> | WeakMap<WeakKey, V>;
+
+function getMapLikeWithFallback<K, V>(
+ map: MapLike<K, V>,
+ key: K,
+ fallback: () => V,
+): V {
+ // Unjustified type cast. FIXME
+ if ("has" in map && map.has(key as any)) {
+ // Unjustified type cast. FIXME
+ return map.get(key as any)!;
+ } else {
+ const value = fallback();
+ // Unjustified type cast. FIXME
+ map.set(key as any, value);
+ return value;
+ }
+}
+
+type CacheValue = unknown;
+type CacheMap = Map<unknown, CacheValue | CacheMap>;
+
+const rootCache = new WeakMap<object, CacheMap>();
+const createCacheMap = (): CacheMap => new Map();
+
+export function memoize<T extends (...args: any[]) => any>(fn: T): T {
+ const memoizedFn = (...args: Parameters<T>): ReturnType<T> => {
+ const [first, ...rest] = [fn, args.length, ...args];
+ const lastKey = rest.pop()!;
+
+ let currentMap = getMapLikeWithFallback(rootCache, first, createCacheMap);
+ for (const key of rest) {
+ const nextMap = getMapLikeWithFallback(currentMap, key, createCacheMap);
+ if (nextMap instanceof Map) {
+ currentMap = nextMap;
+ } else {
+ throw new Error("Invalid cache structure");
+ }
+ }
+
+ return getMapLikeWithFallback(currentMap, lastKey, () => fn(...args));
+ };
+
+ // Unjustified type cast. FIXME
+ return memoizedFn as T;
+}
+
function getWithFallback(
map: Map<string, any>,
key: string,
diff --git a/frontend/src/metabase/visualizations/components/ChartTooltip/KeyValuePairChartTooltip/KeyValuePairChartTooltip.tsx b/frontend/src/metabase/visualizations/components/ChartTooltip/KeyValuePairChartTooltip/KeyValuePairChartTooltip.tsx
index fe3c6c7d625..9a1bb927f51 100644
--- a/frontend/src/metabase/visualizations/components/ChartTooltip/KeyValuePairChartTooltip/KeyValuePairChartTooltip.tsx
+++ b/frontend/src/metabase/visualizations/components/ChartTooltip/KeyValuePairChartTooltip/KeyValuePairChartTooltip.tsx
@@ -12,7 +12,7 @@ import type {
} from "metabase/visualizations/types";
import type { DatasetColumn } from "metabase-types/api";
-import { formatValueForTooltip } from "../utils";
+import { formatValueForTooltip } from "../../../echarts/tooltip/format";
import S from "./KeyValuePairChartTooltip.module.css";
diff --git a/frontend/src/metabase/visualizations/components/ChartTooltip/StackedDataTooltip/StackedDataTooltip.tsx b/frontend/src/metabase/visualizations/components/ChartTooltip/StackedDataTooltip/StackedDataTooltip.tsx
index 7f7174941e8..f925deee96e 100644
--- a/frontend/src/metabase/visualizations/components/ChartTooltip/StackedDataTooltip/StackedDataTooltip.tsx
+++ b/frontend/src/metabase/visualizations/components/ChartTooltip/StackedDataTooltip/StackedDataTooltip.tsx
@@ -2,17 +2,17 @@ import { useMemo } from "react";
import { Box, Stack } from "metabase/ui";
import { color } from "metabase/ui/colors";
-import type { StackedTooltipModel } from "metabase/visualizations/types";
-import { TooltipRow, TooltipTotalRow } from "../TooltipRow";
-
-import S from "./StackedDataTooltip.module.css";
import {
getPercent,
getSortedRows,
getTotalValue,
groupExcessiveTooltipRows,
-} from "./utils";
+} from "../../../echarts/tooltip/utils";
+import type { StackedTooltipModel } from "../../../types";
+import { TooltipRow, TooltipTotalRow } from "../TooltipRow";
+
+import S from "./StackedDataTooltip.module.css";
const MAX_BODY_ROWS = 8;
diff --git a/frontend/src/metabase/visualizations/components/TableInteractive/TableInteractive.tsx b/frontend/src/metabase/visualizations/components/TableInteractive/TableInteractive.tsx
index bf7f81db350..a40e9111692 100644
--- a/frontend/src/metabase/visualizations/components/TableInteractive/TableInteractive.tsx
+++ b/frontend/src/metabase/visualizations/components/TableInteractive/TableInteractive.tsx
@@ -20,10 +20,7 @@ import _ from "underscore";
import { ErrorMessage } from "metabase/common/components/ErrorMessage";
import { ExplicitSize } from "metabase/common/components/ExplicitSize";
import { ExternalLink } from "metabase/common/components/ExternalLink";
-import {
- memoize,
- useMemoizedCallback,
-} from "metabase/common/hooks/use-memoized-callback";
+import { useMemoizedCallback } from "metabase/common/hooks/use-memoized-callback";
import { useTranslateContent } from "metabase/content-translation/hooks";
import DashboardS from "metabase/css/dashboard.module.css";
import { DataGrid, type DataGridStylesProps } from "metabase/data-grid";
@@ -48,6 +45,7 @@ import { useDispatch } from "metabase/redux";
import { setUIControls } from "metabase/redux/query-builder";
import { Flex, type MantineTheme } from "metabase/ui";
import { getScrollBarSize } from "metabase/utils/dom";
+import { memoize } from "metabase/utils/memoize";
import { formatValue } from "metabase/value-formatting";
import {
getTableCellClickedObject,
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingEnumToggle.tsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingEnumToggle.tsx
index f531469382e..6a098eeebfb 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingEnumToggle.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingEnumToggle.tsx
@@ -1,12 +1,6 @@
import { Switch } from "metabase/ui";
-export type ChartSettingEnumToggleProps<T extends string> = {
- value: T | undefined;
- onChange: (value: T) => void;
- id?: string;
- checkedValue: T;
- uncheckedValue: T;
-};
+import type { ChartSettingEnumToggleProps } from "../../types/widget-props";
export const ChartSettingEnumToggle = <T extends string>({
value,
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingSegmentedControl/ChartSettingSegmentedControl.tsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingSegmentedControl/ChartSettingSegmentedControl.tsx
index c34d101f798..8490aebd08c 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingSegmentedControl/ChartSettingSegmentedControl.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingSegmentedControl/ChartSettingSegmentedControl.tsx
@@ -2,12 +2,8 @@ import cx from "classnames";
import CS from "metabase/css/core/index.css";
import { Box, Button, Center, Icon, Text } from "metabase/ui";
-import type { IconName } from "metabase-types/api";
-export type ChartSettingSegmentedControlProps = {
- options: { name: string; value: string; icon?: IconName }[];
- onChange: (value: string) => void;
- value: string;
-};
+
+import type { ChartSettingSegmentedControlProps } from "../../../types/widget-props";
export const ChartSettingSegmentedControl = ({
options,
diff --git a/frontend/src/metabase/visualizations/echarts/boxplot/events.ts b/frontend/src/metabase/visualizations/echarts/boxplot/events.ts
index 322f340ee69..741044bad68 100644
--- a/frontend/src/metabase/visualizations/echarts/boxplot/events.ts
+++ b/frontend/src/metabase/visualizations/echarts/boxplot/events.ts
@@ -4,7 +4,6 @@ import type {
EChartsTooltipModel,
EChartsTooltipRow,
} from "metabase/visualizations/components/ChartTooltip/EChartsTooltip";
-import { formatValueForTooltip } from "metabase/visualizations/components/ChartTooltip/utils";
import {
INDEX_KEY,
X_AXIS_DATA_KEY,
@@ -19,6 +18,8 @@ import type {
import type { ClickObject, ClickObjectDimension } from "metabase-lib";
import type { DatasetColumn, RowValue } from "metabase-types/api";
+import { formatValueForTooltip } from "../tooltip/format";
+
import type {
BoxPlotChartModel,
BoxPlotDatum,
diff --git a/frontend/src/metabase/visualizations/echarts/boxplot/model/index.ts b/frontend/src/metabase/visualizations/echarts/boxplot/model/index.ts
index fb3484ab0d3..6baf2a10df0 100644
--- a/frontend/src/metabase/visualizations/echarts/boxplot/model/index.ts
+++ b/frontend/src/metabase/visualizations/echarts/boxplot/model/index.ts
@@ -1,5 +1,5 @@
-import { memoize } from "metabase/common/hooks/use-memoized-callback";
import { NULL_DISPLAY_VALUE } from "metabase/utils/constants";
+import { memoize } from "metabase/utils/memoize";
import { formatValue } from "metabase/value-formatting";
import {
ECHARTS_CATEGORY_AXIS_NULL_VALUE,
diff --git a/frontend/src/metabase/visualizations/echarts/cartesian/model/series.ts b/frontend/src/metabase/visualizations/echarts/cartesian/model/series.ts
index 1b25216045a..2b30b5e5a30 100644
--- a/frontend/src/metabase/visualizations/echarts/cartesian/model/series.ts
+++ b/frontend/src/metabase/visualizations/echarts/cartesian/model/series.ts
@@ -1,5 +1,5 @@
-import { memoize } from "metabase/common/hooks/use-memoized-callback";
import { NULL_DISPLAY_VALUE } from "metabase/utils/constants";
+import { memoize } from "metabase/utils/memoize";
import { isEmpty } from "metabase/utils/validate";
import { formatValue } from "metabase/value-formatting";
import { getDatasetKey } from "metabase/visualizations/echarts/cartesian/model/dataset";
diff --git a/frontend/src/metabase/visualizations/echarts/graph/sankey/model/formatters.ts b/frontend/src/metabase/visualizations/echarts/graph/sankey/model/formatters.ts
index b325f240a52..9ef0095fccd 100644
--- a/frontend/src/metabase/visualizations/echarts/graph/sankey/model/formatters.ts
+++ b/frontend/src/metabase/visualizations/echarts/graph/sankey/model/formatters.ts
@@ -1,4 +1,4 @@
-import { memoize } from "metabase/common/hooks/use-memoized-callback";
+import { memoize } from "metabase/utils/memoize";
import { formatValue } from "metabase/value-formatting";
import type { ComputedVisualizationSettings } from "metabase/visualizations/types";
diff --git a/frontend/src/metabase/visualizations/echarts/graph/sankey/option/tooltip.tsx b/frontend/src/metabase/visualizations/echarts/graph/sankey/option/tooltip.tsx
index 520f3577cea..355f9ab246e 100644
--- a/frontend/src/metabase/visualizations/echarts/graph/sankey/option/tooltip.tsx
+++ b/frontend/src/metabase/visualizations/echarts/graph/sankey/option/tooltip.tsx
@@ -7,7 +7,6 @@ import {
EChartsTooltip,
type EChartsTooltipRow,
} from "metabase/visualizations/components/ChartTooltip/EChartsTooltip";
-import { getPercent } from "metabase/visualizations/components/ChartTooltip/StackedDataTooltip/utils";
import {
getMarkerColorClass,
getTooltipBaseOption,
@@ -15,6 +14,7 @@ import {
import { getNumberOr } from "metabase/visualizations/lib/settings/row-values";
import { getColumnKey } from "metabase-lib/v1/queries/utils/column-key";
+import { getPercent } from "../../../tooltip/utils";
import type { SankeyChartModel } from "../model/types";
interface ChartItemTooltipProps {
diff --git a/frontend/src/metabase/visualizations/components/ChartTooltip/utils.ts b/frontend/src/metabase/visualizations/echarts/tooltip/format.ts
similarity index 100%
rename from frontend/src/metabase/visualizations/components/ChartTooltip/utils.ts
rename to frontend/src/metabase/visualizations/echarts/tooltip/format.ts
diff --git a/frontend/src/metabase/visualizations/components/ChartTooltip/StackedDataTooltip/utils.ts b/frontend/src/metabase/visualizations/echarts/tooltip/utils.ts
similarity index 100%
rename from frontend/src/metabase/visualizations/components/ChartTooltip/StackedDataTooltip/utils.ts
rename to frontend/src/metabase/visualizations/echarts/tooltip/utils.ts
diff --git a/frontend/src/metabase/visualizations/lib/settings/graph.ts b/frontend/src/metabase/visualizations/lib/settings/graph.ts
index e4b5aae41cc..7a8500ea827 100644
--- a/frontend/src/metabase/visualizations/lib/settings/graph.ts
+++ b/frontend/src/metabase/visualizations/lib/settings/graph.ts
@@ -7,8 +7,6 @@ import {
getMaxMetricsSupported,
} from "metabase/visualizations";
import { trackStackedSeriesEnabled } from "metabase/visualizations/analytics";
-import type { ChartSettingEnumToggleProps } from "metabase/visualizations/components/settings/ChartSettingEnumToggle";
-import type { ChartSettingSegmentedControlProps } from "metabase/visualizations/components/settings/ChartSettingSegmentedControl";
import { dimensionIsNumeric } from "metabase/visualizations/lib/numeric";
import { columnSettings } from "metabase/visualizations/lib/settings/column";
import { seriesSetting } from "metabase/visualizations/lib/settings/series";
@@ -59,6 +57,11 @@ import { getColumnKey } from "metabase-lib/v1/queries/utils/column-key";
import { isNumeric } from "metabase-lib/v1/types/utils/isa";
import type { Series, VisualizationDisplay } from "metabase-types/api";
+import type {
+ ChartSettingEnumToggleProps,
+ ChartSettingSegmentedControlProps,
+} from "../../types/widget-props";
+
export const getSeriesDisplays = (
transformedSeries: Series,
settings: ComputedVisualizationSettings,
diff --git a/frontend/src/metabase/visualizations/types/visualization.ts b/frontend/src/metabase/visualizations/types/visualization.ts
index 5687bc306a2..fbc6b9ab92b 100644
--- a/frontend/src/metabase/visualizations/types/visualization.ts
+++ b/frontend/src/metabase/visualizations/types/visualization.ts
@@ -46,7 +46,6 @@ import type { VisualizationDisplay } from "metabase-types/api/visualization";
import type { ChartSettingGoalInputProps } from "../components/settings/ChartSettingGoalInput";
import type { ChartSettingMaxCategoriesProps } from "../components/settings/ChartSettingMaxCategories";
-import type { ChartSettingSegmentedControlProps } from "../components/settings/ChartSettingSegmentedControl";
import type { ChartSettingSegmentsEditorProps } from "../components/settings/ChartSettingSegmentsEditor";
import type { ChartSettingSeriesOrderProps } from "../components/settings/ChartSettingSeriesOrder";
import type { ChartSettingTableColumnsProps } from "../components/settings/ChartSettingTableColumns";
@@ -57,6 +56,7 @@ import type { TreemapGroupsPickerProps } from "../visualizations/TreemapChart/Tr
import type { RemappingHydratedDatasetColumn } from "./columns";
import type { HighlightedObject, HoveredObject } from "./hover";
+import type { ChartSettingSegmentedControlProps } from "./widget-props";
export interface Padding {
top: number;
diff --git a/frontend/src/metabase/visualizations/types/widget-props.ts b/frontend/src/metabase/visualizations/types/widget-props.ts
new file mode 100644
index 00000000000..738902fb6a3
--- /dev/null
+++ b/frontend/src/metabase/visualizations/types/widget-props.ts
@@ -0,0 +1,19 @@
+import type { IconName } from "metabase-types/api";
+
+// Prop contracts for setting widgets that settings definitions reference by
+// string name. They live here rather than with the widget components so the
+// type dependency runs UI -> core.
+
+export type ChartSettingEnumToggleProps<T extends string> = {
+ value: T | undefined;
+ onChange: (value: T) => void;
+ id?: string;
+ checkedValue: T;
+ uncheckedValue: T;
+};
+
+export type ChartSettingSegmentedControlProps = {
+ options: { name: string; value: string; icon?: IconName }[];
+ onChange: (value: string) => void;
+ value: string;
+};
diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/events.ts b/frontend/src/metabase/visualizations/visualizations/CartesianChart/events.ts
index 27830a7e6ea..e38fdafd49b 100644
--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/events.ts
+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/events.ts
@@ -14,11 +14,6 @@ import type {
EChartsTooltipModel,
EChartsTooltipRow,
} from "metabase/visualizations/components/ChartTooltip/EChartsTooltip";
-import {
- getPercent,
- getTotalValue,
-} from "metabase/visualizations/components/ChartTooltip/StackedDataTooltip/utils";
-import { formatValueForTooltip } from "metabase/visualizations/components/ChartTooltip/utils";
import {
INDEX_KEY,
IS_WATERFALL_TOTAL_DATA_KEY,
@@ -82,6 +77,9 @@ import type {
} from "metabase-types/api";
import { isSavedCard } from "metabase-types/guards";
+import { formatValueForTooltip } from "../../echarts/tooltip/format";
+import { getPercent, getTotalValue } from "../../echarts/tooltip/utils";
+
export const parseDataKey = (dataKey: DataKey) => {
let cardId: Nullable<CardId> = null;
diff --git a/frontend/src/metabase/visualizations/visualizations/PieChart/use-chart-events.ts b/frontend/src/metabase/visualizations/visualizations/PieChart/use-chart-events.ts
index 6a4a8bc22e9..06028aeb59d 100644
--- a/frontend/src/metabase/visualizations/visualizations/PieChart/use-chart-events.ts
+++ b/frontend/src/metabase/visualizations/visualizations/PieChart/use-chart-events.ts
@@ -8,7 +8,6 @@ import type {
EChartsTooltipModel,
EChartsTooltipRow,
} from "metabase/visualizations/components/ChartTooltip/EChartsTooltip";
-import { getTotalValue } from "metabase/visualizations/components/ChartTooltip/StackedDataTooltip/utils";
import type { PieChartFormatters } from "metabase/visualizations/echarts/pie/format";
import type {
PieChartModel,
@@ -33,6 +32,8 @@ import type { EChartsEventHandler } from "metabase/visualizations/types/echarts"
import type { ClickObjectDimension } from "metabase-lib";
import type { DatasetColumn, RowValue } from "metabase-types/api";
+import { getTotalValue } from "../../echarts/tooltip/utils";
+
export const getTooltipModel = (
sliceKeyPath: string[],
chartModel: PieChartModel,