@thoughtspot/visual-embed-sdk 1.52.2-beta → 1.52.2-beta.1

package/lib/src/visual-embed-sdk.d.ts

@@ -12335,7 +12335,7 @@ class TsEmbed {
 	private defaultHiddenActions;
 	private resizeObserver;
 	private preRenderContainerEl;
-	private containerScrollListener;
+	/** Last height the embedded app reported, once fullHeight has measured one. */
 	protected hostEventClient: HostEventClient;
 	protected isReadyForRenderPromise: Promise<void>;
 	protected shouldWaitForRenderPromise: boolean;
@@ -12550,7 +12550,6 @@ class TsEmbed {
 	protected getV1EmbedBasePath(queryString: string): string;
 	protected getEmbedParams(): string;
 	protected getEmbedParamsObject(): Record<any, any>;
-	protected getUrlQueryParamsObject(): Record<any, any>;
 	protected getRootIframeSrc(): string;
 	protected createIframeEl(frameSrc: string): HTMLIFrameElement;
 	/**
@@ -12592,10 +12591,26 @@ class TsEmbed {
 	 */
 	private createPreRenderPlaceholder;
 	/**
-	 * Resolves the configured preRenderContainer to a live element, falling
-	 * back to `document.body`. A string selector is re-queried on every call so
-	 * a remounted container (E.g.: React replacing the node) resolves to the
-	 * fresh element; an element passed directly cannot be re-resolved.
+	 * Resolves the configured preRenderContainer to a live element. A string
+	 * selector is re-queried on every call so a remounted container (E.g.: React
+	 * replacing the node) resolves to the fresh element; an element passed
+	 * directly cannot be re-resolved.
+	 *
+	 * With nothing configured the frame goes into the host element's nearest
+	 * scrolling ancestor, falling back to `document.body`.
+	 *
+	 * The wrapper is absolutely positioned, so it follows the page for free —
+	 * but only while it sits inside whatever scrolls. `document.body` is right
+	 * only when the document itself is the scroller; an app that scrolls an
+	 * inner element instead left the frame pinned to the viewport while the page
+	 * moved under it (SCAL-338563). Being inside the scroller also lets wheel
+	 * events chain out of the frame into it, which they cannot do from
+	 * `document.body`.
+	 *
+	 * A scrolling ancestor is layout chrome rather than route content, so it
+	 * outlives the embed in practice; and if it does go, the host element goes
+	 * with it and this instance is remounting anyway.
+	 * `reconcilePreRenderContainer` re-runs this on a detached container.
 	 */
 	private resolvePreRenderContainerTarget;
 	private inheritPreRenderContainer;
@@ -12612,8 +12627,9 @@ class TsEmbed {
 	 * Re-attaches the wrapper to a live container when the previously resolved
 	 * one has been detached or no longer holds the wrapper — e.g. the host app
 	 * remounted a custom preRenderContainer, which would otherwise leave a stale
-	 * reference and collapse the wrapper. Only string selectors can be
-	 * re-resolved; a container passed as an element is left untouched.
+	 * reference and collapse the wrapper. Selectors and the auto-resolved
+	 * scrolling ancestor are both re-resolved; a container passed as an element
+	 * is left untouched, as there is nothing to re-query.
 	 */
 	private reconcilePreRenderContainer;
 	protected insertIntoDOMForPreRender(child: string | Node): void;
@@ -12829,9 +12845,17 @@ class TsEmbed {
 	 */
 	private restorePreRenderContainerPosition;
 	/**
-	 * Detaches and clears the container scroll listener, if one is attached.
+	 * Re-sizes the wrapper when its placeholder changes size.
+	 *
+	 * Position deliberately has no equivalent. An absolutely positioned wrapper
+	 * follows its containing block for free, so a correctly placed frame is the
+	 * browser's job and costs nothing; repositioning it on scroll would mean a
+	 * layout read and a style write per frame to compensate for placing it in
+	 * the wrong box. Size is the one thing the browser will not do for us: the
+	 * placeholder grows when the embedded app reports a new height, and the
+	 * wrapper has to be told.
 	 */
-	private removeContainerScrollListener;
+	private observePreRenderSize;
 	/**
 	 * Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
 	 * @version SDK: 1.19.1 | ThoughtSpot: *
@@ -12847,8 +12871,6 @@ class TsEmbed {
 	 */
 	prerenderGeneric(): Promise<any>;
 	protected preRenderParamsApplied: Promise<void>;
-	protected isConfigExcludedFromUrl(): boolean;
-	protected triggerUpdateEmbedParams(): Promise<void>;
 	protected beforePrerenderVisible(): void;
 	/**
 	 * Displays the pre-rendered component inside the host element.
@@ -15696,6 +15718,7 @@ export class LiveboardEmbed extends V1Embed {
 		personalizedViewId: string;
 	};
 	protected beforePrerenderVisible(): void;
+	private isSameEmbedConfig;
 	private isShowingLiveboardRoute;
 	protected handleRenderForPrerender(): Promise<TsEmbed>;
 	/**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.52.2-beta",
+    "version": "1.52.2-beta.1",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",
@@ -65,7 +65,7 @@
         "test": "npm run test-sdk",
         "posttest": "cat ./coverage/sdk/lcov.info | npx coveralls-next || echo 'Warning: Coveralls upload failed but not breaking the build.'",
         "is-publish-allowed": "node scripts/is-publish-allowed.js",
-        "prepublishOnly": "npm run is-publish-allowed && npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build",
+        "prepublishOnly": "npm run is-publish-allowed && npm run test && npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build",
         "check-size": "npm run build && size-limit",
         "publish-dev": "npm publish --tag dev",
         "publish-prod": "npm publish --tag latest",

package/src/embed/app.ts

@@ -991,7 +991,7 @@ export class AppEmbed extends V1Embed {
      * embedded Liveboard or visualization.
      */
     protected getEmbedParams() {
-        const params = this.getUrlQueryParamsObject();
+        const params = this.getEmbedParamsObject();
         return getQueryParamString(params, true);
     }
 

package/src/embed/auto-frame-renderer.ts

@@ -108,7 +108,7 @@ class AutoFrameRenderer extends TsEmbed {
      * @returns The constructed URL to use for the ThoughtSpot embed iframe.
      */
     private getMCPIframeSrc(sourceSrc: string) {
-        const queryParams = this.getUrlQueryParamsObject();
+        const queryParams = this.getEmbedParamsObject();
         const sourceURL = new URL(sourceSrc);
         const existingQueryParams = sourceURL.searchParams;
         const existingQueryParamsObject = Object.fromEntries(existingQueryParams);

package/src/embed/bodyless-conversation.ts

@@ -56,7 +56,7 @@ export class ConversationMessage extends TsEmbed {
             messageId,
         } = this.viewConfig;
         const path = 'conv-assist-answer';
-        const queryParams = this.getUrlQueryParamsObject();
+        const queryParams = this.getEmbedParamsObject();
 
         let query = '';
         const queryParamsString = getQueryParamString(queryParams, true);

package/src/embed/conversation.ts

@@ -931,7 +931,7 @@ export class SpotterEmbed extends TsEmbed {
         const path = sharedConversationId
             ? `insights/conv-assist/s/${encodeURIComponent(sharedConversationId)}`
             : 'insights/conv-assist';
-        const queryParams = this.getUrlQueryParamsObject();
+        const queryParams = this.getEmbedParamsObject();
 
         let query = '';
         const queryParamsString = getQueryParamString(queryParams, true);

package/src/embed/liveboard.spec.ts

@@ -2748,6 +2748,68 @@ describe('Liveboard/viz embed tests', () => {
             expect(navigateToLiveboardSpy).toHaveBeenCalled();
         });
 
+        test('should not route via home when a new instance shows an equal config', async () => {
+            const viewConfig = {
+                liveboardId,
+                vizId,
+                activeTabId,
+                ...defaultViewConfig,
+            };
+            const previous = new LiveboardEmbed(getRootEl(), { ...viewConfig, beforeRender: () => {} } as any);
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), { ...viewConfig, beforeRender: () => {} } as any);
+
+            // React constructs a new embed on every mount.
+            jest.spyOn(liveboardEmbed as any, 'getPreRenderObj').mockReturnValue(previous);
+            const triggerSpy = jest
+                .spyOn(liveboardEmbed, 'trigger')
+                .mockImplementation(() => Promise.resolve(undefined as any));
+            const navigateToLiveboardSpy = jest
+                .spyOn(liveboardEmbed, 'navigateToLiveboard')
+                .mockImplementation(() => Promise.resolve(undefined));
+
+            liveboardEmbed.isEmbedContainerLoaded = false;
+            liveboardEmbed['beforePrerenderVisible']();
+            liveboardEmbed.isEmbedContainerLoaded = true;
+            liveboardEmbed['executeEmbedContainerReadyCallbacks']();
+            await waitForPreRenderNavigate();
+
+            expect(triggerSpy).not.toHaveBeenCalledWith(HostEvent.Navigate, 'home');
+            expect(navigateToLiveboardSpy).toHaveBeenCalled();
+        });
+
+        test('should route via home when a new instance shows the same route with other filters', async () => {
+            const viewConfig = {
+                liveboardId,
+                vizId,
+                activeTabId,
+                ...defaultViewConfig,
+            };
+            const previous = new LiveboardEmbed(getRootEl(), {
+                ...viewConfig,
+                runtimeFilters: [{ columnName: 'region', operator: RuntimeFilterOp.EQ, values: ['east'] }],
+            });
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+                ...viewConfig,
+                runtimeFilters: [{ columnName: 'region', operator: RuntimeFilterOp.EQ, values: ['west'] }],
+            });
+
+            jest.spyOn(liveboardEmbed as any, 'getPreRenderObj').mockReturnValue(previous);
+            const triggerSpy = jest
+                .spyOn(liveboardEmbed, 'trigger')
+                .mockImplementation(() => Promise.resolve(undefined as any));
+            jest
+                .spyOn(liveboardEmbed, 'navigateToLiveboard')
+                .mockImplementation(() => Promise.resolve(undefined));
+
+            liveboardEmbed.isEmbedContainerLoaded = false;
+            liveboardEmbed['beforePrerenderVisible']();
+            liveboardEmbed.isEmbedContainerLoaded = true;
+            liveboardEmbed['executeEmbedContainerReadyCallbacks']();
+            await waitForHomeHopNavigate();
+
+            expect(triggerSpy).toHaveBeenCalledWith(HostEvent.Navigate, 'home');
+        });
+
         test('should not route via home when the pre-render is on another liveboard', async () => {
             const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
                 liveboardId,

package/src/embed/liveboard.ts

@@ -8,6 +8,7 @@
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
 
+import isEqualWith from 'lodash/isEqualWith';
 import { getPreview } from '../utils/graphql/preview-service';
 import { ERROR_MESSAGE } from '../errors';
 import {
@@ -599,7 +600,7 @@ export class LiveboardEmbed extends V1Embed {
      * embedded Liveboard or visualization.
      */
     protected getEmbedParams() {
-        const params = this.getUrlQueryParamsObject();
+        const params = this.getEmbedParamsObject();
         const queryParams = getQueryParamString(params, true);
         return queryParams;
     }
@@ -955,10 +956,12 @@ export class LiveboardEmbed extends V1Embed {
         super.beforePrerenderVisible();
 
         // Captured before showPreRender() hands the wrapper over to this
-        // instance. Itself means a hide/show, not a hand-over, so there is
-        // nothing stale to clear.
+        // instance. React builds a new instance per mount, so an equal config
+        // is a hide/show, not a hand-over: there is nothing stale to clear.
         const previous = this.getPreRenderObj<LiveboardEmbed>();
-        const showing = previous === this ? undefined : previous?.currentLiveboardState;
+        const showing = this.isSameEmbedConfig(previous)
+            ? undefined
+            : previous?.currentLiveboardState;
 
         this.executeAfterEmbedContainerLoaded(async () => {
             // Without this the params callback suspends on its await and
@@ -992,6 +995,17 @@ export class LiveboardEmbed extends V1Embed {
         });
     }
 
+    // Callbacks are compared as equal: React passes a fresh closure per render.
+    private isSameEmbedConfig(previous?: LiveboardEmbed): boolean {
+        if (!previous) return false;
+        if (previous === this) return true;
+        return isEqualWith(
+            previous.viewConfig,
+            this.viewConfig,
+            (a, b) => (typeof a === 'function' && typeof b === 'function' ? true : undefined),
+        );
+    }
+
     // The whole route, not just the liveboard id: the path is built from the
     // viz, tab and view too, so a same-liveboard show onto another tab is a
     // real navigation.

package/src/embed/search-bar.tsx

@@ -163,7 +163,7 @@ export class SearchBarEmbed extends TsEmbed {
      * @param dataSources A list of data source GUIDs
      */
     private getIFrameSrc() {
-        const queryParams = this.getUrlQueryParamsObject();
+        const queryParams = this.getEmbedParamsObject();
         const path = 'search-bar-embed';
        
         let query = '';

package/src/embed/search.spec.ts

@@ -854,29 +854,6 @@ test('should pass forceTable parameter when forceTable is true', async () => {
 });
 
 describe('SearchBarEmbed tests', () => {
-    test('should keep view config off the URL when excludeConfigFromURL is set', async () => {
-        const searchBarEmbed = new SearchBarEmbed(getRootEl() as any, {
-            ...defaultViewConfig,
-            dataSources: ['source-1', 'source-2'],
-            additionalFlags: { excludeConfigFromURL: true },
-        } as any);
-        searchBarEmbed.render();
-        await executeAfterWait(() => {
-            const iframeSrc = getIFrameSrc();
-
-            // Bootstrap params stay: the handshake, the embed marker that
-            // picks the app shell, and the data sources it boots against.
-            expect(iframeSrc).toContain('hostAppUrl=');
-            expect(iframeSrc).toContain('isSearchEmbed=true');
-            expect(iframeSrc).toContain('dataSources');
-
-            // The rest of the view config goes over
-            // HostEvent.UpdateEmbedParams.
-            expect(iframeSrc).not.toContain('hideAction');
-            expect(iframeSrc).not.toContain('useLastSelectedDataSource');
-        });
-    });
-
     test('should pass dataSources parameter when dataSources array is provided', async () => {
         const searchBarEmbed = new SearchBarEmbed(getRootEl() as any, {
             ...defaultViewConfig,

package/src/embed/search.ts

@@ -546,7 +546,7 @@ export class SearchEmbed extends TsEmbed {
             excludeRuntimeParametersfromURL,
             excludeRuntimeFiltersfromURL,
         } = this.viewConfig;
-        const queryParams = this.getUrlQueryParamsObject();
+        const queryParams = this.getEmbedParamsObject();
         let query = '';
         const queryParamsString = getQueryParamString(queryParams, true);
         if (queryParamsString) {