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
emb-1300: use plugin for handleLink in eajs and fix double sdk plugin init (#69961)
Nicolò Prettobba60088cb37
diff --git a/enterprise/frontend/src/embedding-sdk-ee/handle-link/handle-link.ts b/enterprise/frontend/src/embedding-sdk-ee/handle-link/handle-link.tsnew file mode 100644index 00000000000..920e136a99f--- /dev/null+++ b/enterprise/frontend/src/embedding-sdk-ee/handle-link/handle-link.ts@@ -0,0 +1,27 @@+import {+ MODULAR_EMBEDDING_HANDLE_LINK_PLUGIN,+ getSdkGlobalPlugins,+} from "embedding-sdk-shared/lib/sdk-global-plugins";+import { hasPremiumFeature } from "metabase-enterprise/settings";++export const initializeHandleLinkPlugin = () => {+ if (hasPremiumFeature("embedding_sdk")) {+ MODULAR_EMBEDDING_HANDLE_LINK_PLUGIN.handleLink = async (url: string) => {+ const globalPlugins = getSdkGlobalPlugins();++ if (!globalPlugins?.handleLink) {+ return { handled: false };+ }++ const result = globalPlugins.handleLink(url);++ if (!result || typeof result !== "object" || !("handled" in result)) {+ throw new Error(+ "handleLink plugin must return an object with a 'handled' property",+ );+ }++ return result;+ };+ }+};diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/handle-link.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/handle-link.tsnew file mode 100644index 00000000000..909ad2f5933--- /dev/null+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/handle-link.ts@@ -0,0 +1,41 @@+import { MODULAR_EMBEDDING_HANDLE_LINK_PLUGIN } from "embedding-sdk-shared/lib/sdk-global-plugins";+import type {+ SdkIframeEmbedMessage,+ SdkIframeEmbedTagMessage,+} from "metabase/embedding/embedding-iframe-sdk/types/embed";+import { hasPremiumFeature } from "metabase-enterprise/settings";++export const initializeHandleLinkPlugin = () => {+ if (hasPremiumFeature("embedding_simple")) {+ MODULAR_EMBEDDING_HANDLE_LINK_PLUGIN.handleLink = (url: string) => {+ return new Promise<{ handled: boolean }>((resolve) => {+ const requestId = crypto.randomUUID();++ const handler = (event: MessageEvent<SdkIframeEmbedMessage>) => {+ if (!event.data) {+ return;+ }++ const action = event.data;++ if (+ action.type === "metabase.embed.handleLinkResponse" &&+ action.data.requestId === requestId+ ) {+ window.removeEventListener("message", handler);+ resolve({ handled: action.data.handled });+ }+ };++ window.addEventListener("message", handler);++ const handleLinkMessage: SdkIframeEmbedTagMessage = {+ type: "metabase.embed.handleLink",+ data: { url, requestId },+ };++ window.parent.postMessage(handleLinkMessage, "*");+ });+ };+ }+};diff --git a/enterprise/frontend/src/metabase-enterprise/sdk-iframe-embedding-plugins.ts b/enterprise/frontend/src/metabase-enterprise/sdk-iframe-embedding-plugins.tsindex fdd46a0854c..e9e5c3bf53d 100644--- a/enterprise/frontend/src/metabase-enterprise/sdk-iframe-embedding-plugins.ts+++ b/enterprise/frontend/src/metabase-enterprise/sdk-iframe-embedding-plugins.ts@@ -2,6 +2,11 @@ import { initializePlugins } from "sdk-ee-plugins";// Plugins that are only applicable to the new iframe embedding.import { initializePlugin as initializeEmbeddingIframeSdkPlugin } from "./embedding_iframe_sdk";+import { initializeHandleLinkPlugin } from "./embedding_iframe_sdk/handle-link";-initializeEmbeddingIframeSdkPlugin();+// Sdk pluginsinitializePlugins();++// EAJS specific plugins and overrides+initializeEmbeddingIframeSdkPlugin();+initializeHandleLinkPlugin();diff --git a/enterprise/frontend/src/metabase-enterprise/sdk-plugins.ts b/enterprise/frontend/src/metabase-enterprise/sdk-plugins.tsindex 738b75fef99..47574c8be26 100644--- a/enterprise/frontend/src/metabase-enterprise/sdk-plugins.ts+++ b/enterprise/frontend/src/metabase-enterprise/sdk-plugins.ts@@ -1,5 +1,7 @@import { PLUGIN_IS_EE_BUILD } from "metabase/plugins";+import { initializeHandleLinkPlugin } from "../embedding-sdk-ee/handle-link/handle-link";+// SETTINGS OVERRIDES:PLUGIN_IS_EE_BUILD.isEEBuild = () => true;@@ -32,6 +34,7 @@ export function initializePlugins() {initializeContentTranslation?.();initializeNotifications();initializeSharing();+ initializeHandleLinkPlugin();}// "SDK EE-plugins", that are specific to the embedding sdk.diff --git a/frontend/src/embedding-sdk-bundle/components/public/ComponentProvider/ComponentProvider.tsx b/frontend/src/embedding-sdk-bundle/components/public/ComponentProvider/ComponentProvider.tsxindex 845c5a04c28..5778fb4502d 100644--- a/frontend/src/embedding-sdk-bundle/components/public/ComponentProvider/ComponentProvider.tsx+++ b/frontend/src/embedding-sdk-bundle/components/public/ComponentProvider/ComponentProvider.tsx@@ -18,6 +18,7 @@ import type { SdkStore } from "embedding-sdk-bundle/store/types";import type { MetabaseProviderProps } from "embedding-sdk-bundle/types/metabase-provider";import { EnsureSingleInstance } from "embedding-sdk-shared/components/EnsureSingleInstance/EnsureSingleInstance";import { useInstanceLocale } from "metabase/common/hooks/use-instance-locale";+import { isEmbeddingEajs } from "metabase/embedding-sdk/config";import { isEmbeddingThemeV1 } from "metabase/embedding-sdk/theme";import { MetabaseReduxProvider, useSelector } from "metabase/lib/redux";import { LocaleProvider } from "metabase/public/LocaleProvider";@@ -44,7 +45,10 @@ function useInitPlugins() {);useEffect(() => {- if (hasInitializedPlugins || !tokenFeatures) {+ // EAJS already initializes the plugins in its entrypoint, and this+ // component is used by EAJS we have to make sure we don't re-initialize the+ // sdk plugins as they could override some of plugins needed by EAJS+ if (isEmbeddingEajs() || hasInitializedPlugins || !tokenFeatures) {return;}diff --git a/frontend/src/embedding-sdk-shared/lib/sdk-global-plugins.ts b/frontend/src/embedding-sdk-shared/lib/sdk-global-plugins.tsindex 967ddd4b680..64e1afa1cf8 100644--- a/frontend/src/embedding-sdk-shared/lib/sdk-global-plugins.ts+++ b/frontend/src/embedding-sdk-shared/lib/sdk-global-plugins.ts@@ -1,9 +1,11 @@-import { bridgeHandleLinkForEmbedJs } from "metabase/embedding/embedding-iframe-sdk/utils/bridge-handle-link";-import { isEmbeddingEajs } from "metabase/embedding-sdk/config";-import { ensureMetabaseProviderPropsStore } from "./ensure-metabase-provider-props-store";-type HandleLinkFn = (url: string) => { handled: boolean };+// On the SDK side, we ask customers for a sync function but in EAJS we actually+// need an async function internally. Typescript doesn't really like it unless+// we specify both versions+type HandleLinkFn = (+ url: string,+) => { handled: boolean } | Promise<{ handled: boolean }>;type SdkGlobalPlugins = {handleLink?: HandleLinkFn;@@ -19,32 +21,16 @@ export const getSdkGlobalPlugins = (): SdkGlobalPlugins => {);};+export const MODULAR_EMBEDDING_HANDLE_LINK_PLUGIN: {+ handleLink: HandleLinkFn;+} = {+ handleLink: (_url: string) => Promise.resolve({ handled: false }),+};+/*** Invokes the handleLink plugin if configured in the host app and returns an object with a 'handled' property, indicating if the host app handled the link.* For iframe SDK, this sends a postMessage to the parent window and awaits the response.*/-export async function handleLinkSdkPlugin(- url: string,-): Promise<{ handled: boolean }> {- // In iframe SDK mode, send a message to the parent window- if (isEmbeddingEajs()) {- return bridgeHandleLinkForEmbedJs(url);- }-- // React SDK mode - use the global plugins- const globalPlugins = getSdkGlobalPlugins();-- if (!globalPlugins?.handleLink) {- return { handled: false };- }-- const result = globalPlugins.handleLink(url);-- if (!result || typeof result !== "object" || !("handled" in result)) {- throw new Error(- "handleLink plugin must return an object with a 'handled' property",- );- }-- return result;+export async function handleLinkSdkPlugin(url: string) {+ return await MODULAR_EMBEDDING_HANDLE_LINK_PLUGIN.handleLink(url);}diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk/utils/bridge-handle-link.ts b/frontend/src/metabase/embedding/embedding-iframe-sdk/utils/bridge-handle-link.tsdeleted file mode 100644index 904126270ce..00000000000--- a/frontend/src/metabase/embedding/embedding-iframe-sdk/utils/bridge-handle-link.ts+++ /dev/null@@ -1,41 +0,0 @@-import type {- SdkIframeEmbedMessage,- SdkIframeEmbedTagMessage,-} from "../types/embed";--/**- * Requests the parent window (embed.js) to handle a link click.- * Returns { handled: true } if the parent handled the link, { handled: false } otherwise.- */-export function bridgeHandleLinkForEmbedJs(- url: string,-): Promise<{ handled: boolean }> {- return new Promise((resolve) => {- const requestId = crypto.randomUUID();-- const handler = (event: MessageEvent<SdkIframeEmbedMessage>) => {- if (!event.data) {- return;- }-- const action = event.data;-- if (- action.type === "metabase.embed.handleLinkResponse" &&- action.data.requestId === requestId- ) {- window.removeEventListener("message", handler);- resolve({ handled: action.data.handled });- }- };-- window.addEventListener("message", handler);-- const handleLinkMessage: SdkIframeEmbedTagMessage = {- type: "metabase.embed.handleLink",- data: { url, requestId },- };-- window.parent.postMessage(handleLinkMessage, "*");- });-}diff --git a/frontend/test/__support__/enterprise.js b/frontend/test/__support__/enterprise.jsindex b86dc892c5d..53acddfafea 100644--- a/frontend/test/__support__/enterprise.js+++ b/frontend/test/__support__/enterprise.js@@ -40,6 +40,11 @@ export function setupEnterprisePlugins() {initializePlugins?.();}+export function setupSdkPlugins() {+ const { initializePlugins } = require(`metabase-enterprise/sdk-plugins`);+ initializePlugins?.();+}+/*** Import only the specified enterprise-only plugin and initialize it.*diff --git a/frontend/test/metabase/lib/dom.unit.spec.js b/frontend/test/metabase/lib/dom.unit.spec.jsindex d8ec33e32d4..7ef765164fc 100644--- a/frontend/test/metabase/lib/dom.unit.spec.js+++ b/frontend/test/metabase/lib/dom.unit.spec.js@@ -1,3 +1,5 @@+import { setupSdkPlugins } from "__support__/enterprise";+import { mockSettings } from "__support__/settings";import { ensureMetabaseProviderPropsStore } from "embedding-sdk-shared/lib/ensure-metabase-provider-props-store";import { mockIsEmbeddingSdk } from "metabase/embedding-sdk/mocks/config-mock";import {@@ -6,6 +8,7 @@ import {parseDataUri,shouldOpenInBlankWindow,} from "metabase/lib/dom";+import { createMockTokenFeatures } from "metabase-types/api/mocks";describe("parseDataUri", () => {it("parses a valid text data URI", () => {@@ -79,6 +82,11 @@ describe("open()", () => {await mockIsEmbeddingSdk();// Ensure a clean store before each testensureMetabaseProviderPropsStore().cleanup();++ mockSettings({+ "token-features": createMockTokenFeatures({ embedding_sdk: true }),+ });+ setupSdkPlugins();});afterEach(() => {diff --git a/frontend/test/metabase/lib/formatting/url.unit.spec.tsx b/frontend/test/metabase/lib/formatting/url.unit.spec.tsxindex 800247cd7ab..40bb227d0b9 100644--- a/frontend/test/metabase/lib/formatting/url.unit.spec.tsx+++ b/frontend/test/metabase/lib/formatting/url.unit.spec.tsx@@ -1,7 +1,10 @@+import { setupSdkPlugins } from "__support__/enterprise";+import { mockSettings } from "__support__/settings";import { render, screen } from "__support__/ui";import { ensureMetabaseProviderPropsStore } from "embedding-sdk-shared/lib/ensure-metabase-provider-props-store";import { mockIsEmbeddingSdk } from "metabase/embedding-sdk/mocks/config-mock";import { formatUrl } from "metabase/lib/formatting/url";+import { createMockTokenFeatures } from "metabase-types/api/mocks";describe("formatUrl", () => {afterEach(() => {@@ -10,6 +13,10 @@ describe("formatUrl", () => {});it("calls handleLinkSdkPlugin and prevents default in SDK", async () => {+ mockSettings({+ "token-features": createMockTokenFeatures({ embedding_sdk: true }),+ });+ setupSdkPlugins();await mockIsEmbeddingSdk(true);const url = "https://example.com/dashboard/1";