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 recent dashboards being loaded before we load a resource in Embed JS wizard (#67013)
Timofey Kachalov49e37e2e9ce7
diff --git a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/helpers/index.ts b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/helpers/index.tsindex c042e04214c..59831e09ac8 100644--- a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/helpers/index.ts+++ b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/helpers/index.ts@@ -23,7 +23,9 @@ export const getEmbedSidebar = () =>export const getRecentItemCards = () =>cy.findAllByTestId("embed-recent-item-card");-export const visitNewEmbedPage = () => {+export const visitNewEmbedPage = (+ { waitForResource } = { waitForResource: true },+) => {cy.intercept("GET", "/api/dashboard/*").as("dashboard");cy.visit("/admin/embedding");@@ -42,9 +44,14 @@ export const visitNewEmbedPage = () => {embedModalEnableEmbedding();}- cy.wait("@dashboard");+ if (waitForResource) {+ cy.wait("@dashboard");- cy.get("[data-iframe-loaded]", { timeout: 20000 }).should("have.length", 1);+ cy.get("[data-iframe-loaded]", { timeout: 20000 }).should(+ "have.length",+ 1,+ );+ }});};diff --git a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-experience.cy.spec.ts b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-experience.cy.spec.tsindex 28e23a7481d..58232aa82b3 100644--- a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-experience.cy.spec.ts+++ b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-experience.cy.spec.ts@@ -214,6 +214,50 @@ describe(suiteTitle, () => {cy.findByTestId("preview-loading-indicator").should("not.exist");});+ it("should respect slow loading of recent dashboars and wait till loading complete", () => {+ cy.intercept("GET", "/api/activity/recents*", (req) => {+ req.on("response", (res) => {+ res.setThrottle(0.3); // Slow down the response+ });+ }).as("getRecents");++ visitNewEmbedPage();++ H.getSimpleEmbedIframeContent().within(() => {+ cy.findByText("Person overview").should("not.exist");+ cy.findByText("Orders in a dashboard").should("be.visible");+ });+ });++ it("shows no-data block when example-dashboard-id points to an archived dashboard", () => {+ H.createDashboard({+ name: "Archived Dashboard",+ }).then(({ body: { id: dashboardId } }) => {+ H.archiveDashboard(dashboardId);++ cy.intercept("GET", "/api/session/properties", (req) => {+ req.continue((res) => {+ res.body["example-dashboard-id"] = dashboardId;+ res.send();+ });+ });+ });++ cy.intercept("GET", "/api/activity/recents*", {+ body: [],+ }).as("emptyRecentItems");++ visitNewEmbedPage({ waitForResource: false });++ getEmbedSidebar().within(() => {+ cy.findByLabelText("Metabase account (SSO)").click();+ });++ cy.wait("@emptyRecentItems");++ cy.findByAltText("No results").should("be.visible");+ });+it("shows Metabot experience when selected", () => {visitNewEmbedPage();diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/analytics.ts b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/analytics.tsindex dbf33ef7942..a6a123adb3e 100644--- a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/analytics.ts+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/analytics.ts@@ -228,7 +228,7 @@ const buildEventDetailsPartsForSettings = (const value = settings[optionKey];- if (value === undefined) {+ if (value === undefined || value === null) {continue;}diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/LegacyStaticEmbeddingModal.tsx b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/LegacyStaticEmbeddingModal.tsxindex e204008501d..d7f42cda02f 100644--- a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/LegacyStaticEmbeddingModal.tsx+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/LegacyStaticEmbeddingModal.tsx@@ -11,8 +11,8 @@ import type { Card, Dashboard, DashboardId } from "metabase-types/api";export type LegacyStaticEmbeddingModalProps = {experience: SdkIframeEmbedSetupExperience;- dashboardId?: DashboardId;- questionId?: string | number;+ dashboardId?: DashboardId | null;+ questionId?: string | number | null;parentInitialState: SdkIframeEmbedSetupModalInitialState | undefined;};diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/SdkIframeEmbedSetupModal.tsx b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/SdkIframeEmbedSetupModal.tsxindex 2dac5571ee0..a3507e08013 100644--- a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/SdkIframeEmbedSetupModal.tsx+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/SdkIframeEmbedSetupModal.tsx@@ -12,6 +12,7 @@ import CS from "metabase/css/core/index.css";import { SdkIframeGuestEmbedStatusBar } from "metabase/embedding/embedding-iframe-sdk-setup/components/SdkIframeGuestEmbedStatusBar";import { SdkIframeStepHeader } from "metabase/embedding/embedding-iframe-sdk-setup/components/SdkIframeStepHeader";import { EMBED_STEPS } from "metabase/embedding/embedding-iframe-sdk-setup/constants";+import { isQuestionOrDashboardSettings } from "metabase/embedding/embedding-iframe-sdk-setup/utils/is-question-or-dashboard-settings";import { useDispatch } from "metabase/lib/redux";import type { SdkIframeEmbedSetupModalProps } from "metabase/plugins";import { closeModal } from "metabase/redux/ui";@@ -47,6 +48,8 @@ export const SdkIframeEmbedSetupContent = () => {handleNext,handleBack,canGoBack,+ isLoading,+ experience,resource,settings,} = useSdkIframeEmbedSetupContext();@@ -72,6 +75,14 @@ export const SdkIframeEmbedSetupContent = () => {? isSimpleEmbeddingEnabled && isSimpleEmbeddingTermsAccepted: isGuestEmbedsEnabled && isGuestEmbedsTermsAccepted;+ const isQuestionOrDashboard = isQuestionOrDashboardSettings(+ experience,+ settings,+ );++ const isMissingResource =+ isQuestionOrDashboard && !isLoading && (!resource || resource.archived);+const nextStepButton = match(currentStep).with("get-code", () => (<Button@@ -148,7 +159,7 @@ export const SdkIframeEmbedSetupContent = () => {<SdkIframeGuestEmbedStatusBar />- {allowPreviewAndNavigation ? (+ {allowPreviewAndNavigation && !isMissingResource ? (<SdkIframeEmbedPreview />) : (<Card h="100%">diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/SdkIframeEmbedSetupProvider.tsx b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/SdkIframeEmbedSetupProvider.tsxindex 503af4178e4..8fb4d1c406a 100644--- a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/SdkIframeEmbedSetupProvider.tsx+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/SdkIframeEmbedSetupProvider.tsx@@ -182,6 +182,7 @@ export const SdkIframeEmbedSetupProvider = ({isError,isLoading,isFetching,+ isRecentsLoading,settings,defaultSettings,replaceSettings,diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/context.ts b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/context.tsindex 3930435149b..14f274a41ed 100644--- a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/context.ts+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/context.ts@@ -47,6 +47,7 @@ export interface SdkIframeEmbedSetupContextType {isError: boolean;isLoading: boolean;isFetching: boolean;+ isRecentsLoading: boolean;// Embed settingssettings: SdkIframeEmbedSetupSettings;diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/hooks/use-get-current-resource.ts b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/hooks/use-get-current-resource.tsindex f4a99c7abfd..64e50f07e2b 100644--- a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/hooks/use-get-current-resource.ts+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/hooks/use-get-current-resource.ts@@ -33,8 +33,8 @@ export const useGetCurrentResource = ({questionId,}: {experience: SdkIframeEmbedSetupExperience;- dashboardId?: DashboardId;- questionId?: string | number;+ dashboardId?: DashboardId | null;+ questionId?: string | number | null;}) => {const dispatch = useDispatch();diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/hooks/use-handle-experience-change.ts b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/hooks/use-handle-experience-change.tsindex 73a5578b3c0..0447b5908a9 100644--- a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/hooks/use-handle-experience-change.ts+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/hooks/use-handle-experience-change.ts@@ -2,13 +2,12 @@ import { useCallback } from "react";import { P, match } from "ts-pattern";import _ from "underscore";+import { useSetting } from "metabase/common/hooks";import { ALLOWED_EMBED_SETTING_KEYS_MAP } from "metabase/embedding/embedding-iframe-sdk/constants";-import {- EMBED_FALLBACK_DASHBOARD_ID,- EMBED_FALLBACK_QUESTION_ID,-} from "metabase/embedding/embedding-iframe-sdk-setup/constants";+import { EMBED_FALLBACK_QUESTION_ID } from "metabase/embedding/embedding-iframe-sdk-setup/constants";import { useSdkIframeEmbedSetupContext } from "metabase/embedding/embedding-iframe-sdk-setup/context";import type { SdkIframeEmbedSetupExperience } from "metabase/embedding/embedding-iframe-sdk-setup/types";+import { determineDashboardId } from "metabase/embedding/embedding-iframe-sdk-setup/utils/determine-dashboard-id";import { getDefaultSdkIframeEmbedSettings } from "metabase/embedding/embedding-iframe-sdk-setup/utils/get-default-sdk-iframe-embed-setting";export const DEFAULT_EXPERIENCE = "dashboard";@@ -18,12 +17,15 @@ export const useHandleExperienceChange = () => {isSimpleEmbedFeatureAvailable,isGuestEmbedsEnabled,isSsoEnabledAndConfigured,+ isRecentsLoading,settings,replaceSettings,recentDashboards,recentQuestions,} = useSdkIframeEmbedSetupContext();+ const exampleDashboardId = useSetting("example-dashboard-id");+const handleEmbedExperienceChange = useCallback((experience: SdkIframeEmbedSetupExperience) => {const persistedSettings = _.pick(@@ -38,9 +40,12 @@ export const useHandleExperienceChange = () => {"chart",() => recentQuestions[0]?.id ?? EMBED_FALLBACK_QUESTION_ID,)- .with(- "dashboard",- () => recentDashboards[0]?.id ?? EMBED_FALLBACK_DASHBOARD_ID,+ .with("dashboard", () =>+ determineDashboardId({+ isRecentsLoading,+ recentDashboards,+ exampleDashboardId,+ }),).with(P.union("exploration", "browser", "metabot"), () => 0) // resource id does not apply.exhaustive();@@ -66,9 +71,11 @@ export const useHandleExperienceChange = () => {isSsoEnabledAndConfigured,isSimpleEmbedFeatureAvailable,recentDashboards,+ isRecentsLoading,recentQuestions,replaceSettings,settings,+ exampleDashboardId,],);diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/hooks/use-sdk-iframe-embed-settings.ts b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/hooks/use-sdk-iframe-embed-settings.tsindex 51c92181a35..13565d3a8af 100644--- a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/hooks/use-sdk-iframe-embed-settings.ts+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/hooks/use-sdk-iframe-embed-settings.ts@@ -2,15 +2,13 @@ import { useCallback, useEffect, useMemo, useState } from "react";import { P, match } from "ts-pattern";import _ from "underscore";-import { useUserSetting } from "metabase/common/hooks";-import {- EMBED_FALLBACK_DASHBOARD_ID,- USER_SETTINGS_DEBOUNCE_MS,-} from "metabase/embedding/embedding-iframe-sdk-setup/constants";+import { useSetting, useUserSetting } from "metabase/common/hooks";+import { USER_SETTINGS_DEBOUNCE_MS } from "metabase/embedding/embedding-iframe-sdk-setup/constants";import type {SdkIframeEmbedSetupRecentItem,SdkIframeEmbedSetupSettings,} from "metabase/embedding/embedding-iframe-sdk-setup/types";+import { determineDashboardId } from "metabase/embedding/embedding-iframe-sdk-setup/utils/determine-dashboard-id";import type { SdkIframeEmbedSetupModalInitialState } from "metabase/plugins";import { getAdjustedSdkIframeEmbedSetting } from "../utils/get-adjusted-sdk-iframe-embed-setting";@@ -90,6 +88,8 @@ export const useSdkIframeEmbedSettings = ({isSimpleEmbedFeatureAvailable,});+ const exampleDashboardId = useSetting("example-dashboard-id");+const defaultSettings = useMemo(() => {return match(initialState).with(@@ -121,7 +121,11 @@ export const useSdkIframeEmbedSettings = ({.otherwise((initialState) =>getDefaultSdkIframeEmbedSettings({experience: "dashboard",- resourceId: recentDashboards[0]?.id ?? EMBED_FALLBACK_DASHBOARD_ID,+ resourceId: determineDashboardId({+ isRecentsLoading,+ recentDashboards,+ exampleDashboardId,+ }),isSimpleEmbedFeatureAvailable,isGuestEmbedsEnabled,isSsoEnabledAndConfigured,@@ -134,7 +138,9 @@ export const useSdkIframeEmbedSettings = ({isSimpleEmbedFeatureAvailable,isGuestEmbedsEnabled,isSsoEnabledAndConfigured,+ exampleDashboardId,recentDashboards,+ isRecentsLoading,]);const [rawSettings, setRawSettings] = useState<SdkIframeEmbedSetupSettings>();diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/utils/determine-dashboard-id.ts b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/utils/determine-dashboard-id.tsnew file mode 100644index 00000000000..f5d2813d59d--- /dev/null+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/utils/determine-dashboard-id.ts@@ -0,0 +1,18 @@+import { EMBED_FALLBACK_DASHBOARD_ID } from "metabase/embedding/embedding-iframe-sdk-setup/constants";+import type { SdkIframeEmbedSetupRecentItem } from "metabase/embedding/embedding-iframe-sdk-setup/types";+import type { DashboardId } from "metabase-types/api";++export const determineDashboardId = ({+ isRecentsLoading,+ recentDashboards,+ exampleDashboardId,+}: {+ isRecentsLoading: boolean;+ recentDashboards: SdkIframeEmbedSetupRecentItem[];+ exampleDashboardId: DashboardId | null;+}) =>+ isRecentsLoading+ ? null+ : (recentDashboards[0]?.id ??+ exampleDashboardId ??+ EMBED_FALLBACK_DASHBOARD_ID);diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/utils/get-default-sdk-iframe-embed-setting.ts b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/utils/get-default-sdk-iframe-embed-setting.tsindex adcb5b3d828..a415270a69f 100644--- a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/utils/get-default-sdk-iframe-embed-setting.ts+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/utils/get-default-sdk-iframe-embed-setting.ts@@ -27,7 +27,7 @@ export const getDefaultSdkIframeEmbedSettings = ({useExistingUserSession,}: {experience: SdkIframeEmbedSetupExperience;- resourceId: SdkDashboardId | SdkQuestionId;+ resourceId: SdkDashboardId | SdkQuestionId | null;isSimpleEmbedFeatureAvailable: boolean;isGuestEmbedsEnabled: boolean;isSsoEnabledAndConfigured: boolean;diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk/types/embed.ts b/frontend/src/metabase/embedding/embedding-iframe-sdk/types/embed.tsindex 21174f287c6..4e5212fc4f6 100644--- a/frontend/src/metabase/embedding/embedding-iframe-sdk/types/embed.ts+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk/types/embed.ts@@ -68,7 +68,7 @@ export type SdkIframeEmbedReportAnalytics = {// --- Embed Option Interfaces ---export type DashboardEmbedOptions = StrictUnion<- { dashboardId: number | string } | { token: string }+ { dashboardId: number | string | null } | { token: string }> & {componentName: "metabase-dashboard";@@ -87,7 +87,7 @@ export type DashboardEmbedOptions = StrictUnion<};export type QuestionEmbedOptions = StrictUnion<- { questionId: number | string } | { token: string }+ { questionId: number | string | null } | { token: string }> & {componentName: "metabase-question";