@microsoft/omnichannel-chat-widget 1.7.8-main.29ce174 → 1.7.8-main.50111af

package/lib/esm/contexts/common/LiveChatWidgetContextInitialState.js

@@ -1,11 +1,15 @@
-import { ConversationState } from "./ConversationState";
-import { defaultMiddlewareLocalizedTexts } from "../../components/webchatcontainerstateful/common/defaultProps/defaultMiddlewareLocalizedTexts";
-import { getWidgetCacheIdfromProps, isNullOrUndefined } from "../../common/utils";
-import { defaultClientDataStoreProvider } from "../../common/storage/default/defaultClientDataStoreProvider";
 import { ConfirmationState, Constants, ConversationEndEntity, StorageType } from "../../common/Constants";
+import { getWidgetCacheIdfromProps, isNullOrUndefined } from "../../common/utils";
+import { ConversationState } from "./ConversationState";
 import { StartChatFailureType } from "./StartChatFailureType";
+import { defaultClientDataStoreProvider } from "../../common/storage/default/defaultClientDataStoreProvider";
+import { defaultMiddlewareLocalizedTexts } from "../../components/webchatcontainerstateful/common/defaultProps/defaultMiddlewareLocalizedTexts";
 export const getLiveChatWidgetContextInitialState = props => {
   var _props$controlProps, _props$webChatContain;
+  const isOutsideOperatingHours = () => {
+    var _props$chatConfig, _props$chatConfig$Liv, _props$chatConfig$Liv2;
+    return ((_props$chatConfig = props.chatConfig) === null || _props$chatConfig === void 0 ? void 0 : (_props$chatConfig$Liv = _props$chatConfig.LiveWSAndLiveChatEngJoin) === null || _props$chatConfig$Liv === void 0 ? void 0 : (_props$chatConfig$Liv2 = _props$chatConfig$Liv.OutOfOperatingHours) === null || _props$chatConfig$Liv2 === void 0 ? void 0 : _props$chatConfig$Liv2.toString().toLowerCase()) === "true";
+  };
   const widgetCacheId = getWidgetCacheIdfromProps(props);
   const cacheTtlInMins = (props === null || props === void 0 ? void 0 : (_props$controlProps = props.controlProps) === null || _props$controlProps === void 0 ? void 0 : _props$controlProps.cacheTtlInMins) ?? Constants.CacheTtlInMinutes;
   const storageType = (props === null || props === void 0 ? void 0 : props.useSessionStorage) === true ? StorageType.sessionStorage : StorageType.localStorage;
@@ -22,6 +26,14 @@ export const getLiveChatWidgetContextInitialState = props => {
     if (initialStateFromCache.appStates.conversationState === ConversationState.Prechat) {
       initialStateFromCache.appStates.conversationState = ConversationState.Closed;
     }
+
+    // we are always setting the chatConfig from the props to avoid any issues with the cache
+    initialStateFromCache.domainStates.liveChatConfig = props.chatConfig;
+
+    // Cache the result of isOutsideOperatingHours() to ensure consistency
+    const outsideOperatingHours = isOutsideOperatingHours();
+    initialStateFromCache.appStates.outsideOperatingHours = outsideOperatingHours;
+    initialStateFromCache.appStates.conversationState = outsideOperatingHours ? ConversationState.OutOfOffice : initialStateFromCache.appStates.conversationState;
     return initialStateFromCache;
   }
   const LiveChatWidgetContextInitialState = {
@@ -46,11 +58,11 @@ export const getLiveChatWidgetContextInitialState = props => {
       startChatFailureType: StartChatFailureType.Generic
     },
     appStates: {
-      conversationState: ConversationState.Closed,
+      conversationState: isOutsideOperatingHours() ? ConversationState.OutOfOffice : ConversationState.Closed,
       isMinimized: undefined,
       previousElementIdOnFocusBeforeModalOpen: null,
       startChatFailed: false,
-      outsideOperatingHours: false,
+      outsideOperatingHours: isOutsideOperatingHours(),
       preChatResponseEmail: "",
       isAudioMuted: null,
       newMessage: false,

package/lib/esm/firstresponselatency/Constants.js

@@ -0,0 +1,6 @@
+export let ScenarioType;
+(function (ScenarioType) {
+  ScenarioType["UserSendMessageStrategy"] = "UserSendMessageStrategy";
+  ScenarioType["SystemMessageStrategy"] = "SystemMessageStrategy";
+  ScenarioType["ReceivedMessageStrategy"] = "ReceivedMessageStrategy";
+})(ScenarioType || (ScenarioType = {}));

package/lib/esm/firstresponselatency/FirstMessageTrackerFromBot.js

@@ -0,0 +1,112 @@
+import { BroadcastEvent, LogLevel, TelemetryEvent } from "../common/telemetry/TelemetryConstants";
+import { BroadcastService } from "@microsoft/omnichannel-chat-components";
+import { TelemetryHelper } from "../common/telemetry/TelemetryHelper";
+import { createTrackingMessage } from "./util";
+
+// This tracker is event based, this is since we are tracking events coming from different sources
+//  with different timeline, therefore this is a functional approach to track the events, instead of a class based approach
+export const createTrackingForFirstMessage = () => {
+  // Reset the tracking variables
+  let startTracking = false;
+  let stopTracking = false;
+  let startTime = 0;
+  let stopTime = 0;
+  let stopTrackingMessage;
+  let flag = false;
+  const isMessageFromValidSender = payload => {
+    var _payload$tags;
+    // agent scenario
+    if (payload !== null && payload !== void 0 && (_payload$tags = payload.tags) !== null && _payload$tags !== void 0 && _payload$tags.includes("public")) {
+      return false;
+    }
+    return true;
+  };
+  const widgetLoadListener = BroadcastService.getMessageByEventName(TelemetryEvent.WidgetLoadComplete).subscribe(() => {
+    if (startTracking) return;
+    startTracking = true;
+    startTime = new Date().getTime();
+  });
+  const newMessageListener = BroadcastService.getMessageByEventName(BroadcastEvent.NewMessageReceived).subscribe(message => {
+    const payload = message.payload;
+
+    // we only care for bot, so we need to check if the message is from the bot
+    // pending to add typing message indicator signal detection
+
+    if (isMessageFromValidSender(payload)) {
+      if (startTracking && !stopTracking) {
+        stopTime = new Date().getTime();
+        const elapsedTime = stopTime - startTime;
+        stopTracking = true;
+        stopTrackingMessage = createTrackingMessage(payload, "botMessage");
+        notifyFMLTrackingCompleted();
+        TelemetryHelper.logActionEvent(LogLevel.INFO, {
+          Event: TelemetryEvent.BotFirstMessageLapTrack,
+          Description: "First Message from Bot latency tracking",
+          CustomProperties: {
+            elapsedTime,
+            widgetLoadedAt: startTime,
+            botMessage: stopTrackingMessage
+          }
+        });
+      }
+    }
+
+    // this track only first message, if coming from the bot or not
+    // the only difference is that it logs only those from bot
+    disconnectListener();
+  });
+  const notifyFMLTrackingCompleted = () => {
+    ackListener();
+    // Retry sending until flag is true, but do not block the main thread
+    const interval = setInterval(() => {
+      if (flag) {
+        clearInterval(interval);
+      } else {
+        BroadcastService.postMessage({
+          eventName: BroadcastEvent.FMLTrackingCompleted,
+          payload: null
+        });
+      }
+    }, 100);
+  };
+  const ackListener = () => {
+    const listen = BroadcastService.getMessageByEventName(BroadcastEvent.FMLTrackingCompletedAck).subscribe(() => {
+      flag = true;
+      listen.unsubscribe();
+    });
+  };
+
+  // Rehydrate message is received when the widget is reloaded, this is to ensure that we are not tracking messages that are not part of the current conversation
+  // No need to keep listerning for tracking, enforcing disconnection for the listners
+  const rehydrateListener = BroadcastService.getMessageByEventName(TelemetryEvent.RehydrateMessageReceived).subscribe(() => {
+    startTracking = false;
+    stopTracking = false;
+    disconnectListener();
+  });
+
+  // Rehydrate message is received when the widget is reloaded, this is to ensure that we are not tracking messages that are not part of the current conversation
+  // No need to keep listerning for tracking, enforcing disconnection for the listners
+  const historyListener = BroadcastService.getMessageByEventName(BroadcastEvent.HistoryMessageReceived).subscribe(() => {
+    startTracking = false;
+    stopTracking = false;
+    disconnectListener();
+  });
+  const offlineNetworkListener = BroadcastService.getMessageByEventName(TelemetryEvent.NetworkDisconnected).subscribe(() => {
+    startTracking = false;
+    stopTracking = false;
+    disconnectListener();
+    TelemetryHelper.logActionEvent(LogLevel.INFO, {
+      Event: TelemetryEvent.BotFirstMessageLapTrackError,
+      Description: "Tracker Stopped due to network disconnection"
+    });
+  });
+
+  // this is to ensure that we are not tracking messages that are not part of the current conversation
+  const disconnectListener = () => {
+    historyListener.unsubscribe();
+    rehydrateListener.unsubscribe();
+    newMessageListener.unsubscribe();
+    widgetLoadListener.unsubscribe();
+    offlineNetworkListener.unsubscribe();
+  };
+};

package/lib/esm/firstresponselatency/FirstResponseLatencyTracker.js

@@ -0,0 +1,194 @@
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+import { BroadcastEvent, LogLevel, TelemetryEvent } from "../common/telemetry/TelemetryConstants";
+import { BroadcastService } from "@microsoft/omnichannel-chat-components";
+import { TelemetryHelper } from "../common/telemetry/TelemetryHelper";
+export let FirstResponseLatencyTracker = /*#__PURE__*/function () {
+  function FirstResponseLatencyTracker() {
+    _classCallCheck(this, FirstResponseLatencyTracker);
+    _defineProperty(this, "isABotConversation", false);
+    _defineProperty(this, "isStarted", false);
+    _defineProperty(this, "isEnded", false);
+    _defineProperty(this, "startTrackingMessage", void 0);
+    _defineProperty(this, "stopTrackingMessage", void 0);
+    _defineProperty(this, "isReady", false);
+    _defineProperty(this, "offlineNetworkListener", BroadcastService.getMessageByEventName(TelemetryEvent.NetworkDisconnected).subscribe(() => {
+      this.isStarted = false;
+      this.isEnded = false;
+      TelemetryHelper.logActionEvent(LogLevel.INFO, {
+        Event: TelemetryEvent.MessageStopLapTrackError,
+        Description: "Tracker Stopped due to network disconnection"
+      });
+    }));
+    _defineProperty(this, "fmltrackingListener", BroadcastService.getMessageByEventName(BroadcastEvent.FMLTrackingCompleted).subscribe(() => {
+      this.isReady = true;
+      BroadcastService.postMessage({
+        eventName: BroadcastEvent.FMLTrackingCompletedAck,
+        payload: null
+      });
+    }));
+    // Rehydrate message is received when the widget is reloaded, this is to ensure that we are not tracking messages that are not part of the current conversation
+    // No need to keep listerning for tracking, enforcing disconnection for the listners
+    _defineProperty(this, "rehydrateListener", BroadcastService.getMessageByEventName(TelemetryEvent.RehydrateMessageReceived).subscribe(() => {
+      this.isReady = true;
+    }));
+    // Rehydrate message is received when the widget is reloaded, this is to ensure that we are not tracking messages that are not part of the current conversation
+    // No need to keep listerning for tracking, enforcing disconnection for the listners
+    _defineProperty(this, "historyListener", BroadcastService.getMessageByEventName(BroadcastEvent.HistoryMessageReceived).subscribe(() => {
+      this.isReady = true;
+    }));
+    // this is a workaround to ensure in reload we track effectively the messages
+    // we do have a mechanism in place to prevent log agent messages.
+    this.isABotConversation = true;
+  }
+  _createClass(FirstResponseLatencyTracker, [{
+    key: "createTrackingMessage",
+    value: function createTrackingMessage(payload, type) {
+      return {
+        Id: payload.Id,
+        role: payload.role,
+        timestamp: payload === null || payload === void 0 ? void 0 : payload.timestamp,
+        tags: payload.tags,
+        messageType: payload.messageType,
+        text: payload.text,
+        type: type,
+        checkTime: new Date().getTime()
+      };
+    }
+
+    // Tracking Functions
+  }, {
+    key: "startTracking",
+    value: function startTracking(payload) {
+      if (!this.isReady) return;
+      //  this prevents to initiate tracking for multiple incoming messages
+      if (this.isStarted) {
+        return;
+      }
+      // this is to ensure we track only messages where bot is engaged
+      if (!this.isABotConversation) {
+        return;
+      }
+      // control of states to prevent clashing of messages
+      this.isStarted = true;
+      this.isEnded = false;
+      // The idea  of using types is to enrich telemetry data 
+      this.startTrackingMessage = this.createTrackingMessage(payload, "userMessage");
+    }
+  }, {
+    key: "handleAgentMessage",
+    value: function handleAgentMessage(payload) {
+      var _payload$tags;
+      // this tag so far is only present in agent messages
+      if (payload !== null && payload !== void 0 && (_payload$tags = payload.tags) !== null && _payload$tags !== void 0 && _payload$tags.includes("public")) {
+        this.deregister();
+      }
+    }
+  }, {
+    key: "stopTracking",
+    value: function stopTracking(payload) {
+      var _this$stopTrackingMes, _this$startTrackingMe;
+      // this prevents execution for multiple incoming messages from the bot.
+      if (this.isEnded && !this.isStarted) {
+        return;
+      }
+
+      // control of states to prevent clashing of messages
+      this.isEnded = true;
+      this.isStarted = false;
+
+      // The idea  of using types is to enrich telemetry data 
+      this.stopTrackingMessage = this.createTrackingMessage(payload, "botMessage");
+      // calculating elapsed time
+      const elapsedTime = (((_this$stopTrackingMes = this.stopTrackingMessage) === null || _this$stopTrackingMes === void 0 ? void 0 : _this$stopTrackingMes.checkTime) ?? 0) - (((_this$startTrackingMe = this.startTrackingMessage) === null || _this$startTrackingMe === void 0 ? void 0 : _this$startTrackingMe.checkTime) ?? 0);
+      TelemetryHelper.logActionEvent(LogLevel.INFO, {
+        Event: TelemetryEvent.MessageLapTrack,
+        Description: "First response latency tracking",
+        CustomProperties: {
+          elapsedTime,
+          userMessage: this.startTrackingMessage,
+          botMessage: this.stopTrackingMessage
+        }
+      });
+    }
+
+    // mechanism to ensure we track only allowed conversations
+  }, {
+    key: "isMessageFromValidSender",
+    value: function isMessageFromValidSender(payload) {
+      var _payload$tags2;
+      // agent scenario
+      if (payload !== null && payload !== void 0 && (_payload$tags2 = payload.tags) !== null && _payload$tags2 !== void 0 && _payload$tags2.includes("public")) {
+        this.handleAgentMessage(payload);
+        return false;
+      }
+      return true;
+    }
+  }, {
+    key: "startClock",
+    value: function startClock(payload) {
+      try {
+        if (!payload || !payload.Id) {
+          throw new Error("Invalid payload");
+        }
+        this.startTracking(payload);
+      } catch (e) {
+        TelemetryHelper.logActionEvent(LogLevel.ERROR, {
+          Event: TelemetryEvent.MessageStartLapTrackError,
+          Description: "Error while starting the clock",
+          ExceptionDetails: e,
+          CustomProperties: {
+            payload: payload
+          }
+        });
+      }
+    }
+  }, {
+    key: "stopClock",
+    value: function stopClock(payload) {
+      try {
+        if (!payload || !payload.Id) {
+          throw new Error("Invalid payload");
+        }
+        if (!this.isMessageFromValidSender(payload)) return;
+        if (this.isABotConversation && this.isStarted) {
+          this.stopTracking(payload);
+        }
+      } catch (e) {
+        console.error("FRL : error while trying to stop the tracker", e);
+        TelemetryHelper.logActionEvent(LogLevel.ERROR, {
+          Event: TelemetryEvent.MessageStopLapTrackError,
+          Description: "Error while stopping the clock",
+          ExceptionDetails: e,
+          CustomProperties: {
+            payload: payload
+          }
+        });
+        //reset state
+        this.startTrackingMessage = undefined;
+        this.stopTrackingMessage = undefined;
+        this.isStarted = false;
+        this.isEnded = false;
+      }
+    }
+  }, {
+    key: "deregister",
+    value: function deregister() {
+      // Reset State
+      this.isABotConversation = false;
+      this.isStarted = false;
+      this.isEnded = false;
+      this.startTrackingMessage = undefined;
+      this.stopTrackingMessage = undefined;
+      this.offlineNetworkListener.unsubscribe();
+      this.fmltrackingListener.unsubscribe();
+      this.rehydrateListener.unsubscribe();
+      this.historyListener.unsubscribe();
+    }
+  }]);
+  return FirstResponseLatencyTracker;
+}();

package/lib/esm/firstresponselatency/util.js

@@ -0,0 +1,87 @@
+import { ScenarioType } from "./Constants";
+import { Constants } from "../common/Constants";
+export const isHistoryMessage = (activity, startTime) => {
+  try {
+    if ((activity === null || activity === void 0 ? void 0 : activity.type) === Constants.message) {
+      var _activity$channelData, _activity$channelData2;
+      // this is an old piece of code, probably no longer relevant
+      if (activity !== null && activity !== void 0 && (_activity$channelData = activity.channelData) !== null && _activity$channelData !== void 0 && (_activity$channelData2 = _activity$channelData.tags) !== null && _activity$channelData2 !== void 0 && _activity$channelData2.includes(Constants.historyMessageTag)) return true;
+
+      // Id is an epoch time in milliseconds , in utc format, for some reason is in a string format
+      if (activity !== null && activity !== void 0 && activity.id) {
+        /// activity.id is an string that contains epoch time in milliseconds
+        const activityId = parseInt(activity === null || activity === void 0 ? void 0 : activity.id);
+
+        // if the activity id is not a number, we default to new message
+        if (isNaN(activityId)) {
+          return false;
+        }
+
+        // if the activity id is less than the start time, it means that the message is a history message
+        if (activityId < startTime) {
+          return true;
+        }
+      }
+      // anything else will be considered a new message
+      return false;
+    }
+  } catch (e) {
+    // if there is an error in parsing the activity id, we will consider it a new message
+    console.error("Error in parsing activity id: ", e);
+  }
+  return false;
+};
+export const buildMessagePayload = (activity, userId) => {
+  var _text, _text2, _activity$channelData3, _activity$from;
+  return {
+    // To identify hidden contents vs empty content
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    text: (activity === null || activity === void 0 ? void 0 : (_text = activity.text) === null || _text === void 0 ? void 0 : _text.length) >= 1 ? `*contents hidden (${activity === null || activity === void 0 ? void 0 : (_text2 = activity.text) === null || _text2 === void 0 ? void 0 : _text2.length} chars)*` : "",
+    type: activity === null || activity === void 0 ? void 0 : activity.type,
+    timestamp: activity === null || activity === void 0 ? void 0 : activity.timestamp,
+    userId: userId,
+    tags: activity === null || activity === void 0 ? void 0 : (_activity$channelData3 = activity.channelData) === null || _activity$channelData3 === void 0 ? void 0 : _activity$channelData3.tags,
+    messageType: "",
+    Id: activity === null || activity === void 0 ? void 0 : activity.id,
+    role: activity === null || activity === void 0 ? void 0 : (_activity$from = activity.from) === null || _activity$from === void 0 ? void 0 : _activity$from.role,
+    isChatComplete: false
+  };
+};
+export const polyfillMessagePayloadForEvent = (activity, payload, conversationId) => {
+  var _activity$conversatio, _attachments, _activity$from2;
+  return {
+    ...payload,
+    channelData: activity === null || activity === void 0 ? void 0 : activity.channelData,
+    chatId: activity === null || activity === void 0 ? void 0 : (_activity$conversatio = activity.conversation) === null || _activity$conversatio === void 0 ? void 0 : _activity$conversatio.id,
+    conversationId: conversationId,
+    Id: activity === null || activity === void 0 ? void 0 : activity.id,
+    isChatComplete: false,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    text: activity === null || activity === void 0 ? void 0 : activity.text,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    attachment: (activity === null || activity === void 0 ? void 0 : (_attachments = activity.attachments) === null || _attachments === void 0 ? void 0 : _attachments.length) >= 1 ? activity === null || activity === void 0 ? void 0 : activity.attachments : [],
+    role: activity === null || activity === void 0 ? void 0 : (_activity$from2 = activity.from) === null || _activity$from2 === void 0 ? void 0 : _activity$from2.role
+  };
+};
+export const getScenarioType = activity => {
+  var _activity$from3, _activity$channelData4, _activity$channelData5;
+  if ((activity === null || activity === void 0 ? void 0 : (_activity$from3 = activity.from) === null || _activity$from3 === void 0 ? void 0 : _activity$from3.role) === Constants.userMessageTag) {
+    return ScenarioType.UserSendMessageStrategy;
+  }
+  if (activity !== null && activity !== void 0 && (_activity$channelData4 = activity.channelData) !== null && _activity$channelData4 !== void 0 && (_activity$channelData5 = _activity$channelData4.tags) !== null && _activity$channelData5 !== void 0 && _activity$channelData5.includes(Constants.systemMessageTag)) {
+    return ScenarioType.SystemMessageStrategy;
+  }
+  return ScenarioType.ReceivedMessageStrategy;
+};
+export const createTrackingMessage = (payload, type) => {
+  return {
+    Id: payload.Id,
+    role: payload.role,
+    timestamp: payload === null || payload === void 0 ? void 0 : payload.timestamp,
+    tags: payload.tags,
+    messageType: payload.messageType,
+    text: payload.text,
+    type: type,
+    checkTime: new Date().getTime()
+  };
+};