Skip to content

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

Register visualization definitions eagerly, load chart components on demand (#79745)

Romeo Van Snick3933c1118381
diff --git a/.storybook/preview.tsx b/.storybook/preview.tsx
index 8f6ae466cf9..8b3626ffae2 100644
--- a/.storybook/preview.tsx
+++ b/.storybook/preview.tsx
@@ -29,6 +29,7 @@ import { EmotionCacheProvider } from "metabase/ui/components/theme/EmotionCacheP
import { Global, css, useTheme } from "@emotion/react";
+import { loadVisualizationComponents } from "metabase/visualizations";
import { saveDomImageStyles } from "metabase/visualizations/lib/image-exports";
import { initialize, mswLoader } from "msw-storybook-addon";
@@ -207,7 +208,11 @@ initialize({
const preview = {
parameters,
decorators,
- loaders: [mswLoader, fontsReady],
+ // Chart components are loaded on demand, so a story that renders through the
+ // registry would otherwise be captured mid-Suspense, showing the skeleton.
+ // Wrapped because a loader is called with the story context, which would
+ // otherwise be taken for the list of displays to load.
+ loaders: [mswLoader, fontsReady, () => loadVisualizationComponents()],
argTypes,
};
diff --git a/frontend/src/metabase/querying/common/components/DataSelector/saved-entity-picker/SavedEntityPicker.unit.spec.tsx b/frontend/src/metabase/querying/common/components/DataSelector/saved-entity-picker/SavedEntityPicker.unit.spec.tsx
index c0aabd6240c..b91690050b5 100644
--- a/frontend/src/metabase/querying/common/components/DataSelector/saved-entity-picker/SavedEntityPicker.unit.spec.tsx
+++ b/frontend/src/metabase/querying/common/components/DataSelector/saved-entity-picker/SavedEntityPicker.unit.spec.tsx
@@ -97,7 +97,9 @@ describe("SavedEntityPicker", () => {
await setup();
expect(
- screen.getAllByTestId("option-text").map((node) => node.textContent),
+ (await screen.findAllByTestId("option-text")).map(
+ (node) => node.textContent,
+ ),
).toEqual(["a", "A", "B"]);
});
});
diff --git a/frontend/src/metabase/querying/components/QueryVisualization/QueryVisualization.tsx b/frontend/src/metabase/querying/components/QueryVisualization/QueryVisualization.tsx
index 19e24ce7aca..2e6703074c1 100644
--- a/frontend/src/metabase/querying/components/QueryVisualization/QueryVisualization.tsx
+++ b/frontend/src/metabase/querying/components/QueryVisualization/QueryVisualization.tsx
@@ -1,6 +1,6 @@
import cx from "classnames";
import type { ReactNode } from "react";
-import { useState } from "react";
+import { useEffect, useState } from "react";
import { useTimeout } from "react-use";
import { c, t } from "ttag";
@@ -12,6 +12,7 @@ import { getWhiteLabeledLoadingMessageFactory } from "metabase/selectors/whitela
import { Box, Flex, Loader, Stack, Text, Title } from "metabase/ui";
import { isMac } from "metabase/utils/browser";
import { SERVER_ERROR_TYPES } from "metabase/utils/errors";
+import { prefetchVisualizationComponent } from "metabase/visualizations";
import * as Lib from "metabase-lib";
import { HARD_ROW_LIMIT } from "metabase-lib/v1/queries/utils";
@@ -39,6 +40,14 @@ export function QueryVisualization(props: QueryVisualizationProps) {
const canRun = Lib.canRun(question.query(), question.type());
const [warnings, setWarnings] = useState<string[]>([]);
+
+ // The result is not rendered until the query returns, so the chart chunk
+ // would only start downloading then. Start it from the display alone, so it
+ // loads in parallel with the query.
+ const display = question.display();
+ useEffect(() => {
+ prefetchVisualizationComponent(display);
+ }, [display]);
const isDirtyStateShown =
canRun &&
isResultDirty &&
diff --git a/frontend/src/metabase/visualizations/components/EChartsRenderer/ResponsiveEChartsRenderer.tsx b/frontend/src/metabase/visualizations/components/EChartsRenderer/ResponsiveEChartsRenderer.tsx
index 93a0ee8db34..040672879a6 100644
--- a/frontend/src/metabase/visualizations/components/EChartsRenderer/ResponsiveEChartsRenderer.tsx
+++ b/frontend/src/metabase/visualizations/components/EChartsRenderer/ResponsiveEChartsRenderer.tsx
@@ -1,19 +1,15 @@
-import { Suspense, forwardRef, useLayoutEffect } from "react";
+import { forwardRef, useLayoutEffect } from "react";
import { ExplicitSize } from "metabase/common/components/ExplicitSize";
-import { Flex } from "metabase/ui";
import { isNumber } from "metabase/utils/types";
-import type { EChartsRendererProps } from "metabase/visualizations/components/EChartsRenderer/EChartsRenderer";
+import {
+ EChartsRenderer,
+ type EChartsRendererProps,
+} from "metabase/visualizations/components/EChartsRenderer/EChartsRenderer";
import { ResponsiveEChartsRendererStyled } from "metabase/visualizations/components/EChartsRenderer/ResponsiveEChartsRenderer.styled";
-import { LazyEChartsRenderer } from "metabase/visualizations/components/EChartsRenderer/lazy";
-import { getChartSkeletonImage } from "metabase/visualizations/components/skeletons/ChartSkeleton/ChartSkeleton";
-import type { VisualizationDisplay } from "metabase-types/api";
export interface ResponsiveEChartsRendererProps extends React.PropsWithChildren<EChartsRendererProps> {
onResize?: (width: number, height: number) => void;
- // Display type of the chart, used to show a matching skeleton while the
- // echarts chunk is loading.
- display?: VisualizationDisplay;
}
const ResponsiveEChartsRendererInner = forwardRef<
@@ -25,7 +21,6 @@ const ResponsiveEChartsRendererInner = forwardRef<
width,
height,
children,
- display,
...echartsRenderedProps
}: ResponsiveEChartsRendererProps,
ref,
@@ -42,26 +37,12 @@ const ResponsiveEChartsRendererInner = forwardRef<
return (
<ResponsiveEChartsRendererStyled>
- <Suspense
- fallback={
- <Flex h="100%" w="100%" direction="column">
- {getChartSkeletonImage(
- display === "boxplot"
- ? "scatter"
- : display === "combo"
- ? "bar"
- : display,
- )}
- </Flex>
- }
- >
- <LazyEChartsRenderer
- ref={ref}
- {...echartsRenderedProps}
- width={width}
- height={height}
- />
- </Suspense>
+ <EChartsRenderer
+ ref={ref}
+ {...echartsRenderedProps}
+ width={width}
+ height={height}
+ />
{children}
</ResponsiveEChartsRendererStyled>
);
diff --git a/frontend/src/metabase/visualizations/components/EChartsRenderer/index.ts b/frontend/src/metabase/visualizations/components/EChartsRenderer/index.ts
index bae6eb54004..e1c9e28589d 100644
--- a/frontend/src/metabase/visualizations/components/EChartsRenderer/index.ts
+++ b/frontend/src/metabase/visualizations/components/EChartsRenderer/index.ts
@@ -1,8 +1,3 @@
-// NOTE: do not statically re-export the EChartsRenderer *value* here. It is
-// loaded lazily (see ResponsiveEChartsRenderer) so that echarts lands in its
-// own async chunk; a static `export *` would pull it back into the initial
-// bundle. Types are erased at build time, so re-exporting them is safe.
export type { EChartsRendererProps } from "./EChartsRenderer";
export type { ResponsiveEChartsRendererProps } from "./ResponsiveEChartsRenderer";
-export { prefetchEChartsRenderer } from "./lazy";
export { ResponsiveEChartsRenderer } from "./ResponsiveEChartsRenderer.styled";
diff --git a/frontend/src/metabase/visualizations/components/EChartsRenderer/lazy.ts b/frontend/src/metabase/visualizations/components/EChartsRenderer/lazy.ts
deleted file mode 100644
index 7e9e6d456e8..00000000000
--- a/frontend/src/metabase/visualizations/components/EChartsRenderer/lazy.ts
+++ /dev/null
@@ -1,31 +0,0 @@
-import { lazy } from "react";
-
-// echarts (its chart classes, components, the core SVG renderer and zrender) is
-// the single largest dependency in the app bundle. Loading EChartsRenderer
-// lazily moves all of it into its own async chunk so it is not part of the
-// initial page load.
-//
-// This lives in its own module (rather than next to ResponsiveEChartsRenderer)
-// to avoid a module-load-order cycle: ResponsiveEChartsRenderer and its styled
-// component import each other, so importing the prefetch helper from there would
-// force that pair to evaluate in the wrong order.
-const importEChartsRenderer = () =>
- import(
- /* webpackChunkName: "echarts-renderer" */
- "metabase/visualizations/components/EChartsRenderer/EChartsRenderer"
- );
-
-// Start downloading the echarts chunk ahead of render — e.g. as soon as a chart
-// card mounts, while its data query is still in flight — so the library loads
-// in parallel with the data instead of only after the chart is ready to render.
-// rspack de-duplicates the request, so this shares the same chunk as the lazy
-// component below.
-export const prefetchEChartsRenderer = () => {
- void importEChartsRenderer();
-};
-
-export const LazyEChartsRenderer = lazy(() =>
- importEChartsRenderer().then((module) => ({
- default: module.EChartsRenderer,
- })),
-);
diff --git a/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetail.unit.spec.tsx b/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetail.unit.spec.tsx
index 4c76bd173a1..e5c2be02d37 100644
--- a/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetail.unit.spec.tsx
+++ b/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetail.unit.spec.tsx
@@ -12,6 +12,7 @@ import {
} from "metabase/redux/store/mocks";
import { getMetadata } from "metabase/selectors/metadata";
import { checkNotNull } from "metabase/utils/types";
+import { loadVisualizationComponents } from "metabase/visualizations";
import { ObjectDetail } from "metabase/visualizations/components/ObjectDetail/ObjectDetail";
import type { ObjectDetailProps } from "metabase/visualizations/components/ObjectDetail/types";
import { registerVisualizations } from "metabase/visualizations/register";
@@ -20,6 +21,10 @@ import { createProductsTable } from "metabase-types/api/mocks/presets";
registerVisualizations();
+// Chart components are loaded on demand. Register them up front so each test
+// renders in one pass and can be run on its own.
+beforeAll(() => loadVisualizationComponents(["object"]));
+
const DATABASE_ID = 1;
const MOCK_TABLE = createProductsTable();
diff --git a/frontend/src/metabase/visualizations/components/Visualization/Visualization-loading.unit.spec.tsx b/frontend/src/metabase/visualizations/components/Visualization/Visualization-loading.unit.spec.tsx
new file mode 100644
index 00000000000..e0055dbda6f
--- /dev/null
+++ b/frontend/src/metabase/visualizations/components/Visualization/Visualization-loading.unit.spec.tsx
@@ -0,0 +1,141 @@
+import type { ComponentProps } from "react";
+
+import { mockSettings } from "__support__/settings";
+import { renderWithProviders, screen, waitFor } from "__support__/ui";
+import { delay } from "__support__/utils";
+import { createMockState } from "metabase/redux/store/mocks";
+import { registerVisualization } from "metabase/visualizations";
+import VisualizationComponent from "metabase/visualizations/components/Visualization";
+import type { Visualization } from "metabase/visualizations/types";
+import type { VisualizationDisplay } from "metabase-types/api";
+import {
+ createMockCard,
+ createMockDatasetData,
+ createMockNumericColumn,
+} from "metabase-types/api/mocks";
+
+const createDefinition = (display: VisualizationDisplay) => ({
+ getUiName: () => String(display),
+ identifier: display,
+ iconName: "unknown" as const,
+ minSize: { width: 1, height: 1 },
+ defaultSize: { width: 4, height: 4 },
+ settings: {},
+ isSensible: () => false,
+ checkRenderable: () => undefined,
+});
+
+const createChart = (display: VisualizationDisplay) =>
+ Object.assign(
+ () => <div>{`${display} chart`}</div>,
+ createDefinition(display),
+ );
+
+/** A visualization whose chunk resolves only when the test says so. */
+function registerDeferred(name: string) {
+ // A cast is needed because the registry is keyed by the known display types.
+ const display = name as VisualizationDisplay;
+ const definition = createDefinition(display);
+ let resolveComponent!: () => void;
+ const chunk = new Promise<Visualization>((resolve) => {
+ resolveComponent = () => resolve(createChart(display));
+ });
+ registerVisualization(definition, () => chunk);
+ return { display, resolveComponent };
+}
+
+// A card with no `data` is the shape the card has while its query runs, which
+// is why the prop accepts a bare card alongside a full series.
+type CardSeries = NonNullable<
+ ComponentProps<typeof VisualizationComponent>["rawSeries"]
+>;
+
+const seriesFor = (
+ display: VisualizationDisplay,
+ withData: boolean,
+): CardSeries => [
+ withData
+ ? {
+ card: createMockCard({ display }),
+ data: createMockDatasetData({
+ cols: [createMockNumericColumn({ name: "Count" })],
+ rows: [[1]],
+ }),
+ }
+ : { card: createMockCard({ display }) },
+];
+
+const renderCard = (series: CardSeries) =>
+ renderWithProviders(
+ <VisualizationComponent rawSeries={series} isDashboard />,
+ { storeInitialState: createMockState({ settings: mockSettings() }) },
+ );
+
+const loadingIndicator = () => screen.queryByTestId("loading-indicator");
+
+describe("Visualization loading states", () => {
+ it("shows one loading state while the data and the chunk load in parallel", async () => {
+ const { display, resolveComponent } = registerDeferred("parallel-load");
+ const { rerender } = renderCard(seriesFor(display, false));
+ await delay(0);
+
+ expect(loadingIndicator()).toBeInTheDocument();
+
+ // Data arrives first, the chunk is still in flight. The card must not
+ // swap one loading state for a different one.
+ rerender(
+ <VisualizationComponent
+ rawSeries={seriesFor(display, true)}
+ isDashboard
+ />,
+ );
+ await delay(0);
+ expect(loadingIndicator()).toBeInTheDocument();
+
+ resolveComponent();
+ expect(await screen.findByText(`${display} chart`)).toBeInTheDocument();
+ expect(loadingIndicator()).not.toBeInTheDocument();
+ });
+
+ it("shows one loading state when the data is ready and the chunk is not", async () => {
+ const { display, resolveComponent } = registerDeferred("data-first");
+ renderCard(seriesFor(display, true));
+ await delay(0);
+
+ expect(loadingIndicator()).toBeInTheDocument();
+
+ resolveComponent();
+ expect(await screen.findByText(`${display} chart`)).toBeInTheDocument();
+ expect(loadingIndicator()).not.toBeInTheDocument();
+ });
+
+ it("shows one loading state when the chunk is ready and the data is not", async () => {
+ const { display, resolveComponent } = registerDeferred("chunk-first");
+ resolveComponent();
+
+ const { rerender } = renderCard(seriesFor(display, false));
+ await delay(0);
+ expect(loadingIndicator()).toBeInTheDocument();
+
+ rerender(
+ <VisualizationComponent
+ rawSeries={seriesFor(display, true)}
+ isDashboard
+ />,
+ );
+ expect(await screen.findByText(`${display} chart`)).toBeInTheDocument();
+ expect(loadingIndicator()).not.toBeInTheDocument();
+ });
+
+ it("shows no loading state when both are already available", async () => {
+ // A cast is needed because the registry is keyed by the known display types.
+ const display = "both-ready" as VisualizationDisplay;
+ registerVisualization(createChart(display));
+
+ renderCard(seriesFor(display, true));
+
+ expect(loadingIndicator()).not.toBeInTheDocument();
+ expect(screen.getByText(`${display} chart`)).toBeInTheDocument();
+ await waitFor(() => expect(loadingIndicator()).not.toBeInTheDocument());
+ });
+});
diff --git a/frontend/src/metabase/visualizations/components/Visualization/Visualization-object.unit.spec.tsx b/frontend/src/metabase/visualizations/components/Visualization/Visualization-object.unit.spec.tsx
index 6940064c25d..73f2dd02a80 100644
--- a/frontend/src/metabase/visualizations/components/Visualization/Visualization-object.unit.spec.tsx
+++ b/frontend/src/metabase/visualizations/components/Visualization/Visualization-object.unit.spec.tsx
@@ -3,6 +3,7 @@ import {
setupDatabasesEndpoints,
} from "__support__/server-mocks";
import { renderWithProviders, screen } from "__support__/ui";
+import { loadVisualizationComponents } from "metabase/visualizations";
import Visualization from "metabase/visualizations/components/Visualization";
import { registerVisualizations } from "metabase/visualizations/register";
import type { FieldVisibilityType } from "metabase-types/api";
@@ -14,6 +15,10 @@ import { createSampleDatabase } from "metabase-types/api/mocks/presets";
registerVisualizations();
+// Chart components are loaded on demand. Register them up front so each test
+// renders in one pass and can be run on its own.
+beforeAll(() => loadVisualizationComponents(["object"]));
+
function setup({
rows,
longNameVisibility = "normal",
diff --git a/frontend/src/metabase/visualizations/components/Visualization/Visualization-themed.unit.spec.tsx b/frontend/src/metabase/visualizations/components/Visualization/Visualization-themed.unit.spec.tsx
index 4c137f639ae..9c1c9cee7bb 100644
--- a/frontend/src/metabase/visualizations/components/Visualization/Visualization-themed.unit.spec.tsx
+++ b/frontend/src/metabase/visualizations/components/Visualization/Visualization-themed.unit.spec.tsx
@@ -2,6 +2,7 @@ import { renderWithProviders, screen } from "__support__/ui";
import { delay } from "__support__/utils";
import { NumberColumn, StringColumn } from "__support__/visualizations";
import { getColorShades } from "metabase/ui/utils/colors";
+import { loadVisualizationComponents } from "metabase/visualizations";
import { registerVisualizations } from "metabase/visualizations/register";
import type { Series } from "metabase-types/api";
import { createMockCard } from "metabase-types/api/mocks";
@@ -10,6 +11,10 @@ import Visualization from ".";
registerVisualizations();
+// Chart components are loaded on demand. Register them up front so each test
+// renders in one pass and can be run on its own.
+beforeAll(() => loadVisualizationComponents(["bar"]));
+
describe("Themed Visualization", () => {
it("inherits the chart label color from the theme", async () => {
const TEST_COLOR = "rgb(44, 55, 66)";
diff --git a/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx b/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx
index 6d9cd9a1260..522ad40678f 100644
--- a/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx
+++ b/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx
@@ -7,6 +7,7 @@ import React, {
PureComponent,
type ReactNode,
type Ref,
+ Suspense,
forwardRef,
} from "react";
import { t } from "ttag";
@@ -32,14 +33,15 @@ import { formatNumber } from "metabase/utils/formatting";
import { memoizeClass } from "metabase/utils/memoize";
import {
extractRemappings,
+ getVisualizationComponent,
getVisualizationTransformed,
+ prefetchVisualizationComponent,
} from "metabase/visualizations";
import { Mode } from "metabase/visualizations/click-actions/Mode";
import { getMode } from "metabase/visualizations/click-actions/lib/modes";
import ChartCaption from "metabase/visualizations/components/ChartCaption";
import ChartTooltip from "metabase/visualizations/components/ChartTooltip";
import { ConnectedClickActionsPopover } from "metabase/visualizations/components/ClickActions";
-import { prefetchEChartsRenderer } from "metabase/visualizations/components/EChartsRenderer/lazy";
import { performDefaultAction } from "metabase/visualizations/lib/action";
import {
ChartSettingsError,
@@ -60,7 +62,6 @@ import {
type VisualizationDefinition,
type VisualizationGridSize,
type VisualizationPassThroughProps,
- type Visualization as VisualizationType,
isClickActionsMode,
isRegularClickAction,
} from "metabase/visualizations/types";
@@ -355,22 +356,22 @@ class Visualization extends PureComponent<
this.updateWarnings();
}
if (prevState.visualization !== this.state.visualization) {
- this.maybePrefetchEChartsRenderer();
+ this.prefetchVisualizationComponent();
}
}
componentDidMount() {
this.updateWarnings();
- this.maybePrefetchEChartsRenderer();
+ this.prefetchVisualizationComponent();
}
- // Kick off loading the (lazy) echarts chunk as soon as an echarts-based chart
- // mounts — typically while its data query is still in flight — so the library
- // downloads in parallel with the data rather than only once the chart is
- // ready to render.
- maybePrefetchEChartsRenderer() {
- if (this.state.visualization?.usesEChartsRenderer) {
- prefetchEChartsRenderer();
+ // Charts are loaded on demand. Start the download as the card mounts, while
+ // its data query is still in flight, rather than once the data is ready. A
+ // chart that uses echarts pulls the library in with its own chunk.
+ prefetchVisualizationComponent() {
+ const { visualization } = this.state;
+ if (visualization) {
+ prefetchVisualizationComponent(visualization.identifier);
}
}
@@ -747,6 +748,11 @@ class Visualization extends PureComponent<
const { width, height } = this.getNormalizedSizes();
const { genericError, visualization, isNativeView } = this.state;
+ // Only resolved when there is a visualization: passing null would fall back
+ // to the default and build its lazy wrapper for a card that then errors.
+ const CardVisualization = visualization
+ ? getVisualizationComponent(visualization.identifier)
+ : undefined;
const small = width < SMALL_CARD_WIDTH_THRESHOLD;
// these may be overridden below
@@ -774,7 +780,7 @@ class Visualization extends PureComponent<
const settings = this.props.settings || this.state.computedSettings;
if (!loading && !error) {
- if (!visualization) {
+ if (!visualization || !CardVisualization) {
error = t`Could not find visualization`;
} else {
try {
@@ -840,9 +846,6 @@ class Visualization extends PureComponent<
};
}
- // Unjustified type cast. FIXME
- const CardVisualization = visualization as VisualizationType;
-
const isVisualizerDashCard = isVisualizerDashboardCard(dashcard);
const title = settings["card.title"];
@@ -920,111 +923,119 @@ class Visualization extends PureComponent<
isNativeView={isNativeView}
/>
) : (
- series && (
+ series &&
+ CardVisualization && (
<div
data-card-key={getCardKey(series[0].card?.id)}
className={cx(CS.flex, CS.flexColumn, CS.flexFull)}
style={{ position: hasDevWatermark ? "relative" : undefined }}
>
- <VisualizationRenderedWrapper
- onRendered={this.handleVisualizationRendered}
+ {/* The same view the card shows while its data loads, so a
+ chunk that arrives after the data does not swap one
+ loading state for a different one. */}
+ <Suspense
+ fallback={renderLoadingView({ expectedDuration, isSlow })}
>
- <CardVisualization
- actionButtons={actionButtons}
- // NOTE: CardVisualization class used as a selector for tests
- className={cx(
- "CardVisualization",
- CS.flexFull,
- CS.flexBasisNone,
- )}
- card={series[0].card} // convenience for single-series visualizations
- canToggleSeriesVisibility={canToggleSeriesVisibility}
- clicked={clicked}
- data={series[0].data} // convenience for single-series visualizations
- dashboard={dashboard}
- dashcard={dashcard}
- dispatch={dispatch}
- errorIcon={errorIcon}
- fontFamily={fontFamily}
- getExtraDataForClick={getExtraDataForClick}
- getHref={getHref}
- gridSize={gridSize}
- headerIcon={hasHeader ? null : headerIcon}
- height={height}
- hovered={hovered}
- highlighted={highlighted}
- isDashboard={!!isDashboard}
- isDocument={!!isDocument}
- isEditing={!!isEditing}
- isEmbeddingSdk={isEmbeddingSdk}
- isFullscreen={!!isFullscreen}
- isMetricsViewer={!!isMetricsViewer}
- isMobile={!!isMobile}
- isVisualizer={!!isVisualizer}
- isVisualizerCard={isVisualizerDashCard}
- isObjectDetail={isObjectDetail}
- isPreviewing={isPreviewing}
- isRawTable={isRawTable}
- isQueryBuilder={!!isQueryBuilder}
- isSettings={!!isSettings}
- isShowingDetailsOnlyColumns={isShowingDetailsOnlyColumns}
- scrollToLastColumn={scrollToLastColumn}
- metadata={metadata}
- mode={mode}
- queryBuilderMode={queryBuilderMode}
- // Unjustified type cast. FIXME
- rawSeries={rawSeries as RawSeries}
- visualizerRawSeries={visualizerRawSeries}
- renderEmptyMessage={renderEmptyMessage}
- renderTableHeader={renderTableHeader}
- scrollToColumn={scrollToColumn}
- selectedTimelineEventIds={selectedTimelineEventIds}
- series={series}
- settings={settings}
- autoAdjustSettings={!!autoAdjustSettings}
- showAllLegendItems={showAllLegendItems}
- hideLegend={hideLegend}
- showTitle={!!showTitle}
- tableHeaderHeight={tableHeaderHeight}
- timelineEvents={timelineEvents}
- totalNumGridCols={totalNumGridCols}
- visualizationIsClickable={this.visualizationIsClickable}
- width={width}
- zoomedRowIndex={zoomedRowIndex}
- onZoomRow={onZoomRow}
- onActionDismissal={this.hideActions}
- onChangeCardAndRun={
- this.props.onChangeCardAndRun
- ? this.handleOnChangeCardAndRun
- : null
- }
- onBrush={this.props.onBrush}
- onDeselectTimelineEvents={onDeselectTimelineEvents}
- onHoverChange={this.handleHoverChange}
- onOpenTimelines={onOpenTimelines}
- onRender={this.onRender}
- onRenderError={this.onRenderError}
- onSelectTimelineEvents={onSelectTimelineEvents}
- onSeeAllEvents={onSeeAllEvents}
- onTogglePreviewing={onTogglePreviewing}
- onUpdateVisualizationSettings={
- onUpdateVisualizationSettings
- }
- onUpdateWarnings={onUpdateWarnings}
- onVisualizationClick={this.handleVisualizationClick}
- onHeaderColumnReorder={this.props.onHeaderColumnReorder}
- titleMenuItems={hasHeader ? undefined : titleMenuItems}
- tableFooterExtraButtons={tableFooterExtraButtons}
- // These props are only used by the table on the Erroring Questions admin page
- isSelectable={isSelectable}
- rowChecked={rowChecked}
- onAllSelectClick={onAllSelectClick}
- onRowSelectClick={onRowSelectClick}
- isSortable={isSortable}
- sorting={sorting}
- onSortingChange={onSortingChange}
- />
- </VisualizationRenderedWrapper>
+ <VisualizationRenderedWrapper
+ onRendered={this.handleVisualizationRendered}
+ >
+ <CardVisualization
+ actionButtons={actionButtons}
+ // NOTE: CardVisualization class used as a selector for tests
+ className={cx(
+ "CardVisualization",
+ CS.flexFull,
+ CS.flexBasisNone,
+ )}
+ card={series[0].card} // convenience for single-series visualizations
+ canToggleSeriesVisibility={canToggleSeriesVisibility}
+ clicked={clicked}
+ data={series[0].data} // convenience for single-series visualizations
+ dashboard={dashboard}
+ dashcard={dashcard}
+ dispatch={dispatch}
+ errorIcon={errorIcon}
+ fontFamily={fontFamily}
+ getExtraDataForClick={getExtraDataForClick}
+ getHref={getHref}
+ gridSize={gridSize}
+ headerIcon={hasHeader ? null : headerIcon}
+ height={height}
+ hovered={hovered}
+ highlighted={highlighted}
+ isDashboard={!!isDashboard}
+ isDocument={!!isDocument}
+ isEditing={!!isEditing}
+ isEmbeddingSdk={isEmbeddingSdk}
+ isFullscreen={!!isFullscreen}
+ isMetricsViewer={!!isMetricsViewer}
+ isMobile={!!isMobile}
+ isVisualizer={!!isVisualizer}
+ isVisualizerCard={isVisualizerDashCard}
+ isObjectDetail={isObjectDetail}
+ isPreviewing={isPreviewing}
+ isRawTable={isRawTable}
+ isQueryBuilder={!!isQueryBuilder}
+ isSettings={!!isSettings}
+ isShowingDetailsOnlyColumns={isShowingDetailsOnlyColumns}
+ scrollToLastColumn={scrollToLastColumn}
+ metadata={metadata}
+ mode={mode}
+ queryBuilderMode={queryBuilderMode}
+ // Unjustified type cast. FIXME
+ rawSeries={rawSeries as RawSeries}
+ visualizerRawSeries={visualizerRawSeries}
+ renderEmptyMessage={renderEmptyMessage}
+ renderTableHeader={renderTableHeader}
+ scrollToColumn={scrollToColumn}
+ selectedTimelineEventIds={selectedTimelineEventIds}
+ series={series}
+ settings={settings}
+ autoAdjustSettings={!!autoAdjustSettings}
+ showAllLegendItems={showAllLegendItems}
+ hideLegend={hideLegend}
+ showTitle={!!showTitle}
+ tableHeaderHeight={tableHeaderHeight}
+ timelineEvents={timelineEvents}
+ totalNumGridCols={totalNumGridCols}
+ visualizationIsClickable={this.visualizationIsClickable}
+ width={width}
+ zoomedRowIndex={zoomedRowIndex}
+ onZoomRow={onZoomRow}
+ onActionDismissal={this.hideActions}
+ onChangeCardAndRun={
+ this.props.onChangeCardAndRun
+ ? this.handleOnChangeCardAndRun
+ : null
+ }
+ onBrush={this.props.onBrush}
+ onDeselectTimelineEvents={onDeselectTimelineEvents}
+ onHoverChange={this.handleHoverChange}
+ onOpenTimelines={onOpenTimelines}
+ onRender={this.onRender}
+ onRenderError={this.onRenderError}
+ onSelectTimelineEvents={onSelectTimelineEvents}
+ onSeeAllEvents={onSeeAllEvents}
+ onTogglePreviewing={onTogglePreviewing}
+ onUpdateVisualizationSettings={
+ onUpdateVisualizationSettings
+ }
+ onUpdateWarnings={onUpdateWarnings}
+ onVisualizationClick={this.handleVisualizationClick}
+ onHeaderColumnReorder={this.props.onHeaderColumnReorder}
+ titleMenuItems={hasHeader ? undefined : titleMenuItems}
+ tableFooterExtraButtons={tableFooterExtraButtons}
+ // These props are only used by the table on the Erroring Questions admin page
+ isSelectable={isSelectable}
+ rowChecked={rowChecked}
+ onAllSelectClick={onAllSelectClick}
+ onRowSelectClick={onRowSelectClick}
+ isSortable={isSortable}
+ sorting={sorting}
+ onSortingChange={onSortingChange}
+ />
+ </VisualizationRenderedWrapper>
+ </Suspense>
{hasDevWatermark && <Watermark card={series[0].card} />}
</div>
)
diff --git a/frontend/src/metabase/visualizations/components/Visualization/Visualization.unit.spec.tsx b/frontend/src/metabase/visualizations/components/Visualization/Visualization.unit.spec.tsx
index 4e93d234208..263a07ae93e 100644
--- a/frontend/src/metabase/visualizations/components/Visualization/Visualization.unit.spec.tsx
+++ b/frontend/src/metabase/visualizations/components/Visualization/Visualization.unit.spec.tsx
@@ -5,10 +5,16 @@ import { renderWithProviders, screen } from "__support__/ui";
import { delay } from "__support__/utils";
import { createMockState } from "metabase/redux/store/mocks";
import { color } from "metabase/ui/colors";
-import { registerVisualization } from "metabase/visualizations";
+import {
+ loadVisualizationComponents,
+ registerVisualization,
+} from "metabase/visualizations";
import VisualizationComponent from "metabase/visualizations/components/Visualization";
import { registerVisualizations } from "metabase/visualizations/register";
-import type { VisualizationProps } from "metabase/visualizations/types";
+import type {
+ Visualization,
+ VisualizationProps,
+} from "metabase/visualizations/types";
import type {
RawSeries,
Settings,
@@ -26,6 +32,10 @@ import {
registerVisualizations();
+// Chart components are loaded on demand. Register them up front so each test
+// renders in one pass and can be run on its own.
+beforeAll(() => loadVisualizationComponents(["bar", "scalar"]));
+
// Unjustified type cast. FIXME
const MOCK_DISPLAY = "mocked-visualization" as VisualizationDisplay;
@@ -50,6 +60,36 @@ const MockedVisualization = Object.assign(
registerVisualization(MockedVisualization);
+// A cast is needed because the registry is keyed by the known display types.
+const LAZY_MOCK_DISPLAY = "lazy-mocked-visualization" as VisualizationDisplay;
+
+const LAZY_MOCK_DEFINITION = {
+ getUiName: () => "Lazy Mocked Visualization",
+ identifier: LAZY_MOCK_DISPLAY,
+ iconName: "unknown" as const,
+ noHeader: true,
+ minSize: { width: 1, height: 1 },
+ defaultSize: { width: 4, height: 4 },
+ settings: {},
+ isSensible: () => false,
+ checkRenderable: () => undefined,
+};
+
+let resolveLazyMockedVisualization: () => void;
+
+// One promise for every call, the way the bundler de-duplicates `import()`.
+// It resolves to a component carrying its definition statics, the shape a
+// chart module exports.
+const lazyMockedVisualization = new Promise<Visualization>((resolve) => {
+ resolveLazyMockedVisualization = () =>
+ resolve(
+ Object.assign(
+ () => <div>Hello, I am loaded on demand</div>,
+ LAZY_MOCK_DEFINITION,
+ ),
+ );
+});
+
describe("Visualization", () => {
const renderViz = async (
series: RawSeries | undefined,
@@ -155,6 +195,37 @@ describe("Visualization", () => {
).toBeInTheDocument();
});
+ describe("with a component that loads on demand", () => {
+ it("should render the chart once its chunk resolves", async () => {
+ // Registered here rather than at module scope so the shared setup hook,
+ // which loads every registered chunk, does not wait on this one.
+ registerVisualization(
+ LAZY_MOCK_DEFINITION,
+ () => lazyMockedVisualization,
+ );
+
+ await renderViz([
+ {
+ card: createMockCard({ display: LAZY_MOCK_DISPLAY }),
+ data: createMockDatasetData({
+ cols: [createMockNumericColumn({ name: "Count" })],
+ rows: [[1]],
+ }),
+ },
+ ]);
+
+ expect(
+ screen.queryByText("Hello, I am loaded on demand"),
+ ).not.toBeInTheDocument();
+
+ resolveLazyMockedVisualization();
+
+ expect(
+ await screen.findByText("Hello, I am loaded on demand"),
+ ).toBeInTheDocument();
+ });
+ });
+
describe("scalar", () => {
it("should render", async () => {
await renderViz([
diff --git a/frontend/src/metabase/visualizations/components/skeletons/ChartSkeleton/ChartSkeleton.tsx b/frontend/src/metabase/visualizations/components/skeletons/ChartSkeleton/ChartSkeleton.tsx
index 74af80ce082..84002ec8ae4 100644
--- a/frontend/src/metabase/visualizations/components/skeletons/ChartSkeleton/ChartSkeleton.tsx
+++ b/frontend/src/metabase/visualizations/components/skeletons/ChartSkeleton/ChartSkeleton.tsx
@@ -27,7 +27,7 @@ export type ChartSkeletonProps = HTMLAttributes<HTMLDivElement> & {
// Returns just the chart-shaped skeleton image for a display type (no caption
// or surrounding chrome), suitable for embedding inside a chart's own render
-// area — e.g. as the Suspense fallback while the echarts chunk loads.
+// area.
export const getChartSkeletonImage: (
display?: VisualizationDisplay,
) => JSX.Element | null = (display?: VisualizationDisplay) => {
diff --git a/frontend/src/metabase/visualizations/index.ts b/frontend/src/metabase/visualizations/index.ts
index be555500610..8af60fe87f6 100644
--- a/frontend/src/metabase/visualizations/index.ts
+++ b/frontend/src/metabase/visualizations/index.ts
@@ -1,5 +1,6 @@
export {
type RegisteredVisualization,
+ type VisualizationComponentLoader,
canSavePng,
getDefaultSize,
getIconForVisualizationType,
@@ -7,9 +8,12 @@ export {
getMaxMetricsSupported,
getSettingWidgetComponent,
getVisualization,
+ getVisualizationComponent,
getVisualizationRaw,
getVisualizationTransformed,
isCartesianChart,
+ loadVisualizationComponents,
+ prefetchVisualizationComponent,
registerSettingWidgets,
registerVisualization,
setDefaultVisualization,
diff --git a/frontend/src/metabase/visualizations/lib/registry.ts b/frontend/src/metabase/visualizations/lib/registry.ts
index a912a5e8708..0d9613d0109 100644
--- a/frontend/src/metabase/visualizations/lib/registry.ts
+++ b/frontend/src/metabase/visualizations/lib/registry.ts
@@ -1,8 +1,10 @@
-import type { ComponentType } from "react";
+import { type ComponentType, lazy } from "react";
+import { isValidElementType } from "react-is";
import { t } from "ttag";
import _ from "underscore";
import { isStorybookActive } from "metabase/env";
+import { retry } from "metabase/utils/retry";
import type {
IconName,
RawSeries,
@@ -12,6 +14,7 @@ import type {
import type {
Visualization,
+ VisualizationComponent,
VisualizationDefinition,
} from "../types/visualization";
@@ -19,12 +22,22 @@ import type {
// bundles register full components carrying their definition statics.
export type RegisteredVisualization = Visualization | VisualizationDefinition;
+// A definition can be registered together with a loader for its component, so
+// the chart itself stays out of the initial bundle. The loaded module carries
+// its definition statics, the same as an eagerly registered visualization.
+export type VisualizationComponentLoader = () => Promise<Visualization>;
+
export const visualizations = new Map<
VisualizationDisplay,
RegisteredVisualization
>();
const aliases = new Map<string, RegisteredVisualization>();
const settingWidgets = new Map<string, ComponentType<any>>();
+const componentLoaders = new Map<
+ VisualizationDisplay,
+ VisualizationComponentLoader
+>();
+const lazyComponents = new Map<VisualizationDisplay, VisualizationComponent>();
visualizations.get = function (key) {
return (
Map.prototype.get.call(this, key) ||
@@ -40,13 +53,18 @@ export function setDefaultVisualization(
defaultVisualization = visualization;
}
+// A component is a function, a class, or one of the exotic objects that memo,
+// forwardRef and lazy return. A bare definition is a plain object.
function isVisualizationComponent(
visualization: RegisteredVisualization | undefined,
-) {
- return typeof visualization === "function";
+): visualization is Visualization {
+ return isValidElementType(visualization);
}
-export function registerVisualization(visualization: RegisteredVisualization) {
+export function registerVisualization(
+ visualization: RegisteredVisualization,
+ loadComponent?: VisualizationComponentLoader,
+) {
if (visualization == null) {
throw new Error(t`Visualization is null`);
}
@@ -57,6 +75,12 @@ export function registerVisualization(visualization: RegisteredVisualization) {
visualization.name,
);
}
+ // Record the loader before the checks below, which return early when this
+ // identifier is already registered. Both registries are one module in
+ // Storybook, where static-viz registers the bare definitions first.
+ if (loadComponent) {
+ componentLoaders.set(identifier, loadComponent);
+ }
if (visualizations.has(identifier)) {
const registeredVisualization = visualizations.get(identifier);
const isReplacingDefinitionWithComponent =
@@ -93,6 +117,111 @@ export function registerVisualization(visualization: RegisteredVisualization) {
}
}
+/**
+ * The component that renders a display type, wrapped in `lazy` when the
+ * definition was registered with a loader. Callers must render it inside a
+ * Suspense boundary.
+ */
+export function getVisualizationComponent(
+ display: VisualizationDisplay | null,
+): VisualizationComponent | undefined {
+ const visualization = getVisualization(display);
+
+ if (visualization == null) {
+ return undefined;
+ }
+
+ if (isVisualizationComponent(visualization)) {
+ return visualization;
+ }
+
+ const { identifier } = visualization;
+ const cachedComponent = lazyComponents.get(identifier);
+ if (cachedComponent) {
+ return cachedComponent;
+ }
+
+ const loadComponent = componentLoaders.get(identifier);
+ if (!loadComponent) {
+ return undefined;
+ }
+
+ const component = lazy(() =>
+ retry(loadComponent, {
+ maxRetries: 2,
+ shouldRetry: () => true,
+ delayMs: (attempt) => 300 * 2 ** attempt,
+ })
+ .then((Chart) => ({ default: Chart }))
+ .catch((error) => {
+ // React keeps a rejected lazy rejected for the life of the object, so
+ // reusing this one would fail every later render until a reload. Drop
+ // it and the next render builds one that downloads again.
+ lazyComponents.delete(identifier);
+ throw error;
+ }),
+ );
+ lazyComponents.set(identifier, component);
+ return component;
+}
+
+/**
+ * Start downloading a chart's chunk before it is rendered, typically while its
+ * data query is still in flight, so the chunk loads in parallel with the data.
+ * The bundler de-duplicates the request with the one `lazy` makes.
+ */
+export function prefetchVisualizationComponent(
+ display: VisualizationDisplay | null,
+) {
+ const visualization = getVisualization(display);
+
+ if (visualization != null && !isVisualizationComponent(visualization)) {
+ // A prefetch failure is not worth surfacing: the render path downloads the
+ // chunk again and reports the error there if it still fails.
+ componentLoaders
+ .get(visualization.identifier)?.()
+ .catch(() => undefined);
+ }
+}
+
+/**
+ * Load chart components and register them in place of their definitions, so
+ * charts render in one pass. Awaiting the loaders is not enough on its own:
+ * `lazy` suspends on its first render even when the module is already in
+ * memory, which a visual regression test captures as the fallback.
+ *
+ * Defaults to every registered chart. Tests should name the displays they
+ * render, so a spec does not pay to load the other twenty.
+ */
+export async function loadVisualizationComponents(
+ displays?: VisualizationDisplay[],
+): Promise<void> {
+ const wanted = displays
+ ? displays.map((display) => getVisualization(display)?.identifier)
+ : Array.from(componentLoaders.keys());
+
+ await Promise.all(
+ wanted.map(async (identifier) => {
+ if (
+ identifier == null ||
+ isVisualizationComponent(visualizations.get(identifier))
+ ) {
+ return;
+ }
+ const loadComponent = componentLoaders.get(identifier);
+ if (!loadComponent) {
+ return;
+ }
+ try {
+ registerVisualization(await loadComponent());
+ } catch {
+ // One chart that fails to load should not stop the rest. It stays
+ // lazy, and the render path reports the failure.
+ }
+ }),
+ );
+}
+
export function registerSettingWidgets(
widgets: Record<string, ComponentType<any>>,
) {
diff --git a/frontend/src/metabase/visualizations/lib/registry.unit.spec.tsx b/frontend/src/metabase/visualizations/lib/registry.unit.spec.tsx
new file mode 100644
index 00000000000..26948660145
--- /dev/null
+++ b/frontend/src/metabase/visualizations/lib/registry.unit.spec.tsx
@@ -0,0 +1,105 @@
+import { render, screen } from "@testing-library/react";
+import React, { Component, Suspense } from "react";
+
+import type { VisualizationDisplay } from "metabase-types/api";
+
+import {
+ getVisualizationComponent,
+ loadVisualizationComponents,
+ registerVisualization,
+} from "./registry";
+
+class ChunkErrorBoundary extends Component<
+ { children: React.ReactNode },
+ { message: string | null }
+> {
+ // The cast gives the initial null a nullable type rather than `null`.
+ state = { message: null as string | null };
+
+ static getDerivedStateFromError(error: Error) {
+ return { message: error.message };
+ }
+
+ render() {
+ return this.state.message ?? this.props.children;
+ }
+}
+
+const createDefinition = (identifier: VisualizationDisplay) => ({
+ getUiName: () => identifier,
+ identifier,
+ iconName: "unknown" as const,
+ settings: {},
+ checkRenderable: () => undefined,
+});
+
+describe("registerVisualization", () => {
+ it("keeps the component loader when the definition is already registered", () => {
+ // Storybook evaluates both registries into one module, and static-viz
+ // registers its bare definitions first. The app's registration is then a
+ // duplicate, but its loader is the only way to reach the component.
+ // A cast is needed because the registry is keyed by the known display types.
+ const display = "already-registered" as VisualizationDisplay;
+ const definition = createDefinition(display);
+ const Chart = Object.assign(() => <div />, definition);
+
+ registerVisualization(definition);
+ expect(() =>
+ registerVisualization(definition, () => Promise.resolve(Chart)),
+ ).toThrow(/already registered/);
+
+ expect(getVisualizationComponent(display)).toBeDefined();
+ });
+});
+
+describe("a chunk that fails to download", () => {
+ it("retries, and does not keep handing back the failed component", async () => {
+ // A cast is needed because the registry is keyed by the known display types.
+ const display = "download-fails" as VisualizationDisplay;
+ const definition = createDefinition(display);
+
+ let attempts = 0;
+ registerVisualization(definition, () => {
+ attempts += 1;
+ return Promise.reject(new Error("chunk load failed"));
+ });
+
+ const failing = getVisualizationComponent(display);
+ render(
+ <ChunkErrorBoundary>
+ <Suspense fallback={<div>loading</div>}>
+ {failing ? React.createElement(failing) : null}
+ </Suspense>
+ </ChunkErrorBoundary>,
+ );
+
+ // The retry backoff runs longer than the default findBy timeout.
+ expect(
+ await screen.findByText("chunk load failed", undefined, {
+ timeout: 5000,
+ }),
+ ).toBeInTheDocument();
+ // The initial attempt plus two retries.
+ expect(attempts).toBe(3);
+
+ // A new object, so the next render downloads again rather than reusing a
+ // lazy React has permanently marked as rejected.
+ const retried = getVisualizationComponent(display);
+ expect(retried).toBeDefined();
+ expect(retried).not.toBe(failing);
+ });
+});
+
+describe("loadVisualizationComponents", () => {
+ it("registers the component so the chart renders without suspending", async () => {
+ // A cast is needed because the registry is keyed by the known display types.
+ const display = "loaded-eagerly" as VisualizationDisplay;
+ const definition = createDefinition(display);
+ const Chart = Object.assign(() => <div />, definition);
+
+ registerVisualization(definition, () => Promise.resolve(Chart));
+ await loadVisualizationComponents();
+
+ expect(getVisualizationComponent(display)).toBe(Chart);
+ });
+});
diff --git a/frontend/src/metabase/visualizations/register.ts b/frontend/src/metabase/visualizations/register.ts
index a9018dc54ff..ec8684769f0 100644
--- a/frontend/src/metabase/visualizations/register.ts
+++ b/frontend/src/metabase/visualizations/register.ts
@@ -32,57 +32,144 @@ import { ChartSettingTableColumns } from "./components/settings/ChartSettingTabl
import { ChartSettingToggle } from "./components/settings/ChartSettingToggle";
import { ChartSettingsTableFormatting } from "./components/settings/ChartSettingsTableFormatting";
import { registerJsxFormatting } from "./lib/register-jsx-formatting";
-import { AreaChart } from "./visualizations/AreaChart";
-import { BarChart } from "./visualizations/BarChart";
-import { BoxPlot } from "./visualizations/BoxPlot";
-import { ComboChart } from "./visualizations/ComboChart";
-import { Funnel } from "./visualizations/Funnel";
-import { Gauge } from "./visualizations/Gauge";
-import { LineChart } from "./visualizations/LineChart";
-import { ListViz } from "./visualizations/List/components/ListViz";
-import { Map } from "./visualizations/Map";
-import { ObjectDetail } from "./visualizations/ObjectDetail";
-import { PieChart } from "./visualizations/PieChart";
+import { AREA_CHART_DEFINITION } from "./visualizations/AreaChart/definition";
+import { BAR_CHART_DEFINITION } from "./visualizations/BarChart/definition";
+import { BOXPLOT_CHART_DEFINITION } from "./visualizations/BoxPlot/definition";
+import { COMBO_CHART_DEFINITION } from "./visualizations/ComboChart/definition";
+import { FUNNEL_CHART_DEFINITION } from "./visualizations/Funnel/definition";
+import { GAUGE_CHART_DEFINITION } from "./visualizations/Gauge/definition";
+import { LINE_CHART_DEFINITION } from "./visualizations/LineChart/definition";
+import { LIST_DEFINITION } from "./visualizations/List/definition";
+import { MAP_VIZ_DEFINITION } from "./visualizations/Map/definition";
+import { OBJECT_DETAIL_DEFINITION } from "./visualizations/ObjectDetail/definition";
import { DimensionsWidget } from "./visualizations/PieChart/DimensionsWidget";
import { SliceNameWidget } from "./visualizations/PieChart/SliceNameWidget";
-import { PivotTable } from "./visualizations/PivotTable";
-import { Progress } from "./visualizations/Progress";
-import { RowChart } from "./visualizations/RowChart";
-import { SankeyChart } from "./visualizations/SankeyChart";
-import { Scalar } from "./visualizations/Scalar";
-import { ScatterPlot } from "./visualizations/ScatterPlot";
-import { SmartScalar } from "./visualizations/SmartScalar";
+import { PIE_CHART_DEFINITION } from "./visualizations/PieChart/definition";
+import { PIVOT_TABLE_DEFINITION } from "./visualizations/PivotTable/definition";
+import { PROGRESS_CHART_DEFINITION } from "./visualizations/Progress/definition";
+import { ROW_CHART_DEFINITION } from "./visualizations/RowChart/definition";
+import { SANKEY_CHART_DEFINITION } from "./visualizations/SankeyChart/definition";
+import { SCALAR_CHART_DEFINITION } from "./visualizations/Scalar/definition";
+import { SCATTER_PLOT_DEFINITION } from "./visualizations/ScatterPlot/definition";
import { SmartScalarComparisonWidget } from "./visualizations/SmartScalar/SettingsComponents/SmartScalarSettingsWidgets";
-import { Table } from "./visualizations/Table/Table";
-import { TreemapChart } from "./visualizations/TreemapChart";
+import { SMART_SCALAR_CHART_DEFINITION } from "./visualizations/SmartScalar/definition";
+import { TABLE_DEFINITION } from "./visualizations/Table/definition";
import { TreemapGroupsPicker } from "./visualizations/TreemapChart/TreemapGroupsPicker";
-import { WaterfallChart } from "./visualizations/WaterfallChart";
+import { TREEMAP_CHART_DEFINITION } from "./visualizations/TreemapChart/definition";
+import { WATERFALL_CHART_DEFINITION } from "./visualizations/WaterfallChart/definition";
+// Registration needs the definition only: the identifier, the icon, the
+// settings schema and the column checks. Each chart component is loaded on
+// demand so it stays out of the initial bundle.
function registerVisualizationComponents() {
- registerVisualization(Scalar);
- registerVisualization(SmartScalar);
- registerVisualization(Progress);
- registerVisualization(Gauge);
- registerVisualization(Table);
- registerVisualization(LineChart);
- registerVisualization(AreaChart);
- registerVisualization(BarChart);
- registerVisualization(WaterfallChart);
- registerVisualization(ComboChart);
- registerVisualization(RowChart);
- registerVisualization(ScatterPlot);
- registerVisualization(BoxPlot);
- registerVisualization(PieChart);
- registerVisualization(Map);
- registerVisualization(Funnel);
- registerVisualization(ObjectDetail);
- registerVisualization(PivotTable);
- registerVisualization(SankeyChart);
- registerVisualization(TreemapChart);
+ registerVisualization(SCALAR_CHART_DEFINITION, () =>
+ import(/* webpackChunkName: "viz-scalar" */ "./visualizations/Scalar").then(
+ (module) => module.Scalar,
+ ),
+ );
+ registerVisualization(SMART_SCALAR_CHART_DEFINITION, () =>
+ import(
+ /* webpackChunkName: "viz-smart-scalar" */ "./visualizations/SmartScalar"
+ ).then((module) => module.SmartScalar),
+ );
+ registerVisualization(PROGRESS_CHART_DEFINITION, () =>
+ import(
+ /* webpackChunkName: "viz-progress" */ "./visualizations/Progress"
+ ).then((module) => module.Progress),
+ );
+ registerVisualization(GAUGE_CHART_DEFINITION, () =>
+ import(/* webpackChunkName: "viz-gauge" */ "./visualizations/Gauge").then(
+ (module) => module.Gauge,
+ ),
+ );
+ registerVisualization(TABLE_DEFINITION, () =>
+ import(
+ /* webpackChunkName: "viz-table" */ "./visualizations/Table/Table"
+ ).then((module) => module.Table),
+ );
+ registerVisualization(LINE_CHART_DEFINITION, () =>
+ import(
+ /* webpackChunkName: "viz-line" */ "./visualizations/LineChart"
+ ).then((module) => module.LineChart),
+ );
+ registerVisualization(AREA_CHART_DEFINITION, () =>
+ import(
+ /* webpackChunkName: "viz-area" */ "./visualizations/AreaChart"
+ ).then((module) => module.AreaChart),
+ );
+ registerVisualization(BAR_CHART_DEFINITION, () =>
+ import(/* webpackChunkName: "viz-bar" */ "./visualizations/BarChart").then(
+ (module) => module.BarChart,
+ ),
+ );
+ registerVisualization(WATERFALL_CHART_DEFINITION, () =>
+ import(
+ /* webpackChunkName: "viz-waterfall" */ "./visualizations/WaterfallChart"
+ ).then((module) => module.WaterfallChart),
+ );
+ registerVisualization(COMBO_CHART_DEFINITION, () =>
+ import(
+ /* webpackChunkName: "viz-combo" */ "./visualizations/ComboChart"
+ ).then((module) => module.ComboChart),
+ );
+ registerVisualization(ROW_CHART_DEFINITION, () =>
+ import(/* webpackChunkName: "viz-row" */ "./visualizations/RowChart").then(
+ (module) => module.RowChart,
+ ),
+ );
+ registerVisualization(SCATTER_PLOT_DEFINITION, () =>
+ import(
+ /* webpackChunkName: "viz-scatter" */ "./visualizations/ScatterPlot"
+ ).then((module) => module.ScatterPlot),
+ );
+ registerVisualization(BOXPLOT_CHART_DEFINITION, () =>
+ import(
+ /* webpackChunkName: "viz-boxplot" */ "./visualizations/BoxPlot"
+ ).then((module) => module.BoxPlot),
+ );
+ registerVisualization(PIE_CHART_DEFINITION, () =>
+ import(/* webpackChunkName: "viz-pie" */ "./visualizations/PieChart").then(
+ (module) => module.PieChart,
+ ),
+ );
+ registerVisualization(MAP_VIZ_DEFINITION, () =>
+ import(/* webpackChunkName: "viz-map" */ "./visualizations/Map").then(
+ (module) => module.Map,
+ ),
+ );
+ registerVisualization(FUNNEL_CHART_DEFINITION, () =>
+ import(/* webpackChunkName: "viz-funnel" */ "./visualizations/Funnel").then(
+ (module) => module.Funnel,
+ ),
+ );
+ registerVisualization(OBJECT_DETAIL_DEFINITION, () =>
+ import(
+ /* webpackChunkName: "viz-object-detail" */ "./visualizations/ObjectDetail"
+ ).then((module) => module.ObjectDetail),
+ );
+ registerVisualization(PIVOT_TABLE_DEFINITION, () =>
+ import(
+ /* webpackChunkName: "viz-pivot-table" */ "./visualizations/PivotTable"
+ ).then((module) => module.PivotTable),
+ );
+ registerVisualization(SANKEY_CHART_DEFINITION, () =>
+ import(
+ /* webpackChunkName: "viz-sankey" */ "./visualizations/SankeyChart"
+ ).then((module) => module.SankeyChart),
+ );
+ registerVisualization(TREEMAP_CHART_DEFINITION, () =>
+ import(
+ /* webpackChunkName: "viz-treemap" */ "./visualizations/TreemapChart"
+ ).then((module) => module.TreemapChart),
+ );
- registerVisualization(ListViz);
+ registerVisualization(LIST_DEFINITION, () =>
+ import(
+ /* webpackChunkName: "viz-list" */ "./visualizations/List/components/ListViz"
+ ).then((module) => module.ListViz),
+ );
- setDefaultVisualization(Table);
+ setDefaultVisualization(TABLE_DEFINITION);
}
function registerVisualizationSettingWidgets() {
diff --git a/frontend/src/metabase/visualizations/types/visualization.ts b/frontend/src/metabase/visualizations/types/visualization.ts
index 2caf93f8b9b..32a23fd83b1 100644
--- a/frontend/src/metabase/visualizations/types/visualization.ts
+++ b/frontend/src/metabase/visualizations/types/visualization.ts
@@ -652,11 +652,12 @@ export type VisualizationGridSize = {
height: number;
};
-// TODO: add component property for the react component instead of the intersection
-export type Visualization = ComponentType<
+export type VisualizationComponent = ComponentType<
VisualizationProps & VisualizationPassThroughProps
-> &
- VisualizationDefinition;
+>;
+
+// TODO: add component property for the react component instead of the intersection
+export type Visualization = VisualizationComponent & VisualizationDefinition;
export type VisualizationDefinition = {
name?: string;
@@ -675,10 +676,6 @@ export type VisualizationDefinition = {
disableClickBehavior?: boolean;
canSavePng?: boolean;
noHeader?: boolean;
- // True for visualizations that render through the (lazily loaded)
- // EChartsRenderer. Used to prefetch the echarts chunk while the chart's data
- // is still loading. See prefetchEChartsRenderer.
- usesEChartsRenderer?: boolean;
hidden?: boolean;
disableSettingsConfig?: boolean;
supportPreviewing?: boolean;
diff --git a/frontend/src/metabase/visualizations/visualizations/BarChart/BarChart.unit.spec.tsx b/frontend/src/metabase/visualizations/visualizations/BarChart/BarChart.unit.spec.tsx
index b39c8f8b340..264ca09aaf4 100644
--- a/frontend/src/metabase/visualizations/visualizations/BarChart/BarChart.unit.spec.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/BarChart/BarChart.unit.spec.tsx
@@ -1,5 +1,6 @@
import { createMockMetadata } from "__support__/metadata";
import { renderWithProviders, screen } from "__support__/ui";
+import { loadVisualizationComponents } from "metabase/visualizations";
import { QuestionChartSettings } from "metabase/visualizations/components/ChartSettings";
import { registerVisualizations } from "metabase/visualizations/register";
import Question from "metabase-lib/v1/Question";
@@ -13,6 +14,10 @@ import {
registerVisualizations();
+// Chart components are loaded on demand. Register them up front so each test
+// renders in one pass and can be run on its own.
+beforeAll(() => loadVisualizationComponents(["bar"]));
+
const metadata = createMockMetadata({
databases: [createSampleDatabase()],
});
diff --git a/frontend/src/metabase/visualizations/visualizations/BoxPlot/BoxPlot.tsx b/frontend/src/metabase/visualizations/visualizations/BoxPlot/BoxPlot.tsx
index 8ecdd4e702e..220abe0a03d 100644
--- a/frontend/src/metabase/visualizations/visualizations/BoxPlot/BoxPlot.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/BoxPlot/BoxPlot.tsx
@@ -225,7 +225,6 @@ function BoxPlotInner({
<ResponsiveEChartsRenderer
key={hasValidOption ? "chart" : "measuring"}
ref={containerRef}
- display="boxplot"
option={option ?? {}}
eventHandlers={hasValidOption ? eventHandlers : undefined}
onInit={handleInit}
diff --git a/frontend/src/metabase/visualizations/visualizations/BoxPlot/definition.ts b/frontend/src/metabase/visualizations/visualizations/BoxPlot/definition.ts
index c98edcc660b..4b9497dc14a 100644
--- a/frontend/src/metabase/visualizations/visualizations/BoxPlot/definition.ts
+++ b/frontend/src/metabase/visualizations/visualizations/BoxPlot/definition.ts
@@ -23,7 +23,6 @@ export const BOXPLOT_CHART_DEFINITION: VisualizationDefinition = {
getUiName: () => t`Box Plot`,
identifier: "boxplot",
iconName: "boxplot",
- usesEChartsRenderer: true,
// eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
noun: t`box plot`,
minSize: getMinSize("boxplot"),
diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/CartesianChart.tsx b/frontend/src/metabase/visualizations/visualizations/CartesianChart/CartesianChart.tsx
index fecb0c53a38..990060dc895 100644
--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/CartesianChart.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/CartesianChart.tsx
@@ -118,9 +118,10 @@ function CartesianChartInner(props: VisualizationProps) {
const chartRef = useRef<EChartsType>();
// Mirror the ECharts instance into state so that effects depending on it
- // (e.g. brush setup) re-run once it becomes available. With the lazily loaded
- // EChartsRenderer, `onInit` fires after the surrounding effects have already
- // run, and a ref assignment alone would not re-trigger them.
+ // (e.g. brush setup) re-run once it becomes available. The renderer renders
+ // nothing until ExplicitSize has measured it, which it does a tick after
+ // mount, so `onInit` fires after the surrounding effects have already run and
+ // a ref assignment alone would not re-trigger them.
const [chartInstance, setChartInstance] = useState<EChartsType>();
const description = settings["card.description"];
@@ -282,7 +283,6 @@ function CartesianChartInner(props: VisualizationProps) {
>
<ResponsiveEChartsRenderer
ref={containerRef}
- display={card.display}
option={option}
eventHandlers={eventHandlers}
onResize={handleResize}
diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/definition.ts b/frontend/src/metabase/visualizations/visualizations/CartesianChart/definition.ts
index 1d8d7506d35..000cb1bc1bf 100644
--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/definition.ts
+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/definition.ts
@@ -50,7 +50,6 @@ type CartesianChartAdditions = Pick<
const cartesianChartAdditions: CartesianChartAdditions = {
noHeader: true,
- usesEChartsRenderer: true,
supportsVisualizer: true,
isSensible: ({ cols, rows }) => {
diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-brush.ts b/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-brush.ts
index 2a86633c0d5..529fbc00eb2 100644
--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-brush.ts
+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-brush.ts
@@ -69,9 +69,9 @@ export const useBrush = (
// chart model changes (ECharts resets the cursor state on re-render).
option?: unknown,
// ECharts instance — used as a signal dep so the brush is (re-)enabled once
- // the (lazily loaded) renderer has initialized the chart. `onInit` fires
- // after this hook's effects first run, so without this the brush would never
- // be enabled on desktop.
+ // the renderer has initialized the chart. It renders nothing until
+ // ExplicitSize has measured it, so `onInit` fires after this hook's effects
+ // first run, and without this the brush would never be enabled on desktop.
chartInstance?: unknown,
) => {
const isTouch = useRef(isTouchDevice()).current;
diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-chart-events.ts b/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-chart-events.ts
index 0b24fe3438b..da1e60254e8 100644
--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-chart-events.ts
+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-chart-events.ts
@@ -97,7 +97,8 @@ export const useChartEvents = (
}: VisualizationProps,
// The ECharts instance, mirrored into state by the caller. Used as a signal
// to re-run chart-instance-dependent effects (e.g. brush) once it is ready,
- // which matters because the lazily loaded renderer calls `onInit` late.
+ // which matters because the renderer calls `onInit` only after ExplicitSize
+ // has measured it.
chartInstance?: EChartsType,
) => {
const isBrushing = useRef<boolean>();
diff --git a/frontend/src/metabase/visualizations/visualizations/Funnel/Funnel.unit.spec.tsx b/frontend/src/metabase/visualizations/visualizations/Funnel/Funnel.unit.spec.tsx
index 71108cdaf9c..dfca00b7bf2 100644
--- a/frontend/src/metabase/visualizations/visualizations/Funnel/Funnel.unit.spec.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/Funnel/Funnel.unit.spec.tsx
@@ -1,5 +1,6 @@
import { renderWithProviders, screen } from "__support__/ui";
import { ThemeProvider } from "metabase/ui";
+import { loadVisualizationComponents } from "metabase/visualizations";
import { registerVisualizations } from "metabase/visualizations/register";
import type { VisualizationProps } from "metabase/visualizations/types";
import type { VisualizationSettings } from "metabase-types/api";
@@ -17,6 +18,10 @@ import { Funnel } from "./Funnel";
registerVisualizations();
+// Chart components are loaded on demand. Register them up front so each test
+// renders in one pass and can be run on its own.
+beforeAll(() => loadVisualizationComponents(["funnel"]));
+
const cardTitle = "cardTitle";
type SetupFunnelProps = Pick<VisualizationProps, "showTitle">;
diff --git a/frontend/src/metabase/visualizations/visualizations/List/components/ListViz/ListViz.tsx b/frontend/src/metabase/visualizations/visualizations/List/components/ListViz/ListViz.tsx
index 563f299e2b6..27881f48faa 100644
--- a/frontend/src/metabase/visualizations/visualizations/List/components/ListViz/ListViz.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/List/components/ListViz/ListViz.tsx
@@ -1,256 +1,20 @@
import cx from "classnames";
import { useMemo } from "react";
-import { t } from "ttag";
import { Box } from "metabase/ui";
-import { color } from "metabase/ui/utils/colors";
-import { displayNameForColumn } from "metabase/value-formatting";
-import { columnSettings } from "metabase/visualizations/lib/settings/column";
-import {
- getDefaultSize,
- getMinSize,
-} from "metabase/visualizations/shared/utils/sizes";
import type {
- ColumnSettingDefinition,
- FormattableColumn,
- VisualizationDefinition,
VisualizationPassThroughProps,
VisualizationProps,
} from "metabase/visualizations/types";
import * as Lib from "metabase-lib";
import Question from "metabase-lib/v1/Question";
-import {
- isAvatarURL,
- isCoordinate,
- isEmail,
- isImageURL,
- isNumber,
- isString,
- isURL,
-} from "metabase-lib/v1/types/utils/isa";
-import type { ColumnSettings, DatasetColumn, Series } from "metabase-types/api";
+import type { DatasetColumn } from "metabase-types/api";
+import { LIST_DEFINITION } from "../../definition";
import { ListView } from "../ListView/ListView";
import S from "./ListViz.module.css";
-const vizDefinition: VisualizationDefinition = {
- identifier: "list",
- iconName: "list",
- getUiName: () => t`List`,
- hidden: true,
-
- minSize: getMinSize("list"),
- defaultSize: getDefaultSize("list"),
- checkRenderable: () => {},
- isSensible: () => true,
-
- settings: {
- ...columnSettings({ getHidden: () => true }),
- "list.entity_icon": {
- getDefault: () => null,
- },
- "list.entity_icon_color": {
- getDefault: () => color("text-primary"),
- },
- "list.entity_icon_enabled": {
- getDefault: () => true,
- },
- "list.use_image_column": {
- getDefault: () => false,
- },
- "list.columns": {
- getDefault: ([
- {
- data: { cols },
- },
- ]: Series) => {
- const defaultTitleColumn =
- cols.find((col) => Lib.isEntityName(Lib.legacyColumnTypeInfo(col))) ||
- cols.find((col) => Lib.isTitle(Lib.legacyColumnTypeInfo(col))) ||
- cols.find((col) => Lib.isID(Lib.legacyColumnTypeInfo(col))) ||
- cols[0];
- const defaultSubtitleColumn =
- defaultTitleColumn &&
- Lib.isID(Lib.legacyColumnTypeInfo(defaultTitleColumn))
- ? null
- : cols.find((col) => Lib.isID(Lib.legacyColumnTypeInfo(col)));
-
- const imageColumn = cols.find(
- (col) =>
- Lib.isAvatarURL(Lib.legacyColumnTypeInfo(col)) ||
- Lib.isImageURL(Lib.legacyColumnTypeInfo(col)),
- );
-
- const usedColumns = new Set(
- [defaultTitleColumn, defaultSubtitleColumn, imageColumn].filter(
- Boolean,
- ),
- );
-
- const defaultRightColumns = cols
- .filter((col) => !usedColumns.has(col))
- .slice(0, 4)
- .map((col) => col?.name);
-
- return {
- left: [defaultTitleColumn, defaultSubtitleColumn]
- .filter(Boolean)
- .map((col) => col?.name),
- right: defaultRightColumns,
- image: imageColumn?.name,
- };
- },
- },
- },
-
- // TODO Unify with the same code in Table viz
- columnSettings: (column: FormattableColumn) => {
- const settings: Record<
- string,
- ColumnSettingDefinition<unknown, unknown>
- > = {
- column_title: {
- title: t`Column title`,
- widget: "input",
- getDefault: (column) => displayNameForColumn(column),
- },
- click_behavior: {},
- text_align: {
- title: t`Align`,
- widget: "select",
- getDefault: (column) => {
- const baseColumn = column?.remapped_to_column ?? column;
- return isNumber(baseColumn) || isCoordinate(baseColumn)
- ? "right"
- : "left";
- },
- props: {
- options: [
- { name: t`Left`, value: "left" },
- { name: t`Right`, value: "right" },
- { name: t`Middle`, value: "middle" },
- ],
- },
- },
- };
-
- if (isNumber(column)) {
- settings["show_mini_bar"] = {
- title: t`Show a mini bar chart`,
- widget: "toggle",
- inline: true,
- };
- }
-
- if (isString(column)) {
- const canWrapText = (columnSettings: ColumnSettings) =>
- columnSettings["view_as"] !== "image";
-
- settings["text_wrapping"] = {
- title: t`Wrap text`,
- getDefault: () => false,
- widget: "toggle",
- inline: true,
- isValid: (_column, columnSettings) => {
- return canWrapText(columnSettings);
- },
- getHidden: (_column, columnSettings) => {
- return !canWrapText(columnSettings);
- },
- };
- }
-
- let defaultValue = !column.semantic_type || isURL(column) ? "link" : null;
-
- const options = [
- { name: t`Text`, value: null },
- { name: t`Link`, value: "link" },
- ];
-
- if (!column.semantic_type || isEmail(column)) {
- defaultValue = "email_link";
- options.push({ name: t`Email link`, value: "email_link" });
- }
- if (!column.semantic_type || isImageURL(column) || isAvatarURL(column)) {
- defaultValue = isAvatarURL(column) ? "image" : "link";
- options.push({ name: t`Image`, value: "image" });
- }
- if (!column.semantic_type) {
- defaultValue = "auto";
- options.push({ name: t`Automatic`, value: "auto" });
- }
-
- if (options.length > 1) {
- settings["view_as"] = {
- title: t`Display as`,
- widget: options.length === 2 ? "radio" : "select",
- getDefault: () => defaultValue,
- props: {
- options,
- },
- };
- }
-
- const linkFieldsHint = t`You can use the value of any column here like this: {{COLUMN}}`;
-
- settings["link_text"] = {
- title: t`Link text`,
- widget: "linkUrlInput",
- hint: linkFieldsHint,
- getDefault: () => null,
- getHidden: (_, settings) =>
- settings["view_as"] !== "link" && settings["view_as"] !== "email_link",
- readDependencies: ["view_as"],
- getProps: (
- column,
- settings,
- onChange,
- {
- series: [
- {
- data: { cols },
- },
- ],
- },
- ) => {
- return {
- options: cols.map((column) => column.name),
- placeholder: t`Link to {{bird_id}}`,
- };
- },
- };
-
- settings["link_url"] = {
- title: t`Link URL`,
- widget: "linkUrlInput",
- hint: linkFieldsHint,
- getDefault: () => null,
- getHidden: (_, settings) => settings["view_as"] !== "link",
- readDependencies: ["view_as"],
- getProps: (
- column,
- settings,
- onChange,
- {
- series: [
- {
- data: { cols },
- },
- ],
- },
- ) => {
- return {
- options: cols.map((column) => column.name),
- placeholder: t`http://toucan.example/{{bird_id}}`,
- };
- },
- };
-
- return settings;
- },
-};
-
const ListVizComponent = ({
card,
metadata,
@@ -331,4 +95,4 @@ const ListVizComponent = ({
);
};
-export const ListViz = Object.assign(ListVizComponent, vizDefinition);
+export const ListViz = Object.assign(ListVizComponent, LIST_DEFINITION);
diff --git a/frontend/src/metabase/visualizations/visualizations/List/definition.ts b/frontend/src/metabase/visualizations/visualizations/List/definition.ts
new file mode 100644
index 00000000000..3aea0b60186
--- /dev/null
+++ b/frontend/src/metabase/visualizations/visualizations/List/definition.ts
@@ -0,0 +1,242 @@
+import { t } from "ttag";
+
+import { color } from "metabase/ui/utils/colors";
+import { displayNameForColumn } from "metabase/value-formatting";
+import { columnSettings } from "metabase/visualizations/lib/settings/column";
+import {
+ getDefaultSize,
+ getMinSize,
+} from "metabase/visualizations/shared/utils/sizes";
+import type {
+ ColumnSettingDefinition,
+ FormattableColumn,
+ VisualizationDefinition,
+} from "metabase/visualizations/types";
+import * as Lib from "metabase-lib";
+import {
+ isAvatarURL,
+ isCoordinate,
+ isEmail,
+ isImageURL,
+ isNumber,
+ isString,
+ isURL,
+} from "metabase-lib/v1/types/utils/isa";
+import type { ColumnSettings, Series } from "metabase-types/api";
+
+export const LIST_DEFINITION: VisualizationDefinition = {
+ identifier: "list",
+ iconName: "list",
+ getUiName: () => t`List`,
+ hidden: true,
+
+ minSize: getMinSize("list"),
+ defaultSize: getDefaultSize("list"),
+ checkRenderable: () => {},
+ isSensible: () => true,
+
+ settings: {
+ ...columnSettings({ getHidden: () => true }),
+ "list.entity_icon": {
+ getDefault: () => null,
+ },
+ "list.entity_icon_color": {
+ getDefault: () => color("text-primary"),
+ },
+ "list.entity_icon_enabled": {
+ getDefault: () => true,
+ },
+ "list.use_image_column": {
+ getDefault: () => false,
+ },
+ "list.columns": {
+ getDefault: ([
+ {
+ data: { cols },
+ },
+ ]: Series) => {
+ const defaultTitleColumn =
+ cols.find((col) => Lib.isEntityName(Lib.legacyColumnTypeInfo(col))) ||
+ cols.find((col) => Lib.isTitle(Lib.legacyColumnTypeInfo(col))) ||
+ cols.find((col) => Lib.isID(Lib.legacyColumnTypeInfo(col))) ||
+ cols[0];
+ const defaultSubtitleColumn =
+ defaultTitleColumn &&
+ Lib.isID(Lib.legacyColumnTypeInfo(defaultTitleColumn))
+ ? null
+ : cols.find((col) => Lib.isID(Lib.legacyColumnTypeInfo(col)));
+
+ const imageColumn = cols.find(
+ (col) =>
+ Lib.isAvatarURL(Lib.legacyColumnTypeInfo(col)) ||
+ Lib.isImageURL(Lib.legacyColumnTypeInfo(col)),
+ );
+
+ const usedColumns = new Set(
+ [defaultTitleColumn, defaultSubtitleColumn, imageColumn].filter(
+ Boolean,
+ ),
+ );
+
+ const defaultRightColumns = cols
+ .filter((col) => !usedColumns.has(col))
+ .slice(0, 4)
+ .map((col) => col?.name);
+
+ return {
+ left: [defaultTitleColumn, defaultSubtitleColumn]
+ .filter(Boolean)
+ .map((col) => col?.name),
+ right: defaultRightColumns,
+ image: imageColumn?.name,
+ };
+ },
+ },
+ },
+
+ // TODO Unify with the same code in Table viz
+ columnSettings: (column: FormattableColumn) => {
+ const settings: Record<
+ string,
+ ColumnSettingDefinition<unknown, unknown>
+ > = {
+ column_title: {
+ title: t`Column title`,
+ widget: "input",
+ getDefault: (column) => displayNameForColumn(column),
+ },
+ click_behavior: {},
+ text_align: {
+ title: t`Align`,
+ widget: "select",
+ getDefault: (column) => {
+ const baseColumn = column?.remapped_to_column ?? column;
+ return isNumber(baseColumn) || isCoordinate(baseColumn)
+ ? "right"
+ : "left";
+ },
+ props: {
+ options: [
+ { name: t`Left`, value: "left" },
+ { name: t`Right`, value: "right" },
+ { name: t`Middle`, value: "middle" },
+ ],
+ },
+ },
+ };
+
+ if (isNumber(column)) {
+ settings["show_mini_bar"] = {
+ title: t`Show a mini bar chart`,
+ widget: "toggle",
+ inline: true,
+ };
+ }
+
+ if (isString(column)) {
+ const canWrapText = (columnSettings: ColumnSettings) =>
+ columnSettings["view_as"] !== "image";
+
+ settings["text_wrapping"] = {
+ title: t`Wrap text`,
+ getDefault: () => false,
+ widget: "toggle",
+ inline: true,
+ isValid: (_column, columnSettings) => {
+ return canWrapText(columnSettings);
+ },
+ getHidden: (_column, columnSettings) => {
+ return !canWrapText(columnSettings);
+ },
+ };
+ }
+
+ let defaultValue = !column.semantic_type || isURL(column) ? "link" : null;
+
+ const options = [
+ { name: t`Text`, value: null },
+ { name: t`Link`, value: "link" },
+ ];
+
+ if (!column.semantic_type || isEmail(column)) {
+ defaultValue = "email_link";
+ options.push({ name: t`Email link`, value: "email_link" });
+ }
+ if (!column.semantic_type || isImageURL(column) || isAvatarURL(column)) {
+ defaultValue = isAvatarURL(column) ? "image" : "link";
+ options.push({ name: t`Image`, value: "image" });
+ }
+ if (!column.semantic_type) {
+ defaultValue = "auto";
+ options.push({ name: t`Automatic`, value: "auto" });
+ }
+
+ if (options.length > 1) {
+ settings["view_as"] = {
+ title: t`Display as`,
+ widget: options.length === 2 ? "radio" : "select",
+ getDefault: () => defaultValue,
+ props: {
+ options,
+ },
+ };
+ }
+
+ const linkFieldsHint = t`You can use the value of any column here like this: {{COLUMN}}`;
+
+ settings["link_text"] = {
+ title: t`Link text`,
+ widget: "linkUrlInput",
+ hint: linkFieldsHint,
+ getDefault: () => null,
+ getHidden: (_, settings) =>
+ settings["view_as"] !== "link" && settings["view_as"] !== "email_link",
+ readDependencies: ["view_as"],
+ getProps: (
+ column,
+ settings,
+ onChange,
+ {
+ series: [
+ {
+ data: { cols },
+ },
+ ],
+ },
+ ) => {
+ return {
+ options: cols.map((column) => column.name),
+ placeholder: t`Link to {{bird_id}}`,
+ };
+ },
+ };
+
+ settings["link_url"] = {
+ title: t`Link URL`,
+ widget: "linkUrlInput",
+ hint: linkFieldsHint,
+ getDefault: () => null,
+ getHidden: (_, settings) => settings["view_as"] !== "link",
+ readDependencies: ["view_as"],
+ getProps: (
+ column,
+ settings,
+ onChange,
+ {
+ series: [
+ {
+ data: { cols },
+ },
+ ],
+ },
+ ) => {
+ return {
+ options: cols.map((column) => column.name),
+ placeholder: t`http://toucan.example/{{bird_id}}`,
+ };
+ },
+ };
+
+ return settings;
+ },
+};
diff --git a/frontend/src/metabase/visualizations/visualizations/Map/Map.tsx b/frontend/src/metabase/visualizations/visualizations/Map/Map.tsx
index 0cf2c23939e..8f064aae029 100644
--- a/frontend/src/metabase/visualizations/visualizations/Map/Map.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/Map/Map.tsx
@@ -1,69 +1,10 @@
-import { Suspense, lazy, memo } from "react";
-import { t } from "ttag";
-import _ from "underscore";
+import { memo } from "react";
-import { Flex } from "metabase/ui";
-import { getAccentColors, getPreferredColor } from "metabase/ui/colors/groups";
-import MetabaseSettings from "metabase/utils/settings";
-import MapSkeleton from "metabase/visualizations/components/skeletons/MapSkeleton/MapSkeleton";
-import {
- getDefaultMapDimension,
- getDefaultMapMetric,
-} from "metabase/visualizations/lib/choropleth";
-import { ChartSettingsError } from "metabase/visualizations/lib/errors";
-import { columnSettings } from "metabase/visualizations/lib/settings/column";
-import {
- dimensionSetting,
- fieldSetting,
- metricSetting,
-} from "metabase/visualizations/lib/settings/utils";
import { isSameSeries } from "metabase/visualizations/lib/utils";
-import {
- getDefaultSize,
- getMinSize,
-} from "metabase/visualizations/shared/utils/sizes";
-import type {
- VisualizationDefinition,
- VisualizationProps,
-} from "metabase/visualizations/types";
-import {
- hasLatitudeAndLongitudeColumns,
- isCountry,
- isLatitude,
- isLongitude,
- isMetric,
- isNumeric,
- isState,
-} from "metabase-lib/v1/types/utils/isa";
-import type { CustomGeoJSONMap } from "metabase-types/api";
+import type { VisualizationProps } from "metabase/visualizations/types";
-import { CustomMapFooter } from "./CustomMapFooter";
-import { getColorplethColorScale } from "./map-color-scale";
-import { isMapSensible, isPinMapType } from "./utils";
-
-const MAP_DISPLAY_ALIASES = ["state", "country", "pin_map"] as const;
-
-// Leaflet (and the map renderer that uses it) is loaded lazily so it stays out
-// of the initial bundle for the majority of users who never open a map.
-const MapRenderer = lazy(() =>
- import(/* webpackChunkName: "map-renderer" */ "./MapRenderer").then(
- (module) => ({ default: module.MapRenderer }),
- ),
-);
-
-function MapComponent(props: VisualizationProps) {
- return (
- <Suspense
- fallback={
- <Flex h="100%" w="100%" direction="column">
- <MapSkeleton />
- </Flex>
- }
- >
- <MapRenderer {...props} />
- </Suspense>
- );
-}
+import { MapRenderer } from "./MapRenderer";
+import { MAP_VIZ_DEFINITION } from "./definition";
function arePropsEqual(prev: VisualizationProps, next: VisualizationProps) {
const sameSize = prev.width === next.width && prev.height === next.height;
@@ -74,277 +15,7 @@ function arePropsEqual(prev: VisualizationProps, next: VisualizationProps) {
return sameSize && sameSeries && sameIsEditing && sameHighlighted;
}
-const MAP_VIZ_DEFINITION: VisualizationDefinition = {
- getUiName: () => t`Map`,
- identifier: "map",
- iconName: "pinmap",
- aliases: [...MAP_DISPLAY_ALIASES],
- minSize: getMinSize("map"),
- defaultSize: getDefaultSize("map"),
- isSensible: isMapSensible,
- hasEmptyState: true,
- settings: {
- ...columnSettings({ getHidden: () => true }),
- "map.type": {
- get title() {
- return t`Map type`;
- },
- widget: "select",
- getProps: () => ({
- options: [
- {
- get name() {
- return t`Region map`;
- },
- value: "region",
- },
- {
- get name() {
- return t`Pin map`;
- },
- value: "pin",
- },
- { name: "Grid map", value: "grid" },
- ],
- }),
- getDefault: ([{ card, data }], settings) => {
- const display: string = card.display;
- switch (display) {
- case "state":
- case "country":
- return "region";
- case "pin_map":
- return "pin";
- default:
- if (hasLatitudeAndLongitudeColumns(data.cols)) {
- const latitudeColumn = _.findWhere(data.cols, {
- name: settings["map.latitude_column"],
- });
- const longitudeColumn = _.findWhere(data.cols, {
- name: settings["map.longitude_column"],
- });
-
- if (
- latitudeColumn &&
- longitudeColumn &&
- latitudeColumn.binning_info &&
- longitudeColumn.binning_info
- ) {
- return "grid";
- } else {
- return "pin";
- }
- } else {
- return "region";
- }
- }
- },
- readDependencies: [
- "map.latitude_column",
- "map.longitude_column",
- "map.metric_column",
- ],
- },
- "map.pin_type": {
- get title() {
- return t`Pin type`;
- },
- widget: "select",
- getProps: () => ({
- options: [
- {
- get name() {
- return t`Tiles`;
- },
- value: "tiles",
- },
- {
- get name() {
- return t`Markers`;
- },
- value: "markers",
- },
- { name: "Grid", value: "grid" },
- ],
- }),
- getDefault: ([{ data }], vizSettings) =>
- vizSettings["map.type"] === "heat"
- ? "heat"
- : vizSettings["map.type"] === "grid"
- ? "grid"
- : data.rows.length >= 1000
- ? "tiles"
- : "markers",
- getHidden: (_series, vizSettings) =>
- !isPinMapType(vizSettings["map.type"]),
- },
- ...fieldSetting("map.latitude_column", {
- get title() {
- return t`Latitude field`;
- },
- fieldFilter: isNumeric,
- getDefault: ([{ data }]) => (_.find(data.cols, isLatitude) || {}).name,
- getHidden: (_series, vizSettings) =>
- !isPinMapType(vizSettings["map.type"]),
- }),
- ...fieldSetting("map.longitude_column", {
- get title() {
- return t`Longitude field`;
- },
- fieldFilter: isNumeric,
- getDefault: ([{ data }]) => (_.find(data.cols, isLongitude) || {}).name,
- getHidden: (_series, vizSettings) =>
- !isPinMapType(vizSettings["map.type"]),
- }),
- ...fieldSetting("map.metric_column", {
- get title() {
- return t`Metric field`;
- },
- fieldFilter: isMetric,
- getHidden: (_series, vizSettings) =>
- !isPinMapType(vizSettings["map.type"]) ||
- (vizSettings["map.pin_type"] !== "heat" &&
- vizSettings["map.pin_type"] !== "grid"),
- }),
- "map.region": {
- get title() {
- return t`Region map`;
- },
- widget: "select",
- getDefault: ([{ card, data }]) => {
- const display: string = card.display;
- if (display === "state" || _.any(data.cols, isState)) {
- return "us_states";
- } else if (display === "country" || _.any(data.cols, isCountry)) {
- return "world_countries";
- }
- return null;
- },
- getProps: () => ({
- options: _.chain(MetabaseSettings.get("custom-geojson") ?? {})
- .pairs()
- .map(([key, value]: [string, CustomGeoJSONMap]) => ({
- name: value.name || "",
- value: key,
- }))
- .sortBy((x) => x.name.toLowerCase())
- .value(),
- placeholder: t`Select a region`,
- footer: <CustomMapFooter />,
- hiddenIcons: true,
- }),
- getHidden: (_series, vizSettings) => vizSettings["map.type"] !== "region",
- },
- ...metricSetting("map.metric", {
- get title() {
- return t`Metric field`;
- },
- getDefault: ([
- {
- data: { cols },
- },
- ]) => getDefaultMapMetric(cols),
- getHidden: (_series, vizSettings) => vizSettings["map.type"] !== "region",
- }),
- ...dimensionSetting("map.dimension", {
- get title() {
- return t`Region field`;
- },
- getDefault: ([
- {
- data: { cols },
- },
- ]) => getDefaultMapDimension(cols),
- getHidden: (_series, vizSettings) => vizSettings["map.type"] !== "region",
- }),
- "map.colors": {
- get title() {
- return t`Color`;
- },
- widget: "colorRangeSelector",
- getProps: () => ({
- colors: getAccentColors(),
- colorMapping: Object.fromEntries(
- getAccentColors().map((color) => [
- color,
- getColorplethColorScale(color),
- ]),
- ),
- isQuantile: true,
- }),
- getDefault: (_series, vizSettings) =>
- getColorplethColorScale(
- getPreferredColor(vizSettings["map.metric"]) ?? getAccentColors()[0],
- ),
- getHidden: (_series, vizSettings) => vizSettings["map.type"] !== "region",
- readDependencies: ["map.metric"],
- },
- "map.zoom": {},
- "map.center_latitude": {},
- "map.center_longitude": {},
- "map.heat.radius": {
- get title() {
- return t`Radius`;
- },
- widget: "number",
- getDefault: () => 30,
- getHidden: (_series, vizSettings) => vizSettings["map.type"] !== "heat",
- },
- "map.heat.blur": {
- get title() {
- return t`Blur`;
- },
- widget: "number",
- getDefault: () => 60,
- getHidden: (_series, vizSettings) => vizSettings["map.type"] !== "heat",
- },
- "map.heat.min-opacity": {
- get title() {
- return t`Min Opacity`;
- },
- widget: "number",
- getDefault: () => 0,
- getHidden: (_series, vizSettings) => vizSettings["map.type"] !== "heat",
- },
- "map.heat.max-zoom": {
- get title() {
- return t`Max Zoom`;
- },
- widget: "number",
- getDefault: () => 1,
- getHidden: (_series, vizSettings) => vizSettings["map.type"] !== "heat",
- },
- },
- checkRenderable: (_series, settings) => {
- const type = settings["map.type"];
-
- if (isPinMapType(type)) {
- if (
- !settings["map.longitude_column"] ||
- !settings["map.latitude_column"]
- ) {
- throw new ChartSettingsError(
- t`Please select longitude and latitude columns in the chart settings.`,
- { section: t`Data` },
- );
- }
- } else if (type === "region") {
- if (!settings["map.region"]) {
- throw new ChartSettingsError(t`Please select a region map.`, {
- section: t`Data`,
- });
- }
- if (!settings["map.dimension"] || !settings["map.metric"]) {
- throw new ChartSettingsError(
- t`Please select region and metric columns in the chart settings.`,
- { section: t`Data` },
- );
- }
- }
- },
-};
-
export const Map = Object.assign(
- memo(MapComponent, arePropsEqual),
+ memo(MapRenderer, arePropsEqual),
MAP_VIZ_DEFINITION,
);
diff --git a/frontend/src/metabase/visualizations/visualizations/Map/MapRenderer.tsx b/frontend/src/metabase/visualizations/visualizations/Map/MapRenderer.tsx
index 5813150d964..31c1cfbebea 100644
--- a/frontend/src/metabase/visualizations/visualizations/Map/MapRenderer.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/Map/MapRenderer.tsx
@@ -6,8 +6,8 @@ import { PinMap } from "../../components/PinMap";
import { isPinMapType } from "./utils";
// Renders the actual leaflet-backed map. This module (and everything it pulls
-// in, including leaflet) is loaded lazily by Map.tsx so it stays out of the
-// initial bundle.
+// in, including leaflet) is only reachable from the map's own chunk, so it
+// stays out of the initial bundle.
export function MapRenderer(props: VisualizationProps) {
const type = props.settings["map.type"];
diff --git a/frontend/src/metabase/visualizations/visualizations/Map/definition.tsx b/frontend/src/metabase/visualizations/visualizations/Map/definition.tsx
new file mode 100644
index 00000000000..925b436ea77
--- /dev/null
+++ b/frontend/src/metabase/visualizations/visualizations/Map/definition.tsx
@@ -0,0 +1,307 @@
+import { t } from "ttag";
+import _ from "underscore";
+
+import { getAccentColors, getPreferredColor } from "metabase/ui/colors/groups";
+import MetabaseSettings from "metabase/utils/settings";
+import {
+ getDefaultMapDimension,
+ getDefaultMapMetric,
+} from "metabase/visualizations/lib/choropleth";
+import { ChartSettingsError } from "metabase/visualizations/lib/errors";
+import { columnSettings } from "metabase/visualizations/lib/settings/column";
+import {
+ dimensionSetting,
+ fieldSetting,
+ metricSetting,
+} from "metabase/visualizations/lib/settings/utils";
+import {
+ getDefaultSize,
+ getMinSize,
+} from "metabase/visualizations/shared/utils/sizes";
+import type { VisualizationDefinition } from "metabase/visualizations/types";
+import {
+ hasLatitudeAndLongitudeColumns,
+ isCountry,
+ isLatitude,
+ isLongitude,
+ isMetric,
+ isNumeric,
+ isState,
+} from "metabase-lib/v1/types/utils/isa";
+import type { CustomGeoJSONMap } from "metabase-types/api";
+
+import { CustomMapFooter } from "./CustomMapFooter";
+import { getColorplethColorScale } from "./map-color-scale";
+import { isMapSensible, isPinMapType } from "./utils";
+
+const MAP_DISPLAY_ALIASES = ["state", "country", "pin_map"] as const;
+
+export const MAP_VIZ_DEFINITION: VisualizationDefinition = {
+ getUiName: () => t`Map`,
+ identifier: "map",
+ iconName: "pinmap",
+ aliases: [...MAP_DISPLAY_ALIASES],
+ minSize: getMinSize("map"),
+ defaultSize: getDefaultSize("map"),
+ isSensible: isMapSensible,
+ hasEmptyState: true,
+ settings: {
+ ...columnSettings({ getHidden: () => true }),
+ "map.type": {
+ get title() {
+ return t`Map type`;
+ },
+ widget: "select",
+ getProps: () => ({
+ options: [
+ {
+ get name() {
+ return t`Region map`;
+ },
+ value: "region",
+ },
+ {
+ get name() {
+ return t`Pin map`;
+ },
+ value: "pin",
+ },
+ { name: "Grid map", value: "grid" },
+ ],
+ }),
+ getDefault: ([{ card, data }], settings) => {
+ const display: string = card.display;
+ switch (display) {
+ case "state":
+ case "country":
+ return "region";
+ case "pin_map":
+ return "pin";
+ default:
+ if (hasLatitudeAndLongitudeColumns(data.cols)) {
+ const latitudeColumn = _.findWhere(data.cols, {
+ name: settings["map.latitude_column"],
+ });
+ const longitudeColumn = _.findWhere(data.cols, {
+ name: settings["map.longitude_column"],
+ });
+
+ if (
+ latitudeColumn &&
+ longitudeColumn &&
+ latitudeColumn.binning_info &&
+ longitudeColumn.binning_info
+ ) {
+ return "grid";
+ } else {
+ return "pin";
+ }
+ } else {
+ return "region";
+ }
+ }
+ },
+ readDependencies: [
+ "map.latitude_column",
+ "map.longitude_column",
+ "map.metric_column",
+ ],
+ },
+ "map.pin_type": {
+ get title() {
+ return t`Pin type`;
+ },
+ widget: "select",
+ getProps: () => ({
+ options: [
+ {
+ get name() {
+ return t`Tiles`;
+ },
+ value: "tiles",
+ },
+ {
+ get name() {
+ return t`Markers`;
+ },
+ value: "markers",
+ },
+ { name: "Grid", value: "grid" },
+ ],
+ }),
+ getDefault: ([{ data }], vizSettings) =>
+ vizSettings["map.type"] === "heat"
+ ? "heat"
+ : vizSettings["map.type"] === "grid"
+ ? "grid"
+ : data.rows.length >= 1000
+ ? "tiles"
+ : "markers",
+ getHidden: (_series, vizSettings) =>
+ !isPinMapType(vizSettings["map.type"]),
+ },
+ ...fieldSetting("map.latitude_column", {
+ get title() {
+ return t`Latitude field`;
+ },
+ fieldFilter: isNumeric,
+ getDefault: ([{ data }]) => (_.find(data.cols, isLatitude) || {}).name,
+ getHidden: (_series, vizSettings) =>
+ !isPinMapType(vizSettings["map.type"]),
+ }),
+ ...fieldSetting("map.longitude_column", {
+ get title() {
+ return t`Longitude field`;
+ },
+ fieldFilter: isNumeric,
+ getDefault: ([{ data }]) => (_.find(data.cols, isLongitude) || {}).name,
+ getHidden: (_series, vizSettings) =>
+ !isPinMapType(vizSettings["map.type"]),
+ }),
+ ...fieldSetting("map.metric_column", {
+ get title() {
+ return t`Metric field`;
+ },
+ fieldFilter: isMetric,
+ getHidden: (_series, vizSettings) =>
+ !isPinMapType(vizSettings["map.type"]) ||
+ (vizSettings["map.pin_type"] !== "heat" &&
+ vizSettings["map.pin_type"] !== "grid"),
+ }),
+ "map.region": {
+ get title() {
+ return t`Region map`;
+ },
+ widget: "select",
+ getDefault: ([{ card, data }]) => {
+ const display: string = card.display;
+ if (display === "state" || _.any(data.cols, isState)) {
+ return "us_states";
+ } else if (display === "country" || _.any(data.cols, isCountry)) {
+ return "world_countries";
+ }
+ return null;
+ },
+ getProps: () => ({
+ options: _.chain(MetabaseSettings.get("custom-geojson") ?? {})
+ .pairs()
+ .map(([key, value]: [string, CustomGeoJSONMap]) => ({
+ name: value.name || "",
+ value: key,
+ }))
+ .sortBy((x) => x.name.toLowerCase())
+ .value(),
+ placeholder: t`Select a region`,
+ footer: <CustomMapFooter />,
+ hiddenIcons: true,
+ }),
+ getHidden: (_series, vizSettings) => vizSettings["map.type"] !== "region",
+ },
+ ...metricSetting("map.metric", {
+ get title() {
+ return t`Metric field`;
+ },
+ getDefault: ([
+ {
+ data: { cols },
+ },
+ ]) => getDefaultMapMetric(cols),
+ getHidden: (_series, vizSettings) => vizSettings["map.type"] !== "region",
+ }),
+ ...dimensionSetting("map.dimension", {
+ get title() {
+ return t`Region field`;
+ },
+ getDefault: ([
+ {
+ data: { cols },
+ },
+ ]) => getDefaultMapDimension(cols),
+ getHidden: (_series, vizSettings) => vizSettings["map.type"] !== "region",
+ }),
+ "map.colors": {
+ get title() {
+ return t`Color`;
+ },
+ widget: "colorRangeSelector",
+ getProps: () => ({
+ colors: getAccentColors(),
+ colorMapping: Object.fromEntries(
+ getAccentColors().map((color) => [
+ color,
+ getColorplethColorScale(color),
+ ]),
+ ),
+ isQuantile: true,
+ }),
+ getDefault: (_series, vizSettings) =>
+ getColorplethColorScale(
+ getPreferredColor(vizSettings["map.metric"]) ?? getAccentColors()[0],
+ ),
+ getHidden: (_series, vizSettings) => vizSettings["map.type"] !== "region",
+ readDependencies: ["map.metric"],
+ },
+ "map.zoom": {},
+ "map.center_latitude": {},
+ "map.center_longitude": {},
+ "map.heat.radius": {
+ get title() {
+ return t`Radius`;
+ },
+ widget: "number",
+ getDefault: () => 30,
+ getHidden: (_series, vizSettings) => vizSettings["map.type"] !== "heat",
+ },
+ "map.heat.blur": {
+ get title() {
+ return t`Blur`;
+ },
+ widget: "number",
+ getDefault: () => 60,
+ getHidden: (_series, vizSettings) => vizSettings["map.type"] !== "heat",
+ },
+ "map.heat.min-opacity": {
+ get title() {
+ return t`Min Opacity`;
+ },
+ widget: "number",
+ getDefault: () => 0,
+ getHidden: (_series, vizSettings) => vizSettings["map.type"] !== "heat",
+ },
+ "map.heat.max-zoom": {
+ get title() {
+ return t`Max Zoom`;
+ },
+ widget: "number",
+ getDefault: () => 1,
+ getHidden: (_series, vizSettings) => vizSettings["map.type"] !== "heat",
+ },
+ },
+ checkRenderable: (_series, settings) => {
+ const type = settings["map.type"];
+
+ if (isPinMapType(type)) {
+ if (
+ !settings["map.longitude_column"] ||
+ !settings["map.latitude_column"]
+ ) {
+ throw new ChartSettingsError(
+ t`Please select longitude and latitude columns in the chart settings.`,
+ { section: t`Data` },
+ );
+ }
+ } else if (type === "region") {
+ if (!settings["map.region"]) {
+ throw new ChartSettingsError(t`Please select a region map.`, {
+ section: t`Data`,
+ });
+ }
+ if (!settings["map.dimension"] || !settings["map.metric"]) {
+ throw new ChartSettingsError(
+ t`Please select region and metric columns in the chart settings.`,
+ { section: t`Data` },
+ );
+ }
+ }
+ },
+};
diff --git a/frontend/src/metabase/visualizations/visualizations/ObjectDetail/ObjectDetail.ts b/frontend/src/metabase/visualizations/visualizations/ObjectDetail/ObjectDetail.ts
new file mode 100644
index 00000000000..7e632209166
--- /dev/null
+++ b/frontend/src/metabase/visualizations/visualizations/ObjectDetail/ObjectDetail.ts
@@ -0,0 +1,10 @@
+import { ObjectDetail } from "metabase/visualizations/components/ObjectDetail";
+
+import { OBJECT_DETAIL_DEFINITION } from "./definition";
+
+const ObjectDetailWithProperties = Object.assign(
+ ObjectDetail,
+ OBJECT_DETAIL_DEFINITION,
+);
+
+export { ObjectDetailWithProperties as ObjectDetail };
diff --git a/frontend/src/metabase/visualizations/visualizations/ObjectDetail.tsx b/frontend/src/metabase/visualizations/visualizations/ObjectDetail/definition.ts
similarity index 77%
rename from frontend/src/metabase/visualizations/visualizations/ObjectDetail.tsx
rename to frontend/src/metabase/visualizations/visualizations/ObjectDetail/definition.ts
index 713168c43e6..13ad2f4d9f1 100644
--- a/frontend/src/metabase/visualizations/visualizations/ObjectDetail.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/ObjectDetail/definition.ts
@@ -1,7 +1,6 @@
import { t } from "ttag";
import { displayNameForColumn } from "metabase/value-formatting";
-import { ObjectDetail } from "metabase/visualizations/components/ObjectDetail";
import {
columnSettings,
tableColumnSettings,
@@ -10,10 +9,9 @@ import {
getDefaultSize,
getMinSize,
} from "metabase/visualizations/shared/utils/sizes";
+import type { VisualizationDefinition } from "metabase/visualizations/types";
-import type { VisualizationDefinition } from "../types";
-
-const ObjectDetailProperties: VisualizationDefinition = {
+export const OBJECT_DETAIL_DEFINITION: VisualizationDefinition = {
getUiName() {
return t`Detail`;
},
@@ -50,10 +48,3 @@ const ObjectDetailProperties: VisualizationDefinition = {
isSensible: () => true,
checkRenderable: () => true,
};
-
-const ObjectDetailWithProperties = Object.assign(
- ObjectDetail,
- ObjectDetailProperties,
-);
-
-export { ObjectDetailWithProperties as ObjectDetail };
diff --git a/frontend/src/metabase/visualizations/visualizations/ObjectDetail/index.ts b/frontend/src/metabase/visualizations/visualizations/ObjectDetail/index.ts
new file mode 100644
index 00000000000..d1232b6492c
--- /dev/null
+++ b/frontend/src/metabase/visualizations/visualizations/ObjectDetail/index.ts
@@ -0,0 +1 @@
+export { ObjectDetail } from "./ObjectDetail";
diff --git a/frontend/src/metabase/visualizations/visualizations/PieChart/PieChart.tsx b/frontend/src/metabase/visualizations/visualizations/PieChart/PieChart.tsx
index 31f35739fe4..c21c3bab6f9 100644
--- a/frontend/src/metabase/visualizations/visualizations/PieChart/PieChart.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/PieChart/PieChart.tsx
@@ -191,7 +191,6 @@ function PieChartComponent(props: VisualizationProps) {
>
<ResponsiveEChartsRenderer
ref={containerRef}
- display="pie"
option={option}
onInit={handleInit}
onResize={handleResize}
diff --git a/frontend/src/metabase/visualizations/visualizations/PieChart/definition.ts b/frontend/src/metabase/visualizations/visualizations/PieChart/definition.ts
index 4e538df271b..2bb0a8dbf5b 100644
--- a/frontend/src/metabase/visualizations/visualizations/PieChart/definition.ts
+++ b/frontend/src/metabase/visualizations/visualizations/PieChart/definition.ts
@@ -47,7 +47,6 @@ export const PIE_CHART_DEFINITION: VisualizationDefinition = {
getUiName: () => t`Pie`,
identifier: "pie",
iconName: "pie",
- usesEChartsRenderer: true,
minSize: getMinSize("pie"),
defaultSize: getDefaultSize("pie"),
supportsVisualizer: true,
diff --git a/frontend/src/metabase/visualizations/visualizations/PivotTable/PivotTable.tsx b/frontend/src/metabase/visualizations/visualizations/PivotTable/PivotTable.tsx
index 1563d6e658a..2f549922899 100644
--- a/frontend/src/metabase/visualizations/visualizations/PivotTable/PivotTable.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/PivotTable/PivotTable.tsx
@@ -1,60 +1,15 @@
-import { Suspense, lazy } from "react";
-import { t } from "ttag";
-
import { connect } from "metabase/redux";
import type { State } from "metabase/redux/store";
import { getSetting } from "metabase/settings";
-import TableSkeleton from "metabase/visualizations/components/skeletons/TableSkeleton";
-import {
- getDefaultSize,
- getMinSize,
-} from "metabase/visualizations/shared/utils/sizes";
-import type {
- VisualizationDefinition,
- VisualizationProps,
-} from "metabase/visualizations/types";
-import { _columnSettings as columnSettings, settings } from "./settings";
-import { checkRenderable, isSensible } from "./utils";
+import { PivotTableView } from "./PivotTableInner";
+import { PIVOT_TABLE_DEFINITION } from "./definition";
const mapStateToProps = (state: State) => ({
fontFamily: getSetting(state, "application-font"),
});
-// react-virtualized (and the grid renderer that uses it) is loaded lazily so it
-// stays out of the initial bundle for the majority of users who never open a
-// pivot table.
-const PivotTableView = lazy(() =>
- import(/* webpackChunkName: "pivot-table-view" */ "./PivotTableInner").then(
- (module) => ({ default: module.PivotTableView }),
- ),
-);
-
-function PivotTableComponent(
- props: VisualizationProps & { className?: string },
-) {
- return (
- <Suspense fallback={<TableSkeleton />}>
- <PivotTableView {...props} />
- </Suspense>
- );
-}
-
-const PivotViz: VisualizationDefinition = {
- getUiName: () => t`Pivot Table`,
- identifier: "pivot",
- iconName: "pivot_table",
- minSize: getMinSize("pivot"),
- defaultSize: getDefaultSize("pivot"),
- canSavePng: false,
- isSensible,
- checkRenderable,
- settings,
- columnSettings,
- isLiveResizable: () => false,
-};
-
export const PivotTable = Object.assign(
- connect(mapStateToProps)(PivotTableComponent),
- PivotViz,
+ connect(mapStateToProps)(PivotTableView),
+ PIVOT_TABLE_DEFINITION,
);
diff --git a/frontend/src/metabase/visualizations/visualizations/PivotTable/PivotTable.unit.spec.tsx b/frontend/src/metabase/visualizations/visualizations/PivotTable/PivotTable.unit.spec.tsx
index 37ae8368ac4..aa67fe81481 100644
--- a/frontend/src/metabase/visualizations/visualizations/PivotTable/PivotTable.unit.spec.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/PivotTable/PivotTable.unit.spec.tsx
@@ -7,6 +7,7 @@ import { useState } from "react";
import { createMockMetadata } from "__support__/metadata";
import { renderWithProviders } from "__support__/ui";
import * as domUtils from "metabase/utils/dom";
+import { loadVisualizationComponents } from "metabase/visualizations";
import { QuestionChartSettings } from "metabase/visualizations/components/ChartSettings";
import { registerVisualizations } from "metabase/visualizations/register";
import Question from "metabase-lib/v1/Question";
@@ -34,6 +35,10 @@ import {
registerVisualizations();
+// Chart components are loaded on demand. Register them up front so each test
+// renders in one pass and can be run on its own.
+beforeAll(() => loadVisualizationComponents(["pivot"]));
+
const metadata = createMockMetadata({
databases: [createSampleDatabase()],
});
diff --git a/frontend/src/metabase/visualizations/visualizations/PivotTable/definition.ts b/frontend/src/metabase/visualizations/visualizations/PivotTable/definition.ts
new file mode 100644
index 00000000000..df159cd2178
--- /dev/null
+++ b/frontend/src/metabase/visualizations/visualizations/PivotTable/definition.ts
@@ -0,0 +1,24 @@
+import { t } from "ttag";
+
+import {
+ getDefaultSize,
+ getMinSize,
+} from "metabase/visualizations/shared/utils/sizes";
+import type { VisualizationDefinition } from "metabase/visualizations/types";
+
+import { _columnSettings as columnSettings, settings } from "./settings";
+import { checkRenderable, isSensible } from "./utils";
+
+export const PIVOT_TABLE_DEFINITION: VisualizationDefinition = {
+ getUiName: () => t`Pivot Table`,
+ identifier: "pivot",
+ iconName: "pivot_table",
+ minSize: getMinSize("pivot"),
+ defaultSize: getDefaultSize("pivot"),
+ canSavePng: false,
+ isSensible,
+ checkRenderable,
+ settings,
+ columnSettings,
+ isLiveResizable: () => false,
+};
diff --git a/frontend/src/metabase/visualizations/visualizations/SankeyChart/SankeyChart.tsx b/frontend/src/metabase/visualizations/visualizations/SankeyChart/SankeyChart.tsx
index 1b465774a94..4a488e1cfa6 100644
--- a/frontend/src/metabase/visualizations/visualizations/SankeyChart/SankeyChart.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/SankeyChart/SankeyChart.tsx
@@ -75,7 +75,6 @@ const SankeyChartComponent = ({
<>
<ResponsiveEChartsRenderer
ref={containerRef}
- display="sankey"
option={option}
eventHandlers={eventHandlers}
onInit={handleInit}
diff --git a/frontend/src/metabase/visualizations/visualizations/SankeyChart/definition.ts b/frontend/src/metabase/visualizations/visualizations/SankeyChart/definition.ts
index f373c64be92..443f58cc07d 100644
--- a/frontend/src/metabase/visualizations/visualizations/SankeyChart/definition.ts
+++ b/frontend/src/metabase/visualizations/visualizations/SankeyChart/definition.ts
@@ -124,7 +124,6 @@ export const SANKEY_CHART_DEFINITION: VisualizationDefinition = {
getUiName: () => t`Sankey`,
identifier: "sankey",
iconName: "sankey",
- usesEChartsRenderer: true,
// eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
noun: t`sankey chart`,
minSize: getMinSize("sankey"),
diff --git a/frontend/src/metabase/visualizations/visualizations/SmartScalar/tests/SmartScalar.unit.spec.tsx b/frontend/src/metabase/visualizations/visualizations/SmartScalar/tests/SmartScalar.unit.spec.tsx
index 929eb00501e..ea3561944b3 100644
--- a/frontend/src/metabase/visualizations/visualizations/SmartScalar/tests/SmartScalar.unit.spec.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/SmartScalar/tests/SmartScalar.unit.spec.tsx
@@ -2,6 +2,7 @@ import userEvent from "@testing-library/user-event";
import { getIcon, renderWithProviders, screen, within } from "__support__/ui";
import { NumberColumn } from "__support__/visualizations";
+import { loadVisualizationComponents } from "metabase/visualizations";
import Visualization from "metabase/visualizations/components/Visualization";
import { getSettingsWidgetsForSeries } from "metabase/visualizations/lib/widgets";
import { registerVisualizations } from "metabase/visualizations/register";
@@ -17,6 +18,10 @@ import {
registerVisualizations();
+// Chart components are loaded on demand. Register them up front so each test
+// renders in one pass and can be run on its own.
+beforeAll(() => loadVisualizationComponents(["smartscalar"]));
+
const createMockInsights = (insights: Partial<Insight>[]) => insights;
const setup = (series: Series, width = 800) =>
diff --git a/frontend/src/metabase/visualizations/visualizations/Table/Table.unit.spec.tsx b/frontend/src/metabase/visualizations/visualizations/Table/Table.unit.spec.tsx
index 402afffd3ac..d51ec52ae48 100644
--- a/frontend/src/metabase/visualizations/visualizations/Table/Table.unit.spec.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/Table/Table.unit.spec.tsx
@@ -10,6 +10,7 @@ import {
screen,
within,
} from "__support__/ui";
+import { loadVisualizationComponents } from "metabase/visualizations";
import { QuestionChartSettings } from "metabase/visualizations/components/ChartSettings";
import Visualization from "metabase/visualizations/components/Visualization";
import { registerVisualizations } from "metabase/visualizations/register";
@@ -42,6 +43,10 @@ import {
registerVisualizations();
+// Chart components are loaded on demand. Register them up front so each test
+// renders in one pass and can be run on its own.
+beforeAll(() => loadVisualizationComponents(["table"]));
+
const metadata = createMockMetadata({
databases: [createSampleDatabase()],
});
diff --git a/rspack.embedding-sdk-bundle.config.js b/rspack.embedding-sdk-bundle.config.js
index 954abd6e513..e29bf7ce58d 100644
--- a/rspack.embedding-sdk-bundle.config.js
+++ b/rspack.embedding-sdk-bundle.config.js
@@ -63,6 +63,12 @@ const shouldAnalyzeBundles = process.env.SHOULD_ANALYZE_BUNDLES === "true";
// Name prefix for all chunked-entry output files (runtime, split chunks, entry)
const CHUNKED_PREFIX = "embedding-sdk-chunk";
+// The chunked entry's own chunks: the entry, its runtime and the pieces
+// splitChunks carves out of them. Excludes the legacy monolithic entry, the
+// bootstrap, and every on-demand chunk.
+const isChunkedEntryChunk = (chunk) =>
+ (chunk.name || "").startsWith(CHUNKED_PREFIX);
+
const config = {
...mainConfig,
@@ -212,28 +218,57 @@ const config = {
// but leave the legacy monolithic entry as a single file.
splitChunks: {
chunks: (chunk) => {
- // Only split chunks that belong to the chunked entry
- // (the entry itself + its runtime). Never split the legacy
- // monolithic "embedding-sdk" or the bootstrap.
- const name = chunk.name || "";
- return name.startsWith(CHUNKED_PREFIX);
+ // Split chunks that belong to the chunked entry (the entry itself +
+ // its runtime), plus the on-demand (async) chunks, so modules shared
+ // by several async chunks are deduplicated instead of copied into
+ // each one. Never split the legacy monolithic "embedding-sdk" or the
+ // bootstrap.
+ return isChunkedEntryChunk(chunk) || !chunk.canBeInitial();
},
// Keep chunk count low (~10-12) so HTTP/1.1 clients (no reverse proxy)
// can load them in 1-2 waves (6 connections per domain).
// maxSize is the primary lever — larger maxSize = fewer chunks.
maxInitialRequests: 10,
+ // Same ceiling for an on-demand load. Not binding today (a chart needs
+ // its own chunk plus a shared one); it caps how far the split can go if
+ // more lazy entry points are added, at the cost of duplicating again.
+ maxAsyncRequests: 10,
maxSize: 5_000_000,
minSize: 100_000,
+ // The groups below are told apart by their `chunks` filter, not by size
+ // or test, so the priorities are what keep a module out of the wrong one.
cacheGroups: {
vendors: {
test: /[\\/]node_modules[\\/]/,
+ // Only the chunked entry's own (initial) chunks: giving async
+ // modules the "vendor" name would merge them into the eagerly
+ // loaded vendor chunks and grow the initial payload.
+ chunks: isChunkedEntryChunk,
// Use a fixed name prefix so rspack merges vendors into a few chunks
// (governed by maxSize) rather than one-per-package.
name: "vendor",
+ priority: 10,
+ reuseExistingChunk: true,
+ },
+ // Modules shared by two or more async chunks (e.g. echarts, pulled in
+ // by every lazily loaded chart) move into a shared async chunk that
+ // loads alongside whichever chart chunk needs it first.
+ asyncCommons: {
+ chunks: "async",
+ minChunks: 2,
+ // Deliberately below the 100 kb the other groups inherit. echarts
+ // clears that bar on its own, but the viz code the chart chunks
+ // share does not, and would stay duplicated across all of them.
+ minSize: 20_000,
+ // No fixed name: rspack derives one per set of sharing chunks, so a
+ // table or scalar chart does not end up loading echarts.
+ priority: 5,
reuseExistingChunk: true,
},
default: {
minChunks: 1,
+ chunks: isChunkedEntryChunk,
+ priority: 0,
reuseExistingChunk: true,
},
},