Skip to content

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

fix(EmbedJS): Downloads fail on guest embedded questions (#69972)

Timofey Kachalov08c4a89f917f
diff --git a/e2e/support/helpers/e2e-downloads-helpers.ts b/e2e/support/helpers/e2e-downloads-helpers.ts
index f82569da1dd..fa4b9e31207 100644
--- a/e2e/support/helpers/e2e-downloads-helpers.ts
+++ b/e2e/support/helpers/e2e-downloads-helpers.ts
@@ -22,8 +22,10 @@ interface DownloadAndAssertParams {
dashboardId?: number;
enableFormatting?: boolean;
pivoting?: "pivoted" | "non-pivoted";
+ assertStatusCode?: number;
/** Assert that parameters in request body match expected values */
assertParameters?: any[];
+ waitForDismiss?: boolean;
}
export interface DownloadRequestData {
@@ -69,7 +71,9 @@ export function downloadAndAssert({
isEmbed = false,
enableFormatting = true,
pivoting,
+ assertStatusCode,
assertParameters,
+ waitForDismiss = true,
}: DownloadAndAssertParams) {
const { method, endpoint } = downloadUrl
? { method: downloadMethod, endpoint: downloadUrl }
@@ -167,8 +171,14 @@ export function downloadAndAssert({
cy.findByTestId("download-results-button").click();
});
- cy.wait("@fileDownload").then(() => {
- ensureDownloadStatusDismissed();
+ cy.wait("@fileDownload").then(({ response }) => {
+ if (assertStatusCode) {
+ expect(response?.statusCode).to.eq(assertStatusCode);
+ }
+
+ if (waitForDismiss) {
+ ensureDownloadStatusDismissed();
+ }
});
}
diff --git a/e2e/test-component/scenarios/embedding-sdk/guest-embed-reproductions.cy.spec.tsx b/e2e/test-component/scenarios/embedding-sdk/guest-embed-reproductions.cy.spec.tsx
new file mode 100644
index 00000000000..dd1d410f059
--- /dev/null
+++ b/e2e/test-component/scenarios/embedding-sdk/guest-embed-reproductions.cy.spec.tsx
@@ -0,0 +1,70 @@
+import { SAMPLE_DATABASE } from "e2e/support/cypress_sample_database";
+import {
+ createQuestion,
+ downloadAndAssert,
+ getSignedJwtForResource,
+} from "e2e/support/helpers";
+import { getSdkRoot } from "e2e/support/helpers/e2e-embedding-sdk-helpers";
+import { mountGuestEmbedQuestion } from "e2e/support/helpers/embedding-sdk-component-testing";
+import { signInAsAdminAndSetupGuestEmbedding } from "e2e/support/helpers/embedding-sdk-testing";
+import type { Card } from "metabase-types/api";
+
+const { ORDERS, ORDERS_ID } = SAMPLE_DATABASE;
+
+describe("scenarios > embedding-sdk > guest-embed reproductions", () => {
+ const setup = ({ display }: { display?: Card["display"] } = {}) => {
+ signInAsAdminAndSetupGuestEmbedding({
+ token: "pro-cloud",
+ });
+
+ createQuestion({
+ name: "Question for Guest Embed SDK",
+ enable_embedding: true,
+ embedding_type: "guest-embed",
+ query: {
+ "source-table": ORDERS_ID,
+ aggregation: [["max", ["field", ORDERS.QUANTITY, null]]],
+ breakout: [["field", ORDERS.PRODUCT_ID, null]],
+ limit: 2,
+ },
+ display,
+ }).then(({ body: question }) => {
+ cy.wrap(question.id).as("questionId");
+ });
+
+ cy.signOut();
+ };
+
+ it("should show question content with applied content translation", () => {
+ setup();
+
+ cy.get("@questionId").then(async (questionId) => {
+ const token = await getSignedJwtForResource({
+ resourceId: questionId as unknown as number,
+ resourceType: "question",
+ });
+
+ mountGuestEmbedQuestion({ token, title: true, withDownloads: true });
+
+ cy.window().then((win) => {
+ const url = new URL(win.location.href);
+
+ url.searchParams.set("foo", "bar");
+ win.history.replaceState(null, "", url);
+ });
+
+ getSdkRoot().within(() => {
+ downloadAndAssert({
+ isDashboard: false,
+ isEmbed: true,
+ enableFormatting: true,
+ assertStatusCode: 200,
+ waitForDismiss: false,
+ fileType: "csv",
+ downloadUrl: "/api/embed/card/*/query/csv*",
+ downloadMethod: "GET",
+ });
+ });
+ });
+ });
+});
diff --git a/e2e/test/scenarios/embedding/sdk-iframe-embedding/guest-embed.cy.spec.ts b/e2e/test/scenarios/embedding/sdk-iframe-embedding/guest-embed.cy.spec.ts
index 72b6ae11f8c..19afb0f5acb 100644
--- a/e2e/test/scenarios/embedding/sdk-iframe-embedding/guest-embed.cy.spec.ts
+++ b/e2e/test/scenarios/embedding/sdk-iframe-embedding/guest-embed.cy.spec.ts
@@ -60,6 +60,43 @@ describe(
});
});
+ it("allows to download a static question as CSV", () => {
+ cy.get("@questionId").then(async (questionId) => {
+ const token = await getSignedJwtForResource({
+ resourceId: questionId as unknown as number,
+ resourceType: "question",
+ });
+
+ const frame = H.loadSdkIframeEmbedTestPage({
+ metabaseConfig: { isGuest: true },
+ elements: [
+ {
+ component: "metabase-question",
+ attributes: {
+ token,
+ "with-downloads": true,
+ },
+ },
+ ],
+ });
+
+ cy.wait("@getCardQuery");
+
+ frame.within(() => {
+ H.downloadAndAssert({
+ isDashboard: false,
+ isEmbed: true,
+ enableFormatting: true,
+ assertStatusCode: 200,
+ waitForDismiss: false,
+ fileType: "csv",
+ downloadUrl: "/api/embed/card/*/query/csv*",
+ downloadMethod: "GET",
+ });
+ });
+ });
+ });
+
it("shows an error for a component without guest embed support", () => {
const frame = H.loadSdkIframeEmbedTestPage({
metabaseConfig: { isGuest: true },
diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk/components/SdkIframeEmbedRoute.tsx b/frontend/src/metabase/embedding/embedding-iframe-sdk/components/SdkIframeEmbedRoute.tsx
index 64910d12989..11480181c6f 100644
--- a/frontend/src/metabase/embedding/embedding-iframe-sdk/components/SdkIframeEmbedRoute.tsx
+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk/components/SdkIframeEmbedRoute.tsx
@@ -1,4 +1,4 @@
-import { type ReactNode, useMemo } from "react";
+import { type ReactNode, useEffect, useMemo } from "react";
import { P, match } from "ts-pattern";
import { PublicComponentStylesWrapper } from "embedding-sdk-bundle/components/private/PublicComponentStylesWrapper";
@@ -30,6 +30,7 @@ import { Stack } from "metabase/ui";
import { useParamRerenderKey } from "../hooks/use-param-rerender-key";
import { useSdkIframeEmbedEventBus } from "../hooks/use-sdk-iframe-embed-event-bus";
import type { SdkIframeEmbedSettings } from "../types/embed";
+import { stripInternalIframeQueryParameters } from "../utils/strip-internal-iframe-query-parameters";
import { MetabaseBrowser } from "./MetabaseBrowser";
import SdkIframeEmbedRouteS from "./SdkIframeEmbedRoute.module.css";
@@ -58,6 +59,10 @@ export const SdkIframeEmbedRoute = () => {
[embedSettings?.theme],
);
+ useEffect(() => {
+ stripInternalIframeQueryParameters();
+ }, []);
+
// The embed settings won't be available until the parent sends it via postMessage.
// The SDK will show its own loading indicator, so we don't need to show it twice.
if (!embedSettings || !embedSettings.instanceUrl) {
diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk/constants.ts b/frontend/src/metabase/embedding/embedding-iframe-sdk/constants.ts
index faf30c857e4..9cf1bfa6d98 100644
--- a/frontend/src/metabase/embedding/embedding-iframe-sdk/constants.ts
+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk/constants.ts
@@ -137,3 +137,9 @@ export const DISABLE_UPDATE_FOR_KEYS = [
] as const satisfies AllowedEmbedSettingKey[];
export const METABASE_CONFIG_IS_PROXY_FIELD_NAME = "__isProxy";
+
+/**
+ * Used to allow parallel loading of EmbedJS iframes
+ */
+export const EMBED_JS_IFRAME_IDENTIFIER_QUERY_PARAMETER_NAME =
+ "embed-js-identifier";
diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk/embed.ts b/frontend/src/metabase/embedding/embedding-iframe-sdk/embed.ts
index 7061f7da181..3b2eb9220e5 100644
--- a/frontend/src/metabase/embedding/embedding-iframe-sdk/embed.ts
+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk/embed.ts
@@ -10,6 +10,7 @@ import { debouncedReportAnalytics } from "./analytics";
import {
ALLOWED_EMBED_SETTING_KEYS_MAP,
DISABLE_UPDATE_FOR_KEYS,
+ EMBED_JS_IFRAME_IDENTIFIER_QUERY_PARAMETER_NAME,
METABASE_CONFIG_IS_PROXY_FIELD_NAME,
} from "./constants";
import type {
@@ -346,7 +347,7 @@ export abstract class MetabaseEmbedElement<T extends string[] = string[]>
// Random query param is needed to allow parallel EmbedJS iframes loading.
// Without it multiple EmbedJS iframes on a page loaded sequentially.
// We don't cache the iframe content, so random query parameter does not break caching.
- this._iframe.src = `${this.globalSettings.instanceUrl}/${EMBEDDING_ROUTE}?v=${_iframeCounter++}`;
+ this._iframe.src = `${this.globalSettings.instanceUrl}/${EMBEDDING_ROUTE}?${EMBED_JS_IFRAME_IDENTIFIER_QUERY_PARAMETER_NAME}=${_iframeCounter++}`;
this._iframe.style.width = "100%";
this._iframe.style.height = "100%";
this._iframe.style.border = "none";
diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk/embed.unit.spec.ts b/frontend/src/metabase/embedding/embedding-iframe-sdk/embed.unit.spec.ts
index 4d9ba26ab25..8a565ae6b53 100644
--- a/frontend/src/metabase/embedding/embedding-iframe-sdk/embed.unit.spec.ts
+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk/embed.unit.spec.ts
@@ -190,7 +190,7 @@ describe("embed.js script tag for sdk iframe embedding", () => {
}).not.toThrow();
});
- it("should include a counter as a query parameter in the iframe src for parallel loading", () => {
+ it("should include a component id as a query parameter in the iframe src for parallel loading", () => {
defineMetabaseConfig({
instanceUrl: "https://example.com",
});
@@ -202,7 +202,7 @@ describe("embed.js script tag for sdk iframe embedding", () => {
const iframe = embed.querySelector("iframe");
expect(iframe).not.toBeNull();
expect(iframe?.src).toMatch(
- /^https:\/\/example\.com\/embed\/sdk\/v1\?v=\d+$/,
+ /^https:\/\/example\.com\/embed\/sdk\/v1\?embed-js-identifier=\d+$/,
);
});
});
diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk/utils/strip-internal-iframe-query-parameters.ts b/frontend/src/metabase/embedding/embedding-iframe-sdk/utils/strip-internal-iframe-query-parameters.ts
new file mode 100644
index 00000000000..e6bd6dec8d2
--- /dev/null
+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk/utils/strip-internal-iframe-query-parameters.ts
@@ -0,0 +1,9 @@
+import { EMBED_JS_IFRAME_IDENTIFIER_QUERY_PARAMETER_NAME } from "../constants";
+
+export const stripInternalIframeQueryParameters = () => {
+ const url = new URL(window.location.href);
+
+ url.searchParams.delete(EMBED_JS_IFRAME_IDENTIFIER_QUERY_PARAMETER_NAME);
+
+ window.history.replaceState(null, "", url);
+};
diff --git a/frontend/src/metabase/redux/downloads.ts b/frontend/src/metabase/redux/downloads.ts
index 00f602ee5a3..a03171f839d 100644
--- a/frontend/src/metabase/redux/downloads.ts
+++ b/frontend/src/metabase/redux/downloads.ts
@@ -323,7 +323,11 @@ const getEmbedQuestionParams = (
type: string,
exportParams: ExportParams,
): DownloadQueryResultsParams => {
- const params = new URLSearchParams(window.location.search);
+ const params = isEmbeddingSdk()
+ ? // For SDK/EmbedJS we must not read params from location search as in both cases
+ // additional params are not supported by a public endpoint
+ null
+ : new URLSearchParams(window.location.search);
const convertSearchParamsToObject = (params: URLSearchParams) => {
const object: Record<string, string | string[]> = {};
@@ -345,7 +349,9 @@ const getEmbedQuestionParams = (
method: "GET",
url: Urls.embedCard(token, type),
params: new URLSearchParams({
- parameters: JSON.stringify(convertSearchParamsToObject(params)),
+ ...(params && {
+ parameters: JSON.stringify(convertSearchParamsToObject(params)),
+ }),
..._.mapObject(exportParams, (value) => String(value)),
}),
};