@microsoft/omnichannel-chat-widget 1.8.2-main.e3c1d40 → 1.8.2-main.f638bed

package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/conversationEndMiddleware.js

@@ -11,27 +11,33 @@ import { MessageTypes } from "../../enums/MessageType";
 import { WebChatActionType } from "../../enums/WebChatActionType";
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unused-vars
-const createConversationEndMiddleware = conversationEndCallback => _ref => {
+const createConversationEndMiddleware = (conversationEndCallback, startConversationalSurveyCallback, endConversationalSurveyCallback) => _ref => {
   let {
     dispatch
   } = _ref;
   return next => action => {
     var _action$payload;
     if ((action === null || action === void 0 ? void 0 : action.type) == WebChatActionType.DIRECT_LINE_INCOMING_ACTIVITY && (_action$payload = action.payload) !== null && _action$payload !== void 0 && _action$payload.activity) {
-      var _activity$from2, _activity$channelData7, _activity$channelData8;
+      var _activity$from2, _activity$channelData17, _activity$channelData18;
       const activity = action.payload.activity;
       if (activity.channelId === "ACS_CHANNEL") {
         var _activity$from;
         if (((_activity$from = activity.from) === null || _activity$from === void 0 ? void 0 : _activity$from.role) === DirectLineSenderRole.Bot) {
-          var _activity$channelData, _activity$channelData2, _activity$channelData3, _activity$channelData4, _activity$channelData5, _activity$channelData6;
+          var _activity$channelData, _activity$channelData2, _activity$channelData3, _activity$channelData4, _activity$channelData5, _activity$channelData6, _activity$channelData7, _activity$channelData8, _activity$channelData9, _activity$channelData10, _activity$channelData11, _activity$channelData12, _activity$channelData13, _activity$channelData14, _activity$channelData15, _activity$channelData16;
           if ((_activity$channelData = activity.channelData) !== null && _activity$channelData !== void 0 && (_activity$channelData2 = _activity$channelData.tags) !== null && _activity$channelData2 !== void 0 && _activity$channelData2.includes(Constants.systemMessageTag) && ((_activity$channelData3 = activity.channelData) !== null && _activity$channelData3 !== void 0 && (_activity$channelData4 = _activity$channelData3.tags) !== null && _activity$channelData4 !== void 0 && _activity$channelData4.includes(Constants.agentEndConversationMessageTag) || (_activity$channelData5 = activity.channelData) !== null && _activity$channelData5 !== void 0 && (_activity$channelData6 = _activity$channelData5.tags) !== null && _activity$channelData6 !== void 0 && _activity$channelData6.includes(Constants.supervisorForceCloseMessageTag))) {
             conversationEndCallback();
           }
+          if ((_activity$channelData7 = activity.channelData) !== null && _activity$channelData7 !== void 0 && (_activity$channelData8 = _activity$channelData7.tags) !== null && _activity$channelData8 !== void 0 && _activity$channelData8.includes(Constants.systemMessageTag) && ((_activity$channelData9 = activity.channelData) !== null && _activity$channelData9 !== void 0 && (_activity$channelData10 = _activity$channelData9.tags) !== null && _activity$channelData10 !== void 0 && _activity$channelData10.includes(Constants.startConversationalSurveyMessageTag) || (_activity$channelData11 = activity.channelData) !== null && _activity$channelData11 !== void 0 && (_activity$channelData12 = _activity$channelData11.tags) !== null && _activity$channelData12 !== void 0 && _activity$channelData12.includes(Constants.startConversationalSurveyMessageTag))) {
+            startConversationalSurveyCallback();
+          }
+          if ((_activity$channelData13 = activity.channelData) !== null && _activity$channelData13 !== void 0 && (_activity$channelData14 = _activity$channelData13.tags) !== null && _activity$channelData14 !== void 0 && _activity$channelData14.includes(Constants.systemMessageTag) && (_activity$channelData15 = activity.channelData) !== null && _activity$channelData15 !== void 0 && (_activity$channelData16 = _activity$channelData15.tags) !== null && _activity$channelData16 !== void 0 && _activity$channelData16.includes(Constants.endConversationalSurveyMessageTag)) {
+            endConversationalSurveyCallback();
+          }
         }
-      } else if (((_activity$from2 = activity.from) === null || _activity$from2 === void 0 ? void 0 : _activity$from2.role) === DirectLineSenderRole.Channel && ((_activity$channelData7 = activity.channelData) === null || _activity$channelData7 === void 0 ? void 0 : _activity$channelData7.type) === MessageTypes.Thread && (_activity$channelData8 = activity.channelData) !== null && _activity$channelData8 !== void 0 && _activity$channelData8.properties) {
-        var _activity$channelData9, _activity$channelData10, _activity$channelData11, _activity$channelData12;
+      } else if (((_activity$from2 = activity.from) === null || _activity$from2 === void 0 ? void 0 : _activity$from2.role) === DirectLineSenderRole.Channel && ((_activity$channelData17 = activity.channelData) === null || _activity$channelData17 === void 0 ? void 0 : _activity$channelData17.type) === MessageTypes.Thread && (_activity$channelData18 = activity.channelData) !== null && _activity$channelData18 !== void 0 && _activity$channelData18.properties) {
+        var _activity$channelData19, _activity$channelData20, _activity$channelData21, _activity$channelData22;
         // IC3
-        if (((_activity$channelData9 = activity.channelData) === null || _activity$channelData9 === void 0 ? void 0 : (_activity$channelData10 = _activity$channelData9.properties) === null || _activity$channelData10 === void 0 ? void 0 : _activity$channelData10.isdeleted) === Constants.truePascal || !((_activity$channelData11 = activity.channelData) !== null && _activity$channelData11 !== void 0 && (_activity$channelData12 = _activity$channelData11.properties) !== null && _activity$channelData12 !== void 0 && _activity$channelData12.containsExternalEntitiesListeningAll)) {
+        if (((_activity$channelData19 = activity.channelData) === null || _activity$channelData19 === void 0 ? void 0 : (_activity$channelData20 = _activity$channelData19.properties) === null || _activity$channelData20 === void 0 ? void 0 : _activity$channelData20.isdeleted) === Constants.truePascal || !((_activity$channelData21 = activity.channelData) !== null && _activity$channelData21 !== void 0 && (_activity$channelData22 = _activity$channelData21.properties) !== null && _activity$channelData22 !== void 0 && _activity$channelData22.containsExternalEntitiesListeningAll)) {
           conversationEndCallback();
         }
       }

package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/customEventMiddleware.js

@@ -0,0 +1,33 @@
+/******
+ * CustomEventMiddleware
+ *
+ * This middleware is invoked when a custom event is received.
+ * The callback is then invoked to handle the custom event.
+ ******/
+
+import { Constants } from "../../../../../common/Constants";
+import { WebChatActionType } from "../../enums/WebChatActionType";
+export const isValidCustomEvent = activity => {
+  var _activity$channelData, _activity$channelData2, _activity$channelData3, _activity$channelData4, _activity$channelData5, _activity$channelData6, _activity$channelData7, _activity$from, _activity$channelData8, _activity$channelData9, _activity$channelData10, _activity$channelData11;
+  return !!(activity !== null && activity !== void 0 && (_activity$channelData = activity.channelData) !== null && _activity$channelData !== void 0 && (_activity$channelData2 = _activity$channelData.metadata) !== null && _activity$channelData2 !== void 0 && _activity$channelData2.customEvent && typeof (activity === null || activity === void 0 ? void 0 : (_activity$channelData3 = activity.channelData) === null || _activity$channelData3 === void 0 ? void 0 : (_activity$channelData4 = _activity$channelData3.metadata) === null || _activity$channelData4 === void 0 ? void 0 : _activity$channelData4.customEvent) === Constants.String && (activity === null || activity === void 0 ? void 0 : (_activity$channelData5 = activity.channelData) === null || _activity$channelData5 === void 0 ? void 0 : (_activity$channelData6 = _activity$channelData5.metadata) === null || _activity$channelData6 === void 0 ? void 0 : (_activity$channelData7 = _activity$channelData6.customEvent) === null || _activity$channelData7 === void 0 ? void 0 : _activity$channelData7.toLowerCase()) === Constants.true && (activity === null || activity === void 0 ? void 0 : (_activity$from = activity.from) === null || _activity$from === void 0 ? void 0 : _activity$from.role) !== Constants.userMessageTag && typeof (activity === null || activity === void 0 ? void 0 : (_activity$channelData8 = activity.channelData) === null || _activity$channelData8 === void 0 ? void 0 : (_activity$channelData9 = _activity$channelData8.metadata) === null || _activity$channelData9 === void 0 ? void 0 : _activity$channelData9.customEventName) === Constants.String && activity !== null && activity !== void 0 && (_activity$channelData10 = activity.channelData) !== null && _activity$channelData10 !== void 0 && (_activity$channelData11 = _activity$channelData10.metadata) !== null && _activity$channelData11 !== void 0 && _activity$channelData11.customEventValue);
+};
+const createCustomEventMiddleware = broadcastservice => () => next => action => {
+  var _action$payload;
+  if ((action === null || action === void 0 ? void 0 : action.type) == WebChatActionType.DIRECT_LINE_INCOMING_ACTIVITY && (_action$payload = action.payload) !== null && _action$payload !== void 0 && _action$payload.activity) {
+    const activity = action.payload.activity;
+    if (isValidCustomEvent(activity)) {
+      const customEvent = {
+        eventName: Constants.onCustomEvent,
+        payload: {
+          messageId: activity.messageid ?? activity.id,
+          customEventName: activity.channelData.metadata.customEventName,
+          customEventValue: activity.channelData.metadata.customEventValue
+        }
+      };
+      broadcastservice.postMessage(customEvent);
+      return;
+    }
+  }
+  return next(action);
+};
+export default createCustomEventMiddleware;

package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/queueOverflowHandlerMiddleware.js

@@ -0,0 +1,38 @@
+import { WebChatActionType } from "../../enums/WebChatActionType";
+import { LogLevel, TelemetryEvent } from "../../../../../common/telemetry/TelemetryConstants";
+import { TelemetryHelper } from "../../../../../common/telemetry/TelemetryHelper";
+import { LiveChatWidgetActionType } from "../../../../../contexts/common/LiveChatWidgetActionType";
+import { executeReducer } from "../../../../../contexts/createReducer";
+import { isEndConversationDueToOverflowActivity } from "../../../../../common/utils";
+const queueOverflowHandlingHelper = async (state, dispatch) => {
+  const {
+    appStates
+  } = executeReducer(state, {
+    type: LiveChatWidgetActionType.GET_IN_MEMORY_STATE,
+    payload: undefined
+  });
+  if (!appStates.chatDisconnectEventReceived) {
+    dispatch({
+      type: LiveChatWidgetActionType.SET_CHAT_DISCONNECT_EVENT_RECEIVED,
+      payload: true
+    });
+    TelemetryHelper.logActionEvent(LogLevel.INFO, {
+      Event: TelemetryEvent.QueueOverflowEvent,
+      Description: "Set chat disconnect event received."
+    });
+  }
+};
+export const createQueueOverflowMiddleware = (state, dispatch) => () => next => action => {
+  var _action$payload;
+  if ((action === null || action === void 0 ? void 0 : action.type) == WebChatActionType.DIRECT_LINE_INCOMING_ACTIVITY && (_action$payload = action.payload) !== null && _action$payload !== void 0 && _action$payload.activity) {
+    const activity = action.payload.activity;
+    if (isEndConversationDueToOverflowActivity(activity)) {
+      TelemetryHelper.logActionEvent(LogLevel.INFO, {
+        Event: TelemetryEvent.QueueOverflowEvent,
+        Description: "Queue overflow event received."
+      });
+      queueOverflowHandlingHelper(state, dispatch);
+    }
+  }
+  return next(action);
+};

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

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

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

@@ -45,5 +45,7 @@ export let LiveChatWidgetActionType;
   LiveChatWidgetActionType[LiveChatWidgetActionType["SET_SURVEY_MODE"] = 42] = "SET_SURVEY_MODE";
   LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CONFIRMATION_STATE"] = 43] = "SET_CONFIRMATION_STATE";
   LiveChatWidgetActionType[LiveChatWidgetActionType["SET_POST_CHAT_PARTICIPANT_TYPE"] = 44] = "SET_POST_CHAT_PARTICIPANT_TYPE";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["GET_IN_MEMORY_STATE"] = 45] = "GET_IN_MEMORY_STATE";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CONVERSATIONAL_SURVEY_ENABLED"] = 45] = "SET_CONVERSATIONAL_SURVEY_ENABLED";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CONVERSATIONAL_SURVEY_DISPLAY"] = 46] = "SET_CONVERSATIONAL_SURVEY_DISPLAY";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["GET_IN_MEMORY_STATE"] = 47] = "GET_IN_MEMORY_STATE";
 })(LiveChatWidgetActionType || (LiveChatWidgetActionType = {}));

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

@@ -77,7 +77,9 @@ export const getLiveChatWidgetContextInitialState = props => {
       conversationEndedBy: ConversationEndEntity.NotSet,
       chatDisconnectEventReceived: false,
       selectedSurveyMode: null,
-      postChatParticipantType: undefined
+      postChatParticipantType: undefined,
+      isConversationalSurvey: false,
+      isConversationalSurveyEnabled: false
     },
     uiStates: {
       showConfirmationPane: false,

package/lib/esm/contexts/createReducer.js

@@ -648,6 +648,36 @@ const reducer = (state, action) => {
           postChatParticipantType: action.payload
         }
       };
+    case LiveChatWidgetActionType.SET_CONVERSATIONAL_SURVEY_ENABLED:
+      inMemory = {
+        ...inMemory,
+        appStates: {
+          ...inMemory.appStates,
+          isConversationalSurveyEnabled: action.payload
+        }
+      };
+      return {
+        ...state,
+        appStates: {
+          ...state.appStates,
+          isConversationalSurveyEnabled: action.payload
+        }
+      };
+    case LiveChatWidgetActionType.SET_CONVERSATIONAL_SURVEY_DISPLAY:
+      inMemory = {
+        ...inMemory,
+        appStates: {
+          ...inMemory.appStates,
+          isConversationalSurvey: action.payload
+        }
+      };
+      return {
+        ...state,
+        appStates: {
+          ...state.appStates,
+          isConversationalSurvey: action.payload
+        }
+      };
     case LiveChatWidgetActionType.GET_IN_MEMORY_STATE:
       return inMemory;
     default:

package/lib/esm/controller/componentController.js

@@ -17,7 +17,7 @@ export const shouldShowEmailTranscriptPane = state => {
   return state.uiStates.showEmailTranscriptPane;
 };
 export const shouldShowWebChatContainer = state => {
-  return !state.appStates.isMinimized && state.appStates.conversationState === ConversationState.Active || state.appStates.conversationState === ConversationState.InActive;
+  return !state.appStates.isMinimized && state.appStates.conversationState === ConversationState.Active || state.appStates.conversationState === ConversationState.InActive || state.appStates.conversationState === ConversationState.Postchat && state.appStates.isConversationalSurveyEnabled && state.appStates.isConversationalSurvey;
 };
 export const shouldShowLoadingPane = state => {
   return !state.appStates.isMinimized && state.appStates.conversationState === ConversationState.Loading;
@@ -42,7 +42,7 @@ export const shouldShowConfirmationPane = state => {
   return state.uiStates.showConfirmationPane;
 };
 export const shouldShowPostChatSurveyPane = state => {
-  return state.appStates.conversationState === ConversationState.Postchat;
+  return state.appStates.conversationState === ConversationState.Postchat && !state.appStates.isConversationalSurvey;
 };
 export const shouldShowCallingContainer = state => {
   return state.appStates.conversationState === ConversationState.Active && state.appStates.e2vvEnabled;

package/lib/esm/firstresponselatency/FirstMessageTrackerFromBot.js

@@ -7,54 +7,96 @@ import { createTrackingMessage } from "./util";
 //  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 isTracking = false;
   let startTime = 0;
   let stopTime = 0;
-  let stopTrackingMessage;
+  let stopTrackingMessage = null;
   let flag = false;
+  let trackingTimeoutId;
+
+  /**
+   * Checks if the message payload is from a valid sender (not an agent).
+   * Returns false if the message is from an agent (tag 'public'), true otherwise.
+   */
   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;
   };
+
+  /**
+   * Listener for widget load completion event.
+   * Starts tracking the time for the first bot message after widget loads.
+   * Sets a 5-second timeout to auto-reset if no bot message is received.
+   */
   const widgetLoadListener = BroadcastService.getMessageByEventName(TelemetryEvent.WidgetLoadComplete).subscribe(() => {
-    if (startTracking) return;
-    startTracking = true;
+    if (isTracking) return;
+    isTracking = true;
     startTime = new Date().getTime();
+    // Start a 5-second timeout to auto-stop tracking if not stopped
+    if (trackingTimeoutId) {
+      clearTimeout(trackingTimeoutId);
+    }
+    trackingTimeoutId = setTimeout(() => {
+      if (isTracking) {
+        // Reset state and disengage, no telemetry or FMLTrackingCompleted
+        isTracking = false;
+        startTime = 0;
+        stopTime = 0;
+        stopTrackingMessage = null;
+        trackingTimeoutId = undefined;
+        disconnectListener();
+      }
+    }, 10000); //adding more time since it meassures from widget load complete till message received
   });
+
+  /**
+   * Listener for new bot message event.
+   * If a valid bot message is received, stops tracking and logs telemetry.
+   * If the message is invalid, resets and disengages listeners.
+   */
   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
-          }
-        });
+    if (!isMessageFromValidSender(payload)) {
+      // If not valid, stop everything and clean up
+      isTracking = false;
+      if (trackingTimeoutId) {
+        clearTimeout(trackingTimeoutId);
+        trackingTimeoutId = undefined;
       }
+      disconnectListener();
+      return;
+    }
+    if (isTracking) {
+      isTracking = false;
+      // Clear the timeout if it exists
+      if (trackingTimeoutId) {
+        clearTimeout(trackingTimeoutId);
+        trackingTimeoutId = undefined;
+      }
+      stopTime = new Date().getTime();
+      const elapsedTime = stopTime - startTime;
+      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
+        }
+      });
+      disconnectListener();
     }
-
-    // this track only first message, if coming from the bot or not
-    // the only difference is that it logs only those from bot
-    disconnectListener();
   });
+
+  /**
+   * Notifies that FML (First Message Latency) tracking is completed.
+   * Retries sending the completion event until acknowledged.
+   */
   const notifyFMLTrackingCompleted = () => {
     ackListener();
     // Retry sending until flag is true, but do not block the main thread
@@ -69,6 +111,11 @@ export const createTrackingForFirstMessage = () => {
       }
     }, 100);
   };
+
+  /**
+   * Listener for FMLTrackingCompletedAck event.
+   * Sets the flag to true when acknowledgment is received.
+   */
   const ackListener = () => {
     const listen = BroadcastService.getMessageByEventName(BroadcastEvent.FMLTrackingCompletedAck).subscribe(() => {
       flag = true;
@@ -78,22 +125,32 @@ export const createTrackingForFirstMessage = () => {
 
   // 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
+  /**
+   * Listener for widget rehydration event.
+   * Resets tracking and disconnects listeners when widget is reloaded.
+   */
   const rehydrateListener = BroadcastService.getMessageByEventName(TelemetryEvent.RehydrateMessageReceived).subscribe(() => {
-    startTracking = false;
-    stopTracking = false;
+    isTracking = 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
+  /**
+   * Listener for history message event.
+   * Resets tracking and disconnects listeners when history is loaded.
+   */
   const historyListener = BroadcastService.getMessageByEventName(BroadcastEvent.HistoryMessageReceived).subscribe(() => {
-    startTracking = false;
-    stopTracking = false;
+    isTracking = false;
     disconnectListener();
   });
+
+  /**
+   * Listener for network disconnection event.
+   * Resets tracking, disconnects listeners, and logs a telemetry error.
+   */
   const offlineNetworkListener = BroadcastService.getMessageByEventName(TelemetryEvent.NetworkDisconnected).subscribe(() => {
-    startTracking = false;
-    stopTracking = false;
+    isTracking = false;
     disconnectListener();
     TelemetryHelper.logActionEvent(LogLevel.INFO, {
       Event: TelemetryEvent.BotFirstMessageLapTrackError,
@@ -102,7 +159,15 @@ export const createTrackingForFirstMessage = () => {
   });
 
   // this is to ensure that we are not tracking messages that are not part of the current conversation
+  /**
+   * Disconnects all listeners and clears the tracking timeout.
+   * Used for cleanup when tracking is stopped or reset.
+   */
   const disconnectListener = () => {
+    if (trackingTimeoutId) {
+      clearTimeout(trackingTimeoutId);
+      trackingTimeoutId = undefined;
+    }
     historyListener.unsubscribe();
     rehydrateListener.unsubscribe();
     newMessageListener.unsubscribe();

package/lib/esm/firstresponselatency/FirstResponseLatencyTracker.js

@@ -11,14 +11,13 @@ export let FirstResponseLatencyTracker = /*#__PURE__*/function () {
   function FirstResponseLatencyTracker() {
     _classCallCheck(this, FirstResponseLatencyTracker);
     _defineProperty(this, "isABotConversation", false);
-    _defineProperty(this, "isStarted", false);
-    _defineProperty(this, "isEnded", false);
+    _defineProperty(this, "isTracking", false);
     _defineProperty(this, "startTrackingMessage", void 0);
     _defineProperty(this, "stopTrackingMessage", void 0);
     _defineProperty(this, "isReady", false);
+    _defineProperty(this, "trackingTimeoutId", void 0);
     _defineProperty(this, "offlineNetworkListener", BroadcastService.getMessageByEventName(TelemetryEvent.NetworkDisconnected).subscribe(() => {
-      this.isStarted = false;
-      this.isEnded = false;
+      this.isTracking = false;
       TelemetryHelper.logActionEvent(LogLevel.INFO, {
         Event: TelemetryEvent.MessageStopLapTrackError,
         Description: "Tracker Stopped due to network disconnection"
@@ -66,7 +65,7 @@ export let FirstResponseLatencyTracker = /*#__PURE__*/function () {
     value: function startTracking(payload) {
       if (!this.isReady) return;
       //  this prevents to initiate tracking for multiple incoming messages
-      if (this.isStarted) {
+      if (this.isTracking) {
         return;
       }
       // this is to ensure we track only messages where bot is engaged
@@ -74,10 +73,24 @@ export let FirstResponseLatencyTracker = /*#__PURE__*/function () {
         return;
       }
       // control of states to prevent clashing of messages
-      this.isStarted = true;
-      this.isEnded = false;
+      this.isTracking = true;
       // The idea  of using types is to enrich telemetry data 
       this.startTrackingMessage = this.createTrackingMessage(payload, "userMessage");
+
+      // Start a 5-second timeout to auto-stop tracking if not stopped
+      if (this.trackingTimeoutId) {
+        clearTimeout(this.trackingTimeoutId);
+      }
+      this.trackingTimeoutId = setTimeout(() => {
+        // this means the start process is in progress, but the end wasn't called within the time limit
+        if (this.isTracking) {
+          // Reset state variables and skip stopTracking
+          this.isTracking = false;
+          this.startTrackingMessage = undefined;
+          this.stopTrackingMessage = undefined;
+          this.trackingTimeoutId = undefined;
+        }
+      }, 5000);
     }
   }, {
     key: "handleAgentMessage",
@@ -93,13 +106,16 @@ export let FirstResponseLatencyTracker = /*#__PURE__*/function () {
     value: function stopTracking(payload) {
       var _this$stopTrackingMes, _this$startTrackingMe;
       // this prevents execution for multiple incoming messages from the bot.
-      if (this.isEnded && !this.isStarted) {
+      if (!this.isTracking) {
         return;
       }
-
+      // Clear the timeout if it exists
+      if (this.trackingTimeoutId) {
+        clearTimeout(this.trackingTimeoutId);
+        this.trackingTimeoutId = undefined;
+      }
       // control of states to prevent clashing of messages
-      this.isEnded = true;
-      this.isStarted = false;
+      this.isTracking = false;
 
       // The idea  of using types is to enrich telemetry data 
       this.stopTrackingMessage = this.createTrackingMessage(payload, "botMessage");
@@ -154,12 +170,16 @@ export let FirstResponseLatencyTracker = /*#__PURE__*/function () {
         if (!payload || !payload.Id) {
           throw new Error("Invalid payload");
         }
-        if (!this.isMessageFromValidSender(payload)) return;
-        if (this.isABotConversation && this.isStarted) {
+
+        // Only allow stopTracking if sender is valid and tracking is active
+        if (!this.isMessageFromValidSender(payload)) {
+          // Do not change isTracking or stopTrackingMessage
+          return;
+        }
+        if (this.isABotConversation && this.isTracking) {
           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",
@@ -168,11 +188,6 @@ export let FirstResponseLatencyTracker = /*#__PURE__*/function () {
             payload: payload
           }
         });
-        //reset state
-        this.startTrackingMessage = undefined;
-        this.stopTrackingMessage = undefined;
-        this.isStarted = false;
-        this.isEnded = false;
       }
     }
   }, {
@@ -180,10 +195,13 @@ export let FirstResponseLatencyTracker = /*#__PURE__*/function () {
     value: function deregister() {
       // Reset State
       this.isABotConversation = false;
-      this.isStarted = false;
-      this.isEnded = false;
+      this.isTracking = false;
       this.startTrackingMessage = undefined;
       this.stopTrackingMessage = undefined;
+      if (this.trackingTimeoutId) {
+        clearTimeout(this.trackingTimeoutId);
+        this.trackingTimeoutId = undefined;
+      }
       this.offlineNetworkListener.unsubscribe();
       this.fmltrackingListener.unsubscribe();
       this.rehydrateListener.unsubscribe();

package/lib/esm/firstresponselatency/util.js

@@ -1,38 +1,66 @@
 import { ScenarioType } from "./Constants";
 import { Constants } from "../common/Constants";
+const DELTA_WITHIN_LIMITS_IN_MS = 250;
+
+/**
+ * Determines whether a given activity is a historical message.
+ * 
+ * This function checks if the activity is a message type and uses a combination
+ * of legacy tags and timestamp-based logic to determine if the message is historical.
+ * 
+ * @param {IActivity} activity - The activity object to evaluate.
+ * @param {number} startTime - The start time (in milliseconds since epoch) to compare against.
+ * @returns {boolean} - Returns true if the activity is a historical message, false otherwise.
+ * 
+ * Logic:
+ * - If the activity type is not a message, it is not historical.
+ * - If the activity contains a legacy history message tag, it is considered historical.
+ * - Otherwise, the function extracts a timestamp from the activity ID using `extractTimestampFromId`.
+ *   - If the ID is valid and the timestamp is older than the start time, the message is historical.
+ */
 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;
+  var _activity$channelData;
+  // Only process message activities
+  if ((activity === null || activity === void 0 ? void 0 : activity.type) !== Constants.message) {
+    return false;
+  }
 
-      // 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);
+  // Prioritize legacy history tag
+  if (activity !== null && activity !== void 0 && (_activity$channelData = activity.channelData) !== null && _activity$channelData !== void 0 && _activity$channelData.tags && activity.channelData.tags.includes(Constants.historyMessageTag)) {
+    return true;
+  }
+  const activityId = extractTimestampFromId(activity);
+  const isValidId = !isNaN(activityId) && activityId > 0;
+  const difference = startTime - activityId;
+  // Only consider historical if activityId < startTime and difference >= DELTA_WITHIN_LIMITS_IN_MS
+  const isOlderThanStartTime = activityId < startTime && difference >= DELTA_WITHIN_LIMITS_IN_MS;
+  const isHistoryById = isValidId && isOlderThanStartTime;
+  return isHistoryById;
+};
+export const extractTimestampFromId = activity => {
+  const id = (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;
-        }
+  // Helper function to get timestamp fallback
+  const getTimestampFallback = () => {
+    const timestamp = new Date((activity === null || activity === void 0 ? void 0 : activity.timestamp) ?? "").getTime();
+    return isNaN(timestamp) ? 0 : timestamp;
+  };
 
-        // 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);
+  // Check if ID looks like a UUID (contains dashes or is very long)
+  const UUID_LENGTH_THRESHOLD = 13; // Threshold to distinguish UUIDs from epoch timestamps
+  if (id.includes("-") || id.length > UUID_LENGTH_THRESHOLD) {
+    // Likely UUID, use timestamp instead
+    return getTimestampFallback();
+  }
+  const activityId = parseInt(id);
+  // if activity id is not a number, then we use timestamp field
+  if (isNaN(activityId)) {
+    return getTimestampFallback();
   }
-  return false;
+  return activityId;
 };
 export const buildMessagePayload = (activity, userId) => {
-  var _text, _text2, _activity$channelData3, _activity$from;
+  var _text, _text2, _activity$channelData2, _activity$from;
   return {
     // To identify hidden contents vs empty content
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -40,7 +68,7 @@ export const buildMessagePayload = (activity, userId) => {
     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,
+    tags: (activity === null || activity === void 0 ? void 0 : (_activity$channelData2 = activity.channelData) === null || _activity$channelData2 === void 0 ? void 0 : _activity$channelData2.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,
@@ -64,9 +92,9 @@ export const polyfillMessagePayloadForEvent = (activity, payload, conversationId
   };
 };
 export const getScenarioType = activity => {
-  var _activity$from3, _activity$channelData4;
+  var _activity$from3, _activity$channelData3;
   const role = activity === null || activity === void 0 ? void 0 : (_activity$from3 = activity.from) === null || _activity$from3 === void 0 ? void 0 : _activity$from3.role;
-  const tags = activity === null || activity === void 0 ? void 0 : (_activity$channelData4 = activity.channelData) === null || _activity$channelData4 === void 0 ? void 0 : _activity$channelData4.tags;
+  const tags = activity === null || activity === void 0 ? void 0 : (_activity$channelData3 = activity.channelData) === null || _activity$channelData3 === void 0 ? void 0 : _activity$channelData3.tags;
   if (role === Constants.userMessageTag) {
     return ScenarioType.UserSendMessageStrategy;
   }