@thoughtspot/visual-embed-sdk 1.10.0 → 1.10.3

package/src/embed/base.ts

@@ -7,31 +7,72 @@
  * @summary Base classes
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
+import EventEmitter from 'eventemitter3';
 import { getThoughtSpotHost } from '../config';
-import { EmbedConfig } from '../types';
-import { authenticate } from '../auth';
+import { AuthType, EmbedConfig } from '../types';
+import {
+    authenticate,
+    logout as _logout,
+    AuthFailureType,
+    AuthStatus,
+} from '../auth';
 import { uploadMixpanelEvent, MIXPANEL_EVENT } from '../mixpanel-service';
 
 let config = {} as EmbedConfig;
+const CONFIG_DEFAULTS: Partial<EmbedConfig> = {
+    loginFailedMessage: 'Not logged in',
+    authType: AuthType.None,
+};
+
+export let authPromise: Promise<boolean>;
+
+export const getEmbedConfig = (): EmbedConfig => config;
+
+export const getAuthPromise = (): Promise<boolean> => authPromise;
+
+let authEE: EventEmitter;
+
+export function notifyAuthSuccess(): void {
+    if (!authEE) {
+        console.error('SDK not initialized');
+        return;
+    }
+    authEE.emit(AuthStatus.SUCCESS);
+}
 
-export let authPromise: Promise<void>;
+export function notifyAuthFailure(failureType: AuthFailureType): void {
+    if (!authEE) {
+        console.error('SDK not initialized');
+        return;
+    }
+    authEE.emit(AuthStatus.FAILURE, failureType);
+}
 
+export function notifyLogout(): void {
+    if (!authEE) {
+        console.error('SDK not initialized');
+        return;
+    }
+    authEE.emit(AuthStatus.LOGOUT);
+}
 /**
  * Perform authentication on the ThoughtSpot app as applicable.
  */
-export const handleAuth = (): Promise<void> => {
-    const authConfig = {
-        ...config,
-        thoughtSpotHost: getThoughtSpotHost(config),
-    };
-    authPromise = authenticate(authConfig);
+export const handleAuth = (): Promise<boolean> => {
+    authPromise = authenticate(config);
+    authPromise.then(
+        (isLoggedIn) => {
+            if (!isLoggedIn) {
+                notifyAuthFailure(AuthFailureType.SDK);
+            }
+        },
+        () => {
+            notifyAuthFailure(AuthFailureType.SDK);
+        },
+    );
     return authPromise;
 };
 
-export const getEmbedConfig = (): EmbedConfig => config;
-
-export const getAuthPromise = (): Promise<void> => authPromise;
-
 /**
  * Prefetches static resources from the specified URL. Web browsers can then cache the prefetched resources and serve them from the user's local disk to provide faster access to your app.
  * @param url The URL provided for prefetch
@@ -57,10 +98,18 @@ export const prefetch = (url?: string): void => {
  * @param embedConfig The configuration object containing ThoughtSpot host,
  * authentication mechanism and so on.
  *
- * @returns authPromise Promise which resolves when authentication is complete.
+ * eg: authStatus = init(config);
+ * authStatus.on(AuthStatus.FAILURE, (reason) => { // do something here });
+ *
+ * @returns event emitter which emits events on authentication success, failure and logout. {@link AuthStatus}
  */
-export const init = (embedConfig: EmbedConfig): Promise<void> => {
-    config = embedConfig;
+export const init = (embedConfig: EmbedConfig): EventEmitter => {
+    config = {
+        ...CONFIG_DEFAULTS,
+        ...embedConfig,
+        thoughtSpotHost: getThoughtSpotHost(embedConfig),
+    };
+    authEE = new EventEmitter();
     handleAuth();
 
     uploadMixpanelEvent(MIXPANEL_EVENT.VISUAL_SDK_CALLED_INIT, {
@@ -71,7 +120,32 @@ export const init = (embedConfig: EmbedConfig): Promise<void> => {
     if (config.callPrefetch) {
         prefetch(config.thoughtSpotHost);
     }
-    return authPromise;
+    return authEE;
+};
+
+export function disableAutoLogin(): void {
+    config.autoLogin = false;
+}
+
+/**
+ * Logout from ThoughtSpot. This also sets the autoLogin flag to false, to prevent
+ * the SDK from automatically logging in again.
+ *
+ * You can call the `init` method again to re login, if autoLogin is set to true in this
+ * second call it will be honored.
+ *
+ * @param doNotDisableAutoLogin This flag when passed will not disable autoLogin
+ * @returns Promise which resolves when logout completes.
+ * @version SDK: 1.10.1 | ThoughtSpot: *
+ */
+export const logout = (doNotDisableAutoLogin = false): Promise<boolean> => {
+    if (!doNotDisableAutoLogin) {
+        disableAutoLogin();
+    }
+    return _logout(config).then((isLoggedIn) => {
+        notifyLogout();
+        return isLoggedIn;
+    });
 };
 
 let renderQueue: Promise<any> = Promise.resolve();
@@ -89,3 +163,10 @@ export const renderInQueue = (fn: (next?: (val?: any) => void) => void) => {
         fn(() => {}); // eslint-disable-line @typescript-eslint/no-empty-function
     }
 };
+
+// For testing purposes only
+export function reset(): void {
+    config = {} as any;
+    authEE = null;
+    authPromise = null;
+}

package/src/embed/embed.spec.ts

@@ -71,7 +71,7 @@ describe('Custom CSS Url', () => {
         document.body.innerHTML = getDocumentBody();
     });
 
-    test.only('passing customCssUrl should set the correct query params on the iframe', async (done) => {
+    test('passing customCssUrl should set the correct query params on the iframe', async (done) => {
         init({
             thoughtSpotHost,
             authType: AuthType.None,

package/src/embed/ts-embed.spec.ts

@@ -165,15 +165,16 @@ describe('Unit test case for ts embed', () => {
         });
     });
 
-    describe('when thoughtSpotHost have value and authPromise return success response', () => {
+    describe('when thoughtSpotHost have value and authPromise return response true/false', () => {
         beforeAll(() => {
             init({
                 thoughtSpotHost,
                 authType: AuthType.None,
+                loginFailedMessage: 'Failed to Login',
             });
         });
 
-        beforeEach(() => {
+        const setup = async (isLoggedIn = false) => {
             jest.spyOn(window, 'addEventListener').mockImplementationOnce(
                 (event, handler, options) => {
                     handler({
@@ -186,10 +187,9 @@ describe('Unit test case for ts embed', () => {
                 },
             );
             const iFrame: any = document.createElement('div');
-            jest.spyOn(
-                baseInstance,
-                'getAuthPromise',
-            ).mockResolvedValueOnce(() => Promise.resolve());
+            jest.spyOn(baseInstance, 'getAuthPromise').mockResolvedValueOnce(
+                isLoggedIn,
+            );
             const tsEmbed = new SearchEmbed(getRootEl(), {});
             iFrame.contentWindow = null;
             tsEmbed.on(EmbedEvent.CustomAction, jest.fn());
@@ -199,10 +199,11 @@ describe('Unit test case for ts embed', () => {
                 },
             );
             jest.spyOn(document, 'createElement').mockReturnValueOnce(iFrame);
-            tsEmbed.render();
-        });
+            await tsEmbed.render();
+        };
 
-        test('mixpanel should call with VISUAL_SDK_RENDER_COMPLETE', () => {
+        test('mixpanel should call with VISUAL_SDK_RENDER_COMPLETE', async () => {
+            await setup(true);
             expect(mockMixPanelEvent).toBeCalledWith(
                 MIXPANEL_EVENT.VISUAL_SDK_RENDER_START,
             );
@@ -212,11 +213,20 @@ describe('Unit test case for ts embed', () => {
         });
 
         test('Should remove prefetch iframe', async () => {
+            await setup(true);
             const prefetchIframe = document.querySelectorAll<HTMLIFrameElement>(
                 '.prefetchIframe',
             );
             expect(prefetchIframe.length).toBe(0);
         });
+
+        test('Should render failure when login fails', async (done) => {
+            setup(false);
+            executeAfterWait(() => {
+                expect(getRootEl().innerHTML).toContain('Failed to Login');
+                done();
+            });
+        });
     });
 
     describe('when thoughtSpotHost have value and authPromise return error', () => {

package/src/embed/ts-embed.ts

@@ -34,7 +34,7 @@ import {
     MessageCallbackObj,
 } from '../types';
 import { uploadMixpanelEvent, MIXPANEL_EVENT } from '../mixpanel-service';
-import { getProcessData } from '../utils/processData';
+import { processEventData } from '../utils/processData';
 import { processTrigger } from '../utils/processTrigger';
 import pkgInfo from '../../package.json';
 import { getAuthPromise, getEmbedConfig, renderInQueue } from './base';
@@ -212,14 +212,6 @@ export class TsEmbed {
         this.isError = false;
         this.viewConfig = viewConfig;
         this.shouldEncodeUrlQueryParams = this.embedConfig.shouldEncodeUrlQueryParams;
-        if (!this.embedConfig.suppressNoCookieAccessAlert) {
-            this.on(EmbedEvent.NoCookieAccess, () => {
-                // eslint-disable-next-line no-alert
-                alert(
-                    'Third party cookie access is blocked on this browser, please allow third party cookies for ThoughtSpot to work properly',
-                );
-            });
-        }
     }
 
     /**
@@ -304,7 +296,12 @@ export class TsEmbed {
             if (event.source === this.iFrame.contentWindow) {
                 this.executeCallbacks(
                     eventType,
-                    getProcessData(eventType, eventData, this.thoughtSpotHost),
+                    processEventData(
+                        eventType,
+                        eventData,
+                        this.thoughtSpotHost,
+                        this.el,
+                    ),
                     eventPort,
                 );
             }
@@ -464,7 +461,12 @@ export class TsEmbed {
             uploadMixpanelEvent(MIXPANEL_EVENT.VISUAL_SDK_RENDER_START);
 
             getAuthPromise()
-                ?.then(() => {
+                ?.then((isLoggedIn: boolean) => {
+                    if (!isLoggedIn) {
+                        this.el.innerHTML = this.embedConfig.loginFailedMessage;
+                        return;
+                    }
+
                     uploadMixpanelEvent(
                         MIXPANEL_EVENT.VISUAL_SDK_RENDER_COMPLETE,
                     );
@@ -492,7 +494,7 @@ export class TsEmbed {
                         frameWidth || DEFAULT_EMBED_WIDTH,
                     );
                     const height = getCssDimension(
-                        frameWidth || DEFAULT_EMBED_HEIGHT,
+                        frameHeight || DEFAULT_EMBED_HEIGHT,
                     );
                     setAttributes(this.iFrame, restParams);
 
@@ -536,6 +538,7 @@ export class TsEmbed {
                     uploadMixpanelEvent(
                         MIXPANEL_EVENT.VISUAL_SDK_RENDER_FAILED,
                     );
+                    this.el.innerHTML = this.embedConfig.loginFailedMessage;
                     this.handleError(error);
                 });
         });

package/src/index.ts

@@ -9,13 +9,14 @@
  */
 
 import { AppEmbed, Page, AppViewConfig } from './embed/app';
-import { init, prefetch } from './embed/base';
+import { init, prefetch, logout } from './embed/base';
 import {
     PinboardEmbed,
     LiveboardViewConfig,
     LiveboardEmbed,
 } from './embed/liveboard';
 import { SearchEmbed, SearchViewConfig } from './embed/search';
+import { AuthFailureType, AuthStatus } from './auth';
 import {
     AuthType,
     RuntimeFilter,
@@ -29,11 +30,14 @@ import {
 
 export {
     init,
+    logout,
     prefetch,
     SearchEmbed,
     PinboardEmbed,
     LiveboardEmbed,
     AppEmbed,
+    AuthFailureType,
+    AuthStatus,
     // types
     Page,
     AuthType,

package/src/test/test-utils.ts

@@ -14,7 +14,7 @@ type DOMElement = HTMLElement | Document;
 
 export const getRootEl = () => document.getElementById('embed');
 
-export const getRootEl2 = () => document.getElementById('emebed-2');
+export const getRootEl2 = () => document.getElementById('embed-2');
 
 export const getIFrameEl = (container: DOMElement = document) =>
     container.querySelector('iframe');

package/src/types.ts

@@ -97,6 +97,16 @@ export interface EmbedConfig {
      */
     noRedirect?: boolean;
 
+    /**
+     * [SSO] For SSO Authentication, one can supply an optional path param,
+     * this will be the path on the host origin where the SAML flow will be
+     * terminated.
+     *
+     * Eg: "/dashboard", "#/foo" [Do not include the host]
+     * @version SDK: 1.10.2 | ThoughtSpot: *
+     */
+    redirectPath?: string;
+
     /** @internal */
     basepath?: string;
 
@@ -131,6 +141,12 @@ export interface EmbedConfig {
      */
     disableLoginRedirect?: boolean;
 
+    /**
+     * This message is displayed on the embed view when the login fails.
+     * @version 1.10.1 | ThoughtSpot: *
+     */
+    loginFailedMessage?: string;
+
     /**
      * Calls the prefetch method internally when set to true
      * @default false
@@ -365,6 +381,16 @@ export enum EmbedEvent {
      * The ThoughtSpot auth session has expired.
      */
     AuthExpire = 'ThoughtspotAuthExpired',
+    /**
+     * ThoughtSpot failed to validate the auth session.
+     * @hidden
+     */
+    AuthFailure = 'ThoughtspotAuthFailure',
+    /**
+     * ThoughtSpot failed to validate the auth session.
+     * @hidden
+     */
+    AuthLogout = 'ThoughtspotAuthLogout',
     /**
      * The height of the embedded Liveboard or visualization has been computed.
      * @return data - The height of the embedded Liveboard or visualization

package/src/utils/authService.spec.ts

@@ -4,6 +4,7 @@ import {
     fetchAuthService,
     fetchBasicAuthService,
 } from './authService';
+import { EndPoints } from '../auth';
 
 const thoughtSpotHost = 'http://10.79.135.124:3000';
 
@@ -21,6 +22,7 @@ describe('Unit test for authService', () => {
             Promise.resolve({
                 json: () => ({ success: true }),
                 status: 200,
+                ok: true,
             }),
         );
         const response = await fetchSessionInfoService(authVerificationUrl);
@@ -32,6 +34,7 @@ describe('Unit test for authService', () => {
         global.fetch = jest.fn(() =>
             Promise.resolve({
                 text: () => ({ success: true }),
+                ok: true,
             }),
         );
         const response = await fetchAuthTokenService(authEndpoint);
@@ -40,14 +43,37 @@ describe('Unit test for authService', () => {
     });
 
     test('fetchAuthService', async () => {
-        global.fetch = jest.fn(() => Promise.resolve({ success: true }));
-        await fetchAuthService(authVerificationUrl, username, authToken);
-        expect(fetch).toBeCalled();
+        global.fetch = jest.fn(() =>
+            Promise.resolve({ success: true, ok: true }),
+        );
+        await fetchAuthService(thoughtSpotHost, username, authToken);
+        expect(fetch).toBeCalledWith(
+            `${thoughtSpotHost}${EndPoints.TOKEN_LOGIN}?username=${username}&auth_token=${authToken}`,
+            {
+                credentials: 'include',
+                redirect: 'manual',
+            },
+        );
     });
 
-    test('fetchBasicAuthService', async () => {
-        global.fetch = jest.fn(() => Promise.resolve({ success: true }));
+    test('fetchBasicAuthService called with manual redirect', async () => {
+        global.fetch = jest.fn(() =>
+            Promise.resolve({ success: true, ok: true }),
+        );
         await fetchBasicAuthService(thoughtSpotHost, username, password);
         expect(fetch).toBeCalled();
     });
+
+    test('log error on API failures', async () => {
+        jest.spyOn(global.console, 'error').mockImplementation(() => undefined);
+        global.fetch = jest.fn(() =>
+            Promise.resolve({
+                text: () => Promise.resolve('error'),
+                status: 500,
+                ok: false,
+            }),
+        );
+        await fetchSessionInfoService(authVerificationUrl);
+        expect(global.console.error).toHaveBeenCalledWith('Failure', 'error');
+    });
 });

package/src/utils/authService.ts

@@ -1,10 +1,22 @@
 // eslint-disable-next-line import/no-cycle
 import { EndPoints } from '../auth';
 
+function failureLoggedFetch(
+    url: string,
+    options: RequestInit = {},
+): Promise<Response> {
+    return fetch(url, options).then(async (r) => {
+        if (!r.ok && r.type !== 'opaqueredirect' && r.type !== 'opaque') {
+            console.error('Failure', await r.text?.());
+        }
+        return r;
+    });
+}
+
 export function fetchSessionInfoService(
     authVerificationUrl: string,
 ): Promise<any> {
-    return fetch(authVerificationUrl, {
+    return failureLoggedFetch(authVerificationUrl, {
         credentials: 'include',
     });
 }
@@ -20,10 +32,12 @@ export async function fetchAuthService(
     username: string,
     authToken: string,
 ): Promise<any> {
-    return fetch(
+    return failureLoggedFetch(
         `${thoughtSpotHost}${EndPoints.TOKEN_LOGIN}?username=${username}&auth_token=${authToken}`,
         {
             credentials: 'include',
+            // We do not want to follow the redirect, as it starts giving a CORS error
+            redirect: 'manual',
         },
     );
 }
@@ -33,7 +47,7 @@ export async function fetchBasicAuthService(
     username: string,
     password: string,
 ): Promise<any> {
-    return fetch(`${thoughtSpotHost}${EndPoints.BASIC_LOGIN}`, {
+    return failureLoggedFetch(`${thoughtSpotHost}${EndPoints.BASIC_LOGIN}`, {
         method: 'POST',
         headers: {
             'content-type': 'application/x-www-form-urlencoded',
@@ -45,3 +59,15 @@ export async function fetchBasicAuthService(
         credentials: 'include',
     });
 }
+
+export async function fetchLogoutService(
+    thoughtSpotHost: string,
+): Promise<any> {
+    return failureLoggedFetch(`${thoughtSpotHost}${EndPoints.LOGOUT}`, {
+        credentials: 'include',
+        method: 'POST',
+        headers: {
+            'x-requested-by': 'ThoughtSpot',
+        },
+    });
+}