@thoughtspot/visual-embed-sdk 1.51.1 → 1.52.0

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

@@ -31,6 +31,7 @@ import {
     DefaultAppInitData,
     ErrorDetailsTypes,
     EmbedErrorCodes,
+    EmbedErrorSeverity,
     ContextObject,
 } from '../types';
 import {
@@ -1897,9 +1898,62 @@ describe('Unit test case for ts embed', () => {
                 errorType: ErrorDetailsTypes.VALIDATION_ERROR,
                 message: ERROR_MESSAGE.INIT_SDK_REQUIRED,
                 code: EmbedErrorCodes.INIT_ERROR,
+                severity: EmbedErrorSeverity.SEV1,
                 error: ERROR_MESSAGE.INIT_SDK_REQUIRED,
             });
         });
+
+        test('a missing init is reported to the host as SEV1', async () => {
+            const errorHandler = jest.fn();
+            const tsEmbed = new SearchEmbed(getRootEl(), {});
+            tsEmbed.on(EmbedEvent.Error, errorHandler);
+            await tsEmbed.render();
+            expect(errorHandler.mock.calls[0][0]).toEqual(
+                expect.objectContaining({
+                    code: EmbedErrorCodes.INIT_ERROR,
+                    severity: EmbedErrorSeverity.SEV1,
+                }),
+            );
+        });
+    });
+
+    describe('error severity', () => {
+        beforeEach(() => {
+            jest.spyOn(config, 'getThoughtSpotHost').mockImplementation(() => 'http://tshost');
+        });
+
+        test('defaults to SEV3 when the raising site does not set one', () => {
+            const errorHandler = jest.fn();
+            const tsEmbed = new SearchEmbed(getRootEl(), {});
+            tsEmbed.on(EmbedEvent.Error, errorHandler);
+
+            (tsEmbed as any).handleError({
+                errorType: ErrorDetailsTypes.VALIDATION_ERROR,
+                message: 'no severity set',
+                code: EmbedErrorCodes.HOST_EVENT_VALIDATION,
+            });
+
+            expect(errorHandler.mock.calls[0][0]).toEqual(
+                expect.objectContaining({ severity: EmbedErrorSeverity.SEV3 }),
+            );
+        });
+
+        test('does not override a severity the raising site set', () => {
+            const errorHandler = jest.fn();
+            const tsEmbed = new SearchEmbed(getRootEl(), {});
+            tsEmbed.on(EmbedEvent.Error, errorHandler);
+
+            (tsEmbed as any).handleError({
+                errorType: ErrorDetailsTypes.VALIDATION_ERROR,
+                message: 'explicitly fatal',
+                code: EmbedErrorCodes.HOST_EVENT_VALIDATION,
+                severity: EmbedErrorSeverity.SEV1,
+            });
+
+            expect(errorHandler.mock.calls[0][0]).toEqual(
+                expect.objectContaining({ severity: EmbedErrorSeverity.SEV1 }),
+            );
+        });
     });
 
     describe('V1Embed ', () => {
@@ -3540,13 +3594,13 @@ describe('Unit test case for ts embed', () => {
                 libEmbed.destroy();
             });
 
-            it('should use preRenderConfig.preRenderId to identify the pre-render instance', async () => {
+            it('should use preRenderConfig.id to identify the pre-render instance', async () => {
                 createRootEleForEmbed();
 
                 const libEmbed = new LiveboardEmbed('#tsEmbedDiv', {
                     liveboardId: 'myLiveboardId',
                     preRenderConfig: {
-                        preRenderId: 'config-level-id',
+                        id: 'config-level-id',
                     },
                 });
 
@@ -3560,14 +3614,14 @@ describe('Unit test case for ts embed', () => {
                 libEmbed.destroy();
             });
 
-            it('should prefer preRenderConfig.preRenderId over top-level preRenderId', async () => {
+            it('should prefer preRenderConfig.id over top-level preRenderId', async () => {
                 createRootEleForEmbed();
 
                 const libEmbed = new LiveboardEmbed('#tsEmbedDiv', {
                     liveboardId: 'myLiveboardId',
                     preRenderId: 'top-level-id',
                     preRenderConfig: {
-                        preRenderId: 'config-level-id',
+                        id: 'config-level-id',
                     },
                 });
 
@@ -3581,7 +3635,7 @@ describe('Unit test case for ts embed', () => {
                 libEmbed.destroy();
             });
 
-            it('should mount the wrapper into preRenderConfig.preRenderContainer', async () => {
+            it('should mount the wrapper into preRenderConfig.containerSelector', async () => {
                 createRootEleForEmbed();
                 const customContainer = document.createElement('div');
                 customContainer.id = 'config-level-container';
@@ -3590,8 +3644,8 @@ describe('Unit test case for ts embed', () => {
                 const libEmbed = new LiveboardEmbed('#tsEmbedDiv', {
                     liveboardId: 'myLiveboardId',
                     preRenderConfig: {
-                        preRenderId: 'container-via-config',
-                        preRenderContainer: '#config-level-container',
+                        id: 'container-via-config',
+                        containerSelector: '#config-level-container',
                     },
                 });
 
@@ -3606,7 +3660,7 @@ describe('Unit test case for ts embed', () => {
                 customContainer.remove();
             });
 
-            it('should prefer preRenderConfig.preRenderContainer over top-level preRenderContainer', async () => {
+            it('should prefer preRenderConfig.containerSelector over top-level preRenderContainer', async () => {
                 createRootEleForEmbed();
                 const topContainer = document.createElement('div');
                 topContainer.id = 'top-level-container';
@@ -3619,8 +3673,8 @@ describe('Unit test case for ts embed', () => {
                     liveboardId: 'myLiveboardId',
                     preRenderContainer: '#top-level-container',
                     preRenderConfig: {
-                        preRenderId: 'container-precedence',
-                        preRenderContainer: '#config-level-container-2',
+                        id: 'container-precedence',
+                        containerSelector: '#config-level-container-2',
                     },
                 });
 
@@ -3637,7 +3691,7 @@ describe('Unit test case for ts embed', () => {
                 configContainer.remove();
             });
 
-            it('should not attach ResizeObserver when preRenderConfig.doNotTrackPreRenderSize is true', async () => {
+            it('should not attach ResizeObserver when preRenderConfig.doNotTrackSize is true', async () => {
                 createRootEleForEmbed();
                 const observeMock = jest.fn();
                 (window as any).ResizeObserver = jest.fn().mockImplementation(() => ({
@@ -3649,8 +3703,8 @@ describe('Unit test case for ts embed', () => {
                 const libEmbed = new LiveboardEmbed('#tsEmbedDiv', {
                     liveboardId: 'myLiveboardId',
                     preRenderConfig: {
-                        preRenderId: 'no-track-via-config',
-                        doNotTrackPreRenderSize: true,
+                        id: 'no-track-via-config',
+                        doNotTrackSize: true,
                     },
                 });
 
@@ -3663,7 +3717,7 @@ describe('Unit test case for ts embed', () => {
                 libEmbed.destroy();
             });
 
-            it('should prefer preRenderConfig.doNotTrackPreRenderSize over top-level doNotTrackPreRenderSize', async () => {
+            it('should prefer preRenderConfig.doNotTrackSize over top-level doNotTrackPreRenderSize', async () => {
                 createRootEleForEmbed();
                 const observeMock = jest.fn();
                 (window as any).ResizeObserver = jest.fn().mockImplementation(() => ({
@@ -3676,8 +3730,8 @@ describe('Unit test case for ts embed', () => {
                     liveboardId: 'myLiveboardId',
                     doNotTrackPreRenderSize: false,
                     preRenderConfig: {
-                        preRenderId: 'no-track-precedence',
-                        doNotTrackPreRenderSize: true,
+                        id: 'no-track-precedence',
+                        doNotTrackSize: true,
                     },
                 });
 

package/src/embed/ts-embed.ts

@@ -38,6 +38,7 @@ import {
     isUndefined,
     getHostEventsConfig,
     getValueFromWindow,
+    deserializeParam,
 } from '../utils';
 import { getCustomActions } from '../utils/custom-actions';
 import {
@@ -62,6 +63,7 @@ import {
     DefaultAppInitData,
     AllEmbedViewConfig as ViewConfig,
     EmbedErrorDetailsEvent,
+    EmbedErrorSeverity,
     ErrorDetailsTypes,
     EmbedErrorCodes,
     MessagePayload,
@@ -283,6 +285,7 @@ export class TsEmbed {
             errorType: ErrorDetailsTypes.VALIDATION_ERROR,
             message: ERROR_MESSAGE.INIT_SDK_REQUIRED,
             code: EmbedErrorCodes.INIT_ERROR,
+            severity: EmbedErrorSeverity.SEV1,
             error: ERROR_MESSAGE.INIT_SDK_REQUIRED,
         });
     }
@@ -294,7 +297,10 @@ export class TsEmbed {
      */
     protected handleError(errorDetails: EmbedErrorDetailsEvent) {
         this.isError = true;
-        this.executeCallbacks(EmbedEvent.Error, errorDetails);
+        this.executeCallbacks(EmbedEvent.Error, {
+            severity: EmbedErrorSeverity.SEV3,
+            ...errorDetails,
+        });
         // Log error
         logger.error(errorDetails);
     }
@@ -392,6 +398,7 @@ export class TsEmbed {
                 errorType: ErrorDetailsTypes.NETWORK,
                 message: ERROR_MESSAGE.OFFLINE_WARNING,
                 code: EmbedErrorCodes.NETWORK_ERROR,
+                severity: EmbedErrorSeverity.SEV2,
                 offlineWarning: ERROR_MESSAGE.OFFLINE_WARNING,
             };
             this.executeCallbacks(EmbedEvent.Error, errorDetails);
@@ -706,11 +713,14 @@ export class TsEmbed {
     }
 
     protected async getUpdateEmbedParamsObject() {
-        let queryParams = this.getEmbedParamsObject();
+        const queryParams = this.getEmbedParamsObject();
+        // Values are URL-serialized (e.g. dataSources as '["guid"]'); parse
+        // them back so the event payload matches a URL load (SCAL-334713).
+        Object.keys(queryParams).forEach((key) => {
+            queryParams[key] = deserializeParam(queryParams[key]);
+        });
         const appInitData = await this.getAppInitData();
-        queryParams = { ...this.viewConfig, ...queryParams, ...appInitData };
-
-        return queryParams;
+        return { ...this.viewConfig, ...queryParams, ...appInitData };
     }
 
     /**
@@ -963,18 +973,19 @@ export class TsEmbed {
     }
 
     /**
-     * Returns a merged {@link PreRenderConfig} object where each shared key
-     * prefers `preRenderConfig.key` over the top-level `viewConfig.key` for
-     * backward compatibility.
+     * Returns a merged {@link PreRenderConfig} object where each key prefers the
+     * value from `preRenderConfig` over its deprecated top-level `viewConfig`
+     * counterpart (`id`/`preRenderId`, `containerSelector`/`preRenderContainer`,
+     * `doNotTrackSize`/`doNotTrackPreRenderSize`) for backward compatibility.
      */
     protected getPreRenderConfig(): PreRenderConfig {
         const viewCfg = this.viewConfig as BaseViewConfig;
         const preRenderCfg = viewCfg.preRenderConfig ?? {};
         return {
             ...preRenderCfg,
-            preRenderId: preRenderCfg.preRenderId ?? viewCfg.preRenderId,
-            preRenderContainer: preRenderCfg.preRenderContainer ?? viewCfg.preRenderContainer,
-            doNotTrackPreRenderSize: preRenderCfg.doNotTrackPreRenderSize ?? viewCfg.doNotTrackPreRenderSize,
+            id: preRenderCfg.id ?? viewCfg.preRenderId,
+            containerSelector: preRenderCfg.containerSelector ?? viewCfg.preRenderContainer,
+            doNotTrackSize: preRenderCfg.doNotTrackSize ?? viewCfg.doNotTrackPreRenderSize,
         };
     }
 
@@ -982,7 +993,7 @@ export class TsEmbed {
      * Returns true if this embed instance is configured for pre-rendering.
      */
     protected isPreRenderEmbed() {
-        return !!this.getPreRenderConfig().preRenderId;
+        return !!this.getPreRenderConfig().id;
     }
     protected handleInsertionIntoDOM(child: string | Node): void {
         if (this.isPreRenderEmbed()) {
@@ -1088,6 +1099,7 @@ export class TsEmbed {
                         errorType: ErrorDetailsTypes.API,
                         message: error.message || ERROR_MESSAGE.LOGIN_FAILED,
                         code: EmbedErrorCodes.LOGIN_FAILED,
+                        severity: EmbedErrorSeverity.SEV1,
                         error: error,
                     });
                 });
@@ -1196,7 +1208,7 @@ export class TsEmbed {
      * fresh element; an element passed directly cannot be re-resolved.
      */
     private resolvePreRenderContainerTarget(): HTMLElement {
-        const containerConfig = this.getPreRenderConfig().preRenderContainer;
+        const containerConfig = this.getPreRenderConfig().containerSelector;
         let container: Element | null = null;
         if (typeof containerConfig === 'string') {
             try {
@@ -1220,7 +1232,7 @@ export class TsEmbed {
         }
         const ownerContainer = preRenderedObject.preRenderContainerEl ?? document.body;
         if (
-            this.getPreRenderConfig().preRenderContainer
+            this.getPreRenderConfig().containerSelector
             && this.resolvePreRenderContainerTarget() !== ownerContainer
         ) {
             logger.warn(
@@ -1846,7 +1858,7 @@ export class TsEmbed {
             showPreRenderByDefault,
             replaceExistingPreRender,
         });
-        if (!this.getPreRenderConfig().preRenderId) {
+        if (!this.getPreRenderConfig().id) {
             logger.error(ERROR_MESSAGE.PRERENDER_ID_MISSING);
             return this;
         }
@@ -2032,14 +2044,14 @@ export class TsEmbed {
      */
     public async showPreRender(): Promise<TsEmbed> {
         uploadMixpanelEvent(MIXPANEL_EVENT.VISUAL_SDK_SHOW_PRE_RENDER, {
-            preRenderId: this.getPreRenderConfig().preRenderId,
+            preRenderId: this.getPreRenderConfig().id,
             embedComponentType: this.viewConfig.embedComponentType,
         });
 
         if (this.shouldWaitForRenderPromise) await this.isReadyForRenderPromise;
 
 
-        if (!this.getPreRenderConfig().preRenderId) {
+        if (!this.getPreRenderConfig().id) {
             logger.error(ERROR_MESSAGE.PRERENDER_ID_MISSING);
             return this;
         }
@@ -2081,7 +2093,7 @@ export class TsEmbed {
                 customContainer.addEventListener('scroll', this.containerScrollListener);
             }
 
-            if (!this.getPreRenderConfig().doNotTrackPreRenderSize) {
+            if (!this.getPreRenderConfig().doNotTrackSize) {
                 const observeTarget = (this.insertedDomEl as HTMLElement) ?? this.hostElement;
                 this.resizeObserver = new ResizeObserver((entries) => {
                     entries.forEach((entry) => {
@@ -2156,7 +2168,7 @@ export class TsEmbed {
      */
     public hidePreRender(): void {
         uploadMixpanelEvent(MIXPANEL_EVENT.VISUAL_SDK_HIDE_PRE_RENDER, {
-            preRenderId: this.getPreRenderConfig().preRenderId,
+            preRenderId: this.getPreRenderConfig().id,
             embedComponentType: this.viewConfig.embedComponentType,
         });
 
@@ -2200,7 +2212,7 @@ export class TsEmbed {
      * @property {string} child - The HTML element ID for the PreRender child.
      */
     public getPreRenderIds() {
-        const preRenderId = this.getPreRenderConfig().preRenderId;
+        const preRenderId = this.getPreRenderConfig().id;
         return {
             wrapper: `${PRERENDER_WRAPPER_ID_PREFIX}${preRenderId}`,
             child: `tsEmbed-pre-render-child-${preRenderId}`,

package/src/index.ts

@@ -69,6 +69,7 @@ import {
     InterceptedApiType,
     EmbedErrorCodes,
     EmbedErrorDetailsEvent,
+    EmbedErrorSeverity,
     ErrorDetailsTypes,
     ContextType,
     AutoMCPFrameRendererViewConfig,
@@ -218,6 +219,7 @@ export {
     InterceptedApiType,
     EmbedErrorCodes,
     EmbedErrorDetailsEvent,
+    EmbedErrorSeverity,
     ErrorDetailsTypes,
     AutoMCPFrameRendererViewConfig,
     VisualizationOverrides,

package/src/react/all-types-export.ts

@@ -75,6 +75,7 @@ export {
     LiveboardParameter,
     DataPanelCustomColumnGroupsAccordionState,
     InterceptedApiType,
+    EmbedErrorSeverity,
     CustomActionsPosition,
     CustomActionTarget,
     SpotterAnalystConfig,

package/src/react/index.spec.tsx

@@ -358,10 +358,10 @@ describe('React Components', () => {
                 ].forEach((spy) => spy.mockRestore());
             });
 
-            it('Should preRender PreRenderedLiveboardEmbed with preRenderConfig.preRenderId', () => {
+            it('Should preRender PreRenderedLiveboardEmbed with preRenderConfig.id', () => {
                 render(
                     <PreRenderedLiveboardEmbed
-                        preRenderConfig={{ preRenderId }}
+                        preRenderConfig={{ id: preRenderId }}
                         liveboardId="test-liveboard"
                     />,
                 );
@@ -386,7 +386,7 @@ describe('React Components', () => {
             it('Should showPreRender the LiveboardEmbed connected via preRenderConfig', () => {
                 const { unmount } = render(
                     <LiveboardEmbed
-                        preRenderConfig={{ preRenderId }}
+                        preRenderConfig={{ id: preRenderId }}
                         liveboardId="test-liveboard"
                     />,
                 );
@@ -447,10 +447,10 @@ describe('React Components', () => {
                     .forEach((el) => el.remove());
             });
 
-            it('Should create the wrapper with preRenderConfig.preRenderId', async () => {
+            it('Should create the wrapper with preRenderConfig.id', async () => {
                 render(
                     <PreRenderedLiveboardEmbed
-                        preRenderConfig={{ preRenderId }}
+                        preRenderConfig={{ id: preRenderId }}
                         liveboardId="test-liveboard"
                     />,
                 );
@@ -458,11 +458,11 @@ describe('React Components', () => {
                 await waitFor(() => expect(document.getElementById(wrapperId(preRenderId))).not.toBe(null));
             });
 
-            it('Should prefer preRenderConfig.preRenderId over the top-level preRenderId', async () => {
+            it('Should prefer preRenderConfig.id over the top-level preRenderId', async () => {
                 render(
                     <PreRenderedLiveboardEmbed
                         preRenderId="top-level-pre-render-id"
-                        preRenderConfig={{ preRenderId: 'config-pre-render-id' }}
+                        preRenderConfig={{ id: 'config-pre-render-id' }}
                         liveboardId="test-liveboard"
                     />,
                 );

package/src/react/index.tsx

@@ -34,7 +34,7 @@ const componentFactory = <T extends typeof TsEmbed, U extends EmbedProps, V exte
             const { viewConfig, listeners } = getViewPropsAndListeners<Omit<U, 'className' | 'style'>, V>(
                 embedProps,
             );
-            const preRenderId = props.preRenderConfig?.preRenderId ?? props.preRenderId;
+            const preRenderId = props.preRenderConfig?.id ?? props.preRenderId;
 
             const handleDestroy = (tsEmbed: InstanceType<T>) => {
                 // do not destroy if it is a preRender component
@@ -116,9 +116,9 @@ interface SearchProps extends EmbedProps, SearchViewConfig { }
 
 /**
  * The PreRendered components require a preRender id. It can be supplied either
- * through `preRenderConfig.preRenderId` (SDK: 1.52.0 and later) or through the
+ * through `preRenderConfig.id` (SDK: 1.52.0 and later) or through the
  * top-level `preRenderId` prop (SDK: 1.25.0 and later, now deprecated).
- * `preRenderConfig.preRenderId` takes precedence when both are set.
+ * `preRenderConfig.id` takes precedence when both are set.
  *
  * Use PreRender to render the embed in the background and then
  * show or hide the rendered embed using showPreRender or hidePreRender respectively.
@@ -127,14 +127,14 @@ interface SearchProps extends EmbedProps, SearchViewConfig { }
  * // Preferred, SDK: 1.52.0 and later.
  * function LandingPageComponent() {
  *  return <PreRenderedLiveboardEmbed
- *      preRenderConfig={{ preRenderId: "someId" }}
+ *      preRenderConfig={{ id: "someId" }}
  *      liveboardId="libId"
  *  />
  * }
  *
  * function MyComponent() {
  *  return <LiveboardEmbed
- *      preRenderConfig={{ preRenderId: "someId" }}
+ *      preRenderConfig={{ id: "someId" }}
  *      liveboardId="libId"
  *  />
  * }
@@ -152,7 +152,7 @@ type PreRenderProps =
         /**
          * PreRender id to be used for PreRendering the embed.
          * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl
-         * @deprecated Use `preRenderConfig.preRenderId` instead.
+         * @deprecated Use `preRenderConfig.id` instead.
          */
         preRenderId: string;
         /**
@@ -166,16 +166,16 @@ type PreRenderProps =
         /**
          * PreRender id to be used for PreRendering the embed.
          * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl
-         * @deprecated Use `preRenderConfig.preRenderId` instead.
+         * @deprecated Use `preRenderConfig.id` instead.
          */
         preRenderId?: string;
         /**
-         * Configuration for the pre-render wrapper element. `preRenderId` is
+         * Configuration for the pre-render wrapper element. `id` is
          * required here when the top-level `preRenderId` prop is not passed.
          * See {@link PreRenderConfig} for available options.
          * @version SDK: 1.52.0
          */
-        preRenderConfig: PreRenderConfig & { preRenderId: string };
+        preRenderConfig: PreRenderConfig & { id: string };
     };
 
 /**