Skip to content

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

Skipping first sso request if possible in EAJS/Modular Embedding (#68679)

Sébastien8bafab3e0fa7
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 3224c96d43e..04eee68e8db 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
@@ -9,6 +9,91 @@ import {
const { H } = cy;
describe("scenarios > embedding > sdk iframe embedding > authentication", () => {
+ describe("jwtProviderUri", () => {
+ beforeEach(() => {
+ cy.signInAsAdmin();
+ H.prepareSdkIframeEmbedTest({
+ withToken: "bleeding-edge",
+ });
+
+ cy.intercept("GET", "http://localhost:4000/auth/sso").as("sso");
+ cy.intercept("GET", "http://auth-provider/sso?response=json").as(
+ "ssoProvider",
+ );
+ cy.intercept("GET", "http://localhost:4000/auth/sso?*").as(
+ "tokenInSessionOut",
+ );
+ });
+
+ it("should not skip the first auth request if jwtProviderUri is not given", () => {
+ H.visitCustomHtmlPage(`
+ <!DOCTYPE html>
+ <html>
+ <body>
+ <script src="http://localhost:4000/app/embed.js" ></script>
+ <script>
+ function defineMetabaseConfig(settings) {
+ window.metabaseConfig = settings;
+ }
+ </script>
+ <script>
+ defineMetabaseConfig({
+ "instanceUrl": "http://localhost:4000",
+ });
+ </script>
+ <metabase-dashboard dashboard-id='9' />
+ </body>
+ </html>
+ `);
+
+ cy.wait("@sso");
+ cy.wait("@ssoProvider");
+ cy.wait("@tokenInSessionOut");
+
+ cy.wait("@getDashboard");
+
+ H.getSimpleEmbedIframeContent().should(
+ "contain",
+ "Orders in a dashboard",
+ );
+ });
+
+ it("should skip the first auth request if jwtProviderUri is given", () => {
+ H.visitCustomHtmlPage(`
+ <!DOCTYPE html>
+ <html>
+ <body>
+ <script src="http://localhost:4000/app/embed.js" ></script>
+ <script>
+ function defineMetabaseConfig(settings) {
+ window.metabaseConfig = settings;
+ }
+ </script>
+ <script>
+ defineMetabaseConfig({
+ "instanceUrl": "http://localhost:4000",
+ "jwtProviderUri": "http://auth-provider/sso?response=json",
+ });
+ </script>
+ <metabase-dashboard dashboard-id='9' />
+ </body>
+ </html>
+ `);
+
+ cy.wait("@ssoProvider");
+ cy.wait("@tokenInSessionOut");
+
+ cy.get("@sso.all").should("have.length", 0);
+
+ cy.wait("@getDashboard");
+
+ H.getSimpleEmbedIframeContent().should(
+ "contain",
+ "Orders in a dashboard",
+ );
+ });
+ });
+
it("cannot login if no auth methods are enabled", () => {
H.prepareSdkIframeEmbedTest({ enabledAuthMethods: [], signOut: true });
diff --git a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/auth-manager/AuthManager.ts b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/auth-manager/AuthManager.ts
index 415344340bc..da5b7854ea4 100644
--- a/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/auth-manager/AuthManager.ts
+++ b/enterprise/frontend/src/metabase-enterprise/embedding_iframe_sdk/auth-manager/AuthManager.ts
@@ -52,13 +52,21 @@ export class EmbedAuthManager {
method: "saml" | "jwt";
sessionToken: MetabaseEmbeddingSessionToken;
}> {
- const { instanceUrl, preferredAuthMethod, fetchRequestToken } =
- this.context.properties;
-
- const urlResponseJson = await connectToInstanceAuthSso(instanceUrl, {
- headers: this.getAuthRequestHeader(),
+ const {
+ instanceUrl,
preferredAuthMethod,
- });
+ fetchRequestToken,
+ jwtProviderUri,
+ } = this.context.properties;
+
+ const shouldSkipSsoDiscovery = jwtProviderUri !== undefined;
+
+ const urlResponseJson = shouldSkipSsoDiscovery
+ ? { method: "jwt", url: jwtProviderUri }
+ : await connectToInstanceAuthSso(instanceUrl, {
+ headers: this.getAuthRequestHeader(),
+ preferredAuthMethod,
+ });
const { method, url: responseUrl, hash } = urlResponseJson || {};
@@ -68,7 +76,7 @@ export class EmbedAuthManager {
return { method, sessionToken };
}
- if (method === "jwt") {
+ if (method === "jwt" && responseUrl) {
const sessionToken = await jwtDefaultRefreshTokenFunction(
responseUrl,
instanceUrl,
diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk/constants.ts b/frontend/src/metabase/embedding/embedding-iframe-sdk/constants.ts
index 26f7d1893a2..d2196226b74 100644
--- a/frontend/src/metabase/embedding/embedding-iframe-sdk/constants.ts
+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk/constants.ts
@@ -26,6 +26,7 @@ export const ALLOWED_EMBED_SETTING_KEYS_MAP = {
"fetchRequestToken",
"useExistingUserSession",
"isGuest",
+ "jwtProviderUri",
] satisfies (keyof SdkIframeEmbedBaseSettings)[],
dashboard: [
"dashboardId",
diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk/types/auth-manager.ts b/frontend/src/metabase/embedding/embedding-iframe-sdk/types/auth-manager.ts
index 7128704beb9..c7ae15bd56d 100644
--- a/frontend/src/metabase/embedding/embedding-iframe-sdk/types/auth-manager.ts
+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk/types/auth-manager.ts
@@ -8,6 +8,7 @@ export interface EmbedAuthManagerContext {
instanceUrl: string;
preferredAuthMethod?: MetabaseAuthMethod;
fetchRequestToken?: MetabaseFetchRequestTokenFn;
+ jwtProviderUri?: string;
};
sendMessage<Message extends SdkIframeEmbedMessage>(
type: Message["type"],
diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk/types/embed.ts b/frontend/src/metabase/embedding/embedding-iframe-sdk/types/embed.ts
index 91a2825b554..3dc50244992 100644
--- a/frontend/src/metabase/embedding/embedding-iframe-sdk/types/embed.ts
+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk/types/embed.ts
@@ -181,6 +181,7 @@ export type SdkIframeEmbedBaseSettings = {
theme?: MetabaseTheme;
locale?: string;
preferredAuthMethod?: MetabaseAuthMethod;
+ jwtProviderUri?: string;
fetchRequestToken?: MetabaseFetchRequestTokenFn;
/** Whether we should use the existing user session (i.e. admin user's cookie) */