Skip to content

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

Allow customizing filters values for subscriptions on modular embedding (#67249)

Mahatthana (Kelvin) Nomsawadi68c0efa9cd7c
diff --git a/e2e/test-component/scenarios/embedding-sdk/subscriptions.cy.spec.tsx b/e2e/test-component/scenarios/embedding-sdk/subscriptions.cy.spec.tsx
index a4277385c73..ffd0bd46f2f 100644
--- a/e2e/test-component/scenarios/embedding-sdk/subscriptions.cy.spec.tsx
+++ b/e2e/test-component/scenarios/embedding-sdk/subscriptions.cy.spec.tsx
@@ -5,6 +5,7 @@ import {
StaticDashboard,
} from "@metabase/embedding-sdk-react";
+import { SAMPLE_DATABASE } from "e2e/support/cypress_sample_database";
import {
ORDERS_DASHBOARD_DASHCARD_ID,
ORDERS_QUESTION_ID,
@@ -14,11 +15,21 @@ import { getSdkRoot } from "e2e/support/helpers/e2e-embedding-sdk-helpers";
import { mountSdkContent } from "e2e/support/helpers/embedding-sdk-component-testing";
import { signInAsAdminAndEnableEmbeddingSdk } from "e2e/support/helpers/embedding-sdk-testing";
import { mockAuthProviderAndJwtSignIn } from "e2e/support/helpers/embedding-sdk-testing/embedding-sdk-helpers";
+import type { DashboardParameterMapping } from "metabase-types/api";
+
+const { PRODUCTS } = SAMPLE_DATABASE;
describe("scenarios > embedding-sdk > subscriptions", () => {
beforeEach(() => {
signInAsAdminAndEnableEmbeddingSdk();
+ const parameter = {
+ id: "1b9cd9f1",
+ name: "Category",
+ slug: "category",
+ type: "string/=",
+ sectionId: "string",
+ };
const textCard = getTextCardDetails({ col: 16, text: "Test text card" });
const questionCard = {
id: ORDERS_DASHBOARD_DASHCARD_ID,
@@ -30,11 +41,19 @@ describe("scenarios > embedding-sdk > subscriptions", () => {
visualization_settings: {
"card.title": "Test question card",
},
+ parameter_mappings: [
+ {
+ parameter_id: parameter.id,
+ card_id: ORDERS_QUESTION_ID,
+ target: ["dimension", ["field", PRODUCTS.CATEGORY, null]],
+ } satisfies DashboardParameterMapping,
+ ],
};
createDashboard({
name: "Embedding SDK Test Dashboard",
dashcards: [questionCard, textCard],
+ parameters: [parameter],
}).then(({ body: dashboard }) => {
cy.wrap(dashboard.id).as("dashboardId");
cy.wrap(dashboard.entity_id).as("dashboardEntityId");
@@ -66,6 +85,11 @@ describe("scenarios > embedding-sdk > subscriptions", () => {
cy.icon("subscription").click();
cy.findByText("Email this dashboard").should("be.visible");
+ cy.log("can customize filter values");
+ cy.findByRole("heading", {
+ name: "Set filter values for when this gets sent",
+ }).should("be.visible");
+
cy.findByRole("button", { name: "Done" }).click();
cy.wait("@createPulse");
@@ -91,6 +115,11 @@ describe("scenarios > embedding-sdk > subscriptions", () => {
cy.icon("subscription").click();
cy.findByText("Email this dashboard").should("be.visible");
+ cy.log("can customize filter values");
+ cy.findByRole("heading", {
+ name: "Set filter values for when this gets sent",
+ }).should("be.visible");
+
cy.findByRole("button", { name: "Done" }).click();
cy.wait("@createPulse");
@@ -116,6 +145,11 @@ describe("scenarios > embedding-sdk > subscriptions", () => {
cy.icon("subscription").click();
cy.findByText("Email this dashboard").should("be.visible");
+ cy.log("can customize filter values");
+ cy.findByRole("heading", {
+ name: "Set filter values for when this gets sent",
+ }).should("be.visible");
+
cy.findByRole("button", { name: "Done" }).click();
cy.wait("@createPulse");
diff --git a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-options.cy.spec.ts b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-options.cy.spec.ts
index 0c32a5e5dd6..1b7afbed168 100644
--- a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-options.cy.spec.ts
+++ b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/select-embed-options.cy.spec.ts
@@ -1,3 +1,4 @@
+import { SAMPLE_DATABASE } from "e2e/support/cypress_sample_database";
import { mockEmbedJsToDevServer } from "e2e/support/helpers";
import {
@@ -8,6 +9,8 @@ import {
const { H } = cy;
+const { PRODUCTS, PRODUCTS_ID } = SAMPLE_DATABASE;
+
const DASHBOARD_NAME = "Orders in a dashboard";
const QUESTION_NAME = "Orders, Count";
@@ -222,10 +225,56 @@ describe(suiteTitle, () => {
it("toggles subscriptions for dashboard when email is set up", () => {
H.setupSMTP();
+ const dashboardName = "Dashboard with parameter";
+
+ cy.log("Create a dashboard with a single parameter mapped to a card");
+ const parameter = {
+ id: "1b9cd9f1",
+ name: "Category",
+ slug: "category",
+ type: "string/=",
+ sectionId: "string",
+ };
+
+ const questionDetails = {
+ display: "table",
+ query: { "source-table": PRODUCTS_ID },
+ } as const;
+
+ const dashboardDetails = {
+ name: dashboardName,
+ parameters: [parameter],
+ };
+
+ H.createQuestionAndDashboard({
+ questionDetails,
+ dashboardDetails,
+ }).then(({ body: { id, card_id, dashboard_id } }) => {
+ cy.request("PUT", `/api/dashboard/${dashboard_id}`, {
+ dashcards: [
+ {
+ id,
+ card_id,
+ row: 0,
+ col: 0,
+ size_x: 16,
+ size_y: 8,
+ parameter_mappings: [
+ {
+ parameter_id: parameter.id,
+ card_id,
+ target: ["dimension", ["field", PRODUCTS.CATEGORY, null]],
+ },
+ ],
+ visualization_settings: {},
+ },
+ ],
+ });
+ });
navigateToEmbedOptionsStep({
experience: "dashboard",
- resourceName: DASHBOARD_NAME,
+ resourceName: dashboardName,
preselectSso: true,
});
@@ -255,6 +304,11 @@ describe(suiteTitle, () => {
"be.visible",
);
+ cy.log("can customize filter values");
+ cy.findByRole("heading", {
+ name: "Set filter values for when this gets sent",
+ }).should("be.visible");
+
/**
* It seems `should("be.visible")` above doesn't not work in iframe.
* It can only check the existence of the element but not its visibility.
diff --git a/enterprise/frontend/src/metabase-enterprise/sdk-plugins.ts b/enterprise/frontend/src/metabase-enterprise/sdk-plugins.ts
index a419dd74e66..4d3e4fba71b 100644
--- a/enterprise/frontend/src/metabase-enterprise/sdk-plugins.ts
+++ b/enterprise/frontend/src/metabase-enterprise/sdk-plugins.ts
@@ -12,6 +12,7 @@ import { initializePlugin as initializeContentTranslation } from "./content_tran
import { initializePlugin as initializeEmbedding } from "./embedding";
import { initializePlugin as initializeEmbeddingSdk } from "./embedding-sdk";
import { initializePlugin as initializeMetabot } from "./metabot";
+import { initializePlugin as initializeSharing } from "./sharing";
import { initializePlugin as initializeTenants } from "./tenants";
import { initializePlugin as initializeWhitelabelPlugin } from "./whitelabel";
import { initializePlugin as initializeWhitelabelOverridePlugin } from "./whitelabel/sdk-overrides";
@@ -29,6 +30,7 @@ export function initializePlugins() {
initializeWhitelabelOverridePlugin?.();
initializeContentTranslation?.();
initializeSubscriptions();
+ initializeSharing();
}
// "SDK EE-plugins", that are specific to the embedding sdk.