@microsoft/omnichannel-chat-widget 1.7.8-main.bd4de53 → 1.7.8-main.cf04c1c

package/lib/cjs/firstresponselatency/FirstMessageTrackerFromBot.js

@@ -0,0 +1,118 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createTrackingForFirstMessage = void 0;
+var _TelemetryConstants = require("../common/telemetry/TelemetryConstants");
+var _omnichannelChatComponents = require("@microsoft/omnichannel-chat-components");
+var _TelemetryHelper = require("../common/telemetry/TelemetryHelper");
+var _util = require("./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
+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 = _omnichannelChatComponents.BroadcastService.getMessageByEventName(_TelemetryConstants.TelemetryEvent.WidgetLoadComplete).subscribe(() => {
+    if (startTracking) return;
+    startTracking = true;
+    startTime = new Date().getTime();
+  });
+  const newMessageListener = _omnichannelChatComponents.BroadcastService.getMessageByEventName(_TelemetryConstants.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 = (0, _util.createTrackingMessage)(payload, "botMessage");
+        notifyFMLTrackingCompleted();
+        _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.INFO, {
+          Event: _TelemetryConstants.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 {
+        _omnichannelChatComponents.BroadcastService.postMessage({
+          eventName: _TelemetryConstants.BroadcastEvent.FMLTrackingCompleted,
+          payload: null
+        });
+      }
+    }, 100);
+  };
+  const ackListener = () => {
+    const listen = _omnichannelChatComponents.BroadcastService.getMessageByEventName(_TelemetryConstants.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 = _omnichannelChatComponents.BroadcastService.getMessageByEventName(_TelemetryConstants.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 = _omnichannelChatComponents.BroadcastService.getMessageByEventName(_TelemetryConstants.BroadcastEvent.HistoryMessageReceived).subscribe(() => {
+    startTracking = false;
+    stopTracking = false;
+    disconnectListener();
+  });
+  const offlineNetworkListener = _omnichannelChatComponents.BroadcastService.getMessageByEventName(_TelemetryConstants.TelemetryEvent.NetworkDisconnected).subscribe(() => {
+    startTracking = false;
+    stopTracking = false;
+    disconnectListener();
+    _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.INFO, {
+      Event: _TelemetryConstants.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();
+  };
+};
+exports.createTrackingForFirstMessage = createTrackingForFirstMessage;

package/lib/cjs/firstresponselatency/FirstResponseLatencyTracker.js

@@ -5,148 +5,197 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.FirstResponseLatencyTracker = void 0;
 var _TelemetryConstants = require("../common/telemetry/TelemetryConstants");
+var _omnichannelChatComponents = require("@microsoft/omnichannel-chat-components");
 var _TelemetryHelper = require("../common/telemetry/TelemetryHelper");
+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); }
-class FirstResponseLatencyTracker {
-  constructor() {
+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", _omnichannelChatComponents.BroadcastService.getMessageByEventName(_TelemetryConstants.TelemetryEvent.NetworkDisconnected).subscribe(() => {
+      this.isStarted = false;
+      this.isEnded = false;
+      _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.INFO, {
+        Event: _TelemetryConstants.TelemetryEvent.MessageStopLapTrackError,
+        Description: "Tracker Stopped due to network disconnection"
+      });
+    }));
+    _defineProperty(this, "fmltrackingListener", _omnichannelChatComponents.BroadcastService.getMessageByEventName(_TelemetryConstants.BroadcastEvent.FMLTrackingCompleted).subscribe(() => {
+      this.isReady = true;
+      _omnichannelChatComponents.BroadcastService.postMessage({
+        eventName: _TelemetryConstants.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", _omnichannelChatComponents.BroadcastService.getMessageByEventName(_TelemetryConstants.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", _omnichannelChatComponents.BroadcastService.getMessageByEventName(_TelemetryConstants.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;
   }
-  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
-  startTracking(payload) {
-    //  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;
+  _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()
+      };
     }
 
-    // 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");
-  }
-  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();
-    }
-  }
-  stopTracking(payload) {
-    var _this$stopTrackingMes, _this$startTrackingMe;
-    // this prevents execution for multiple incoming messages from the bot.
-    if (this.isEnded && !this.isStarted) {
-      return;
+    // 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");
     }
-
-    // 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.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.INFO, {
-      Event: _TelemetryConstants.TelemetryEvent.MessageLapTrack,
-      Description: "First response latency tracking",
-      CustomProperties: {
-        elapsedTime,
-        userMessage: this.startTrackingMessage,
-        botMessage: this.stopTrackingMessage
+  }, {
+    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();
       }
-    });
-  }
-
-  // mechanism to ensure we track only allowed conversations
-  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;
-  }
-  startClock(payload) {
-    try {
-      if (!payload || !payload.Id) {
-        throw new Error("Invalid payload");
+  }, {
+    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;
       }
-      // in the case of a reload, tracker will be paused, until last history message is received
-      // this is because we dont have a way to identidy send messages as part of the history
-      //if (this.inPause) return;
-      this.startTracking(payload);
-    } catch (e) {
-      _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.ERROR, {
-        Event: _TelemetryConstants.TelemetryEvent.MessageStartLapTrackError,
-        Description: "Error while starting the clock",
-        ExceptionDetails: e,
+
+      // 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.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.INFO, {
+        Event: _TelemetryConstants.TelemetryEvent.MessageLapTrack,
+        Description: "First response latency tracking",
         CustomProperties: {
-          payload: payload
+          elapsedTime,
+          userMessage: this.startTrackingMessage,
+          botMessage: this.stopTrackingMessage
         }
       });
     }
-  }
-  stopClock(payload) {
-    try {
-      if (!payload || !payload.Id) {
-        throw new Error("Invalid payload");
+
+    // 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;
       }
-      if (!this.isMessageFromValidSender(payload)) return;
-      if (this.isABotConversation && this.isStarted) {
-        this.stopTracking(payload);
+      return true;
+    }
+  }, {
+    key: "startClock",
+    value: function startClock(payload) {
+      try {
+        if (!payload || !payload.Id) {
+          throw new Error("Invalid payload");
+        }
+        this.startTracking(payload);
+      } catch (e) {
+        _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.ERROR, {
+          Event: _TelemetryConstants.TelemetryEvent.MessageStartLapTrackError,
+          Description: "Error while starting the clock",
+          ExceptionDetails: e,
+          CustomProperties: {
+            payload: payload
+          }
+        });
       }
-    } catch (e) {
-      console.error("FRL : error while trying to stop the tracker", e);
-      _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.ERROR, {
-        Event: _TelemetryConstants.TelemetryEvent.MessageStopLapTrackError,
-        Description: "Error while stopping the clock",
-        ExceptionDetails: e,
-        CustomProperties: {
-          payload: payload
+    }
+  }, {
+    key: "stopClock",
+    value: function stopClock(payload) {
+      try {
+        if (!payload || !payload.Id) {
+          throw new Error("Invalid payload");
         }
-      });
-      //reset state
-      this.startTrackingMessage = undefined;
-      this.stopTrackingMessage = undefined;
+        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.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.ERROR, {
+          Event: _TelemetryConstants.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();
     }
-  }
-  deregister() {
-    // Reset State
-    this.isABotConversation = false;
-    this.isStarted = false;
-    this.isEnded = false;
-    this.startTrackingMessage = undefined;
-    this.stopTrackingMessage = undefined;
-  }
-}
+  }]);
+  return FirstResponseLatencyTracker;
+}();
 exports.FirstResponseLatencyTracker = FirstResponseLatencyTracker;

package/lib/cjs/firstresponselatency/util.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.polyfillMessagePayloadForEvent = exports.isHistoryMessage = exports.getScenarioType = exports.buildMessagePayload = void 0;
+exports.polyfillMessagePayloadForEvent = exports.isHistoryMessage = exports.getScenarioType = exports.createTrackingMessage = exports.buildMessagePayload = void 0;
 var _Constants = require("./Constants");
 var _Constants2 = require("../common/Constants");
 const isHistoryMessage = (activity, startTime) => {
@@ -82,4 +82,17 @@ const getScenarioType = activity => {
   }
   return _Constants.ScenarioType.ReceivedMessageStrategy;
 };
-exports.getScenarioType = getScenarioType;
+exports.getScenarioType = getScenarioType;
+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()
+  };
+};
+exports.createTrackingMessage = createTrackingMessage;