Skip to content

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

Correct the modular embedding preview usage count (#69473)

Mahatthana (Kelvin) Nomsawadi7efad1c10546
diff --git a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/guest-embed-ee.cy.spec.ts b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/guest-embed-ee.cy.spec.ts
index 2096b9f5526..3c74e0c46a9 100644
--- a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/guest-embed-ee.cy.spec.ts
+++ b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/guest-embed-ee.cy.spec.ts
@@ -128,6 +128,7 @@ describe("scenarios > embedding > sdk iframe embed setup > guest-embed", () => {
describe("Happy path", () => {
it("Navigates through the guest-embed flow for a question and opens its embed page", () => {
+ cy.intercept("GET", "api/preview_embed/card/*").as("previewEmbed");
visitNewEmbedPage();
H.expectUnstructuredSnowplowEvent({ event: "embed_wizard_opened" });
@@ -215,6 +216,15 @@ describe("scenarios > embedding > sdk iframe embed setup > guest-embed", () => {
cy.findByTestId("publish-guest-embed-link").should("not.exist");
});
+ cy.log(
+ 'Embed preview requests should not have "X-Metabase-Client" header (EMB-945)',
+ );
+ cy.wait("@previewEmbed").then(({ request }) => {
+ expect(request?.headers?.["x-metabase-embedded-preview"]).to.equal(
+ "true",
+ );
+ });
+
H.unpublishChanges("card");
getEmbedSidebar().within(() => {
diff --git a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/guest-embed-oss.cy.spec.ts b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/guest-embed-oss.cy.spec.ts
index 32cebc0e7d1..b7d50fdea12 100644
--- a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/guest-embed-oss.cy.spec.ts
+++ b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/guest-embed-oss.cy.spec.ts
@@ -119,6 +119,7 @@ describe(
describe("Happy path", () => {
it("Navigates through the guest-embed flow for a question and opens its embed page", () => {
+ cy.intercept("GET", "api/preview_embed/card/*").as("previewEmbed");
visitNewEmbedPage();
H.expectUnstructuredSnowplowEvent({ event: "embed_wizard_opened" });
@@ -239,6 +240,15 @@ describe(
.click();
});
+ cy.log(
+ 'Embed preview requests should not have "X-Metabase-Client" header (EMB-945)',
+ );
+ cy.wait("@previewEmbed").then(({ request }) => {
+ expect(request?.headers?.["x-metabase-embedded-preview"]).to.equal(
+ "true",
+ );
+ });
+
H.expectUnstructuredSnowplowEvent({
event: "embed_wizard_code_copied",
event_detail:
diff --git a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-entity.cy.spec.ts b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-entity.cy.spec.ts
index 38cd55b5897..fa004c2238b 100644
--- a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-entity.cy.spec.ts
+++ b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-entity.cy.spec.ts
@@ -63,6 +63,7 @@ describe(suiteTitle, () => {
});
it("tracks event details with `isDefaultResource=false` when selecting a different dashboard", () => {
+ cy.intercept("GET", "api/preview_embed/dashboard/*").as("previewEmbed");
cy.log("add two dashboards to activity log");
H.createDashboard({ name: SECOND_DASHBOARD_NAME }).then(
@@ -100,6 +101,15 @@ describe(suiteTitle, () => {
cy.findByText(SECOND_DASHBOARD_NAME).should("be.visible");
});
+ cy.log(
+ 'Embed preview requests should not have "X-Metabase-Client" header (EMB-945)',
+ );
+ cy.wait("@previewEmbed").then(({ request }) => {
+ expect(request?.headers?.["x-metabase-embedded-preview"]).to.equal(
+ "true",
+ );
+ });
+
getEmbedSidebar().findByText("Next").click();
H.expectUnstructuredSnowplowEvent({
diff --git a/frontend/src/metabase/lib/api.js b/frontend/src/metabase/lib/api.js
index 4b2aa2c7594..acdb86284ab 100644
--- a/frontend/src/metabase/lib/api.js
+++ b/frontend/src/metabase/lib/api.js
@@ -1,3 +1,4 @@
+/* eslint-disable metabase/no-literal-metabase-strings */
import EventEmitter from "events";
import querystring from "querystring";
@@ -11,9 +12,7 @@ import { PLUGIN_API, PLUGIN_EMBEDDING_SDK } from "metabase/plugins";
const ONE_SECOND = 1000;
const MAX_RETRIES = 10;
-// eslint-disable-next-line metabase/no-literal-metabase-strings -- Not a user facing string
const ANTI_CSRF_HEADER = "X-Metabase-Anti-CSRF-Token";
-// eslint-disable-next-line metabase/no-literal-metabase-strings -- Not a user facing string
const METABASE_VERSION_HEADER = "X-Metabase-Version";
let ANTI_CSRF_TOKEN = null;
@@ -67,12 +66,10 @@ export class Api extends EventEmitter {
}
if (this.sessionToken) {
- // eslint-disable-next-line metabase/no-literal-metabase-strings -- Not a user facing string
headers["X-Metabase-Session"] = self.sessionToken;
}
if (isWithinIframe() && !self.requestClient) {
- // eslint-disable-next-line metabase/no-literal-metabase-strings -- Not a user facing string
headers["X-Metabase-Embedded"] = "true";
/**
* We counted static embed preview query executions which led to wrong embedding stats (EMB-930)
@@ -80,20 +77,19 @@ export class Api extends EventEmitter {
* embedding iframe (only for Documents at the time of this comment)
*/
if (!IFRAMED_IN_SELF) {
- // eslint-disable-next-line metabase/no-literal-metabase-strings -- Not a user facing string
headers["X-Metabase-Client"] = "embedding-iframe";
}
}
if (self.requestClient) {
+ if (IFRAMED_IN_SELF) {
+ headers["X-Metabase-Embedded-Preview"] = "true";
+ }
if (typeof self.requestClient === "object") {
- // eslint-disable-next-line metabase/no-literal-metabase-strings -- Not a user facing string
headers["X-Metabase-Client"] = self.requestClient.name;
- // eslint-disable-next-line metabase/no-literal-metabase-strings -- Not a user facing string
headers["X-Metabase-Client-Version"] =
self.requestClient.version ?? "unknown";
} else {
- // eslint-disable-next-line metabase/no-literal-metabase-strings -- Not a user facing string
headers["X-Metabase-Client"] = self.requestClient;
}
}
@@ -102,11 +98,8 @@ export class Api extends EventEmitter {
headers[ANTI_CSRF_HEADER] = ANTI_CSRF_TOKEN;
}
- // eslint-disable-next-line metabase/no-literal-metabase-strings -- Not a user facing string
if (DEFAULT_OPTIONS.headers["X-Metabase-Locale"]) {
- // eslint-disable-next-line metabase/no-literal-metabase-strings -- Not a user facing string
headers["X-Metabase-Locale"] =
- // eslint-disable-next-line metabase/no-literal-metabase-strings -- Not a user facing string
DEFAULT_OPTIONS.headers["X-Metabase-Locale"];
}
@@ -450,6 +443,5 @@ export const setLocaleHeader = (locale) => {
* We need it to localize downloads. It *currently* only work if there is a user, so it won't work
* for public/static embedding.
*/
- // eslint-disable-next-line metabase/no-literal-metabase-strings -- Header name, not a user facing string
DEFAULT_OPTIONS.headers["X-Metabase-Locale"] = locale ?? undefined;
};
diff --git a/src/metabase/analytics/sdk.clj b/src/metabase/analytics/sdk.clj
index e17297a90ad..65451e7f8f5 100644
--- a/src/metabase/analytics/sdk.clj
+++ b/src/metabase/analytics/sdk.clj
@@ -62,8 +62,9 @@
(fn embedding-mw-fn
[request respond raise]
(let [sdk-client (get-in request [:headers "x-metabase-client"])
- version (get-in request [:headers "x-metabase-client-version"])]
- (binding [*client* sdk-client
+ version (get-in request [:headers "x-metabase-client-version"])
+ preview? (= (get-in request [:headers "x-metabase-embedded-preview"]) "true")]
+ (binding [*client* (if preview? (str sdk-client "-preview") sdk-client)
*version* version]
(handler request
(fn responder [response]