@thoughtspot/visual-embed-sdk 1.10.0-alpha.4 → 1.11.0-auth.0

package/src/auth.spec.ts

@@ -120,7 +120,11 @@ describe('Unit test for auth', () => {
             authService,
             'fetchAuthTokenService',
         ).mockImplementation(() => ({ text: () => Promise.resolve('abc') }));
-        jest.spyOn(authService, 'fetchAuthService');
+        jest.spyOn(authService, 'fetchAuthService').mockImplementation(() =>
+            Promise.resolve({
+                status: 200,
+            }),
+        );
         await authInstance.doTokenAuth(embedConfig.doTokenAuthSuccess);
         expect(authService.fetchSessionInfoService).toBeCalled();
         expect(authService.fetchAuthService).toBeCalledWith(
@@ -140,7 +144,11 @@ describe('Unit test for auth', () => {
         ).mockImplementation(() =>
             Promise.resolve({ text: () => Promise.resolve('abc') }),
         );
-        jest.spyOn(authService, 'fetchAuthService');
+        jest.spyOn(authService, 'fetchAuthService').mockImplementation(() =>
+            Promise.resolve({
+                status: 200,
+            }),
+        );
         await authInstance.doTokenAuth(
             embedConfig.doTokenAuthFailureWithoutGetAuthToken,
         );
@@ -263,7 +271,7 @@ describe('Unit test for auth', () => {
                     ...embedConfig.doSamlAuth,
                     noRedirect: true,
                 }),
-            ).toBe(undefined);
+            ).toBe(false);
             expect(authService.fetchSessionInfoService).toBeCalled();
         });
     });

package/src/auth.ts

@@ -83,7 +83,9 @@ function removeSSORedirectUrlMarker(): void {
  * Perform token based authentication
  * @param embedConfig The embed configuration
  */
-export const doTokenAuth = async (embedConfig: EmbedConfig): Promise<void> => {
+export const doTokenAuth = async (
+    embedConfig: EmbedConfig,
+): Promise<boolean> => {
     const {
         thoughtSpotHost,
         username,
@@ -104,11 +106,16 @@ export const doTokenAuth = async (embedConfig: EmbedConfig): Promise<void> => {
             const response = await fetchAuthTokenService(authEndpoint);
             authToken = await response.text();
         }
-        await fetchAuthService(thoughtSpotHost, username, authToken);
-        loggedInStatus = false;
+        const resp = await fetchAuthService(
+            thoughtSpotHost,
+            username,
+            authToken,
+        );
+        loggedInStatus = resp.status === 200;
+    } else {
+        loggedInStatus = true;
     }
-
-    loggedInStatus = true;
+    return loggedInStatus;
 };
 
 /**
@@ -119,7 +126,9 @@ export const doTokenAuth = async (embedConfig: EmbedConfig): Promise<void> => {
  * strongly advised not to use this authentication method in production.
  * @param embedConfig The embed configuration
  */
-export const doBasicAuth = async (embedConfig: EmbedConfig): Promise<void> => {
+export const doBasicAuth = async (
+    embedConfig: EmbedConfig,
+): Promise<boolean> => {
     const { thoughtSpotHost, username, password } = embedConfig;
     const loggedIn = await isLoggedIn(thoughtSpotHost);
     if (!loggedIn) {
@@ -129,9 +138,10 @@ export const doBasicAuth = async (embedConfig: EmbedConfig): Promise<void> => {
             password,
         );
         loggedInStatus = response.status === 200;
+    } else {
+        loggedInStatus = true;
     }
-
-    loggedInStatus = true;
+    return loggedInStatus;
 };
 
 async function samlPopupFlow(ssoURL: string) {
@@ -218,6 +228,7 @@ export const doSamlAuth = async (embedConfig: EmbedConfig) => {
     )}`;
 
     await doSSOAuth(embedConfig, ssoEndPoint);
+    return loggedInStatus;
 };
 
 export const doOIDCAuth = async (embedConfig: EmbedConfig) => {
@@ -234,13 +245,16 @@ export const doOIDCAuth = async (embedConfig: EmbedConfig) => {
     )}`;
 
     await doSSOAuth(embedConfig, ssoEndPoint);
+    return loggedInStatus;
 };
 
 /**
  * Perform authentication on the ThoughtSpot cluster
  * @param embedConfig The embed configuration
  */
-export const authenticate = async (embedConfig: EmbedConfig): Promise<void> => {
+export const authenticate = async (
+    embedConfig: EmbedConfig,
+): Promise<boolean> => {
     const { authType } = embedConfig;
     switch (authType) {
         case AuthType.SSO:
@@ -252,7 +266,7 @@ export const authenticate = async (embedConfig: EmbedConfig): Promise<void> => {
         case AuthType.Basic:
             return doBasicAuth(embedConfig);
         default:
-            return Promise.resolve();
+            return Promise.resolve(true);
     }
 };
 

package/src/embed/base.ts

@@ -14,12 +14,12 @@ import { uploadMixpanelEvent, MIXPANEL_EVENT } from '../mixpanel-service';
 
 let config = {} as EmbedConfig;
 
-export let authPromise: Promise<void>;
+export let authPromise: Promise<boolean>;
 
 /**
  * Perform authentication on the ThoughtSpot app as applicable.
  */
-export const handleAuth = (): Promise<void> => {
+export const handleAuth = (): Promise<boolean> => {
     const authConfig = {
         ...config,
         thoughtSpotHost: getThoughtSpotHost(config),
@@ -30,7 +30,7 @@ export const handleAuth = (): Promise<void> => {
 
 export const getEmbedConfig = (): EmbedConfig => config;
 
-export const getAuthPromise = (): Promise<void> => authPromise;
+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.
@@ -59,7 +59,7 @@ export const prefetch = (url?: string): void => {
  *
  * @returns authPromise Promise which resolves when authentication is complete.
  */
-export const init = (embedConfig: EmbedConfig): Promise<void> => {
+export const init = (embedConfig: EmbedConfig): Promise<boolean> => {
     config = embedConfig;
     handleAuth();
 

package/src/embed/events.spec.ts

@@ -5,6 +5,7 @@ import {
     SearchEmbed,
     PinboardEmbed,
     LiveboardEmbed,
+    AppEmbed,
     HostEvent,
 } from '../index';
 import {
@@ -247,4 +248,35 @@ describe('test communication between host app and ThoughtSpot', () => {
         };
         expect(mockPort.postMessage).toHaveBeenCalledWith(heightObj);
     });
+    test('ALL event listener should fire for all events with the event type set correctly', async () => {
+        const embed = new AppEmbed(getRootEl(), defaultViewConfig);
+        const spy = jest.fn();
+        embed.on(EmbedEvent.ALL, spy);
+        embed.render();
+
+        await executeAfterWait(() => {
+            const iframe = getIFrameEl();
+            postMessageToParent(iframe.contentWindow, {
+                type: EmbedEvent.CustomAction,
+                data: PAYLOAD,
+            });
+            postMessageToParent(iframe.contentWindow, {
+                type: EmbedEvent.DialogOpen,
+            });
+        });
+
+        await executeAfterWait(() => {
+            expect(spy).toHaveBeenCalledTimes(3);
+            expect(spy.mock.calls[0][0]).toMatchObject({
+                type: EmbedEvent.Init,
+            });
+            expect(spy.mock.calls[1][0]).toMatchObject({
+                type: EmbedEvent.CustomAction,
+                data: PAYLOAD,
+            });
+            expect(spy.mock.calls[2][0]).toMatchObject({
+                type: EmbedEvent.DialogOpen,
+            });
+        }, EVENT_WAIT_TIME);
+    });
 });

package/src/embed/ts-embed.ts

@@ -279,9 +279,10 @@ export class TsEmbed {
      * will be removed for ts7.oct.cl
      * @hidden
      */
-    private formatEventData(event: MessageEvent) {
+    private formatEventData(event: MessageEvent, eventType: string) {
         const eventData = {
             ...event.data,
+            type: eventType,
         };
         if (!eventData.data) {
             eventData.data = event.data.payload;
@@ -299,7 +300,7 @@ export class TsEmbed {
         window.addEventListener('message', (event) => {
             const eventType = this.getEventType(event);
             const eventPort = this.getEventPort(event);
-            const eventData = this.formatEventData(event);
+            const eventData = this.formatEventData(event, eventType);
             if (event.source === this.iFrame.contentWindow) {
                 this.executeCallbacks(
                     eventType,
@@ -457,12 +458,18 @@ export class TsEmbed {
                 data: {
                     timestamp: initTimestamp,
                 },
+                type: EmbedEvent.Init,
             });
 
             uploadMixpanelEvent(MIXPANEL_EVENT.VISUAL_SDK_RENDER_START);
 
             getAuthPromise()
-                ?.then(() => {
+                ?.then((isLoggedIn: boolean) => {
+                    if (!isLoggedIn) {
+                        this.el.innerHTML = 'Login failed';
+                        return;
+                    }
+
                     uploadMixpanelEvent(
                         MIXPANEL_EVENT.VISUAL_SDK_RENDER_COMPLETE,
                     );
@@ -505,6 +512,7 @@ export class TsEmbed {
                             data: {
                                 timestamp: loadTimestamp,
                             },
+                            type: EmbedEvent.Load,
                         });
                         uploadMixpanelEvent(
                             MIXPANEL_EVENT.VISUAL_SDK_IFRAME_LOAD_PERFORMANCE,
@@ -558,6 +566,8 @@ export class TsEmbed {
         eventPort?: MessagePort | void,
     ): void {
         const callbacks = this.eventHandlerMap.get(eventType) || [];
+        const allHandlers = this.eventHandlerMap.get(EmbedEvent.ALL) || [];
+        callbacks.push(...allHandlers);
         const dataStatus = data?.status || embedEventStatus.END;
         callbacks.forEach((callbackObj) => {
             if (
@@ -760,9 +770,10 @@ export class V1Embed extends TsEmbed {
     public on(
         messageType: EmbedEvent,
         callback: MessageCallback,
+        options: MessageOptions = { start: false },
     ): typeof TsEmbed.prototype {
         const eventType = this.getCompatibleEventType(messageType);
 
-        return super.on(eventType, callback);
+        return super.on(eventType, callback, options);
     }
 }

package/src/types.ts

@@ -416,6 +416,12 @@ export enum EmbedEvent {
      * @version 1.9.1 or later
      */
     LiveboardRendered = 'PinboardRendered',
+    /**
+     * This can be used to register an event listener which
+     * is triggered on all events.
+     * @version SDK: 1.10.0 | ThoughtSpot: any
+     */
+    ALL = '*',
     /**
      * Emitted when answer is saved in the app
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl

package/src/utils/authService.spec.ts

@@ -21,6 +21,7 @@ describe('Unit test for authService', () => {
             Promise.resolve({
                 json: () => ({ success: true }),
                 status: 200,
+                ok: true,
             }),
         );
         const response = await fetchSessionInfoService(authVerificationUrl);
@@ -32,6 +33,7 @@ describe('Unit test for authService', () => {
         global.fetch = jest.fn(() =>
             Promise.resolve({
                 text: () => ({ success: true }),
+                ok: true,
             }),
         );
         const response = await fetchAuthTokenService(authEndpoint);
@@ -40,13 +42,17 @@ describe('Unit test for authService', () => {
     });
 
     test('fetchAuthService', async () => {
-        global.fetch = jest.fn(() => Promise.resolve({ success: true }));
+        global.fetch = jest.fn(() =>
+            Promise.resolve({ success: true, ok: true }),
+        );
         await fetchAuthService(authVerificationUrl, username, authToken);
         expect(fetch).toBeCalled();
     });
 
     test('fetchBasicAuthService', async () => {
-        global.fetch = jest.fn(() => Promise.resolve({ success: true }));
+        global.fetch = jest.fn(() =>
+            Promise.resolve({ success: true, ok: true }),
+        );
         await fetchBasicAuthService(thoughtSpotHost, username, password);
         expect(fetch).toBeCalled();
     });

package/src/utils/authService.ts

@@ -1,10 +1,22 @@
 // eslint-disable-next-line import/no-cycle
 import { EndPoints } from '../auth';
 
+function errorLoggedFetch(
+    url: string,
+    options: RequestInit,
+): Promise<Response> {
+    return fetch(url, options).then(async (r) => {
+        if (!r.ok) {
+            console.error('Failure', await r.json());
+        }
+        return r;
+    });
+}
+
 export function fetchSessionInfoService(
     authVerificationUrl: string,
 ): Promise<any> {
-    return fetch(authVerificationUrl, {
+    return errorLoggedFetch(authVerificationUrl, {
         credentials: 'include',
     });
 }
@@ -20,7 +32,7 @@ export async function fetchAuthService(
     username: string,
     authToken: string,
 ): Promise<any> {
-    return fetch(
+    return errorLoggedFetch(
         `${thoughtSpotHost}${EndPoints.TOKEN_LOGIN}?username=${username}&auth_token=${authToken}`,
         {
             credentials: 'include',
@@ -33,7 +45,7 @@ export async function fetchBasicAuthService(
     username: string,
     password: string,
 ): Promise<any> {
-    return fetch(`${thoughtSpotHost}${EndPoints.BASIC_LOGIN}`, {
+    return errorLoggedFetch(`${thoughtSpotHost}${EndPoints.BASIC_LOGIN}`, {
         method: 'POST',
         headers: {
             'content-type': 'application/x-www-form-urlencoded',

package/lib/src/utils/fetchAnswers.d.ts

@@ -1,3 +0,0 @@
-import { SessionInterface } from '../types';
-declare function FetchAnswers(session: SessionInterface, query: string, operation: string, thoughtSpotHost: string): any;
-export default FetchAnswers;

package/lib/src/utils/fetchAnswers.js

@@ -1,49 +0,0 @@
-import { OperationType } from '../types';
-function FetchAnswers(session, query, operation, thoughtSpotHost) {
-    let variable;
-    const fetchQuery = async (variables) => {
-        try {
-            const response = await fetch(`${thoughtSpotHost}/prism/?op=${operation}`, {
-                method: 'POST',
-                headers: {
-                    'content-type': 'application/json;charset=UTF-8',
-                    'x-requested-by': 'ThoughtSpot',
-                    accept: '*/*',
-                    'accept-language': 'en-us',
-                },
-                body: JSON.stringify({
-                    operationName: operation,
-                    query,
-                    variables,
-                }),
-                credentials: 'include'
-            });
-            const result = await response.json();
-            return result.data;
-        }
-        catch (error) {
-            return error;
-        }
-    };
-    const getAnswer = (offset, batchSize) => {
-        if (operation === OperationType.GetChartWithData) {
-            variable = { batchSize, offset };
-        }
-        else {
-            variable = {
-                dataPaginationParams: {
-                    isClientPaginated: true,
-                    offset,
-                    size: batchSize,
-                },
-            };
-        }
-        return fetchQuery({
-            session,
-            ...variable,
-        });
-    };
-    return getAnswer;
-}
-export default FetchAnswers;
-//# sourceMappingURL=fetchAnswers.js.map

package/lib/src/utils/fetchAnswers.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"fetchAnswers.js","sourceRoot":"","sources":["../../../src/utils/fetchAnswers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,aAAa,EAAE,MAAM,UAAU,CAAC;AAE3D,SAAS,YAAY,CACjB,OAAyB,EACzB,KAAa,EACb,SAAiB,EACjB,eAAuB;IAEvB,IAAI,QAAa,CAAC;IAElB,MAAM,UAAU,GAAG,KAAK,EAAE,SAAc,EAAE,EAAE;QACxC,IAAI;YACA,MAAM,QAAQ,GAAG,MAAM,KAAK,CACxB,GAAG,eAAe,cAAc,SAAS,EAAE,EAC3C;gBACI,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACL,cAAc,EAAE,gCAAgC;oBAChD,gBAAgB,EAAE,aAAa;oBAC/B,MAAM,EAAE,KAAK;oBACb,iBAAiB,EAAE,OAAO;iBAC7B;gBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;oBACjB,aAAa,EAAE,SAAS;oBACxB,KAAK;oBACL,SAAS;iBACZ,CAAC;gBACF,WAAW,EAAE,SAAS;aACzB,CACA,CAAC;YACF,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACrC,OAAO,MAAM,CAAC,IAAI,CAAC;SACtB;QAAC,OAAO,KAAK,EAAE;YACZ,OAAO,KAAK,CAAC;SAChB;IACL,CAAC,CAAC;IAEF,MAAM,SAAS,GAAG,CAAC,MAAc,EAAE,SAAiB,EAAE,EAAE;QACpD,IAAI,SAAS,KAAK,aAAa,CAAC,gBAAgB,EAAE;YAC9C,QAAQ,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC;SACpC;aAAM;YACH,QAAQ,GAAG;gBACP,oBAAoB,EAAE;oBAClB,iBAAiB,EAAE,IAAI;oBACvB,MAAM;oBACN,IAAI,EAAE,SAAS;iBAClB;aACJ,CAAC;SACL;QACD,OAAO,UAAU,CAAC;YACd,OAAO;YACP,GAAG,QAAQ;SACd,CAAC,CAAC;IACP,CAAC,CAAC;IAEF,OAAO,SAAS,CAAC;AACrB,CAAC;AAED,eAAe,YAAY,CAAC"}