@microsoft/omnichannel-chat-widget 1.5.0 → 1.5.1-main.6b98130

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

@@ -0,0 +1,212 @@
+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";
+import { StartChatFailureType } from "../../../contexts/common/StartChatFailureType";
+
+// 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) {
+    dispatch({
+      type: LiveChatWidgetActionType.SET_START_CHAT_FAILURE_TYPE,
+      payload: StartChatFailureType.AuthSetupError
+    });
+    logWidgetLoadCompleteWithError(ex);
+  }
+  if (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(dispatch, 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)) {
+    // New flow of leveraging ConversationState.Error
+    // 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"
+    });
+    dispatch({
+      type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+      payload: ConversationState.Error
+    });
+  } else {
+    // Old flow of leveraging ConversationState.Loading
+    // 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 = (dispatch, ex) => {
+  if (ex.httpResponseStatusCode === 400) {
+    logWidgetLoadFailed(ex);
+  } else {
+    if (ex.httpResponseStatusCode === 401) {
+      dispatch({
+        type: LiveChatWidgetActionType.SET_START_CHAT_FAILURE_TYPE,
+        payload: StartChatFailureType.Unauthorized
+      });
+    }
+    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,298 @@
+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(3);
+    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 ChatTokenRetrievalFailure for 401 status", () => {
+    const dispatch = jest.fn();
+    const mockEx = new ChatSDKError(ChatSDKErrorName.ChatTokenRetrievalFailure, 401);
+    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: ${ChatSDKErrorName.ChatTokenRetrievalFailure}`,
+        HttpResponseStatusCode: 401
+      })
+    }));
+    expect(dispatch).toHaveBeenCalledTimes(3);
+    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,9 +8,9 @@ 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 { shouldShowCallingContainer, shouldShowChatButton, shouldShowConfirmationPane, shouldShowEmailTranscriptPane, shouldShowStartChatErrorPane, shouldShowHeader, shouldShowLoadingPane, shouldShowOutOfOfficeHoursPane, shouldShowPostChatLoadingPane, shouldShowPostChatSurveyPane, shouldShowPreChatSurveyPane, shouldShowProactiveChatPane, shouldShowReconnectChatPane, shouldShowWebChatContainer } from "../../../controller/componentController";
 import { ActivityStreamHandler } from "../common/ActivityStreamHandler";
 import CallingContainerStateful from "../../callingcontainerstateful/CallingContainerStateful";
 import ChatButtonStateful from "../../chatbuttonstateful/ChatButtonStateful";
@@ -51,9 +51,10 @@ 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";
+import StartChatErrorPaneStateful from "../../startchaterrorpanestateful/StartChatErrorPaneStateful";
+import { StartChatFailureType } from "../../../contexts/common/StartChatFailureType";
 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;
+  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$compon8, _livechatProps$contro10, _livechatProps$contro11, _livechatProps$compon9, _livechatProps$contro12, _livechatProps$compon10, _livechatProps$contro13, _livechatProps$compon11, _livechatProps$compon12, _livechatProps$compon13;
   const [state, dispatch] = useChatContextStore();
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   const [adapter, setAdapter] = useChatAdapterStore();
@@ -186,6 +187,14 @@ export const LiveChatWidgetStateful = props => {
   };
   useEffect(() => {
     var _props$controlProps5, _props$controlProps6, _props$controlProps7, _props$chatConfig, _props$chatConfig$Liv, _props$controlProps9, _props$chatConfig2, _props$chatConfig2$Ch, _state$appStates5;
+    dispatch({
+      type: LiveChatWidgetActionType.SET_START_CHAT_FAILING,
+      payload: false
+    });
+    dispatch({
+      type: LiveChatWidgetActionType.SET_START_CHAT_FAILURE_TYPE,
+      payload: StartChatFailureType.Generic
+    });
     state.domainStates.confirmationPaneConfirmedOptionClicked = false;
     state.domainStates.confirmationState = ConfirmationState.NotSet;
     setupClientDataStore();
@@ -425,12 +434,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;
       }
     });
@@ -608,9 +612,7 @@ export const LiveChatWidgetStateful = props => {
 
   // Handle Chat disconnect cases
   useEffect(() => {
-    if (state.appStates.chatDisconnectEventReceived) {
-      handleChatDisconnect(props, state, setWebChatStyles);
-    }
+    handleChatDisconnect(props, state, setWebChatStyles);
   }, [state.appStates.chatDisconnectEventReceived]);
   const initiateEndChatOnBrowserUnload = () => {
     var _DataStoreManager$cli;
@@ -707,17 +709,17 @@ export const LiveChatWidgetStateful = props => {
   }, headerDraggableConfig))), !((_livechatProps$contro5 = livechatProps.controlProps) !== null && _livechatProps$contro5 !== void 0 && _livechatProps$contro5.hideLoadingPane) && shouldShowLoadingPane(state) && (decodeComponentString((_livechatProps$compon4 = livechatProps.componentOverrides) === null || _livechatProps$compon4 === void 0 ? void 0 : _livechatProps$compon4.loadingPane) || /*#__PURE__*/React.createElement(LoadingPaneStateful, {
     loadingPaneProps: livechatProps.loadingPaneProps,
     startChatErrorPaneProps: livechatProps.startChatErrorPaneProps
-  })), !((_livechatProps$contro6 = livechatProps.controlProps) !== null && _livechatProps$contro6 !== void 0 && _livechatProps$contro6.hideOutOfOfficeHoursPane) && shouldShowOutOfOfficeHoursPane(state) && (decodeComponentString((_livechatProps$compon5 = livechatProps.componentOverrides) === null || _livechatProps$compon5 === void 0 ? void 0 : _livechatProps$compon5.outOfOfficeHoursPane) || /*#__PURE__*/React.createElement(OutOfOfficeHoursPaneStateful, livechatProps.outOfOfficeHoursPaneProps)), !((_livechatProps$contro7 = livechatProps.controlProps) !== null && _livechatProps$contro7 !== void 0 && _livechatProps$contro7.hideReconnectChatPane) && shouldShowReconnectChatPane(state) && (decodeComponentString((_livechatProps$compon6 = livechatProps.componentOverrides) === null || _livechatProps$compon6 === void 0 ? void 0 : _livechatProps$compon6.reconnectChatPane) || /*#__PURE__*/React.createElement(ReconnectChatPaneStateful, {
+  })), !((_livechatProps$contro6 = livechatProps.controlProps) !== null && _livechatProps$contro6 !== void 0 && _livechatProps$contro6.hideErrorUIPane) && shouldShowStartChatErrorPane(state) && (decodeComponentString((_livechatProps$compon5 = livechatProps.componentOverrides) === null || _livechatProps$compon5 === void 0 ? void 0 : _livechatProps$compon5.startChatErrorPane) || /*#__PURE__*/React.createElement(StartChatErrorPaneStateful, livechatProps.startChatErrorPaneProps)), !((_livechatProps$contro7 = livechatProps.controlProps) !== null && _livechatProps$contro7 !== void 0 && _livechatProps$contro7.hideOutOfOfficeHoursPane) && shouldShowOutOfOfficeHoursPane(state) && (decodeComponentString((_livechatProps$compon6 = livechatProps.componentOverrides) === null || _livechatProps$compon6 === void 0 ? void 0 : _livechatProps$compon6.outOfOfficeHoursPane) || /*#__PURE__*/React.createElement(OutOfOfficeHoursPaneStateful, livechatProps.outOfOfficeHoursPaneProps)), !((_livechatProps$contro8 = livechatProps.controlProps) !== null && _livechatProps$contro8 !== void 0 && _livechatProps$contro8.hideReconnectChatPane) && shouldShowReconnectChatPane(state) && (decodeComponentString((_livechatProps$compon7 = livechatProps.componentOverrides) === null || _livechatProps$compon7 === void 0 ? void 0 : _livechatProps$compon7.reconnectChatPane) || /*#__PURE__*/React.createElement(ReconnectChatPaneStateful, {
     reconnectChatProps: livechatProps.reconnectChatPaneProps,
     initStartChat: initStartChatRelay
-  })), !((_livechatProps$contro8 = livechatProps.controlProps) !== null && _livechatProps$contro8 !== void 0 && _livechatProps$contro8.hidePreChatSurveyPane) && shouldShowPreChatSurveyPane(state) && (decodeComponentString((_livechatProps$compon7 = livechatProps.componentOverrides) === null || _livechatProps$compon7 === void 0 ? void 0 : _livechatProps$compon7.preChatSurveyPane) || /*#__PURE__*/React.createElement(PreChatSurveyPaneStateful, {
+  })), !((_livechatProps$contro9 = livechatProps.controlProps) !== null && _livechatProps$contro9 !== void 0 && _livechatProps$contro9.hidePreChatSurveyPane) && shouldShowPreChatSurveyPane(state) && (decodeComponentString((_livechatProps$compon8 = livechatProps.componentOverrides) === null || _livechatProps$compon8 === void 0 ? void 0 : _livechatProps$compon8.preChatSurveyPane) || /*#__PURE__*/React.createElement(PreChatSurveyPaneStateful, {
     surveyProps: livechatProps.preChatSurveyPaneProps,
     initStartChat: initStartChatRelay
-  })), !((_livechatProps$contro9 = livechatProps.controlProps) !== null && _livechatProps$contro9 !== void 0 && _livechatProps$contro9.hideCallingContainer) && shouldShowCallingContainer(state) && /*#__PURE__*/React.createElement(CallingContainerStateful, _extends({
+  })), !((_livechatProps$contro10 = livechatProps.controlProps) !== null && _livechatProps$contro10 !== void 0 && _livechatProps$contro10.hideCallingContainer) && shouldShowCallingContainer(state) && /*#__PURE__*/React.createElement(CallingContainerStateful, _extends({
     voiceVideoCallingSdk: voiceVideoCallingSDK
-  }, livechatProps.callingContainerProps)), !((_livechatProps$contro10 = livechatProps.controlProps) !== null && _livechatProps$contro10 !== void 0 && _livechatProps$contro10.hideWebChatContainer) && shouldShowWebChatContainer(state) && (decodeComponentString((_livechatProps$compon8 = livechatProps.componentOverrides) === null || _livechatProps$compon8 === void 0 ? void 0 : _livechatProps$compon8.webChatContainer) || /*#__PURE__*/React.createElement(WebChatContainerStateful, livechatProps)), !((_livechatProps$contro11 = livechatProps.controlProps) !== null && _livechatProps$contro11 !== void 0 && _livechatProps$contro11.hideConfirmationPane) && shouldShowConfirmationPane(state) && (decodeComponentString((_livechatProps$compon9 = livechatProps.componentOverrides) === null || _livechatProps$compon9 === void 0 ? void 0 : _livechatProps$compon9.confirmationPane) || /*#__PURE__*/React.createElement(ConfirmationPaneStateful, _extends({}, confirmationPaneProps, {
+  }, livechatProps.callingContainerProps)), !((_livechatProps$contro11 = livechatProps.controlProps) !== null && _livechatProps$contro11 !== void 0 && _livechatProps$contro11.hideWebChatContainer) && shouldShowWebChatContainer(state) && (decodeComponentString((_livechatProps$compon9 = livechatProps.componentOverrides) === null || _livechatProps$compon9 === void 0 ? void 0 : _livechatProps$compon9.webChatContainer) || /*#__PURE__*/React.createElement(WebChatContainerStateful, livechatProps)), !((_livechatProps$contro12 = livechatProps.controlProps) !== null && _livechatProps$contro12 !== void 0 && _livechatProps$contro12.hideConfirmationPane) && shouldShowConfirmationPane(state) && (decodeComponentString((_livechatProps$compon10 = livechatProps.componentOverrides) === null || _livechatProps$compon10 === void 0 ? void 0 : _livechatProps$compon10.confirmationPane) || /*#__PURE__*/React.createElement(ConfirmationPaneStateful, _extends({}, confirmationPaneProps, {
     setPostChatContext: setPostChatContextRelay,
     prepareEndChat: prepareEndChatRelay
-  }))), !((_livechatProps$contro12 = livechatProps.controlProps) !== null && _livechatProps$contro12 !== void 0 && _livechatProps$contro12.hidePostChatLoadingPane) && shouldShowPostChatLoadingPane(state) && (decodeComponentString((_livechatProps$compon10 = livechatProps.componentOverrides) === null || _livechatProps$compon10 === void 0 ? void 0 : _livechatProps$compon10.postChatLoadingPane) || /*#__PURE__*/React.createElement(PostChatLoadingPaneStateful, livechatProps.postChatLoadingPaneProps)), shouldShowPostChatSurveyPane(state) && (decodeComponentString((_livechatProps$compon11 = livechatProps.componentOverrides) === null || _livechatProps$compon11 === void 0 ? void 0 : _livechatProps$compon11.postChatSurveyPane) || /*#__PURE__*/React.createElement(PostChatSurveyPaneStateful, _extends({}, livechatProps.postChatSurveyPaneProps, livechatProps.chatSDK))), createFooter(livechatProps, state), shouldShowEmailTranscriptPane(state) && (decodeComponentString((_livechatProps$compon12 = livechatProps.componentOverrides) === null || _livechatProps$compon12 === void 0 ? void 0 : _livechatProps$compon12.emailTranscriptPane) || /*#__PURE__*/React.createElement(EmailTranscriptPaneStateful, livechatProps.emailTranscriptPane))))));
+  }))), !((_livechatProps$contro13 = livechatProps.controlProps) !== null && _livechatProps$contro13 !== void 0 && _livechatProps$contro13.hidePostChatLoadingPane) && shouldShowPostChatLoadingPane(state) && (decodeComponentString((_livechatProps$compon11 = livechatProps.componentOverrides) === null || _livechatProps$compon11 === void 0 ? void 0 : _livechatProps$compon11.postChatLoadingPane) || /*#__PURE__*/React.createElement(PostChatLoadingPaneStateful, livechatProps.postChatLoadingPaneProps)), shouldShowPostChatSurveyPane(state) && (decodeComponentString((_livechatProps$compon12 = livechatProps.componentOverrides) === null || _livechatProps$compon12 === void 0 ? void 0 : _livechatProps$compon12.postChatSurveyPane) || /*#__PURE__*/React.createElement(PostChatSurveyPaneStateful, _extends({}, livechatProps.postChatSurveyPaneProps, livechatProps.chatSDK))), createFooter(livechatProps, state), shouldShowEmailTranscriptPane(state) && (decodeComponentString((_livechatProps$compon13 = livechatProps.componentOverrides) === null || _livechatProps$compon13 === void 0 ? void 0 : _livechatProps$compon13.emailTranscriptPane) || /*#__PURE__*/React.createElement(EmailTranscriptPaneStateful, livechatProps.emailTranscriptPane))))));
 };
 export default LiveChatWidgetStateful;

package/lib/esm/components/loadingpanestateful/LoadingPaneStateful.js

@@ -3,10 +3,10 @@ import React, { useEffect } from "react";
 import { LoadingPane } from "@microsoft/omnichannel-chat-components";
 import { TelemetryHelper } from "../../common/telemetry/TelemetryHelper";
 import { defaultGeneralLoadingPaneStyleProps } from "./common/defaultStyleProps/defaultgeneralLoadingPaneStyleProps";
-import { errorUILoadingPaneStyleProps } from "./common/errorUIStyleProps/errorUILoadingPaneStyleProps";
 import { findAllFocusableElement } from "../../common/utils";
 import useChatContextStore from "../../hooks/useChatContextStore";
 import useWindowDimensions from "../../hooks/useWindowDimensions";
+import { errorUILoadingPaneStyleProps } from "./common/errorUIStyleProps/errorUILoadingPaneStyleProps";
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const LoadingPaneStateful = props => {