Skip to content

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

Load the dependency graph and schema viewer pages lazily (#80050)

Romeo Van Snickf5bdbf045d50
diff --git a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/DependencyGraph.tsx b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/DependencyGraph.tsx
index b35135030b2..46481af36c2 100644
--- a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/DependencyGraph.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/DependencyGraph.tsx
@@ -1,3 +1,8 @@
+// Deliberate import-time side effect: xyflow's stylesheet must load with this
+// chunk. If this module is ever declared side-effect free, the bundler would
+// drop this import and the graph would render unstyled.
+import "@xyflow/react/dist/style.css";
+
import {
Background,
Controls,
diff --git a/enterprise/frontend/src/metabase-enterprise/dependencies/index.ts b/enterprise/frontend/src/metabase-enterprise/dependencies/index.ts
index e72dfc9e78f..63b5db6e8e1 100644
--- a/enterprise/frontend/src/metabase-enterprise/dependencies/index.ts
+++ b/enterprise/frontend/src/metabase-enterprise/dependencies/index.ts
@@ -1,8 +1,10 @@
import { PLUGIN_DEPENDENCIES } from "metabase/plugins";
+import { registerPagePrefetch } from "metabase/router";
+import * as Urls from "metabase/urls";
import { hasPremiumFeature } from "metabase-enterprise/settings";
import { useGetDependenciesCount } from "./hooks/use-get-dependencies-count";
-import { DependencyGraphPage } from "./pages/DependencyGraphPage";
+import { LazyDependencyGraphPage, loadDependencyGraphPage } from "./lazy";
import { getDataStudioDependencyRoutes } from "./routes";
/**
@@ -13,7 +15,13 @@ export function initializePlugin() {
PLUGIN_DEPENDENCIES.isEnabled = true;
PLUGIN_DEPENDENCIES.getDataStudioDependencyRoutes =
getDataStudioDependencyRoutes;
- PLUGIN_DEPENDENCIES.DependencyGraphPage = DependencyGraphPage;
+ PLUGIN_DEPENDENCIES.DependencyGraphPage = LazyDependencyGraphPage;
PLUGIN_DEPENDENCIES.useGetDependenciesCount = useGetDependenciesCount;
+
+ // Hovering a link to the graph starts its fetch, so the chunk is usually in
+ // hand by the time the click lands. Only the Data Studio path is registered:
+ // the per-entity dependency tabs carry an entity id before the segment that
+ // names them, so no prefix can single them out.
+ registerPagePrefetch(Urls.dependencyGraph(), loadDependencyGraphPage);
}
}
diff --git a/enterprise/frontend/src/metabase-enterprise/dependencies/lazy.tsx b/enterprise/frontend/src/metabase-enterprise/dependencies/lazy.tsx
new file mode 100644
index 00000000000..540aeaded12
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/dependencies/lazy.tsx
@@ -0,0 +1,29 @@
+import { Suspense, lazy } from "react";
+
+import { DelayedLoadingSpinner } from "metabase/common/components/DelayedLoading";
+
+/**
+ * The dependency graph page, in its own chunk. It renders the graph with xyflow
+ * and dagre, which nothing else in the initial bundle needs.
+ */
+export const loadDependencyGraphPage = () =>
+ import("./pages/DependencyGraphPage");
+
+const DependencyGraphPage = lazy(() =>
+ loadDependencyGraphPage().then(({ DependencyGraphPage }) => ({
+ default: DependencyGraphPage,
+ })),
+);
+
+/**
+ * The route file splits this page with a route-level `lazy`. This `React.lazy`
+ * wrapper exists only for the `PLUGIN_DEPENDENCIES.DependencyGraphPage` slot,
+ * which is a ComponentType rendered as a route `element` at over a dozen call
+ * sites. Route-level `lazy` cannot express that, so the Suspense boundary lives
+ * here rather than at every site.
+ */
+export const LazyDependencyGraphPage = () => (
+ <Suspense fallback={<DelayedLoadingSpinner />}>
+ <DependencyGraphPage />
+ </Suspense>
+);
diff --git a/enterprise/frontend/src/metabase-enterprise/dependencies/routes.tsx b/enterprise/frontend/src/metabase-enterprise/dependencies/routes.tsx
index 04845414603..5492c67f928 100644
--- a/enterprise/frontend/src/metabase-enterprise/dependencies/routes.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/dependencies/routes.tsx
@@ -1,7 +1,9 @@
import { Route } from "metabase/router";
+import { loadDependencyGraphPage } from "./lazy";
+
const dependencyGraphPage = () =>
- import("./pages/DependencyGraphPage").then(({ DependencyGraphPage }) => ({
+ loadDependencyGraphPage().then(({ DependencyGraphPage }) => ({
Component: DependencyGraphPage,
}));
diff --git a/enterprise/frontend/src/metabase-enterprise/schema_viewer/components/SchemaViewer/SchemaViewer.tsx b/enterprise/frontend/src/metabase-enterprise/schema_viewer/components/SchemaViewer/SchemaViewer.tsx
index 2f132064545..d5ec37a4d6f 100644
--- a/enterprise/frontend/src/metabase-enterprise/schema_viewer/components/SchemaViewer/SchemaViewer.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/schema_viewer/components/SchemaViewer/SchemaViewer.tsx
@@ -1,3 +1,8 @@
+// Deliberate import-time side effect: xyflow's stylesheet must load with this
+// chunk. If this module is ever declared side-effect free, the bundler would
+// drop this import and the graph would render unstyled.
+import "@xyflow/react/dist/style.css";
+
import {
Background,
Panel,
diff --git a/enterprise/frontend/src/metabase-enterprise/schema_viewer/lazy.ts b/enterprise/frontend/src/metabase-enterprise/schema_viewer/lazy.ts
new file mode 100644
index 00000000000..b4977a6dc81
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/schema_viewer/lazy.ts
@@ -0,0 +1,7 @@
+/**
+ * The schema viewer page, in its own chunk. It renders the schema with xyflow
+ * and dagre, which nothing else in the initial bundle needs. The route file
+ * turns this loader into a route-level `lazy`, and the prefetch registration
+ * reuses it, so both sides always name the same module.
+ */
+export const loadSchemaViewerPage = () => import("./pages/SchemaViewerPage");
diff --git a/enterprise/frontend/src/metabase-enterprise/schema_viewer/routes.tsx b/enterprise/frontend/src/metabase-enterprise/schema_viewer/routes.tsx
index 3b4a83b26cd..c71543f9151 100644
--- a/enterprise/frontend/src/metabase-enterprise/schema_viewer/routes.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/schema_viewer/routes.tsx
@@ -1,8 +1,10 @@
import { Route, registerPagePrefetch } from "metabase/router";
import * as Urls from "metabase/urls";
+import { loadSchemaViewerPage } from "./lazy";
+
const schemaViewerPage = () =>
- import("./pages/SchemaViewerPage").then(({ SchemaViewerPage }) => ({
+ loadSchemaViewerPage().then(({ SchemaViewerPage }) => ({
Component: SchemaViewerPage,
}));
diff --git a/frontend/src/metabase/app.tsx b/frontend/src/metabase/app.tsx
index e6c16679920..28549bac158 100644
--- a/frontend/src/metabase/app.tsx
+++ b/frontend/src/metabase/app.tsx
@@ -1,6 +1,5 @@
import "@mantine/core/styles.css";
import "@mantine/dates/styles.css";
-import "@xyflow/react/dist/style.css";
// This is conditionally aliased in the webpack config.
// If EE isn't enabled, it loads an empty file.