@thoughtspot/visual-embed-sdk 1.32.3 → 1.32.4-dc.1

package/src/utils/graphql/conversationService/conversation-queries.ts

@@ -0,0 +1,315 @@
+export const createConversation = `
+mutation CreateConversation($params: Input_convassist_CreateConversationRequest) {
+  ConvAssist__createConversation(request: $params) {
+    convId
+    initialCtx {
+      type
+      tsAnsCtx {
+        sessionId
+        genNo
+        stateKey {
+          transactionId
+          generationNumber
+          __typename
+        }
+        worksheet {
+          worksheetId
+          worksheetName
+          __typename
+        }
+        __typename
+      }
+      __typename
+    }
+    __typename
+  }
+}
+`;
+
+export const sendMessage = `
+query SendMessage($params: Input_convassist_SendMessageRequest) {
+  ConvAssist__sendMessage(request: $params) {
+    responses {
+      timestamp
+      msgId
+      data {
+        asstRespData {
+          tool
+          asstRespText
+          nlsAnsData {
+            sageQuerySuggestions {
+              sageQueryTokens {
+                additions {
+                  phrase {
+                    isCompletePhrase
+                    numTokens
+                    phraseType
+                    startIndex
+                    __typename
+                  }
+                  tokens {
+                    token
+                    dataType
+                    typeEnum
+                    guid
+                    tokenMetadata {
+                      name
+                      __typename
+                    }
+                    __typename
+                  }
+                  __typename
+                }
+                phrases {
+                  isCompletePhrase
+                  numTokens
+                  phraseType
+                  startIndex
+                  __typename
+                }
+                removals {
+                  phrase {
+                    isCompletePhrase
+                    numTokens
+                    phraseType
+                    startIndex
+                    __typename
+                  }
+                  tokens {
+                    token
+                    dataType
+                    typeEnum
+                    guid
+                    tokenMetadata {
+                      name
+                      __typename
+                    }
+                    __typename
+                  }
+                  __typename
+                }
+                tokens {
+                  token
+                  dataType
+                  typeEnum
+                  guid
+                  tokenMetadata {
+                    name
+                    __typename
+                  }
+                  __typename
+                }
+                __typename
+              }
+              llmReasoning {
+                assumptions
+                clarifications
+                interpretation
+                __typename
+              }
+              tokens
+              tmlTokens
+              worksheetId
+              tokens
+              description
+              title
+              tmlTokens
+              cached
+              sqlQuery
+              sessionId
+              genNo
+              formulaInfo {
+                name
+                expression
+                __typename
+              }
+              tmlPhrases
+              ambiguousPhrases {
+                alternativePhrases {
+                  phraseType
+                  token {
+                    token
+                    dataType
+                    typeEnum
+                    guid
+                    tokenMetadata {
+                      name
+                      __typename
+                    }
+                    __typename
+                  }
+                  __typename
+                }
+                ambiguityType
+                token {
+                  token
+                  dataType
+                  typeEnum
+                  guid
+                  tokenMetadata {
+                    name
+                    __typename
+                  }
+                  __typename
+                }
+                __typename
+              }
+              ambiguousTokens {
+                alternativeTokens {
+                  token
+                  dataType
+                  typeEnum
+                  guid
+                  tokenMetadata {
+                    name
+                    deprecatedTableGuid
+                    deprecatedTableName
+                    isFormula
+                    rootTables {
+                      created
+                      description
+                      guid
+                      indexVersion
+                      modified
+                      name
+                      __typename
+                    }
+                    schemaTableUserDefinedName
+                    table {
+                      created
+                      description
+                      guid
+                      indexVersion
+                      modified
+                      name
+                      __typename
+                    }
+                    __typename
+                  }
+                  __typename
+                }
+                ambiguityType
+                token {
+                  token
+                  dataType
+                  typeEnum
+                  guid
+                  tokenMetadata {
+                    name
+                    __typename
+                  }
+                  __typename
+                }
+                __typename
+              }
+              stateKey {
+                transactionId
+                generationNumber
+                transactionId
+                __typename
+              }
+              subQueries {
+                tokens
+                cohortConfig {
+                  anchorColumnId
+                  cohortAnswerGuid
+                  cohortGroupingType
+                  cohortGuid
+                  cohortType
+                  combineNonGroupValues
+                  description
+                  groupExcludedQueryValues
+                  hideExcludedQueryValues
+                  isEditable
+                  name
+                  nullOutputValue
+                  returnColumnId
+                  __typename
+                }
+                formulas {
+                  name
+                  expression
+                  __typename
+                }
+                __typename
+              }
+              visualizationSuggestion {
+                chartType
+                displayMode
+                axisConfigs {
+                  category
+                  color
+                  hidden
+                  size
+                  sort
+                  x
+                  y
+                  __typename
+                }
+                usersVizIntentApplied
+                customChartConfigs {
+                  dimensions {
+                    columns
+                    key
+                    __typename
+                  }
+                  key
+                  __typename
+                }
+                customChartGuid
+                __typename
+              }
+              tableData {
+                columnDataLite {
+                  columnId
+                  columnDataType
+                  dataValue
+                  columnName
+                  __typename
+                }
+                __typename
+              }
+              warningType
+              cached
+              __typename
+            }
+            debugInfo {
+              fewShotExamples {
+                chartType
+                id
+                mappingId
+                nlQuery
+                nlQueryConcepts
+                sageQuery
+                scope
+                sql
+                tml
+                __typename
+              }
+              __typename
+            }
+            __typename
+          }
+          __typename
+        }
+        errorData {
+          tool
+          errCode
+          errTxt
+          toolErrCode
+          __typename
+        }
+        __typename
+      }
+      type
+      __typename
+    }
+    prevCtx {
+      genNo
+      sessionId
+      __typename
+    }
+    __typename
+  }
+}
+`;

package/src/utils/graphql/conversationService/conversation-service.ts

@@ -0,0 +1,93 @@
+import { graphqlQuery } from '../graphql-request';
+import * as queries from './conversation-queries';
+
+export class Conversation {
+    private conversationId: string;
+
+    private inProgress = false;
+
+    constructor(private thoughtSpotHost: string, private worksheetId: string) {
+        this.init();
+    }
+
+    async init() {
+        try {
+            this.inProgress = true;
+            const { convId } = await this.createConversation();
+            this.conversationId = convId;
+        } finally {
+            this.inProgress = false;
+        }
+    }
+
+    createConversation(): Promise<any> {
+        return this.executeQuery(
+            queries.createConversation,
+            {
+                params: {
+                    initialCtx: {
+                        tsWorksheetCtx: {
+                            worksheet: {
+                                worksheetId: this.worksheetId,
+                            },
+                        },
+                        type: 'TS_WORKSHEET',
+                    },
+                    userInfo: {
+                        tenantUrl: `${this.thoughtSpotHost}/prism`,
+                    },
+                },
+            },
+        );
+    }
+
+    public async sendMessage(userMessage: string): Promise<any> {
+        if (this.inProgress) {
+            console.warn('Previous message still in progress');
+            return { error: 'Previous message still in progress' };
+        }
+
+        try {
+            this.inProgress = true;
+            const { responses } = await this.executeQuery(
+                queries.sendMessage,
+                {
+                    params: {
+                        convId: this.conversationId,
+                        msg: {
+                            data: {
+                                userCmdData: {
+                                    cmdText: userMessage,
+                                    nlsData: {
+                                        worksheetId: this.worksheetId,
+                                    },
+                                },
+                            },
+                            msgId: crypto.randomUUID(),
+                            type: 'USER_COMMAND',
+                        },
+                    },
+                },
+            );
+            this.inProgress = false;
+            const data = responses[0].data;
+            return {
+                data: data.asstRespData.nlsAnsData.sageQuerySuggestions[0],
+                error: null,
+            };
+        } catch (error) {
+            return { error };
+        } finally {
+            this.inProgress = false;
+        }
+    }
+
+    public async executeQuery(query: string, variables: any) {
+        return graphqlQuery({
+            query,
+            variables,
+            thoughtSpotHost: this.thoughtSpotHost,
+            isCompositeQuery: false,
+        });
+    }
+}

package/src/utils/graphql/graphql-request.spec.ts

@@ -0,0 +1,38 @@
+import 'jest-fetch-mock';
+import { getSourceDetail } from './sourceService';
+import * as tokenizedFetchUtil from '../../tokenizedFetch';
+import { graphqlQuery } from './graphql-request';
+
+const getSourceDetailQuery = `
+    query GetSourceDetail($ids: [GUID!]!) {
+        getSourceDetailById(ids: $ids, type: LOGICAL_TABLE) {
+            id
+            name
+        }
+    }  
+`;
+
+const thoughtSpotHost = 'TSHOST';
+
+describe('graphQl tests', () => {
+    test('should call tokenizedFetch with correct parameters when graphqlQuery is called', async () => {
+        jest.spyOn(tokenizedFetchUtil, 'tokenizedFetch');
+
+        const details = await graphqlQuery({
+            query: getSourceDetailQuery,
+            variables: {
+                ids: [2],
+            },
+            thoughtSpotHost,
+        });
+
+        expect(tokenizedFetchUtil.tokenizedFetch).toBeCalledWith('TSHOST/prism/?op=GetSourceDetail', {
+            body: '{"operationName":"GetSourceDetail","query":"\\n    query GetSourceDetail($ids: [GUID!]!) {\\n        getSourceDetailById(ids: $ids, type: LOGICAL_TABLE) {\\n            id\\n            name\\n        }\\n    }  \\n","variables":{"ids":[2]}}',
+            credentials: 'include',
+            headers: {
+                accept: '*/*', 'accept-language': 'en-us', 'content-type': 'application/json;charset=UTF-8', 'x-requested-by': 'ThoughtSpot',
+            },
+            method: 'POST',
+        });
+    });
+});

package/src/utils/graphql/graphql-request.ts

@@ -19,7 +19,7 @@ export async function graphqlQuery({
     variables: any,
     thoughtSpotHost: string,
     isCompositeQuery?: boolean
-}) {
+}): Promise<any> {
     const operationName = getOperationNameFromQuery(query);
     try {
         const response = await tokenizedFetch(`${thoughtSpotHost}/prism/?op=${operationName}`, {

package/src/utils/graphql/preview-service.ts

@@ -18,6 +18,12 @@ query GetEurekaVizSnapshots(
   } 
 `;
 
+/**
+ *
+ * @param thoughtSpotHost
+ * @param vizId
+ * @param liveboardId
+ */
 export async function getPreview(
     thoughtSpotHost: string,
     vizId: string,

package/src/utils/processData.ts

@@ -32,7 +32,6 @@ export function processCustomAction(e: any, thoughtSpotHost: string) {
 
 /**
  * Responds to AuthInit sent from host signifying successful authentication in host.
- *
  * @param e
  * @returns {any}
  */

package/src/utils/processTrigger.spec.ts

@@ -67,4 +67,23 @@ describe('Unit test for processTrigger', () => {
         expect(messageChannelMock.port1.close).toBeCalled();
         expect(triggerPromise).rejects.toEqual(res.data.error);
     });
+
+    test('should close channel.port1 when timeout exceeds TRIGGER_TIMEOUT', async () => {
+        const messageType = HostEvent.Search;
+        const thoughtSpotHost = 'http://localhost:3000';
+        const data = {};
+        mockMessageChannel();
+
+        const triggerPromise = _processTriggerInstance.processTrigger(
+            iFrame,
+            messageType,
+            thoughtSpotHost,
+            data,
+        );
+
+        jest.advanceTimersByTime(_processTriggerInstance.TRIGGER_TIMEOUT);
+
+        expect(messageChannelMock.port1.close).toBeCalled();
+        await expect(triggerPromise).resolves.toBeInstanceOf(Error);
+    });
 });

package/src/utils/processTrigger.ts

@@ -31,7 +31,7 @@ function postIframeMessage(
     return iFrame.contentWindow.postMessage(message, thoughtSpotHost, [channel?.port2]);
 }
 
-const TRIGGER_TIMEOUT = 30000;
+export const TRIGGER_TIMEOUT = 30000;
 
 /**
  *

package/src/utils/sessionInfoService.ts

@@ -19,7 +19,6 @@ let sessionInfo: null | SessionInfo = null;
  * Returns the session info object and caches it for future use.
  * Once fetched the session info object is cached and returned from the cache on
  * subsequent calls.
- *
  * @example ```js
  * const sessionInfo = await getSessionInfo();
  * console.log(sessionInfo);
@@ -40,7 +39,6 @@ export async function getSessionInfo(): Promise<SessionInfo> {
 /**
  * Returns the cached session info object. If the client is not authenticated the
  * function will return null.
- *
  * @example ```js
  * const sessionInfo = getCachedSessionInfo();
  * if (sessionInfo) {
@@ -58,7 +56,6 @@ export function getCachedSessionInfo(): SessionInfo | null {
 
 /**
  * Processes the session info response and returns the session info object.
- *
  *  @param sessionInfoResp {any} Response from the session info API.
  *  @returns {SessionInfo} The session info object.
  *  @example ```js
@@ -87,7 +84,6 @@ export const getSessionDetails = (sessionInfoResp: any): SessionInfo => {
 
 /**
  * Resets the cached session info object and forces a new fetch on the next call.
- *
  * @example ```js
  * resetCachedSessionInfo();
  * const sessionInfo = await getSessionInfo();

package/src/utils.ts

@@ -206,7 +206,6 @@ export const getCustomisations = (
     embedConfig: EmbedConfig,
     viewConfig: ViewConfig,
 ): CustomisationsInterface => {
-    const customCssUrlFromEmbedConfig = embedConfig.customCssUrl;
     const customizationsFromViewConfig = viewConfig.customizations;
     const customizationsFromEmbedConfig = embedConfig.customizations
         || ((embedConfig as any).customisations as CustomisationsInterface);
@@ -219,10 +218,6 @@ export const getCustomisations = (
                 ...customizationsFromEmbedConfig?.style?.customCSS,
                 ...customizationsFromViewConfig?.style?.customCSS,
             },
-            customCSSUrl:
-                customizationsFromViewConfig?.style?.customCSSUrl
-                || customizationsFromEmbedConfig?.style?.customCSSUrl
-                || customCssUrlFromEmbedConfig,
         },
         content: {
             ...customizationsFromEmbedConfig?.content,