Move init to promise (#152)

Author: sastaachar

src/embed/app.ts

@@ -761,7 +761,8 @@ export class AppEmbed extends V1Embed {
      * to be embedded.
      */
     public async render(): Promise<AppEmbed> {
-        super.render();
+        await super.render();
+
         const src = this.getIFrameSrc();
         await this.renderV1Embed(src);
 

src/embed/base.ts

@@ -30,9 +30,10 @@ import {
     AuthEventEmitter,
     postLoginService,
 } from '../auth';
+import '../utils/with-resolvers-polyfill';
 import { uploadMixpanelEvent, MIXPANEL_EVENT } from '../mixpanel-service';
 import { getEmbedConfig, setEmbedConfig } from './embedConfig';
-import { getQueryParamString } from '../utils';
+import { getQueryParamString, getValueFromWindow, storeValueInWindow } from '../utils';
 import { resetAllCachedServices } from '../utils/resetServices';
 
 const CONFIG_DEFAULTS: Partial<EmbedConfig> = {
@@ -171,6 +172,40 @@ function backwardCompat(embedConfig: EmbedConfig): EmbedConfig {
     return newConfig;
 }
 
+type InitFlagStore = {
+  initPromise: Promise<ReturnType<typeof init>>;
+  isInitCalled: boolean;
+  initPromiseResolve: (value: ReturnType<typeof init>) => void;
+}
+const initFlagKey = 'initFlagKey';
+
+export const createAndSetInitPromise = (): void => {
+    const {
+        promise: initPromise,
+        resolve: initPromiseResolve,
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+    } = Promise.withResolvers<AuthEventEmitter>();
+    const initFlagStore: InitFlagStore = {
+        initPromise,
+        isInitCalled: false,
+        initPromiseResolve,
+    };
+    storeValueInWindow(initFlagKey, initFlagStore, {
+        // In case of diff imports the promise might be already set
+        ignoreIfAlreadyExists: true,
+    });
+};
+
+createAndSetInitPromise();
+
+export const getInitPromise = ():
+    Promise<
+      ReturnType<typeof init>
+    > => getValueFromWindow<InitFlagStore>(initFlagKey)?.initPromise;
+
+export const getIsInitCalled = (): boolean => !!getValueFromWindow(initFlagKey)?.isInitCalled;
+
 /**
  * Initializes the Visual Embed SDK globally and perform
  * authentication if applicable. This function needs to be called before any ThoughtSpot
@@ -223,6 +258,11 @@ export const init = (embedConfig: EmbedConfig): AuthEventEmitter => {
     if (getEmbedConfig().callPrefetch) {
         prefetch(getEmbedConfig().thoughtSpotHost);
     }
+
+    // Resolves the promise created in the initPromiseKey
+    getValueFromWindow<InitFlagStore>(initFlagKey).initPromiseResolve(authEE);
+    getValueFromWindow<InitFlagStore>(initFlagKey).isInitCalled = true;
+
     return authEE as AuthEventEmitter;
 };
 

src/embed/bodyless-conversation.ts

@@ -55,7 +55,8 @@ class ConversationMessage extends TsEmbed {
     }
 
     public async render(): Promise<ConversationMessage> {
-        super.render();
+        await super.render();
+
         const src = this.getIframeSrc();
         await this.renderIFrame(src);
         return this;

src/embed/conversation.ts

@@ -164,7 +164,8 @@ export class ConversationEmbed extends TsEmbed {
     }
 
     public async render(): Promise<ConversationEmbed> {
-        super.render();
+        await super.render();
+
         const src = this.getIframeSrc();
         await this.renderIFrame(src);
         return this;

src/embed/embedConfig.ts

@@ -9,7 +9,7 @@ const configKey = 'embedConfig';
  * @version SDK: 1.19.0 | ThoughtSpot: *
  * @group Global methods
  */
-export const getEmbedConfig = (): EmbedConfig => getValueFromWindow(configKey) || {};
+export const getEmbedConfig = (): EmbedConfig => getValueFromWindow(configKey) || ({} as any);
 
 /**
  * Sets the configuration embed was initialized with.

src/embed/liveboard.spec.ts

@@ -553,13 +553,13 @@ describe('Liveboard/viz embed tests', () => {
         });
     });
 
-    test('navigateToLiveboard should trigger the navigate event with the correct path', (done) => {
+    test('navigateToLiveboard should trigger the navigate event with the correct path', async (done) => {
         mockMessageChannel();
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
             ...defaultViewConfig,
         } as LiveboardViewConfig);
         const onSpy = jest.spyOn(liveboardEmbed, 'trigger');
-        liveboardEmbed.prerenderGeneric();
+        await liveboardEmbed.prerenderGeneric();
         executeAfterWait(() => {
             const iframe = getIFrameEl();
             postMessageToParent(iframe.contentWindow, {
@@ -573,14 +573,14 @@ describe('Liveboard/viz embed tests', () => {
         });
     });
 
-    test('navigateToLiveboard with preRender', (done) => {
+    test('navigateToLiveboard with preRender', async (done) => {
         mockMessageChannel();
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
             ...defaultViewConfig,
             preRenderId: 'test',
         } as LiveboardViewConfig);
         const onSpy = jest.spyOn(liveboardEmbed, 'trigger');
-        liveboardEmbed.prerenderGeneric();
+        await liveboardEmbed.prerenderGeneric();
         executeAfterWait(() => {
             const iframe = getIFrameEl();
             postMessageToParent(iframe.contentWindow, {
@@ -604,7 +604,7 @@ describe('Liveboard/viz embed tests', () => {
                 },
             ],
         } as LiveboardViewConfig);
-        liveboardEmbed.render();
+        await liveboardEmbed.render();
         await executeAfterWait(() => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
@@ -637,7 +637,7 @@ describe('Liveboard/viz embed tests', () => {
             ...defaultViewConfig,
             liveboardId,
         } as LiveboardViewConfig);
-        liveboardEmbed.render();
+        await liveboardEmbed.render();
         await executeAfterWait(() => {
             const result = liveboardEmbed.trigger(HostEvent.SetActiveTab, {
                 tabId: newActiveTabId,
@@ -650,13 +650,13 @@ describe('Liveboard/viz embed tests', () => {
     });
 
     describe('PreRender flow for liveboard embed', () => {
-        test('it should preRender generic with liveboard id is not passed', (done) => {
+        test('it should preRender generic with liveboard id is not passed', async (done) => {
             const consoleSpy = jest.spyOn(console, 'error');
             const libEmbed = new LiveboardEmbed(getRootEl(), {
                 preRenderId: 'testPreRender',
             });
             const prerenderGenericSpy = jest.spyOn(libEmbed, 'prerenderGeneric');
-            libEmbed.preRender();
+            await libEmbed.preRender();
             executeAfterWait(() => {
                 const iFrame = document.getElementById(
                     libEmbed.getPreRenderIds().child,
@@ -735,7 +735,7 @@ describe('Liveboard/viz embed tests', () => {
                     };
                 });
 
-            libEmbed.preRender();
+            await libEmbed.preRender();
 
             await waitFor(() => !!getIFrameEl());
 
@@ -750,7 +750,7 @@ describe('Liveboard/viz embed tests', () => {
                 liveboardId: testLiveboardId,
             });
             const navigateToLiveboardSpy = jest.spyOn(newLibEmbed, 'navigateToLiveboard');
-            newLibEmbed.showPreRender();
+            await newLibEmbed.showPreRender();
 
             executeAfterWait(() => {
                 const iFrame = document.getElementById(
@@ -776,7 +776,7 @@ describe('Liveboard/viz embed tests', () => {
                 ...defaultViewConfig,
                 vizId: 'testViz',
             });
-            liveboardEmbed.render();
+            await liveboardEmbed.render();
             mockProcessTrigger.mockResolvedValue({ session: 'test' });
             await executeAfterWait(async () => {
                 await liveboardEmbed.trigger(

src/embed/liveboard.ts

@@ -21,7 +21,7 @@ import {
 } from '../types';
 import { getQueryParamString, isUndefined } from '../utils';
 import { getAuthPromise } from './base';
-import { V1Embed } from './ts-embed';
+import { TsEmbed, V1Embed } from './ts-embed';
 import { addPreviewStylesIfNotPresent } from '../utils/global-styles';
 import { TriggerPayload, TriggerResponse } from './hostEventClient/contracts';
 
@@ -635,12 +635,11 @@ export class LiveboardEmbed extends V1Embed {
         }
     }
 
-    protected handleRenderForPrerender(): void {
+    protected async handleRenderForPrerender(): Promise<TsEmbed> {
         if (isUndefined(this.viewConfig.liveboardId)) {
-            this.prerenderGeneric();
-            return;
+            return this.prerenderGeneric();
         }
-        super.handleRenderForPrerender();
+        return super.handleRenderForPrerender();
     }
 
     /**
@@ -670,7 +669,7 @@ export class LiveboardEmbed extends V1Embed {
      * visualization ID and the runtime filters.
      */
     public async render(): Promise<LiveboardEmbed> {
-        super.render();
+        await super.render();
 
         const src = this.getIFrameSrc();
         await this.renderV1Embed(src);

src/embed/sage.ts

@@ -206,8 +206,7 @@ export class SageEmbed extends V1Embed {
      * @returns {SageEmbed} Eureka/Sage embed
      */
     public async render(): Promise<SageEmbed> {
-        super.render();
-
+        await super.render();
         const src = this.getIFrameSrc();
         await this.renderV1Embed(src);
 

src/embed/search-bar.tsx

@@ -174,8 +174,7 @@ export class SearchBarEmbed extends TsEmbed {
      * Render the embedded ThoughtSpot search
      */
     public async render(): Promise<SearchBarEmbed> {
-        super.render();
-
+        await super.render();
         const src = this.getIFrameSrc();
         await this.renderIFrame(src);
         return this;

src/embed/search.ts

@@ -482,9 +482,8 @@ export class SearchEmbed extends TsEmbed {
      * Render the embedded ThoughtSpot search
      */
     public async render(): Promise<SearchEmbed> {
-        super.render();
+        await super.render();
         const { answerId } = this.viewConfig;
-
         const src = this.getIFrameSrc();
         await this.renderIFrame(src);
         getAuthPromise().then(() => {