@thoughtspot/visual-embed-sdk 1.12.0-alpha.2 → 1.12.2

package/src/embed/searchEmbed-basic-auth.spec.ts

@@ -0,0 +1,115 @@
+import { SearchEmbed } from './search';
+import * as baseInstance from './base';
+import * as authService from '../utils/authService';
+import * as authInstance from '../auth';
+import * as config from '../config';
+
+import { init } from '../index';
+import { AuthType } from '../types';
+import { getDocumentBody, getRootEl } from '../test/test-utils';
+import { mockSessionInfo } from '../auth.spec';
+import { ERROR_MESSAGE } from '../errors';
+
+const thoughtSpotHost = 'tshost';
+init({
+    thoughtSpotHost,
+    authType: AuthType.Basic,
+    username: 'tsadmin',
+    password: 'admin',
+});
+
+describe('Search embed tests when authType is Basic', () => {
+    function setupVersion(version: string) {
+        jest.spyOn(window, 'addEventListener').mockImplementationOnce(
+            (event, handler, options) => {
+                handler({
+                    data: {
+                        type: 'xyz',
+                    },
+                    ports: [3000],
+                    source: null,
+                });
+            },
+        );
+        jest.spyOn(authService, 'fetchSessionInfoService').mockImplementation(
+            async () => ({
+                json: () => ({
+                    ...mockSessionInfo,
+                    releaseVersion: version,
+                }),
+                status: 200,
+            }),
+        );
+        jest.spyOn(authInstance, 'getReleaseVersion').mockReturnValue(version);
+    }
+    beforeEach(() => {
+        document.body.innerHTML = getDocumentBody();
+        jest.spyOn(baseInstance, 'getAuthPromise').mockResolvedValue(true);
+    });
+
+    afterEach(() => {
+        jest.clearAllMocks();
+    });
+
+    test('when releaseVersion is empty', async () => {
+        setupVersion('');
+        const mockAlert = spyOn(window, 'alert');
+        const searchEmbed = new SearchEmbed(getRootEl(), {});
+        await searchEmbed.render();
+        expect(mockAlert).not.toBeCalled();
+    });
+
+    test("when releaseVersion is '7.0.1.cl' ", async () => {
+        setupVersion('7.0.1.cl');
+        const mockAlert = jest.spyOn(window, 'alert');
+        const searchEmbed = new SearchEmbed(getRootEl(), {});
+        await searchEmbed.render();
+        expect(mockAlert).not.toBeCalled();
+    });
+    test('when releaseVersion is above 8.4.0.sw', async () => {
+        setupVersion('8.4.0.sw');
+        const mockAlert = jest.spyOn(window, 'alert');
+        const searchEmbed = new SearchEmbed(getRootEl(), {});
+        await searchEmbed.render();
+        expect(mockAlert).not.toBeCalled();
+    });
+
+    test('releaseVersion is above 8.4.0.sw', async () => {
+        setupVersion('8.8.0.sw');
+        jest.spyOn(config, 'getThoughtSpotHost').mockImplementation(
+            () => 'http://tshost',
+        );
+        const mockAlert = jest.spyOn(window, 'alert');
+        const searchEmbed = new SearchEmbed(getRootEl(), {});
+        await searchEmbed.render();
+        expect(mockAlert).not.toBeCalled();
+    });
+
+    test('Alert should not appear when suppressSearchEmbedBetaWarning is true and releaseVersion is ts7.dec.cl', async () => {
+        setupVersion('ts7.dec.cl');
+        jest.spyOn(config, 'getThoughtSpotHost').mockImplementation(
+            () => 'http://tshost',
+        );
+        jest.spyOn(baseInstance, 'getEmbedConfig').mockReturnValue({
+            suppressSearchEmbedBetaWarning: true,
+        });
+        const mockAlert = jest.spyOn(window, 'alert');
+        const searchEmbed = new SearchEmbed(getRootEl(), {});
+        await searchEmbed.render();
+        expect(mockAlert).not.toBeCalled();
+    });
+
+    test('Alert should not appear when suppressSearchEmbedBetaWarning is true and releaseVersion is 8.4.0.sw', async () => {
+        setupVersion('8.4.0.sw');
+        jest.spyOn(config, 'getThoughtSpotHost').mockImplementation(
+            () => 'http://tshost',
+        );
+        jest.spyOn(baseInstance, 'getEmbedConfig').mockReturnValue({
+            suppressSearchEmbedBetaWarning: true,
+        });
+        const mockAlert = jest.spyOn(window, 'alert');
+        const searchEmbed = new SearchEmbed(getRootEl(), {});
+        await searchEmbed.render();
+        expect(mockAlert).not.toBeCalled();
+    });
+});

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

@@ -34,9 +34,13 @@ 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';
 
+beforeAll(() => {
+    spyOn(window, 'alert');
+});
+
 describe('Unit test case for ts embed', () => {
     const mockMixPanelEvent = jest.spyOn(
         mixpanelInstance,
@@ -261,7 +265,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, 'log');
+            spyOn(console, 'error');
             const pinboardEmbed = new PinboardEmbed(getRootEl(), {
                 hiddenActions: [Action.DownloadAsCsv],
                 visibleActions: [Action.DownloadAsCsv],
@@ -270,7 +274,7 @@ describe('Unit test case for ts embed', () => {
             } as LiveboardViewConfig);
             await pinboardEmbed.render();
             expect(pinboardEmbed['isError']).toBe(true);
-            expect(console.log).toHaveBeenCalledWith(
+            expect(console.error).toHaveBeenCalledWith(
                 'You cannot have both hidden actions and visible actions',
             );
         });
@@ -288,7 +292,7 @@ describe('Unit test case for ts embed', () => {
             hiddenActions: Array<Action>,
             visibleActions: Array<Action>,
         ) {
-            spyOn(console, 'log');
+            spyOn(console, 'error');
             const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
                 hiddenActions,
                 visibleActions,
@@ -297,7 +301,7 @@ describe('Unit test case for ts embed', () => {
             } as LiveboardViewConfig);
             await liveboardEmbed.render();
             expect(liveboardEmbed['isError']).toBe(true);
-            expect(console.log).toHaveBeenCalledWith(
+            expect(console.error).toHaveBeenCalledWith(
                 'You cannot have both hidden actions and visible actions',
             );
         }
@@ -346,14 +350,19 @@ describe('Unit test case for ts embed', () => {
         });
 
         test('Error should be true', async () => {
+            spyOn(console, 'error');
             const tsEmbed = new SearchEmbed(getRootEl(), {});
             tsEmbed.render();
             expect(tsEmbed['isError']).toBe(true);
+            expect(console.error).toHaveBeenCalledWith(
+                'You need to init the ThoughtSpot SDK module first',
+            );
         });
     });
 
     describe('V1Embed ', () => {
         test('when isRendered is true than isError will be true', () => {
+            spyOn(console, 'error');
             const viEmbedIns = new tsEmbedInstance.V1Embed(
                 getRootEl(),
                 defaultViewConfig,
@@ -362,11 +371,15 @@ describe('Unit test case for ts embed', () => {
             viEmbedIns.render();
             viEmbedIns.on(EmbedEvent.CustomAction, jest.fn()).render();
             expect(viEmbedIns['isError']).toBe(true);
+            expect(console.error).toHaveBeenCalledWith(
+                'Please register event handlers before calling render',
+            );
         });
     });
 
     describe('Navigate to Page API', () => {
         const path = 'viz/e0836cad-4fdf-42d4-bd97-567a6b2a6058';
+
         beforeEach(() => {
             jest.spyOn(config, 'getThoughtSpotHost').mockImplementation(
                 () => 'http://tshost',
@@ -415,6 +428,7 @@ describe('Unit test case for ts embed', () => {
     });
     describe('Navigate to Page API - Pinboard', () => {
         const path = 'pinboard/e0836cad-4fdf-42d4-bd97-567a6b2a6058';
+
         beforeEach(() => {
             jest.spyOn(config, 'getThoughtSpotHost').mockImplementation(
                 () => 'http://tshost',

package/src/embed/ts-embed.ts

@@ -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
@@ -242,7 +244,7 @@ export class TsEmbed {
             error,
         });
         // Log error
-        console.log(error);
+        console.error(error);
     }
 
     /**
@@ -382,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;
         }

package/src/errors.ts

@@ -4,4 +4,6 @@ export const ERROR_MESSAGE = {
     LIVEBOARD_VIZ_ID_VALIDATION:
         'Please provide either liveboardId or pinboardId',
     TRIGGER_TIMED_OUT: 'Trigger timedout in getting response',
+    SEARCHEMBED_BETA_WRANING_MESSAGE:
+        'Search Embed is in Beta in this release.',
 };

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,
@@ -11,7 +12,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';
@@ -21,6 +22,7 @@ beforeAll(() => {
         thoughtSpotHost,
         authType: AuthType.None,
     });
+    spyOn(window, 'alert');
 });
 
 describe('React Components', () => {
@@ -38,7 +40,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/react/index.tsx

@@ -1,4 +1,5 @@
 import React from 'react';
+import useDeepCompareEffect from 'use-deep-compare-effect';
 import { SearchEmbed as _SearchEmbed, SearchViewConfig } from '../embed/search';
 import { AppEmbed as _AppEmbed, AppViewConfig } from '../embed/app';
 import {
@@ -25,7 +26,7 @@ const componentFactory = <
                 Omit<U, 'className'>,
                 V
             >(embedProps);
-            React.useEffect(() => {
+            useDeepCompareEffect(() => {
                 const tsEmbed = new EmbedConstructor(ref!.current, {
                     ...viewConfig,
                 });
@@ -40,7 +41,7 @@ const componentFactory = <
                     // eslint-disable-next-line no-param-reassign
                     forwardedRef.current = tsEmbed;
                 }
-            }, [embedProps]);
+            }, [viewConfig, listeners]);
 
             return (
                 <div

package/src/types.ts

@@ -177,6 +177,12 @@ export interface EmbedConfig {
      * @version SDK: 1.10.4 | ThoughtSpot: *
      */
     detectCookieAccessSlow?: boolean;
+    /**
+     * Hide beta alert warning message for SearchEmbed.
+     *
+     * @version SDK: 1.12.0 | ThoughtSpot: *
+     */
+    suppressSearchEmbedBetaWarning?: boolean;
 }
 
 /**
@@ -613,6 +619,13 @@ export enum HostEvent {
      * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl
      */
     getExportRequestForCurrentPinboard = 'getExportRequestForCurrentPinboard',
+    /**
+     * Fires the pin action on an embedded object
+     * @param - incase of liveboard embed, takes in an object with vizId as a key
+     * can be left empty for search and viz embeds
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    Pin = 'pin',
 }
 
 /**
@@ -813,6 +826,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.spec.ts

@@ -9,6 +9,7 @@ import {
     getEncodedQueryParamsString,
     appendToUrlHash,
     getRedirectUrl,
+    checkReleaseVersionInBeta,
 } from './utils';
 import { RuntimeFilterOp } from './types';
 
@@ -110,4 +111,32 @@ describe('unit test for utils', () => {
         expect(getEncodedQueryParamsString('')).toBe('');
         expect(getEncodedQueryParamsString('test')).toBe('dGVzdA');
     });
+
+    test('when ReleaseVersion is empty ', () => {
+        expect(checkReleaseVersionInBeta('', false)).toBe(false);
+    });
+
+    test('when ReleaseVersion is 7.0.1.cl ', () => {
+        expect(checkReleaseVersionInBeta('7.0.1.cl', false)).toBe(false);
+    });
+
+    test('when cluster has dev version', () => {
+        expect(checkReleaseVersionInBeta('dev', false)).toBe(false);
+    });
+
+    test('when cluster is above 8.4.0.cl-11 software version', () => {
+        expect(checkReleaseVersionInBeta('8.4.0.cl-117', false)).toBe(false);
+    });
+
+    test('when cluster is bellow 8.0.0.sw software version', () => {
+        expect(checkReleaseVersionInBeta('7.2.1.sw', false)).toBe(true);
+    });
+
+    test('when suppressBetaWarning is true and ReleaseVersion is 7.0.1', () => {
+        expect(checkReleaseVersionInBeta('7.0.1', true)).toBe(false);
+    });
+
+    test('when suppressBetaWarning is false ReleaseVersion is 7.0.1', () => {
+        expect(checkReleaseVersionInBeta('7.0.1', false)).toBe(true);
+    });
 });

package/src/utils.ts

@@ -154,3 +154,19 @@ export const setAttributes = (
         element.setAttribute(key, attributes[key].toString());
     });
 };
+
+const isCloudRelease = (version: string) => version.endsWith('.cl');
+
+/* For Search Embed: ReleaseVersionInBeta */
+export const checkReleaseVersionInBeta = (
+    releaseVersion: string,
+    suppressBetaWarning: boolean,
+): boolean => {
+    if (releaseVersion !== '' && !isCloudRelease(releaseVersion)) {
+        const splittedReleaseVersion = releaseVersion.split('.');
+        const majorVersion = Number(splittedReleaseVersion[0]);
+        const isBetaVersion = majorVersion < 8;
+        return !suppressBetaWarning && isBetaVersion;
+    }
+    return false;
+};