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
Wait for the SDK login before rendering metabase-browser (#84866)
Nicolò Pretto9ebc40f6ad4f
diff --git a/e2e/test/scenarios/embedding/sdk-iframe-embedding/metabase-browser.cy.spec.ts b/e2e/test/scenarios/embedding/sdk-iframe-embedding/metabase-browser.cy.spec.tsindex ee0f9394ff6..64e60a5b0d5 100644--- a/e2e/test/scenarios/embedding/sdk-iframe-embedding/metabase-browser.cy.spec.ts+++ b/e2e/test/scenarios/embedding/sdk-iframe-embedding/metabase-browser.cy.spec.ts@@ -37,7 +37,8 @@ describe("scenarios > embedding > sdk iframe embedding > metabase-browser", () =},});- cy.signIn("nocollection");+ cy.signOut();+ mockAuthProviderAndJwtSignIn(USERS.nocollection);setupEmbed(`<metabase-browser@@ -77,7 +78,8 @@ describe("scenarios > embedding > sdk iframe embedding > metabase-browser", () =collection_id: collection.id,});- cy.signIn("nocollection");+ cy.signOut();+ mockAuthProviderAndJwtSignIn(USERS.nocollection);setupEmbed(`<metabase-browserdiff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk/components/MetabaseBrowser.tsx b/frontend/src/metabase/embedding/embedding-iframe-sdk/components/MetabaseBrowser.tsxindex e3bfaf02ca6..fadf06b77b9 100644--- a/frontend/src/metabase/embedding/embedding-iframe-sdk/components/MetabaseBrowser.tsx+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk/components/MetabaseBrowser.tsx@@ -4,7 +4,12 @@ import { P, match } from "ts-pattern";import { t } from "ttag";import _ from "underscore";-import { SdkBreadcrumbs } from "embedding-sdk-bundle/components/private/SdkBreadcrumbs";+import { withPublicComponentWrapper } from "embedding-sdk-bundle/components/private/PublicComponentWrapper";+import {+ SdkBreadcrumbs,+ SdkBreadcrumbsProvider,+} from "embedding-sdk-bundle/components/private/SdkBreadcrumbs";+import { SdkInternalNavigationProvider } from "embedding-sdk-bundle/components/private/SdkInternalNavigation/SdkInternalNavigationProvider";import { useSdkInternalNavigation } from "embedding-sdk-bundle/components/private/SdkInternalNavigation/context";import { CollectionBrowser } from "embedding-sdk-bundle/components/public/CollectionBrowser";import { CreateDashboardModal } from "embedding-sdk-bundle/components/public/CreateDashboardModal";@@ -38,7 +43,7 @@ type EntityBreadcrumbType = Exclude<SdkBreadcrumbItemType, "all-collections">;const BREADCRUMB_HEIGHT = "3.5rem";-export function MetabaseBrowser({ settings }: MetabaseBrowserProps) {+function MetabaseBrowserContent({ settings }: MetabaseBrowserProps) {const navigationContext = useSdkInternalNavigation();const { initialCollection } = settings;@@ -292,3 +297,21 @@ export function MetabaseBrowser({ settings }: MetabaseBrowserProps) {</Stack>);}++const MetabaseBrowserInner = ({ settings }: MetabaseBrowserProps) => (+ <SdkInternalNavigationProvider+ keepChildrenMounted+ // Needed so dashboards and questions opened via click behavior can scroll+ style={{ height: "100%" }}+ >+ {/* re-mount breadcrumbs when initial collection changes */}+ <SdkBreadcrumbsProvider key={settings.initialCollection}>+ <MetabaseBrowserContent settings={settings} />+ </SdkBreadcrumbsProvider>+ </SdkInternalNavigationProvider>+);++export const MetabaseBrowser = withPublicComponentWrapper(+ MetabaseBrowserInner,+ { supportsGuestEmbed: false },+);diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk/components/MetabaseBrowser.unit.spec.tsx b/frontend/src/metabase/embedding/embedding-iframe-sdk/components/MetabaseBrowser.unit.spec.tsxindex accad9afad6..7aafec9cf50 100644--- a/frontend/src/metabase/embedding/embedding-iframe-sdk/components/MetabaseBrowser.unit.spec.tsx+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk/components/MetabaseBrowser.unit.spec.tsx@@ -1,4 +1,5 @@import userEvent from "@testing-library/user-event";+import fetchMock from "fetch-mock";import {setupCollectionByIdEndpoint,@@ -8,14 +9,19 @@ import {setupDashboardQueryMetadataEndpoint,setupNotificationChannelsEndpoints,} from "__support__/server-mocks";-import { screen, within } from "__support__/ui";-import { SdkBreadcrumbsProvider } from "embedding-sdk-bundle/components/private/SdkBreadcrumbs/SdkBreadcrumbsProvider";-import { SdkInternalNavigationProvider } from "embedding-sdk-bundle/components/private/SdkInternalNavigation/SdkInternalNavigationProvider";+import { act, screen, within } from "__support__/ui";+import { initAuth } from "embedding-sdk-bundle/store/auth";import { renderWithSDKProviders } from "embedding-sdk-bundle/test/__support__/ui";import { createMockSdkConfig } from "embedding-sdk-bundle/test/mocks/config";+import {+ createMockLoginStatusState,+ createMockSdkState,+} from "embedding-sdk-bundle/test/mocks/state";import { setupSdkState } from "embedding-sdk-bundle/test/server-mocks/sdk-init";+import type { LoginStatus } from "embedding-sdk-bundle/types/user";import { ROOT_COLLECTION } from "metabase/common/collections/constants";import { useLocale } from "metabase/common/hooks/use-locale";+import type { CollectionId } from "metabase-types/api";import {createMockCollection,createMockCollectionItem,@@ -111,6 +117,27 @@ describe("MetabaseBrowser", () => {expect(queryNewQuestionButton()).not.toBeInTheDocument();expect(queryNewDashboardButton()).not.toBeInTheDocument();});++ it("should wait for the SDK login before fetching the initial collection", async () => {+ const { store, authConfig } = setup({+ initialCollection: "root",+ initStatus: { status: "loading" },+ });++ expect(await screen.findByTestId("loading-indicator")).toBeInTheDocument();+ expect(+ fetchMock.callHistory.calls("path:/api/collection/root"),+ ).toHaveLength(0);++ act(() => {+ store.dispatch(initAuth.fulfilled(undefined, "test-request", authConfig));+ });++ expect(await screen.findByText("Root Dashboard")).toBeInTheDocument();+ expect(+ fetchMock.callHistory.calls("path:/api/collection/root").length,+ ).toBeGreaterThan(0);+ });});function getBreadcrumb(name: string) {@@ -125,7 +152,15 @@ function queryNewDashboardButton() {return screen.queryByRole("button", { name: "New dashboard" });}-function setup() {+interface SetupOpts {+ initialCollection?: CollectionId | "all";+ initStatus?: LoginStatus;+}++function setup({+ initialCollection = "all",+ initStatus = { status: "success" },+}: SetupOpts = {}) {useLocaleMock.mockReturnValue({ isLocaleLoading: false });const personalCollection = createMockCollection({@@ -195,27 +230,31 @@ function setup() {);setupNotificationChannelsEndpoints({});- const { state } = setupSdkState();+ const { state } = setupSdkState({+ sdkState: createMockSdkState({+ initStatus: createMockLoginStatusState(initStatus),+ }),+ });const settings: SdkIframeEmbedSettings & {componentName: "metabase-browser";} = {componentName: "metabase-browser",instanceUrl: "http://localhost",- initialCollection: "all",+ initialCollection,// `MetabaseBrowser` defaults `readOnly` to true when the key is absent.readOnly: false,};- renderWithSDKProviders(- <SdkInternalNavigationProvider keepChildrenMounted>- <SdkBreadcrumbsProvider>- <MetabaseBrowser settings={settings} />- </SdkBreadcrumbsProvider>- </SdkInternalNavigationProvider>,+ const authConfig = createMockSdkConfig();++ const { store } = renderWithSDKProviders(+ <MetabaseBrowser settings={settings} />,{- componentProviderProps: { authConfig: createMockSdkConfig() },+ componentProviderProps: { authConfig },storeInitialState: state,},);++ return { store, authConfig };}diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk/components/SdkIframeEmbedRoute.tsx b/frontend/src/metabase/embedding/embedding-iframe-sdk/components/SdkIframeEmbedRoute.tsxindex 565b19e2522..445475cd061 100644--- a/frontend/src/metabase/embedding/embedding-iframe-sdk/components/SdkIframeEmbedRoute.tsx+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk/components/SdkIframeEmbedRoute.tsx@@ -3,8 +3,6 @@ import { P, match } from "ts-pattern";import { PublicComponentStylesWrapper } from "embedding-sdk-bundle/components/private/PublicComponentStylesWrapper";import { SdkError } from "embedding-sdk-bundle/components/private/PublicComponentWrapper";-import { SdkBreadcrumbsProvider } from "embedding-sdk-bundle/components/private/SdkBreadcrumbs";-import { SdkInternalNavigationProvider } from "embedding-sdk-bundle/components/private/SdkInternalNavigation/SdkInternalNavigationProvider";import { ComponentProvider } from "embedding-sdk-bundle/components/public/ComponentProvider";import { MetabotQuestion } from "embedding-sdk-bundle/components/public/MetabotQuestion";import { SdkQuestion } from "embedding-sdk-bundle/components/public/SdkQuestion";@@ -179,14 +177,7 @@ const SdkIframeEmbedView = ({{componentName: "metabase-browser",},- (settings) => (- <SdkInternalNavigationProvider keepChildrenMounted>- {/* re-mount breadcrumbs when initial collection changes */}- <SdkBreadcrumbsProvider key={settings.initialCollection}>- <MetabaseBrowser settings={settings} />- </SdkBreadcrumbsProvider>- </SdkInternalNavigationProvider>- ),+ (settings) => <MetabaseBrowser settings={settings} />,).with(// Embedding based on a dashboardId (Metabase Account auth type) with disabled drills