Skip to content

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

fix(sdk): Fix SDK refresh token race-conditions (#64094)

Timofey Kachalov8ba64b7bcd37
diff --git a/e2e/support/helpers/embedding-sdk-testing/embedding-sdk-helpers.ts b/e2e/support/helpers/embedding-sdk-testing/embedding-sdk-helpers.ts
index 119062e3aa5..8d90699827a 100644
--- a/e2e/support/helpers/embedding-sdk-testing/embedding-sdk-helpers.ts
+++ b/e2e/support/helpers/embedding-sdk-testing/embedding-sdk-helpers.ts
@@ -11,20 +11,29 @@ import {
} from "e2e/support/helpers";
import { enableJwtAuth } from "e2e/support/helpers/e2e-jwt-helpers";
-export const getSignedJwtForUser = async (user = USERS.admin) => {
+export const getSignedJwtForUser = async ({
+ user = USERS.admin,
+ expiredInSeconds = 60 * 10, // 10 minutes expiration,
+}: {
+ user?: { email: string; first_name: string; last_name: string };
+ expiredInSeconds?: number;
+}) => {
const secret = new TextEncoder().encode(JWT_SHARED_SECRET);
return new jose.SignJWT({
email: user.email,
first_name: user.first_name,
last_name: user.last_name,
- exp: Math.round(Date.now() / 1000) + 60 * 10, // 10 minutes expiration
+ exp: Math.round(Date.now() / 1000) + expiredInSeconds,
})
.setProtectedHeader({ alg: "HS256" })
.sign(secret);
};
-export const mockAuthProviderAndJwtSignIn = (user = USERS.admin) => {
+export const mockAuthProviderAndJwtSignIn = (
+ user = USERS.admin,
+ { jwt }: { jwt?: string } = {},
+) => {
cy.intercept("GET", `${AUTH_PROVIDER_URL}**`, async (req) => {
try {
const url = new URL(req.url);
@@ -39,7 +48,7 @@ export const mockAuthProviderAndJwtSignIn = (user = USERS.admin) => {
return;
}
- const jwt = await getSignedJwtForUser(user);
+ jwt = jwt || (await getSignedJwtForUser({ user }));
req.reply({
statusCode: 200,
diff --git a/e2e/test-component/scenarios/embedding-sdk/requests.cy.spec.tsx b/e2e/test-component/scenarios/embedding-sdk/requests.cy.spec.tsx
index ee9b574d92f..234455aaccd 100644
--- a/e2e/test-component/scenarios/embedding-sdk/requests.cy.spec.tsx
+++ b/e2e/test-component/scenarios/embedding-sdk/requests.cy.spec.tsx
@@ -1,7 +1,20 @@
-import { CollectionBrowser } from "@metabase/embedding-sdk-react";
+import {
+ CollectionBrowser,
+ InteractiveQuestion,
+ MetabaseProvider,
+} from "@metabase/embedding-sdk-react";
-import { mountSdkContent } from "e2e/support/helpers/embedding-sdk-component-testing/component-embedding-sdk-helpers";
-import { signInAsAdminAndEnableEmbeddingSdk } from "e2e/support/helpers/embedding-sdk-testing";
+import { USERS } from "e2e/support/cypress_data";
+import { ORDERS_QUESTION_ID } from "e2e/support/cypress_sample_instance_data";
+import { getSdkRoot } from "e2e/support/helpers/e2e-embedding-sdk-helpers";
+import {
+ DEFAULT_SDK_AUTH_PROVIDER_CONFIG,
+ mountSdkContent,
+} from "e2e/support/helpers/embedding-sdk-component-testing/component-embedding-sdk-helpers";
+import {
+ getSignedJwtForUser,
+ signInAsAdminAndEnableEmbeddingSdk,
+} from "e2e/support/helpers/embedding-sdk-testing";
import { mockAuthProviderAndJwtSignIn } from "e2e/support/helpers/embedding-sdk-testing/embedding-sdk-helpers";
describe("scenarios > embedding-sdk > requests", () => {
@@ -23,5 +36,39 @@ describe("scenarios > embedding-sdk > requests", () => {
expect(maxAgeHeader).to.equal("60");
});
});
+
+ it("properly performs session token refresh request when multiple data requests are triggered at the same time", () => {
+ const expiredInSeconds = 60;
+ cy.clock(Date.now());
+
+ cy.then(() => getSignedJwtForUser({ expiredInSeconds })).then((jwt) => {
+ mockAuthProviderAndJwtSignIn(USERS.admin, { jwt });
+ });
+
+ cy.mount(
+ <MetabaseProvider authConfig={DEFAULT_SDK_AUTH_PROVIDER_CONFIG}>
+ <InteractiveQuestion questionId={ORDERS_QUESTION_ID} />
+ </MetabaseProvider>,
+ );
+
+ getSdkRoot().within(() => {
+ cy.findByText("Orders").should("exist");
+
+ cy.findByText("Group").click();
+
+ cy.findByRole("dialog").should("be.visible");
+
+ cy.tick(1000 * (expiredInSeconds + 5));
+
+ cy.findByRole("dialog").contains(/^ID$/).click();
+ cy.findByRole("dialog").findByTestId("badge-remove-button").click();
+
+ cy.wait("@jwtProvider");
+
+ cy.intercept("POST", "/api/dataset").as("dataset");
+ // We ensure that both `dataset` requests are made after the token refresh request
+ cy.get("@dataset.all").should("have.length", 2);
+ });
+ });
});
});
diff --git a/e2e/test/scenarios/embedding/sdk-iframe-embedding/authentication.cy.spec.ts b/e2e/test/scenarios/embedding/sdk-iframe-embedding/authentication.cy.spec.ts
index 154b4fc5ff7..3224c96d43e 100644
--- a/e2e/test/scenarios/embedding/sdk-iframe-embedding/authentication.cy.spec.ts
+++ b/e2e/test/scenarios/embedding/sdk-iframe-embedding/authentication.cy.spec.ts
@@ -134,7 +134,7 @@ describe("scenarios > embedding > sdk iframe embedding > authentication", () =>
(win as any).metabaseConfig = {
...(win as any).metabaseConfig,
fetchRequestToken: async () => {
- const jwt = await getSignedJwtForUser(USERS.admin);
+ const jwt = await getSignedJwtForUser({ user: USERS.admin });
return { jwt };
},
diff --git a/enterprise/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/util/BadgeList/BadgeListItem/BadgeListItem.tsx b/enterprise/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/util/BadgeList/BadgeListItem/BadgeListItem.tsx
index 1661732d8d5..cbb0b20fa29 100644
--- a/enterprise/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/util/BadgeList/BadgeListItem/BadgeListItem.tsx
+++ b/enterprise/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/util/BadgeList/BadgeListItem/BadgeListItem.tsx
@@ -37,6 +37,7 @@ const _BadgeListItem = (
onRemoveItem?.();
}}
className={S.BadgeListRemoveButton}
+ data-testid="badge-remove-button"
>
<Icon name="close" c="var(--mb-color-text-brand)" size={10} />
</ActionIcon>
diff --git a/enterprise/frontend/src/embedding-sdk-bundle/store/reducer.ts b/enterprise/frontend/src/embedding-sdk-bundle/store/reducer.ts
index 86fb96445b2..cb4563bb52e 100644
--- a/enterprise/frontend/src/embedding-sdk-bundle/store/reducer.ts
+++ b/enterprise/frontend/src/embedding-sdk-bundle/store/reducer.ts
@@ -1,11 +1,18 @@
-import { createAction, createReducer } from "@reduxjs/toolkit";
+import {
+ type AsyncThunkAction,
+ createAction,
+ createReducer,
+} from "@reduxjs/toolkit";
import { samlTokenStorage } from "embedding/auth-common";
import type { SdkState, SdkStoreState } from "embedding-sdk-bundle/store/types";
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 { MetabaseFetchRequestTokenFn } from "embedding-sdk-bundle/types/refresh-token";
+import type {
+ MetabaseEmbeddingSessionToken,
+ MetabaseFetchRequestTokenFn,
+} from "embedding-sdk-bundle/types/refresh-token";
import type { SdkErrorComponent } from "embedding-sdk-bundle/types/ui";
import type { SdkUsageProblem } from "embedding-sdk-bundle/types/usage-problem";
import { createAsyncThunk } from "metabase/lib/redux";
@@ -35,6 +42,10 @@ export const setFetchRefreshTokenFn =
const GET_OR_REFRESH_SESSION = "sdk/token/GET_OR_REFRESH_SESSION";
+let refreshTokenPromise: ReturnType<
+ AsyncThunkAction<MetabaseEmbeddingSessionToken | null, unknown, any>
+> | null = null;
+
export const getOrRefreshSession = createAsyncThunk(
GET_OR_REFRESH_SESSION,
async (
@@ -52,11 +63,20 @@ export const getOrRefreshSession = createAsyncThunk(
const isTokenValid = token && token.exp * 1000 >= Date.now();
- if (state.loading || isTokenValid) {
+ if (isTokenValid) {
return token;
}
- return dispatch(refreshTokenAsync(authConfig)).unwrap();
+ if (refreshTokenPromise) {
+ return refreshTokenPromise.unwrap();
+ }
+
+ refreshTokenPromise = dispatch(refreshTokenAsync(authConfig));
+ refreshTokenPromise.finally(() => {
+ refreshTokenPromise = null;
+ });
+
+ return refreshTokenPromise.unwrap();
},
);