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
Support passing `dataPicker` to SDK components to force staged data picker (#69631)
Mahatthana (Kelvin) Nomsawadi7fa10713eafe
diff --git a/e2e/test-component/scenarios/embedding-sdk/interactive-dashboard.cy.spec.tsx b/e2e/test-component/scenarios/embedding-sdk/interactive-dashboard.cy.spec.tsxindex 39f2142e1ff..081522df864 100644--- a/e2e/test-component/scenarios/embedding-sdk/interactive-dashboard.cy.spec.tsx+++ b/e2e/test-component/scenarios/embedding-sdk/interactive-dashboard.cy.spec.tsx@@ -213,6 +213,37 @@ describe("scenarios > embedding-sdk > interactive-dashboard", () => {});});+ it('should render staged picker when passing `drillThroughQuestionProps.dataPicker = "staged"`', () => {+ cy.get("@dashboardId").then((dashboardId) => {+ mountSdkContent(+ <InteractiveDashboard+ dashboardId={dashboardId}+ drillThroughQuestionProps={{ dataPicker: "staged" }}+ />,+ );+ });++ getSdkRoot().within(() => {+ getTableCell("User ID", 1).findByText("1").should("be.visible").click();++ H.popover().findByText("View this User's Orders").click();++ cy.button("Edit question").click();++ // Data step+ cy.findByText("Orders").click();++ cy.log("Go back to the bucket step");+ H.popover().within(() => {+ cy.icon("chevronleft").click();+ cy.icon("chevronleft").click();++ cy.findByText("Raw Data").should("be.visible");+ cy.findByText("Models").should("be.visible");+ });+ });+ });+const idTypes = [{idType: "numeric ID",@@ -422,3 +453,19 @@ describe("scenarios > embedding-sdk > interactive-dashboard > tabs", () => {});});});++function getTableCell(columnName, rowIndex) {+ cy.findAllByRole("columnheader").then(($columnHeaders) => {+ const columnHeaderIndex = $columnHeaders+ .toArray()+ .findIndex(($columnHeader) => $columnHeader.textContent === columnName);+ // eslint-disable-next-line metabase/no-unsafe-element-filtering+ cy.findAllByRole("row")+ .eq(rowIndex)+ .findAllByTestId("cell-data")+ .eq(columnHeaderIndex)+ .as("cellData");+ });++ return cy.get("@cellData");+}diff --git a/enterprise/frontend/src/embedding-sdk-package/index.ts b/enterprise/frontend/src/embedding-sdk-package/index.tsindex b2cc4deffc8..b94ecedf99c 100644--- a/enterprise/frontend/src/embedding-sdk-package/index.ts+++ b/enterprise/frontend/src/embedding-sdk-package/index.ts@@ -134,7 +134,10 @@ export type {SqlParameterValues,} from "embedding-sdk-bundle/types";-export type { ModularEmbeddingEntityType } from "metabase-types/store/embedding-data-picker";+export type {+ EmbeddingEntityType,+ EmbeddingDataPicker,+} from "metabase-types/store/embedding-data-picker";export type { ParameterValues } from "metabase/embedding-sdk/types/dashboard";export type { IconName } from "metabase/embedding-sdk/types/icon";diff --git a/enterprise/frontend/src/embedding/data-picker/SimpleDataPicker/SimpleDataPicker.tsx b/enterprise/frontend/src/embedding/data-picker/SimpleDataPicker/SimpleDataPicker.tsxindex b3f7f326a63..27fb3ab37a6 100644--- a/enterprise/frontend/src/embedding/data-picker/SimpleDataPicker/SimpleDataPicker.tsx+++ b/enterprise/frontend/src/embedding/data-picker/SimpleDataPicker/SimpleDataPicker.tsx@@ -8,7 +8,7 @@ import { Box, Popover } from "metabase/ui";import { getQuestionVirtualTableId } from "metabase-lib/v1/metadata/utils/saved-questions";import type { SearchModel, SearchResult, TableId } from "metabase-types/api";import type { SortingOptions } from "metabase-types/api/sorting";-import type { ModularEmbeddingEntityType } from "metabase-types/store/embedding-data-picker";+import type { EmbeddingEntityType } from "metabase-types/store/embedding-data-picker";import { SimpleDataPickerView } from "./SimpleDataPickerView";@@ -103,7 +103,7 @@ function sortEntities(const compareString = (a: string, b: string) => a.localeCompare(b);function translateEntityTypesToSearchModels(- entityTypes: ModularEmbeddingEntityType[],+ entityTypes: EmbeddingEntityType[],): SearchModel[] {const searchModels: SearchModel[] = [];diff --git a/frontend/src/embedding-sdk-bundle/components/private/SdkAdHocQuestion/SdkAdHocQuestion.tsx b/frontend/src/embedding-sdk-bundle/components/private/SdkAdHocQuestion/SdkAdHocQuestion.tsxindex 79fe6b263c6..95ab83725ab 100644--- a/frontend/src/embedding-sdk-bundle/components/private/SdkAdHocQuestion/SdkAdHocQuestion.tsx+++ b/frontend/src/embedding-sdk-bundle/components/private/SdkAdHocQuestion/SdkAdHocQuestion.tsx@@ -24,6 +24,7 @@ export const SdkAdHocQuestion = ({onBeforeSave,onSave,entityTypes,+ dataPicker,isSaveEnabled,targetCollection,withChartTypeSelector = true,@@ -45,6 +46,7 @@ export const SdkAdHocQuestion = ({| "onBeforeSave"| "onSave"| "entityTypes"+ | "dataPicker"| "isSaveEnabled"| "targetCollection"| "withChartTypeSelector"@@ -77,6 +79,7 @@ export const SdkAdHocQuestion = ({onBeforeSave={onBeforeSave}onSave={onSave}entityTypes={entityTypes}+ dataPicker={dataPicker}isSaveEnabled={isSaveEnabled}targetCollection={targetCollection}initialSqlParameters={initialSqlParameters}diff --git a/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/context/SdkQuestionProvider.tsx b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/context/SdkQuestionProvider.tsxindex fbd734e21f5..55c2bc66f26 100644--- a/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/context/SdkQuestionProvider.tsx+++ b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/context/SdkQuestionProvider.tsx@@ -14,7 +14,7 @@ import { QuestionAlertModalProvider } from "embedding-sdk-bundle/components/privimport { useExtractResourceIdFromJwtToken } from "embedding-sdk-bundle/hooks/private/use-extract-resource-id-from-jwt-token";import { useLoadQuestion } from "embedding-sdk-bundle/hooks/private/use-load-question";import { useSetupContentTranslations } from "embedding-sdk-bundle/hooks/private/use-setup-content-translations";-import { useSdkDispatch, useSdkSelector } from "embedding-sdk-bundle/store";+import { useSdkSelector } from "embedding-sdk-bundle/store";import {getError,getIsGuestEmbed,@@ -29,7 +29,7 @@ import {useCreateQuestion,} from "metabase/query_builder/containers/use-create-question";import { useSaveQuestion } from "metabase/query_builder/containers/use-save-question";-import { setEntityTypes } from "metabase/redux/embedding-data-picker";+import { EmbeddingDataPickerContextProvider } from "metabase/querying/notebook/components/NotebookDataPicker/EmbeddingDataPicker/context";import { getEmbeddingMode } from "metabase/visualizations/click-actions/lib/modes";import { EmbeddingSdkMode } from "metabase/visualizations/click-actions/modes/EmbeddingSdkMode";import type { ClickActionModeGetter } from "metabase/visualizations/types";@@ -62,6 +62,7 @@ export const SdkQuestionProvider = ({onRun,isSaveEnabled = true,entityTypes,+ dataPicker,targetCollection,initialSqlParameters,hiddenParameters,@@ -257,12 +258,6 @@ export const SdkQuestionProvider = ({}}, [questionId, question, navigation]);- const dispatch = useSdkDispatch();-- useEffect(() => {- dispatch(setEntityTypes(entityTypes));- }, [dispatch, entityTypes]);-if (isGuestEmbed && isNewQuestion) {return (<SdkError@@ -283,7 +278,12 @@ export const SdkQuestionProvider = ({<SdkQuestionContext.Provider value={questionContext}><EmbeddingEntityContextProvider uuid={null} token={token}><QuestionAlertModalProvider>- {children}+ <EmbeddingDataPickerContextProvider+ dataPicker={dataPicker}+ entityTypes={entityTypes}+ >+ {children}+ </EmbeddingDataPickerContextProvider><SdkQuestionAlertListModal /></QuestionAlertModalProvider></EmbeddingEntityContextProvider>diff --git a/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/context/types.ts b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/context/types.tsindex cf6da2d96ee..ce1aba5a918 100644--- a/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/context/types.ts+++ b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/context/types.ts@@ -18,13 +18,21 @@ import type {import type Question from "metabase-lib/v1/Question";import type { CardDisplayType, DashboardId } from "metabase-types/api";import type { EntityToken } from "metabase-types/api/entity";-import type { ModularEmbeddingEntityType } from "metabase-types/store/embedding-data-picker";+import type {+ EmbeddingDataPicker,+ EmbeddingEntityType,+} from "metabase-types/store/embedding-data-picker";type SdkQuestionConfig = {/*** An array that specifies which entity types are available in the data picker*/- entityTypes?: ModularEmbeddingEntityType[];+ entityTypes?: EmbeddingEntityType[];++ /**+ * Controls the menu for selecting data sources in questions. You can opt for the full data picker by setting `dataPicker = "staged"`.+ */+ dataPicker?: EmbeddingDataPicker;/*** Whether to show the save button.diff --git a/frontend/src/embedding-sdk-bundle/components/public/InteractiveQuestion/InteractiveQuestion.schema.ts b/frontend/src/embedding-sdk-bundle/components/public/InteractiveQuestion/InteractiveQuestion.schema.tsindex a87e4a72856..9630ad0e3ea 100644--- a/frontend/src/embedding-sdk-bundle/components/public/InteractiveQuestion/InteractiveQuestion.schema.ts+++ b/frontend/src/embedding-sdk-bundle/components/public/InteractiveQuestion/InteractiveQuestion.schema.ts@@ -15,6 +15,7 @@ const propsSchema: Yup.SchemaOf<InteractiveQuestionProps> = Yup.object({.noUnknown(),deserializedCard: Yup.mixed().optional(),entityTypes: Yup.mixed().optional(),+ dataPicker: Yup.mixed().optional(),height: Yup.mixed().optional(),initialSqlParameters: Yup.mixed().optional(),hiddenParameters: Yup.mixed().optional(),diff --git a/frontend/src/embedding-sdk-bundle/components/public/InteractiveQuestion/InteractiveQuestion.unit.spec.tsx b/frontend/src/embedding-sdk-bundle/components/public/InteractiveQuestion/InteractiveQuestion.unit.spec.tsxindex 313a49e8fe6..0e581d5387b 100644--- a/frontend/src/embedding-sdk-bundle/components/public/InteractiveQuestion/InteractiveQuestion.unit.spec.tsx+++ b/frontend/src/embedding-sdk-bundle/components/public/InteractiveQuestion/InteractiveQuestion.unit.spec.tsx@@ -1,6 +1,9 @@import userEvent from "@testing-library/user-event";-import { setupEnterpriseOnlyPlugin } from "__support__/enterprise";+import {+ setupEnterpriseOnlyPlugin,+ setupEnterprisePlugins,+} from "__support__/enterprise";import {findRequests,setupAlertsEndpoints,@@ -10,6 +13,8 @@ import {setupCollectionByIdEndpoint,setupDatabaseEndpoints,setupDatabaseListEndpoint,+ setupDatabasesEndpoints,+ setupEmbeddingDataPickerDecisionEndpoints,setupNotificationChannelsEndpoints,setupSearchEndpoints,setupTableEndpoints,@@ -29,6 +34,8 @@ import {import { renderWithSDKProviders } from "embedding-sdk-bundle/test/__support__/ui";import { createMockSdkConfig } from "embedding-sdk-bundle/test/mocks/config";import { setupSdkState } from "embedding-sdk-bundle/test/server-mocks/sdk-init";+import type { SdkQuestionId } from "embedding-sdk-bundle/types/question";+import { createMockModelResult } from "metabase/browse/models/test-utils";import { reinitialize } from "metabase/plugins";import type { CardId, CollectionType, TokenFeatures } from "metabase-types/api";import {@@ -44,6 +51,7 @@ import {createMockUser,} from "metabase-types/api/mocks";import { createMockNotification } from "metabase-types/api/mocks/notification";+import type { EmbeddingDataPicker } from "metabase-types/store/embedding-data-picker";import { InteractiveQuestion } from "./InteractiveQuestion";@@ -559,3 +567,74 @@ describe("InteractiveQuestion", () => {async function findModal() {return await screen.findByRole("dialog");}++describe('questionId: "new"', () => {+ interface SetupOpts {+ questionId?: SdkQuestionId;+ dataPicker?: EmbeddingDataPicker;+ }++ async function setup({ questionId, dataPicker }: SetupOpts = {}) {+ setupDatabasesEndpoints([TEST_DB]);+ setupCollectionByIdEndpoint({+ collections: [createMockCollection({ id: 1 })],+ });+ setupEmbeddingDataPickerDecisionEndpoints("flat");+ setupSearchEndpoints([+ createMockModelResult({+ id: 1,+ name: "Orders model",+ }),+ ]);++ renderWithSDKProviders(+ <InteractiveQuestion questionId={questionId} dataPicker={dataPicker} />,+ {+ componentProviderProps: {+ authConfig: createMockSdkConfig(),+ },+ },+ );++ await waitForLoaderToBeRemoved();+ }++ function findDataPickerPopover() {+ return screen.findByRole("dialog", { name: "Pick your starting data" });+ }++ beforeEach(() => {+ setupEnterprisePlugins();+ });++ it("should render simple data picker the query editor", async () => {+ await setup({ questionId: "new" });++ expect(+ await screen.findByRole("button", { name: "Pick your starting data" }),+ ).toBeVisible();++ expect(+ within(await findDataPickerPopover()).getByRole("link", {+ name: "Orders model",+ }),+ ).toBeVisible();+ });++ it(`should render staged data picker the query editor when passing dataPicker="staged"`, async () => {+ await setup({ questionId: "new", dataPicker: "staged" });++ expect(+ await screen.findByRole("button", { name: "Pick your starting data" }),+ ).toBeVisible();++ const withinPopover = within(await findDataPickerPopover());+ expect(+ withinPopover.queryByRole("link", {+ name: "Orders model",+ }),+ ).not.toBeInTheDocument();+ expect(withinPopover.getByText("Raw Data")).toBeVisible();+ expect(withinPopover.getByText("Models")).toBeVisible();+ });+});diff --git a/frontend/src/embedding-sdk-bundle/components/public/SdkQuestion/SdkQuestion.stories.tsx b/frontend/src/embedding-sdk-bundle/components/public/SdkQuestion/SdkQuestion.stories.tsxindex 80854407a3a..1769d1deaa2 100644--- a/frontend/src/embedding-sdk-bundle/components/public/SdkQuestion/SdkQuestion.stories.tsx+++ b/frontend/src/embedding-sdk-bundle/components/public/SdkQuestion/SdkQuestion.stories.tsx@@ -70,6 +70,10 @@ export default {},},},+ dataPicker: {+ control: { type: "select" },+ options: ["flat", "staged"],+ },},};@@ -203,5 +207,6 @@ export const CreateQuestion = {args: {questionId: "new",entityTypes: ["model"],+ dataPicker: "flat",},};diff --git a/frontend/src/embedding-sdk-bundle/components/public/SdkQuestion/SdkQuestion.tsx b/frontend/src/embedding-sdk-bundle/components/public/SdkQuestion/SdkQuestion.tsxindex 9556c5c24ca..2b45463e25f 100644--- a/frontend/src/embedding-sdk-bundle/components/public/SdkQuestion/SdkQuestion.tsx+++ b/frontend/src/embedding-sdk-bundle/components/public/SdkQuestion/SdkQuestion.tsx@@ -54,6 +54,7 @@ export type BaseSdkQuestionProps = SdkQuestionIdProps & {| "onBeforeSave"| "onSave"| "entityTypes"+ | "dataPicker"| "isSaveEnabled"| "initialSqlParameters"| "withDownloads"@@ -132,6 +133,7 @@ export const _SdkQuestion = ({onRun,isSaveEnabled = true,entityTypes,+ dataPicker,targetCollection,initialSqlParameters,hiddenParameters,@@ -187,6 +189,7 @@ export const _SdkQuestion = ({onRun={onRun}isSaveEnabled={isSaveEnabled}entityTypes={entityTypes}+ dataPicker={dataPicker}targetCollection={targetCollection}initialSqlParameters={initialSqlParameters}hiddenParameters={hiddenParameters}diff --git a/frontend/src/embedding-sdk-bundle/components/public/dashboard/EditableDashboard/EditableDashboard.stories.tsx b/frontend/src/embedding-sdk-bundle/components/public/dashboard/EditableDashboard/EditableDashboard.stories.tsxindex 30132fbc526..bf41c98c1e8 100644--- a/frontend/src/embedding-sdk-bundle/components/public/dashboard/EditableDashboard/EditableDashboard.stories.tsx+++ b/frontend/src/embedding-sdk-bundle/components/public/dashboard/EditableDashboard/EditableDashboard.stories.tsx@@ -32,7 +32,11 @@ const meta = {"dataPickerProps.entityTypes": {control: "check",- options: ["model", "table"] satisfies SdkQuestionProps["entityTypes"],+ options: [+ "model",+ "table",+ "question",+ ] satisfies SdkQuestionProps["entityTypes"],},// Display optionsdiff --git a/frontend/src/embedding-sdk-bundle/components/public/dashboard/EditableDashboard/enterprise.unit.spec.tsx b/frontend/src/embedding-sdk-bundle/components/public/dashboard/EditableDashboard/enterprise.unit.spec.tsxindex 81cc43786aa..1e67dae3b0c 100644--- a/frontend/src/embedding-sdk-bundle/components/public/dashboard/EditableDashboard/enterprise.unit.spec.tsx+++ b/frontend/src/embedding-sdk-bundle/components/public/dashboard/EditableDashboard/enterprise.unit.spec.tsx@@ -177,6 +177,16 @@ describe("EditableDashboard", () => {expect(screen.getByTestId("dashboard-name-heading")).toBeEnabled();});++ // eslint-disable-next-line jest/expect-expect -- Just want to ensure the type passes+ it('should accept "drillThroughQuestionProps.dataPicker"', async () => {+ <EditableDashboard+ dashboardId={1}+ drillThroughQuestionProps={{+ dataPicker: "staged",+ }}+ />;+ });});function setupSimpleDataPickerEndpoints() {diff --git a/frontend/src/embedding-sdk-bundle/components/public/dashboard/InteractiveDashboard/tests/enterprise.unit.spec.tsx b/frontend/src/embedding-sdk-bundle/components/public/dashboard/InteractiveDashboard/tests/enterprise.unit.spec.tsxindex cbd64abbd5e..e7d37eae47a 100644--- a/frontend/src/embedding-sdk-bundle/components/public/dashboard/InteractiveDashboard/tests/enterprise.unit.spec.tsx+++ b/frontend/src/embedding-sdk-bundle/components/public/dashboard/InteractiveDashboard/tests/enterprise.unit.spec.tsx@@ -21,4 +21,14 @@ console.warn = () => {};describe("InteractiveDashboard", () => {addEnterpriseSubscriptionsTests(setupEnterprise);addEnterpriseAutoRefreshTests(setupEnterprise);++ // eslint-disable-next-line jest/expect-expect -- Just want to ensure the type passes+ it('should accept "drillThroughQuestionProps.dataPicker"', async () => {+ <InteractiveDashboard+ dashboardId={1}+ drillThroughQuestionProps={{+ dataPicker: "staged",+ }}+ />;+ });});diff --git a/frontend/src/embedding-sdk-bundle/test/storybook-id-args.ts b/frontend/src/embedding-sdk-bundle/test/storybook-id-args.tsindex 959300f61d9..1b2876069e8 100644--- a/frontend/src/embedding-sdk-bundle/test/storybook-id-args.ts+++ b/frontend/src/embedding-sdk-bundle/test/storybook-id-args.ts@@ -76,7 +76,7 @@ function generateIds(entityId: string) {wrongEntityId:entityId.slice(0, -1) +String.fromCharCode((entityId.at(-1)?.charCodeAt(0) || ZERO_CODE) + 1),- numberId: 12,+ numberId: 1,wrongNumberId: 99999999,};}diff --git a/frontend/src/metabase-types/store/embed.ts b/frontend/src/metabase-types/store/embed.tsindex dd54f8eadc9..622f092225e 100644--- a/frontend/src/metabase-types/store/embed.ts+++ b/frontend/src/metabase-types/store/embed.ts@@ -15,14 +15,16 @@ export interface InteractiveEmbeddingOptions {additional_info: boolean;action_buttons: boolean;data_picker: EmbeddingDataPicker;- /**- * There might be a cleaner way to say this is in a search parameter- * but it's not in the embed reducer, than making this optional.- */- entity_types?: FullAppEmbeddingEntityType[];+ entity_types: FullAppEmbeddingEntityType[];}+// These 2 properties are saved in embedding-data-picker reducer+export type InteractiveEmbeddingOptionsState = Omit<+ InteractiveEmbeddingOptions,+ "data_picker" | "entity_types"+>;+type EmptyObject = Record<string, never>;export interface EmbedState {- options: InteractiveEmbeddingOptions | EmptyObject;+ options: InteractiveEmbeddingOptionsState | EmptyObject;}diff --git a/frontend/src/metabase-types/store/embedding-data-picker.ts b/frontend/src/metabase-types/store/embedding-data-picker.tsindex a6d48122ca1..f2186c9ffeb 100644--- a/frontend/src/metabase-types/store/embedding-data-picker.ts+++ b/frontend/src/metabase-types/store/embedding-data-picker.ts@@ -1,5 +1,6 @@export interface EmbeddingDataPickerState {entityTypes: EmbeddingEntityType[];+ dataPicker: EmbeddingDataPicker;}// Duplicate the type instead, so we see this type name rather than `FullAppEmbeddingEntityType` if we do type EmbeddingEntityType = FullAppEmbeddingEntityType@@ -13,8 +14,4 @@ export type EmbeddingEntityType = "model" | "table" | "question";*/export type FullAppEmbeddingEntityType = "model" | "table" | "question";-// `question` is only applicable to the staged picker, which is rarely used in SDK unless-// there are 100+ combined tables/models.-export type ModularEmbeddingEntityType = "model" | "table";-export type EmbeddingDataPicker = "staged" | "flat";diff --git a/frontend/src/metabase-types/store/mocks/embedding-data-picker.ts b/frontend/src/metabase-types/store/mocks/embedding-data-picker.tsindex 0c6b5bd0be8..deaee91cc6c 100644--- a/frontend/src/metabase-types/store/mocks/embedding-data-picker.ts+++ b/frontend/src/metabase-types/store/mocks/embedding-data-picker.ts@@ -6,5 +6,6 @@ export const createMockEmbeddingDataPickerState = (opts?: Partial<EmbeddingDataPickerState>,): EmbeddingDataPickerState => ({entityTypes: DEFAULT_EMBEDDING_ENTITY_TYPES,+ dataPicker: "flat",...opts,});diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk/types/embed.ts b/frontend/src/metabase/embedding/embedding-iframe-sdk/types/embed.tsindex 535030557f2..7353276fbb3 100644--- a/frontend/src/metabase/embedding/embedding-iframe-sdk/types/embed.ts+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk/types/embed.ts@@ -20,7 +20,7 @@ import type { StrictUnion } from "metabase/embedding-sdk/types/utils";import type { EmbeddedAnalyticsJsEventSchema } from "metabase-types/analytics/embedded-analytics-js";import type { CollectionId } from "metabase-types/api";import type { EntityToken } from "metabase-types/api/entity";-import type { ModularEmbeddingEntityType } from "metabase-types/store/embedding-data-picker";+import type { EmbeddingEntityType } from "metabase-types/store/embedding-data-picker";/** Events that the embed.js script listens for */export type SdkIframeEmbedTagMessage =@@ -154,7 +154,7 @@ export interface BrowserEmbedOptions {collectionEntityTypes?: CollectionBrowserEntityTypes[];/** Which entities to show on the question's data picker */- dataPickerEntityTypes?: ModularEmbeddingEntityType[];+ dataPickerEntityTypes?: EmbeddingEntityType[];/** Whether to show the "New exploration" button. Defaults to true. */withNewQuestion?: boolean;diff --git a/frontend/src/metabase/nav/containers/MainNavbar/MainNavbarContainer/BrowseNavSection.tsx b/frontend/src/metabase/nav/containers/MainNavbar/MainNavbarContainer/BrowseNavSection.tsxindex e9bd6a68f3e..75dd2604c70 100644--- a/frontend/src/metabase/nav/containers/MainNavbar/MainNavbarContainer/BrowseNavSection.tsx+++ b/frontend/src/metabase/nav/containers/MainNavbar/MainNavbarContainer/BrowseNavSection.tsx@@ -3,8 +3,8 @@ import { c, t } from "ttag";import { CollapseSection } from "metabase/common/components/CollapseSection";import { useUserSetting } from "metabase/common/hooks";import { useSelector } from "metabase/lib/redux";+import { getEntityTypes } from "metabase/redux/embedding-data-picker";import { getIsEmbeddingIframe } from "metabase/selectors/embed";-import { getEntityTypes } from "metabase/selectors/embedding-data-picker";import { ActionIcon, Icon, Tooltip } from "metabase/ui";import { PaddedSidebarLink, SidebarHeading } from "../MainNavbar.styled";diff --git a/frontend/src/metabase/nav/containers/MainNavbar/MainNavbarContainer/BrowseNavSection.unit.spec.tsx b/frontend/src/metabase/nav/containers/MainNavbar/MainNavbarContainer/BrowseNavSection.unit.spec.tsxindex d2758afba9a..f986b4509d2 100644--- a/frontend/src/metabase/nav/containers/MainNavbar/MainNavbarContainer/BrowseNavSection.unit.spec.tsx+++ b/frontend/src/metabase/nav/containers/MainNavbar/MainNavbarContainer/BrowseNavSection.unit.spec.tsx@@ -13,8 +13,9 @@ import {} from "__support__/ui";import * as domUtils from "metabase/lib/dom";import { createMockDatabase, createMockUser } from "metabase-types/api/mocks";-import type { ModularEmbeddingEntityType } from "metabase-types/store/embedding-data-picker";+import type { EmbeddingEntityType } from "metabase-types/store/embedding-data-picker";import { createMockState } from "metabase-types/store/mocks";+import { createMockEmbeddingDataPickerState } from "metabase-types/store/mocks/embedding-data-picker";import { BrowseNavSection } from "./BrowseNavSection";@@ -176,7 +177,7 @@ describe("BrowseNavSection", () => {interface SetupOpts {isEmbeddingIframe?: boolean;- entityTypes?: ModularEmbeddingEntityType[];+ entityTypes?: EmbeddingEntityType[];isAdmin?: boolean;}@@ -200,9 +201,9 @@ async function setup({const embeddingDataPickerState = entityTypes? {- embeddingDataPicker: {+ embeddingDataPicker: createMockEmbeddingDataPickerState({entityTypes,- },+ }),}: undefined;diff --git a/frontend/src/metabase/plugins/oss/embedding.ts b/frontend/src/metabase/plugins/oss/embedding.tsindex 59fa2ba98b5..5620664ed93 100644--- a/frontend/src/metabase/plugins/oss/embedding.ts+++ b/frontend/src/metabase/plugins/oss/embedding.ts@@ -3,7 +3,7 @@ import type { ReactNode } from "react";import type { DataSourceSelectorProps } from "metabase/embedding-sdk/types/components/data-picker";import type { TableId } from "metabase-types/api";import type { State } from "metabase-types/store";-import type { ModularEmbeddingEntityType } from "metabase-types/store/embedding-data-picker";+import type { EmbeddingEntityType } from "metabase-types/store/embedding-data-picker";export interface SimpleDataPickerProps {filterByDatabaseId: number | null;@@ -11,7 +11,7 @@ export interface SimpleDataPickerProps {isInitiallyOpen: boolean;triggerElement: ReactNode;setSourceTableFn: (tableId: TableId) => void;- entityTypes: ModularEmbeddingEntityType[];+ entityTypes: EmbeddingEntityType[];}const getDefaultPluginEmbedding = () => ({diff --git a/frontend/src/metabase/querying/notebook/components/NotebookDataPicker/EmbeddingDataPicker/EmbeddingDataPicker.tsx b/frontend/src/metabase/querying/notebook/components/NotebookDataPicker/EmbeddingDataPicker/EmbeddingDataPicker.tsxindex d72464e93d2..c0845734b6a 100644--- a/frontend/src/metabase/querying/notebook/components/NotebookDataPicker/EmbeddingDataPicker/EmbeddingDataPicker.tsx+++ b/frontend/src/metabase/querying/notebook/components/NotebookDataPicker/EmbeddingDataPicker/EmbeddingDataPicker.tsx@@ -1,17 +1,19 @@+import { useContext } from "react";+import { skipToken, useGetCardQuery, useSearchQuery } from "metabase/api";import { useSelector } from "metabase/lib/redux";import { PLUGIN_EMBEDDING } from "metabase/plugins";-import { DEFAULT_EMBEDDING_ENTITY_TYPES } from "metabase/redux/embedding-data-picker";-import { getEmbedOptions } from "metabase/selectors/embed";-import { getEntityTypes } from "metabase/selectors/embedding-data-picker";+import { EmbeddingDataPickerContext } from "metabase/querying/notebook/components/NotebookDataPicker/EmbeddingDataPicker/context";+import {+ DEFAULT_EMBEDDING_ENTITY_TYPES,+ getDataPicker,+ getEntityTypes,+} from "metabase/redux/embedding-data-picker";import { getMetadata } from "metabase/selectors/metadata";import * as Lib from "metabase-lib";import { getQuestionIdFromVirtualTableId } from "metabase-lib/v1/metadata/utils/saved-questions";import type { CardType, TableId } from "metabase-types/api";-import type {- EmbeddingEntityType,- ModularEmbeddingEntityType,-} from "metabase-types/store/embedding-data-picker";+import type { EmbeddingEntityType } from "metabase-types/store/embedding-data-picker";import { DataPickerTarget } from "../DataPickerTarget";@@ -50,11 +52,19 @@ export function EmbeddingDataPicker({* which is incorrect.*/const normalizedCard = pickerInfo?.cardId ? card : undefined;+ const entityTypesFromRedux = useSelector(getEntityTypes);+ const dataPickerFromRedux = useSelector(getDataPicker);+ const queryingContext = useContext(EmbeddingDataPickerContext);- const entityTypes = useSelector(getEntityTypes);- const forceMultiStagedDataPicker = useSelector(- (state) => getEmbedOptions(state).data_picker === "staged",- );+ /**+ * It's by design that we have to check values from both the context and Redux,+ * unlike the dashboard where we always get the values from only the context.+ * Because it's impossible to determine all querying parent components and wrap+ * them with the context provider.+ */+ const entityTypes = queryingContext?.entityTypes ?? entityTypesFromRedux;+ const dataPicker = queryingContext?.dataPicker ?? dataPickerFromRedux;+ const forceMultiStagedDataPicker = dataPicker === "staged";// a table or a virtual table (card)const sourceTable = useSourceTable(query);@@ -105,10 +115,7 @@ export function EmbeddingDataPicker({/>}setSourceTableFn={onChange}- entityTypes={- // We don't care about the extra entity type `question` for simple data picker- simpleDataPickerEntityTypes as ModularEmbeddingEntityType[]- }+ entityTypes={simpleDataPickerEntityTypes}/>);}diff --git a/frontend/src/metabase/querying/notebook/components/NotebookDataPicker/EmbeddingDataPicker/context.tsx b/frontend/src/metabase/querying/notebook/components/NotebookDataPicker/EmbeddingDataPicker/context.tsxnew file mode 100644index 00000000000..1a6e9a2f096--- /dev/null+++ b/frontend/src/metabase/querying/notebook/components/NotebookDataPicker/EmbeddingDataPicker/context.tsx@@ -0,0 +1,46 @@+import { type PropsWithChildren, createContext } from "react";++import {+ DEFAULT_EMBEDDING_DATA_PICKER_STATE,+ normalizeEntityTypes,+} from "metabase/redux/embedding-data-picker";+import type {+ EmbeddingDataPicker,+ EmbeddingEntityType,+} from "metabase-types/store/embedding-data-picker";++interface EmbeddingDataPickerContext {+ entityTypes: EmbeddingEntityType[];+ dataPicker: EmbeddingDataPicker;+}++/**+ * In full-app embedding, parameters are passed via the URL and stored in Redux. In modular embeddings,+ * parameters are passed directly via props and to the SDK context. However, we cannot access SDK context+ * in the OSS codebase, so we need to create an OSS context to receive these props from modular embeddings.+ *+ * We won't provide a function like `useQueryingContext` similar to `useDashboardContext` where+ * we throw an error if the caller calls the function outside of the context provider, because+ * I cannot pinpoint all the entry points where we should put the context, as querying is used in many places,+ * unlike what we did for dashboards. Instead, we use the context and if the values are absent,+ * we fall back to the values from Redux.+ *+ * Currently, this context is only used in the embedding data picker.+ */+export const EmbeddingDataPickerContext = createContext<+ EmbeddingDataPickerContext | undefined+>(undefined);++export function EmbeddingDataPickerContextProvider({+ entityTypes = DEFAULT_EMBEDDING_DATA_PICKER_STATE.entityTypes,+ dataPicker = DEFAULT_EMBEDDING_DATA_PICKER_STATE.dataPicker,+ children,+}: PropsWithChildren<Partial<EmbeddingDataPickerContext>>) {+ return (+ <EmbeddingDataPickerContext.Provider+ value={{ entityTypes: normalizeEntityTypes(entityTypes), dataPicker }}+ >+ {children}+ </EmbeddingDataPickerContext.Provider>+ );+}diff --git a/frontend/src/metabase/querying/notebook/components/NotebookDataPicker/EmbeddingDataPicker/tests/setup.tsx b/frontend/src/metabase/querying/notebook/components/NotebookDataPicker/EmbeddingDataPicker/tests/setup.tsxindex 224c363e67b..0e335f5edab 100644--- a/frontend/src/metabase/querying/notebook/components/NotebookDataPicker/EmbeddingDataPicker/tests/setup.tsx+++ b/frontend/src/metabase/querying/notebook/components/NotebookDataPicker/EmbeddingDataPicker/tests/setup.tsx@@ -16,6 +16,7 @@ import {} from "metabase-types/api/mocks/presets";import type { EmbeddingEntityType } from "metabase-types/store/embedding-data-picker";import { createMockState } from "metabase-types/store/mocks";+import { createMockEmbeddingDataPickerState } from "metabase-types/store/mocks/embedding-data-picker";import { EmbeddingDataPicker } from "../EmbeddingDataPicker";@@ -56,9 +57,9 @@ export function setup({entityTypes? {storeInitialState: createMockState({- embeddingDataPicker: {+ embeddingDataPicker: createMockEmbeddingDataPickerState({entityTypes,- },+ }),}),}: undefined,diff --git a/frontend/src/metabase/redux/embed/embed.ts b/frontend/src/metabase/redux/embed/embed.tsindex 4dd516da41f..dc1ee4f277e 100644--- a/frontend/src/metabase/redux/embed/embed.ts+++ b/frontend/src/metabase/redux/embed/embed.ts@@ -8,16 +8,20 @@ import { compose, pick } from "underscore";import { parseSearchOptions } from "metabase/lib/browser";import {DEFAULT_EMBEDDING_ENTITY_TYPES,+ setDataPicker,setEntityTypes,} from "metabase/redux/embedding-data-picker";-import type { InteractiveEmbeddingOptions } from "metabase-types/store";+import type {+ InteractiveEmbeddingOptions,+ InteractiveEmbeddingOptionsState,+} from "metabase-types/store";import type { EmbeddingDataPicker } from "metabase-types/store/embedding-data-picker";export const createSlice = buildCreateSlice({creators: { asyncThunk: asyncThunkCreator },});-export const DEFAULT_INTERACTIVE_EMBEDDING_OPTIONS: InteractiveEmbeddingOptions =+export const DEFAULT_INTERACTIVE_EMBEDDING_OPTIONS: InteractiveEmbeddingOptionsState ={font: undefined,top_nav: true,@@ -29,14 +33,15 @@ export const DEFAULT_INTERACTIVE_EMBEDDING_OPTIONS: InteractiveEmbeddingOptionsheader: true,additional_info: true,action_buttons: true,- data_picker: "flat",};-const ALLOWED_INTERACTIVE_EMBEDDING_OPTIONS = Object.keys(- DEFAULT_INTERACTIVE_EMBEDDING_OPTIONS,+const ALLOWED_INTERACTIVE_EMBEDDING_OPTIONS = (+ Object.keys(+ DEFAULT_INTERACTIVE_EMBEDDING_OPTIONS,+ ) as (keyof InteractiveEmbeddingOptions)[])- // `entity_types` used to be in the embed slice, but it's moved to the embedding data picker slice already.- .concat("entity_types");+ // These 2 properties belongs in embedding-data-picker reducer+ .concat("entity_types", "data_picker");export const urlParameterToBoolean = (urlParameter: string | string[] | boolean | undefined,@@ -57,15 +62,17 @@ interface Location {const interactiveEmbedSlice = createSlice({name: "interactiveEmbed",initialState: {- options: {} as InteractiveEmbeddingOptions,+ options: {} as InteractiveEmbeddingOptionsState,isEmbeddingSdk: false,},reducers: (create) => ({setInitialUrlOptions: create.asyncThunk(({ search }: Location, { dispatch }) => {- const { entity_types, ...searchOptions } = processSearch(search);+ const { entity_types, data_picker, ...searchOptions } =+ processSearch(search);dispatch(setEntityTypes(entity_types));+ dispatch(setDataPicker(data_picker));return searchOptions;},diff --git a/frontend/src/metabase/redux/embedding-data-picker.ts b/frontend/src/metabase/redux/embedding-data-picker.tsindex 58346f06c2e..bbacb32f549 100644--- a/frontend/src/metabase/redux/embedding-data-picker.ts+++ b/frontend/src/metabase/redux/embedding-data-picker.ts@@ -2,7 +2,12 @@ import type { PayloadAction } from "@reduxjs/toolkit";import { createSlice } from "@reduxjs/toolkit";import _ from "underscore";+/**+ * This slice is only used in full-app embedding. As in modular embeddings, we'd pass the `entityTypes`+ * and `dataPicker`as props to the data picker component, instead of relying on the global state.+ */import type {+ EmbeddingDataPicker,EmbeddingDataPickerState,EmbeddingEntityType,} from "metabase-types/store/embedding-data-picker";@@ -14,6 +19,7 @@ export const DEFAULT_EMBEDDING_ENTITY_TYPES: EmbeddingEntityType[] = [export const DEFAULT_EMBEDDING_DATA_PICKER_STATE: EmbeddingDataPickerState = {entityTypes: DEFAULT_EMBEDDING_ENTITY_TYPES,+ dataPicker: "flat",};const embeddingDataPickerSlice = createSlice({@@ -31,6 +37,18 @@ const embeddingDataPickerSlice = createSlice({}}},+ setDataPicker: (+ state,+ action: PayloadAction<EmbeddingDataPicker | undefined>,+ ) => {+ if (action.payload) {+ state.dataPicker = action.payload;+ }+ },+ },+ selectors: {+ getEntityTypes: (state) => state.entityTypes,+ getDataPicker: (state) => state.dataPicker,},});@@ -39,7 +57,7 @@ const embeddingDataPickerSlice = createSlice({* As it could not be empty, it needs at least a single valid value. e.g. `["model"]`, or `["model", "table"]`,* but never `[]`.*/-function normalizeEntityTypes(+export function normalizeEntityTypes(entityTypes: EmbeddingEntityType[],): EmbeddingEntityType[] {const ALLOWED_ENTITY_TYPES: EmbeddingEntityType[] = [@@ -59,6 +77,10 @@ function normalizeEntityTypes(return filteredEntityTypes;}-export const { setEntityTypes } = embeddingDataPickerSlice.actions;+export const { setEntityTypes, setDataPicker } =+ embeddingDataPickerSlice.actions;++export const { getEntityTypes, getDataPicker } =+ embeddingDataPickerSlice.selectors;export const { reducer } = embeddingDataPickerSlice;diff --git a/frontend/src/metabase/selectors/embed.ts b/frontend/src/metabase/selectors/embed.tsindex 22805d90ec1..cc7b4a55351 100644--- a/frontend/src/metabase/selectors/embed.ts+++ b/frontend/src/metabase/selectors/embed.ts@@ -2,7 +2,10 @@ import { createSelector } from "@reduxjs/toolkit";import { isEmbeddingSdk } from "metabase/embedding-sdk/config";import { isWithinIframe } from "metabase/lib/dom";-import type { InteractiveEmbeddingOptions, State } from "metabase-types/store";+import type {+ InteractiveEmbeddingOptionsState,+ State,+} from "metabase-types/store";export const getIsEmbeddingIframe = (_state?: State): boolean => {return isWithinIframe();@@ -11,7 +14,7 @@ export const getIsEmbeddingIframe = (_state?: State): boolean => {type EmptyObject = Record<string, never>;export const getEmbedOptions = (state: State,-): InteractiveEmbeddingOptions | EmptyObject => {+): InteractiveEmbeddingOptionsState | EmptyObject => {return state.embed.options;};diff --git a/frontend/src/metabase/selectors/embedding-data-picker.ts b/frontend/src/metabase/selectors/embedding-data-picker.tsdeleted file mode 100644index 471ff526bd8..00000000000--- a/frontend/src/metabase/selectors/embedding-data-picker.ts+++ /dev/null@@ -1,6 +0,0 @@-import type { State } from "metabase-types/store";-import type { EmbeddingEntityType } from "metabase-types/store/embedding-data-picker";--export const getEntityTypes = (state: State): EmbeddingEntityType[] => {- return state.embeddingDataPicker.entityTypes;-};