@thoughtspot/visual-embed-sdk 1.10.0 → 1.10.3

package/src/utils/processData.spec.ts

@@ -1,9 +1,20 @@
 import * as processDataInstance from './processData';
 import * as answerServiceInstance from './answerService';
 import * as auth from '../auth';
-import { EmbedEvent, OperationType } from '../types';
+import * as base from '../embed/base';
+import { EmbedEvent, OperationType, AuthType } from '../types';
 
 describe('Unit test for process data', () => {
+    beforeAll(() => {
+        base.init({
+            thoughtSpotHost: '',
+            authType: AuthType.None,
+        });
+    });
+    afterEach(() => {
+        jest.resetAllMocks();
+    });
+
     const thoughtSpotHost = 'http://localhost';
     test('processDataInstance, when operation is GetChartWithData', () => {
         const answerService = {};
@@ -34,10 +45,11 @@ describe('Unit test for process data', () => {
             'processCustomAction',
         ).mockImplementation(async () => ({}));
         expect(
-            processDataInstance.getProcessData(
+            processDataInstance.processEventData(
                 EmbedEvent.CustomAction,
                 processedData,
                 thoughtSpotHost,
+                null,
             ),
         ).toStrictEqual(processedData);
     });
@@ -52,10 +64,11 @@ describe('Unit test for process data', () => {
             answerServiceInstance,
             'getAnswerServiceInstance',
         ).mockImplementation(async () => ({}));
-        processDataInstance.getProcessData(
+        processDataInstance.processEventData(
             EmbedEvent.Data,
             processedData,
             thoughtSpotHost,
+            null,
         );
         expect(processDataInstance.processCustomAction).not.toBeCalled();
     });
@@ -68,12 +81,134 @@ describe('Unit test for process data', () => {
         };
         const e = { type: EmbedEvent.AuthInit, data: sessionInfo };
         jest.spyOn(auth, 'initSession').mockReturnValue(null);
-        expect(processDataInstance.getProcessData(e.type, e, '')).toEqual({
+        jest.spyOn(base, 'notifyAuthSuccess');
+        expect(
+            processDataInstance.processEventData(e.type, e, '', null),
+        ).toEqual({
             type: e.type,
             data: {
                 userGUID: sessionInfo.userGUID,
             },
         });
         expect(auth.initSession).toBeCalledWith(sessionInfo);
+        expect(base.notifyAuthSuccess).toBeCalled();
+    });
+
+    test('AuthExpire autoLogin false', () => {
+        const e = { type: EmbedEvent.AuthExpire };
+        jest.spyOn(base, 'notifyAuthFailure');
+        jest.spyOn(base, 'handleAuth');
+        jest.spyOn(base, 'getEmbedConfig').mockReturnValue({
+            autoLogin: false,
+        });
+        expect(
+            processDataInstance.processEventData(e.type, e, '', null),
+        ).toEqual({
+            type: e.type,
+        });
+        expect(base.notifyAuthFailure).toBeCalledWith(
+            auth.AuthFailureType.EXPIRY,
+        );
+        expect(base.handleAuth).not.toHaveBeenCalled();
+    });
+
+    test('AuthExpire autoLogin true', () => {
+        const e = { type: EmbedEvent.AuthExpire };
+        jest.spyOn(base, 'notifyAuthFailure');
+        jest.spyOn(base, 'handleAuth').mockResolvedValue(true);
+        jest.spyOn(base, 'getEmbedConfig').mockReturnValue({
+            autoLogin: true,
+        });
+        expect(
+            processDataInstance.processEventData(e.type, e, '', null),
+        ).toEqual({
+            type: e.type,
+        });
+        expect(base.notifyAuthFailure).toBeCalledWith(
+            auth.AuthFailureType.EXPIRY,
+        );
+        expect(base.handleAuth).toBeCalled();
+    });
+
+    test('NoCookieAccess no suppress alert', () => {
+        const e = { type: EmbedEvent.NoCookieAccess };
+        jest.spyOn(base, 'notifyAuthFailure');
+        jest.spyOn(base, 'getEmbedConfig').mockReturnValue({
+            loginFailedMessage: 'Hello',
+            suppressNoCookieAccessAlert: false,
+        });
+        jest.spyOn(window, 'alert').mockImplementation(() => undefined);
+        const el: any = {};
+        expect(processDataInstance.processEventData(e.type, e, '', el)).toEqual(
+            {
+                type: e.type,
+            },
+        );
+        expect(base.notifyAuthFailure).toBeCalledWith(
+            auth.AuthFailureType.NO_COOKIE_ACCESS,
+        );
+        expect(window.alert).toBeCalled();
+        expect(el.innerHTML).toBe('Hello');
+    });
+
+    test('NoCookieAccess suppressAlert=true', () => {
+        const e = { type: EmbedEvent.NoCookieAccess };
+        jest.spyOn(base, 'notifyAuthFailure');
+        jest.spyOn(base, 'getEmbedConfig').mockReturnValue({
+            loginFailedMessage: 'Hello',
+            suppressNoCookieAccessAlert: true,
+        });
+        jest.spyOn(window, 'alert').mockReset();
+        jest.spyOn(window, 'alert').mockImplementation(() => undefined);
+        const el: any = {};
+        expect(processDataInstance.processEventData(e.type, e, '', el)).toEqual(
+            {
+                type: e.type,
+            },
+        );
+        expect(base.notifyAuthFailure).toBeCalledWith(
+            auth.AuthFailureType.NO_COOKIE_ACCESS,
+        );
+        expect(window.alert).not.toBeCalled();
+        expect(el.innerHTML).toBe('Hello');
+    });
+
+    test('process authFailure', () => {
+        const e = { type: EmbedEvent.AuthFailure };
+        jest.spyOn(base, 'notifyAuthFailure');
+        jest.spyOn(base, 'getEmbedConfig').mockReturnValue({
+            loginFailedMessage: 'Hello',
+        });
+        const el: any = {};
+        expect(processDataInstance.processEventData(e.type, e, '', el)).toEqual(
+            {
+                type: e.type,
+            },
+        );
+        expect(base.notifyAuthFailure).toBeCalledWith(
+            auth.AuthFailureType.OTHER,
+        );
+        expect(el.innerHTML).toBe('Hello');
+    });
+
+    test('process authLogout', () => {
+        base.init({
+            loginFailedMessage: 'Hello',
+            autoLogin: true,
+            thoughtSpotHost: '',
+            authType: AuthType.None,
+        });
+        jest.spyOn(base, 'getEmbedConfig').mockRestore();
+        const e = { type: EmbedEvent.AuthLogout };
+        jest.spyOn(base, 'notifyLogout');
+        const el: any = {};
+        expect(processDataInstance.processEventData(e.type, e, '', el)).toEqual(
+            {
+                type: e.type,
+            },
+        );
+        expect(base.notifyLogout).toBeCalled();
+        expect(el.innerHTML).toBe('Hello');
+        expect(base.getEmbedConfig().autoLogin).toBe(false);
     });
 });

package/src/utils/processData.ts

@@ -1,5 +1,12 @@
-import { getEmbedConfig, handleAuth } from '../embed/base';
-import { initSession } from '../auth';
+import {
+    disableAutoLogin,
+    getEmbedConfig,
+    handleAuth,
+    notifyAuthFailure,
+    notifyAuthSuccess,
+    notifyLogout,
+} from '../embed/base';
+import { AuthFailureType, initSession } from '../auth';
 import { EmbedEvent, OperationType } from '../types';
 import { getAnswerServiceInstance } from './answerService';
 
@@ -28,6 +35,7 @@ export function processCustomAction(e: any, thoughtSpotHost: string) {
 function processAuthInit(e: any) {
     // Store user session details sent by app.
     initSession(e.data);
+    notifyAuthSuccess();
 
     // Expose only allowed details (eg: userGUID) back to SDK users.
     return {
@@ -43,14 +51,50 @@ function processAuthExpire(e: any) {
     if (autoLogin) {
         handleAuth();
     }
+    notifyAuthFailure(AuthFailureType.EXPIRY);
     return e;
 }
 
-export function getProcessData(
+function processNoCookieAccess(e: any, containerEl: Element) {
+    const {
+        loginFailedMessage,
+        suppressNoCookieAccessAlert,
+    } = getEmbedConfig();
+    if (!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.',
+        );
+    }
+    // eslint-disable-next-line no-param-reassign
+    containerEl.innerHTML = loginFailedMessage;
+    notifyAuthFailure(AuthFailureType.NO_COOKIE_ACCESS);
+    return e;
+}
+
+function processAuthFailure(e: any, containerEl: Element) {
+    const { loginFailedMessage } = getEmbedConfig();
+    // eslint-disable-next-line no-param-reassign
+    containerEl.innerHTML = loginFailedMessage;
+    notifyAuthFailure(AuthFailureType.OTHER);
+    return e;
+}
+
+function processAuthLogout(e: any, containerEl: Element) {
+    const { loginFailedMessage } = getEmbedConfig();
+    // eslint-disable-next-line no-param-reassign
+    containerEl.innerHTML = loginFailedMessage;
+    disableAutoLogin();
+    notifyLogout();
+    return e;
+}
+
+export function processEventData(
     type: EmbedEvent,
     e: any,
     thoughtSpotHost: string,
-) {
+    containerEl: Element,
+): any {
     switch (type) {
         case EmbedEvent.CustomAction:
             return processCustomAction(e, thoughtSpotHost);
@@ -58,6 +102,12 @@ export function getProcessData(
             return processAuthInit(e);
         case EmbedEvent.AuthExpire:
             return processAuthExpire(e);
+        case EmbedEvent.NoCookieAccess:
+            return processNoCookieAccess(e, containerEl);
+        case EmbedEvent.AuthFailure:
+            return processAuthFailure(e, containerEl);
+        case EmbedEvent.AuthLogout:
+            return processAuthLogout(e, containerEl);
         default:
     }
     return e;

package/src/utils.spec.ts

@@ -8,6 +8,7 @@ import {
     getCssDimension,
     getEncodedQueryParamsString,
     appendToUrlHash,
+    getRedirectUrl,
 } from './utils';
 import { RuntimeFilterOp } from './types';
 
@@ -80,6 +81,31 @@ describe('unit test for utils', () => {
         );
     });
 
+    describe('getRedirectURL', () => {
+        test('Should return correct value when path is undefined', () => {
+            expect(getRedirectUrl('http://myhost:3000', 'hashFrag')).toBe(
+                'http://myhost:3000#hashFrag',
+            );
+            expect(getRedirectUrl('http://xyz.com/#foo', 'bar')).toBe(
+                'http://xyz.com/#foobar',
+            );
+        });
+
+        test('Should return correct value when path is set', () => {
+            Object.defineProperty(window.location, 'origin', {
+                get: () => 'http://myhost:3000',
+            });
+
+            expect(
+                getRedirectUrl('http://myhost:3000/', 'hashFrag', '/bar'),
+            ).toBe('http://myhost:3000/bar#hashFrag');
+
+            expect(
+                getRedirectUrl('http://myhost:3000/#/foo', 'hashFrag', '#/bar'),
+            ).toBe('http://myhost:3000/#/barhashFrag');
+        });
+    });
+
     test('getEncodedQueryParamsString', () => {
         expect(getEncodedQueryParamsString('')).toBe('');
         expect(getEncodedQueryParamsString('test')).toBe('dGVzdA');

package/src/utils.ts

@@ -121,6 +121,11 @@ export const appendToUrlHash = (url: string, stringToAppend: string) => {
     return outputUrl;
 };
 
+export function getRedirectUrl(url: string, stringToAppend: string, path = '') {
+    const targetUrl = path ? new URL(path, window.location.origin).href : url;
+    return appendToUrlHash(targetUrl, stringToAppend);
+}
+
 export const getEncodedQueryParamsString = (queryString: string) => {
     if (!queryString) {
         return queryString;