Skip to content

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

[1 of 3] Add MetabaseTestProvider for unit testing SDK code (#85728)

Alexander Polyankin3e03280a816b
diff --git a/bin/embedding-sdk/fixup-types-after-compilation.js b/bin/embedding-sdk/fixup-types-after-compilation.js
index 2c960500af1..3bf8d441c56 100644
--- a/bin/embedding-sdk/fixup-types-after-compilation.js
+++ b/bin/embedding-sdk/fixup-types-after-compilation.js
@@ -51,6 +51,17 @@ const DTS_ROLLUPS = [
"../../resources/embedding-sdk/dist/enterprise/frontend/src/embedding-sdk-package/data-app.d.ts",
),
},
+ {
+ name: "testing",
+ configPath: path.join(
+ __dirname,
+ "../../enterprise/frontend/src/embedding-sdk-package/embedding-sdk-testing-api-extractor.json",
+ ),
+ entryPointPath: path.join(
+ __dirname,
+ "../../resources/embedding-sdk/dist/enterprise/frontend/src/embedding-sdk-package/testing.d.ts",
+ ),
+ },
{
name: "data-app-dev",
configPath: path.join(
diff --git a/enterprise/frontend/src/embedding-sdk-package/bin/generate-package-support-files.ts b/enterprise/frontend/src/embedding-sdk-package/bin/generate-package-support-files.ts
index 78e96ecee1e..adf5ebf042a 100644
--- a/enterprise/frontend/src/embedding-sdk-package/bin/generate-package-support-files.ts
+++ b/enterprise/frontend/src/embedding-sdk-package/bin/generate-package-support-files.ts
@@ -48,6 +48,19 @@ export * from "./data-app.esm.js";
writeToFile("data-app.cjs", dataApp_cjs);
writeToFile("data-app.js", dataApp_js);
+const testing_cjs = `
+const Testing = require("./testing.bundle");
+
+module.exports = Testing;
+`.trim();
+
+const testing_js = `
+export * from "./testing.esm.js";
+`.trim();
+
+writeToFile("testing.cjs", testing_cjs);
+writeToFile("testing.js", testing_js);
+
// The data-app dev preset (`data-app-dev.js`, ESM-only) and the dev entry
// (`data-app-dev-entry.js`) are emitted directly by the rspack builds, so they
// need no wrappers here.
diff --git a/enterprise/frontend/src/embedding-sdk-package/embedding-sdk-testing-api-extractor.json b/enterprise/frontend/src/embedding-sdk-package/embedding-sdk-testing-api-extractor.json
new file mode 100644
index 00000000000..11ef95db6e9
--- /dev/null
+++ b/enterprise/frontend/src/embedding-sdk-package/embedding-sdk-testing-api-extractor.json
@@ -0,0 +1,25 @@
+{
+ "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+ "mainEntryPointFilePath": "<projectFolder>/resources/embedding-sdk/dist/enterprise/frontend/src/embedding-sdk-package/testing.d.ts",
+ "bundledPackages": [],
+ "apiReport": {
+ "enabled": false
+ },
+ "docModel": {
+ "enabled": false
+ },
+ "dtsRollup": {
+ "enabled": true,
+ "untrimmedFilePath": "<projectFolder>/resources/embedding-sdk/dist/testing.d.ts"
+ },
+ "tsdocMetadata": {
+ "enabled": false
+ },
+ "messages": {
+ "extractorMessageReporting": {
+ "ae-wrong-input-file-type": {
+ "logLevel": "none"
+ }
+ }
+ }
+}
diff --git a/enterprise/frontend/src/embedding-sdk-package/package.template.json b/enterprise/frontend/src/embedding-sdk-package/package.template.json
index 62c7606540a..269a5b2059e 100644
--- a/enterprise/frontend/src/embedding-sdk-package/package.template.json
+++ b/enterprise/frontend/src/embedding-sdk-package/package.template.json
@@ -28,6 +28,11 @@
"require": "./dist/data-app.cjs",
"import": "./dist/data-app.js"
},
+ "./testing": {
+ "types": "./dist/testing.d.ts",
+ "require": "./dist/testing.cjs",
+ "import": "./dist/testing.js"
+ },
"./data-app-dev": {
"types": "./dist/data-app-dev.d.ts",
"import": "./dist/data-app-dev.js"
diff --git a/enterprise/frontend/src/embedding-sdk-package/testing.ts b/enterprise/frontend/src/embedding-sdk-package/testing.ts
new file mode 100644
index 00000000000..004d62ebd9a
--- /dev/null
+++ b/enterprise/frontend/src/embedding-sdk-package/testing.ts
@@ -0,0 +1,12 @@
+export {
+ MetabaseTestProvider,
+ type MetabaseTestOptions,
+ type MetabaseTestProviderProps,
+} from "./testing/components/MetabaseTestProvider";
+export {
+ createMockCollection,
+ createMockCollectionItem,
+ createMockDashboard,
+ createMockQuestion,
+ createMockUser,
+} from "./testing/lib/public/mocks";
diff --git a/enterprise/frontend/src/embedding-sdk-package/testing/components/MetabaseTestProvider/MetabaseTestProvider.tsx b/enterprise/frontend/src/embedding-sdk-package/testing/components/MetabaseTestProvider/MetabaseTestProvider.tsx
new file mode 100644
index 00000000000..e22baf4eece
--- /dev/null
+++ b/enterprise/frontend/src/embedding-sdk-package/testing/components/MetabaseTestProvider/MetabaseTestProvider.tsx
@@ -0,0 +1,65 @@
+import {
+ type ComponentType,
+ type ReactNode,
+ useLayoutEffect,
+ useState,
+} from "react";
+
+import type { CollectionBrowserProps } from "embedding-sdk-bundle/components/public/CollectionBrowser";
+import type { CreateDashboardModalProps } from "embedding-sdk-bundle/components/public/CreateDashboardModal";
+import type { CreateQuestionProps } from "embedding-sdk-bundle/components/public/CreateQuestion";
+import type { DateRangeCalendarProps } from "embedding-sdk-bundle/components/public/DateRangeCalendar/DateRangeCalendar";
+import type { DateRangePopoverProps } from "embedding-sdk-bundle/components/public/DateRangePopover/DateRangePopover";
+import type { InteractiveQuestionProps } from "embedding-sdk-bundle/components/public/InteractiveQuestion/InteractiveQuestion";
+import type { MetabotQuestionProps } from "embedding-sdk-bundle/components/public/MetabotQuestion";
+import type { StaticQuestionProps } from "embedding-sdk-bundle/components/public/StaticQuestion/StaticQuestion";
+import type {
+ EditableDashboardProps,
+ InteractiveDashboardProps,
+ StaticDashboardProps,
+} from "embedding-sdk-bundle/components/public/dashboard";
+import type {
+ LoginStatus,
+ MetabaseUser,
+} from "embedding-sdk-bundle/types/user";
+import { createMockSdkBundle } from "embedding-sdk-package/testing/lib/private/bundle";
+import { installMockSdk } from "embedding-sdk-package/testing/lib/private/install";
+
+export type MetabaseTestOptions = {
+ CollectionBrowser?: ComponentType<CollectionBrowserProps>;
+ CreateDashboardModal?: ComponentType<CreateDashboardModalProps>;
+ CreateQuestion?: ComponentType<CreateQuestionProps>;
+ DateRangeCalendar?: ComponentType<DateRangeCalendarProps>;
+ DateRangePopover?: ComponentType<DateRangePopoverProps>;
+ EditableDashboard?: ComponentType<EditableDashboardProps>;
+ InteractiveDashboard?: ComponentType<InteractiveDashboardProps>;
+ InteractiveQuestion?: ComponentType<InteractiveQuestionProps>;
+ MetabotQuestion?: ComponentType<MetabotQuestionProps>;
+ StaticDashboard?: ComponentType<StaticDashboardProps>;
+ StaticQuestion?: ComponentType<StaticQuestionProps>;
+ user?: MetabaseUser | null;
+ loginStatus?: LoginStatus;
+ applicationName?: string;
+ availableFonts?: string[];
+};
+
+export type MetabaseTestProviderProps = MetabaseTestOptions & {
+ children?: ReactNode;
+};
+
+export function MetabaseTestProvider({
+ children,
+ ...options
+}: MetabaseTestProviderProps) {
+ const [bundle] = useState(() => createMockSdkBundle(options));
+ const [isInstalled, setIsInstalled] = useState(false);
+
+ useLayoutEffect(() => {
+ const uninstall = installMockSdk(bundle);
+ setIsInstalled(true);
+
+ return uninstall;
+ }, [bundle]);
+
+ return isInstalled ? children : null;
+}
diff --git a/enterprise/frontend/src/embedding-sdk-package/testing/components/MetabaseTestProvider/MetabaseTestProvider.unit.spec.tsx b/enterprise/frontend/src/embedding-sdk-package/testing/components/MetabaseTestProvider/MetabaseTestProvider.unit.spec.tsx
new file mode 100644
index 00000000000..e1b8f77b5ef
--- /dev/null
+++ b/enterprise/frontend/src/embedding-sdk-package/testing/components/MetabaseTestProvider/MetabaseTestProvider.unit.spec.tsx
@@ -0,0 +1,203 @@
+import { render, screen, waitFor } from "@testing-library/react";
+import userEvent from "@testing-library/user-event";
+import { StrictMode, useState } from "react";
+
+import { CreateDashboardModal } from "embedding-sdk-package/components/public/CreateDashboardModal";
+import { InteractiveQuestion } from "embedding-sdk-package/components/public/InteractiveQuestion";
+import { StaticQuestion } from "embedding-sdk-package/components/public/StaticQuestion";
+import {
+ SDK_COMPONENT_NOT_YET_AVAILABLE_MESSAGE,
+ SDK_NOT_LOADED_YET_MESSAGE,
+} from "embedding-sdk-package/constants/error-messages";
+import { useApplicationName } from "embedding-sdk-package/hooks/public/use-application-name";
+import { useCurrentUser } from "embedding-sdk-package/hooks/public/use-current-user";
+import { useDateFormatter } from "embedding-sdk-package/hooks/public/use-date-formatter";
+import { useMetabaseAuthStatus } from "embedding-sdk-package/hooks/public/use-metabase-auth-status";
+import { useMetabaseQuery } from "embedding-sdk-package/hooks/public/use-metabase-query";
+import { defineQuery } from "embedding-sdk-package/hooks/public/use-metabase-query/define-query";
+import {
+ createMockDashboard,
+ createMockUser,
+} from "embedding-sdk-package/testing/lib/public/mocks";
+
+import {
+ MetabaseTestProvider,
+ type MetabaseTestProviderProps,
+} from "./MetabaseTestProvider";
+
+const ORDERS_QUERY = defineQuery({
+ source: { type: "card", entityId: "ordersQuestionEntity" },
+});
+
+const CREATED_DASHBOARD = createMockDashboard({ name: "Q3 revenue" });
+
+function SessionInfo() {
+ const applicationName = useApplicationName();
+ const authStatus = useMetabaseAuthStatus();
+ const user = useCurrentUser();
+
+ return (
+ <p>
+ {applicationName} {authStatus?.status} {user?.first_name ?? "anonymous"}
+ </p>
+ );
+}
+
+function OrdersQueryError() {
+ const { error } = useMetabaseQuery(ORDERS_QUERY);
+
+ return <p>{error instanceof Error ? error.message : "no error"}</p>;
+}
+
+function DateRangeLabel() {
+ const { formatDateRange } = useDateFormatter();
+
+ return <p>{formatDateRange(["2024-01-01", "2024-01-31"])}</p>;
+}
+
+function NewDashboardFlow() {
+ const [createdName, setCreatedName] = useState("");
+
+ return (
+ <div>
+ <CreateDashboardModal
+ onCreate={(dashboard) => setCreatedName(dashboard.name)}
+ />
+ {createdName && <p>Opened {createdName}</p>}
+ </div>
+ );
+}
+
+function setup({ children, ...options }: MetabaseTestProviderProps = {}) {
+ return render(
+ <MetabaseTestProvider {...options}>{children}</MetabaseTestProvider>,
+ );
+}
+
+describe("MetabaseTestProvider", () => {
+ it("renders subcomponents of compound SDK components", async () => {
+ setup({
+ children: (
+ <InteractiveQuestion questionId={1}>
+ <InteractiveQuestion.Title />
+ <p>Below title</p>
+ </InteractiveQuestion>
+ ),
+ });
+
+ expect(await screen.findByText("Below title")).toBeInTheDocument();
+ expect(
+ screen.queryByText(SDK_COMPONENT_NOT_YET_AVAILABLE_MESSAGE),
+ ).not.toBeInTheDocument();
+ expect(
+ screen.queryByText(SDK_NOT_LOADED_YET_MESSAGE),
+ ).not.toBeInTheDocument();
+ });
+
+ it("renders component passed for SDK component with its props", async () => {
+ setup({
+ StaticQuestion: ({ questionId }) => <p>Question {questionId}</p>,
+ children: <StaticQuestion questionId={42} />,
+ });
+
+ expect(await screen.findByText("Question 42")).toBeInTheDocument();
+ });
+
+ it("lets component passed for SDK component call its callbacks", async () => {
+ setup({
+ CreateDashboardModal: ({ onCreate }) => (
+ <button onClick={() => onCreate(CREATED_DASHBOARD)}>
+ Create dashboard
+ </button>
+ ),
+ children: <NewDashboardFlow />,
+ });
+
+ await userEvent.click(
+ await screen.findByRole("button", { name: "Create dashboard" }),
+ );
+
+ expect(screen.getByText("Opened Q3 revenue")).toBeInTheDocument();
+ });
+
+ it("serves signed-in session by default", async () => {
+ setup({ children: <SessionInfo /> });
+
+ expect(
+ await screen.findByText("Metabase success anonymous"),
+ ).toBeInTheDocument();
+ });
+
+ it("serves passed user, login status and application name", async () => {
+ setup({
+ user: createMockUser({ first_name: "Ada" }),
+ loginStatus: { status: "loading" },
+ applicationName: "Acme Analytics",
+ children: <SessionInfo />,
+ });
+
+ expect(
+ await screen.findByText("Acme Analytics loading Ada"),
+ ).toBeInTheDocument();
+ });
+
+ it("joins date range for date formatter hook", async () => {
+ setup({ children: <DateRangeLabel /> });
+
+ expect(
+ await screen.findByText("2024-01-01 - 2024-01-31"),
+ ).toBeInTheDocument();
+ });
+
+ it("rejects unmocked data requests", async () => {
+ setup({ children: <OrdersQueryError /> });
+
+ expect(
+ await screen.findByText(/No mock for resolveDatasetQuery/),
+ ).toBeInTheDocument();
+ });
+
+ it("keeps serving SDK through strict mode effect replay", async () => {
+ render(
+ <StrictMode>
+ <MetabaseTestProvider applicationName="Acme Analytics">
+ <SessionInfo />
+ </MetabaseTestProvider>
+ </StrictMode>,
+ );
+
+ expect(
+ await screen.findByText("Acme Analytics success anonymous"),
+ ).toBeInTheDocument();
+ });
+
+ it("fails when another provider is already mounted", () => {
+ const consoleError = jest
+ .spyOn(console, "error")
+ .mockImplementation(() => undefined);
+
+ expect(() =>
+ render(
+ <MetabaseTestProvider>
+ <MetabaseTestProvider />
+ </MetabaseTestProvider>,
+ ),
+ ).toThrow("An SDK bundle is already installed");
+
+ consoleError.mockRestore();
+ });
+
+ it("removes mock SDK on unmount", async () => {
+ const { unmount } = setup({
+ children: <StaticQuestion questionId={1} />,
+ });
+
+ expect(window.METABASE_EMBEDDING_SDK_BUNDLE).toBeDefined();
+
+ unmount();
+
+ await waitFor(() =>
+ expect(window.METABASE_EMBEDDING_SDK_BUNDLE).toBeUndefined(),
+ );
+ });
+});
diff --git a/enterprise/frontend/src/embedding-sdk-package/testing/components/MetabaseTestProvider/index.ts b/enterprise/frontend/src/embedding-sdk-package/testing/components/MetabaseTestProvider/index.ts
new file mode 100644
index 00000000000..5bd7bb1dc14
--- /dev/null
+++ b/enterprise/frontend/src/embedding-sdk-package/testing/components/MetabaseTestProvider/index.ts
@@ -0,0 +1,5 @@
+export {
+ MetabaseTestProvider,
+ type MetabaseTestOptions,
+ type MetabaseTestProviderProps,
+} from "./MetabaseTestProvider";
diff --git a/enterprise/frontend/src/embedding-sdk-package/testing/lib/private/bundle.tsx b/enterprise/frontend/src/embedding-sdk-package/testing/lib/private/bundle.tsx
new file mode 100644
index 00000000000..f0c84d31dec
--- /dev/null
+++ b/enterprise/frontend/src/embedding-sdk-package/testing/lib/private/bundle.tsx
@@ -0,0 +1,129 @@
+import { type ReactNode, memo } from "react";
+
+import type { DateRangeCalendarProps } from "embedding-sdk-bundle/components/public/DateRangeCalendar/DateRangeCalendar";
+import type { DateRangePopoverProps } from "embedding-sdk-bundle/components/public/DateRangePopover/DateRangePopover";
+import type {
+ InteractiveQuestionComponents,
+ InteractiveQuestionProps,
+} from "embedding-sdk-bundle/components/public/InteractiveQuestion/InteractiveQuestion";
+import type {
+ StaticQuestionComponents,
+ StaticQuestionProps,
+} from "embedding-sdk-bundle/components/public/StaticQuestion/StaticQuestion";
+import type { MetabaseEmbeddingSdkBundleExports } from "embedding-sdk-bundle/types/sdk-bundle";
+import type { LoginStatus } from "embedding-sdk-bundle/types/user";
+import type { MetabaseTestOptions } from "embedding-sdk-package/testing/components/MetabaseTestProvider";
+
+type ChildrenProps = { children?: ReactNode };
+
+// eslint-disable-next-line metabase/no-literal-metabase-strings -- the default name a real instance reports
+const DEFAULT_APPLICATION_NAME = "Metabase";
+const NO_FONTS: string[] = [];
+const SIGNED_IN_STATUS: LoginStatus = { status: "success" };
+
+const STATIC_QUESTION_SUBCOMPONENTS = {
+ Filter: EmptyOutput,
+ FilterDropdown: EmptyOutput,
+ ResetButton: EmptyOutput,
+ RefreshButton: EmptyOutput,
+ Title: EmptyOutput,
+ Summarize: EmptyOutput,
+ SummarizeDropdown: EmptyOutput,
+ QuestionVisualization: EmptyOutput,
+ ChartTypeSelector: EmptyOutput,
+ ChartTypeDropdown: EmptyOutput,
+ QuestionSettings: EmptyOutput,
+ QuestionSettingsDropdown: EmptyOutput,
+ Breakout: EmptyOutput,
+ BreakoutDropdown: EmptyOutput,
+ DownloadWidget: EmptyOutput,
+ DownloadWidgetDropdown: EmptyOutput,
+ AlertsButton: EmptyOutput,
+ SqlParametersList: EmptyOutput,
+} satisfies Record<keyof StaticQuestionComponents, unknown>;
+
+const INTERACTIVE_QUESTION_SUBCOMPONENTS = {
+ ...STATIC_QUESTION_SUBCOMPONENTS,
+ BackButton: EmptyOutput,
+ NavigationBackButton: EmptyOutput,
+ Notebook: EmptyOutput,
+ Editor: EmptyOutput,
+ NotebookButton: EmptyOutput,
+ EditorButton: EmptyOutput,
+ VisualizationButton: EmptyOutput,
+ SaveQuestionForm: EmptyOutput,
+ SaveButton: EmptyOutput,
+} satisfies Record<keyof InteractiveQuestionComponents, unknown>;
+
+function EmptyOutput() {
+ return <></>;
+}
+
+function ChildrenOutput({ children }: ChildrenProps) {
+ return <>{children}</>;
+}
+
+function throwNoMock(bundleExportName: string): never {
+ throw new Error(`No mock for ${bundleExportName}.`);
+}
+
+export function createMockSdkBundle({
+ CollectionBrowser = EmptyOutput,
+ CreateDashboardModal = EmptyOutput,
+ CreateQuestion = EmptyOutput,
+ DateRangeCalendar = EmptyOutput,
+ DateRangePopover = ChildrenOutput,
+ EditableDashboard = EmptyOutput,
+ InteractiveDashboard = EmptyOutput,
+ InteractiveQuestion = ChildrenOutput,
+ MetabotQuestion = EmptyOutput,
+ StaticDashboard = EmptyOutput,
+ StaticQuestion = ChildrenOutput,
+ user = null,
+ loginStatus = SIGNED_IN_STATUS,
+ applicationName = DEFAULT_APPLICATION_NAME,
+ availableFonts = NO_FONTS,
+}: MetabaseTestOptions): MetabaseEmbeddingSdkBundleExports {
+ return {
+ CollectionBrowser,
+ CreateDashboardModal,
+ CreateQuestion,
+ DateRangeCalendar: (props: DateRangeCalendarProps) => (
+ <DateRangeCalendar {...props} />
+ ),
+ DateRangePopover: (props: DateRangePopoverProps) => (
+ <DateRangePopover {...props} />
+ ),
+ EditableDashboard,
+ InteractiveDashboard,
+ InteractiveQuestion: Object.assign(
+ (props: InteractiveQuestionProps) => <InteractiveQuestion {...props} />,
+ INTERACTIVE_QUESTION_SUBCOMPONENTS,
+ ),
+ ComponentProvider: memo(ChildrenOutput),
+ MetabotQuestion,
+ SdkDebugInfo: EmptyOutput,
+ StaticDashboard,
+ StaticQuestion: Object.assign(
+ (props: StaticQuestionProps) => <StaticQuestion {...props} />,
+ STATIC_QUESTION_SUBCOMPONENTS,
+ ),
+ MetabotSubscriber: () => throwNoMock("MetabotSubscriber"),
+ SdkThemeProviderWithStore: () => throwNoMock("SdkThemeProviderWithStore"),
+ getSdkStore: () => throwNoMock("getSdkStore"),
+ resolveDatasetQuery: () => () => throwNoMock("resolveDatasetQuery"),
+ queryDataset: () => () => throwNoMock("queryDataset"),
+ queryQuestion: () => () => throwNoMock("queryQuestion"),
+ createDashboard: () => () => throwNoMock("createDashboard"),
+ executeAction: () => () => throwNoMock("executeAction"),
+ getApplicationName: () => applicationName,
+ getAvailableFonts: () => availableFonts,
+ getLoginStatus: () => loginStatus,
+ getUser: () => user,
+ useInitData: () => throwNoMock("useInitData"),
+ useLogVersionInfo: () => throwNoMock("useLogVersionInfo"),
+ validateFunctionSchema: () => throwNoMock("validateFunctionSchema"),
+ formatDate: (value) => value ?? "",
+ formatDateRange: (value) => value?.join(" - ") ?? "",
+ };
+}
diff --git a/enterprise/frontend/src/embedding-sdk-package/testing/lib/private/constants.ts b/enterprise/frontend/src/embedding-sdk-package/testing/lib/private/constants.ts
new file mode 100644
index 00000000000..599baf8d401
--- /dev/null
+++ b/enterprise/frontend/src/embedding-sdk-package/testing/lib/private/constants.ts
@@ -0,0 +1,2 @@
+// eslint-disable-next-line metabase/no-literal-metabase-strings -- developer-facing name of the testing provider
+export const TEST_PROVIDER_NAME = "MetabaseTestProvider";
diff --git a/enterprise/frontend/src/embedding-sdk-package/testing/lib/private/install.ts b/enterprise/frontend/src/embedding-sdk-package/testing/lib/private/install.ts
new file mode 100644
index 00000000000..118dd1cfeb0
--- /dev/null
+++ b/enterprise/frontend/src/embedding-sdk-package/testing/lib/private/install.ts
@@ -0,0 +1,53 @@
+import type { MetabaseProviderPropsStoreExternalProps } from "embedding-sdk-bundle/components/public/ComponentProvider";
+import type { MetabaseEmbeddingSdkBundleExports } from "embedding-sdk-bundle/types/sdk-bundle";
+import { ensureMetabaseProviderPropsStore } from "embedding-sdk-shared/lib/ensure-metabase-provider-props-store";
+import { getWindow } from "embedding-sdk-shared/lib/get-window";
+import { SdkLoadingState } from "embedding-sdk-shared/types/sdk-loading";
+
+import { TEST_PROVIDER_NAME } from "./constants";
+
+type MockSdkStore = {
+ getState: () => undefined;
+ subscribe: (listener: () => void) => () => void;
+};
+
+const MOCK_SDK_STORE: MockSdkStore = {
+ getState: () => undefined,
+ subscribe: () => () => undefined,
+};
+
+function getPropsStore() {
+ return ensureMetabaseProviderPropsStore<
+ MetabaseProviderPropsStoreExternalProps,
+ MockSdkStore
+ >();
+}
+
+export function installMockSdk(bundle: MetabaseEmbeddingSdkBundleExports) {
+ const win = getWindow();
+
+ if (!win) {
+ return () => undefined;
+ }
+
+ if (win.METABASE_EMBEDDING_SDK_BUNDLE) {
+ throw new Error(
+ `An SDK bundle is already installed. Render one ${TEST_PROVIDER_NAME} at a time.`,
+ );
+ }
+
+ win.METABASE_EMBEDDING_SDK_BUNDLE = bundle;
+
+ const propsStore = getPropsStore();
+ propsStore.setProps({});
+ propsStore.updateInternalProps({
+ reduxStore: MOCK_SDK_STORE,
+ loadingState: SdkLoadingState.Initialized,
+ loadingError: null,
+ });
+
+ return () => {
+ delete win.METABASE_EMBEDDING_SDK_BUNDLE;
+ getPropsStore().cleanup();
+ };
+}
diff --git a/enterprise/frontend/src/embedding-sdk-package/testing/lib/public/mocks.ts b/enterprise/frontend/src/embedding-sdk-package/testing/lib/public/mocks.ts
new file mode 100644
index 00000000000..0574c514d2c
--- /dev/null
+++ b/enterprise/frontend/src/embedding-sdk-package/testing/lib/public/mocks.ts
@@ -0,0 +1,87 @@
+import type {
+ MetabaseCollection,
+ MetabaseCollectionItem,
+} from "embedding-sdk-bundle/types/collection";
+import type { MetabaseDashboard } from "embedding-sdk-bundle/types/dashboard";
+import type { MetabaseQuestion } from "embedding-sdk-bundle/types/question";
+import type { MetabaseUser } from "embedding-sdk-bundle/types/user";
+
+const MOCK_TIMESTAMP = "2024-01-01T00:00:00Z";
+
+export function createMockUser(opts?: Partial<MetabaseUser>): MetabaseUser {
+ const firstName = opts?.first_name ?? "Testy";
+ const lastName = opts?.last_name ?? "Tableton";
+
+ return {
+ id: 1,
+ first_name: firstName,
+ last_name: lastName,
+ common_name: [firstName, lastName].filter(Boolean).join(" "),
+ email: "[email protected]",
+ locale: null,
+ date_joined: MOCK_TIMESTAMP,
+ first_login: MOCK_TIMESTAMP,
+ last_login: MOCK_TIMESTAMP,
+ ...opts,
+ };
+}
+
+export function createMockDashboard(
+ opts?: Partial<MetabaseDashboard>,
+): MetabaseDashboard {
+ return {
+ id: 1,
+ entity_id: "mockDashboardEntityId",
+ created_at: MOCK_TIMESTAMP,
+ updated_at: MOCK_TIMESTAMP,
+ collection: null,
+ name: "Dashboard",
+ description: null,
+ "last-edit-info": {
+ id: 1,
+ email: "[email protected]",
+ first_name: "Testy",
+ last_name: "Tableton",
+ timestamp: MOCK_TIMESTAMP,
+ },
+ ...opts,
+ };
+}
+
+export function createMockQuestion(
+ opts?: Partial<MetabaseQuestion>,
+): MetabaseQuestion {
+ return {
+ id: 1,
+ name: "Question",
+ description: null,
+ entityId: "mockQuestionEntityId",
+ isSavedQuestion: true,
+ ...opts,
+ };
+}
+
+export function createMockCollection(
+ opts?: Partial<MetabaseCollection>,
+): MetabaseCollection {
+ return {
+ id: 1,
+ name: "Collection",
+ entity_id: "mockCollectionEntityId",
+ description: null,
+ ...opts,
+ };
+}
+
+export function createMockCollectionItem(
+ opts?: Partial<MetabaseCollectionItem>,
+): MetabaseCollectionItem {
+ return {
+ id: 1,
+ entity_id: "mockQuestionEntityId",
+ model: "card",
+ name: "Question",
+ description: null,
+ ...opts,
+ };
+}
diff --git a/enterprise/frontend/src/embedding-sdk-package/testing/tests/metabase-test-provider-type-contract.tsx b/enterprise/frontend/src/embedding-sdk-package/testing/tests/metabase-test-provider-type-contract.tsx
new file mode 100644
index 00000000000..e9e56f666ac
--- /dev/null
+++ b/enterprise/frontend/src/embedding-sdk-package/testing/tests/metabase-test-provider-type-contract.tsx
@@ -0,0 +1,16 @@
+import { MetabaseTestProvider } from "../components/MetabaseTestProvider";
+
+<MetabaseTestProvider
+ // @ts-expect-error `StaticQuestion` has no `dashboardId` prop
+ StaticQuestion={({ dashboardId }) => <p>{dashboardId}</p>}
+/>;
+
+<MetabaseTestProvider
+ CreateDashboardModal={({ onCreate }) => (
+ // @ts-expect-error `onCreate` takes the created dashboard
+ <button onClick={() => onCreate("Q3 revenue")}>Create</button>
+ )}
+/>;
+
+// @ts-expect-error `loginStatus` takes a login status object
+<MetabaseTestProvider loginStatus="success" />;
diff --git a/frontend/src/embedding-sdk-bundle/components/public/CreateQuestion/CreateQuestion.tsx b/frontend/src/embedding-sdk-bundle/components/public/CreateQuestion/CreateQuestion.tsx
index 2ed56c6c3e1..17fc831a947 100644
--- a/frontend/src/embedding-sdk-bundle/components/public/CreateQuestion/CreateQuestion.tsx
+++ b/frontend/src/embedding-sdk-bundle/components/public/CreateQuestion/CreateQuestion.tsx
@@ -15,7 +15,7 @@ export type CreateQuestionProps = Omit<
"children"
>;
-const CreateQuestionInner = (props: CreateQuestionProps = {}) => (
+const CreateQuestionInner = (props: CreateQuestionProps) => (
<InteractiveQuestion {...props} questionId="new" />
);
diff --git a/frontend/src/embedding-sdk-bundle/types/sdk-bundle.ts b/frontend/src/embedding-sdk-bundle/types/sdk-bundle.ts
index df78f2cfc63..fef625d878c 100644
--- a/frontend/src/embedding-sdk-bundle/types/sdk-bundle.ts
+++ b/frontend/src/embedding-sdk-bundle/types/sdk-bundle.ts
@@ -1,4 +1,4 @@
-import type { JSXElementConstructor } from "react";
+import type { ComponentProps, JSXElementConstructor } from "react";
import type { MetabotSubscriber } from "embedding-sdk-bundle/components/private/MetabotSubscriber/MetabotSubscriber";
import type { SdkThemeProviderWithStore } from "embedding-sdk-bundle/components/private/SdkThemeProvider";
@@ -37,12 +37,17 @@ import type {
CreateDashboardValues,
MetabaseDashboard,
} from "embedding-sdk-bundle/types";
-import type { LoginStatus } from "embedding-sdk-bundle/types/user";
+import type { FunctionSchema } from "embedding-sdk-bundle/types/schema";
+import type {
+ LoginStatus,
+ MetabaseUser,
+} from "embedding-sdk-bundle/types/user";
import type { FunctionSchemaValidationResult } from "embedding-sdk-shared/types/validation";
-import type { User } from "metabase-types/api";
+import type { PartialBy } from "metabase/common/types";
export type InternalComponent<TComponent extends JSXElementConstructor<any>> =
- TComponent & { schema?: any };
+ JSXElementConstructor<ComponentProps<TComponent>> &
+ PartialBy<TComponent & { schema?: FunctionSchema }, "schema">;
type InternalHook = () => void;
type ReduxStoreFactory = () => SdkStore;
type ReduxStoreSelector<T> = (state: SdkStoreState) => T;
@@ -106,7 +111,7 @@ type ReduxStoreSelectorsExports = {
getApplicationName: ReduxStoreSelector<string>;
getAvailableFonts: ReduxStoreSelector<string[]>;
getLoginStatus: ReduxStoreSelector<LoginStatus>;
- getUser: ReduxStoreSelector<User | null>;
+ getUser: ReduxStoreSelector<MetabaseUser | null>;
};
type InternalHooksExports = {
diff --git a/rspack.embedding-sdk-package.config.js b/rspack.embedding-sdk-package.config.js
index 8d94033de81..ce0780ddf7d 100644
--- a/rspack.embedding-sdk-package.config.js
+++ b/rspack.embedding-sdk-package.config.js
@@ -45,6 +45,7 @@ const baseConfig = {
entry: {
main: "./index.ts",
"data-app": "./data-app.ts",
+ testing: "./testing.ts",
},
output: {
@@ -114,6 +115,7 @@ const esmConfig = {
entry: {
"main.esm": "./index.ts",
"data-app.esm": "./data-app.ts",
+ "testing.esm": "./testing.ts",
"data-app-dev": "./data-app-dev.ts",
},