@microsoft/omnichannel-chat-widget 1.5.1-main.c3533cf → 1.5.1-main.e2be12d

package/lib/esm/components/livechatwidget/common/startChatErrorHandler.js

@@ -0,0 +1,191 @@
+import { ChatSDKErrorName, ChatSDKError } from "@microsoft/omnichannel-chat-sdk";
+import { LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
+import { TelemetryHelper } from "../../../common/telemetry/TelemetryHelper";
+import { TelemetryTimers } from "../../../common/telemetry/TelemetryManager";
+import { ConversationState } from "../../../contexts/common/ConversationState";
+import { LiveChatWidgetActionType } from "../../../contexts/common/LiveChatWidgetActionType";
+import { callingStateCleanUp, endChatStateCleanUp, closeChatStateCleanUp, chatSDKStateCleanUp } from "./endChat";
+import { DataStoreManager } from "../../../common/contextDataStore/DataStoreManager";
+import { getWidgetCacheIdfromProps } from "../../../common/utils";
+import { WidgetLoadCustomErrorString, WidgetLoadTelemetryMessage } from "../../../common/Constants";
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export const handleStartChatError = (dispatch, chatSDK, props, ex, isStartChatSuccessful) => {
+  var _props$controlProps;
+  if (!ex) {
+    logWidgetLoadFailed();
+    return;
+  }
+
+  // Handle internal or misc errors
+  if (ex.message === WidgetLoadCustomErrorString.AuthenticationFailedErrorString || ex.message === WidgetLoadCustomErrorString.NetworkErrorString) {
+    logWidgetLoadCompleteWithError(ex);
+  }
+
+  // Handle ChatSDK errors
+  if (ex instanceof ChatSDKError) {
+    switch (ex.message) {
+      case ChatSDKErrorName.WidgetUseOutsideOperatingHour:
+        handleWidgetUseOutsideOperatingHour(dispatch);
+        return;
+      case ChatSDKErrorName.PersistentChatConversationRetrievalFailure:
+        handlePersistentChatConversationRetrievalFailure(ex);
+        break;
+      case ChatSDKErrorName.ConversationInitializationFailure:
+        handleConversationInitializationFailure(ex);
+        break;
+      case ChatSDKErrorName.ChatTokenRetrievalFailure:
+        handleChatTokenRetrievalFailure(ex);
+        break;
+      case ChatSDKErrorName.UninitializedChatSDK:
+        handleUninitializedChatSDK(ex);
+        break;
+      case ChatSDKErrorName.InvalidConversation:
+      case ChatSDKErrorName.ClosedConversation:
+        handleInvalidOrClosedConversation(dispatch, chatSDK, props, ex);
+        return;
+      default:
+        logWidgetLoadFailed(ex);
+    }
+  }
+
+  // Show the error UI pane
+  dispatch({
+    type: LiveChatWidgetActionType.SET_START_CHAT_FAILING,
+    payload: true
+  });
+  if (!(props !== null && props !== void 0 && (_props$controlProps = props.controlProps) !== null && _props$controlProps !== void 0 && _props$controlProps.hideErrorUIPane)) {
+    // Set app state to failing start chat if hideErrorUI is not turned on
+    TelemetryHelper.logLoadingEvent(LogLevel.INFO, {
+      Event: TelemetryEvent.ErrorUIPaneLoaded,
+      Description: "Error UI Pane Loaded"
+    });
+  }
+  // Show the loading pane in other cases for failure, this will help for both hideStartChatButton case
+  dispatch({
+    type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+    payload: ConversationState.Loading
+  });
+
+  // If sessionInit was successful but LCW startchat failed due to some reason e.g adapter didn't load
+  // we need to directly endChat to avoid leaving ghost chats in OC, not disturbing any other UI state
+  if (isStartChatSuccessful === true) {
+    forceEndChat(chatSDK);
+  }
+};
+const logWidgetLoadFailed = ex => {
+  var _TelemetryTimers$Widg;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const exDetails = {
+    Exception: `Widget load complete with error: ${ex}`
+  };
+  if (ex !== null && ex !== void 0 && ex.httpResponseStatusCode) {
+    exDetails.HttpResponseStatusCode = ex.httpResponseStatusCode;
+  }
+  TelemetryHelper.logLoadingEvent(LogLevel.ERROR, {
+    Event: TelemetryEvent.WidgetLoadFailed,
+    ExceptionDetails: exDetails,
+    ElapsedTimeInMilliseconds: TelemetryTimers === null || TelemetryTimers === void 0 ? void 0 : (_TelemetryTimers$Widg = TelemetryTimers.WidgetLoadTimer) === null || _TelemetryTimers$Widg === void 0 ? void 0 : _TelemetryTimers$Widg.milliSecondsElapsed
+  });
+};
+export const logWidgetLoadComplete = additionalMessage => {
+  var _TelemetryTimers$Widg2;
+  let descriptionString = "Widget load complete";
+  if (additionalMessage) {
+    descriptionString += `. ${additionalMessage}`;
+  }
+  TelemetryHelper.logLoadingEvent(LogLevel.INFO, {
+    Event: TelemetryEvent.WidgetLoadComplete,
+    Description: descriptionString,
+    ElapsedTimeInMilliseconds: TelemetryTimers === null || TelemetryTimers === void 0 ? void 0 : (_TelemetryTimers$Widg2 = TelemetryTimers.WidgetLoadTimer) === null || _TelemetryTimers$Widg2 === void 0 ? void 0 : _TelemetryTimers$Widg2.milliSecondsElapsed
+  });
+};
+const logWidgetLoadCompleteWithError = ex => {
+  var _TelemetryTimers$Widg3;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const exDetails = {
+    Exception: `Widget load complete with error: ${ex}`
+  };
+  if (ex !== null && ex !== void 0 && ex.httpResponseStatusCode) {
+    exDetails.HttpResponseStatusCode = ex.httpResponseStatusCode;
+  }
+  TelemetryHelper.logLoadingEvent(LogLevel.WARN, {
+    Event: TelemetryEvent.WidgetLoadComplete,
+    Description: "Widget load complete with error",
+    ExceptionDetails: exDetails,
+    ElapsedTimeInMilliseconds: TelemetryTimers === null || TelemetryTimers === void 0 ? void 0 : (_TelemetryTimers$Widg3 = TelemetryTimers.WidgetLoadTimer) === null || _TelemetryTimers$Widg3 === void 0 ? void 0 : _TelemetryTimers$Widg3.milliSecondsElapsed
+  });
+};
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const forceEndChat = chatSDK => {
+  TelemetryHelper.logLoadingEvent(LogLevel.ERROR, {
+    Event: TelemetryEvent.WidgetLoadFailed,
+    ExceptionDetails: {
+      Exception: "SessionInit was successful, but widget load failed."
+    }
+  });
+  chatSDK === null || chatSDK === void 0 ? void 0 : chatSDK.endChat();
+};
+const handleWidgetUseOutsideOperatingHour = dispatch => {
+  dispatch({
+    type: LiveChatWidgetActionType.SET_OUTSIDE_OPERATING_HOURS,
+    payload: true
+  });
+  dispatch({
+    type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+    payload: ConversationState.OutOfOffice
+  });
+  logWidgetLoadComplete(WidgetLoadTelemetryMessage.OOOHMessage);
+};
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const handlePersistentChatConversationRetrievalFailure = ex => {
+  if (ex.httpResponseStatusCode === 400) {
+    logWidgetLoadFailed(ex);
+  } else {
+    logWidgetLoadCompleteWithError(ex);
+  }
+};
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const handleConversationInitializationFailure = ex => {
+  if (ex.httpResponseStatusCode === 400) {
+    logWidgetLoadFailed(ex);
+  } else {
+    logWidgetLoadCompleteWithError(ex);
+  }
+};
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const handleChatTokenRetrievalFailure = ex => {
+  if (ex.httpResponseStatusCode === 400) {
+    logWidgetLoadFailed(ex);
+  } else {
+    logWidgetLoadCompleteWithError(ex);
+  }
+};
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const handleUninitializedChatSDK = ex => {
+  logWidgetLoadCompleteWithError(ex);
+};
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const handleInvalidOrClosedConversation = (dispatch, chatSDK, props, ex) => {
+  var _DataStoreManager$cli;
+  logWidgetLoadCompleteWithError(ex);
+
+  // Reset all internal states
+  callingStateCleanUp(dispatch);
+  endChatStateCleanUp(dispatch);
+  closeChatStateCleanUp(dispatch);
+  chatSDKStateCleanUp(chatSDK);
+  (_DataStoreManager$cli = DataStoreManager.clientDataStore) === null || _DataStoreManager$cli === void 0 ? void 0 : _DataStoreManager$cli.removeData(getWidgetCacheIdfromProps(props));
+
+  // Starts new chat
+  dispatch({
+    type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+    payload: ConversationState.Closed
+  });
+};

package/lib/esm/components/livechatwidget/common/startChatErrorHandler.spec.js

@@ -0,0 +1,280 @@
+import { BroadcastService } from "@microsoft/omnichannel-chat-components";
+import { TelemetryHelper } from "../../../common/telemetry/TelemetryHelper";
+import { handleStartChatError } from "./startChatErrorHandler";
+import { WidgetLoadCustomErrorString, WidgetLoadTelemetryMessage } from "../../../common/Constants";
+import { ChatSDKError, ChatSDKErrorName } from "@microsoft/omnichannel-chat-sdk";
+import { LiveChatWidgetActionType } from "../../../contexts/common/LiveChatWidgetActionType";
+import { ConversationState } from "../../../contexts/common/ConversationState";
+describe("startChatErrorHandler unit test", () => {
+  it("handleStartChatError should log failed event and return if exception is undefined", () => {
+    const dispatch = jest.fn();
+    spyOn(BroadcastService, "postMessage").and.callFake(() => false);
+    spyOn(TelemetryHelper, "logLoadingEvent").and.callFake(() => false);
+    handleStartChatError(dispatch, {}, {}, undefined, false);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledTimes(1);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledWith("ERROR", expect.objectContaining({
+      ExceptionDetails: expect.objectContaining({
+        Exception: "Widget load complete with error: undefined"
+      })
+    }));
+    expect(dispatch).not.toHaveBeenCalled();
+  });
+  it("handleStartChatError should log failed with error event for AuthenticationFailedErrorString", () => {
+    const dispatch = jest.fn();
+    const mockEx = new Error(WidgetLoadCustomErrorString.AuthenticationFailedErrorString);
+    spyOn(BroadcastService, "postMessage").and.callFake(() => false);
+    spyOn(TelemetryHelper, "logLoadingEvent").and.callFake(() => false);
+    handleStartChatError(dispatch, {}, {}, mockEx, false);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledTimes(2);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledWith("WARN", expect.objectContaining({
+      ExceptionDetails: expect.objectContaining({
+        Exception: `Widget load complete with error: Error: ${WidgetLoadCustomErrorString.AuthenticationFailedErrorString}`
+      })
+    }));
+    expect(dispatch).toHaveBeenCalledTimes(2);
+    expect(dispatch).toHaveBeenCalledWith(expect.objectContaining({
+      type: LiveChatWidgetActionType.SET_CONVERSATION_STATE
+    }));
+  });
+  it("handleStartChatError should log failed with error event for NetworkErrorString", () => {
+    const dispatch = jest.fn();
+    const mockEx = new Error(WidgetLoadCustomErrorString.NetworkErrorString);
+    spyOn(BroadcastService, "postMessage").and.callFake(() => false);
+    spyOn(TelemetryHelper, "logLoadingEvent").and.callFake(() => false);
+    handleStartChatError(dispatch, {}, {}, mockEx, false);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledTimes(2);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledWith("WARN", expect.objectContaining({
+      ExceptionDetails: expect.objectContaining({
+        Exception: `Widget load complete with error: Error: ${WidgetLoadCustomErrorString.NetworkErrorString}`
+      })
+    }));
+    expect(dispatch).toHaveBeenCalledTimes(2);
+    expect(dispatch).toHaveBeenCalledWith(expect.objectContaining({
+      type: LiveChatWidgetActionType.SET_CONVERSATION_STATE
+    }));
+  });
+  it("handleStartChatError should log complete event for WidgetUseOutsideOperatingHour", () => {
+    const dispatch = jest.fn();
+    const mockEx = new ChatSDKError(ChatSDKErrorName.WidgetUseOutsideOperatingHour);
+    spyOn(BroadcastService, "postMessage").and.callFake(() => false);
+    spyOn(TelemetryHelper, "logLoadingEvent").and.callFake(() => false);
+    handleStartChatError(dispatch, {}, {}, mockEx, false);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledTimes(1);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledWith("INFO", expect.objectContaining({
+      Description: `Widget load complete. ${WidgetLoadTelemetryMessage.OOOHMessage}`
+    }));
+    expect(dispatch).toHaveBeenCalledTimes(2);
+    expect(dispatch).toHaveBeenCalledWith(expect.objectContaining({
+      type: LiveChatWidgetActionType.SET_CONVERSATION_STATE
+    }));
+    expect(dispatch).toHaveBeenCalledWith(expect.objectContaining({
+      type: LiveChatWidgetActionType.SET_OUTSIDE_OPERATING_HOURS
+    }));
+  });
+  it("handleStartChatError should log failed with error event for PersistentChatConversationRetrievalFailure for non-400 status", () => {
+    const dispatch = jest.fn();
+    const mockEx = new ChatSDKError(ChatSDKErrorName.PersistentChatConversationRetrievalFailure, 429);
+    spyOn(BroadcastService, "postMessage").and.callFake(() => false);
+    spyOn(TelemetryHelper, "logLoadingEvent").and.callFake(() => false);
+    handleStartChatError(dispatch, {}, {}, mockEx, false);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledTimes(2);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledWith("WARN", expect.objectContaining({
+      Description: "Widget load complete with error",
+      ExceptionDetails: expect.objectContaining({
+        Exception: `Widget load complete with error: ${ChatSDKErrorName.PersistentChatConversationRetrievalFailure}`,
+        HttpResponseStatusCode: 429
+      })
+    }));
+    expect(dispatch).toHaveBeenCalledTimes(2);
+    expect(dispatch).toHaveBeenCalledWith(expect.objectContaining({
+      type: LiveChatWidgetActionType.SET_CONVERSATION_STATE
+    }));
+  });
+  it("handleStartChatError should log failed event for PersistentChatConversationRetrievalFailure for 400 status", () => {
+    const dispatch = jest.fn();
+    const mockEx = new ChatSDKError(ChatSDKErrorName.PersistentChatConversationRetrievalFailure, 400);
+    spyOn(BroadcastService, "postMessage").and.callFake(() => false);
+    spyOn(TelemetryHelper, "logLoadingEvent").and.callFake(() => false);
+    handleStartChatError(dispatch, {}, {}, mockEx, false);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledTimes(2);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledWith("ERROR", expect.objectContaining({
+      ExceptionDetails: expect.objectContaining({
+        Exception: `Widget load complete with error: ${ChatSDKErrorName.PersistentChatConversationRetrievalFailure}`,
+        HttpResponseStatusCode: 400
+      })
+    }));
+    expect(dispatch).toHaveBeenCalledTimes(2);
+    expect(dispatch).toHaveBeenCalledWith(expect.objectContaining({
+      type: LiveChatWidgetActionType.SET_CONVERSATION_STATE
+    }));
+  });
+  it("handleStartChatError should log failed with error event for ConversationInitializationFailure for non-400 status", () => {
+    const dispatch = jest.fn();
+    const mockEx = new ChatSDKError(ChatSDKErrorName.ConversationInitializationFailure, 429);
+    spyOn(BroadcastService, "postMessage").and.callFake(() => false);
+    spyOn(TelemetryHelper, "logLoadingEvent").and.callFake(() => false);
+    handleStartChatError(dispatch, {}, {}, mockEx, false);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledTimes(2);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledWith("WARN", expect.objectContaining({
+      Description: "Widget load complete with error",
+      ExceptionDetails: expect.objectContaining({
+        Exception: `Widget load complete with error: ${ChatSDKErrorName.ConversationInitializationFailure}`,
+        HttpResponseStatusCode: 429
+      })
+    }));
+    expect(dispatch).toHaveBeenCalledTimes(2);
+    expect(dispatch).toHaveBeenCalledWith(expect.objectContaining({
+      type: LiveChatWidgetActionType.SET_CONVERSATION_STATE
+    }));
+  });
+  it("handleStartChatError should log failed event for ConversationInitializationFailure for 400 status", () => {
+    const dispatch = jest.fn();
+    const mockEx = new ChatSDKError(ChatSDKErrorName.ConversationInitializationFailure, 400);
+    spyOn(BroadcastService, "postMessage").and.callFake(() => false);
+    spyOn(TelemetryHelper, "logLoadingEvent").and.callFake(() => false);
+    handleStartChatError(dispatch, {}, {}, mockEx, false);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledTimes(2);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledWith("ERROR", expect.objectContaining({
+      ExceptionDetails: expect.objectContaining({
+        Exception: `Widget load complete with error: ${ChatSDKErrorName.ConversationInitializationFailure}`,
+        HttpResponseStatusCode: 400
+      })
+    }));
+    expect(dispatch).toHaveBeenCalledTimes(2);
+    expect(dispatch).toHaveBeenCalledWith(expect.objectContaining({
+      type: LiveChatWidgetActionType.SET_CONVERSATION_STATE
+    }));
+  });
+  it("handleStartChatError should log failed with error event for ChatTokenRetrievalFailure for non-400 status", () => {
+    const dispatch = jest.fn();
+    const mockEx = new ChatSDKError(ChatSDKErrorName.ChatTokenRetrievalFailure, 429);
+    spyOn(BroadcastService, "postMessage").and.callFake(() => false);
+    spyOn(TelemetryHelper, "logLoadingEvent").and.callFake(() => false);
+    handleStartChatError(dispatch, {}, {}, mockEx, false);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledTimes(2);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledWith("WARN", expect.objectContaining({
+      Description: "Widget load complete with error",
+      ExceptionDetails: expect.objectContaining({
+        Exception: `Widget load complete with error: ${ChatSDKErrorName.ChatTokenRetrievalFailure}`,
+        HttpResponseStatusCode: 429
+      })
+    }));
+    expect(dispatch).toHaveBeenCalledTimes(2);
+    expect(dispatch).toHaveBeenCalledWith(expect.objectContaining({
+      type: LiveChatWidgetActionType.SET_CONVERSATION_STATE
+    }));
+  });
+  it("handleStartChatError should log failed event for ChatTokenRetrievalFailure for 400 status", () => {
+    const dispatch = jest.fn();
+    const mockEx = new ChatSDKError(ChatSDKErrorName.ChatTokenRetrievalFailure, 400);
+    spyOn(BroadcastService, "postMessage").and.callFake(() => false);
+    spyOn(TelemetryHelper, "logLoadingEvent").and.callFake(() => false);
+    handleStartChatError(dispatch, {}, {}, mockEx, false);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledTimes(2);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledWith("ERROR", expect.objectContaining({
+      ExceptionDetails: expect.objectContaining({
+        Exception: `Widget load complete with error: ${ChatSDKErrorName.ChatTokenRetrievalFailure}`,
+        HttpResponseStatusCode: 400
+      })
+    }));
+    expect(dispatch).toHaveBeenCalledTimes(2);
+    expect(dispatch).toHaveBeenCalledWith(expect.objectContaining({
+      type: LiveChatWidgetActionType.SET_CONVERSATION_STATE
+    }));
+  });
+  it("handleStartChatError should log failed with error event for UninitializedChatSDK", () => {
+    const dispatch = jest.fn();
+    const mockEx = new ChatSDKError(ChatSDKErrorName.UninitializedChatSDK);
+    spyOn(BroadcastService, "postMessage").and.callFake(() => false);
+    spyOn(TelemetryHelper, "logLoadingEvent").and.callFake(() => false);
+    handleStartChatError(dispatch, {}, {}, mockEx, false);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledTimes(2);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledWith("WARN", expect.objectContaining({
+      Description: "Widget load complete with error",
+      ExceptionDetails: expect.objectContaining({
+        Exception: `Widget load complete with error: ${ChatSDKErrorName.UninitializedChatSDK}`
+      })
+    }));
+    expect(dispatch).toHaveBeenCalledTimes(2);
+    expect(dispatch).toHaveBeenCalledWith(expect.objectContaining({
+      type: LiveChatWidgetActionType.SET_CONVERSATION_STATE
+    }));
+  });
+  it("handleStartChatError should log failed with error event for InvalidConversation", () => {
+    const dispatch = jest.fn();
+    const mockEx = new ChatSDKError(ChatSDKErrorName.InvalidConversation);
+    spyOn(BroadcastService, "postMessage").and.callFake(() => false);
+    spyOn(TelemetryHelper, "logLoadingEvent").and.callFake(() => false);
+    handleStartChatError(dispatch, {}, {}, mockEx, false);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledTimes(1);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledWith("WARN", expect.objectContaining({
+      Description: "Widget load complete with error",
+      ExceptionDetails: expect.objectContaining({
+        Exception: `Widget load complete with error: ${ChatSDKErrorName.InvalidConversation}`
+      })
+    }));
+    expect(dispatch).toHaveBeenCalledTimes(16);
+    expect(dispatch).toHaveBeenCalledWith(expect.objectContaining({
+      type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+      payload: ConversationState.Closed
+    }));
+  });
+  it("handleStartChatError should log failed with error event for ClosedConversation", () => {
+    const dispatch = jest.fn();
+    const mockEx = new ChatSDKError(ChatSDKErrorName.ClosedConversation);
+    spyOn(BroadcastService, "postMessage").and.callFake(() => false);
+    spyOn(TelemetryHelper, "logLoadingEvent").and.callFake(() => false);
+    handleStartChatError(dispatch, {}, {}, mockEx, false);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledTimes(1);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledWith("WARN", expect.objectContaining({
+      Description: "Widget load complete with error",
+      ExceptionDetails: expect.objectContaining({
+        Exception: `Widget load complete with error: ${ChatSDKErrorName.ClosedConversation}`
+      })
+    }));
+    expect(dispatch).toHaveBeenCalledTimes(16);
+    expect(dispatch).toHaveBeenCalledWith(expect.objectContaining({
+      type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+      payload: ConversationState.Closed
+    }));
+  });
+  it("handleStartChatError should log failed event for any other errors", () => {
+    const dispatch = jest.fn();
+    const mockEx = new ChatSDKError(ChatSDKErrorName.ScriptLoadFailure, 405);
+    spyOn(BroadcastService, "postMessage").and.callFake(() => false);
+    spyOn(TelemetryHelper, "logLoadingEvent").and.callFake(() => false);
+    handleStartChatError(dispatch, {}, {}, mockEx, false);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledTimes(2);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledWith("ERROR", expect.objectContaining({
+      ExceptionDetails: expect.objectContaining({
+        Exception: `Widget load complete with error: ${ChatSDKErrorName.ScriptLoadFailure}`,
+        HttpResponseStatusCode: 405
+      })
+    }));
+    expect(dispatch).toHaveBeenCalledTimes(2);
+    expect(dispatch).toHaveBeenCalledWith(expect.objectContaining({
+      type: LiveChatWidgetActionType.SET_CONVERSATION_STATE
+    }));
+  });
+  it("handleStartChatError should force end chat if isStartChatSuccessful is true", () => {
+    const dispatch = jest.fn();
+    const mockEx = new ChatSDKError(ChatSDKErrorName.ScriptLoadFailure, 405);
+    const mockSDK = {
+      endChat: jest.fn()
+    };
+    spyOn(BroadcastService, "postMessage").and.callFake(() => false);
+    spyOn(TelemetryHelper, "logLoadingEvent").and.callFake(() => false);
+    handleStartChatError(dispatch, mockSDK, {}, mockEx, true);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledTimes(3);
+    expect(TelemetryHelper.logLoadingEvent).toHaveBeenCalledWith("ERROR", expect.objectContaining({
+      ExceptionDetails: expect.objectContaining({
+        Exception: "SessionInit was successful, but widget load failed."
+      })
+    }));
+    expect(dispatch).toHaveBeenCalledTimes(2);
+    expect(dispatch).toHaveBeenCalledWith(expect.objectContaining({
+      type: LiveChatWidgetActionType.SET_CONVERSATION_STATE
+    }));
+    expect(mockSDK.endChat).toHaveBeenCalled();
+  });
+});

package/lib/esm/components/livechatwidget/livechatwidgetstateful/LiveChatWidgetStateful.js

@@ -8,7 +8,7 @@ import React, { useEffect, useRef, useState } from "react";
 import { checkIfConversationStillValid, initStartChat, prepareStartChat, setPreChatAndInitiateChat } from "../common/startChat";
 import { createTimer, getBroadcastChannelName, getConversationDetailsCall, getLocaleDirection, getStateFromCache, getWidgetCacheIdfromProps, getWidgetEndChatEventName, isNullOrEmptyString, isNullOrUndefined, isUndefinedOrEmpty } from "../../../common/utils";
 import { defaultClientDataStoreProvider, isCookieAllowed } from "../../../common/storage/default/defaultClientDataStoreProvider";
-import { endChat, endChatStateCleanUp, prepareEndChat } from "../common/endChat";
+import { chatSDKStateCleanUp, endChat, endChatStateCleanUp, prepareEndChat } from "../common/endChat";
 import { handleChatReconnect, isPersistentEnabled, isReconnectEnabled } from "../common/reconnectChatHelper";
 import { shouldShowCallingContainer, shouldShowChatButton, shouldShowConfirmationPane, shouldShowEmailTranscriptPane, shouldShowHeader, shouldShowLoadingPane, shouldShowOutOfOfficeHoursPane, shouldShowPostChatLoadingPane, shouldShowPostChatSurveyPane, shouldShowPreChatSurveyPane, shouldShowProactiveChatPane, shouldShowReconnectChatPane, shouldShowWebChatContainer } from "../../../controller/componentController";
 import { ActivityStreamHandler } from "../common/ActivityStreamHandler";
@@ -51,7 +51,6 @@ import useChatAdapterStore from "../../../hooks/useChatAdapterStore";
 import useChatContextStore from "../../../hooks/useChatContextStore";
 import useChatSDKStore from "../../../hooks/useChatSDKStore";
 import { defaultAdaptiveCardStyles } from "../../webchatcontainerstateful/common/defaultStyles/defaultAdaptiveCardStyles";
-import { uuidv4 } from "@microsoft/omnichannel-chat-sdk";
 export const LiveChatWidgetStateful = props => {
   var _props$webChatContain, _props$styleProps, _props$controlProps, _props$controlProps3, _state$appStates7, _props$webChatContain5, _state$appStates14, _props$webChatContain6, _props$controlProps12, _props$draggableChatW, _props$draggableChatW2, _props$draggableChatW3, _props$draggableChatW4, _props$draggableChatW5, _props$webChatContain7, _props$webChatContain8, _props$webChatContain9, _props$webChatContain10, _livechatProps$webCha, _livechatProps$styleP, _livechatProps$contro, _livechatProps$contro2, _livechatProps$compon, _livechatProps$contro3, _livechatProps$compon2, _livechatProps$contro4, _livechatProps$compon3, _livechatProps$contro5, _livechatProps$compon4, _livechatProps$contro6, _livechatProps$compon5, _livechatProps$contro7, _livechatProps$compon6, _livechatProps$contro8, _livechatProps$compon7, _livechatProps$contro9, _livechatProps$contro10, _livechatProps$compon8, _livechatProps$contro11, _livechatProps$compon9, _livechatProps$contro12, _livechatProps$compon10, _livechatProps$compon11, _livechatProps$compon12;
   const [state, dispatch] = useChatContextStore();
@@ -425,12 +424,7 @@ export const LiveChatWidgetStateful = props => {
       if ((msg === null || msg === void 0 ? void 0 : (_msg$payload9 = msg.payload) === null || _msg$payload9 === void 0 ? void 0 : _msg$payload9.runtimeId) !== TelemetryManager.InternalTelemetryData.lcwRuntimeId) {
         endChat(props, chatSDK, state, dispatch, setAdapter, setWebChatStyles, adapter, true, false, false);
         endChatStateCleanUp(dispatch);
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        chatSDK.requestId = uuidv4();
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        chatSDK.chatToken = {};
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        chatSDK.reconnectId = null;
+        chatSDKStateCleanUp(chatSDK);
         return;
       }
     });

package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/activityMiddleware.js

@@ -11,7 +11,6 @@ import { LogLevel, TelemetryEvent } from "../../../../../common/telemetry/Teleme
 import { Constants } from "../../../../../common/Constants";
 import { DirectLineActivityType } from "../../enums/DirectLineActivityType";
 import { DirectLineSenderRole } from "../../enums/DirectLineSenderRole";
-import { MessageTypes } from "../../enums/MessageType";
 import React from "react";
 import { TelemetryHelper } from "../../../../../common/telemetry/TelemetryHelper";
 import { defaultSystemMessageStyles } from "./defaultStyles/defaultSystemMessageStyles";
@@ -74,13 +73,6 @@ export const createActivityMiddleware = (systemMessageStyleProps, userMessageSty
   if (card.activity) {
     var _card$activity$from;
     if (((_card$activity$from = card.activity.from) === null || _card$activity$from === void 0 ? void 0 : _card$activity$from.role) === DirectLineSenderRole.Channel) {
-      var _card$activity$channe3;
-      if (((_card$activity$channe3 = card.activity.channelData) === null || _card$activity$channe3 === void 0 ? void 0 : _card$activity$channe3.type) === MessageTypes.Thread) {
-        TelemetryHelper.logActionEvent(LogLevel.INFO, {
-          Event: TelemetryEvent.IC3ThreadUpdateEventReceived,
-          Description: "IC3 ThreadUpdateEvent Received"
-        });
-      }
       return () => false;
     }
     if (isTagIncluded(card, Constants.hiddenTag)) {

package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/activityMiddleware.spec.js

@@ -20,7 +20,7 @@ describe("activityMiddleware test", () => {
     };
     const results = createActivityMiddleware()()(next)(args);
     expect(results()).toEqual(false);
-    expect(TelemetryHelper.logActionEvent).toHaveBeenCalledTimes(1);
+    expect(TelemetryHelper.logActionEvent).toHaveBeenCalledTimes(0);
   });
   it("createActivityMiddleware() with Hidden tag should return nothing", () => {
     spyOn(TelemetryHelper, "logActionEvent").and.callFake(() => false);

package/lib/types/common/Constants.d.ts

@@ -160,10 +160,6 @@ export declare class LocaleConstants {
 export declare enum ElementType {
     CallingContainerSDK = "CallingContainerSDK"
 }
-export declare enum ChatSDKError {
-    WidgetUseOutsideOperatingHour = "WidgetUseOutsideOperatingHour",
-    AuthContactIdNotFoundFailure = "AuthContactIdNotFoundFailure"
-}
 export declare enum EnvironmentVersion {
     prod = "prod",
     dogfood = "df",
@@ -241,3 +237,11 @@ export declare class AriaTelemetryConstants {
     static readonly EU: string;
     static readonly lcwEUDomainNames: Array<string>;
 }
+export declare class WidgetLoadTelemetryMessage {
+    static readonly OOOHMessage = "Widget is OOOH";
+    static readonly PersistedStateRetrievedMessage = "Persisted state retrieved";
+}
+export declare class WidgetLoadCustomErrorString {
+    static readonly AuthenticationFailedErrorString = "Authentication was not successful";
+    static readonly NetworkErrorString = "Network Error";
+}

package/lib/types/common/telemetry/TelemetryConstants.d.ts

@@ -120,7 +120,6 @@ export declare enum TelemetryEvent {
     ErrorUIPaneLoaded = "ErrorUIPaneLoaded",
     DownloadTranscriptFailed = "DownloadTranscriptFailed",
     StartChatFailed = "StartChatFailed",
-    IC3ThreadUpdateEventReceived = "IC3ThreadUpdateEventReceived",
     ConfirmationCancelButtonClicked = "ConfirmationCancelButtonClicked",
     ConfirmationConfirmButtonClicked = "ConfirmationConfirmButtonClicked",
     LoadingPaneLoaded = "LoadingPaneLoaded",

package/lib/types/components/livechatwidget/common/endChat.d.ts

@@ -4,8 +4,9 @@ import { ILiveChatWidgetContext } from "../../../contexts/common/ILiveChatWidget
 import { ILiveChatWidgetProps } from "../interfaces/ILiveChatWidgetProps";
 declare const prepareEndChat: (props: ILiveChatWidgetProps, chatSDK: any, state: ILiveChatWidgetContext, dispatch: Dispatch<ILiveChatWidgetAction>, setAdapter: any, setWebChatStyles: any, adapter: any) => Promise<void>;
 declare const endChat: (props: ILiveChatWidgetProps, chatSDK: any, state: ILiveChatWidgetContext, dispatch: Dispatch<ILiveChatWidgetAction>, setAdapter: any, setWebChatStyles: any, adapter: any, skipEndChatSDK?: boolean | undefined, skipCloseChat?: boolean | undefined, postMessageToOtherTab?: boolean | undefined) => Promise<void>;
-export declare const callingStateCleanUp: (dispatch: Dispatch<ILiveChatWidgetAction>) => Promise<void>;
-export declare const endChatStateCleanUp: (dispatch: Dispatch<ILiveChatWidgetAction>) => Promise<void>;
-export declare const closeChatStateCleanUp: (dispatch: Dispatch<ILiveChatWidgetAction>) => Promise<void>;
+export declare const callingStateCleanUp: (dispatch: Dispatch<ILiveChatWidgetAction>) => void;
+export declare const endChatStateCleanUp: (dispatch: Dispatch<ILiveChatWidgetAction>) => void;
+export declare const closeChatStateCleanUp: (dispatch: Dispatch<ILiveChatWidgetAction>) => void;
+export declare const chatSDKStateCleanUp: (chatSDK: any) => void;
 export declare const endVoiceVideoCallIfOngoing: (chatSDK: any, dispatch: Dispatch<ILiveChatWidgetAction>) => Promise<void>;
 export { prepareEndChat, endChat };

package/lib/types/components/livechatwidget/common/startChatErrorHandler.d.ts

@@ -0,0 +1,5 @@
+import { Dispatch } from "react";
+import { ILiveChatWidgetAction } from "../../../contexts/common/ILiveChatWidgetAction";
+import { ILiveChatWidgetProps } from "../interfaces/ILiveChatWidgetProps";
+export declare const handleStartChatError: (dispatch: Dispatch<ILiveChatWidgetAction>, chatSDK: any, props: ILiveChatWidgetProps | undefined, ex: any, isStartChatSuccessful: boolean) => void;
+export declare const logWidgetLoadComplete: (additionalMessage?: string | undefined) => void;

package/lib/types/components/livechatwidget/common/startChatErrorHandler.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/omnichannel-chat-widget",
-  "version": "1.5.1-main.c3533cf",
+  "version": "1.5.1-main.e2be12d",
   "description": "Microsoft Omnichannel Chat Widget",
   "main": "lib/cjs/index.js",
   "types": "lib/types/index.d.ts",
@@ -75,7 +75,7 @@
   },
   "dependencies": {
     "@microsoft/omnichannel-chat-components": "^1.0.9",
-    "@microsoft/omnichannel-chat-sdk": "1.5.7",
+    "@microsoft/omnichannel-chat-sdk": "1.6.1",
     "abort-controller-es5": "^2.0.1",
     "dompurify": "^2.3.4",
     "markdown-it": "^12.3.2",