Skip to content

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

Move api plugin slots into api (#78747)

Fraser70ada33ee2ab
diff --git a/enterprise/frontend/src/embedding-sdk-ee/auth/auth.ts b/enterprise/frontend/src/embedding-sdk-ee/auth/auth.ts
index 6826a8727ee..690da2fe4bf 100644
--- a/enterprise/frontend/src/embedding-sdk-ee/auth/auth.ts
+++ b/enterprise/frontend/src/embedding-sdk-ee/auth/auth.ts
@@ -29,6 +29,7 @@ import type { MetabaseAuthConfig } from "embedding-sdk-shared/types/auth-config"
import type { SdkAuthState } from "embedding-sdk-shared/types/auth-state";
import { SDK_AUTH_STATE_KEY } from "embedding-sdk-shared/types/auth-state";
import { refetchSiteSettings, sessionApi } from "metabase/api";
+import { PLUGIN_API } from "metabase/api/client";
import { requestSessionTokenFromEmbedJs } from "metabase/embedding/embedding-iframe-sdk/utils";
import { getSessionTokenHeaders } from "metabase/embedding/lib/auth/get-session-token-headers";
import { setApiKeyHeader } from "metabase/embedding/lib/auth/set-api-key-header";
@@ -39,7 +40,6 @@ import {
} from "metabase/embedding-sdk/config";
import { samlTokenStorage } from "metabase/embedding-sdk/lib/saml-token-storage";
import type { MetabaseEmbeddingSessionToken } from "metabase/embedding-sdk/types/refresh-token";
-import { PLUGIN_API, PLUGIN_EMBEDDING_SDK } from "metabase/plugins";
import { refreshCurrentUser } from "metabase/redux/user";
import { createAsyncThunk } from "metabase/redux/utils";
import MetabaseSettings from "metabase/utils/settings";
@@ -116,7 +116,7 @@ PLUGIN_EMBEDDING_SDK_AUTH.initAuth = async (
// The session handler emits the X-Metabase-Session header on every API
// call, renewing the token when it expires.
- PLUGIN_EMBEDDING_SDK.onBeforeRequestHandlers.getOrRefreshSessionHandler =
+ PLUGIN_API.onBeforeRequestHandlers.getOrRefreshSessionHandler =
sessionTokenHandler;
return;
@@ -147,7 +147,7 @@ PLUGIN_EMBEDDING_SDK_AUTH.initAuth = async (
// request and refreshes the token when it expires; later API calls pick it
// up because the handler runs in the request pipeline. Call it once eagerly
// to verify the session is valid before the app renders.
- PLUGIN_EMBEDDING_SDK.onBeforeRequestHandlers.getOrRefreshSessionHandler =
+ PLUGIN_API.onBeforeRequestHandlers.getOrRefreshSessionHandler =
sessionTokenHandler;
try {
// verify that the session is actually valid before proceeding
diff --git a/enterprise/frontend/src/metabase-enterprise/data_apps/runtime/components/DataAppProvider/DataAppProvider.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/data_apps/runtime/components/DataAppProvider/DataAppProvider.unit.spec.tsx
index 177df63389a..cd07cded53a 100644
--- a/enterprise/frontend/src/metabase-enterprise/data_apps/runtime/components/DataAppProvider/DataAppProvider.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/data_apps/runtime/components/DataAppProvider/DataAppProvider.unit.spec.tsx
@@ -1,7 +1,7 @@
import { render, screen } from "@testing-library/react";
+import { PLUGIN_API } from "metabase/api/client";
import { EMBEDDING_SDK_CONFIG } from "metabase/embedding-sdk/config";
-import { PLUGIN_API } from "metabase/plugins";
import { useHostSdkStore } from "../../lib/use-host-sdk-store";
import { DataAppErrorState } from "../DataAppErrorState/DataAppErrorState";
diff --git a/frontend/src/embedding-sdk-bundle/hooks/private/use-init-data/use-init-data-internal.ts b/frontend/src/embedding-sdk-bundle/hooks/private/use-init-data/use-init-data-internal.ts
index 9fe4c62f0e0..f56db2ff84c 100644
--- a/frontend/src/embedding-sdk-bundle/hooks/private/use-init-data/use-init-data-internal.ts
+++ b/frontend/src/embedding-sdk-bundle/hooks/private/use-init-data/use-init-data-internal.ts
@@ -15,7 +15,7 @@ import type { MetabaseAuthConfig } from "embedding-sdk-bundle/types";
import { useMetabaseProviderPropsStore } from "embedding-sdk-shared/hooks/use-metabase-provider-props-store";
import { ensureMetabaseProviderPropsStore } from "embedding-sdk-shared/lib/ensure-metabase-provider-props-store";
import { getSdkPackageVersion } from "embedding-sdk-shared/lib/get-build-info";
-import { type RequestClientInfo, api } from "metabase/api/client";
+import { PLUGIN_API, type RequestClientInfo, api } from "metabase/api/client";
import registerDashboardVisualizations from "metabase/dashboard/visualizations/register";
import { setDataApp } from "metabase/embedding/config";
import { setEmbedPreviewHeader } from "metabase/embedding/lib/auth/set-embed-preview-header";
@@ -25,7 +25,6 @@ import {
EMBEDDING_SDK_CONFIG,
isEmbeddingEajs,
} from "metabase/embedding-sdk/config";
-import { PLUGIN_API, PLUGIN_EMBEDDING_SDK } from "metabase/plugins";
import { setBasename } from "metabase/utils/basename";
import { registerVisualizations } from "metabase/visualizations/register";
@@ -132,7 +131,7 @@ export const useInitDataInternal = ({
// header on every request. The EAJS iframe installs its own handler in
// SdkIframeEmbedRoute.tsx using the value received via postMessage.
if (!isEmbeddingEajs()) {
- PLUGIN_EMBEDDING_SDK.onBeforeRequestHandlers.reactSdkEmbedReferrer =
+ PLUGIN_API.onBeforeRequestHandlers.reactSdkEmbedReferrer =
setReactSdkEmbedReferrerHeader;
}
diff --git a/frontend/src/embedding-sdk-bundle/hooks/private/use-init-data/use-init-data-internal.unit.spec.tsx b/frontend/src/embedding-sdk-bundle/hooks/private/use-init-data/use-init-data-internal.unit.spec.tsx
index 8e7fdb13288..080734ab904 100644
--- a/frontend/src/embedding-sdk-bundle/hooks/private/use-init-data/use-init-data-internal.unit.spec.tsx
+++ b/frontend/src/embedding-sdk-bundle/hooks/private/use-init-data/use-init-data-internal.unit.spec.tsx
@@ -2,8 +2,8 @@ import { renderHook } from "@testing-library/react";
import type { SdkStore } from "embedding-sdk-bundle/store/types";
import { ensureMetabaseProviderPropsStore } from "embedding-sdk-shared/lib/ensure-metabase-provider-props-store";
+import { PLUGIN_API } from "metabase/api/client";
import { EMBEDDING_SDK_CONFIG } from "metabase/embedding-sdk/config";
-import { PLUGIN_API } from "metabase/plugins";
import { useInitData } from "./use-init-data-internal";
diff --git a/frontend/src/embedding-sdk-bundle/store/guest-embed/guest-embed.ts b/frontend/src/embedding-sdk-bundle/store/guest-embed/guest-embed.ts
index 673dae36d71..e800c14ff2b 100644
--- a/frontend/src/embedding-sdk-bundle/store/guest-embed/guest-embed.ts
+++ b/frontend/src/embedding-sdk-bundle/store/guest-embed/guest-embed.ts
@@ -2,9 +2,11 @@ import { merge } from "icepick";
import type { MetabaseAuthConfig } from "embedding-sdk-shared/types/auth-config";
import { refetchSiteSettings } from "metabase/api";
-import type { OnBeforeRequestHandlerConfig } from "metabase/api/client";
+import {
+ type OnBeforeRequestHandlerConfig,
+ PLUGIN_API,
+} from "metabase/api/client";
import { overrideRequestsForGuestEmbeds } from "metabase/embedding/lib/override-requests-for-embeds";
-import { PLUGIN_EMBEDDING_SDK } from "metabase/plugins";
import { createAsyncThunk } from "metabase/redux/utils";
import { isJWT } from "metabase/utils/jwt";
@@ -17,7 +19,7 @@ export const initGuestEmbed = createAsyncThunk<void, MetabaseAuthConfig>(
if (authConfig.isGuest && authConfig.guestEmbedProviderUri) {
// Replaces the request token with the newly refreshed guest embed token.
- PLUGIN_EMBEDDING_SDK.onBeforeRequestHandlers.getOrRefreshGuestSessionHandler =
+ PLUGIN_API.onBeforeRequestHandlers.getOrRefreshGuestSessionHandler =
async (config: OnBeforeRequestHandlerConfig) => {
const newToken = await dispatch(
getOrRefreshGuestSession(authConfig),
diff --git a/frontend/src/metabase/api/client/client.unit.spec.ts b/frontend/src/metabase/api/client/client.unit.spec.ts
index 9d774c7d408..30f48ebccf5 100644
--- a/frontend/src/metabase/api/client/client.unit.spec.ts
+++ b/frontend/src/metabase/api/client/client.unit.spec.ts
@@ -1,10 +1,11 @@
import fetchMock from "fetch-mock";
import { setupBasename } from "__support__/basename";
-import { PLUGIN_API, reinitialize } from "metabase/plugins";
+import { reinitialize } from "metabase/plugins";
import { setBasename } from "metabase/utils/basename";
import { ApiClient } from "./client";
+import { PLUGIN_API } from "./request-handlers";
describe("api", () => {
describe("request (RTK entry point)", () => {
diff --git a/frontend/src/metabase/api/client/index.ts b/frontend/src/metabase/api/client/index.ts
index 8caf31a66a6..da4f71b5a7f 100644
--- a/frontend/src/metabase/api/client/index.ts
+++ b/frontend/src/metabase/api/client/index.ts
@@ -4,6 +4,7 @@ export * from "./errors";
export type {
OnBeforeRequestHandler,
OnBeforeRequestHandlerConfig,
-} from "./middleware";
+} from "./request-handlers";
+export { PLUGIN_API, reinitializeRequestHandlers } from "./request-handlers";
export type { RequestClientInfo, RequestOptions } from "./types";
export { setLocaleHeader } from "./locale";
diff --git a/frontend/src/metabase/api/client/middleware.ts b/frontend/src/metabase/api/client/middleware.ts
index c2bc22dfd4e..928fbd5ba40 100644
--- a/frontend/src/metabase/api/client/middleware.ts
+++ b/frontend/src/metabase/api/client/middleware.ts
@@ -1,38 +1,23 @@
import {
+ type OnBeforeRequestHandler,
+ type OnBeforeRequestHandlerConfig,
PLUGIN_API,
- PLUGIN_EMBEDDING_IFRAME_SDK,
- PLUGIN_EMBEDDING_SDK,
-} from "metabase/plugins";
+} from "./request-handlers";
-import type { RequestMethod } from "./method";
-
-export type OnBeforeRequestHandlerConfig = {
- method: RequestMethod;
- url: string;
- headers?: Record<string, string>;
- // URL `:tag` params (and querystring leftovers). For the legacy GET/POST
- // helpers this holds the whole request bag.
- data: Record<string, unknown>;
- // The JSON-body bag, kept as a separate channel from `data`. Exposed to
- // handlers so embed URL `:tag`s — notably the guest-embed `:token` — can be
- // filled from body fields, and so the refresh handler can swap a stale body
- // token. `undefined` for GETs, raw (FormData/URLSearchParams) bodies, and the
- // legacy helpers (which pack everything into `data`).
- body?: Record<string, unknown>;
-};
-
-export type OnBeforeRequestHandler = (
- data: OnBeforeRequestHandlerConfig,
-) => Promise<void | Partial<OnBeforeRequestHandlerConfig>>;
+export type {
+ OnBeforeRequestHandler,
+ OnBeforeRequestHandlerConfig,
+} from "./request-handlers";
/**
* The complete, ordered request-manipulation pipeline.
*
- * Every handler is a plugin slot — a no-op by default, populated by the owning
- * feature's init flow (SDK auth, guest/public/static embeds, the embed-referrer
- * handlers). Listing them here, rather than letting features push handlers onto
- * a dynamic array, keeps the full set of things that can rewrite an outgoing
- * request — and the order they run in — visible in one place.
+ * Every handler is a named slot on `PLUGIN_API` — a no-op by default,
+ * populated by the owning feature's init flow (SDK auth, guest/public/static
+ * embeds, the embed-referrer handlers). Listing them here, rather than letting
+ * features push handlers onto a dynamic array, keeps the full set of things
+ * that can rewrite an outgoing request — and the order they run in — visible
+ * in one place.
*
* Order matters: handlers run in sequence and each one sees the result of the
* previous one. In particular the embed-preview rewrite must run after the
@@ -44,14 +29,13 @@ function getOnBeforeRequestHandlers(): OnBeforeRequestHandler[] {
PLUGIN_API.onBeforeRequestHandlers.setEmbedPreviewHeader,
PLUGIN_API.onBeforeRequestHandlers.setEmbeddingRequestAuthHeaders,
PLUGIN_API.onBeforeRequestHandlers.setEmbeddedHeader,
- PLUGIN_EMBEDDING_SDK.onBeforeRequestHandlers.getOrRefreshSessionHandler,
- PLUGIN_EMBEDDING_SDK.onBeforeRequestHandlers
- .getOrRefreshGuestSessionHandler,
- PLUGIN_EMBEDDING_SDK.onBeforeRequestHandlers.overrideRequestsForGuestEmbeds,
+ PLUGIN_API.onBeforeRequestHandlers.getOrRefreshSessionHandler,
+ PLUGIN_API.onBeforeRequestHandlers.getOrRefreshGuestSessionHandler,
+ PLUGIN_API.onBeforeRequestHandlers.overrideRequestsForGuestEmbeds,
PLUGIN_API.onBeforeRequestHandlers.overrideRequestsForPublicEmbeds,
PLUGIN_API.onBeforeRequestHandlers.rewriteEmbedPreviewUrl,
- PLUGIN_EMBEDDING_SDK.onBeforeRequestHandlers.reactSdkEmbedReferrer,
- PLUGIN_EMBEDDING_IFRAME_SDK.onBeforeRequestHandlers.embedReferrer,
+ PLUGIN_API.onBeforeRequestHandlers.reactSdkEmbedReferrer,
+ PLUGIN_API.onBeforeRequestHandlers.embedReferrer,
];
}
diff --git a/frontend/src/metabase/api/client/request-handlers.ts b/frontend/src/metabase/api/client/request-handlers.ts
new file mode 100644
index 00000000000..f4dca94b27f
--- /dev/null
+++ b/frontend/src/metabase/api/client/request-handlers.ts
@@ -0,0 +1,89 @@
+/* eslint-disable metabase/no-literal-metabase-strings -- request header names */
+import { isEmbeddingSdk } from "metabase/embedding-sdk/config";
+import { isWithinIframe } from "metabase/utils/iframe";
+
+import type { RequestMethod } from "./method";
+
+export type OnBeforeRequestHandlerConfig = {
+ method: RequestMethod;
+ url: string;
+ headers?: Record<string, string>;
+ // URL `:tag` params (and querystring leftovers). For the legacy GET/POST
+ // helpers this holds the whole request bag.
+ data: Record<string, unknown>;
+ // The JSON-body bag, kept as a separate channel from `data`. Exposed to
+ // handlers so embed URL `:tag`s — notably the guest-embed `:token` — can be
+ // filled from body fields, and so the refresh handler can swap a stale body
+ // token. `undefined` for GETs, raw (FormData/URLSearchParams) bodies, and the
+ // legacy helpers (which pack everything into `data`).
+ body?: Record<string, unknown>;
+};
+
+export type OnBeforeRequestHandler = (
+ data: OnBeforeRequestHandlerConfig,
+) => Promise<void | Partial<OnBeforeRequestHandlerConfig>>;
+
+const noop: OnBeforeRequestHandler = async () => {};
+
+// Tag requests from a non-SDK app running inside an iframe (interactive /
+// static / public embedding) so the backend knows it's embedded.
+const setEmbeddedHeader: OnBeforeRequestHandler = async () => {
+ if (isWithinIframe() && !isEmbeddingSdk()) {
+ return { headers: { "X-Metabase-Embedded": "true" } };
+ }
+};
+
+/**
+ * The api client's request-extension slots.
+ */
+const getDefaultPluginApi = () => ({
+ onBeforeRequestHandlers: {
+ overrideRequestsForPublicEmbeds: noop,
+ rewriteEmbedPreviewUrl: noop,
+ setEmbeddedHeader,
+ // Emit the embedding client headers (`X-Metabase-Client` / `-Version`). A
+ // no-op slot: the embedding setup flow installs `setRequestClientHeaders`
+ // here, closing over the active client (see `embedding-request-auth`).
+ // Untouched in the normal app — keeping these embedding-only headers out of
+ // the generic api client.
+ setRequestClientHeaders: noop,
+ // Emit the embed-preview header (`X-Metabase-Embedded-Preview`). A no-op
+ // slot: the public and SDK embed flows install `setEmbedPreviewHeader` here,
+ // which tags requests when running inside an embed preview (see
+ // `embedding-request-auth`).
+ setEmbedPreviewHeader: noop,
+ // Emit the embedding auth header (`X-Api-Key` or `X-Metabase-Session`). A
+ // no-op slot: the embedding auth flow installs exactly one strategy here —
+ // `setApiKeyHeader` or `setSessionTokenHeader` — based on the auth method in
+ // use (see `embedding-request-auth`).
+ setEmbeddingRequestAuthHeaders: noop,
+ // Resolve and emit the SDK session token, refreshing it when expired.
+ // Installed by SDK auth (`embedding-sdk-ee/auth`).
+ getOrRefreshSessionHandler: noop,
+ // Swap a stale guest-embed token in the request for a freshly refreshed
+ // one. Installed by the guest-embed init flow.
+ getOrRefreshGuestSessionHandler: noop,
+ // Rewrite requests to their guest-embed equivalents. Installed by the
+ // guest-embed init flow.
+ overrideRequestsForGuestEmbeds: noop,
+ // Send the host page URL as the embed referrer header. Installed by the
+ // React SDK's init flow.
+ reactSdkEmbedReferrer: noop,
+ // Send the host page URL as the embed referrer header. Installed by the
+ // iframe SDK's embed route, which receives the URL via postMessage.
+ embedReferrer: noop,
+ },
+});
+
+export const PLUGIN_API = getDefaultPluginApi();
+
+/**
+ * Reset every request-handler slot to its default.
+ * Mutate so that existing references stay up-to-date.
+ */
+export function reinitializeRequestHandlers() {
+ Object.assign(
+ PLUGIN_API.onBeforeRequestHandlers,
+ getDefaultPluginApi().onBeforeRequestHandlers,
+ );
+}
diff --git a/frontend/src/metabase/app-embed-mcp.tsx b/frontend/src/metabase/app-embed-mcp.tsx
index 969b099d7d3..6718072aad1 100644
--- a/frontend/src/metabase/app-embed-mcp.tsx
+++ b/frontend/src/metabase/app-embed-mcp.tsx
@@ -7,9 +7,9 @@ import { createRoot } from "react-dom/client";
// Import the embedding SDK vendors side-effects (sets up global CSS vars, etc.)
import "metabase/embedding-sdk/vendors-side-effects";
+import { PLUGIN_API } from "metabase/api/client";
import { McpUiAppRoute } from "metabase/embedding/mcp/McpUiAppRoute";
import { EMBEDDING_SDK_CONFIG } from "metabase/embedding-sdk/config";
-import { PLUGIN_API } from "metabase/plugins";
import { setBasename } from "metabase/utils/basename";
// Load EE plugins (whitelabeling, etc.) - no-op in OSS
diff --git a/frontend/src/metabase/app-main.js b/frontend/src/metabase/app-main.js
index 9ea9bf5f012..53e11e712da 100644
--- a/frontend/src/metabase/app-main.js
+++ b/frontend/src/metabase/app-main.js
@@ -4,10 +4,9 @@ import "metabase-dev";
import _ from "underscore";
-import { api } from "metabase/api/client";
+import { PLUGIN_API, api } from "metabase/api/client";
import { init } from "metabase/app";
import { setRequestClientHeaders } from "metabase/embedding/lib/auth/set-request-client-headers";
-import { PLUGIN_API } from "metabase/plugins";
import { mainReducers } from "metabase/reducers-main";
import { setErrorPage } from "metabase/redux/app";
import { clearCurrentUser } from "metabase/redux/user";
diff --git a/frontend/src/metabase/embedding/config.ts b/frontend/src/metabase/embedding/config.ts
index 1ed05e1fa46..2f552768abf 100644
--- a/frontend/src/metabase/embedding/config.ts
+++ b/frontend/src/metabase/embedding/config.ts
@@ -1,10 +1,10 @@
import { getSdkPackageVersion } from "embedding-sdk-shared/lib/get-build-info";
+import { PLUGIN_API } from "metabase/api/client";
import {
EMBEDDING_SDK_CONFIG,
isDataApp,
isEmbeddingSdk,
} from "metabase/embedding-sdk/config";
-import { PLUGIN_API, PLUGIN_EMBEDDING_SDK } from "metabase/plugins";
import { IFRAMED_IN_SELF, isWithinIframe } from "metabase/utils/iframe";
import { setEmbedPreviewHeader } from "./lib/auth/set-embed-preview-header";
@@ -66,7 +66,7 @@ export function setDataApp(
PLUGIN_API.onBeforeRequestHandlers.setEmbedPreviewHeader =
setEmbedPreviewHeader;
- PLUGIN_EMBEDDING_SDK.onBeforeRequestHandlers.reactSdkEmbedReferrer =
+ PLUGIN_API.onBeforeRequestHandlers.reactSdkEmbedReferrer =
setReactSdkEmbedReferrerHeader;
}
diff --git a/frontend/src/metabase/embedding/config.unit.spec.ts b/frontend/src/metabase/embedding/config.unit.spec.ts
index ad2c15896f7..1e4dd7303c7 100644
--- a/frontend/src/metabase/embedding/config.unit.spec.ts
+++ b/frontend/src/metabase/embedding/config.unit.spec.ts
@@ -2,11 +2,11 @@ import type {
OnBeforeRequestHandler,
OnBeforeRequestHandlerConfig,
} from "metabase/api/client";
+import { PLUGIN_API } from "metabase/api/client";
import {
EMBEDDING_SDK_CONFIG,
isDataAppDev,
} from "metabase/embedding-sdk/config";
-import { PLUGIN_API } from "metabase/plugins";
import { isEmbedPreview, setDataApp } from "./config";
import { setRequestClientHeaders } from "./lib/auth/set-request-client-headers";
diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk/components/SdkIframeEmbedRoute.tsx b/frontend/src/metabase/embedding/embedding-iframe-sdk/components/SdkIframeEmbedRoute.tsx
index b016f946757..6036dbc9e75 100644
--- a/frontend/src/metabase/embedding/embedding-iframe-sdk/components/SdkIframeEmbedRoute.tsx
+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk/components/SdkIframeEmbedRoute.tsx
@@ -20,7 +20,7 @@ import type { SdkQuestionEntityPublicProps } from "embedding-sdk-bundle/types/qu
import { applyThemePreset } from "embedding-sdk-shared/lib/apply-theme-preset";
import type { MetabaseAuthConfig } from "embedding-sdk-shared/types/auth-config";
import { createSnowplowTracker } from "metabase/analytics";
-import type { OnBeforeRequestHandler } from "metabase/api/client";
+import { type OnBeforeRequestHandler, PLUGIN_API } from "metabase/api/client";
import { EmbeddingFooter } from "metabase/embedding/components/EmbeddingFooter/EmbeddingFooter";
import { EMBEDDING_SDK_IFRAME_EMBEDDING_CONFIG } from "metabase/embedding-sdk/config";
import { PLUGIN_EMBEDDING_IFRAME_SDK } from "metabase/plugins";
@@ -60,8 +60,7 @@ const embedReferrerHandler: OnBeforeRequestHandler = async (config) => {
};
// Install the iframe embed-referrer handler into its plugin slot.
-PLUGIN_EMBEDDING_IFRAME_SDK.onBeforeRequestHandlers.embedReferrer =
- embedReferrerHandler;
+PLUGIN_API.onBeforeRequestHandlers.embedReferrer = embedReferrerHandler;
const onSettingsChanged = (settings: SdkIframeEmbedSettings) => {
// Tell the SDK whether to use the existing user session or not.
diff --git a/frontend/src/metabase/embedding/lib/override-requests-for-embeds.ts b/frontend/src/metabase/embedding/lib/override-requests-for-embeds.ts
index a13cb55dff7..c98cd9e76da 100644
--- a/frontend/src/metabase/embedding/lib/override-requests-for-embeds.ts
+++ b/frontend/src/metabase/embedding/lib/override-requests-for-embeds.ts
@@ -1,14 +1,11 @@
import { sessionPropertiesPath } from "metabase/api";
-import type {
- OnBeforeRequestHandlerConfig,
- RequestMethod,
-} from "metabase/api/client";
-import { isEmbedPreview } from "metabase/embedding/config";
import {
+ type OnBeforeRequestHandlerConfig,
PLUGIN_API,
- PLUGIN_CONTENT_TRANSLATION,
- PLUGIN_EMBEDDING_SDK,
-} from "metabase/plugins";
+ type RequestMethod,
+} from "metabase/api/client";
+import { isEmbedPreview } from "metabase/embedding/config";
+import { PLUGIN_CONTENT_TRANSLATION } from "metabase/plugins";
type EmbedType = "guest" | "static" | "public";
@@ -259,12 +256,11 @@ export const setupEmbedPreviewRewrite = () => {
export const overrideRequestsForGuestEmbeds = () => {
setupEmbedPreviewRewrite();
- PLUGIN_EMBEDDING_SDK.onBeforeRequestHandlers.overrideRequestsForGuestEmbeds =
- (data) =>
- overrideRequests({
- ...data,
- embedType: "guest",
- });
+ PLUGIN_API.onBeforeRequestHandlers.overrideRequestsForGuestEmbeds = (data) =>
+ overrideRequests({
+ ...data,
+ embedType: "guest",
+ });
};
/**
diff --git a/frontend/src/metabase/embedding/lib/override-requests-for-embeds.unit.spec.ts b/frontend/src/metabase/embedding/lib/override-requests-for-embeds.unit.spec.ts
index 89b2d872874..ac9908ceff0 100644
--- a/frontend/src/metabase/embedding/lib/override-requests-for-embeds.unit.spec.ts
+++ b/frontend/src/metabase/embedding/lib/override-requests-for-embeds.unit.spec.ts
@@ -1,5 +1,6 @@
+import { PLUGIN_API } from "metabase/api/client";
import { isEmbedPreview } from "metabase/embedding/config";
-import { PLUGIN_API, reinitialize } from "metabase/plugins";
+import { reinitialize } from "metabase/plugins";
import {
matchUrlPattern,
diff --git a/frontend/src/metabase/plugins/index.ts b/frontend/src/metabase/plugins/index.ts
index b8eb096fbbc..da7a69de87f 100644
--- a/frontend/src/metabase/plugins/index.ts
+++ b/frontend/src/metabase/plugins/index.ts
@@ -1,5 +1,4 @@
// Re-export all plugins from OSS modules (excluding reinitialize functions to avoid conflicts)
-export { PLUGIN_API } from "./oss/api";
export {
PLUGIN_AUDIT,
type InsightsLinkProps,
@@ -189,9 +188,9 @@ export type {
SyncedCollectionsSidebarSectionProps,
} from "./types";
-// Export a single reinitialize function that calls all individual reinitialize functions
+import { reinitializeRequestHandlers } from "metabase/api/client";
+
import { reinitialize as reinitializeAiControls } from "./oss/ai-controls";
-import { reinitialize as reinitializeApi } from "./oss/api";
import { reinitialize as reinitializeAudit } from "./oss/audit";
import { reinitialize as reinitializeAuth } from "./oss/auth";
import { reinitialize as reinitializeCaching } from "./oss/caching";
@@ -239,7 +238,7 @@ export function reinitialize() {
reinitializeNotificationsSdk();
reinitializeAiControls();
- reinitializeApi();
+ reinitializeRequestHandlers();
reinitializeAudit();
reinitializeAuth();
reinitializeCaching();
diff --git a/frontend/src/metabase/plugins/oss/api.ts b/frontend/src/metabase/plugins/oss/api.ts
deleted file mode 100644
index 12d51f40503..00000000000
--- a/frontend/src/metabase/plugins/oss/api.ts
+++ /dev/null
@@ -1,48 +0,0 @@
-/* eslint-disable metabase/no-literal-metabase-strings -- request header names */
-import type { OnBeforeRequestHandler } from "metabase/api/client";
-import { isEmbeddingSdk } from "metabase/embedding-sdk/config";
-import { isWithinIframe } from "metabase/utils/iframe";
-
-const noop: OnBeforeRequestHandler = async () => {};
-
-// Tag requests from a non-SDK app running inside an iframe (interactive /
-// static / public embedding) so the backend knows it's embedded. Lives here
-// rather than in `metabase/api` so the client stays free of SDK imports.
-const setEmbeddedHeader: OnBeforeRequestHandler = async () => {
- if (isWithinIframe() && !isEmbeddingSdk()) {
- return { headers: { "X-Metabase-Embedded": "true" } };
- }
-};
-
-const getDefaultPluginApi = () => ({
- onBeforeRequestHandlers: {
- overrideRequestsForPublicEmbeds: noop,
- rewriteEmbedPreviewUrl: noop,
- setEmbeddedHeader,
- // Emit the embedding client headers (`X-Metabase-Client` / `-Version`). A
- // no-op slot: the embedding setup flow installs `setRequestClientHeaders`
- // here, closing over the active client (see `embedding-request-auth`).
- // Untouched in the normal app — keeping these embedding-only headers out of
- // the generic api client.
- setRequestClientHeaders: noop,
- // Emit the embed-preview header (`X-Metabase-Embedded-Preview`). A no-op
- // slot: the public and SDK embed flows install `setEmbedPreviewHeader` here,
- // which tags requests when running inside an embed preview (see
- // `embedding-request-auth`).
- setEmbedPreviewHeader: noop,
- // Emit the embedding auth header (`X-Api-Key` or `X-Metabase-Session`). A
- // no-op slot: the embedding auth flow installs exactly one strategy here —
- // `setApiKeyHeader` or `setSessionTokenHeader` — based on the auth method in
- // use (see `embedding-request-auth`).
- setEmbeddingRequestAuthHeaders: noop,
- },
-});
-
-export const PLUGIN_API = getDefaultPluginApi();
-
-/**
- * @internal Do not call directly. Use the main reinitialize function from metabase/plugins instead.
- */
-export function reinitialize() {
- Object.assign(PLUGIN_API, getDefaultPluginApi());
-}
diff --git a/frontend/src/metabase/plugins/oss/embedding-iframe-sdk.ts b/frontend/src/metabase/plugins/oss/embedding-iframe-sdk.ts
index 7632d32cce9..a9c1c4ef016 100644
--- a/frontend/src/metabase/plugins/oss/embedding-iframe-sdk.ts
+++ b/frontend/src/metabase/plugins/oss/embedding-iframe-sdk.ts
@@ -1,12 +1,5 @@
-import type { OnBeforeRequestHandler } from "metabase/api/client";
-
-const noop: OnBeforeRequestHandler = async () => {};
-
const getDefaultPluginEmbeddingIframeSdk = () => ({
isEnabled: () => false,
- onBeforeRequestHandlers: {
- embedReferrer: noop,
- },
});
export const PLUGIN_EMBEDDING_IFRAME_SDK = getDefaultPluginEmbeddingIframeSdk();
diff --git a/frontend/src/metabase/plugins/oss/embedding-sdk.ts b/frontend/src/metabase/plugins/oss/embedding-sdk.ts
index 2e3e4190ad8..48b4ef8cf86 100644
--- a/frontend/src/metabase/plugins/oss/embedding-sdk.ts
+++ b/frontend/src/metabase/plugins/oss/embedding-sdk.ts
@@ -1,15 +1,5 @@
-import type { OnBeforeRequestHandler } from "metabase/api/client";
-
-const noop: OnBeforeRequestHandler = async () => {};
-
const getDefaultPluginEmbeddingSdk = () => ({
isEnabled: () => false,
- onBeforeRequestHandlers: {
- getOrRefreshSessionHandler: noop,
- getOrRefreshGuestSessionHandler: noop,
- overrideRequestsForGuestEmbeds: noop,
- reactSdkEmbedReferrer: noop,
- },
});
export const PLUGIN_EMBEDDING_SDK = getDefaultPluginEmbeddingSdk();