Skip to content

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

refactor(sdk, embed-js): Additional code preparations for Anonymous Embedding (#64457)

Timofey Kachalove4cd45986564
diff --git a/enterprise/frontend/src/embedding-sdk-bundle/components/private/SdkAdHocQuestion/SdkAdHocQuestion.tsx b/enterprise/frontend/src/embedding-sdk-bundle/components/private/SdkAdHocQuestion/SdkAdHocQuestion.tsx
index 30d236c9d02..e2a34973c08 100644
--- a/enterprise/frontend/src/embedding-sdk-bundle/components/private/SdkAdHocQuestion/SdkAdHocQuestion.tsx
+++ b/enterprise/frontend/src/embedding-sdk-bundle/components/private/SdkAdHocQuestion/SdkAdHocQuestion.tsx
@@ -73,7 +73,7 @@ export const SdkAdHocQuestion = ({
questionId={questionId}
options={options}
deserializedCard={deserializedCard}
- componentPlugins={plugins}
+ plugins={plugins}
onBeforeSave={onBeforeSave}
onSave={onSave}
entityTypes={entityTypes}
diff --git a/enterprise/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/context/SdkQuestionProvider.tsx b/enterprise/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/context/SdkQuestionProvider.tsx
index 7f8b02761ab..18f5daac317 100644
--- a/enterprise/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/context/SdkQuestionProvider.tsx
+++ b/enterprise/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/context/SdkQuestionProvider.tsx
@@ -1,9 +1,10 @@
import { createContext, useContext, useEffect, useMemo } from "react";
+import { SdkError } from "embedding-sdk-bundle/components/private/PublicComponentWrapper";
import { useLoadQuestion } from "embedding-sdk-bundle/hooks/private/use-load-question";
import { transformSdkQuestion } from "embedding-sdk-bundle/lib/transform-question";
import { useSdkDispatch, useSdkSelector } from "embedding-sdk-bundle/store";
-import { getPlugins } from "embedding-sdk-bundle/store/selectors";
+import { getError, getPlugins } from "embedding-sdk-bundle/store/selectors";
import type { MetabasePluginsConfig } from "embedding-sdk-bundle/types/plugins";
import type { MetabasePluginsConfig as InternalMetabasePluginsConfig } from "metabase/embedding-sdk/types/plugins";
import {
@@ -53,6 +54,8 @@ export const SdkQuestionProvider = ({
navigateToNewCard: userNavigateToNewCard,
onVisualizationChange,
}: SdkQuestionProviderProps) => {
+ const error = useSdkSelector(getError);
+
const handleCreateQuestion = useCreateQuestion();
const handleSaveQuestion = useSaveQuestion();
@@ -179,6 +182,10 @@ export const SdkQuestionProvider = ({
dispatch(setEntityTypes(entityTypes));
}, [dispatch, entityTypes]);
+ if (error) {
+ return <SdkError message={error.message} />;
+ }
+
return (
<SdkQuestionContext.Provider value={questionContext}>
{children}
diff --git a/enterprise/frontend/src/embedding-sdk-bundle/components/public/SdkQuestion/SdkQuestion.tsx b/enterprise/frontend/src/embedding-sdk-bundle/components/public/SdkQuestion/SdkQuestion.tsx
index 17b7a7bc571..f6104dc0d75 100644
--- a/enterprise/frontend/src/embedding-sdk-bundle/components/public/SdkQuestion/SdkQuestion.tsx
+++ b/enterprise/frontend/src/embedding-sdk-bundle/components/public/SdkQuestion/SdkQuestion.tsx
@@ -76,8 +76,7 @@ export type DrillThroughQuestionProps = Omit<
* @expand
* @category InteractiveQuestion
*/
-export type SdkQuestionProps = SdkQuestionProviderProps &
- SdkQuestionDefaultViewProps &
+export type SdkQuestionProps = SdkQuestionDefaultViewProps &
Omit<SdkQuestionProviderProps, "componentPlugins"> & {
plugins?: SdkQuestionProviderProps["componentPlugins"];
};
diff --git a/enterprise/frontend/src/embedding-sdk-bundle/components/public/StaticQuestion/StaticQuestion.tsx b/enterprise/frontend/src/embedding-sdk-bundle/components/public/StaticQuestion/StaticQuestion.tsx
index 2d9e7b57875..eb48182669c 100644
--- a/enterprise/frontend/src/embedding-sdk-bundle/components/public/StaticQuestion/StaticQuestion.tsx
+++ b/enterprise/frontend/src/embedding-sdk-bundle/components/public/StaticQuestion/StaticQuestion.tsx
@@ -76,8 +76,8 @@ export type StaticQuestionComponents = {
SqlParametersList: typeof SqlParametersList;
};
-const _StaticQuestion = ({
- questionId: initialQuestionId,
+const StaticQuestionInner = ({
+ questionId,
withChartTypeSelector,
height,
width,
@@ -105,7 +105,7 @@ const _StaticQuestion = ({
return (
<SdkQuestion
- questionId={initialQuestionId}
+ questionId={questionId}
getClickActionMode={getClickActionMode}
navigateToNewCard={null}
initialSqlParameters={initialSqlParameters}
@@ -161,6 +161,8 @@ const subComponents: StaticQuestionComponents = {
SqlParametersList: SqlParametersList,
};
-export const StaticQuestion = Object.assign(_StaticQuestion, subComponents, {
- schema: staticQuestionSchema,
-});
+export const StaticQuestion = Object.assign(
+ StaticQuestionInner,
+ subComponents,
+ { schema: staticQuestionSchema },
+);
diff --git a/enterprise/frontend/src/embedding-sdk-bundle/components/public/dashboard/SdkDashboard.tsx b/enterprise/frontend/src/embedding-sdk-bundle/components/public/dashboard/SdkDashboard.tsx
index ced6b165cc0..6c66c5c0b4f 100644
--- a/enterprise/frontend/src/embedding-sdk-bundle/components/public/dashboard/SdkDashboard.tsx
+++ b/enterprise/frontend/src/embedding-sdk-bundle/components/public/dashboard/SdkDashboard.tsx
@@ -18,6 +18,7 @@ import {
} from "embedding-sdk-bundle/components/private/PublicComponentWrapper";
import { SdkAdHocQuestion } from "embedding-sdk-bundle/components/private/SdkAdHocQuestion";
import { SdkQuestion } from "embedding-sdk-bundle/components/public/SdkQuestion/SdkQuestion";
+import { useDashboardLoadHandlers } from "embedding-sdk-bundle/hooks/private/use-dashboard-load-handlers";
import { useSdkBreadcrumbs } from "embedding-sdk-bundle/hooks/private/use-sdk-breadcrumb";
import {
type SdkDashboardDisplayProps,
@@ -45,7 +46,6 @@ import {
import { getDashboardComplete, getIsDirty } from "metabase/dashboard/selectors";
import { useSelector } from "metabase/lib/redux";
import EmbedFrameS from "metabase/public/components/EmbedFrame/EmbedFrame.module.css";
-import { useDashboardLoadHandlers } from "metabase/public/containers/PublicOrEmbeddedDashboard/use-dashboard-load-handlers";
import { resetErrorPage, setErrorPage } from "metabase/redux/app";
import { dismissAllUndo } from "metabase/redux/undo";
import { getErrorPage } from "metabase/selectors/app";
diff --git a/frontend/src/metabase/public/containers/PublicOrEmbeddedDashboard/use-dashboard-load-handlers.ts b/enterprise/frontend/src/embedding-sdk-bundle/hooks/private/use-dashboard-load-handlers.ts
similarity index 89%
rename from frontend/src/metabase/public/containers/PublicOrEmbeddedDashboard/use-dashboard-load-handlers.ts
rename to enterprise/frontend/src/embedding-sdk-bundle/hooks/private/use-dashboard-load-handlers.ts
index d985fc63980..2991be6ab8f 100644
--- a/frontend/src/metabase/public/containers/PublicOrEmbeddedDashboard/use-dashboard-load-handlers.ts
+++ b/enterprise/frontend/src/embedding-sdk-bundle/hooks/private/use-dashboard-load-handlers.ts
@@ -1,11 +1,11 @@
import { useCallback, useEffect, useRef } from "react";
-/* eslint-disable-next-line no-restricted-imports -- deprecated sdk import */
-import { getEventHandlers } from "embedding-sdk-bundle/store/selectors";
import { useSelector } from "metabase/lib/redux";
import type { PublicOrEmbeddedDashboardEventHandlersProps } from "metabase/public/containers/PublicOrEmbeddedDashboard/types";
import type { Dashboard } from "metabase-types/api";
+import { getEventHandlers } from "../../store/selectors";
+
export const useDashboardLoadHandlers = ({
onLoad,
onLoadWithoutCards,
diff --git a/enterprise/frontend/src/embedding-sdk-bundle/store/index.ts b/enterprise/frontend/src/embedding-sdk-bundle/store/index.ts
index a8bf5961421..077977dd764 100644
--- a/enterprise/frontend/src/embedding-sdk-bundle/store/index.ts
+++ b/enterprise/frontend/src/embedding-sdk-bundle/store/index.ts
@@ -15,7 +15,7 @@ import { getStore } from "metabase/store";
import { reducer as visualizer } from "metabase/visualizer/visualizer.slice";
import { sdk } from "./reducer";
-import type { SdkStore } from "./types";
+import type { SdkDispatch, SdkStore } from "./types";
export const sdkReducers = {
...commonReducers,
@@ -42,7 +42,7 @@ export const getSdkStore = () =>
export const useSdkDispatch = () => {
useCheckSdkReduxContext();
- return useDispatch();
+ return useDispatch() as SdkDispatch;
};
export const useSdkStore = () => {
diff --git a/enterprise/frontend/src/embedding-sdk-bundle/store/reducer.ts b/enterprise/frontend/src/embedding-sdk-bundle/store/reducer.ts
index 41aadbc901d..07f9bc24438 100644
--- a/enterprise/frontend/src/embedding-sdk-bundle/store/reducer.ts
+++ b/enterprise/frontend/src/embedding-sdk-bundle/store/reducer.ts
@@ -13,7 +13,10 @@ import type {
MetabaseEmbeddingSessionToken,
MetabaseFetchRequestTokenFn,
} from "embedding-sdk-bundle/types/refresh-token";
-import type { SdkErrorComponent } from "embedding-sdk-bundle/types/ui";
+import type {
+ SdkErrorComponent,
+ SdkLoadingError,
+} from "embedding-sdk-bundle/types/ui";
import type { SdkUsageProblem } from "embedding-sdk-bundle/types/usage-problem";
import { createAsyncThunk } from "metabase/lib/redux";
@@ -23,6 +26,7 @@ const SET_METABASE_INSTANCE_VERSION = "sdk/SET_METABASE_INSTANCE_VERSION";
const SET_METABASE_CLIENT_URL = "sdk/SET_METABASE_CLIENT_URL";
const SET_LOADER_COMPONENT = "sdk/SET_LOADER_COMPONENT";
const SET_ERROR_COMPONENT = "sdk/SET_ERROR_COMPONENT";
+const SET_ERROR = "sdk/SET_ERROR";
const SET_FETCH_REQUEST_TOKEN_FN = "sdk/SET_FETCH_REQUEST_TOKEN_FN";
export const setMetabaseInstanceVersion = createAction<string>(
@@ -37,6 +41,7 @@ export const setLoaderComponent = createAction<null | (() => JSX.Element)>(
export const setErrorComponent = createAction<null | SdkErrorComponent>(
SET_ERROR_COMPONENT,
);
+export const setError = createAction<SdkLoadingError | null>(SET_ERROR);
export const setFetchRefreshTokenFn =
createAction<null | MetabaseFetchRequestTokenFn>(SET_FETCH_REQUEST_TOKEN_FN);
@@ -110,6 +115,7 @@ const initialState: SdkState = {
error: null,
},
loginStatus: { status: "uninitialized" },
+ error: null,
plugins: null,
eventHandlers: null,
usageProblem: null,
@@ -168,6 +174,10 @@ export const sdk = createReducer(initialState, (builder) => {
state.errorComponent = action.payload;
});
+ builder.addCase(setError, (state, action) => {
+ state.error = action.payload;
+ });
+
builder.addCase(setMetabaseInstanceVersion, (state, action) => {
state.metabaseInstanceVersion = action.payload;
});
diff --git a/enterprise/frontend/src/embedding-sdk-bundle/store/selectors.ts b/enterprise/frontend/src/embedding-sdk-bundle/store/selectors.ts
index c5495591827..fe24885544a 100644
--- a/enterprise/frontend/src/embedding-sdk-bundle/store/selectors.ts
+++ b/enterprise/frontend/src/embedding-sdk-bundle/store/selectors.ts
@@ -25,6 +25,8 @@ export const getLoaderComponent = (state: SdkStoreState) =>
export const getErrorComponent = (state: SdkStoreState) =>
state.sdk.errorComponent;
+export const getError = (state: SdkStoreState) => state.sdk.error;
+
export const getMetabaseInstanceUrl = (state: SdkStoreState) =>
state.sdk?.metabaseInstanceUrl;
diff --git a/enterprise/frontend/src/embedding-sdk-bundle/store/types.ts b/enterprise/frontend/src/embedding-sdk-bundle/store/types.ts
index 44cfb63f49b..e617f0465ec 100644
--- a/enterprise/frontend/src/embedding-sdk-bundle/store/types.ts
+++ b/enterprise/frontend/src/embedding-sdk-bundle/store/types.ts
@@ -11,7 +11,10 @@ import type { MetabaseAuthConfig } from "embedding-sdk-bundle/types/auth-config"
import type { SdkEventHandlersConfig } from "embedding-sdk-bundle/types/events";
import type { MetabasePluginsConfig } from "embedding-sdk-bundle/types/plugins";
import type { MetabaseEmbeddingSessionToken } from "embedding-sdk-bundle/types/refresh-token";
-import type { SdkErrorComponent } from "embedding-sdk-bundle/types/ui";
+import type {
+ SdkErrorComponent,
+ SdkLoadingError,
+} from "embedding-sdk-bundle/types/ui";
import type { SdkUsageProblem } from "embedding-sdk-bundle/types/usage-problem";
import type { LoginStatus } from "embedding-sdk-bundle/types/user";
import type { State } from "metabase-types/store";
@@ -33,6 +36,7 @@ export type SdkState = {
metabaseInstanceVersion: string | null;
token: EmbeddingSessionTokenState;
loginStatus: LoginStatus;
+ error: SdkLoadingError | null;
plugins: null | MetabasePluginsConfig;
eventHandlers: null | SdkEventHandlersConfig;
usageProblem: null | SdkUsageProblem;
diff --git a/enterprise/frontend/src/embedding-sdk-bundle/test/mocks/state.ts b/enterprise/frontend/src/embedding-sdk-bundle/test/mocks/state.ts
index 8ec0a7ba391..911197dc9c2 100644
--- a/enterprise/frontend/src/embedding-sdk-bundle/test/mocks/state.ts
+++ b/enterprise/frontend/src/embedding-sdk-bundle/test/mocks/state.ts
@@ -36,6 +36,7 @@ export const createMockSdkState = ({
eventHandlers: {},
loaderComponent: null,
errorComponent: null,
+ error: null,
fetchRefreshTokenFn: null,
...opts,
};
diff --git a/enterprise/frontend/src/embedding-sdk-bundle/types/collection.ts b/enterprise/frontend/src/embedding-sdk-bundle/types/collection.ts
index 662d6175ae5..a0ff86dee13 100644
--- a/enterprise/frontend/src/embedding-sdk-bundle/types/collection.ts
+++ b/enterprise/frontend/src/embedding-sdk-bundle/types/collection.ts
@@ -1,6 +1,6 @@
import type { SdkUserId } from "embedding-sdk-bundle/types/user";
-import type { SdkEntityId } from "./entity-id";
+import type { SdkEntityId } from "./entity";
// "CollectionId" from core app also includes "root" | "users" and "trash", we don't want to include those
// in public apis of the sdk, as we don't support them
diff --git a/enterprise/frontend/src/embedding-sdk-bundle/types/dashboard.ts b/enterprise/frontend/src/embedding-sdk-bundle/types/dashboard.ts
index 4248cf2d44c..1c5e1b0f391 100644
--- a/enterprise/frontend/src/embedding-sdk-bundle/types/dashboard.ts
+++ b/enterprise/frontend/src/embedding-sdk-bundle/types/dashboard.ts
@@ -5,7 +5,7 @@ import type {
import type { CreateDashboardProperties } from "metabase/dashboard/containers/CreateDashboardForm";
import type { CardDisplayType } from "metabase-types/api";
-import type { SdkEntityId } from "./entity-id";
+import type { SdkEntityId } from "./entity";
export type SdkDashboardId = number | string | SdkEntityId;
diff --git a/enterprise/frontend/src/embedding-sdk-bundle/types/entity-id.ts b/enterprise/frontend/src/embedding-sdk-bundle/types/entity.ts
similarity index 100%
rename from enterprise/frontend/src/embedding-sdk-bundle/types/entity-id.ts
rename to enterprise/frontend/src/embedding-sdk-bundle/types/entity.ts
diff --git a/enterprise/frontend/src/embedding-sdk-bundle/types/index.ts b/enterprise/frontend/src/embedding-sdk-bundle/types/index.ts
index 561ec0d5dfa..9b791d4d11e 100644
--- a/enterprise/frontend/src/embedding-sdk-bundle/types/index.ts
+++ b/enterprise/frontend/src/embedding-sdk-bundle/types/index.ts
@@ -1,7 +1,7 @@
export type * from "./auth-config";
export type * from "./collection";
export type * from "./dashboard";
-export type * from "./entity-id";
+export type * from "./entity";
export type * from "./events";
export type * from "./plugins";
export type * from "./question";
diff --git a/enterprise/frontend/src/embedding-sdk-bundle/types/question.ts b/enterprise/frontend/src/embedding-sdk-bundle/types/question.ts
index e2bbc68c6e9..4014e508a33 100644
--- a/enterprise/frontend/src/embedding-sdk-bundle/types/question.ts
+++ b/enterprise/frontend/src/embedding-sdk-bundle/types/question.ts
@@ -7,7 +7,7 @@ import type InternalQuestion from "metabase-lib/v1/Question";
import type { Card, ParameterValuesMap } from "metabase-types/api";
import type { SdkDashboardId } from "./dashboard";
-import type { SdkEntityId } from "./entity-id";
+import type { SdkEntityId } from "./entity";
export type { MetabaseQuestion } from "metabase/embedding-sdk/types/question";
diff --git a/enterprise/frontend/src/embedding-sdk-bundle/types/ui.ts b/enterprise/frontend/src/embedding-sdk-bundle/types/ui.ts
index 344dd0a1141..7284ed03266 100644
--- a/enterprise/frontend/src/embedding-sdk-bundle/types/ui.ts
+++ b/enterprise/frontend/src/embedding-sdk-bundle/types/ui.ts
@@ -22,3 +22,8 @@ export type SdkErrorComponent = ({
message,
error,
}: SdkErrorComponentProps) => JSX.Element;
+
+export type SdkLoadingError = {
+ status: number;
+ message: string;
+};
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/hooks/use-sdk-iframe-embed-event-bus.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/hooks/use-sdk-iframe-embed-event-bus.ts
index d243ddb6984..5e1c4d06547 100644
--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/hooks/use-sdk-iframe-embed-event-bus.ts
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/hooks/use-sdk-iframe-embed-event-bus.ts
@@ -8,6 +8,7 @@ import type { EmbeddedAnalyticsJsEventSchema } from "metabase-types/analytics/em
import type {
SdkIframeEmbedMessage,
SdkIframeEmbedSettings,
+ SdkIframeEmbedTagMessage,
} from "../types/embed";
type Handler = (event: MessageEvent<SdkIframeEmbedMessage>) => void;
@@ -17,13 +18,15 @@ type UsageAnalytics = {
embedHostUrl: string;
};
+const sendMessage = (message: SdkIframeEmbedTagMessage) => {
+ window.parent.postMessage(message, "*");
+};
+
export function useSdkIframeEmbedEventBus({
onSettingsChanged,
}: {
onSettingsChanged?: (settings: SdkIframeEmbedSettings) => void;
-}): {
- embedSettings: SdkIframeEmbedSettings | null;
-} {
+}) {
const [embedSettings, setEmbedSettings] =
useState<SdkIframeEmbedSettings | null>(null);
const [usageAnalytics, setUsageAnalytics] = useState<UsageAnalytics | null>(
@@ -52,7 +55,7 @@ export function useSdkIframeEmbedEventBus({
window.addEventListener("message", messageHandler);
// notify embed.js that the iframe is ready
- window.parent.postMessage({ type: "metabase.embed.iframeReady" }, "*");
+ sendMessage({ type: "metabase.embed.iframeReady" });
return () => {
window.removeEventListener("message", messageHandler);
@@ -71,7 +74,7 @@ export function useSdkIframeEmbedEventBus({
}
}, [embedSettings?.instanceUrl, usageAnalytics]);
- return { embedSettings };
+ return { sendMessage, embedSettings };
}
export function isMetabaseInstance(instanceUrl: string, embedHostUrl: string) {
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/ParameterSettings/ParameterSettings.tsx b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/ParameterSettings/ParameterSettings.tsx
index bee3d0c20fe..6bd0e58f3e3 100644
--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/ParameterSettings/ParameterSettings.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/ParameterSettings/ParameterSettings.tsx
@@ -21,7 +21,7 @@ export const ParameterSettings = () => {
settings,
updateSettings,
availableParameters,
- parameterValuesById,
+ parametersValuesById,
isLoading,
} = useSdkIframeEmbedSetupContext();
@@ -61,10 +61,10 @@ export const ParameterSettings = () => {
() =>
getValuePopulatedParameters({
parameters: availableParameters,
- values: parameterValuesById,
+ values: parametersValuesById,
defaultRequired: true,
}),
- [availableParameters, parameterValuesById],
+ [availableParameters, parametersValuesById],
);
// Only show parameters for dashboards and questions
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SdkIframeEmbedSetupProvider.tsx b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SdkIframeEmbedSetupProvider.tsx
index 865bca276f4..d2ccd2eef39 100644
--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SdkIframeEmbedSetupProvider.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/components/SdkIframeEmbedSetupProvider.tsx
@@ -123,7 +123,7 @@ export const SdkIframeEmbedSetupProvider = ({
addRecentItem,
isEmbedSettingsLoaded,
availableParameters,
- parameterValuesById: parametersValuesById,
+ parametersValuesById,
};
return (
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/context.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/context.ts
index 4cefe989a87..635e598f79e 100644
--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/context.ts
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk_setup/context.ts
@@ -44,7 +44,7 @@ export interface SdkIframeEmbedSetupContextType {
// Parameters for dashboards and questions
availableParameters: Parameter[];
- parameterValuesById: EmbeddingParametersValues;
+ parametersValuesById: EmbeddingParametersValues;
isEmbedSettingsLoaded: boolean;
}
diff --git a/frontend/src/metabase/public/components/EmbedModal/StaticEmbedSetupPane/CodeSample.tsx b/frontend/src/metabase/public/components/EmbedModal/StaticEmbedSetupPane/CodeSample.tsx
index 3a1d7b7ddb6..2e7d604cc11 100644
--- a/frontend/src/metabase/public/components/EmbedModal/StaticEmbedSetupPane/CodeSample.tsx
+++ b/frontend/src/metabase/public/components/EmbedModal/StaticEmbedSetupPane/CodeSample.tsx
@@ -1,11 +1,11 @@
import cx from "classnames";
-import { type ChangeEvent, useMemo } from "react";
+import { useMemo } from "react";
import type { CodeLanguage } from "metabase/common/components/CodeEditor";
import { CodeEditor } from "metabase/common/components/CodeEditor";
import { CopyButton } from "metabase/common/components/CopyButton";
-import Select, { Option } from "metabase/common/components/Select";
import CS from "metabase/css/core/index.css";
+import { EmbedServerSnippetLanguageSelect } from "metabase/public/components/EmbedServerSnippetLanguageSelect/EmbedServerSnippetLanguageSelect";
import type { CodeSampleOption } from "metabase/public/lib/types";
import { CopyButtonContainer } from "./CodeSample.styled";
@@ -48,24 +48,12 @@ export const CodeSample = ({
{(title || languageOptions.length > 1) && (
<div className={cx(CS.flex, CS.alignCenter)}>
{title && <h4>{title}</h4>}
- {languageOptions.length > 1 ? (
- <Select
- className={CS.mlAuto}
- value={selectedOptionId}
- onChange={(e: ChangeEvent<HTMLSelectElement>) =>
- onChangeOption(e.target.value)
- }
- buttonProps={{
- dataTestId,
- }}
- >
- {languageOptions.map((option) => (
- <Option key={option.id} value={option.id}>
- {option.name}
- </Option>
- ))}
- </Select>
- ) : null}
+ <EmbedServerSnippetLanguageSelect
+ languageOptions={languageOptions}
+ selectedOptionId={selectedOptionId}
+ onChangeOption={onChangeOption}
+ dataTestId={dataTestId}
+ />
</div>
)}
<div
diff --git a/frontend/src/metabase/public/components/EmbedModal/StaticEmbedSetupPane/ServerEmbedCodePane.tsx b/frontend/src/metabase/public/components/EmbedModal/StaticEmbedSetupPane/ServerEmbedCodePane.tsx
index 3a5a5f42737..8b78520a7d6 100644
--- a/frontend/src/metabase/public/components/EmbedModal/StaticEmbedSetupPane/ServerEmbedCodePane.tsx
+++ b/frontend/src/metabase/public/components/EmbedModal/StaticEmbedSetupPane/ServerEmbedCodePane.tsx
@@ -131,6 +131,7 @@ function getHighlightedText({
resourceId: resource.id,
params: initialPreviewParameters,
displayOptions,
+ withIframeSnippet: true,
}).find(({ id }) => id === selectedServerCodeOptionId)?.parametersSource;
const hasAppearanceCodeDiff = !_.isEqual(
diff --git a/frontend/src/metabase/public/components/EmbedModal/StaticEmbedSetupPane/StaticEmbedSetupPane.tsx b/frontend/src/metabase/public/components/EmbedModal/StaticEmbedSetupPane/StaticEmbedSetupPane.tsx
index b02359a78a0..b1d1aa407e7 100644
--- a/frontend/src/metabase/public/components/EmbedModal/StaticEmbedSetupPane/StaticEmbedSetupPane.tsx
+++ b/frontend/src/metabase/public/components/EmbedModal/StaticEmbedSetupPane/StaticEmbedSetupPane.tsx
@@ -121,6 +121,7 @@ export const StaticEmbedSetupPane = ({
resourceId: resource.id,
params: previewParametersBySlug,
displayOptions,
+ withIframeSnippet: true,
});
const [selectedServerCodeOptionId, setSelectedServerCodeOptionId] = useState(
diff --git a/frontend/src/metabase/public/components/EmbedServerSnippetLanguageSelect/EmbedServerSnippetLanguageSelect.tsx b/frontend/src/metabase/public/components/EmbedServerSnippetLanguageSelect/EmbedServerSnippetLanguageSelect.tsx
new file mode 100644
index 00000000000..9cf0162547d
--- /dev/null
+++ b/frontend/src/metabase/public/components/EmbedServerSnippetLanguageSelect/EmbedServerSnippetLanguageSelect.tsx
@@ -0,0 +1,42 @@
+import type { ChangeEvent } from "react";
+
+import Select, { Option } from "metabase/common/components/Select";
+import CS from "metabase/css/core/index.css";
+import type { CodeSampleOption } from "metabase/public/lib/types";
+
+type Props = {
+ languageOptions: CodeSampleOption[];
+ selectedOptionId: string;
+ onChangeOption: (optionId: string) => void;
+ dataTestId?: string;
+};
+
+export const EmbedServerSnippetLanguageSelect = ({
+ languageOptions,
+ selectedOptionId,
+ onChangeOption,
+ dataTestId,
+}: Props) => {
+ if (!languageOptions.length) {
+ return null;
+ }
+
+ return (
+ <Select
+ className={CS.mlAuto}
+ value={selectedOptionId}
+ onChange={(e: ChangeEvent<HTMLSelectElement>) =>
+ onChangeOption(e.target.value)
+ }
+ buttonProps={{
+ dataTestId,
+ }}
+ >
+ {languageOptions.map((option) => (
+ <Option key={option.id} value={option.id}>
+ {option.name}
+ </Option>
+ ))}
+ </Select>
+ );
+};
diff --git a/frontend/src/metabase/public/lib/code-templates.ts b/frontend/src/metabase/public/lib/code-templates.ts
index 8155d6a51b5..79a841c5c15 100644
--- a/frontend/src/metabase/public/lib/code-templates.ts
+++ b/frontend/src/metabase/public/lib/code-templates.ts
@@ -34,7 +34,13 @@ function transformEmbeddingDisplayToHashOptions(
return { ...displayOptions, downloads };
}
-function getIframeQuerySource(displayOptions: EmbeddingDisplayOptions) {
+function getIframeQuerySource(
+ displayOptions: EmbeddingDisplayOptions | undefined,
+) {
+ if (!displayOptions) {
+ return "";
+ }
+
return JSON.stringify(getIframeQueryWithoutDefaults(displayOptions));
}
@@ -63,6 +69,7 @@ export const node = {
resourceId,
params,
displayOptions,
+ withIframeSnippet,
}: CodeSampleParameters) =>
`// you will need to install via 'npm install jsonwebtoken' or in your package.json
@@ -78,8 +85,13 @@ const payload = {
};
const token = jwt.sign(payload, METABASE_SECRET_KEY);
-const iframeUrl = METABASE_SITE_URL + "/embed/${resourceType}/" + token +
- ${node.getIframeQuerySource(displayOptions)};`,
+${
+ withIframeSnippet
+ ? `const iframeUrl = METABASE_SITE_URL + "/embed/${resourceType}/" + token +
+ ${node.getIframeQuerySource(displayOptions)};`
+ : ""
+}
+`.trim(),
};
export const python = {
@@ -99,6 +111,7 @@ export const python = {
resourceId,
params,
displayOptions,
+ withIframeSnippet,
}: CodeSampleParameters) =>
`# You'll need to install PyJWT via pip 'pip install PyJWT' or your project packages file
@@ -115,8 +128,8 @@ payload = {
}
token = jwt.encode(payload, METABASE_SECRET_KEY, algorithm="HS256")
-iframeUrl = METABASE_SITE_URL + "/embed/${resourceType}/" + token + ${python.getIframeQuerySource(displayOptions)}
-`,
+${withIframeSnippet ? `iframeUrl = METABASE_SITE_URL + "/embed/${resourceType}/" + token + ${python.getIframeQuerySource(displayOptions)}` : ""}
+`.trim(),
};
export const ruby = {
@@ -141,6 +154,7 @@ export const ruby = {
resourceId,
params,
displayOptions,
+ withIframeSnippet,
}: CodeSampleParameters) =>
`# you will need to install 'jwt' gem first via 'gem install jwt' or in your project Gemfile
@@ -156,8 +170,13 @@ payload = {
}
token = JWT.encode payload, METABASE_SECRET_KEY
-iframe_url = METABASE_SITE_URL + "/embed/${resourceType}/" + token +
- ${ruby.getIframeQuerySource(displayOptions)}`,
+${
+ withIframeSnippet
+ ? `iframe_url = METABASE_SITE_URL + "/embed/${resourceType}/" + token +
+ ${ruby.getIframeQuerySource(displayOptions)}`
+ : ""
+}
+`.trim(),
};
export const clojure = {
@@ -175,6 +194,7 @@ export const clojure = {
resourceId,
params,
displayOptions,
+ withIframeSnippet,
}: CodeSampleParameters) =>
`(require '[buddy.sign.jwt :as jwt])
@@ -188,8 +208,13 @@ export const clojure = {
(def token (jwt/sign payload metabase-secret-key))
-(def iframe-url (str metabase-site-url "/embed/${resourceType}/" token
- ${clojure.getIframeQuerySource(displayOptions)}))`,
+${
+ withIframeSnippet
+ ? `(def iframe-url (str metabase-site-url "/embed/${resourceType}/" token
+ ${clojure.getIframeQuerySource(displayOptions)}))`
+ : ""
+}
+`.trim(),
};
export const getHtmlSource = ({ iframeUrl }: { iframeUrl: string }) =>
diff --git a/frontend/src/metabase/public/lib/embed.ts b/frontend/src/metabase/public/lib/embed.ts
index 6dd2d541e0d..600f559b72f 100644
--- a/frontend/src/metabase/public/lib/embed.ts
+++ b/frontend/src/metabase/public/lib/embed.ts
@@ -7,15 +7,16 @@ import type {
EmbeddingParametersValues,
} from "./types";
-async function getSignedToken(
+export async function getSignedToken(
resourceType: EmbedResourceType,
- resourceId: EmbedResource["id"],
+ rawResourceId: EmbedResource["id"],
params: EmbeddingParametersValues = {},
secretKey: string,
previewEmbeddingParams: EmbeddingParametersValues,
) {
+ const normalizedResourceId = parseInt(rawResourceId as string, 10);
const unsignedToken: Record<string, any> = {
- resource: { [resourceType]: resourceId },
+ resource: { [resourceType]: normalizedResourceId },
params: params,
iat: Math.round(new Date().getTime() / 1000),
};
diff --git a/frontend/src/metabase/public/lib/types.ts b/frontend/src/metabase/public/lib/types.ts
index be371336302..13205145629 100644
--- a/frontend/src/metabase/public/lib/types.ts
+++ b/frontend/src/metabase/public/lib/types.ts
@@ -71,7 +71,8 @@ export type CodeSampleParameters = {
resourceType: EmbedResourceType;
resourceId: EmbedResource["id"];
params: EmbeddingParametersValues;
- displayOptions: EmbeddingDisplayOptions;
+ displayOptions?: EmbeddingDisplayOptions;
+ withIframeSnippet: boolean;
};
export type ClientCodeSampleConfig = {
diff --git a/frontend/src/metabase/query_builder/components/VisualizationResult.jsx b/frontend/src/metabase/query_builder/components/VisualizationResult.jsx
index 92ffb671efe..acd9e01c7e3 100644
--- a/frontend/src/metabase/query_builder/components/VisualizationResult.jsx
+++ b/frontend/src/metabase/query_builder/components/VisualizationResult.jsx
@@ -52,6 +52,7 @@ export default class VisualizationResult extends Component {
render() {
const {
question,
+ token,
isDirty,
queryBuilderMode,
navigateToNewCardInsideQB,
@@ -145,6 +146,7 @@ export default class VisualizationResult extends Component {
canToggleSeriesVisibility
metadata={question.metadata()}
timelineEvents={timelineEvents}
+ token={token}
selectedTimelineEventIds={selectedTimelineEventIds}
handleVisualizationClick={this.props.handleVisualizationClick}
onOpenTimelines={this.props.onOpenTimelines}
diff --git a/frontend/src/metabase/redux/downloads.ts b/frontend/src/metabase/redux/downloads.ts
index 74d328b40ce..3c9308abff2 100644
--- a/frontend/src/metabase/redux/downloads.ts
+++ b/frontend/src/metabase/redux/downloads.ts
@@ -31,7 +31,7 @@ export interface DownloadQueryResultsOpts {
dashboardId?: DashboardId;
dashcardId?: DashCardId;
uuid?: string;
- token?: string;
+ token?: string | null;
params?: Record<string, unknown>;
visualizationSettings?: VisualizationSettings;
}