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
feat(sdk-bundle, embed-js): add metabase-metabot custom element for Embed JS (#64144)
Phoomparin Mano400b10f74caa
diff --git a/e2e/test/scenarios/embedding/sdk-iframe-embedding/custom-elements-api.cy.spec.ts b/e2e/test/scenarios/embedding/sdk-iframe-embedding/custom-elements-api.cy.spec.tsindex 284fd9bb437..b14ef150b26 100644--- a/e2e/test/scenarios/embedding/sdk-iframe-embedding/custom-elements-api.cy.spec.ts+++ b/e2e/test/scenarios/embedding/sdk-iframe-embedding/custom-elements-api.cy.spec.ts@@ -389,6 +389,46 @@ describe("scenarios > embedding > sdk iframe embedding > custom elements api", (});});+ describe("<metabase-metabot>", () => {+ it("should load the embedded Metabot component", () => {+ H.visitCustomHtmlPage(`+ ${H.getNewEmbedScriptTag()}+ ${H.getNewEmbedConfigurationScript()}+ <metabase-metabot />+ `);++ H.getSimpleEmbedIframeContent().within(() => {+ cy.log("metabot chat should be interactive");+ cy.findByText("Ask questions to AI.").should("be.visible");+ cy.findByPlaceholderText("Ask AI a question...").type("Foo{enter}");+ cy.findByText(+ "Metabot is currently offline. Please try again later.",+ ).should("be.visible");++ cy.log(+ "uses sidebar layout by default when no layout attribute is provided",+ );+ cy.findByTestId("metabot-question-container").should(+ "have.attr",+ "data-layout",+ "sidebar",+ );+ });+ });++ it("should apply the data-layout attribute when layout is set to stacked", () => {+ H.visitCustomHtmlPage(`+ ${H.getNewEmbedScriptTag()}+ ${H.getNewEmbedConfigurationScript()}+ <metabase-metabot layout="stacked" />+ `);++ H.getSimpleEmbedIframeContent()+ .findByTestId("metabot-question-container")+ .should("have.attr", "data-layout", "stacked");+ });+ });+describe("common checks", () => {describe("should be permissive with json attributes", () => {// NOTE: pay attention if you use initialFilters for these tests, as when the filters are not parsed correctlydiff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/components/SdkIframeEmbedRoute.tsx b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/components/SdkIframeEmbedRoute.tsxindex c8e0071f78a..1d332e10407 100644--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/components/SdkIframeEmbedRoute.tsx+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/components/SdkIframeEmbedRoute.tsx@@ -5,6 +5,7 @@ import { PublicComponentStylesWrapper } from "embedding-sdk-bundle/components/primport { SdkError } from "embedding-sdk-bundle/components/private/PublicComponentWrapper";import { SdkBreadcrumbsProvider } from "embedding-sdk-bundle/components/private/SdkBreadcrumbs";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";import { StaticQuestion } from "embedding-sdk-bundle/components/public/StaticQuestion";import {@@ -189,5 +190,11 @@ const SdkIframeEmbedView = ({);},)+ .with(+ {+ componentName: "metabase-metabot",+ },+ (settings) => <MetabotQuestion layout={settings.layout} height="100%" />,+ ).otherwise(() => null);};diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/embed.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/embed.tsindex 01d30899044..c6cf0e28b86 100644--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/embed.ts+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/embed.ts@@ -564,6 +564,10 @@ const MetabaseManageContentElement = createCustomElement("metabase-browser", ["read-only",]);+const MetabaseMetabotElement = createCustomElement("metabase-metabot", [+ "layout",+]);+// Expose the old API that's still used in the tests, we'll probably remove this api unless customers prefer itif (typeof window !== "undefined") {(window as any)["metabase.embed"] = {@@ -575,4 +579,5 @@ export {MetabaseDashboardElement,MetabaseQuestionElement,MetabaseManageContentElement,+ MetabaseMetabotElement,};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.tsindex 1e6cc656382..64980637bec 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@@ -131,6 +131,18 @@ export interface BrowserEmbedOptions {dashboardId?: never;}+export interface MetabotEmbedOptions {+ componentName: "metabase-metabot";++ /** Layout mode for the metabot interface */+ layout?: "auto" | "sidebar" | "stacked";++ // incompatible options+ template?: never;+ questionId?: never;+ dashboardId?: never;+}+type CollectionBrowserEntityTypes =| "collection"| "dashboard"@@ -156,7 +168,8 @@ export type SdkIframeEmbedTemplateSettings =| DashboardEmbedOptions| QuestionEmbedOptions| ExplorationEmbedOptions- | BrowserEmbedOptions;+ | BrowserEmbedOptions+ | MetabotEmbedOptions;/** Settings used by the sdk embed route */export type SdkIframeEmbedSettings = Omit<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.tsxindex 56dca6c87cc..758cd1eeae6 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@@ -186,6 +186,8 @@ export const SdkIframeEmbedPreview = () => {: undefined,}),)+ // TODO(EMB-869): add Metabot experience to embed flow+ .with({ componentName: "metabase-metabot" }, () => null).exhaustive()}<EmbedPreviewLoadingOverlay isVisible={isLoading} />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/default-embed-setting.tsindex 33905e19b68..461ac605073 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/default-embed-setting.ts@@ -79,4 +79,6 @@ export const getExperienceFromSettings = (.with({ componentName: "metabase-question" }, () => "chart").with({ componentName: "metabase-browser" }, () => "browser").with({ componentName: "metabase-dashboard" }, () => "dashboard")+ // TODO(EMB-869): add Metabot experience to embed flow - replace this with "metabot"+ .with({ componentName: "metabase-metabot" }, () => "chart").exhaustive();