The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Lazy load `echarts` module (#75220)
Romeo Van Snick3d5661eb5484
diff --git a/.storybook/preview.tsx b/.storybook/preview.tsxindex dbd3ea2a1c9..8f6ae466cf9 100644--- a/.storybook/preview.tsx+++ b/.storybook/preview.tsx@@ -14,6 +14,13 @@ require("metabase/css/core/index.css");require("metabase/css/index.module.css");require("metabase/utils/dayjs");+// EChartsRenderer is loaded as an on-demand chunk in the app (see+// EChartsRenderer/lazy.ts). Force it into the Storybook bundle so chart stories+// render echarts synchronously and visual snapshots are deterministic (no+// lazy-chunk skeleton flash). The dynamic `import()` then resolves from the+// already-loaded module.+require("metabase/visualizations/components/EChartsRenderer/EChartsRenderer");+import "@mantine/core/styles.css";import "@mantine/dates/styles.css";diff --git a/frontend/src/embedding-sdk-bundle/lib/sdk-specific-imports.ts b/frontend/src/embedding-sdk-bundle/lib/sdk-specific-imports.tsindex 0da0dde9c9e..d32c909dfe9 100644--- a/frontend/src/embedding-sdk-bundle/lib/sdk-specific-imports.ts+++ b/frontend/src/embedding-sdk-bundle/lib/sdk-specific-imports.ts@@ -30,3 +30,13 @@ import "metabase/visualizations/visualizations/Map/MapRenderer";// main app. The SDK bundle can't fetch on-demand chunks at runtime, so force the// pivot table module to be included eagerly here.import "metabase/visualizations/visualizations/PivotTable/PivotTableInner";++/**+ * EChartsRenderer (and all of echarts) is loaded as an on-demand chunk in the+ * main app (see EChartsRenderer/lazy.ts) to keep echarts out of the initial+ * bundle. The SDK loads its code eagerly via a build-time manifest and can't+ * fetch on-demand chunks in a host app (they'd fail with a ChunkLoadError), so+ * we force EChartsRenderer into the bundle here. The dynamic `import()` then+ * resolves from the already-loaded module instead of fetching a chunk.+ */+import "metabase/visualizations/components/EChartsRenderer/EChartsRenderer";diff --git a/frontend/src/metabase/visualizations/components/EChartsRenderer/ResponsiveEChartsRenderer.tsx b/frontend/src/metabase/visualizations/components/EChartsRenderer/ResponsiveEChartsRenderer.tsxindex 51a3a457773..93a0ee8db34 100644--- a/frontend/src/metabase/visualizations/components/EChartsRenderer/ResponsiveEChartsRenderer.tsx+++ b/frontend/src/metabase/visualizations/components/EChartsRenderer/ResponsiveEChartsRenderer.tsx@@ -1,13 +1,19 @@-import { forwardRef, useLayoutEffect } from "react";+import { Suspense, 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 } 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<@@ -19,6 +25,7 @@ const ResponsiveEChartsRendererInner = forwardRef<width,height,children,+ display,...echartsRenderedProps}: ResponsiveEChartsRendererProps,ref,@@ -35,12 +42,26 @@ const ResponsiveEChartsRendererInner = forwardRef<return (<ResponsiveEChartsRendererStyled>- <EChartsRenderer- ref={ref}- {...echartsRenderedProps}- width={width}- height={height}- />+ <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>{children}</ResponsiveEChartsRendererStyled>);diff --git a/frontend/src/metabase/visualizations/components/EChartsRenderer/index.ts b/frontend/src/metabase/visualizations/components/EChartsRenderer/index.tsindex ce92e7de996..bae6eb54004 100644--- a/frontend/src/metabase/visualizations/components/EChartsRenderer/index.ts+++ b/frontend/src/metabase/visualizations/components/EChartsRenderer/index.ts@@ -1,3 +1,8 @@-export * from "./EChartsRenderer";+// 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.tsnew file mode 100644index 00000000000..7e9e6d456e8--- /dev/null+++ b/frontend/src/metabase/visualizations/components/EChartsRenderer/lazy.ts@@ -0,0 +1,31 @@+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/Visualization/Visualization.tsx b/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsxindex 14b84416fb5..e6eae9f2d9d 100644--- a/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx+++ b/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx@@ -40,6 +40,7 @@ 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,@@ -353,10 +354,24 @@ class Visualization extends PureComponent<) {this.updateWarnings();}+ if (prevState.visualization !== this.state.visualization) {+ this.maybePrefetchEChartsRenderer();+ }}componentDidMount() {this.updateWarnings();+ this.maybePrefetchEChartsRenderer();+ }++ // 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();+ }}componentDidCatch(error: Error, info: ErrorInfo) {diff --git a/frontend/src/metabase/visualizations/components/skeletons/ChartSkeleton/ChartSkeleton.tsx b/frontend/src/metabase/visualizations/components/skeletons/ChartSkeleton/ChartSkeleton.tsxindex b6d10b7f304..74af80ce082 100644--- a/frontend/src/metabase/visualizations/components/skeletons/ChartSkeleton/ChartSkeleton.tsx+++ b/frontend/src/metabase/visualizations/components/skeletons/ChartSkeleton/ChartSkeleton.tsx@@ -16,7 +16,7 @@ import SkeletonCaption from "metabase/visualizations/components/skeletons/Skeletimport TableSkeleton from "metabase/visualizations/components/skeletons/TableSkeleton";import { VisualizationSkeleton } from "metabase/visualizations/components/skeletons/VisualizationSkeleton/VisualizationSkeleton";import WaterfallSkeleton from "metabase/visualizations/components/skeletons/WaterfallSkeleton";-import type { CardDisplayType } from "metabase-types/api";+import type { CardDisplayType, VisualizationDisplay } from "metabase-types/api";export type ChartSkeletonProps = HTMLAttributes<HTMLDivElement> & {display?: CardDisplayType;@@ -25,9 +25,12 @@ export type ChartSkeletonProps = HTMLAttributes<HTMLDivElement> & {actionMenu?: JSX.Element | null;};-const skeletonComponent: (display?: CardDisplayType) => JSX.Element | null = (- display?: CardDisplayType,-) => {+// 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.+export const getChartSkeletonImage: (+ display?: VisualizationDisplay,+) => JSX.Element | null = (display?: VisualizationDisplay) => {if (!display) {return null;}@@ -92,7 +95,7 @@ const ChartSkeleton = ({description={description}actionMenu={actionMenu}>- {skeletonComponent(display)}+ {getChartSkeletonImage(display)}</VisualizationSkeleton>);};diff --git a/frontend/src/metabase/visualizations/types/visualization.ts b/frontend/src/metabase/visualizations/types/visualization.tsindex 8f2e30e30d2..c6600102cee 100644--- a/frontend/src/metabase/visualizations/types/visualization.ts+++ b/frontend/src/metabase/visualizations/types/visualization.ts@@ -640,6 +640,10 @@ 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/BoxPlot/BoxPlot.tsx b/frontend/src/metabase/visualizations/visualizations/BoxPlot/BoxPlot.tsxindex 9669648002c..5e3b55f5ed9 100644--- a/frontend/src/metabase/visualizations/visualizations/BoxPlot/BoxPlot.tsx+++ b/frontend/src/metabase/visualizations/visualizations/BoxPlot/BoxPlot.tsx@@ -227,6 +227,7 @@ function BoxPlotInner({<ResponsiveEChartsRendererkey={hasValidOption ? "chart" : "measuring"}ref={containerRef}+ display="boxplot"option={option ?? {}}eventHandlers={hasValidOption ? eventHandlers : undefined}onInit={handleInit}diff --git a/frontend/src/metabase/visualizations/visualizations/BoxPlot/chart-definition.ts b/frontend/src/metabase/visualizations/visualizations/BoxPlot/chart-definition.tsindex d13a0ae19d7..ebd5281f341 100644--- a/frontend/src/metabase/visualizations/visualizations/BoxPlot/chart-definition.ts+++ b/frontend/src/metabase/visualizations/visualizations/BoxPlot/chart-definition.ts@@ -23,6 +23,7 @@ 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#55045noun: 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.tsxindex bc1be34bc07..4af06e3e796 100644--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/CartesianChart.tsx+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/CartesianChart.tsx@@ -84,6 +84,11 @@ function CartesianChartInner(props: VisualizationProps) {useChartDebug({ isQueryBuilder, rawSeries, option, chartModel });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.+ const [chartInstance, setChartInstance] = useState<EChartsType>();const description = settings["card.description"];@@ -95,6 +100,7 @@ function CartesianChartInner(props: VisualizationProps) {const handleInit = useCallback((chart: EChartsType) => {chartRef.current = chart;+ setChartInstance(chart);// HACK: clip paths cause glitches in Safari on multiseries line charts on dashboards (metabase#51383)if (isWebkit()) {@@ -129,6 +135,7 @@ function CartesianChartInner(props: VisualizationProps) {option,renderingContext,props,+ chartInstance,);const handleResize = useCallback((width: number, height: number) => {@@ -186,6 +193,7 @@ function CartesianChartInner(props: VisualizationProps) {><ResponsiveEChartsRendererref={containerRef}+ display={card.display}option={option}eventHandlers={eventHandlers}onResize={handleResize}diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/chart-definition.ts b/frontend/src/metabase/visualizations/visualizations/CartesianChart/chart-definition.tsindex 2b88a95ad98..4209976fbe9 100644--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/chart-definition.ts+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/chart-definition.ts@@ -48,6 +48,7 @@ export const getCartesianChartDefinition = (): Partial<Visualization> => {return {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.tsindex 37d17c8393a..f3adede32a4 100644--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-brush.ts+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-brush.ts@@ -66,6 +66,11 @@ export const useBrush = (// ECharts option object — used as a signal dep to re-enable brush after// 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.+ chartInstance?: unknown,) => {const isTouch = useRef(isTouchDevice()).current;@@ -81,7 +86,14 @@ export const useBrush = (chartRef.current?.dispatchAction({ type: "takeGlobalCursor" });}, [chartRef]);- useDesktopBrush({ isTouch, isBrushable, enableBrush, disableBrush, option });+ useDesktopBrush({+ isTouch,+ isBrushable,+ enableBrush,+ disableBrush,+ option,+ chartInstance,+ });useTouchBrush({chartRef,containerRef,@@ -99,12 +111,14 @@ function useDesktopBrush({enableBrush,disableBrush,option,+ chartInstance,}: {isTouch: boolean;isBrushable: boolean;enableBrush: () => void;disableBrush: () => void;option?: unknown;+ chartInstance?: unknown;}) {useEffect(() => {if (isTouch) {@@ -120,7 +134,7 @@ function useDesktopBrush({}, 0);return () => clearTimeout(timeout);- }, [isBrushable, isTouch, enableBrush, disableBrush, option]);+ }, [isBrushable, isTouch, enableBrush, disableBrush, option, chartInstance]);}/**diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-brush.unit.spec.ts b/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-brush.unit.spec.tsindex c363062a74b..b983922ddbe 100644--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-brush.unit.spec.ts+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-brush.unit.spec.ts@@ -224,6 +224,48 @@ describe("use-brush", () => {expectBrushDisabled(dispatchAction);});++ it("enables brush once the chart instance becomes available (lazy renderer)", () => {+ // Simulates the lazily loaded EChartsRenderer: the chart instance is+ // only set (via onInit) after this hook's effects have already run, so+ // the first attempt to enable the brush is a no-op. Surfacing the chart+ // instance as a signal must re-run the effect and enable the brush.+ const dispatchAction = jest.fn();+ const chartRef = {+ current: undefined,+ } as MutableRefObject<EChartsType | undefined>;+ const { containerRef } = createMockContainerRef();++ const { rerender } = renderHook(+ ({ chartInstance }) =>+ useBrush(+ chartRef,+ containerRef,+ true,+ true,+ undefined,+ chartInstance,+ ),+ {+ initialProps: {+ chartInstance: undefined as EChartsType | undefined,+ },+ },+ );+ act(() => jest.runAllTimers());++ // Chart not initialized yet → brush cannot be enabled.+ expectBrushNotEnabled(dispatchAction);++ // Chart initializes: ref is populated and the instance is surfaced as a+ // signal, mirroring CartesianChart's handleInit.+ const chart = { dispatchAction } as unknown as EChartsType;+ chartRef.current = chart;+ rerender({ chartInstance: chart });+ act(() => jest.runAllTimers());++ expectBrushEnabled(dispatchAction);+ });});describe("touch", () => {diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-chart-events.ts b/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-chart-events.tsindex 9d70fc179df..588bd4ba602 100644--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-chart-events.ts+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-chart-events.ts@@ -79,6 +79,10 @@ export const useChartEvents = (metadata,isDashboard,}: 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.+ chartInstance?: EChartsType,) => {const isBrushing = useRef<boolean>();useTooltipMouseLeave(chartRef, onHoverChange, containerRef);@@ -367,7 +371,14 @@ export const useChartEvents = ();const isBrushable = canBrushChart && !hovered && !clicked;- useBrush(chartRef, containerRef, canBrushChart, isBrushable, option);+ useBrush(+ chartRef,+ containerRef,+ canBrushChart,+ isBrushable,+ option,+ chartInstance,+ );const onSelectSeries = useCallback((event: React.MouseEvent, seriesIndex: number) => {diff --git a/frontend/src/metabase/visualizations/visualizations/PieChart/PieChart.tsx b/frontend/src/metabase/visualizations/visualizations/PieChart/PieChart.tsxindex e8a0cf4ff50..ec610abd2c5 100644--- a/frontend/src/metabase/visualizations/visualizations/PieChart/PieChart.tsx+++ b/frontend/src/metabase/visualizations/visualizations/PieChart/PieChart.tsx@@ -193,6 +193,7 @@ export function PieChart(props: VisualizationProps) {><ResponsiveEChartsRendererref={containerRef}+ display="pie"option={option}onInit={handleInit}onResize={handleResize}diff --git a/frontend/src/metabase/visualizations/visualizations/PieChart/chart-definition.ts b/frontend/src/metabase/visualizations/visualizations/PieChart/chart-definition.tsindex 92c5e5bcf0f..8fcc55cbc89 100644--- a/frontend/src/metabase/visualizations/visualizations/PieChart/chart-definition.ts+++ b/frontend/src/metabase/visualizations/visualizations/PieChart/chart-definition.ts@@ -48,6 +48,7 @@ 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/SankeyChart/SankeyChart.tsx b/frontend/src/metabase/visualizations/visualizations/SankeyChart/SankeyChart.tsxindex c458e63ed73..9137a801d87 100644--- a/frontend/src/metabase/visualizations/visualizations/SankeyChart/SankeyChart.tsx+++ b/frontend/src/metabase/visualizations/visualizations/SankeyChart/SankeyChart.tsx@@ -75,6 +75,7 @@ export const SankeyChart = ({<><ResponsiveEChartsRendererref={containerRef}+ display="sankey"option={option}eventHandlers={eventHandlers}onInit={handleInit}diff --git a/frontend/src/metabase/visualizations/visualizations/SankeyChart/chart-definition.ts b/frontend/src/metabase/visualizations/visualizations/SankeyChart/chart-definition.tsindex 443f58cc07d..f373c64be92 100644--- a/frontend/src/metabase/visualizations/visualizations/SankeyChart/chart-definition.ts+++ b/frontend/src/metabase/visualizations/visualizations/SankeyChart/chart-definition.ts@@ -124,6 +124,7 @@ 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#55045noun: t`sankey chart`,minSize: getMinSize("sankey"),