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
Allow multiple useDataAppLocation consumers without crashing data apps (#81854)
Phoomparin Mano96c905f64380
diff --git a/frontend/src/embedding-sdk-bundle/lib/data-app/router/dataAppRouting.ts b/frontend/src/embedding-sdk-bundle/lib/data-app/router/dataAppRouting.tsnew file mode 100644index 00000000000..e8e0bedd775--- /dev/null+++ b/frontend/src/embedding-sdk-bundle/lib/data-app/router/dataAppRouting.ts@@ -0,0 +1,30 @@+import { getRawBrowserHistory } from "metabase/router";++import { getBasename } from "./DataAppRouter";++const subscribers = new Set<() => void>();+let unsubscribeFromHistory: (() => void) | undefined;++export const subscribeToDataAppRouting = (callback: () => void) => {+ subscribers.add(callback);++ unsubscribeFromHistory ??= getRawBrowserHistory().listen(() => {+ subscribers.forEach((subscriber) => subscriber());+ });++ return () => {+ subscribers.delete(callback);++ if (subscribers.size === 0) {+ unsubscribeFromHistory?.();+ unsubscribeFromHistory = undefined;+ }+ };+};++/** Routing helpers exposed on the bundle, for data apps to consume. */+export const dataAppRouting = {+ getBasename,+ navigate: (to: string) => getRawBrowserHistory().push(getBasename() + to),+ subscribe: subscribeToDataAppRouting,+};diff --git a/frontend/src/embedding-sdk-bundle/lib/data-app/router/index.ts b/frontend/src/embedding-sdk-bundle/lib/data-app/router/index.tsindex ffb192e3c07..ab663243dd5 100644--- a/frontend/src/embedding-sdk-bundle/lib/data-app/router/index.ts+++ b/frontend/src/embedding-sdk-bundle/lib/data-app/router/index.ts@@ -1,20 +1,6 @@-import { getRawBrowserHistory } from "metabase/router";-import { DataAppRouter, getBasename } from "./DataAppRouter";export { DataAppRouter, getBasename };export { DataAppLink, type DataAppLinkProps } from "./DataAppLink";export { useDataAppLocation } from "./useDataAppLocation";--/**- * Imperative routing surface exposed to the SDK bundle's public API.- * The bundle never depends on a router library directly, it only relies on this- * `{ getBasename, navigate, subscribe }` shape, backed by the browser history the- * data app drives its iframe URL with.- */-export const dataAppRouting = {- getBasename,- navigate: (to: string) => getRawBrowserHistory().push(getBasename() + to),- subscribe: (callback: () => void) =>- getRawBrowserHistory().listen(() => callback()),-};+export { dataAppRouting } from "./dataAppRouting";diff --git a/frontend/src/embedding-sdk-bundle/lib/data-app/router/useDataAppLocation.ts b/frontend/src/embedding-sdk-bundle/lib/data-app/router/useDataAppLocation.tsindex 866b4f75f06..39e0c237f6b 100644--- a/frontend/src/embedding-sdk-bundle/lib/data-app/router/useDataAppLocation.ts+++ b/frontend/src/embedding-sdk-bundle/lib/data-app/router/useDataAppLocation.ts@@ -3,6 +3,7 @@ import { useCallback, useEffect, useMemo, useState } from "react";import { getRawBrowserHistory } from "metabase/router";import { getBasename } from "./DataAppRouter";+import { subscribeToDataAppRouting } from "./dataAppRouting";const computeSubPath = (basename: string): string => {const pathname = window.location.pathname;@@ -33,7 +34,7 @@ export const useDataAppLocation = (): {useEffect(() => {// `listen` fires for every navigation: `<Link>` clicks, imperative `push`// calls, and browser back/forward. One subscription covers all of them.- return getRawBrowserHistory().listen(() => {+ return subscribeToDataAppRouting(() => {setPathname(computeSubPath(basename));});}, [basename]);diff --git a/frontend/src/embedding-sdk-bundle/lib/data-app/router/useDataAppLocation.unit.spec.tsx b/frontend/src/embedding-sdk-bundle/lib/data-app/router/useDataAppLocation.unit.spec.tsxindex 15d4059ebe1..b564ff602d2 100644--- a/frontend/src/embedding-sdk-bundle/lib/data-app/router/useDataAppLocation.unit.spec.tsx+++ b/frontend/src/embedding-sdk-bundle/lib/data-app/router/useDataAppLocation.unit.spec.tsx@@ -17,4 +17,16 @@ describe("useDataAppLocation", () => {expect(result.current.pathname).toBe("/orders/42");expect(window.location.pathname).toBe("/orders/42");});++ it("supports multiple consumers", () => {+ const { result: firstResult } = renderHook(() => useDataAppLocation());+ const { result: secondResult } = renderHook(() => useDataAppLocation());++ act(() => {+ firstResult.current.navigate("/orders/42");+ });++ expect(firstResult.current.pathname).toBe("/orders/42");+ expect(secondResult.current.pathname).toBe("/orders/42");+ });});