catch and handle credential parse error

yext · Oct 1, 2024 · 31db95c · 31db95c
1 parent ead1219
commit 31db95c
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 5 deletions.
diff --git a/packages/chat-headless-react/THIRD-PARTY-NOTICES b/packages/chat-headless-react/THIRD-PARTY-NOTICES
@@ -67,7 +67,7 @@ The following npm packages may be included in this product:
  - @types/[email protected]
  - @types/[email protected]
  - @types/[email protected]
- - @types/[email protected].9
+ - @types/[email protected].10
  - @types/[email protected]
 
 These packages each contain the following license and notice below:

diff --git a/packages/chat-headless/src/ChatHeadlessImpl.ts b/packages/chat-headless/src/ChatHeadlessImpl.ts
@@ -104,7 +104,14 @@ export class ChatHeadlessImpl implements ChatHeadless {
         this.credentialsSessionStorageKey
       );
       if (credentials) {
-        return JSON.parse(credentials);
+        try {
+          return JSON.parse(credentials);
+        } catch (e) {
+          this.removeSessionAgentCredentials();
+          throw new Error(
+            `Error occurred while parsing credentials from session storage: ${e}`
+          );
+        }
       }
     }
   }
@@ -265,9 +272,17 @@ export class ChatHeadlessImpl implements ChatHeadless {
     }
 
     this.credentialsSessionStorageKey = `${BASE_HANDOFF_CREDENTIALS_SESSION_STORAGE_KEY}__${hostname}__${this.config.botId}`;
-
-    if (this.sessionAgentCredentials) {
-      this.handoff();
+
+    try {
+      const credentials = this.sessionAgentCredentials;
+      if (credentials) {
+        this.handoff();
+      }
+    } catch (e) {
+      console.error(
+        "Error occurred while initializing agent session using stored credentials:",
+        e
+      );
     }
   }
 

diff --git a/packages/chat-headless/tests/chatheadless.clients.test.ts b/packages/chat-headless/tests/chatheadless.clients.test.ts
@@ -272,6 +272,44 @@ it("does not reinitialize session if saveToLocalStorage is false", async () => {
   expect(botClient.getNextMessage).toHaveBeenCalledTimes(2);
 });
 
+it("defaults to bot client if session storage contains invalid data", async () => {
+  const botClient = createMockHttpClient([
+    { message: createMessage("message 1"), notes: {}, integrationDetails: {} }, //trigger handoff
+    { message: createMessage("message 2"), notes: {} },
+  ]);
+  const callbacks: Record<string, any[]> = {};
+  let agentClient = createMockEventClient(callbacks);
+  const newConfig = { ...config, saveToLocalStorage: true };
+  let headless = provideChatHeadless(newConfig, {
+    bot: botClient,
+    agent: agentClient,
+  });
+
+  // start with bot client, immediately trigger handoff
+  await headless.getNextMessage();
+  expect(botClient.getNextMessage).toHaveBeenCalledTimes(1);
+  expect(agentClient.init).toHaveBeenCalledTimes(1);
+
+  // save invalid data to session storage
+  sessionStorage.setItem(
+    "yext_chat_handoff_credentials__localhost__botId",
+    "invalid"
+  );
+
+  agentClient = createMockEventClient(callbacks);
+  headless = provideChatHeadless(newConfig, {
+    bot: botClient,
+    agent: agentClient,
+  });
+
+  // agent does not reinitialize, nothing saved to session
+  expect(agentClient.reinitializeSession).toHaveBeenCalledTimes(0);
+
+  // bot client is the active client
+  await headless.getNextMessage();
+  expect(botClient.getNextMessage).toHaveBeenCalledTimes(2);
+});
+
 function createMessage(text: string): Message {
   return {
     text,