@thoughtspot/visual-embed-sdk 1.11.0-auth.9 → 1.11.2

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 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<boolean> => {
-    const authConfig = {
-        ...config,
-        thoughtSpotHost: getThoughtSpotHost(config),
-    };
-    authPromise = authenticate(authConfig);
+    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<boolean> => 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<boolean> => {
-    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<boolean> => {
     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/liveboard.spec.ts

@@ -18,7 +18,8 @@ const defaultViewConfig = {
 const liveboardId = 'eca215d4-0d2c-4a55-90e3-d81ef6848ae0';
 const vizId = '6e73f724-660e-11eb-ae93-0242ac130002';
 const thoughtSpotHost = 'tshost';
-const defaultParams = `&hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}`;
+const defaultParamsSansHideAction = `&hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}`;
+const defaultParams = `${defaultParamsSansHideAction}&hideAction=[%22${Action.ReportError}%22]`;
 const prefixParams = '&isLiveboardEmbed=true&isPinboardV2Enabled=false';
 
 beforeAll(() => {
@@ -60,7 +61,7 @@ describe('Liveboard/viz embed tests', () => {
         liveboardEmbed.render();
         await executeAfterWait(() => {
             expect(getIFrameSrc()).toBe(
-                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&disableAction=[%22${Action.DownloadAsCsv}%22,%22${Action.DownloadAsPdf}%22,%22${Action.DownloadAsXlsx}%22]&disableHint=Action%20denied${prefixParams}#/embed/viz/${liveboardId}`,
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParamsSansHideAction}&disableAction=[%22${Action.DownloadAsCsv}%22,%22${Action.DownloadAsPdf}%22,%22${Action.DownloadAsXlsx}%22]&disableHint=Action%20denied&hideAction=[%22${Action.ReportError}%22]${prefixParams}#/embed/viz/${liveboardId}`,
             );
         });
     });
@@ -78,7 +79,7 @@ describe('Liveboard/viz embed tests', () => {
         liveboardEmbed.render();
         await executeAfterWait(() => {
             expect(getIFrameSrc()).toBe(
-                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&hideAction=[%22${Action.DownloadAsCsv}%22,%22${Action.DownloadAsPdf}%22,%22${Action.DownloadAsXlsx}%22]${prefixParams}#/embed/viz/${liveboardId}`,
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParamsSansHideAction}&hideAction=[%22${Action.ReportError}%22,%22${Action.DownloadAsCsv}%22,%22${Action.DownloadAsPdf}%22,%22${Action.DownloadAsXlsx}%22]${prefixParams}#/embed/viz/${liveboardId}`,
             );
         });
     });

package/src/embed/pinboard.spec.ts

@@ -18,7 +18,8 @@ const defaultViewConfig = {
 const pinboardId = 'eca215d4-0d2c-4a55-90e3-d81ef6848ae0';
 const vizId = '6e73f724-660e-11eb-ae93-0242ac130002';
 const thoughtSpotHost = 'tshost';
-const defaultParams = `&hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}`;
+const defaultParamsWithoutHideActions = `&hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}`;
+const defaultParams = `${defaultParamsWithoutHideActions}&hideAction=[%22${Action.ReportError}%22]`;
 const prefixParams = '&isLiveboardEmbed=true&isPinboardV2Enabled=false';
 
 beforeAll(() => {
@@ -60,7 +61,7 @@ describe('Pinboard/viz embed tests', () => {
         pinboardEmbed.render();
         await executeAfterWait(() => {
             expect(getIFrameSrc()).toBe(
-                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&disableAction=[%22${Action.DownloadAsCsv}%22,%22${Action.DownloadAsPdf}%22,%22${Action.DownloadAsXlsx}%22]&disableHint=Action%20denied${prefixParams}#/embed/viz/${pinboardId}`,
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParamsWithoutHideActions}&disableAction=[%22${Action.DownloadAsCsv}%22,%22${Action.DownloadAsPdf}%22,%22${Action.DownloadAsXlsx}%22]&disableHint=Action%20denied&hideAction=[%22${Action.ReportError}%22]${prefixParams}#/embed/viz/${pinboardId}`,
             );
         });
     });
@@ -78,7 +79,7 @@ describe('Pinboard/viz embed tests', () => {
         pinboardEmbed.render();
         await executeAfterWait(() => {
             expect(getIFrameSrc()).toBe(
-                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&hideAction=[%22${Action.DownloadAsCsv}%22,%22${Action.DownloadAsPdf}%22,%22${Action.DownloadAsXlsx}%22]${prefixParams}#/embed/viz/${pinboardId}`,
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParamsWithoutHideActions}&hideAction=[%22${Action.ReportError}%22,%22${Action.DownloadAsCsv}%22,%22${Action.DownloadAsPdf}%22,%22${Action.DownloadAsXlsx}%22]${prefixParams}#/embed/viz/${pinboardId}`,
             );
         });
     });

package/src/embed/search.spec.ts

@@ -20,7 +20,10 @@ const answerId = 'eca215d4-0d2c-4a55-90e3-d81ef6848ae0';
 const thoughtSpotHost = 'tshost';
 const defaultParams = `hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}`;
 const hideBydefault = `&hideAction=${fixedEncodeURI(
-    JSON.stringify(HiddenActionItemByDefaultForSearchEmbed),
+    JSON.stringify([
+        Action.ReportError,
+        ...HiddenActionItemByDefaultForSearchEmbed,
+    ]),
 )}`;
 const defaultParamsWithHiddenActions = defaultParams + hideBydefault;
 const prefixParams = '&isSearchEmbed=true';
@@ -197,6 +200,7 @@ describe('Search embed tests', () => {
         searchEmbed.render();
         const hideActionUrl = fixedEncodeURI(
             JSON.stringify([
+                Action.ReportError,
                 ...hiddenActionsForSearch,
                 ...HiddenActionItemByDefaultForSearchEmbed,
             ]),
@@ -220,6 +224,7 @@ describe('Search embed tests', () => {
         searchEmbed.render();
         const hideActionUrl = fixedEncodeURI(
             JSON.stringify([
+                Action.ReportError,
                 ...hiddenActionsForSearch,
                 ...HiddenActionItemByDefaultForSearchEmbed,
             ]),

package/src/embed/search.ts

@@ -49,6 +49,10 @@ export interface SearchViewConfig extends ViewConfig {
      * using raw answer data.
      */
     hideResults?: boolean;
+    /**
+     * If set to true, expands all the data sources panel.
+     */
+    expandAllDataSource?: boolean;
     /**
      * If set to true, the Search Assist feature is enabled.
      */
@@ -126,6 +130,7 @@ export class SearchEmbed extends TsEmbed {
     private getIFrameSrc(answerId: string, dataSources?: string[]) {
         const {
             hideResults,
+            expandAllDataSource,
             enableSearchAssist,
             forceTable,
             searchOptions,

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

@@ -34,7 +34,7 @@ const defaultViewConfig = {
 const pinboardId = 'eca215d4-0d2c-4a55-90e3-d81ef6848ae0';
 const liveboardId = 'eca215d4-0d2c-4a55-90e3-d81ef6848ae0';
 const thoughtSpotHost = 'tshost';
-const defaultParamsForPinboardEmbed = `hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}`;
+const defaultParamsForPinboardEmbed = `hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}&hideAction=[%22${Action.ReportError}%22]`;
 const defaultParamsPost = '&isPinboardV2Enabled=false';
 
 describe('Unit test case for ts embed', () => {

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';
@@ -75,7 +75,7 @@ export interface FrameParams {
      * This parameters will be passed on the iframe
      * as is.
      */
-    [key: string]: string | number | boolean;
+    [key: string]: string | number | boolean | undefined;
 }
 
 /**
@@ -202,6 +202,8 @@ export class TsEmbed {
      */
     private shouldEncodeUrlQueryParams = false;
 
+    private defaultHiddenActions = [Action.ReportError];
+
     constructor(domSelector: DOMSelector, viewConfig?: ViewConfig) {
         this.el = this.getDOMNode(domSelector);
         // TODO: handle error
@@ -212,20 +214,6 @@ export class TsEmbed {
         this.isError = false;
         this.viewConfig = viewConfig;
         this.shouldEncodeUrlQueryParams = this.embedConfig.shouldEncodeUrlQueryParams;
-        this.on(EmbedEvent.NoCookieAccess, () => {
-            if (!this.embedConfig.suppressNoCookieAccessAlert) {
-                // eslint-disable-next-line no-alert
-                alert(
-                    'Third party cookie access is blocked on this browser, please allow third party cookies for this to work properly. \nYou can use `suppressNoCookieAccessAlert` to suppress this message.',
-                );
-            }
-            this.el.innerHTML = this.getLoginFiledMessage();
-        });
-    }
-
-    private getLoginFiledMessage(): string {
-        const { loginFailedMessage } = this.embedConfig;
-        return loginFailedMessage || 'Login failed';
     }
 
     /**
@@ -310,7 +298,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,
                 );
             }
@@ -391,9 +384,10 @@ export class TsEmbed {
         if (disabledActionReason) {
             queryParams[Param.DisableActionReason] = disabledActionReason;
         }
-        if (hiddenActions?.length) {
-            queryParams[Param.HideActions] = hiddenActions;
-        }
+        queryParams[Param.HideActions] = [
+            ...this.defaultHiddenActions,
+            ...(hiddenActions ?? []),
+        ];
         if (Array.isArray(visibleActions)) {
             queryParams[Param.VisibleActions] = visibleActions;
         }
@@ -472,7 +466,7 @@ export class TsEmbed {
             getAuthPromise()
                 ?.then((isLoggedIn: boolean) => {
                     if (!isLoggedIn) {
-                        this.el.innerHTML = this.getLoginFiledMessage();
+                        this.el.innerHTML = this.embedConfig.loginFailedMessage;
                         return;
                     }
 
@@ -503,7 +497,7 @@ export class TsEmbed {
                         frameWidth || DEFAULT_EMBED_WIDTH,
                     );
                     const height = getCssDimension(
-                        frameWidth || DEFAULT_EMBED_HEIGHT,
+                        frameHeight || DEFAULT_EMBED_HEIGHT,
                     );
                     setAttributes(this.iFrame, restParams);
 
@@ -547,7 +541,7 @@ export class TsEmbed {
                     uploadMixpanelEvent(
                         MIXPANEL_EVENT.VISUAL_SDK_RENDER_FAILED,
                     );
-                    this.el.innerHTML = this.getLoginFiledMessage();
+                    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/react/index.spec.tsx

@@ -2,6 +2,7 @@ import React from 'react';
 import '@testing-library/jest-dom';
 import '@testing-library/jest-dom/extend-expect';
 import { cleanup, fireEvent, render, waitFor } from '@testing-library/react';
+import { Action, EmbedEvent, HostEvent } from '../types';
 import {
     executeAfterWait,
     getIFrameEl,
@@ -10,7 +11,7 @@ import {
 } from '../test/test-utils';
 import { SearchEmbed, AppEmbed, LiveboardEmbed, useEmbedRef } from './index';
 import { AuthType, init } from '../index';
-import { EmbedEvent, HostEvent } from '../types';
+
 import { version } from '../../package.json';
 
 const thoughtSpotHost = 'localhost';
@@ -37,7 +38,7 @@ describe('React Components', () => {
                 ),
             ).toBe(true);
             expect(getIFrameSrc(container)).toBe(
-                `http://${thoughtSpotHost}/?hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}&hideAction=[%22editACopy%22,%22saveAsView%22,%22updateTSL%22,%22editTSL%22,%22onDeleteAnswer%22]&dataSourceMode=hide&useLastSelectedSources=false&isSearchEmbed=true#/embed/answer`,
+                `http://${thoughtSpotHost}/?hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}&hideAction=[%22${Action.ReportError}%22,%22editACopy%22,%22saveAsView%22,%22updateTSL%22,%22editTSL%22,%22onDeleteAnswer%22]&dataSourceMode=hide&useLastSelectedSources=false&isSearchEmbed=true#/embed/answer`,
             );
         });
 

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;
 
@@ -159,6 +169,14 @@ export interface EmbedConfig {
      * @default ''
      */
     customCssUrl?: string;
+    /**
+     * [AuthServer|Basic] Detect if 3rd party cookies are enabled by doing an additional call. This is slower
+     * and should be avoided. Listen to the NO_COOKIE_ACCESS event to handle the situation.
+     *
+     * This is slightly slower than letting the browser handle the cookie check, as it involves an extra network call.
+     * @version SDK: 1.10.4 | ThoughtSpot: *
+     */
+    detectCookieAccessSlow?: boolean;
 }
 
 /**
@@ -371,6 +389,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
@@ -780,6 +808,10 @@ export enum Action {
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
      */
     CreateMonitor = 'createMonitor',
+    /**
+     * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl
+     */
+    ReportError = 'reportError',
 }
 
 export interface SessionInterface {

package/src/utils/authService.spec.ts

@@ -63,4 +63,17 @@ describe('Unit test for authService', () => {
         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

@@ -6,8 +6,8 @@ function failureLoggedFetch(
     options: RequestInit = {},
 ): Promise<Response> {
     return fetch(url, options).then(async (r) => {
-        if (!r.ok && r.type !== 'opaqueredirect') {
-            console.error('Failure', await r.text());
+        if (!r.ok && r.type !== 'opaqueredirect' && r.type !== 'opaque') {
+            console.error('Failure', await r.text?.());
         }
         return r;
     });
@@ -59,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',
+        },
+    });
+}