Skip to content

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

refactor(embed-js): Refactor EmbedJS wizard to prepare it for No-user embedding (#64411)

Timofey Kachalov1a28ee25c38e
diff --git a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/embed-parameters.cy.spec.ts b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/embed-parameters.cy.spec.ts
index 24ec3b70c06..0bc7bd6714d 100644
--- a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/embed-parameters.cy.spec.ts
+++ b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/embed-parameters.cy.spec.ts
@@ -106,7 +106,7 @@ H.describeWithSnowplow(suiteTitle, () => {
cy.log("both default values should be in the code snippet");
getEmbedSidebar().within(() => {
- cy.findByText("Get Code").click();
+ cy.findByText("Get code").click();
codeBlock().should("contain", "initial-parameters=");
codeBlock().should("contain", '"id":[123]');
codeBlock().should("contain", '"product_id":[456]');
@@ -141,7 +141,7 @@ H.describeWithSnowplow(suiteTitle, () => {
cy.log("code snippet should contain the hidden parameters");
getEmbedSidebar().within(() => {
- cy.findByText("Get Code").click();
+ cy.findByText("Get code").click();
codeBlock().should("contain", "hidden-parameters=");
codeBlock().should("contain", '"id"');
codeBlock().should("contain", '"product_id"');
@@ -203,7 +203,7 @@ H.describeWithSnowplow(suiteTitle, () => {
});
getEmbedSidebar().within(() => {
- cy.findByText("Get Code").click();
+ cy.findByText("Get code").click();
codeBlock().should("contain", "initial-sql-parameters=");
codeBlock().should("not.contain", "hidden-parameters="); // not supported for questions yet
codeBlock().should("contain", '"id":"123"');
diff --git a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/get-code.cy.spec.ts b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/get-code.cy.spec.ts
index 65573659aa4..8c4345a0ea7 100644
--- a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/get-code.cy.spec.ts
+++ b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/get-code.cy.spec.ts
@@ -99,7 +99,7 @@ H.describeWithSnowplow(suiteTitle, () => {
});
getEmbedSidebar().within(() => {
- cy.findByText("Embed Code").should("be.visible");
+ cy.findByText("Embed code").should("be.visible");
codeBlock().should("be.visible");
codeBlock().should("contain", "defineMetabaseConfig");
codeBlock().should("contain", "metabase-dashboard");
@@ -116,7 +116,7 @@ H.describeWithSnowplow(suiteTitle, () => {
cy.findByLabelText("Existing Metabase session").should("be.checked");
codeBlock().should("contain", '"useExistingUserSession": true');
- cy.findByText(/Copy Code/).click();
+ cy.findByText(/Copy code/).click();
H.expectUnstructuredSnowplowEvent({
event: "embed_wizard_code_copied",
@@ -155,7 +155,7 @@ H.describeWithSnowplow(suiteTitle, () => {
cy.findByLabelText("Single sign-on (SSO)").click();
codeBlock().should("not.contain", "useExistingUserSession");
- cy.findByText(/Copy Code/).click();
+ cy.findByText(/Copy code/).click();
H.expectUnstructuredSnowplowEvent({
event: "embed_wizard_code_copied",
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.ts
index 157c5e0f992..cf44f907437 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
@@ -132,7 +132,7 @@ export const navigateToGetCodeStep = (options: NavigateToStepOptions) => {
cy.log("navigate to get code step");
getEmbedSidebar().within(() => {
- cy.findByText("Get Code").click(); // Get code step
+ cy.findByText("Get code").click(); // Get code step
});
};
diff --git a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-options.cy.spec.ts b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-options.cy.spec.ts
index 8e562c856a7..60f3ec815b8 100644
--- a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-options.cy.spec.ts
+++ b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-options.cy.spec.ts
@@ -62,7 +62,7 @@ H.describeWithSnowplow(suiteTitle, () => {
});
cy.log("snippet should be updated");
- getEmbedSidebar().findByText("Get Code").click();
+ getEmbedSidebar().findByText("Get code").click();
H.expectUnstructuredSnowplowEvent({
event: "embed_wizard_options_completed",
@@ -98,7 +98,7 @@ H.describeWithSnowplow(suiteTitle, () => {
.should("be.visible");
cy.log("snippet should be updated");
- getEmbedSidebar().findByText("Get Code").click();
+ getEmbedSidebar().findByText("Get code").click();
H.expectUnstructuredSnowplowEvent({
event: "embed_wizard_options_completed",
@@ -134,7 +134,7 @@ H.describeWithSnowplow(suiteTitle, () => {
.should("not.exist");
cy.log("snippet should be updated");
- getEmbedSidebar().findByText("Get Code").click();
+ getEmbedSidebar().findByText("Get code").click();
H.expectUnstructuredSnowplowEvent({
event: "embed_wizard_options_completed",
@@ -177,7 +177,7 @@ H.describeWithSnowplow(suiteTitle, () => {
getEmbedSidebar().findByLabelText("Allow downloads").should("be.visible");
cy.log("snippet should be updated");
- getEmbedSidebar().findByText("Get Code").click();
+ getEmbedSidebar().findByText("Get code").click();
codeBlock().should("contain", 'drills="false"');
});
@@ -206,7 +206,7 @@ H.describeWithSnowplow(suiteTitle, () => {
.should("be.visible");
cy.log("snippet should be updated");
- getEmbedSidebar().findByText("Get Code").click();
+ getEmbedSidebar().findByText("Get code").click();
H.expectUnstructuredSnowplowEvent({
event: "embed_wizard_options_completed",
@@ -258,7 +258,7 @@ H.describeWithSnowplow(suiteTitle, () => {
.should("not.exist");
cy.log("snippet should be updated");
- getEmbedSidebar().findByText("Get Code").click();
+ getEmbedSidebar().findByText("Get code").click();
codeBlock().should("contain", 'with-title="false"');
cy.log("go back to embed options step");
@@ -319,7 +319,7 @@ H.describeWithSnowplow(suiteTitle, () => {
});
cy.log("snippet should be updated");
- getEmbedSidebar().findByText("Get Code").click();
+ getEmbedSidebar().findByText("Get code").click();
H.expectUnstructuredSnowplowEvent({
event: "embed_wizard_options_completed",
@@ -358,7 +358,7 @@ H.describeWithSnowplow(suiteTitle, () => {
});
cy.log("snippet should be updated");
- getEmbedSidebar().findByText("Get Code").click();
+ getEmbedSidebar().findByText("Get code").click();
H.expectUnstructuredSnowplowEvent({
event: "embed_wizard_options_completed",
@@ -404,7 +404,7 @@ H.describeWithSnowplow(suiteTitle, () => {
getEmbedSidebar().findByLabelText("Reset colors").should("be.visible");
cy.log("snippet should be updated");
- getEmbedSidebar().findByText("Get Code").click();
+ getEmbedSidebar().findByText("Get code").click();
H.expectUnstructuredSnowplowEvent({
event: "embed_wizard_options_completed",
@@ -432,7 +432,7 @@ H.describeWithSnowplow(suiteTitle, () => {
getEmbedSidebar().findByLabelText("Reset colors").should("not.exist");
cy.log("snippet should not contain theme colors");
- getEmbedSidebar().findByText("Get Code").click();
+ getEmbedSidebar().findByText("Get code").click();
codeBlock().should("not.contain", '"theme": {');
H.expectUnstructuredSnowplowEvent({
@@ -471,7 +471,7 @@ H.describeWithSnowplow(suiteTitle, () => {
.should("have.css", "background-color", "rgb(18, 18, 18)");
cy.log("check that derived colors are applied to snippet");
- getEmbedSidebar().findByText("Get Code").click();
+ getEmbedSidebar().findByText("Get code").click();
H.expectUnstructuredSnowplowEvent({
event: "embed_wizard_options_completed",
diff --git a/e2e/test/scenarios/sharing/public-sharing-embed-flow.cy.spec.ts b/e2e/test/scenarios/sharing/public-sharing-embed-flow.cy.spec.ts
index f67ca711d44..fb194889477 100644
--- a/e2e/test/scenarios/sharing/public-sharing-embed-flow.cy.spec.ts
+++ b/e2e/test/scenarios/sharing/public-sharing-embed-flow.cy.spec.ts
@@ -51,7 +51,7 @@ H.describeWithSnowplow(suiteTitle, () => {
.findByText("Orders in a dashboard", { timeout: 10_000 })
.should("be.visible");
- getEmbedSidebar().findByText("Get Code").click();
+ getEmbedSidebar().findByText("Get code").click();
H.expectUnstructuredSnowplowEvent({
event: "embed_wizard_options_completed",
@@ -87,7 +87,7 @@ H.describeWithSnowplow(suiteTitle, () => {
.findByText("Orders", { timeout: 10_000 })
.should("be.visible");
- getEmbedSidebar().findByText("Get Code").click();
+ getEmbedSidebar().findByText("Get code").click();
H.expectUnstructuredSnowplowEvent({
event: "embed_wizard_options_completed",
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/constants.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/constants.ts
index c1683a45f32..7519948dea5 100644
--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/constants.ts
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/constants.ts
@@ -39,6 +39,7 @@ export const ALLOWED_EMBED_SETTING_KEYS_MAP = {
"withTitle",
"withDownloads",
"initialSqlParameters",
+ "hiddenParameters",
"drills",
"entityTypes",
] satisfies (keyof QuestionEmbedOptions)[],
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/embed.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/embed.ts
index c6cf0e28b86..948ebdc1793 100644
--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/embed.ts
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/embed.ts
@@ -548,6 +548,7 @@ const MetabaseQuestionElement = createCustomElement("metabase-question", [
"with-downloads",
"drills",
"initial-sql-parameters",
+ "hidden-parameters",
"is-save-enabled",
"target-collection",
"entity-types",
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/types/embed.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/types/embed.ts
index 64980637bec..22bea67e178 100644
--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/types/embed.ts
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/types/embed.ts
@@ -80,6 +80,7 @@ export interface QuestionEmbedOptions {
// parameters
initialSqlParameters?: SqlParameterValues;
+ hiddenParameters?: string[];
// incompatible options
template?: never;
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/analytics.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/analytics.ts
index b041a3eec7d..6ab0a3148d1 100644
--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/analytics.ts
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/analytics.ts
@@ -13,7 +13,7 @@ import type {
import {
getDefaultSdkIframeEmbedSettings,
getResourceIdFromSettings,
-} from "./utils/default-embed-setting";
+} from "./utils/get-default-sdk-iframe-embed-setting";
/**
* Tracking every embed settings would bloat Snowplow, so we only track
@@ -71,7 +71,10 @@ export const trackEmbedWizardOptionsCompleted = (
experience: SdkIframeEmbedSetupExperience,
) => {
// Get defaults for this experience type (with a dummy resource ID)
- const defaultSettings = getDefaultSdkIframeEmbedSettings(experience, 0);
+ const defaultSettings = getDefaultSdkIframeEmbedSettings({
+ experience,
+ resourceId: 0,
+ });
// Does the embed settings diverge from the experience defaults?
const hasCustomOptions = !_.isEqual(
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/EmbedPreviewLoadingOverlay.tsx b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/EmbedPreviewLoadingOverlay.tsx
index e67ffac51a9..9b219042cad 100644
--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/EmbedPreviewLoadingOverlay.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/EmbedPreviewLoadingOverlay.tsx
@@ -6,15 +6,17 @@ import { Box, Center, Loader } from "metabase/ui";
**/
export const EmbedPreviewLoadingOverlay = ({
isVisible,
+ bg,
}: {
isVisible: boolean;
+ bg?: string;
}) => {
if (!isVisible) {
return null;
}
return (
- <Box pos="absolute" bg="var(--mb-color-bg-white)" inset={0}>
+ <Box pos="absolute" bg={bg ?? "var(--mb-color-bg-white)"} inset={0}>
<Center h="100%" w="100%" mx="auto">
<Loader data-testid="preview-loading-indicator" />
</Center>
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/GetCodeStep.tsx b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/GetCodeStep.tsx
index 2e93a1e2e60..2a429574240 100644
--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/GetCodeStep.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/GetCodeStep.tsx
@@ -115,7 +115,7 @@ export const GetCodeStep = () => {
<Card p="md">
<Text size="lg" fw="bold" mb="md">
- {t`Embed Code`}
+ {t`Embed code`}
</Text>
<Stack gap="sm">
@@ -137,7 +137,7 @@ export const GetCodeStep = () => {
handleCodeSnippetCopied();
}}
>
- {copied ? t`Copied!` : t`Copy Code`}
+ {copied ? t`Copied!` : t`Copy code`}
</Button>
)}
</CopyButton>
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/ParameterSettings/ParameterSettings.tsx b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/ParameterSettings/ParameterSettings.tsx
index bdac6a41b38..bee3d0c20fe 100644
--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/ParameterSettings/ParameterSettings.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/ParameterSettings/ParameterSettings.tsx
@@ -1,6 +1,5 @@
import { useDebouncedCallback } from "@mantine/hooks";
import { useCallback, useMemo } from "react";
-import { P, match } from "ts-pattern";
import { t } from "ttag";
import CS from "metabase/css/core/index.css";
@@ -16,51 +15,39 @@ import { useSdkIframeEmbedSetupContext } from "../../context";
import { ParameterVisibilityToggle } from "./ParameterVisibilityToggle";
import { useHideParameter } from "./hooks/use-hide-parameter";
-function mapValuesBySlugToById(
- valuesBySlug: Record<string, any> | undefined,
- params: { id: string; slug: string }[],
-) {
- if (!valuesBySlug) {
- return {};
- }
-
- return params.reduce<Record<string, any>>((byId, param) => {
- if (param.slug in valuesBySlug) {
- byId[param.id] = valuesBySlug[param.slug];
- }
- return byId;
- }, {});
-}
-
export const ParameterSettings = () => {
const {
experience,
settings,
updateSettings,
availableParameters,
- isLoadingParameters,
+ parameterValuesById,
+ isLoading,
} = useSdkIframeEmbedSetupContext();
- const { isParameterHidden, toggleParameterVisibility } = useHideParameter();
+ const { isParameterHidden, toggleParameterVisibility } = useHideParameter({
+ settings,
+ updateSettings,
+ });
const isQuestionOrDashboardEmbed =
!!settings.questionId || !!settings.dashboardId;
const updateInitialParameterValue = useDebouncedCallback(
useCallback(
- (paramId: string, value: ParameterValueOrArray | null | undefined) => {
+ (slug: string, value: ParameterValueOrArray | null | undefined) => {
if (settings.dashboardId) {
updateSettings({
initialParameters: {
...settings.initialParameters,
- [paramId]: value,
+ [slug]: value,
},
});
} else if (settings.questionId) {
updateSettings({
initialSqlParameters: {
...settings.initialSqlParameters,
- [paramId]: value,
+ [slug]: value,
},
});
}
@@ -70,22 +57,6 @@ export const ParameterSettings = () => {
SET_INITIAL_PARAMETER_DEBOUNCE_MS,
);
- /**
- * Widgets (and most of metabase logic) expect parameter values keyed by
- * **parameter.id**, but in the embed flow settings we store them by
- * **parameter.slug**, as the public API of embeds wants them by slug
- *
- * Here we convert them to "by-id" to make widgets work properly.
- */
- const parameterValuesById = useMemo(() => {
- const valuesBySlug = match(settings)
- .with({ dashboardId: P.nonNullable }, (s) => s.initialParameters)
- .with({ questionId: P.nonNullable }, (s) => s.initialSqlParameters)
- .otherwise(() => ({}));
-
- return mapValuesBySlugToById(valuesBySlug, availableParameters);
- }, [settings, availableParameters]);
-
const uiParameters = useMemo(
() =>
getValuePopulatedParameters({
@@ -101,7 +72,7 @@ export const ParameterSettings = () => {
return null;
}
- if (isLoadingParameters) {
+ if (isLoading) {
return (
<Text size="sm" c="text-medium">
{t`Loading parameters...`}
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/ParameterSettings/ParameterVisibilityToggle.tsx b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/ParameterSettings/ParameterVisibilityToggle.tsx
index 1f62ec5d3de..f43c6dcd725 100644
--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/ParameterSettings/ParameterVisibilityToggle.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/ParameterSettings/ParameterVisibilityToggle.tsx
@@ -17,7 +17,7 @@ export const ParameterVisibilityToggle = ({
isHidden,
onToggle,
}: ParameterVisibilityToggleProps) => {
- // Only show toggle for dashboards, as question parameters cannot be hidden.
+ // Only show toggle for dashboards at the moment
if (experience !== "dashboard") {
return null;
}
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/ParameterSettings/hooks/use-hide-parameter.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/ParameterSettings/hooks/use-hide-parameter.ts
index 9dc1e07d49f..98316e980b3 100644
--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/ParameterSettings/hooks/use-hide-parameter.ts
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/ParameterSettings/hooks/use-hide-parameter.ts
@@ -1,33 +1,38 @@
-import { useSdkIframeEmbedSetupContext } from "../../../context";
-
-export function useHideParameter() {
- const { settings, updateSettings } = useSdkIframeEmbedSetupContext();
-
- const toggleParameterVisibility = (parameterName: string) => {
- // Dashboard parameters are shown by default and can be hidden,
- // while question parameters are always hidden in the SDK and cannot be shown.
- if (!settings.dashboardId) {
- return;
- }
-
- const hiddenParameters = settings?.hiddenParameters ?? [];
-
- const nextHiddenParameters = hiddenParameters.includes(parameterName)
- ? hiddenParameters.filter((name) => name !== parameterName)
- : [...hiddenParameters, parameterName];
-
- updateSettings({ hiddenParameters: nextHiddenParameters });
- };
-
- const isParameterHidden = (parameterName: string) => {
- // Dashboard parameters are shown by default and can be hidden,
- // while question parameters are always hidden in the SDK and cannot be shown.
- if (!settings.dashboardId) {
- return true;
- }
-
- return (settings.hiddenParameters ?? []).includes(parameterName);
- };
+import { useCallback } from "react";
+
+import type { SdkIframeEmbedSetupContextType } from "metabase-enterprise/embedding_iframe_sdk_setup/context";
+
+export function useHideParameter({
+ settings,
+ updateSettings,
+}: Pick<SdkIframeEmbedSetupContextType, "settings" | "updateSettings">) {
+ const toggleParameterVisibility = useCallback(
+ (parameterName: string) => {
+ if (!settings.dashboardId && !settings.questionId) {
+ return;
+ }
+
+ const hiddenParameters = settings?.hiddenParameters ?? [];
+
+ const nextHiddenParameters = hiddenParameters.includes(parameterName)
+ ? hiddenParameters.filter((name) => name !== parameterName)
+ : [...hiddenParameters, parameterName];
+
+ updateSettings({ hiddenParameters: nextHiddenParameters });
+ },
+ [settings, updateSettings],
+ );
+
+ const isParameterHidden = useCallback(
+ (parameterName: string) => {
+ if (!settings.dashboardId && !settings.questionId) {
+ return true;
+ }
+
+ return (settings.hiddenParameters ?? []).includes(parameterName);
+ },
+ [settings],
+ );
return {
isParameterHidden,
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SdkIframeEmbedPreview.tsx b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SdkIframeEmbedPreview.tsx
index 758cd1eeae6..c227aa6727f 100644
--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SdkIframeEmbedPreview.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SdkIframeEmbedPreview.tsx
@@ -84,9 +84,9 @@ export const SdkIframeEmbedPreview = () => {
const metabaseConfig = useMemo(
() => ({
instanceUrl,
- useExistingUserSession: true,
theme: derivedTheme,
...(localeOverride ? { locale: localeOverride } : {}),
+ useExistingUserSession: true,
}),
[instanceUrl, localeOverride, derivedTheme],
);
@@ -153,14 +153,17 @@ export const SdkIframeEmbedPreview = () => {
drills: s.drills,
"with-title": s.withTitle,
"with-downloads": s.withDownloads,
- "initial-sql-parameters": s.initialSqlParameters
- ? JSON.stringify(s.initialSqlParameters)
- : undefined,
"is-save-enabled": s.isSaveEnabled,
"target-collection": s.targetCollection,
"entity-types": s.entityTypes
? JSON.stringify(s.entityTypes)
: undefined,
+ "initial-sql-parameters": s.initialSqlParameters
+ ? JSON.stringify(s.initialSqlParameters)
+ : undefined,
+ "hidden-parameters": s.hiddenParameters
+ ? JSON.stringify(s.hiddenParameters)
+ : undefined,
}),
)
.with({ componentName: "metabase-dashboard" }, (s) =>
@@ -190,7 +193,10 @@ export const SdkIframeEmbedPreview = () => {
.with({ componentName: "metabase-metabot" }, () => null)
.exhaustive()}
- <EmbedPreviewLoadingOverlay isVisible={isLoading} />
+ <EmbedPreviewLoadingOverlay
+ isVisible={isLoading}
+ bg={settings.theme?.colors?.background}
+ />
</Card>
);
};
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SdkIframeEmbedSetup.tsx b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SdkIframeEmbedSetup.tsx
index a70ef552701..4398077f3c2 100644
--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SdkIframeEmbedSetup.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SdkIframeEmbedSetup.tsx
@@ -27,7 +27,7 @@ import { SdkIframeEmbedPreview } from "./SdkIframeEmbedPreview";
import S from "./SdkIframeEmbedSetup.module.css";
import { SdkIframeEmbedSetupProvider } from "./SdkIframeEmbedSetupProvider";
-const SdkIframeEmbedSetupContent = () => {
+export const SdkIframeEmbedSetupContent = () => {
const [updateSettings] = useUpdateSettingsMutation();
const { currentStep, settings } = useSdkIframeEmbedSetupContext();
@@ -59,7 +59,7 @@ const SdkIframeEmbedSetupContent = () => {
))
.with("select-embed-options", () => (
<Button variant="filled" onClick={handleNext}>
- {t`Get Code`}
+ {t`Get code`}
</Button>
))
.otherwise(() => (
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SdkIframeEmbedSetupProvider.tsx b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SdkIframeEmbedSetupProvider.tsx
index 61ca24d083e..865bca276f4 100644
--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SdkIframeEmbedSetupProvider.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SdkIframeEmbedSetupProvider.tsx
@@ -1,36 +1,24 @@
-import {
- type ReactNode,
- useCallback,
- useEffect,
- useMemo,
- useState,
-} from "react";
+import { type ReactNode, useMemo, useState } from "react";
import { useLocation } from "react-use";
-import { P, match } from "ts-pattern";
-import _ from "underscore";
import { useSearchQuery } from "metabase/api";
-import { useUserSetting } from "metabase/common/hooks";
-import { trackEmbedWizardOpened } from "../analytics";
-import {
- EMBED_FALLBACK_DASHBOARD_ID,
- USER_SETTINGS_DEBOUNCE_MS,
-} from "../constants";
import {
SdkIframeEmbedSetupContext,
type SdkIframeEmbedSetupContextType,
} from "../context";
-import { useParameterList, useRecentItems } from "../hooks";
+import {
+ useGetCurrentResource,
+ useParameters,
+ useParametersValues,
+ useRecentItems,
+} from "../hooks";
+import { useSdkIframeEmbedSettings } from "../hooks/use-sdk-iframe-embed-settings";
import type {
- SdkIframeEmbedSetupSettings,
SdkIframeEmbedSetupStep,
+ SdkIframeEmbedSetupUrlParams,
} from "../types";
-import {
- getDefaultSdkIframeEmbedSettings,
- getExperienceFromSettings,
- getResourceIdFromSettings,
-} from "../utils/default-embed-setting";
+import { getExperienceFromSettings } from "../utils/get-default-sdk-iframe-embed-setting";
interface SdkIframeEmbedSetupProviderProps {
children: ReactNode;
@@ -40,11 +28,6 @@ export const SdkIframeEmbedSetupProvider = ({
children,
}: SdkIframeEmbedSetupProviderProps) => {
const location = useLocation();
- const [isEmbedSettingsLoaded, setEmbedSettingsLoaded] = useState(false);
-
- const [rawSettings, setRawSettings] = useState<SdkIframeEmbedSetupSettings>();
-
- const [persistedSettings, persistSettings] = usePersistedSettings();
// We don't want to re-fetch the recent items every time we switch between
// steps, therefore we load recent items once in the provider.
@@ -65,7 +48,7 @@ export const SdkIframeEmbedSetupProvider = ({
// EmbeddingHub passes `auth_method`.
// EmbedContentModal passes `resource_type` and `resource_id`.
- const urlParams = useMemo(() => {
+ const urlParams: SdkIframeEmbedSetupUrlParams = useMemo(() => {
const params = new URLSearchParams(location.search);
return {
@@ -75,22 +58,6 @@ export const SdkIframeEmbedSetupProvider = ({
};
}, [location.search]);
- const defaultSettings = useMemo(() => {
- return match([urlParams.resourceType, urlParams.resourceId])
- .with(["dashboard", P.nonNullable], ([, id]) =>
- getDefaultSdkIframeEmbedSettings("dashboard", id),
- )
- .with(["question", P.nonNullable], ([, id]) =>
- getDefaultSdkIframeEmbedSettings("chart", id),
- )
- .otherwise(() =>
- getDefaultSdkIframeEmbedSettings(
- "dashboard",
- recentDashboards[0]?.id ?? EMBED_FALLBACK_DASHBOARD_ID,
- ),
- );
- }, [recentDashboards, urlParams]);
-
// Default to the embed options step if both resource type and id are provided.
// This is to skip the experience and resource selection steps as we know both.
const defaultStep: SdkIframeEmbedSetupStep = useMemo(() => {
@@ -104,25 +71,18 @@ export const SdkIframeEmbedSetupProvider = ({
const [currentStep, setCurrentStep] =
useState<SdkIframeEmbedSetupStep>(defaultStep);
- const settings = useMemo(() => {
- const latestSettings = rawSettings ?? defaultSettings;
-
- // Append entity-types=model if there are more than 2 models in the instance.
- if (modelCount > 2) {
- return match(latestSettings)
- .with({ componentName: "metabase-question" }, (settings) => ({
- ...settings,
- entityTypes: ["model" as const],
- }))
- .with({ componentName: "metabase-browser" }, (settings) => ({
- ...settings,
- dataPickerEntityTypes: ["model" as const],
- }))
- .otherwise((settings) => settings);
- }
-
- return latestSettings;
- }, [defaultSettings, modelCount, rawSettings]);
+ const {
+ settings,
+ defaultSettings,
+ isEmbedSettingsLoaded,
+ replaceSettings,
+ updateSettings,
+ } = useSdkIframeEmbedSettings({
+ urlParams,
+ recentDashboards,
+ isRecentsLoading,
+ modelCount,
+ });
// Which embed experience are we setting up?
const experience = useMemo(
@@ -130,53 +90,31 @@ export const SdkIframeEmbedSetupProvider = ({
[settings],
);
- // Use parameter list hook for dynamic parameter loading
- const { availableParameters, isLoadingParameters } = useParameterList({
+ const { resource, isError, isLoading, isFetching } = useGetCurrentResource({
experience,
-
- // We're always using numeric IDs for previews.
- ...(settings.dashboardId && {
- dashboardId: settings.dashboardId as number,
- }),
-
- ...(settings.questionId && {
- questionId: Number(settings.questionId),
- }),
+ settings,
});
- const updateSettings = useCallback(
- (nextSettings: Partial<SdkIframeEmbedSetupSettings>) =>
- setRawSettings((prev) => {
- // Merging with a partial setting requires us to cast the type
- const mergedSettings = {
- ...(prev ?? defaultSettings),
- ...nextSettings,
- } as SdkIframeEmbedSetupSettings;
-
- persistSettings(mergedSettings);
-
- return mergedSettings;
- }),
- [defaultSettings, persistSettings],
- );
+ const { availableParameters } = useParameters({
+ experience,
+ resource,
+ });
- const replaceSettings = useCallback(
- (nextSettings: SdkIframeEmbedSetupSettings) => {
- setRawSettings(nextSettings);
- persistSettings(nextSettings);
- },
- [persistSettings],
- );
+ const { parametersValuesById } = useParametersValues({
+ settings,
+ availableParameters,
+ });
const value: SdkIframeEmbedSetupContextType = {
currentStep,
setCurrentStep,
experience,
+ resource,
+ isError,
+ isLoading,
+ isFetching,
settings,
- defaultSettings: {
- resourceId: getResourceIdFromSettings(defaultSettings) ?? "",
- experience: getExperienceFromSettings(defaultSettings),
- },
+ defaultSettings,
replaceSettings,
updateSettings,
recentDashboards,
@@ -184,67 +122,13 @@ export const SdkIframeEmbedSetupProvider = ({
recentCollections,
addRecentItem,
isEmbedSettingsLoaded,
- isLoadingParameters,
availableParameters,
+ parameterValuesById: parametersValuesById,
};
- // Once the persisted settings are loaded, check if they are valid.
- // If they are, set them as the current settings.
- useEffect(() => {
- if (!isEmbedSettingsLoaded && !isRecentsLoading) {
- setRawSettings({
- ...settings,
- ...persistedSettings,
-
- // Override the persisted settings if `auth_method` is specified.
- // This is used for Embedding Hub.
- ...(urlParams.authMethod !== null && {
- useExistingUserSession: urlParams.authMethod === "user_session",
- }),
- });
-
- setEmbedSettingsLoaded(true);
-
- trackEmbedWizardOpened();
- }
- }, [
- persistedSettings,
- isEmbedSettingsLoaded,
- settings,
- isRecentsLoading,
- urlParams,
- ]);
-
return (
<SdkIframeEmbedSetupContext.Provider value={value}>
{children}
</SdkIframeEmbedSetupContext.Provider>
);
};
-
-const getSettingsToPersist = (
- settings: Partial<SdkIframeEmbedSetupSettings>,
-) => {
- return _.pick(settings, ["theme", "useExistingUserSession"]);
-};
-
-const usePersistedSettings = () => {
- const [rawPersisted, rawPersistSettings] = useUserSetting(
- "sdk-iframe-embed-setup-settings",
- { debounceTimeout: USER_SETTINGS_DEBOUNCE_MS },
- );
-
- const persistedSettings = useMemo(
- () => getSettingsToPersist(rawPersisted || {}),
- [rawPersisted],
- );
-
- const persistSettings = useCallback(
- (settings: Partial<SdkIframeEmbedSetupSettings>) => {
- rawPersistSettings(getSettingsToPersist(settings));
- },
- [rawPersistSettings],
- );
-
- return [persistedSettings, persistSettings] as const;
-};
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SelectEmbedExperienceStep.tsx b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SelectEmbedExperienceStep.tsx
index f8ddc1a10f0..5544af2f361 100644
--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SelectEmbedExperienceStep.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SelectEmbedExperienceStep.tsx
@@ -15,7 +15,7 @@ import {
} from "../constants";
import { useSdkIframeEmbedSetupContext } from "../context";
import type { SdkIframeEmbedSetupExperience } from "../types";
-import { getDefaultSdkIframeEmbedSettings } from "../utils/default-embed-setting";
+import { getDefaultSdkIframeEmbedSettings } from "../utils/get-default-sdk-iframe-embed-setting";
import { EnableEmbeddedAnalyticsCard } from "./EnableEmbeddedAnalyticsCard";
@@ -55,7 +55,10 @@ export const SelectEmbedExperienceStep = () => {
...persistedSettings,
// these settings are overridden when the embed type changes
- ...getDefaultSdkIframeEmbedSettings(experience, defaultResourceId),
+ ...getDefaultSdkIframeEmbedSettings({
+ experience,
+ resourceId: defaultResourceId,
+ }),
});
};
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SelectEmbedResourceStep.tsx b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SelectEmbedResourceStep.tsx
index 1ed556fcd9f..c5a0d09ab2c 100644
--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SelectEmbedResourceStep.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SelectEmbedResourceStep.tsx
@@ -14,7 +14,7 @@ import type {
SdkIframeEmbedSetupRecentItem,
SdkIframeEmbedSetupRecentItemType,
} from "../types";
-import { getResourceIdFromSettings } from "../utils/default-embed-setting";
+import { getResourceIdFromSettings } from "../utils/get-default-sdk-iframe-embed-setting";
import { SelectEmbedResourceMissingRecents } from "./SelectEmbedResourceMissingRecents";
import { SelectEmbedResourceRecentItemCard } from "./SelectEmbedResourceRecentItemCard";
@@ -74,6 +74,7 @@ export const SelectEmbedResourceStep = () => {
// Clear parameters
initialSqlParameters: {},
+ hiddenParameters: [],
});
} else if (experience === "browser") {
updateSettings({
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/tests/SdkIframeEmbedSetup-embedding-hub.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/tests/SdkIframeEmbedSetup-embedding-hub.unit.spec.tsx
index a35152ad39b..f46185ab5e5 100644
--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/tests/SdkIframeEmbedSetup-embedding-hub.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/tests/SdkIframeEmbedSetup-embedding-hub.unit.spec.tsx
@@ -28,7 +28,7 @@ describe("Embed flow > embedding hub step completion tracking", () => {
await userEvent.click(screen.getByRole("button", { name: "Next" }));
await userEvent.click(screen.getByRole("button", { name: "Next" }));
- await userEvent.click(screen.getByRole("button", { name: "Get Code" }));
+ await userEvent.click(screen.getByRole("button", { name: "Get code" }));
const authRadio = screen.getByDisplayValue(
authMethod === "user_session" ? "user-session" : "sso",
@@ -38,7 +38,7 @@ describe("Embed flow > embedding hub step completion tracking", () => {
expect(authRadio).toBeChecked();
const actionButton = screen.getByRole("button", {
- name: trigger === "copy" ? /Copy Code/ : /Done/,
+ name: trigger === "copy" ? /Copy code/ : /Done/,
});
await userEvent.click(actionButton);
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/tests/SdkIframeEmbedSetup.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/tests/SdkIframeEmbedSetup.unit.spec.tsx
index c1ef542ba40..24ff4287816 100644
--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/tests/SdkIframeEmbedSetup.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/tests/SdkIframeEmbedSetup.unit.spec.tsx
@@ -37,10 +37,10 @@ describe("Embed flow > forward and backward navigation", () => {
expect(screen.getByText("Behavior")).toBeInTheDocument();
expect(screen.getByText("Appearance")).toBeInTheDocument();
expect(
- screen.getByRole("button", { name: "Get Code" }),
+ screen.getByRole("button", { name: "Get code" }),
).toBeInTheDocument();
- await userEvent.click(screen.getByRole("button", { name: "Get Code" }));
+ await userEvent.click(screen.getByRole("button", { name: "Get code" }));
expect(
screen.getByText("Choose the authentication method for embedding:"),
).toBeInTheDocument();
@@ -48,7 +48,7 @@ describe("Embed flow > forward and backward navigation", () => {
screen.queryByRole("button", { name: "Next" }),
).not.toBeInTheDocument();
expect(
- screen.queryByRole("button", { name: "Get Code" }),
+ screen.queryByRole("button", { name: "Get code" }),
).not.toBeInTheDocument();
});
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/context.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/context.ts
index 24e7d81b686..4cefe989a87 100644
--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/context.ts
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/context.ts
@@ -1,6 +1,7 @@
import { createContext, useContext } from "react";
-import type { Parameter } from "metabase-types/api";
+import type { EmbeddingParametersValues } from "metabase/public/lib/types";
+import type { Card, Dashboard, Parameter } from "metabase-types/api";
import type {
SdkIframeEmbedSetupExperience,
@@ -17,6 +18,12 @@ export interface SdkIframeEmbedSetupContextType {
experience: SdkIframeEmbedSetupExperience;
+ // Loaded resources
+ resource: Dashboard | Card | null;
+ isError: boolean;
+ isLoading: boolean;
+ isFetching: boolean;
+
// Embed settings
settings: SdkIframeEmbedSetupSettings;
defaultSettings: {
@@ -37,7 +44,7 @@ export interface SdkIframeEmbedSetupContextType {
// Parameters for dashboards and questions
availableParameters: Parameter[];
- isLoadingParameters: boolean;
+ parameterValuesById: EmbeddingParametersValues;
isEmbedSettingsLoaded: boolean;
}
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/hooks/index.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/hooks/index.ts
index e0159650d39..c1227e0acda 100644
--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/hooks/index.ts
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/hooks/index.ts
@@ -1,3 +1,6 @@
-export { useSdkIframeEmbedNavigation } from "./use-sdk-iframe-embed-navigation";
+export { useGetCurrentResource } from "./use-get-current-resource";
export { useRecentItems } from "./use-recent-items";
-export { useParameterList } from "./use-parameter-list";
+export { useParameters } from "./use-parameters";
+export { useParametersValues } from "./use-parameters-values";
+export { useSdkIframeEmbedSnippet } from "./use-sdk-iframe-embed-snippet";
+export { useSdkIframeEmbedNavigation } from "./use-sdk-iframe-embed-navigation";
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/hooks/use-get-current-resource.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/hooks/use-get-current-resource.ts
new file mode 100644
index 00000000000..bac8801b912
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/hooks/use-get-current-resource.ts
@@ -0,0 +1,83 @@
+import { useAsync } from "react-use";
+
+import { skipToken, useGetCardQuery } from "metabase/api";
+import { fetchDashboard } from "metabase/dashboard/actions";
+import { getDashboardComplete } from "metabase/dashboard/selectors";
+import { useDispatch, useSelector } from "metabase/lib/redux";
+import type {
+ SdkIframeEmbedSetupExperience,
+ SdkIframeEmbedSetupSettings,
+} from "metabase-enterprise/embedding_iframe_sdk_setup/types";
+import type { Card, Dashboard } from "metabase-types/api";
+
+const getResource = ({
+ experience,
+ dashboard,
+ card,
+}: {
+ experience: SdkIframeEmbedSetupExperience;
+ dashboard: Dashboard | null | undefined;
+ card: Card | null | undefined;
+}) => {
+ if (experience === "dashboard" && dashboard) {
+ return dashboard;
+ }
+
+ if (experience === "chart" && card) {
+ return card;
+ }
+
+ return null;
+};
+
+export const useGetCurrentResource = ({
+ experience,
+ settings,
+}: {
+ experience: SdkIframeEmbedSetupExperience;
+ settings: SdkIframeEmbedSetupSettings;
+}) => {
+ const dispatch = useDispatch();
+
+ const { loading: isDashboardLoading, error: dashboardLoadingError } =
+ useAsync(async () => {
+ if (!settings.dashboardId) {
+ return;
+ }
+
+ await dispatch(
+ fetchDashboard({
+ dashId: settings.dashboardId as number,
+ queryParams: {},
+ }),
+ );
+ }, [settings.dashboardId, dispatch]);
+ const dashboard = useSelector(getDashboardComplete);
+
+ const {
+ data: card,
+ error: cardLoadingError,
+ isLoading: isCardLoading,
+ isFetching: isCardFetching,
+ } = useGetCardQuery(
+ settings.questionId ? { id: settings.questionId as number } : skipToken,
+ );
+
+ const isLoading = isDashboardLoading || isCardLoading;
+ const isFetching = isCardFetching;
+
+ const resource = getResource({
+ experience,
+ dashboard,
+ card,
+ });
+
+ const isError = !!dashboardLoadingError || !!cardLoadingError;
+
+ return {
+ resource,
+ isError,
+ isLoading,
+ isFetching,
+ };
+};
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/hooks/use-parameters-values.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/hooks/use-parameters-values.ts
new file mode 100644
index 00000000000..f0bf56db7b1
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/hooks/use-parameters-values.ts
@@ -0,0 +1,38 @@
+import { useMemo } from "react";
+import { P, match } from "ts-pattern";
+
+import type { EmbeddingParametersValues } from "metabase/public/lib/types";
+import type { SdkIframeEmbedSetupSettings } from "metabase-enterprise/embedding_iframe_sdk_setup/types";
+import { convertParameterValuesBySlugToById } from "metabase-enterprise/embedding_iframe_sdk_setup/utils/convert-parameter-values-by-slug-to-by-id";
+import type { Parameter } from "metabase-types/api";
+
+export const useParametersValues = ({
+ settings,
+ availableParameters,
+}: {
+ settings: SdkIframeEmbedSetupSettings;
+ availableParameters: Parameter[];
+}) => {
+ /**
+ * Widgets (and most of metabase logic) expect parameter values keyed by
+ * **parameter.id**, but in the embed flow settings we store them by
+ * **parameter.slug**, as the public API of embeds wants them by slug
+ *
+ * Here we convert them to "by-id" to make widgets work properly.
+ */
+ const parametersValuesById: EmbeddingParametersValues = useMemo(() => {
+ const valuesBySlug = match(settings)
+ .with({ dashboardId: P.nonNullable }, (s) => s.initialParameters ?? {})
+ .with({ questionId: P.nonNullable }, (s) => s.initialSqlParameters ?? {})
+ .otherwise(() => ({}));
+
+ return convertParameterValuesBySlugToById(
+ valuesBySlug,
+ availableParameters,
+ );
+ }, [availableParameters, settings]);
+
+ return {
+ parametersValuesById,
+ };
+};
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/hooks/use-parameter-list.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/hooks/use-parameters.ts
similarity index 53%
rename from enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/hooks/use-parameter-list.ts
rename to enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/hooks/use-parameters.ts
index 688de2afce2..98594e09dfd 100644
--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/hooks/use-parameter-list.ts
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/hooks/use-parameters.ts
@@ -1,36 +1,24 @@
import { useEffect, useMemo } from "react";
import { useLatest } from "react-use";
-import { skipToken, useGetCardQuery, useGetDashboardQuery } from "metabase/api";
import { useDispatch, useSelector } from "metabase/lib/redux";
import { getSavedDashboardUiParameters } from "metabase/parameters/utils/dashboards";
import { addFields } from "metabase/redux/metadata";
import { getMetadata } from "metabase/selectors/metadata";
+import type { SdkIframeEmbedSetupExperience } from "metabase-enterprise/embedding_iframe_sdk_setup/types";
import { getCardUiParameters } from "metabase-lib/v1/parameters/utils/cards";
-import type { Card, Parameter } from "metabase-types/api";
+import type { Card, Dashboard, Parameter } from "metabase-types/api";
-import type { SdkIframeEmbedSetupExperience } from "../types";
-
-interface UseParameterListProps {
+type UseParameterListProps = {
experience: SdkIframeEmbedSetupExperience;
- dashboardId?: number;
- questionId?: number;
-}
+ resource: Dashboard | Card | null;
+};
-export const useParameterList = ({
+export const useParameters = ({
experience,
- dashboardId,
- questionId,
+ resource,
}: UseParameterListProps) => {
const dispatch = useDispatch();
- // Fetch dashboard/question data for parameter extraction
- const { data: dashboard, isLoading: isDashboardLoading } =
- useGetDashboardQuery(dashboardId ? { id: dashboardId } : skipToken);
-
- const { data: card, isLoading: isCardLoading } = useGetCardQuery(
- questionId ? { id: questionId as number } : skipToken,
- );
-
const metadata = useSelector(getMetadata);
// This prevents `availableParameters` from being updated on every metadata change,
@@ -40,34 +28,35 @@ export const useParameterList = ({
// Extract parameters from the loaded dashboard/card
const availableParameters = useMemo((): Parameter[] => {
- if (experience === "dashboard" && dashboard) {
+ if (!resource) {
+ return [];
+ }
+
+ if (experience === "dashboard") {
+ const dashboard = resource as Dashboard;
return getSavedDashboardUiParameters(
dashboard.dashcards,
dashboard.parameters,
dashboard.param_fields,
metadata,
);
- } else if (experience === "chart" && card) {
- return getCardUiParameters(card as Card, metadataRef.current) || [];
+ } else if (experience === "chart") {
+ const card = resource as Card;
+ return getCardUiParameters(card, metadataRef.current) || [];
}
return [];
- }, [experience, dashboard, card, metadata, metadataRef]);
+ }, [resource, experience, metadata, metadataRef]);
useEffect(() => {
- if (dashboard?.param_fields) {
+ if (resource && "param_fields" in resource && resource.param_fields) {
// This is needed to make some parameter widget populate the dropdown list
// otherwise they will use a normal text input
- dispatch(addFields(Object.values(dashboard.param_fields).flat()));
+ dispatch(addFields(Object.values(resource.param_fields).flat()));
}
- }, [dashboard?.param_fields, dispatch]);
-
- const isLoadingParameters = isDashboardLoading || isCardLoading;
+ }, [resource, dispatch]);
return {
availableParameters,
- isLoadingParameters,
- dashboard,
- card,
};
};
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/hooks/use-sdk-iframe-embed-settings.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/hooks/use-sdk-iframe-embed-settings.ts
new file mode 100644
index 00000000000..81cb0823ab5
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/hooks/use-sdk-iframe-embed-settings.ts
@@ -0,0 +1,169 @@
+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-enterprise/embedding_iframe_sdk_setup/constants";
+import type {
+ SdkIframeEmbedSetupRecentItem,
+ SdkIframeEmbedSetupSettings,
+ SdkIframeEmbedSetupUrlParams,
+} from "metabase-enterprise/embedding_iframe_sdk_setup/types";
+
+import { trackEmbedWizardOpened } from "../analytics";
+import {
+ getDefaultSdkIframeEmbedSettings,
+ getExperienceFromSettings,
+ getResourceIdFromSettings,
+} from "../utils/get-default-sdk-iframe-embed-setting";
+
+const getSettingsToPersist = (
+ settings: Partial<SdkIframeEmbedSetupSettings>,
+) => {
+ return _.pick(settings, ["theme", "useExistingUserSession"]);
+};
+
+const usePersistedSettings = () => {
+ const [rawPersisted, rawPersistSettings] = useUserSetting(
+ "sdk-iframe-embed-setup-settings",
+ { debounceTimeout: USER_SETTINGS_DEBOUNCE_MS },
+ );
+
+ const persistedSettings = useMemo(
+ () => getSettingsToPersist(rawPersisted || {}),
+ [rawPersisted],
+ );
+
+ const persistSettings = useCallback(
+ (settings: Partial<SdkIframeEmbedSetupSettings>) => {
+ rawPersistSettings(getSettingsToPersist(settings));
+ },
+ [rawPersistSettings],
+ );
+
+ return [persistedSettings, persistSettings] as const;
+};
+
+export const useSdkIframeEmbedSettings = ({
+ urlParams,
+ recentDashboards,
+ isRecentsLoading,
+ modelCount,
+}: {
+ urlParams: SdkIframeEmbedSetupUrlParams;
+ recentDashboards: SdkIframeEmbedSetupRecentItem[];
+ isRecentsLoading: boolean;
+ modelCount: number;
+}) => {
+ const [isEmbedSettingsLoaded, setEmbedSettingsLoaded] = useState(false);
+ const [persistedSettings, persistSettings] = usePersistedSettings();
+
+ const defaultSettings = useMemo(() => {
+ return match([urlParams.resourceType, urlParams.resourceId])
+ .with(["dashboard", P.nonNullable], ([, resourceId]) =>
+ getDefaultSdkIframeEmbedSettings({
+ experience: "dashboard",
+ resourceId,
+ }),
+ )
+ .with(["question", P.nonNullable], ([, resourceId]) =>
+ getDefaultSdkIframeEmbedSettings({
+ experience: "chart",
+ resourceId,
+ }),
+ )
+ .otherwise(() =>
+ getDefaultSdkIframeEmbedSettings({
+ experience: "dashboard",
+ resourceId: recentDashboards[0]?.id ?? EMBED_FALLBACK_DASHBOARD_ID,
+ }),
+ );
+ }, [recentDashboards, urlParams]);
+
+ const [rawSettings, setRawSettings] = useState<SdkIframeEmbedSetupSettings>();
+
+ const settings = useMemo(() => {
+ const latestSettings = rawSettings ?? defaultSettings;
+
+ // Append entity-types=model if there are more than 2 models in the instance.
+ if (modelCount > 2) {
+ return match(latestSettings)
+ .with({ componentName: "metabase-question" }, (settings) => ({
+ ...settings,
+ entityTypes: ["model" as const],
+ }))
+ .with({ componentName: "metabase-browser" }, (settings) => ({
+ ...settings,
+ dataPickerEntityTypes: ["model" as const],
+ }))
+ .otherwise((settings) => settings);
+ }
+
+ return latestSettings;
+ }, [defaultSettings, modelCount, rawSettings]);
+
+ const updateSettings = useCallback(
+ (nextSettings: Partial<SdkIframeEmbedSetupSettings>) =>
+ setRawSettings((prevSettings) => {
+ // Merging with a partial setting requires us to cast the type
+ const mergedSettings = {
+ ...(prevSettings ?? defaultSettings),
+ ...nextSettings,
+ } as SdkIframeEmbedSetupSettings;
+
+ persistSettings(mergedSettings);
+
+ return mergedSettings;
+ }),
+ [defaultSettings, persistSettings],
+ );
+
+ const replaceSettings = useCallback(
+ (nextSettings: SdkIframeEmbedSetupSettings) => {
+ setRawSettings(nextSettings);
+ persistSettings(nextSettings);
+ },
+ [persistSettings],
+ );
+
+ // Once the persisted settings are loaded, check if they are valid.
+ // If they are, set them as the current settings.
+ useEffect(() => {
+ if (!isEmbedSettingsLoaded && !isRecentsLoading) {
+ setRawSettings({
+ ...settings,
+ ...persistedSettings,
+
+ // Override the persisted settings if `auth_method` is specified.
+ // This is used for Embedding Hub.
+ ...(urlParams.authMethod !== null && {
+ useExistingUserSession: urlParams.authMethod === "user_session",
+ }),
+ });
+
+ setEmbedSettingsLoaded(true);
+
+ trackEmbedWizardOpened();
+ }
+ }, [
+ persistedSettings,
+ isEmbedSettingsLoaded,
+ settings,
+ isRecentsLoading,
+ urlParams,
+ ]);
+
+ return {
+ settings,
+ defaultSettings: {
+ resourceId: getResourceIdFromSettings(defaultSettings) ?? "",
+ experience: getExperienceFromSettings(defaultSettings),
+ },
+ isEmbedSettingsLoaded,
+ replaceSettings,
+ updateSettings,
+ };
+};
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/hooks/use-sdk-iframe-embed-snippet.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/hooks/use-sdk-iframe-embed-snippet.ts
index cb7a31e5334..758c5429431 100644
--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/hooks/use-sdk-iframe-embed-snippet.ts
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/hooks/use-sdk-iframe-embed-snippet.ts
@@ -25,5 +25,5 @@ export function useSdkIframeEmbedSnippet() {
instanceUrl,
experience,
});
- }, [instanceUrl, settings, experience, applicationColors]);
+ }, [settings, applicationColors, instanceUrl, experience]);
}
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/types.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/types.ts
index 1548ef7f1a2..9a2d5ee8a49 100644
--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/types.ts
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/types.ts
@@ -1,6 +1,10 @@
import type {
+ BrowserEmbedOptions,
+ DashboardEmbedOptions,
+ ExplorationEmbedOptions,
+ MetabotEmbedOptions,
+ QuestionEmbedOptions,
SdkIframeEmbedBaseSettings,
- SdkIframeEmbedTemplateSettings,
} from "metabase-enterprise/embedding_iframe_sdk/types/embed";
import type { BaseRecentItem } from "metabase-types/api";
@@ -26,6 +30,17 @@ export type SdkIframeEmbedSetupRecentItem = Pick<
"name" | "description"
> & { id: string | number };
+export type SdkIframeDashboardEmbedSettings = DashboardEmbedOptions;
+
+export type SdkIframeQuestionEmbedSettings = QuestionEmbedOptions;
+
+export type SdkIframeEmbedSetupTemplateSettings =
+ | SdkIframeDashboardEmbedSettings
+ | SdkIframeQuestionEmbedSettings
+ | ExplorationEmbedOptions
+ | BrowserEmbedOptions
+ | MetabotEmbedOptions;
+
/**
* Settings used by the embed setup route.
* Excludes `instanceUrl` as it is derived dynamically from site-url.
@@ -34,4 +49,10 @@ export type SdkIframeEmbedSetupSettings = Omit<
SdkIframeEmbedBaseSettings,
"instanceUrl"
> &
- SdkIframeEmbedTemplateSettings;
+ SdkIframeEmbedSetupTemplateSettings;
+
+export type SdkIframeEmbedSetupUrlParams = {
+ authMethod?: string | null;
+ resourceType?: string | null;
+ resourceId?: string | null;
+};
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/utils/convert-parameter-values-by-slug-to-by-id.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/utils/convert-parameter-values-by-slug-to-by-id.ts
new file mode 100644
index 00000000000..f4a9b278796
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/utils/convert-parameter-values-by-slug-to-by-id.ts
@@ -0,0 +1,15 @@
+export const convertParameterValuesBySlugToById = (
+ valuesBySlug: Record<string, any> | undefined,
+ params: { id: string; slug: string }[],
+) => {
+ if (!valuesBySlug) {
+ return {};
+ }
+
+ return params.reduce<Record<string, any>>((byId, param) => {
+ if (param.slug in valuesBySlug) {
+ byId[param.id] = valuesBySlug[param.slug];
+ }
+ return byId;
+ }, {});
+};
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/utils/convert-parameter-values-by-slug-to-by-id.unit.spec.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/utils/convert-parameter-values-by-slug-to-by-id.unit.spec.ts
new file mode 100644
index 00000000000..52423baec5a
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/utils/convert-parameter-values-by-slug-to-by-id.unit.spec.ts
@@ -0,0 +1,88 @@
+import { convertParameterValuesBySlugToById } from "./convert-parameter-values-by-slug-to-by-id";
+
+describe("convertParameterValuesBySlugToById", () => {
+ it("returns empty object when valuesBySlug is undefined", () => {
+ const result = convertParameterValuesBySlugToById(undefined, [
+ { id: "1", slug: "city" },
+ ]);
+ expect(result).toEqual({});
+ });
+
+ it("maps matching slugs to ids", () => {
+ const result = convertParameterValuesBySlugToById(
+ { city: "NYC", country: "US" },
+ [
+ { id: "p1", slug: "city" },
+ { id: "p2", slug: "country" },
+ ],
+ );
+ expect(result).toEqual({ p1: "NYC", p2: "US" });
+ });
+
+ it("ignores params whose slug is missing in valuesBySlug", () => {
+ const result = convertParameterValuesBySlugToById({ city: "NYC" }, [
+ { id: "p1", slug: "city" },
+ { id: "p2", slug: "country" },
+ ]);
+ expect(result).toEqual({ p1: "NYC" });
+ expect(result).not.toHaveProperty("p2");
+ });
+
+ it("ignores extra slugs present only in valuesBySlug", () => {
+ const result = convertParameterValuesBySlugToById(
+ { city: "NYC", extra: 123 },
+ [{ id: "p1", slug: "city" }],
+ );
+ expect(result).toEqual({ p1: "NYC" });
+ });
+
+ it("preserves falsy values (0, '', false, null, undefined)", () => {
+ const result = convertParameterValuesBySlugToById(
+ { a: 0, b: "", c: false, d: null, e: undefined },
+ [
+ { id: "idA", slug: "a" },
+ { id: "idB", slug: "b" },
+ { id: "idC", slug: "c" },
+ { id: "idD", slug: "d" },
+ { id: "idE", slug: "e" },
+ ],
+ );
+
+ expect(result.idA).toBe(0);
+ expect(result.idB).toBe("");
+ expect(result.idC).toBe(false);
+ expect(result.idD).toBeNull();
+
+ // Ensure the key exists even if value is undefined
+ expect(Object.prototype.hasOwnProperty.call(result, "idE")).toBe(true);
+ expect(result.idE).toBeUndefined();
+ });
+
+ it("returns empty object when params is empty", () => {
+ const result = convertParameterValuesBySlugToById({ city: "NYC" }, []);
+ expect(result).toEqual({});
+ });
+
+ it("does not mutate inputs", () => {
+ const values = { city: "NYC" };
+ const params = [{ id: "p1", slug: "city" }];
+
+ const valuesCopy = { ...values };
+ const paramsCopy = params.map((p) => ({ ...p }));
+
+ const result = convertParameterValuesBySlugToById(values, params);
+
+ expect(result).toEqual({ p1: "NYC" });
+ expect(values).toEqual(valuesCopy);
+ expect(params).toEqual(paramsCopy);
+ });
+
+ it("maps the same slug to multiple ids (duplicate slug entries)", () => {
+ const result = convertParameterValuesBySlugToById({ common: 42 }, [
+ { id: "one", slug: "common" },
+ { id: "two", slug: "common" },
+ ]);
+
+ expect(result).toEqual({ one: 42, two: 42 });
+ });
+});
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/utils/embed-snippet.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/utils/embed-snippet.ts
index a617d7b2088..ff56d174894 100644
--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/utils/embed-snippet.ts
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/utils/embed-snippet.ts
@@ -6,13 +6,16 @@ import {
type AllowedEmbedSettingKey,
} from "metabase-enterprise/embedding_iframe_sdk/constants";
import type {
+ DashboardEmbedOptions,
QuestionEmbedOptions,
SdkIframeEmbedBaseSettings,
} from "metabase-enterprise/embedding_iframe_sdk/types/embed";
import type {
+ SdkIframeDashboardEmbedSettings,
SdkIframeEmbedSetupExperience,
SdkIframeEmbedSetupSettings,
+ SdkIframeQuestionEmbedSettings,
} from "../types";
import { filterEmptySettings } from "./filter-empty-settings";
@@ -38,11 +41,17 @@ function defineMetabaseConfig(config) {
<script>
defineMetabaseConfig({
- ${getMetabaseConfigSnippet(settings, instanceUrl)}
+ ${getMetabaseConfigSnippet({
+ settings,
+ instanceUrl,
+ })}
});
</script>
-${getEmbedCustomElementSnippet({ settings, experience })}`;
+${getEmbedCustomElementSnippet({
+ settings,
+ experience,
+})}`;
}
export function getEmbedCustomElementSnippet({
@@ -59,7 +68,17 @@ export function getEmbedCustomElementSnippet({
.with("browser", () => "metabase-browser")
.exhaustive();
- const settingsWithExplorationOverride = match(experience)
+ const settingsWithOverrides = match(experience)
+ .with("chart", () => {
+ const questionSettings = settings as SdkIframeQuestionEmbedSettings;
+
+ return {
+ ...settings,
+ hiddenParameters: questionSettings.hiddenParameters?.length
+ ? questionSettings.hiddenParameters
+ : undefined,
+ } as QuestionEmbedOptions;
+ })
.with(
"exploration",
() =>
@@ -69,10 +88,20 @@ export function getEmbedCustomElementSnippet({
template: undefined,
}) as QuestionEmbedOptions,
)
+ .with("dashboard", () => {
+ const dashboardSettings = settings as SdkIframeDashboardEmbedSettings;
+
+ return {
+ ...settings,
+ hiddenParameters: dashboardSettings.hiddenParameters?.length
+ ? dashboardSettings.hiddenParameters
+ : undefined,
+ } as DashboardEmbedOptions;
+ })
.otherwise(() => settings);
const attributes = transformEmbedSettingsToAttributes(
- settingsWithExplorationOverride,
+ settingsWithOverrides,
ALLOWED_EMBED_SETTING_KEYS_MAP[experience],
);
@@ -119,10 +148,13 @@ export function transformEmbedSettingsToAttributes(
return attributes.join(" ");
}
-export function getMetabaseConfigSnippet(
- settings: Partial<SdkIframeEmbedSetupSettings>,
- instanceUrl: string,
-): string {
+export function getMetabaseConfigSnippet({
+ settings,
+ instanceUrl,
+}: {
+ settings: Partial<SdkIframeEmbedSetupSettings>;
+ instanceUrl: string;
+}): string {
const config = _.pick(settings, ALLOWED_EMBED_SETTING_KEYS_MAP.base);
const cleanedConfig = {
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/utils/default-embed-setting.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/utils/get-default-sdk-iframe-embed-setting.ts
similarity index 84%
rename from enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/utils/default-embed-setting.ts
rename to enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/utils/get-default-sdk-iframe-embed-setting.ts
index 461ac605073..377fa8e1cb9 100644
--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/utils/default-embed-setting.ts
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/utils/get-default-sdk-iframe-embed-setting.ts
@@ -1,5 +1,6 @@
import { P, match } from "ts-pattern";
+import type { SdkDashboardId, SdkQuestionId } from "embedding-sdk-bundle/types";
import type {
BrowserEmbedOptions,
DashboardEmbedOptions,
@@ -12,16 +13,19 @@ import type {
SdkIframeEmbedSetupSettings,
} from "../types";
-export const getDefaultSdkIframeEmbedSettings = (
- type: SdkIframeEmbedSetupExperience,
- defaultResourceId: string | number,
-): SdkIframeEmbedSetupSettings => {
- const templateDefaults = match(type)
+export const getDefaultSdkIframeEmbedSettings = ({
+ experience,
+ resourceId,
+}: {
+ experience: SdkIframeEmbedSetupExperience;
+ resourceId: SdkDashboardId | SdkQuestionId;
+}): SdkIframeEmbedSetupSettings => {
+ const templateDefaults = match(experience)
.with(
"dashboard",
(): DashboardEmbedOptions => ({
componentName: "metabase-dashboard",
- dashboardId: defaultResourceId,
+ dashboardId: resourceId,
drills: true,
withDownloads: false,
withTitle: true,
@@ -31,7 +35,7 @@ export const getDefaultSdkIframeEmbedSettings = (
"chart",
(): QuestionEmbedOptions => ({
componentName: "metabase-question",
- questionId: defaultResourceId,
+ questionId: resourceId,
drills: true,
withDownloads: false,
withTitle: true,