@thoughtspot/visual-embed-sdk 1.26.2 → 1.27.0-logger

package/src/embed/search-bar.tsx

@@ -20,25 +20,41 @@ export interface SearchBarViewConfig
     > {
     /**
      * The array of data source GUIDs to set on load.
-     * Only a single dataSource supported currently.
+     * Only a single data source is supported currently.
      *
-     * @deprecated Use dataSource instead
+     * @deprecated Use `dataSource` instead
      */
     dataSources?: string[];
     /**
      * The array of data source GUIDs to set on load.
      *
-     * @version: SDK: 1.19.0
+     * @version: SDK: 1.19.0, ThoughtSpot 9.0.0.cl, 9.0.1.sw
      */
     dataSource?: string;
     /**
-     * Flag to set if last selected dataSource should be used
+     * Boolean to define if the last selected data source should be used
      *
-     * @version: SDK: 1.24.0
+     * @version: SDK: 1.24.0, ThoughtSpot 9.5.0.cl, 9.5.0.sw
      */
     useLastSelectedSources?: boolean;
     /**
-     * Configuration for search options
+     * Configuration for search options.
+     * Includes the following properties:
+     *
+     * `searchTokenString`: Search tokens to pass in the query.
+     *
+     * `executeSearch`: Boolean to define if the search should be executed or not.
+     * If it is executed, the focus is placed on the results.
+     * If it’s not executed, the focus is placed at the end of
+     * the token string in the search bar.
+     *
+     * @example
+     * ```js
+     * searchOptions: {
+     *    searchTokenString: '[quantity purchased] [region]',
+     *    executeSearch: true,
+     * }
+     * ```
      */
     searchOptions?: SearchOptions;
 }

package/src/embed/search.spec.ts

@@ -411,4 +411,17 @@ describe('Search embed tests', () => {
             );
         });
     });
+    test('should set hideSearchBar to true if hideSearchBar flag is true', async () => {
+        const searchEmbed = new SearchEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            hideSearchBar: true,
+        });
+        searchEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSourceMode=expand&enableDataPanelV2=false&useLastSelectedSources=false&hideSearchBar=true${prefixParams}#/embed/saved-answer/${answerId}`,
+            );
+        });
+    });
 });

package/src/embed/search.ts

@@ -23,18 +23,19 @@ import { getReleaseVersion } from '../auth';
 import { getEmbedConfig } from './embedConfig';
 
 /**
- * Configuration for search options
+ * Configuration for search options.
+ *
  */
 export interface SearchOptions {
     /**
-     * The tml string to load the answer
+     * Search tokens to pass in the query.
      */
     searchTokenString: string;
     /**
-     * Boolean to determine if the search should be executed or not.
-     * if it is executed, put the focus on the results.
-     * if it’s not executed, put the focus in the search bar - at the end of
-     * the tokens
+     * Boolean to define if the search should be executed or not.
+     * If it is executed, the focus is placed on the results.
+     * If it’s not executed, the focus is placed at the end of
+     * the token string in the search bar.
      */
     executeSearch?: boolean;
 }
@@ -59,19 +60,15 @@ export interface SearchViewConfig
      */
     collapseDataSources?: boolean;
     /**
-     * If set to true, hides the data sources panel.
+     * Show or hide the data sources panel.
      */
     hideDataSources?: boolean;
     /**
-     * If set to true, hides the charts and tables in search answers.
+     * Show or hide the charts and tables in search answers.
      * This attribute can be used to create a custom visualization
      * 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.
      *
@@ -85,9 +82,9 @@ export interface SearchViewConfig
     forceTable?: boolean;
     /**
      * The array of data source GUIDs to set on load.
-     * Only a single dataSource supported currently.
+     * Only a single data source is supported currently.
      *
-     * @deprecated Use dataSource instead
+     * @deprecated Use `dataSource` instead.
      */
     dataSources?: string[];
     /**
@@ -99,11 +96,29 @@ export interface SearchViewConfig
     /**
      * The initial search query to load the answer with.
      *
-     * @deprecated Use {@link searchOptions} instead
+     * @deprecated
+     *
+     * Use {@link searchOptions} instead.
      */
     searchQuery?: string;
     /**
-     * Configuration for search options
+     * Configuration for search options.
+     * Includes the following properties:
+     *
+     * `searchTokenString`: Search tokens to pass in the query.
+     *
+     * `executeSearch`: Boolean to define if the search should be executed or not.
+     * If it is executed, the focus is placed on the results.
+     * If it’s not executed, the focus is placed at the end of
+     * the token string in the search bar.
+     *
+     * @example
+     * ```js
+     * searchOptions: {
+     *    searchTokenString: '[quantity purchased] [region]',
+     *    executeSearch: true,
+     * }
+     * ```
      */
     searchOptions?: SearchOptions;
     /**
@@ -111,10 +126,10 @@ export interface SearchViewConfig
      */
     answerId?: string;
     /**
-     * If set to true, search page will render without the Search Bar
+     * If set to true, the search page will render without the Search Bar
      * The chart/table should still be visible.
      *
-     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
      */
     hideSearchBar?: boolean;
     /**
@@ -177,7 +192,6 @@ export class SearchEmbed extends TsEmbed {
     protected getEmbedParams(): string {
         const {
             hideResults,
-            expandAllDataSource,
             enableSearchAssist,
             forceTable,
             searchOptions,
@@ -185,6 +199,7 @@ export class SearchEmbed extends TsEmbed {
             dataSource,
             dataSources,
             excludeRuntimeFiltersfromURL,
+            hideSearchBar,
             dataPanelV2 = false,
             useLastSelectedSources = false,
             runtimeParameters,
@@ -221,6 +236,10 @@ export class SearchEmbed extends TsEmbed {
             queryParams[Param.ForceTable] = true;
         }
 
+        if (hideSearchBar) {
+            queryParams[Param.HideSearchBar] = true;
+        }
+
         queryParams[Param.DataPanelV2Enabled] = dataPanelV2;
         queryParams[Param.DataSourceMode] = this.getDataSourceMode();
 

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

@@ -32,6 +32,7 @@ import * as authInstance from '../auth';
 import * as baseInstance from './base';
 import { MIXPANEL_EVENT } from '../mixpanel-service';
 import * as authService from '../utils/authService/authService';
+import { logger } from '../utils/logger';
 
 const defaultViewConfig = {
     frameParams: {
@@ -425,7 +426,7 @@ describe('Unit test case for ts embed', () => {
             const searchEmbed = new SearchEmbed(getRootEl(), defaultViewConfig);
             searchEmbed
                 .on(EmbedEvent.Save, () => {
-                    console.log('non callable');
+                    logger.log('non callable');
                 })
                 .render();
 
@@ -468,7 +469,7 @@ describe('Unit test case for ts embed', () => {
                 .on(
                     EmbedEvent.Save,
                     () => {
-                        console.log('non callable');
+                        logger.log('non callable');
                     },
                     { start: true },
                 )
@@ -562,6 +563,138 @@ describe('Unit test case for ts embed', () => {
         });
     });
 
+    describe('Token fetch fails in cookieless authentication authType', () => {
+        beforeEach(() => {
+            jest.spyOn(authInstance, 'doCookielessTokenAuth').mockResolvedValueOnce(true);
+            init({
+                thoughtSpotHost: 'tshost',
+                customizations: customisations,
+                customCssUrl: 'http://localhost:5000',
+                authType: AuthType.TrustedAuthTokenCookieless,
+                getAuthToken: () => Promise.reject(),
+            });
+        });
+
+        afterEach(() => {
+            jest.clearAllMocks();
+            baseInstance.reset();
+        });
+
+        test('should show login failure message if token failed during app_init', async () => {
+            const a = jest.spyOn(authService, 'verifyTokenService');
+            a.mockResolvedValue(true);
+
+            // authVerifyMock.mockResolvedValue(true);
+            const mockEmbedEventPayload = {
+                type: EmbedEvent.APP_INIT,
+                data: {},
+            };
+            const searchEmbed = new SearchEmbed(getRootEl(), defaultViewConfig);
+            searchEmbed.render();
+            const mockPort: any = {
+                postMessage: jest.fn(),
+            };
+            await executeAfterWait(() => {
+                const iframe = getIFrameEl();
+                postMessageToParent(iframe.contentWindow, mockEmbedEventPayload, mockPort);
+            });
+            await executeAfterWait(() => {
+                expect(mockPort.postMessage).not.toHaveBeenCalled();
+                expect(getRootEl().innerHTML).toContain('Not logged in');
+            });
+
+            jest.spyOn(authService, 'verifyTokenService').mockClear();
+        });
+
+        test('should show login failure message if token failed during app_init prerender', async () => {
+            const a = jest.spyOn(authService, 'verifyTokenService');
+            a.mockResolvedValue(true);
+
+            // authVerifyMock.mockResolvedValue(true);
+            const mockEmbedEventPayload = {
+                type: EmbedEvent.APP_INIT,
+                data: {},
+            };
+            const searchEmbed = new SearchEmbed(getRootEl(), { ...defaultViewConfig, preRenderId: 'test' });
+            searchEmbed.preRender();
+            const mockPort: any = {
+                postMessage: jest.fn(),
+            };
+            await executeAfterWait(() => {
+                const iframe = getIFrameEl();
+                postMessageToParent(iframe.contentWindow, mockEmbedEventPayload, mockPort);
+            });
+            const preRenderWrapper = document.getElementById('tsEmbed-pre-render-wrapper-test');
+            await executeAfterWait(() => {
+                expect(mockPort.postMessage).not.toHaveBeenCalled();
+                expect(preRenderWrapper.innerHTML).toContain('Not logged in');
+            });
+
+            jest.spyOn(authService, 'verifyTokenService').mockClear();
+        });
+
+        test('should show login failure message if update token failed', async () => {
+            const a = jest.spyOn(authService, 'verifyTokenService');
+            a.mockResolvedValue(true);
+
+            // authVerifyMock.mockResolvedValue(true);
+            const mockEmbedEventPayload = {
+                type: EmbedEvent.AuthExpire,
+                data: {},
+            };
+            const searchEmbed = new SearchEmbed(getRootEl(), defaultViewConfig);
+            jest.spyOn(baseInstance, 'notifyAuthFailure');
+            searchEmbed.render();
+            const mockPort: any = {
+                postMessage: jest.fn(),
+            };
+            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.EXPIRY,
+                );
+            });
+
+            jest.spyOn(authService, 'verifyTokenService').mockClear();
+            jest.spyOn(baseInstance, 'notifyAuthFailure').mockClear();
+        });
+
+        test('should show login failure message if update token failed prerender', async () => {
+            const a = jest.spyOn(authService, 'verifyTokenService');
+            a.mockResolvedValue(true);
+
+            // authVerifyMock.mockResolvedValue(true);
+            const mockEmbedEventPayload = {
+                type: EmbedEvent.AuthExpire,
+                data: {},
+            };
+            const searchEmbed = new SearchEmbed(getRootEl(), { ...defaultViewConfig, preRenderId: 'test' });
+            jest.spyOn(baseInstance, 'notifyAuthFailure');
+            searchEmbed.preRender();
+            const mockPort: any = {
+                postMessage: jest.fn(),
+            };
+            await executeAfterWait(() => {
+                const iframe = getIFrameEl();
+                postMessageToParent(iframe.contentWindow, mockEmbedEventPayload, mockPort);
+            });
+            const preRenderWrapper = document.getElementById('tsEmbed-pre-render-wrapper-test');
+            await executeAfterWait(() => {
+                expect(preRenderWrapper.innerHTML).toContain('Not logged in');
+                expect(baseInstance.notifyAuthFailure).toBeCalledWith(
+                    authInstance.AuthFailureType.EXPIRY,
+                );
+            });
+
+            jest.spyOn(authService, 'verifyTokenService').mockClear();
+            jest.spyOn(baseInstance, 'notifyAuthFailure').mockClear();
+        });
+    });
+
     xdescribe('AuthExpire embedEvent in TrustedAuthToken authType', () => {
         test('AutoLogin true scenario', async () => {
             init({
@@ -698,7 +831,7 @@ describe('Unit test case for ts embed', () => {
             const iFrame: any = document.createElement('div');
             iFrame.contentWindow = null;
             jest.spyOn(document, 'createElement').mockReturnValueOnce(iFrame);
-            spyOn(console, 'error');
+            spyOn(logger, 'error');
             tsEmbed.render();
         });
 
@@ -712,7 +845,7 @@ describe('Unit test case for ts embed', () => {
 
     describe('when visible actions are set', () => {
         test('should throw error when there are both visible and hidden actions - pinboard', async () => {
-            spyOn(console, 'error');
+            spyOn(logger, 'error');
             const pinboardEmbed = new PinboardEmbed(getRootEl(), {
                 hiddenActions: [Action.DownloadAsCsv],
                 visibleActions: [Action.DownloadAsCsv],
@@ -721,7 +854,7 @@ describe('Unit test case for ts embed', () => {
             } as LiveboardViewConfig);
             await pinboardEmbed.render();
             expect(pinboardEmbed['isError']).toBe(true);
-            expect(console.error).toHaveBeenCalledWith(
+            expect(logger.error).toHaveBeenCalledWith(
                 'You cannot have both hidden actions and visible actions',
             );
         });
@@ -744,7 +877,7 @@ describe('Unit test case for ts embed', () => {
             hiddenActions: Array<Action>,
             visibleActions: Array<Action>,
         ) {
-            spyOn(console, 'error');
+            spyOn(logger, 'error');
             const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
                 hiddenActions,
                 visibleActions,
@@ -753,7 +886,7 @@ describe('Unit test case for ts embed', () => {
             } as LiveboardViewConfig);
             await liveboardEmbed.render();
             expect(liveboardEmbed['isError']).toBe(true);
-            expect(console.error).toHaveBeenCalledWith(
+            expect(logger.error).toHaveBeenCalledWith(
                 'You cannot have both hidden actions and visible actions',
             );
         }
@@ -789,7 +922,7 @@ describe('Unit test case for ts embed', () => {
 
     describe('when visible Tabs are set', () => {
         test('should throw error when there are both visible and hidden Tabs - pinboard', async () => {
-            spyOn(console, 'error');
+            spyOn(logger, 'error');
             const pinboardEmbed = new PinboardEmbed(getRootEl(), {
                 visibleTabs: [tabId1],
                 hiddenTabs: [tabId2],
@@ -798,7 +931,7 @@ describe('Unit test case for ts embed', () => {
             } as LiveboardViewConfig);
             await pinboardEmbed.render();
             expect(pinboardEmbed['isError']).toBe(true);
-            expect(console.error).toHaveBeenCalledWith(
+            expect(logger.error).toHaveBeenCalledWith(
                 'You cannot have both hidden Tabs and visible Tabs',
             );
         });
@@ -821,7 +954,7 @@ describe('Unit test case for ts embed', () => {
             hiddenTabs: Array<string>,
             visibleTabs: Array<string>,
         ) {
-            spyOn(console, 'error');
+            spyOn(logger, 'error');
             const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
                 hiddenTabs,
                 visibleTabs,
@@ -830,7 +963,7 @@ describe('Unit test case for ts embed', () => {
             } as LiveboardViewConfig);
             await liveboardEmbed.render();
             expect(liveboardEmbed['isError']).toBe(true);
-            expect(console.error).toHaveBeenCalledWith(
+            expect(logger.error).toHaveBeenCalledWith(
                 'You cannot have both hidden Tabs and visible Tabs',
             );
         }
@@ -874,11 +1007,11 @@ describe('Unit test case for ts embed', () => {
         });
 
         test('Error should be true', async () => {
-            spyOn(console, 'error');
+            spyOn(logger, 'error');
             const tsEmbed = new SearchEmbed(getRootEl(), {});
             tsEmbed.render();
             expect(tsEmbed['isError']).toBe(true);
-            expect(console.error).toHaveBeenCalledWith(
+            expect(logger.error).toHaveBeenCalledWith(
                 'You need to init the ThoughtSpot SDK module first',
             );
         });
@@ -886,13 +1019,13 @@ describe('Unit test case for ts embed', () => {
 
     describe('V1Embed ', () => {
         test('when isRendered is true than isError will be true', () => {
-            spyOn(console, 'error');
+            spyOn(logger, 'error');
             const viEmbedIns = new tsEmbedInstance.V1Embed(getRootEl(), defaultViewConfig);
             expect(viEmbedIns['isError']).toBe(false);
             viEmbedIns.render();
             viEmbedIns.on(EmbedEvent.CustomAction, jest.fn()).render();
             expect(viEmbedIns['isError']).toBe(true);
-            expect(console.error).toHaveBeenCalledWith(
+            expect(logger.error).toHaveBeenCalledWith(
                 'Please register event handlers before calling render',
             );
         });
@@ -933,7 +1066,7 @@ describe('Unit test case for ts embed', () => {
         });
 
         test('navigateToPage function use before render', async () => {
-            spyOn(console, 'log');
+            spyOn(logger, 'log');
             const appEmbed = new AppEmbed(getRootEl(), {
                 frameParams: {
                     width: '100%',
@@ -942,7 +1075,7 @@ describe('Unit test case for ts embed', () => {
             });
             appEmbed.navigateToPage(path, false);
             await appEmbed.render();
-            expect(console.log).toHaveBeenCalledWith(
+            expect(logger.log).toHaveBeenCalledWith(
                 'Please call render before invoking this method',
             );
         });
@@ -1330,7 +1463,7 @@ describe('Unit test case for ts embed', () => {
                 });
 
             // show preRender
-            const warnSpy = spyOn(console, 'warn');
+            const warnSpy = spyOn(logger, 'warn');
             libEmbed.showPreRender();
             expect(warnSpy).toHaveBeenCalledTimes(0);
 
@@ -1360,13 +1493,13 @@ describe('Unit test case for ts embed', () => {
         it('preRender called without preRenderId should log error ', () => {
             createRootEleForEmbed();
 
-            spyOn(console, 'error');
+            spyOn(logger, 'error');
             const libEmbed = new LiveboardEmbed('#tsEmbedDiv', {
                 liveboardId: 'myLiveboardId',
             });
             libEmbed.preRender();
 
-            expect(console.error).toHaveBeenCalledWith('PreRender id is required for preRender');
+            expect(logger.error).toHaveBeenCalledWith('PreRender id is required for preRender');
         });
 
         it('showPreRender should preRender if not available', async () => {
@@ -1414,7 +1547,7 @@ describe('Unit test case for ts embed', () => {
 
             libEmbed.preRender();
             await waitFor(() => !!getIFrameEl());
-            const warnSpy = jest.spyOn(console, 'warn');
+            const warnSpy = jest.spyOn(logger, 'warn');
             const newEmbed = new LiveboardEmbed('#tsEmbedDiv', {
                 preRenderId: 'i-am-preRendered',
                 liveboardId: 'awdawda',
@@ -1433,10 +1566,10 @@ describe('Unit test case for ts embed', () => {
                 liveboardId: 'myLiveboardId',
             });
             spyOn(libEmbed, 'preRender');
-            spyOn(console, 'error');
+            spyOn(logger, 'error');
             libEmbed.showPreRender();
             expect(libEmbed.preRender).toHaveBeenCalledTimes(0);
-            expect(console.error).toHaveBeenCalledTimes(1);
+            expect(logger.error).toHaveBeenCalledTimes(1);
         });
 
         it('should get underlying iframe', async () => {
@@ -1464,16 +1597,16 @@ describe('Unit test case for ts embed', () => {
             );
         });
         it('should log error if sync is called before preRender', async () => {
-            jest.spyOn(console, 'error').mockImplementation(jest.fn());
+            jest.spyOn(logger, 'error').mockImplementation(jest.fn());
             const libEmbed = new LiveboardEmbed('#tsEmbedDiv', {
                 liveboardId: 'myLiveboardId',
                 preRenderId: 'test',
             });
             await libEmbed.syncPreRenderStyle();
-            expect(console.error).toBeCalledWith(
+            expect(logger.error).toBeCalledWith(
                 'PreRender should be called before using syncPreRenderStyle',
             );
-            (console.error as any).mockClear();
+            (logger.error as any).mockClear();
         });
     });
 });