@thoughtspot/visual-embed-sdk 1.35.11 → 1.35.13

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

@@ -1,7 +1,7 @@
 /* eslint-disable dot-notation */
 import { resetCachedAuthToken } from '../authToken';
-import { AuthType, init, EmbedEvent, SearchEmbed, PinboardEmbed, AppEmbed, LiveboardEmbed, SageEmbed, ConversationEmbed, AnswerService, } from '../index';
-import { Action, HomeLeftNavItem, RuntimeFilterOp, HomepageModule, HostEvent, } from '../types';
+import { AuthType, init, EmbedEvent, SearchEmbed, PinboardEmbed, AppEmbed, LiveboardEmbed, SageEmbed, AnswerService, } from '../index';
+import { Action, HomeLeftNavItem, RuntimeFilterOp, HomepageModule, HostEvent, ContextMenuTriggerOptions, } from '../types';
 import { executeAfterWait, getDocumentBody, getIFrameEl, getIFrameSrc, getRootEl, postMessageToParent, defaultParamsForPinboardEmbed, waitFor, expectUrlMatchesWithParams, expectUrlToHaveParamsWithValues, mockMessageChannel, createRootEleForEmbed, expectUrlMatch, fixedEncodeURI, } from '../test/test-utils';
 import * as config from '../config';
 import * as tsEmbedInstance from './ts-embed';
@@ -182,6 +182,38 @@ describe('Unit test case for ts embed', () => {
                 });
             });
         });
+        test('check for new authToken based on getAuthToken function', async () => {
+            init({
+                thoughtSpotHost: 'tshost',
+                customizations: customisations,
+                authType: AuthType.TrustedAuthToken,
+                getAuthToken: () => Promise.resolve('test_auth_token2'),
+                autoLogin: true,
+            });
+            const mockEmbedEventPayload = {
+                type: EmbedEvent.AuthExpire,
+                data: {},
+            };
+            const searchEmbed = new SearchEmbed(getRootEl(), defaultViewConfig);
+            jest.spyOn(baseInstance, 'notifyAuthFailure');
+            jest.spyOn(baseInstance, 'handleAuth');
+            searchEmbed.render();
+            const mockPort = {
+                postMessage: jest.fn(),
+            };
+            await executeAfterWait(() => {
+                const iframe = getIFrameEl();
+                postMessageToParent(iframe.contentWindow, mockEmbedEventPayload, mockPort);
+            });
+            await executeAfterWait(() => {
+                expect(baseInstance.notifyAuthFailure).toBeCalledWith(authInstance.AuthFailureType.EXPIRY);
+                expect(mockPort.postMessage).not.toHaveBeenCalledWith({
+                    type: EmbedEvent.AuthExpire,
+                    data: { authToken: 'test_auth_token2' },
+                });
+                expect(baseInstance.handleAuth).toHaveBeenCalled();
+            });
+        });
     });
     describe('Called Embed event status for start and end', () => {
         beforeAll(() => {
@@ -1415,49 +1447,15 @@ describe('Unit test case for ts embed', () => {
                 orgId: overrideOrgId,
             });
         });
-        it('AppEmbed: Should add flipTooltipToContextMenuEnabled flag to the iframe src', async () => {
-            const appEmbed = new AppEmbed(getRootEl(), {
-                ...defaultViewConfig,
-                enableFlipTooltipToContextMenu: true,
-            });
-            appEmbed.render();
-            await executeAfterWait(() => {
-                expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&flipTooltipToContextMenuEnabled=true${defaultParams}${defaultParamsPost}#/home`);
-            });
-        });
-        it('AppEmbed: Should not add flipTooltipToContextMenuEnabled flag to the iframe src when if false', async () => {
-            const appEmbed = new AppEmbed(getRootEl(), {
-                ...defaultViewConfig,
-                enableFlipTooltipToContextMenu: false,
-            });
-            appEmbed.render();
-            await executeAfterWait(() => {
-                expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false${defaultParams}${defaultParamsPost}#/home`);
-            });
-        });
-        it('LiveboardEmbed: Should add flipTooltipToContextMenuEnabled flag to the iframe src', async () => {
-            const appEmbed = new LiveboardEmbed(getRootEl(), {
-                ...defaultViewConfig,
-                liveboardId,
-                enableFlipTooltipToContextMenu: true,
-            });
-            appEmbed.render();
-            await executeAfterWait(() => {
-                expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&flipTooltipToContextMenuEnabled=true${defaultParams}#/embed/viz/${liveboardId}`);
-            });
-        });
-        it('LiveboardEmbed: Should not add flipTooltipToContextMenuEnabled flag to the iframe src when if false', async () => {
-            const appEmbed = new LiveboardEmbed(getRootEl(), {
+        it('Should not add contextMenuEnabledOnWhichClick flag to the iframe src when it is not passed', async () => {
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
                 ...defaultViewConfig,
                 liveboardId,
-                enableFlipTooltipToContextMenu: false,
             });
-            appEmbed.render();
+            liveboardEmbed.render();
             await executeAfterWait(() => {
                 expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true${defaultParams}#/embed/viz/${liveboardId}`);
             });
-        });
-        it('SageViewConfig: Should add flipTooltipToContextMenuEnabled flag to the iframe src', async () => {
             const defaultConfig = {
                 disableWorksheetChange: false,
                 hideWorksheetSelector: false,
@@ -1467,16 +1465,24 @@ describe('Unit test case for ts embed', () => {
                 isProductTour: false,
                 dataPanelV2: false,
             };
-            const appEmbed = new SageEmbed(getRootEl(), {
+            const sageEmbed = new SageEmbed(getRootEl(), {
                 ...defaultConfig,
-                enableFlipTooltipToContextMenu: true,
             });
-            appEmbed.render();
+            sageEmbed.render();
             await executeAfterWait(() => {
-                expectUrlMatch(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&enableDataPanelV2=false&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D&flipTooltipToContextMenuEnabled=true#/embed/eureka`);
+                expectUrlMatch(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&enableDataPanelV2=false&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`);
             });
         });
-        it('SageViewConfig: Should not add flipTooltipToContextMenuEnabled flag to the iframe src when if false', async () => {
+        it('Should add contextMenuEnabledOnWhichClick flag to the iframe with left value', async () => {
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+                ...defaultViewConfig,
+                liveboardId,
+                contextMenuTrigger: ContextMenuTriggerOptions.LEFT_CLICK,
+            });
+            liveboardEmbed.render();
+            await executeAfterWait(() => {
+                expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&contextMenuEnabledOnWhichClick=left#/embed/viz/${liveboardId}`);
+            });
             const defaultConfig = {
                 disableWorksheetChange: false,
                 hideWorksheetSelector: false,
@@ -1486,63 +1492,69 @@ describe('Unit test case for ts embed', () => {
                 isProductTour: false,
                 dataPanelV2: false,
             };
-            const appEmbed = new SageEmbed(getRootEl(), {
+            const sageEmbed = new SageEmbed(getRootEl(), {
                 ...defaultConfig,
-                enableFlipTooltipToContextMenu: false,
+                contextMenuTrigger: ContextMenuTriggerOptions.LEFT_CLICK,
             });
-            appEmbed.render();
+            sageEmbed.render();
             await executeAfterWait(() => {
-                expectUrlMatch(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&enableDataPanelV2=false&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`);
+                expectUrlMatch(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&enableDataPanelV2=false&contextMenuEnabledOnWhichClick=left&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`);
             });
         });
-        it('ConversationEmbed: Should add flipTooltipToContextMenuEnabled flag to the iframe src', async () => {
-            const appEmbed = new ConversationEmbed(getRootEl(), {
-                worksheetId: 'worksheetId',
-                searchOptions: {
-                    searchQuery: 'searchQuery',
-                },
-                enableFlipTooltipToContextMenu: true,
+        it('Should add contextMenuEnabledOnWhichClick flag to the iframe with right value', async () => {
+            const livebaordEmbed = new LiveboardEmbed(getRootEl(), {
+                ...defaultViewConfig,
+                liveboardId,
+                contextMenuTrigger: ContextMenuTriggerOptions.RIGHT_CLICK,
             });
-            appEmbed.render();
+            livebaordEmbed.render();
             await executeAfterWait(() => {
-                expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true&flipTooltipToContextMenuEnabled=true#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`);
+                expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&contextMenuEnabledOnWhichClick=right#/embed/viz/${liveboardId}`);
             });
-        });
-        it('ConversationEmbed: Should not add flipTooltipToContextMenuEnabled flag to the iframe src when flag is false', async () => {
-            const appEmbed = new ConversationEmbed(getRootEl(), {
-                worksheetId: 'worksheetId',
-                searchOptions: {
-                    searchQuery: 'searchQuery',
-                },
-                enableFlipTooltipToContextMenu: false,
+            const defaultConfig = {
+                disableWorksheetChange: false,
+                hideWorksheetSelector: false,
+                hideSageAnswerHeader: false,
+                hideAutocompleteSuggestions: false,
+                hideSampleQuestions: false,
+                isProductTour: false,
+                dataPanelV2: false,
+            };
+            const sageEmbed = new SageEmbed(getRootEl(), {
+                ...defaultConfig,
+                contextMenuTrigger: ContextMenuTriggerOptions.RIGHT_CLICK,
             });
-            appEmbed.render();
+            sageEmbed.render();
             await executeAfterWait(() => {
-                expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/v2/?${defaultParams}&isSpotterExperienceEnabled=true#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`);
+                expectUrlMatch(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&enableDataPanelV2=false&contextMenuEnabledOnWhichClick=right&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`);
             });
         });
-        it('SearchEmbed: Should add flipTooltipToContextMenuEnabled flag to the iframe src', async () => {
-            const dataSources = ['data-source-1'];
-            const appEmbed = new SearchEmbed(getRootEl(), {
+        it('Should add contextMenuEnabledOnWhichClick flag to the iframe with both value', async () => {
+            const livebaordEmbed = new LiveboardEmbed(getRootEl(), {
                 ...defaultViewConfig,
-                dataSources,
-                enableFlipTooltipToContextMenu: true,
+                liveboardId,
+                contextMenuTrigger: ContextMenuTriggerOptions.BOTH_CLICKS,
             });
-            appEmbed.render();
+            livebaordEmbed.render();
             await executeAfterWait(() => {
-                expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSources=[%22data-source-1%22]&dataSourceMode=expand&useLastSelectedSources=false&flipTooltipToContextMenuEnabled=true#/embed/answer`);
+                expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&contextMenuEnabledOnWhichClick=both#/embed/viz/${liveboardId}`);
             });
-        });
-        it('SearchEmbed: Should not add flipTooltipToContextMenuEnabled flag to the iframe src when if false', async () => {
-            const dataSources = ['data-source-1'];
-            const appEmbed = new SearchEmbed(getRootEl(), {
-                ...defaultViewConfig,
-                dataSources,
-                enableFlipTooltipToContextMenu: false,
+            const defaultConfig = {
+                disableWorksheetChange: false,
+                hideWorksheetSelector: false,
+                hideSageAnswerHeader: false,
+                hideAutocompleteSuggestions: false,
+                hideSampleQuestions: false,
+                isProductTour: false,
+                dataPanelV2: false,
+            };
+            const sageEmbed = new SageEmbed(getRootEl(), {
+                ...defaultConfig,
+                contextMenuTrigger: ContextMenuTriggerOptions.BOTH_CLICKS,
             });
-            appEmbed.render();
+            sageEmbed.render();
             await executeAfterWait(() => {
-                expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSources=[%22data-source-1%22]&dataSourceMode=expand&useLastSelectedSources=false#/embed/answer`);
+                expectUrlMatch(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&enableDataPanelV2=false&contextMenuEnabledOnWhichClick=both&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=false&hideEurekaSuggestions=false&isProductTour=false&hideSageAnswerHeader=false&hideAction=%5B%22reportError%22%5D#/embed/eureka`);
             });
         });
     });
@@ -1816,5 +1828,105 @@ describe('Unit test case for ts embed', () => {
             logger.error.mockClear();
         });
     });
+    describe('IdleSessionTimeout embedEvent for TrustedAuthTokenCookieless authType with autoLogin true', () => {
+        beforeAll(() => {
+            jest.spyOn(authInstance, 'doCookielessTokenAuth').mockResolvedValueOnce(true);
+            jest.spyOn(authService, 'verifyTokenService').mockResolvedValueOnce(true);
+            init({
+                thoughtSpotHost: 'tshost',
+                customizations: customisations,
+                authType: AuthType.TrustedAuthTokenCookieless,
+                getAuthToken: () => Promise.resolve('test_auth_token2'),
+                autoLogin: true,
+            });
+        });
+        test('should handle idle session timeout and send updated auth token', async () => {
+            const mockEmbedEventPayload = {
+                type: EmbedEvent.IdleSessionTimeout,
+                data: {},
+            };
+            const searchEmbed = new SearchEmbed(getRootEl(), defaultViewConfig);
+            jest.spyOn(baseInstance, 'handleAuth');
+            jest.spyOn(baseInstance, 'notifyAuthFailure');
+            searchEmbed.render();
+            const mockPort = {
+                postMessage: jest.fn(),
+            };
+            await executeAfterWait(() => {
+                const iframe = getIFrameEl();
+                postMessageToParent(iframe.contentWindow, mockEmbedEventPayload, mockPort);
+            });
+            await executeAfterWait(() => {
+                expect(baseInstance.notifyAuthFailure).toBeCalledWith(authInstance.AuthFailureType.IDLE_SESSION_TIMEOUT);
+                expect(baseInstance.handleAuth).toHaveBeenCalled();
+                expect(mockPort.postMessage).toHaveBeenCalledWith({
+                    type: EmbedEvent.IdleSessionTimeout,
+                    data: { authToken: 'test_auth_token2' },
+                });
+            });
+        });
+        test('should handle idle session timeout and show login failure message if token fetch fails', async () => {
+            init({
+                thoughtSpotHost: 'tshost',
+                customizations: customisations,
+                authType: AuthType.TrustedAuthTokenCookieless,
+                getAuthToken: () => Promise.reject(),
+                autoLogin: true,
+            });
+            const mockEmbedEventPayload = {
+                type: EmbedEvent.IdleSessionTimeout,
+                data: {},
+            };
+            const searchEmbed = new SearchEmbed(getRootEl(), defaultViewConfig);
+            jest.spyOn(baseInstance, 'notifyAuthFailure');
+            searchEmbed.render();
+            const mockPort = {
+                postMessage: jest.fn(),
+            };
+            const loggerSpy = jest.spyOn(logger, 'error').mockResolvedValueOnce(true);
+            await executeAfterWait(() => {
+                const iframe = getIFrameEl();
+                postMessageToParent(iframe.contentWindow, mockEmbedEventPayload, mockPort);
+            });
+            await executeAfterWait(() => {
+                expect(getRootEl().innerHTML).toContain('Not logged in');
+                expect(baseInstance.notifyAuthFailure).toBeCalledWith(authInstance.AuthFailureType.IDLE_SESSION_TIMEOUT);
+                expect(loggerSpy).toHaveBeenCalledTimes(1);
+            });
+            jest.spyOn(authService, 'verifyTokenService').mockClear();
+            jest.spyOn(baseInstance, 'notifyAuthFailure').mockClear();
+        });
+        test('should handle idle session timeout and show login failure message if handleAuth fails', async () => {
+            init({
+                thoughtSpotHost: 'tshost',
+                customizations: customisations,
+                authType: AuthType.TrustedAuthTokenCookieless,
+                getAuthToken: () => Promise.resolve('test_auth_token2'),
+                autoLogin: true,
+            });
+            const mockEmbedEventPayload = {
+                type: EmbedEvent.IdleSessionTimeout,
+                data: {},
+            };
+            const searchEmbed = new SearchEmbed(getRootEl(), defaultViewConfig);
+            jest.spyOn(baseInstance, 'notifyAuthFailure');
+            jest.spyOn(authInstance, 'authenticate').mockResolvedValue(false);
+            searchEmbed.render();
+            const mockPort = {
+                postMessage: jest.fn(),
+            };
+            const loggerSpy = jest.spyOn(logger, 'error').mockResolvedValueOnce(true);
+            await executeAfterWait(() => {
+                const iframe = getIFrameEl();
+                postMessageToParent(iframe.contentWindow, mockEmbedEventPayload, mockPort);
+            });
+            await executeAfterWait(() => {
+                expect(baseInstance.notifyAuthFailure).toBeCalledWith(authInstance.AuthFailureType.IDLE_SESSION_TIMEOUT);
+                expect(loggerSpy).toHaveBeenCalledTimes(0);
+            });
+            jest.spyOn(authService, 'verifyTokenService').mockClear();
+            jest.spyOn(baseInstance, 'notifyAuthFailure').mockClear();
+        });
+    });
 });
 //# sourceMappingURL=ts-embed.spec.js.map