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

package/src/embed/ts-embed.ts

@@ -45,6 +45,7 @@ import {
     getHostEventsConfig,
     getValueFromWindow,
     deserializeParam,
+    getScrollableAncestors,
 } from '../utils';
 import { getCustomActions } from '../utils/custom-actions';
 import {
@@ -115,6 +116,9 @@ const TS_EMBED_ID = '_thoughtspot-embed';
  */
 const PRERENDER_CONTAINER_ORIGINAL_POSITION_KEY = 'tsEmbedOriginalPosition';
 const PRERENDER_WRAPPER_ID_PREFIX = 'tsEmbed-pre-render-wrapper-';
+const PRERENDER_PARKED_TRANSFORM = 'translateY(-100%)';
+/** The height createPreRenderWrapper() seeds before anything is measured. */
+const UNMEASURED_WRAPPER_HEIGHT = '100vh';
 
 // The container applies UpdateEmbedParams through React state, so a delivered
 // post is not the same as the params being in effect.
@@ -125,57 +129,6 @@ const UPDATE_EMBED_PARAMS_SETTLE_MS = 200;
 // truthy and parses to {}.
 const NO_RUNTIME_PARAMS = '&';
 
-/**
- * Query parameters that stay on the iframe `src` while config is excluded from
- * the URL, which is the default unless the embed sets the
- * `excludeConfigFromURL` additional flag to `false`. These are the parameters the
- * application shell needs before it can receive a postMessage at all: the
- * embed marker, the host application URL used to validate the message origin,
- * the SDK version, the flags that pick the authentication flow, and the
- * boot-time settings that would otherwise be applied a frame late (viewport,
- * log level, locale, formatting and org). Everything else is delivered over
- * `HostEvent.UpdateEmbedParams`.
- * @internal
- */
-const BOOTSTRAP_URL_PARAMS: ReadonlySet<string> = new Set<string>([
-    Param.EmbedApp,
-    Param.HostAppUrl,
-    Param.Version,
-    Param.AuthType,
-    Param.AutoLogin,
-    Param.DisableLoginRedirect,
-    Param.ForceSAMLAutoRedirect,
-    Param.cookieless,
-    Param.preAuthCache,
-    Param.blockNonEmbedFullAppAccess,
-    Param.OverrideOrgId,
-    Param.ViewPortHeight,
-    Param.ViewPortWidth,
-    Param.ClientLogLevel,
-    Param.OverrideNativeConsole,
-    Param.PendoTrackingKey,
-    Param.NumberFormatLocale,
-    Param.DateFormatLocale,
-    Param.CurrencyFormat,
-    Param.Locale,
-    Param.searchEmbed,
-    Param.livedBoardEmbed,
-    Param.isSpotterAgentEmbed,
-    Param.SpotterEnabled,
-    Param.IsFullAppEmbed,
-    Param.IsOnBeforeGetVizDataInterceptEnabled,
-    Param.LinkOverride,
-    Param.EnableLinkOverridesV2,
-    Param.DisableRedirectionLinksInNewTab,
-    Param.OverrideHistoryState,
-    Param.ForceTable,
-    Param.StringIDsUrl,
-    Param.DataSources,
-    Param.ExposeTranslationIDs,
-    Param.IconSpriteUrl,
-    Param.Tag,
-]);
-
 /**
  * The event id map from v2 event names to v1 event id
  * v1 events are the classic embed events implemented in Blink v1
@@ -281,8 +234,7 @@ export class TsEmbed {
 
     private preRenderContainerEl: HTMLElement = document.body;
 
-    private containerScrollListener: (() => void) | null = null;
-
+    /** Last height the embedded app reported, once fullHeight has measured one. */
     protected hostEventClient: HostEventClient;
 
     protected isReadyForRenderPromise;
@@ -1001,7 +953,7 @@ export class TsEmbed {
     }
 
     protected getEmbedParams() {
-        const queryParams = this.getUrlQueryParamsObject();
+        const queryParams = this.getEmbedParamsObject();
         return getQueryParamString(queryParams);
     }
 
@@ -1010,16 +962,6 @@ export class TsEmbed {
         return params;
     }
 
-    protected getUrlQueryParamsObject(): Record<any, any> {
-        const queryParams = this.getEmbedParamsObject();
-        if (!this.isConfigExcludedFromUrl()) {
-            return queryParams;
-        }
-        return Object.fromEntries(
-            Object.entries(queryParams).filter(([key]) => BOOTSTRAP_URL_PARAMS.has(key)),
-        );
-    }
-
     protected getRootIframeSrc() {
         const query = this.getEmbedParams();
         return this.getEmbedBasePath(query);
@@ -1208,7 +1150,7 @@ export class TsEmbed {
             top: '0',
             left: '0',
             width: '100vw',
-            height: '100vh',
+            height: UNMEASURED_WRAPPER_HEIGHT,
         };
         setStyleProperties(preRenderWrapper, initialPreRenderWrapperStyle);
 
@@ -1294,10 +1236,26 @@ export class TsEmbed {
     }
 
     /**
-     * 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(): HTMLElement {
         const containerConfig = this.getPreRenderConfig().containerSelector;
@@ -1314,7 +1272,13 @@ export class TsEmbed {
         } else if (containerConfig) {
             container = containerConfig;
         }
-        return (container as HTMLElement) ?? document.body;
+        if (container) {
+            return container as HTMLElement;
+        }
+        if (!this.hostElement) {
+            return document.body;
+        }
+        return getScrollableAncestors(this.hostElement)[0] ?? document.body;
     }
 
     private inheritPreRenderContainer(): void {
@@ -1368,8 +1332,9 @@ export 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(): void {
         const wrapper = this.preRenderWrapper;
@@ -1388,14 +1353,6 @@ export class TsEmbed {
         if (resolved === stored && stored.contains(wrapper)) {
             return;
         }
-        if (this.containerScrollListener && stored !== resolved) {
-            if (stored !== document.body) {
-                stored.removeEventListener('scroll', this.containerScrollListener);
-            }
-            if (resolved !== document.body) {
-                resolved.addEventListener('scroll', this.containerScrollListener);
-            }
-        }
         this.preRenderContainerEl = resolved;
         this.applyPreRenderContainerPositioning();
         if (wrapper.parentNode !== resolved) {
@@ -1464,10 +1421,11 @@ export class TsEmbed {
      */
     protected setIFrameHeight(height: number | string): void {
         if (this.isPreRendered) {
+            const next = getCssDimension(height);
             if (this.insertedDomEl) {
-                (this.insertedDomEl as HTMLElement).style.height = getCssDimension(height);
+                (this.insertedDomEl as HTMLElement).style.height = next;
             } else if (this.preRenderWrapper) {
-                this.preRenderWrapper.style.height = getCssDimension(height);
+                this.preRenderWrapper.style.height = next;
             }
         } else {
             // normal (non-preRender) mode: size the iframe directly
@@ -1741,9 +1699,6 @@ export class TsEmbed {
                 setTimeout(processEmbedContainerReady, AUTH_INIT_FALLBACK_DELAY);
             } else if (source === EmbedEvent.EmbedListenerReady) {
                 processEmbedContainerReady();
-                if (this.isConfigExcludedFromUrl()) {
-                    this.triggerUpdateEmbedParams();
-                }
             }
         };
 
@@ -2035,15 +1990,27 @@ export class TsEmbed {
     }
 
     /**
-     * Detaches and clears the container scroll listener, if one is attached.
-     */
-    private removeContainerScrollListener(): void {
-        if (!this.containerScrollListener) {
+     * 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 observePreRenderSize(): void {
+        if (this.getPreRenderConfig().doNotTrackSize || typeof ResizeObserver === 'undefined') {
+            return;
+        }
+        const placeholder = this.getPreRenderPlaceHolderElement();
+        if (!placeholder) {
             return;
         }
-        const customContainer = this.getCustomPreRenderContainer();
-        customContainer?.removeEventListener('scroll', this.containerScrollListener);
-        this.containerScrollListener = null;
+        this.resizeObserver?.disconnect();
+        this.resizeObserver = new ResizeObserver(() => this.syncPreRenderStyle());
+        this.resizeObserver.observe(placeholder);
     }
 
     /**
@@ -2053,7 +2020,7 @@ export class TsEmbed {
     public destroy(): void {
         try {
             this.removeFullscreenChangeHandler();
-            this.removeContainerScrollListener();
+            this.resizeObserver?.disconnect();
             this.unsubscribeToEvents();
             this.preRenderWrapper?.remove();
             this.restorePreRenderContainerPosition();
@@ -2112,29 +2079,6 @@ export class TsEmbed {
     // blocked.
     protected preRenderParamsApplied: Promise<void> = Promise.resolve();
 
-    protected isConfigExcludedFromUrl(): boolean {
-        const flag =
-            this.viewConfig.additionalFlags?.excludeConfigFromURL ??
-            this.embedConfig.additionalFlags?.excludeConfigFromURL;
-        // Enabled by default; only an explicit false opts out.
-        return flag !== false && flag !== 'false';
-    }
-
-    protected async triggerUpdateEmbedParams(): Promise<void> {
-        try {
-            const params = await this.getUpdateEmbedParamsObject();
-            this.trigger(HostEvent.UpdateEmbedParams, params);
-        } catch (error) {
-            logger.error(ERROR_MESSAGE.UPDATE_PARAMS_FAILED, error);
-            this.handleError({
-                errorType: ErrorDetailsTypes.API,
-                message: error?.message || ERROR_MESSAGE.UPDATE_PARAMS_FAILED,
-                code: EmbedErrorCodes.UPDATE_PARAMS_FAILED,
-                error: error?.message || error,
-            });
-        }
-    }
-
     protected beforePrerenderVisible(): void {
         // We can ignore this as its a bit expensive and the newer customers
         // have moved on to UpdateEmbedParams supported clusters
@@ -2145,7 +2089,16 @@ export class TsEmbed {
         this.preRenderParamsApplied = new Promise<void>((resolve) => {
             this.executeAfterEmbedContainerLoaded(async () => {
                 try {
-                    await this.triggerUpdateEmbedParams();
+                    const params = await this.getUpdateEmbedParamsObject();
+                    this.trigger(HostEvent.UpdateEmbedParams, params);
+                } catch (error) {
+                    logger.error(ERROR_MESSAGE.UPDATE_PARAMS_FAILED, error);
+                    this.handleError({
+                        errorType: ErrorDetailsTypes.API,
+                        message: error?.message || ERROR_MESSAGE.UPDATE_PARAMS_FAILED,
+                        code: EmbedErrorCodes.UPDATE_PARAMS_FAILED,
+                        error: error?.message || error,
+                    });
                 } finally {
                     setTimeout(resolve, UPDATE_EMBED_PARAMS_SETTLE_MS);
                 }
@@ -2181,14 +2134,18 @@ export class TsEmbed {
 
         if (this.hostElement) {
             this.insertedDomEl = this.createPreRenderPlaceholder();
-            if ((this.viewConfig as { fullHeight: boolean }).fullHeight) {
-                // If fullHeight has already sized the wrapper, seed the
-                // placeholder with the same height so syncPreRenderStyle gets
-                // an accurate rect.
-                const existingHeight = this.preRenderWrapper.style.height;
-                if (existingHeight) {
-                    (this.insertedDomEl as HTMLDivElement).style.height = existingHeight;
-                }
+            // Carry a height fullHeight has already measured onto the fresh
+            // placeholder, so a re-show does not flash at frameParams height.
+            // UNMEASURED_WRAPPER_HEIGHT is what createPreRenderWrapper() seeds
+            // before anything has been measured; treating that as a measurement
+            // is what made a first reveal overshoot to a full viewport.
+            const wrapperHeight = this.preRenderWrapper.style.height;
+            if (
+                (this.viewConfig as { fullHeight: boolean }).fullHeight
+                && wrapperHeight
+                && wrapperHeight !== UNMEASURED_WRAPPER_HEIGHT
+            ) {
+                (this.insertedDomEl as HTMLDivElement).style.height = wrapperHeight;
             }
 
             const placeHolderId = this.getPreRenderIds().placeHolder;
@@ -2205,32 +2162,20 @@ export class TsEmbed {
             this.hostElement.appendChild(this.insertedDomEl);
 
             this.syncPreRenderStyle();
-
-            const customContainer = this.getCustomPreRenderContainer();
-            if (customContainer && !this.containerScrollListener) {
-                this.containerScrollListener = () => this.syncPreRenderStyle();
-                customContainer.addEventListener('scroll', this.containerScrollListener);
-            }
-
-            if (!this.getPreRenderConfig().doNotTrackSize) {
-                const observeTarget = (this.insertedDomEl as HTMLElement) ?? this.hostElement;
-                this.resizeObserver = new ResizeObserver((entries) => {
-                    entries.forEach((entry) => {
-                        if (entry.target === observeTarget) {
-                            this.syncPreRenderStyle();
-                        }
-                    });
-                });
-                this.resizeObserver.observe(observeTarget);
-            }
+            this.observePreRenderSize();
         }
 
         removeStyleProperties(this.preRenderWrapper, [
             'z-index',
             'opacity',
-            'pointer-events',
             'overflow',
+            'transform',
         ]);
+        // Set rather than removed: a container that carries `pointer-events:
+        // none` — the usual styling for a parking root that must not swallow
+        // clicks — passes it down, and dropping the property here would leave
+        // the inherited `none` in force and the frame dead to input.
+        setStyleProperties(this.preRenderWrapper, { pointerEvents: 'auto' });
         this.subscribeToEvents();
 
         // Setup fullscreen change handler for prerendered components
@@ -2310,14 +2255,16 @@ export class TsEmbed {
             top: '0',
             left: '0',
             overflow: 'hidden',
+            // Keeps the measured size — so the next show needs no resize, which
+            // is the point of pre-rendering — while lifting the box out of
+            // the container's scrollable area. Overflow only extends
+            // downwards, so a hidden frame parked above the top edge adds
+            // none, where one left at full height shows as blank scroll space.
+            transform: PRERENDER_PARKED_TRANSFORM,
         };
         setStyleProperties(this.preRenderWrapper, preRenderHideStyles);
 
-        this.removeContainerScrollListener();
-
-        if (this.resizeObserver) {
-            this.resizeObserver.disconnect();
-        }
+        this.resizeObserver?.disconnect();
 
         const placeHolderEle = this.getPreRenderPlaceHolderElement();
         if (placeHolderEle) {