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

package/lib/esm/plugins/newMessageEventHandler.js

@@ -1,100 +1,114 @@
 import { BroadcastEvent, LogLevel, TelemetryEvent } from "../common/telemetry/TelemetryConstants";
+import { ScenarioType } from "../firstresponselatency/Constants";
+import { buildMessagePayload, getScenarioType, isHistoryMessage, polyfillMessagePayloadForEvent } from "../firstresponselatency/util";
 import { BroadcastService } from "@microsoft/omnichannel-chat-components";
 import { Constants } from "../common/Constants";
+import { FirstResponseLatencyTracker } from "../firstresponselatency/FirstResponseLatencyTracker";
 import { TelemetryHelper } from "../common/telemetry/TelemetryHelper";
 import { TelemetryManager } from "../common/telemetry/TelemetryManager";
 export const createOnNewAdapterActivityHandler = (chatId, userId) => {
+  // Hooking the message tracker in the listener, a bit invasive but easier to control.
+  const firstResponseLatencyTracker = new FirstResponseLatencyTracker();
+  // epoch time in utc for when start to listen.
+  // We dont longer have a mechanism to know if a message is history or new, so any message older than the time we start listening will be considered a history message.
+  // this is a workaround for the fact that we dont have a way to identify if a message is history or new, and it will provide consistency across different scenarios
+  const startTime = new Date().getTime();
+  let isHistoryMessageReceivedEventRaised = false;
   const onNewAdapterActivityHandler = activity => {
-    var _activity$channelData, _activity$channelData2, _activity$channelData3;
-    const isActivityMessage = (activity === null || activity === void 0 ? void 0 : activity.type) === Constants.message;
-    const isHistoryMessage = isActivityMessage && ((activity === null || activity === void 0 ? void 0 : (_activity$channelData = activity.channelData) === null || _activity$channelData === void 0 ? void 0 : (_activity$channelData2 = _activity$channelData.tags) === null || _activity$channelData2 === void 0 ? void 0 : _activity$channelData2.includes(Constants.historyMessageTag)) || (activity === null || activity === void 0 ? void 0 : (_activity$channelData3 = activity.channelData) === null || _activity$channelData3 === void 0 ? void 0 : _activity$channelData3.fromList));
-    raiseMessageEvent(activity, isHistoryMessage);
+    raiseMessageEvent(activity);
   };
-  let isHistoryMessageReceivedEventRasied = false;
-  const raiseMessageEvent = (activity, isHistoryMessage) => {
+  const userSendMessageStrategy = activity => {
+    var _TelemetryManager$Int;
+    const payload = buildMessagePayload(activity, userId);
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const polyfillMessagePayloadForEvent = payload => {
-      var _activity$conversatio, _TelemetryManager$Int, _attachments;
-      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: (_TelemetryManager$Int = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int === void 0 ? void 0 : _TelemetryManager$Int.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 : []
-      };
+    payload.messageType = Constants.userMessageTag;
+    const newMessageSentEvent = {
+      eventName: BroadcastEvent.NewMessageSent,
+      payload: polyfillMessagePayloadForEvent(activity, payload, (_TelemetryManager$Int = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int === void 0 ? void 0 : _TelemetryManager$Int.conversationId)
     };
+    BroadcastService.postMessage(newMessageSentEvent);
+    if (!isHistoryMessage(activity, startTime)) {
+      firstResponseLatencyTracker.startClock(payload);
+    }
+    TelemetryHelper.logActionEvent(LogLevel.INFO, {
+      Event: TelemetryEvent.MessageSent,
+      Description: "New message sent"
+    });
+  };
+  const systemMessageStrategy = activity => {
+    const payload = buildMessagePayload(activity, userId);
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    payload.messageType = Constants.systemMessageTag;
+    TelemetryHelper.logActionEvent(LogLevel.INFO, {
+      Event: TelemetryEvent.SystemMessageReceived,
+      Description: "System message received"
+    });
+  };
+  const historyMessageStrategy = payload => {
+    const newMessageReceivedEvent = {
+      eventName: BroadcastEvent.HistoryMessageReceived,
+      payload: payload
+    };
+    BroadcastService.postMessage(newMessageReceivedEvent);
+    if (!isHistoryMessageReceivedEventRaised) {
+      // this is needed for reload scenarios, it helps to identify the last message received before the reload
+      isHistoryMessageReceivedEventRaised = true;
+      TelemetryHelper.logActionEvent(LogLevel.INFO, {
+        Event: TelemetryEvent.RehydrateMessageReceived,
+        Description: "History message received",
+        CustomProperties: payload
+      });
+    }
+  };
+  const isValidMessage = activity => {
+    var _activity$channelData, _activity$channelData2, _activity$channelData3;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const messageHasNoText = !(activity !== null && activity !== void 0 && activity.text);
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const messageHasNoTags = !(activity !== null && activity !== void 0 && activity.channelData) || !(activity !== null && activity !== void 0 && (_activity$channelData = activity.channelData) !== null && _activity$channelData !== void 0 && _activity$channelData.tags) || (activity === null || activity === void 0 ? void 0 : (_activity$channelData2 = activity.channelData) === null || _activity$channelData2 === void 0 ? void 0 : (_activity$channelData3 = _activity$channelData2.tags) === null || _activity$channelData3 === void 0 ? void 0 : _activity$channelData3.length) === 0;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const messageHasNoAttachments = !(activity !== null && activity !== void 0 && activity.attachments) || (activity === null || activity === void 0 ? void 0 : activity.attachments.length) === 0;
+    if (messageHasNoTags && messageHasNoText && messageHasNoAttachments) {
+      return false;
+    }
+    return true;
+  };
+  const receivedMessageStrategy = activity => {
+    var _TelemetryManager$Int3;
+    if (!isValidMessage(activity)) return;
+    const isHistoryMessageReceived = isHistoryMessage(activity, startTime);
+    const payload = buildMessagePayload(activity, userId);
+    payload.messageType = Constants.userMessageTag;
+    if (isHistoryMessageReceived) {
+      var _TelemetryManager$Int2;
+      historyMessageStrategy(polyfillMessagePayloadForEvent(activity, payload, (_TelemetryManager$Int2 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int2 === void 0 ? void 0 : _TelemetryManager$Int2.conversationId));
+      return;
+    }
+    firstResponseLatencyTracker.stopClock(payload);
+    const newMessageReceivedEvent = {
+      eventName: BroadcastEvent.NewMessageReceived,
+      payload: polyfillMessagePayloadForEvent(activity, payload, (_TelemetryManager$Int3 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int3 === void 0 ? void 0 : _TelemetryManager$Int3.conversationId)
+    };
+    BroadcastService.postMessage(newMessageReceivedEvent);
+    TelemetryHelper.logActionEvent(LogLevel.INFO, {
+      Event: TelemetryEvent.MessageReceived,
+      Description: "New message received",
+      CustomProperties: payload
+    });
+  };
+  const raiseMessageEvent = activity => {
     if ((activity === null || activity === void 0 ? void 0 : activity.type) === Constants.message) {
-      var _text, _text2, _activity$channelData4, _activity$from;
-      const payload = {
-        // 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$channelData4 = activity.channelData) === null || _activity$channelData4 === void 0 ? void 0 : _activity$channelData4.tags,
-        messageType: ""
-      };
-      if ((activity === null || activity === void 0 ? void 0 : (_activity$from = activity.from) === null || _activity$from === void 0 ? void 0 : _activity$from.role) === Constants.userMessageTag) {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        payload.messageType = Constants.userMessageTag;
-        const newMessageSentEvent = {
-          eventName: BroadcastEvent.NewMessageSent,
-          payload: polyfillMessagePayloadForEvent(payload)
-        };
-        BroadcastService.postMessage(newMessageSentEvent);
-        TelemetryHelper.logActionEvent(LogLevel.INFO, {
-          Event: TelemetryEvent.MessageSent,
-          Description: "New message sent"
-        });
-      } else {
-        var _activity$channelData5, _activity$channelData6;
-        if (activity !== null && activity !== void 0 && (_activity$channelData5 = activity.channelData) !== null && _activity$channelData5 !== void 0 && (_activity$channelData6 = _activity$channelData5.tags) !== null && _activity$channelData6 !== void 0 && _activity$channelData6.includes(Constants.systemMessageTag)) {
-          // eslint-disable-next-line @typescript-eslint/no-explicit-any
-          payload.messageType = Constants.systemMessageTag;
-          TelemetryHelper.logActionEvent(LogLevel.INFO, {
-            Event: TelemetryEvent.SystemMessageReceived,
-            Description: "System message received"
-          });
-        } else {
-          var _activity$channelData7, _activity$channelData8, _activity$channelData9;
-          // eslint-disable-next-line @typescript-eslint/no-explicit-any
-          const messageHasNoText = !(activity !== null && activity !== void 0 && activity.text);
-          // eslint-disable-next-line @typescript-eslint/no-explicit-any
-          const messageHasNoTags = !(activity !== null && activity !== void 0 && activity.channelData) || !(activity !== null && activity !== void 0 && (_activity$channelData7 = activity.channelData) !== null && _activity$channelData7 !== void 0 && _activity$channelData7.tags) || (activity === null || activity === void 0 ? void 0 : (_activity$channelData8 = activity.channelData) === null || _activity$channelData8 === void 0 ? void 0 : (_activity$channelData9 = _activity$channelData8.tags) === null || _activity$channelData9 === void 0 ? void 0 : _activity$channelData9.length) === 0;
-          // eslint-disable-next-line @typescript-eslint/no-explicit-any
-          const messageHasNoAttachments = !(activity !== null && activity !== void 0 && activity.attachments) || (activity === null || activity === void 0 ? void 0 : activity.attachments.length) === 0;
-          if (messageHasNoTags && messageHasNoText && messageHasNoAttachments) {
-            return;
-          }
-          payload.messageType = Constants.userMessageTag;
-        }
-        const newMessageReceivedEvent = {
-          eventName: isHistoryMessage ? BroadcastEvent.HistoryMessageReceived : BroadcastEvent.NewMessageReceived,
-          payload: polyfillMessagePayloadForEvent(payload)
-        };
-        BroadcastService.postMessage(newMessageReceivedEvent);
-        if (!isHistoryMessage) {
-          TelemetryHelper.logActionEvent(LogLevel.INFO, {
-            Event: TelemetryEvent.MessageReceived,
-            Description: "New message received",
-            CustomProperties: payload
-          });
-        } else {
-          if (!isHistoryMessageReceivedEventRasied) {
-            isHistoryMessageReceivedEventRasied = true;
-            TelemetryHelper.logActionEvent(LogLevel.INFO, {
-              Event: TelemetryEvent.RehydrateMessageReceived,
-              Description: "History message received",
-              CustomProperties: payload
-            });
-          }
-        }
+      const scenarioType = getScenarioType(activity);
+      switch (scenarioType) {
+        case ScenarioType.UserSendMessageStrategy:
+          userSendMessageStrategy(activity);
+          break;
+        case ScenarioType.SystemMessageStrategy:
+          systemMessageStrategy(activity);
+          break;
+        case ScenarioType.ReceivedMessageStrategy:
+          receivedMessageStrategy(activity);
+          break;
       }
     }
   };

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

@@ -192,6 +192,9 @@ export declare enum TelemetryEvent {
     ReconnectChatMinimize = "ReconnectChatMinimize",
     MessageSent = "MessageSent",
     MessageReceived = "MessageReceived",
+    MessageLapTrack = "MessageLapTrack",
+    MessageStartLapTrackError = "MessageStartLapTrackError",
+    MessageStopLapTrackError = "MessageStopLapTrackError",
     SystemMessageReceived = "SystemMessageReceived",
     RehydrateMessageReceived = "RehydrateMessageReceived",
     CustomContextReceived = "CustomContextReceived",
@@ -206,6 +209,8 @@ export declare enum TelemetryEvent {
     PostChatContextCallFailed = "PostChatContextCallFailed",
     PostChatSurveyLoadingPaneLoaded = "PostChatSurveyLoadingPaneLoaded",
     PostChatSurveyLoaded = "PostChatSurveyLoaded",
+    PostChatSurveyUrlValidationCompleted = "PostChatSurveyUrlValidationCompleted",
+    PostChatSurveyUrlValidationFailed = "PostChatSurveyUrlValidationFailed",
     ChatDisconnectThreadEventReceived = "ChatDisconnectThreadEventReceived",
     HiddenAdaptiveCardMessageReceived = "HiddenAdaptiveCardMessageReceived",
     EndingAdapterAfterDisconnectionError = "EndingAdapterAfterDisconnectionError",

package/lib/types/components/postchatsurveypanestateful/common/isValidSurveyUrl.d.ts

@@ -0,0 +1,2 @@
+declare const isValidSurveyUrl: (url: string) => boolean;
+export default isValidSurveyUrl;

package/lib/types/contexts/common/ILiveChatWidgetContext.d.ts

@@ -1,9 +1,9 @@
+import { ConfirmationState, ConversationEndEntity, ParticipantType } from "../../common/Constants";
 import ChatConfig from "@microsoft/omnichannel-chat-sdk/lib/core/ChatConfig";
 import { ConversationState } from "./ConversationState";
 import { IInternalTelemetryData } from "../../common/telemetry/interfaces/IInternalTelemetryData";
 import { ILiveChatWidgetLocalizedTexts } from "./ILiveChatWidgetLocalizedTexts";
 import { IRenderingMiddlewareProps } from "../../components/webchatcontainerstateful/interfaces/IRenderingMiddlewareProps";
-import { ConfirmationState, ConversationEndEntity, ParticipantType } from "../../common/Constants";
 import { StartChatFailureType } from "./StartChatFailureType";
 export interface ILiveChatWidgetContext {
     domainStates: {

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

@@ -0,0 +1,30 @@
+export declare enum ScenarioType {
+    UserSendMessageStrategy = "UserSendMessageStrategy",
+    SystemMessageStrategy = "SystemMessageStrategy",
+    ReceivedMessageStrategy = "ReceivedMessageStrategy"
+}
+export type MessagePayload = {
+    text: string;
+    type: string;
+    timestamp?: string | undefined;
+    userId: string;
+    tags: string[];
+    messageType: string;
+    Id: string | undefined;
+    role: string | undefined;
+    channelData?: any;
+    chatId?: string;
+    conversationId?: string;
+    isChatComplete: boolean;
+    attachment?: any[];
+};
+export type TrackingMessage = {
+    Id: string | undefined;
+    role: string | undefined;
+    timestamp: string | undefined;
+    tags: string[];
+    messageType: string;
+    text: string;
+    checkTime?: number;
+    type: string;
+};

package/lib/types/firstresponselatency/FirstResponseLatencyTracker.d.ts

@@ -0,0 +1,17 @@
+import { MessagePayload } from "./Constants";
+export declare class FirstResponseLatencyTracker {
+    private isABotConversation;
+    private isStarted;
+    private isEnded;
+    private startTrackingMessage?;
+    private stopTrackingMessage?;
+    constructor();
+    private createTrackingMessage;
+    private startTracking;
+    private handleAgentMessage;
+    private stopTracking;
+    private isMessageFromValidSender;
+    startClock(payload: MessagePayload): void;
+    stopClock(payload: MessagePayload): void;
+    private deregister;
+}

package/lib/types/firstresponselatency/util.d.ts

@@ -0,0 +1,6 @@
+import { MessagePayload, ScenarioType } from "./Constants";
+import { IActivity } from "botframework-directlinejs";
+export declare const isHistoryMessage: (activity: IActivity, startTime: number) => boolean;
+export declare const buildMessagePayload: (activity: IActivity, userId: string) => MessagePayload;
+export declare const polyfillMessagePayloadForEvent: (activity: IActivity, payload: MessagePayload, conversationId?: string) => MessagePayload;
+export declare const getScenarioType: (activity: IActivity) => ScenarioType;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/omnichannel-chat-widget",
-  "version": "1.7.8-main.9e74278",
+  "version": "1.7.8-main.bd4de53",
   "description": "Microsoft Omnichannel Chat Widget",
   "main": "lib/cjs/index.js",
   "types": "lib/types/index.d.ts",