SCAL-269016 : rebase

Author: sastaachar

src/api-intercept.ts

@@ -0,0 +1,131 @@
+import { getThoughtSpotHost } from "./config";
+import { getEmbedConfig } from "./embed/embedConfig";
+import { InterceptedApiType, BaseViewConfig, EmbedConfig, InterceptV2Flags, EmbedEvent } from "./types";
+
+
+
+const defaultUrls: Record<Exclude<InterceptedApiType, InterceptedApiType.ALL>, string[]> = {
+    [InterceptedApiType.METADATA]: [
+        '/prism/?op=CreateAnswerSession',
+        '/prism/?op=GetV2SourceDetail',
+    ] as string[],
+    [InterceptedApiType.DATA]: [
+        '/prism/?op=GetChartWithData',
+        '/prism/?op=GetTableWithHeadlineData',
+        '/prism/?op=LoadContextBook'
+    ] as string[],
+};
+
+const formatInterceptUrl = (url: string) => {
+    const host = getThoughtSpotHost(getEmbedConfig());
+    if (url.startsWith('/')) return `${host}${url}`;
+    return url;
+}
+
+export const processApiIntercept = async (eventData: any) => {
+
+    return JSON.parse(eventData.data);
+}
+
+interface LegacyInterceptFlags {
+    isOnBeforeGetVizDataInterceptEnabled: boolean;
+}
+
+const processInterceptUrls = (combinedUrls: (string | InterceptedApiType)[]) => {
+    Object.entries(defaultUrls).forEach(([apiType, apiTypeUrls]) => {
+        if (!combinedUrls.includes(apiType)) return;
+        combinedUrls = combinedUrls.filter(url => url !== apiType);
+        combinedUrls = [...combinedUrls, ...apiTypeUrls];
+    })
+    return combinedUrls.map(url => formatInterceptUrl(url));
+}
+export const getInterceptInitData = (embedConfig: EmbedConfig, viewConfig: BaseViewConfig): InterceptV2Flags => {
+
+    const enableApiIntercept = (embedConfig.enableApiIntercept || viewConfig.enableApiIntercept) && (viewConfig.enableApiIntercept !== false);
+
+    if (!enableApiIntercept) return {
+        enableApiIntercept: false,
+    };
+
+    const combinedUrls = [...(embedConfig.interceptUrls || []), ...(viewConfig.interceptUrls || [])];
+
+    if ((viewConfig as LegacyInterceptFlags).isOnBeforeGetVizDataInterceptEnabled) {
+        combinedUrls.push(InterceptedApiType.DATA);
+    }
+
+    const shouldInterceptAll = combinedUrls.includes(InterceptedApiType.ALL);
+    const interceptUrls = shouldInterceptAll ? [InterceptedApiType.ALL] : processInterceptUrls(combinedUrls);
+
+    const interceptTimeout = embedConfig.interceptTimeout || viewConfig.interceptTimeout;
+
+    return {
+        interceptUrls,
+        interceptTimeout,
+        enableApiIntercept,
+    };
+}
+
+/**
+ * 
+ * @param fetchInit 
+ */
+const parseInterceptData = (eventDataString: any) => {
+
+    try {
+        const { input, init } = JSON.parse(eventDataString);
+
+        init.body = JSON.parse(init.body);
+
+        const parsedInit = { input, init };
+        return [parsedInit, null];
+    } catch (error) {
+        return [null, error];
+    }
+}
+
+export const handleInterceptEvent = async (params: { eventData: any, executeEvent: (eventType: EmbedEvent, data: any) => void, embedConfig: EmbedConfig, viewConfig: BaseViewConfig, getUnsavedAnswerTml: (props: { sessionId?: string, vizId?: string }) => Promise<{ tml: string }> }) => {
+
+    const { eventData, executeEvent, viewConfig, getUnsavedAnswerTml } = params;
+
+    const [interceptData, bodyParseError] = parseInterceptData(eventData.data);
+
+    if (bodyParseError) {
+        executeEvent(EmbedEvent.Error, {
+            error: 'Error parsing api intercept body',
+        });
+        logger.error('Error parsing request body', bodyParseError);
+        return;
+    }
+
+    const { input: requestUrl, init } = interceptData;
+
+    const sessionId = init?.body?.variables?.session?.sessionId;
+    const vizId = init?.body?.variables?.contextBookId;
+
+    if (defaultUrls.DATA.includes(requestUrl) && (viewConfig as LegacyInterceptFlags).isOnBeforeGetVizDataInterceptEnabled) {
+        const answerTml = await getUnsavedAnswerTml({ sessionId, vizId });
+        executeEvent(EmbedEvent.OnBeforeGetVizDataIntercept, { data: { data: answerTml } });
+    }
+
+    executeEvent(EmbedEvent.ApiIntercept, interceptData);
+}
+
+export const processLegacyInterceptResponse = (payload: any) => {
+
+    const title = payload?.data?.errorText;
+    const desc = payload?.data?.errorDescription;
+
+    const payloadToSend = [{
+        data: {},
+        errors: [
+            {
+                errorObj: {
+                    title,
+                    desc
+                }
+            }
+        ],
+    }];
+
+    return payloadToSend;
+}

src/embed/app.ts

@@ -19,6 +19,7 @@ import {
     AllEmbedViewConfig,
 } from '../types';
 import { V1Embed } from './ts-embed';
+import { getInterceptInitData } from '../api-intercept';
 
 /**
  * Pages within the ThoughtSpot app that can be embedded.
@@ -728,7 +729,9 @@ export class AppEmbed extends V1Embed {
             params[Param.enableAskSage] = enableAskSage;
         }
 
-        if (isOnBeforeGetVizDataInterceptEnabled) {
+        const { enableApiIntercept } = getInterceptInitData(this.embedConfig, this.viewConfig);
+
+        if (isOnBeforeGetVizDataInterceptEnabled && !enableApiIntercept) {
 
             params[
                 Param.IsOnBeforeGetVizDataInterceptEnabled

src/embed/hostEventClient/contracts.ts

@@ -7,6 +7,7 @@ export enum UIPassthroughEvent {
   GetAvailableUIPassthroughs = 'getAvailableUiPassthroughs',
   GetAnswerConfig = 'getAnswerPageConfig',
   GetLiveboardConfig = 'getPinboardPageConfig',
+  GetUnsavedAnswerTML = 'getUnsavedAnswerTML',
 }
 
 // UI Passthrough Contract
@@ -63,6 +64,15 @@ export type UIPassthroughContractBase = {
     request: any;
     response: any;
   };
+  [UIPassthroughEvent.GetUnsavedAnswerTML]: {
+    request: {
+      sessionId?: string;
+      vizId?: string;
+    };
+    response: {
+      tml: string;
+    };
+  };
 };
 
 // UI Passthrough Request and Response

src/embed/search.ts

@@ -26,6 +26,7 @@ import { ERROR_MESSAGE } from '../errors';
 import { getAuthPromise } from './base';
 import { getReleaseVersion } from '../auth';
 import { getEmbedConfig } from './embedConfig';
+import { getInterceptInitData } from '../api-intercept';
 
 /**
  * Configuration for search options.
@@ -442,7 +443,8 @@ export class SearchEmbed extends TsEmbed {
             queryParams[Param.HideSearchBar] = true;
         }
 
-        if (isOnBeforeGetVizDataInterceptEnabled) {
+        const { enableApiIntercept } = getInterceptInitData(this.embedConfig, this.viewConfig);
+        if (isOnBeforeGetVizDataInterceptEnabled && !enableApiIntercept) {
 
             queryParams[Param.IsOnBeforeGetVizDataInterceptEnabled] = isOnBeforeGetVizDataInterceptEnabled;
         }

src/embed/ts-embed.spec.ts

@@ -1045,7 +1045,7 @@ describe('Unit test case for ts embed', () => {
                 type: EmbedEvent.APP_INIT,
                 data: {},
             };
-            
+
             // Create a SearchEmbed with valid custom actions to test
             // CustomActionsValidationResult
             const searchEmbed = new SearchEmbed(getRootEl(), {
@@ -1067,7 +1067,7 @@ describe('Unit test case for ts embed', () => {
                     }
                 ]
             });
-            
+
             searchEmbed.render();
             const mockPort: any = {
                 postMessage: jest.fn(),
@@ -1116,7 +1116,7 @@ describe('Unit test case for ts embed', () => {
                         customVariablesForThirdPartyTools: {},
                     },
                 });
-                
+
                 // Verify that CustomActionsValidationResult structure is
                 // correct
                 const appInitData = mockPort.postMessage.mock.calls[0][0].data;
@@ -1137,7 +1137,7 @@ describe('Unit test case for ts embed', () => {
                         })
                     ])
                 );
-                
+
                 // Verify actions are sorted by name (alphabetically)
                 expect(appInitData.customActions[0].name).toBe('Another Valid Action');
                 expect(appInitData.customActions[1].name).toBe('Valid Action');
@@ -2488,7 +2488,7 @@ describe('Unit test case for ts embed', () => {
         });
 
         afterAll((): void => {
-            window.location = location as any;
+            (window.location as any) = location;
         });
 
         it('get url params for TS', () => {
@@ -3406,7 +3406,7 @@ describe('Unit test case for ts embed', () => {
                 new Error('Auth failed'),
             );
             const searchEmbed = new SearchEmbed(getRootEl(), defaultViewConfig);
-            const errorSpy = jest.spyOn(console, 'error').mockImplementation(() => {});
+            const errorSpy = jest.spyOn(console, 'error').mockImplementation(() => { });
             await searchEmbed.render();
             await executeAfterWait(() => {
                 expect(getRootEl().innerHTML).toContain('Not logged in');
@@ -3415,7 +3415,7 @@ describe('Unit test case for ts embed', () => {
                     window.dispatchEvent(onlineEvent);
                 }).not.toThrow();
             });
-    
+
             errorSpy.mockReset();
         });