Skip to content

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

Closes EMB-1042 removed flaky e2e test and adds a unit test instead (#66424)

Sébastien421ac355e411
diff --git a/e2e/test/scenarios/embedding/embedding-dashboard.cy.spec.js b/e2e/test/scenarios/embedding/embedding-dashboard.cy.spec.js
index 03c72fb1333..e305942d2eb 100644
--- a/e2e/test/scenarios/embedding/embedding-dashboard.cy.spec.js
+++ b/e2e/test/scenarios/embedding/embedding-dashboard.cy.spec.js
@@ -418,49 +418,6 @@ describe("scenarios > embedding > dashboard parameters", () => {
});
});
- it("should allow searching dashboard parameters in preview embed modal", () => {
- H.visitDashboard("@dashboardId");
-
- cy.get("@dashboardId").then((dashboardId) => {
- H.openLegacyStaticEmbeddingModal({
- resource: "dashboard",
- resourceId: dashboardId,
- activeTab: "parameters",
- previewMode: "preview",
- });
- });
-
- H.modal().within(() => {
- // Set the Name parameter to enabled so we can test searching
- cy.findByText("Name")
- .parent()
- .within(() => {
- cy.findByText("Disabled").click();
- });
- });
-
- H.popover().findByText("Editable").click();
-
- // Test the preview iframe parameter search functionality
- H.getIframeBody().within(() => {
- // Open the Name filter dropdown
- cy.findByTestId("dashboard-parameters-widget-container")
- .findByText("Name")
- .click();
-
- // Test searching for names containing specific text
- cy.findByPlaceholderText("Search by Name").type("Af");
-
- // Verify that search results are filtered
- H.popover().within(() => {
- // Should show names containing "Af"
- cy.findByText("Afton Lesch").should("be.visible");
- // Should not show names that don't match the search
- cy.findByText("Lina Heaney").should("not.exist");
- });
- });
- });
-
it("should render error message when `params` is not an object (metabase#14474)", () => {
cy.get("@dashboardId").then((dashboardId) => {
cy.request("PUT", `/api/dashboard/${dashboardId}`, {
diff --git a/frontend/src/embedding-sdk-bundle/lib/override-requests-for-guest-embeds.ts b/frontend/src/embedding-sdk-bundle/lib/override-requests-for-guest-embeds.ts
index 42f2b78986f..c29fdb3497e 100644
--- a/frontend/src/embedding-sdk-bundle/lib/override-requests-for-guest-embeds.ts
+++ b/frontend/src/embedding-sdk-bundle/lib/override-requests-for-guest-embeds.ts
@@ -3,7 +3,7 @@ import {
PLUGIN_CONTENT_TRANSLATION,
PLUGIN_EMBEDDING_SDK,
} from "metabase/plugins";
-import { embedBase, internalBase } from "metabase/services";
+import { getEmbedBase, internalBase } from "metabase/services";
const getIgnoreOverridePatterns = () => [
sessionPropertiesPath,
@@ -34,35 +34,35 @@ const EMBED_URL_TRANSFORMATIONS: Record<
{ url: string; method: "GET" | "POST" }
> = {
[URL_PATTERNS.CARD_QUERY]: {
- url: `${embedBase}/card/:token/query`,
+ url: `${getEmbedBase()}/card/:token/query`,
method: "GET",
},
[URL_PATTERNS.CARD_PIVOT_QUERY]: {
- url: `${embedBase}/pivot/card/:token/query`,
+ url: `${getEmbedBase()}/pivot/card/:token/query`,
method: "GET",
},
[URL_PATTERNS.CARD_PARAMETER_VALUES]: {
- url: `${embedBase}/card/:token/params/:paramId/values`,
+ url: `${getEmbedBase()}/card/:token/params/:paramId/values`,
method: "GET",
},
[URL_PATTERNS.CARD_PARAMETER_SEARCH]: {
- url: `${embedBase}/card/:token/params/:paramId/search/:query`,
+ url: `${getEmbedBase()}/card/:token/params/:paramId/search/:query`,
method: "GET",
},
[URL_PATTERNS.CARD_PARAMETER_REMAPPING]: {
- url: `${embedBase}/card/:token/params/:paramId/remapping`,
+ url: `${getEmbedBase()}/card/:token/params/:paramId/remapping`,
method: "GET",
},
[URL_PATTERNS.DASHBOARD_PARAMETER_VALUES]: {
- url: `${embedBase}/dashboard/:token/params/:paramId/values`,
+ url: `${getEmbedBase()}/dashboard/:token/params/:paramId/values`,
method: "GET",
},
[URL_PATTERNS.DASHBOARD_PARAMETER_SEARCH]: {
- url: `${embedBase}/dashboard/:token/params/:paramId/search/:query`,
+ url: `${getEmbedBase()}/dashboard/:token/params/:paramId/search/:query`,
method: "GET",
},
[URL_PATTERNS.DASHBOARD_PARAMETER_REMAPPING]: {
- url: `${embedBase}/dashboard/:token/params/:paramId/remapping`,
+ url: `${getEmbedBase()}/dashboard/:token/params/:paramId/remapping`,
method: "GET",
},
} as const;
@@ -149,8 +149,8 @@ function getRequestTransformation({
* Replaces the standard API base path with the embed API base path.
*/
function replaceWithEmbedBase(url: string): string {
- if (url.includes(internalBase) && !url.includes(embedBase)) {
- return url.replace(internalBase, embedBase);
+ if (url.includes(internalBase) && !url.includes(getEmbedBase())) {
+ return url.replace(internalBase, getEmbedBase());
}
return url;
}
diff --git a/frontend/src/metabase/get-is-embed-preview.ts b/frontend/src/metabase/get-is-embed-preview.ts
new file mode 100644
index 00000000000..79f861fd274
--- /dev/null
+++ b/frontend/src/metabase/get-is-embed-preview.ts
@@ -0,0 +1,10 @@
+import { IS_EMBED_PREVIEW } from "metabase/lib/embed";
+
+/**
+ * The only point of putting this into its own function
+ * is so we can mock it up in tests.
+ * @internal
+ */
+export const getIsEmbedPreview = (): boolean => {
+ return IS_EMBED_PREVIEW;
+};
diff --git a/frontend/src/metabase/services.js b/frontend/src/metabase/services.js
index 43aa8d66287..ac19da301e4 100644
--- a/frontend/src/metabase/services.js
+++ b/frontend/src/metabase/services.js
@@ -1,17 +1,20 @@
import _ from "underscore";
import api, { DELETE, GET, POST, PUT } from "metabase/lib/api";
-import { IS_EMBED_PREVIEW } from "metabase/lib/embed";
import { PLUGIN_API, PLUGIN_CONTENT_TRANSLATION } from "metabase/plugins";
import Question from "metabase-lib/v1/Question";
import { normalizeParameters } from "metabase-lib/v1/parameters/utils/parameter-values";
import { isNative } from "metabase-lib/v1/queries/utils/card";
import { getPivotOptions } from "metabase-lib/v1/queries/utils/pivot";
+import { getIsEmbedPreview } from "./get-is-embed-preview";
+
export const internalBase = "/api";
export const publicBase = "/api/public";
// use different endpoints for embed previews
-export const embedBase = IS_EMBED_PREVIEW ? "/api/preview_embed" : "/api/embed";
+export function getEmbedBase() {
+ return getIsEmbedPreview() ? "/api/preview_embed" : "/api/embed";
+}
export const ActivityApi = {
most_recently_viewed_dashboard: GET(
@@ -205,15 +208,16 @@ export const PublicApi = {
};
export const EmbedApi = {
- card: GET(embedBase + "/card/:token"),
- cardQuery: GET(embedBase + "/card/:token/query"),
- cardQueryPivot: GET(embedBase + "/pivot/card/:token/query"),
- dashboard: GET(embedBase + "/dashboard/:token"),
+ card: GET(getEmbedBase() + "/card/:token"),
+ cardQuery: GET(getEmbedBase() + "/card/:token/query"),
+ cardQueryPivot: GET(getEmbedBase() + "/pivot/card/:token/query"),
+ dashboard: GET(getEmbedBase() + "/dashboard/:token"),
dashboardCardQuery: GET(
- embedBase + "/dashboard/:token/dashcard/:dashcardId/card/:cardId",
+ getEmbedBase() + "/dashboard/:token/dashcard/:dashcardId/card/:cardId",
),
dashboardCardQueryPivot: GET(
- embedBase + "/pivot/dashboard/:token/dashcard/:dashcardId/card/:cardId",
+ getEmbedBase() +
+ "/pivot/dashboard/:token/dashcard/:dashcardId/card/:cardId",
),
};
@@ -349,7 +353,7 @@ export function setPublicDashboardEndpoints(uuid) {
*/
export function setEmbedQuestionEndpoints(token) {
const encodedToken = encodeURIComponent(token);
- setCardEndpoints({ base: embedBase, encodedToken });
+ setCardEndpoints({ base: getEmbedBase(), encodedToken });
PLUGIN_CONTENT_TRANSLATION.setEndpointsForStaticEmbedding(encodedToken);
}
@@ -358,7 +362,7 @@ export function setEmbedQuestionEndpoints(token) {
*/
export function setEmbedDashboardEndpoints(token) {
const encodedToken = encodeURIComponent(token);
- setDashboardEndpoints({ base: embedBase, encodedToken });
+ setDashboardEndpoints({ base: getEmbedBase(), encodedToken });
PLUGIN_CONTENT_TRANSLATION.setEndpointsForStaticEmbedding(encodedToken);
}
diff --git a/frontend/src/metabase/services.unit.spec.ts b/frontend/src/metabase/services.unit.spec.ts
index 7b0bb589e48..3a4e4bae323 100644
--- a/frontend/src/metabase/services.unit.spec.ts
+++ b/frontend/src/metabase/services.unit.spec.ts
@@ -23,7 +23,12 @@ import {
} from "metabase-types/api/mocks/presets";
import { createMockState } from "metabase-types/store/mocks";
-import { runQuestionQuery } from "./services";
+import * as getIsEmbedPreviewModule from "./get-is-embed-preview";
+import {
+ DashboardApi,
+ runQuestionQuery,
+ setEmbedDashboardEndpoints,
+} from "./services";
const MOCK_QUERY = createMockStructuredDatasetQuery({
database: SAMPLE_DB_ID,
@@ -201,3 +206,52 @@ describe("metabase/services > runQuestionQuery", () => {
});
});
});
+
+describe("DashboardApi parameter endpoints with IS_EMBED_PREVIEW", () => {
+ let isEmbedPreviewMock: jest.SpyInstance<boolean, []>;
+
+ beforeEach(() => {
+ isEmbedPreviewMock = jest.spyOn(
+ getIsEmbedPreviewModule,
+ "getIsEmbedPreview",
+ );
+ });
+
+ it("should use /api/embed prefix when IS_EMBED_PREVIEW is false", async () => {
+ isEmbedPreviewMock.mockReturnValue(false);
+
+ setEmbedDashboardEndpoints("test-token");
+
+ fetchMock.get(
+ "path:/api/embed/dashboard/test-token/params/param1/values",
+ {},
+ );
+
+ await DashboardApi.parameterValues({ dashId: "123", paramId: "param1" });
+
+ expect(
+ fetchMock.callHistory.called(
+ "path:/api/embed/dashboard/test-token/params/param1/values",
+ ),
+ ).toBe(true);
+ });
+
+ it("should use /api/preview_embed prefix when IS_EMBED_PREVIEW is true", async () => {
+ isEmbedPreviewMock.mockReturnValue(true);
+
+ setEmbedDashboardEndpoints("test-token");
+
+ fetchMock.get(
+ "path:/api/preview_embed/dashboard/test-token/params/param1/values",
+ {},
+ );
+
+ await DashboardApi.parameterValues({ dashId: "123", paramId: "param1" });
+
+ expect(
+ fetchMock.callHistory.called(
+ "path:/api/preview_embed/dashboard/test-token/params/param1/values",
+ ),
+ ).toBe(true);
+ });
+});