@thoughtspot/visual-embed-sdk 1.40.1 → 1.40.3

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

@@ -2,7 +2,7 @@ import { resetValueFromWindow } from '../utils';
 import { ERROR_MESSAGE } from '../errors';
 import { resetCachedAuthToken } from '../authToken';
 import { AuthType, init, EmbedEvent, SearchEmbed, PinboardEmbed, AppEmbed, LiveboardEmbed, SageEmbed, AnswerService, } from '../index';
-import { Action, HomeLeftNavItem, RuntimeFilterOp, HomepageModule, HostEvent, ContextMenuTriggerOptions, } from '../types';
+import { Action, HomeLeftNavItem, RuntimeFilterOp, HomepageModule, HostEvent, ContextMenuTriggerOptions, CustomActionTarget, CustomActionsPosition, } 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 embedConfig from './embedConfig';
@@ -253,6 +253,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
@@ -288,6 +289,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
@@ -328,6 +330,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [HomepageModule.MyLibrary, HomepageModule.Learning],
                         hiddenListColumns: [],
+                        customActions: [],
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
                     },
@@ -362,6 +365,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
                     },
@@ -401,6 +405,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         reorderedHomepageModules: [HomepageModule.MyLibrary, HomepageModule.Watchlist],
                         customVariablesForThirdPartyTools,
                     },
@@ -442,6 +447,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
@@ -485,6 +491,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
@@ -527,6 +534,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
@@ -570,6 +578,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
@@ -610,6 +619,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [HomeLeftNavItem.Home, HomeLeftNavItem.MonitorSubscription],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
                     },
@@ -755,6 +765,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools: {},
@@ -833,6 +844,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools: {},
@@ -864,6 +876,116 @@ describe('Unit test case for ts embed', () => {
             });
         });
     });
+    describe('getDefaultAppInitData with CustomActionsValidationResult', () => {
+        beforeEach(() => {
+            jest.spyOn(authInstance, 'doCookielessTokenAuth').mockResolvedValueOnce(true);
+            jest.spyOn(authService, 'verifyTokenService').mockResolvedValue(true);
+            init({
+                thoughtSpotHost: 'tshost',
+                authType: AuthType.TrustedAuthTokenCookieless,
+                getAuthToken: () => Promise.resolve('test_auth_token1'),
+            });
+        });
+        afterEach(() => {
+            baseInstance.reset();
+            jest.clearAllMocks();
+        });
+        test('should handle valid custom actions and sort them by name in getDefaultAppInitData', async () => {
+            const mockEmbedEventPayload = {
+                type: EmbedEvent.APP_INIT,
+                data: {},
+            };
+            // Create a SearchEmbed with valid custom actions to test
+            // CustomActionsValidationResult
+            const searchEmbed = new SearchEmbed(getRootEl(), {
+                ...defaultViewConfig,
+                customActions: [
+                    {
+                        id: 'action1',
+                        name: 'Valid Action',
+                        target: CustomActionTarget.LIVEBOARD,
+                        position: CustomActionsPosition.PRIMARY,
+                        metadataIds: { liveboardIds: ['lb123'] }
+                    },
+                    {
+                        id: 'action2',
+                        name: 'Another Valid Action',
+                        target: CustomActionTarget.VIZ,
+                        position: CustomActionsPosition.MENU,
+                        metadataIds: { vizIds: ['viz456'] }
+                    }
+                ]
+            });
+            searchEmbed.render();
+            const mockPort = {
+                postMessage: jest.fn(),
+            };
+            await executeAfterWait(() => {
+                const iframe = getIFrameEl();
+                postMessageToParent(iframe.contentWindow, mockEmbedEventPayload, mockPort);
+            });
+            await executeAfterWait(() => {
+                expect(mockPort.postMessage).toHaveBeenCalledWith({
+                    type: EmbedEvent.APP_INIT,
+                    data: {
+                        customisations: {
+                            content: {},
+                            style: {
+                                customCSS: {},
+                                customCSSUrl: undefined,
+                            },
+                        },
+                        authToken: 'test_auth_token1',
+                        runtimeFilterParams: null,
+                        runtimeParameterParams: null,
+                        hiddenHomeLeftNavItems: [],
+                        hiddenHomepageModules: [],
+                        hiddenListColumns: [],
+                        customActions: [
+                            {
+                                id: 'action2',
+                                name: 'Another Valid Action',
+                                target: CustomActionTarget.VIZ,
+                                position: CustomActionsPosition.MENU,
+                                metadataIds: { vizIds: ['viz456'] }
+                            },
+                            {
+                                id: 'action1',
+                                name: 'Valid Action',
+                                target: CustomActionTarget.LIVEBOARD,
+                                position: CustomActionsPosition.PRIMARY,
+                                metadataIds: { liveboardIds: ['lb123'] }
+                            }
+                        ],
+                        hostConfig: undefined,
+                        reorderedHomepageModules: [],
+                        customVariablesForThirdPartyTools: {},
+                    },
+                });
+                // Verify that CustomActionsValidationResult structure is
+                // correct
+                const appInitData = mockPort.postMessage.mock.calls[0][0].data;
+                expect(appInitData.customActions).toHaveLength(2);
+                expect(appInitData.customActions).toEqual(expect.arrayContaining([
+                    expect.objectContaining({
+                        id: 'action1',
+                        name: 'Valid Action',
+                        target: CustomActionTarget.LIVEBOARD,
+                        position: CustomActionsPosition.PRIMARY
+                    }),
+                    expect.objectContaining({
+                        id: 'action2',
+                        name: 'Another Valid Action',
+                        target: CustomActionTarget.VIZ,
+                        position: CustomActionsPosition.MENU
+                    })
+                ]));
+                // Verify actions are sorted by name (alphabetically)
+                expect(appInitData.customActions[0].name).toBe('Another Valid Action');
+                expect(appInitData.customActions[1].name).toBe('Valid Action');
+            });
+        });
+    });
     describe('Token fetch fails in cookieless authentication authType', () => {
         beforeEach(() => {
             jest.spyOn(authInstance, 'doCookielessTokenAuth').mockResolvedValueOnce(true);