@microsoft/omnichannel-chat-widget 1.8.2-main.5199342 → 1.8.2-main.d82a79b
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -0
- package/lib/cjs/common/Constants.js +11 -3
- package/lib/cjs/common/telemetry/TelemetryConstants.js +1 -0
- package/lib/cjs/common/utils.js +7 -1
- package/lib/cjs/components/draggable/DraggableChatWidget.js +16 -1
- package/lib/cjs/components/livechatwidget/common/createInternetConnectionChangeHandler.js +22 -9
- package/lib/cjs/components/livechatwidget/common/endChat.js +18 -7
- package/lib/cjs/components/livechatwidget/common/initWebChatComposer.js +30 -1
- package/lib/cjs/components/livechatwidget/common/liveChatConfigUtils.js +18 -1
- package/lib/cjs/components/livechatwidget/common/renderSurveyHelpers.js +31 -7
- package/lib/cjs/components/livechatwidget/common/setPostChatContextAndLoadSurvey.js +15 -2
- package/lib/cjs/components/livechatwidget/common/startChat.js +6 -4
- package/lib/cjs/components/livechatwidget/livechatwidgetstateful/LiveChatWidgetStateful.js +22 -11
- package/lib/cjs/components/webchatcontainerstateful/WebChatContainerStateful.js +18 -14
- package/lib/cjs/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/channelDataMiddleware.js +4 -3
- package/lib/cjs/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/conversationEndMiddleware.js +12 -6
- package/lib/cjs/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/queueOverflowHandlerMiddleware.js +45 -0
- package/lib/cjs/contexts/common/LiveChatWidgetActionType.js +3 -1
- package/lib/cjs/contexts/common/LiveChatWidgetContextInitialState.js +3 -1
- package/lib/cjs/contexts/createReducer.js +30 -0
- package/lib/cjs/controller/componentController.js +2 -2
- package/lib/cjs/firstresponselatency/FirstMessageTrackerFromBot.js +101 -36
- package/lib/cjs/firstresponselatency/FirstResponseLatencyTracker.js +39 -21
- package/lib/cjs/firstresponselatency/util.js +60 -31
- package/lib/cjs/plugins/newMessageEventHandler.js +12 -6
- package/lib/esm/common/Constants.js +9 -2
- package/lib/esm/common/telemetry/TelemetryConstants.js +1 -0
- package/lib/esm/common/utils.js +4 -0
- package/lib/esm/components/draggable/DraggableChatWidget.js +16 -1
- package/lib/esm/components/livechatwidget/common/createInternetConnectionChangeHandler.js +22 -9
- package/lib/esm/components/livechatwidget/common/endChat.js +18 -7
- package/lib/esm/components/livechatwidget/common/initWebChatComposer.js +30 -1
- package/lib/esm/components/livechatwidget/common/liveChatConfigUtils.js +16 -0
- package/lib/esm/components/livechatwidget/common/renderSurveyHelpers.js +33 -9
- package/lib/esm/components/livechatwidget/common/setPostChatContextAndLoadSurvey.js +16 -3
- package/lib/esm/components/livechatwidget/common/startChat.js +6 -4
- package/lib/esm/components/livechatwidget/livechatwidgetstateful/LiveChatWidgetStateful.js +22 -11
- package/lib/esm/components/webchatcontainerstateful/WebChatContainerStateful.js +18 -14
- package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/channelDataMiddleware.js +4 -4
- package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/conversationEndMiddleware.js +12 -6
- package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/queueOverflowHandlerMiddleware.js +38 -0
- package/lib/esm/contexts/common/LiveChatWidgetActionType.js +3 -1
- package/lib/esm/contexts/common/LiveChatWidgetContextInitialState.js +3 -1
- package/lib/esm/contexts/createReducer.js +30 -0
- package/lib/esm/controller/componentController.js +2 -2
- package/lib/esm/firstresponselatency/FirstMessageTrackerFromBot.js +101 -36
- package/lib/esm/firstresponselatency/FirstResponseLatencyTracker.js +39 -21
- package/lib/esm/firstresponselatency/util.js +57 -29
- package/lib/esm/plugins/newMessageEventHandler.js +12 -6
- package/lib/types/common/Constants.d.ts +8 -2
- package/lib/types/common/telemetry/TelemetryConstants.d.ts +1 -0
- package/lib/types/common/utils.d.ts +5 -0
- package/lib/types/components/livechatwidget/common/liveChatConfigUtils.d.ts +1 -0
- package/lib/types/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/channelDataMiddleware.d.ts +1 -1
- package/lib/types/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/conversationEndMiddleware.d.ts +1 -1
- package/lib/types/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/queueOverflowHandlerMiddleware.d.ts +5 -0
- package/lib/types/contexts/common/ILiveChatWidgetContext.d.ts +2 -0
- package/lib/types/contexts/common/LiveChatWidgetActionType.d.ts +3 -1
- package/lib/types/firstresponselatency/FirstResponseLatencyTracker.d.ts +2 -2
- package/lib/types/firstresponselatency/util.d.ts +17 -0
- package/lib/types/plugins/newMessageEventHandler.d.ts +1 -1
- package/package.json +4 -4
|
@@ -7,54 +7,96 @@ import { createTrackingMessage } from "./util";
|
|
|
7
7
|
// with different timeline, therefore this is a functional approach to track the events, instead of a class based approach
|
|
8
8
|
export const createTrackingForFirstMessage = () => {
|
|
9
9
|
// Reset the tracking variables
|
|
10
|
-
let
|
|
11
|
-
let stopTracking = false;
|
|
10
|
+
let isTracking = false;
|
|
12
11
|
let startTime = 0;
|
|
13
12
|
let stopTime = 0;
|
|
14
|
-
let stopTrackingMessage;
|
|
13
|
+
let stopTrackingMessage = null;
|
|
15
14
|
let flag = false;
|
|
15
|
+
let trackingTimeoutId;
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* Checks if the message payload is from a valid sender (not an agent).
|
|
19
|
+
* Returns false if the message is from an agent (tag 'public'), true otherwise.
|
|
20
|
+
*/
|
|
16
21
|
const isMessageFromValidSender = payload => {
|
|
17
22
|
var _payload$tags;
|
|
18
|
-
// agent scenario
|
|
19
23
|
if (payload !== null && payload !== void 0 && (_payload$tags = payload.tags) !== null && _payload$tags !== void 0 && _payload$tags.includes("public")) {
|
|
20
24
|
return false;
|
|
21
25
|
}
|
|
22
26
|
return true;
|
|
23
27
|
};
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* Listener for widget load completion event.
|
|
31
|
+
* Starts tracking the time for the first bot message after widget loads.
|
|
32
|
+
* Sets a 5-second timeout to auto-reset if no bot message is received.
|
|
33
|
+
*/
|
|
24
34
|
const widgetLoadListener = BroadcastService.getMessageByEventName(TelemetryEvent.WidgetLoadComplete).subscribe(() => {
|
|
25
|
-
if (
|
|
26
|
-
|
|
35
|
+
if (isTracking) return;
|
|
36
|
+
isTracking = true;
|
|
27
37
|
startTime = new Date().getTime();
|
|
38
|
+
// Start a 5-second timeout to auto-stop tracking if not stopped
|
|
39
|
+
if (trackingTimeoutId) {
|
|
40
|
+
clearTimeout(trackingTimeoutId);
|
|
41
|
+
}
|
|
42
|
+
trackingTimeoutId = setTimeout(() => {
|
|
43
|
+
if (isTracking) {
|
|
44
|
+
// Reset state and disengage, no telemetry or FMLTrackingCompleted
|
|
45
|
+
isTracking = false;
|
|
46
|
+
startTime = 0;
|
|
47
|
+
stopTime = 0;
|
|
48
|
+
stopTrackingMessage = null;
|
|
49
|
+
trackingTimeoutId = undefined;
|
|
50
|
+
disconnectListener();
|
|
51
|
+
}
|
|
52
|
+
}, 10000); //adding more time since it meassures from widget load complete till message received
|
|
28
53
|
});
|
|
54
|
+
|
|
55
|
+
/**
|
|
56
|
+
* Listener for new bot message event.
|
|
57
|
+
* If a valid bot message is received, stops tracking and logs telemetry.
|
|
58
|
+
* If the message is invalid, resets and disengages listeners.
|
|
59
|
+
*/
|
|
29
60
|
const newMessageListener = BroadcastService.getMessageByEventName(BroadcastEvent.NewMessageReceived).subscribe(message => {
|
|
30
61
|
const payload = message.payload;
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
stopTime = new Date().getTime();
|
|
38
|
-
const elapsedTime = stopTime - startTime;
|
|
39
|
-
stopTracking = true;
|
|
40
|
-
stopTrackingMessage = createTrackingMessage(payload, "botMessage");
|
|
41
|
-
notifyFMLTrackingCompleted();
|
|
42
|
-
TelemetryHelper.logActionEvent(LogLevel.INFO, {
|
|
43
|
-
Event: TelemetryEvent.BotFirstMessageLapTrack,
|
|
44
|
-
Description: "First Message from Bot latency tracking",
|
|
45
|
-
CustomProperties: {
|
|
46
|
-
elapsedTime,
|
|
47
|
-
widgetLoadedAt: startTime,
|
|
48
|
-
botMessage: stopTrackingMessage
|
|
49
|
-
}
|
|
50
|
-
});
|
|
62
|
+
if (!isMessageFromValidSender(payload)) {
|
|
63
|
+
// If not valid, stop everything and clean up
|
|
64
|
+
isTracking = false;
|
|
65
|
+
if (trackingTimeoutId) {
|
|
66
|
+
clearTimeout(trackingTimeoutId);
|
|
67
|
+
trackingTimeoutId = undefined;
|
|
51
68
|
}
|
|
69
|
+
disconnectListener();
|
|
70
|
+
return;
|
|
71
|
+
}
|
|
72
|
+
if (isTracking) {
|
|
73
|
+
isTracking = false;
|
|
74
|
+
// Clear the timeout if it exists
|
|
75
|
+
if (trackingTimeoutId) {
|
|
76
|
+
clearTimeout(trackingTimeoutId);
|
|
77
|
+
trackingTimeoutId = undefined;
|
|
78
|
+
}
|
|
79
|
+
stopTime = new Date().getTime();
|
|
80
|
+
const elapsedTime = stopTime - startTime;
|
|
81
|
+
stopTrackingMessage = createTrackingMessage(payload, "botMessage");
|
|
82
|
+
notifyFMLTrackingCompleted();
|
|
83
|
+
TelemetryHelper.logActionEvent(LogLevel.INFO, {
|
|
84
|
+
Event: TelemetryEvent.BotFirstMessageLapTrack,
|
|
85
|
+
Description: "First Message from Bot latency tracking",
|
|
86
|
+
CustomProperties: {
|
|
87
|
+
elapsedTime,
|
|
88
|
+
widgetLoadedAt: startTime,
|
|
89
|
+
botMessage: stopTrackingMessage
|
|
90
|
+
}
|
|
91
|
+
});
|
|
92
|
+
disconnectListener();
|
|
52
93
|
}
|
|
53
|
-
|
|
54
|
-
// this track only first message, if coming from the bot or not
|
|
55
|
-
// the only difference is that it logs only those from bot
|
|
56
|
-
disconnectListener();
|
|
57
94
|
});
|
|
95
|
+
|
|
96
|
+
/**
|
|
97
|
+
* Notifies that FML (First Message Latency) tracking is completed.
|
|
98
|
+
* Retries sending the completion event until acknowledged.
|
|
99
|
+
*/
|
|
58
100
|
const notifyFMLTrackingCompleted = () => {
|
|
59
101
|
ackListener();
|
|
60
102
|
// Retry sending until flag is true, but do not block the main thread
|
|
@@ -69,6 +111,11 @@ export const createTrackingForFirstMessage = () => {
|
|
|
69
111
|
}
|
|
70
112
|
}, 100);
|
|
71
113
|
};
|
|
114
|
+
|
|
115
|
+
/**
|
|
116
|
+
* Listener for FMLTrackingCompletedAck event.
|
|
117
|
+
* Sets the flag to true when acknowledgment is received.
|
|
118
|
+
*/
|
|
72
119
|
const ackListener = () => {
|
|
73
120
|
const listen = BroadcastService.getMessageByEventName(BroadcastEvent.FMLTrackingCompletedAck).subscribe(() => {
|
|
74
121
|
flag = true;
|
|
@@ -78,22 +125,32 @@ export const createTrackingForFirstMessage = () => {
|
|
|
78
125
|
|
|
79
126
|
// 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
|
|
80
127
|
// No need to keep listerning for tracking, enforcing disconnection for the listners
|
|
128
|
+
/**
|
|
129
|
+
* Listener for widget rehydration event.
|
|
130
|
+
* Resets tracking and disconnects listeners when widget is reloaded.
|
|
131
|
+
*/
|
|
81
132
|
const rehydrateListener = BroadcastService.getMessageByEventName(TelemetryEvent.RehydrateMessageReceived).subscribe(() => {
|
|
82
|
-
|
|
83
|
-
stopTracking = false;
|
|
133
|
+
isTracking = false;
|
|
84
134
|
disconnectListener();
|
|
85
135
|
});
|
|
86
136
|
|
|
87
137
|
// 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
|
|
88
138
|
// No need to keep listerning for tracking, enforcing disconnection for the listners
|
|
139
|
+
/**
|
|
140
|
+
* Listener for history message event.
|
|
141
|
+
* Resets tracking and disconnects listeners when history is loaded.
|
|
142
|
+
*/
|
|
89
143
|
const historyListener = BroadcastService.getMessageByEventName(BroadcastEvent.HistoryMessageReceived).subscribe(() => {
|
|
90
|
-
|
|
91
|
-
stopTracking = false;
|
|
144
|
+
isTracking = false;
|
|
92
145
|
disconnectListener();
|
|
93
146
|
});
|
|
147
|
+
|
|
148
|
+
/**
|
|
149
|
+
* Listener for network disconnection event.
|
|
150
|
+
* Resets tracking, disconnects listeners, and logs a telemetry error.
|
|
151
|
+
*/
|
|
94
152
|
const offlineNetworkListener = BroadcastService.getMessageByEventName(TelemetryEvent.NetworkDisconnected).subscribe(() => {
|
|
95
|
-
|
|
96
|
-
stopTracking = false;
|
|
153
|
+
isTracking = false;
|
|
97
154
|
disconnectListener();
|
|
98
155
|
TelemetryHelper.logActionEvent(LogLevel.INFO, {
|
|
99
156
|
Event: TelemetryEvent.BotFirstMessageLapTrackError,
|
|
@@ -102,7 +159,15 @@ export const createTrackingForFirstMessage = () => {
|
|
|
102
159
|
});
|
|
103
160
|
|
|
104
161
|
// this is to ensure that we are not tracking messages that are not part of the current conversation
|
|
162
|
+
/**
|
|
163
|
+
* Disconnects all listeners and clears the tracking timeout.
|
|
164
|
+
* Used for cleanup when tracking is stopped or reset.
|
|
165
|
+
*/
|
|
105
166
|
const disconnectListener = () => {
|
|
167
|
+
if (trackingTimeoutId) {
|
|
168
|
+
clearTimeout(trackingTimeoutId);
|
|
169
|
+
trackingTimeoutId = undefined;
|
|
170
|
+
}
|
|
106
171
|
historyListener.unsubscribe();
|
|
107
172
|
rehydrateListener.unsubscribe();
|
|
108
173
|
newMessageListener.unsubscribe();
|
|
@@ -11,14 +11,13 @@ export let FirstResponseLatencyTracker = /*#__PURE__*/function () {
|
|
|
11
11
|
function FirstResponseLatencyTracker() {
|
|
12
12
|
_classCallCheck(this, FirstResponseLatencyTracker);
|
|
13
13
|
_defineProperty(this, "isABotConversation", false);
|
|
14
|
-
_defineProperty(this, "
|
|
15
|
-
_defineProperty(this, "isEnded", false);
|
|
14
|
+
_defineProperty(this, "isTracking", false);
|
|
16
15
|
_defineProperty(this, "startTrackingMessage", void 0);
|
|
17
16
|
_defineProperty(this, "stopTrackingMessage", void 0);
|
|
18
17
|
_defineProperty(this, "isReady", false);
|
|
18
|
+
_defineProperty(this, "trackingTimeoutId", void 0);
|
|
19
19
|
_defineProperty(this, "offlineNetworkListener", BroadcastService.getMessageByEventName(TelemetryEvent.NetworkDisconnected).subscribe(() => {
|
|
20
|
-
this.
|
|
21
|
-
this.isEnded = false;
|
|
20
|
+
this.isTracking = false;
|
|
22
21
|
TelemetryHelper.logActionEvent(LogLevel.INFO, {
|
|
23
22
|
Event: TelemetryEvent.MessageStopLapTrackError,
|
|
24
23
|
Description: "Tracker Stopped due to network disconnection"
|
|
@@ -66,7 +65,7 @@ export let FirstResponseLatencyTracker = /*#__PURE__*/function () {
|
|
|
66
65
|
value: function startTracking(payload) {
|
|
67
66
|
if (!this.isReady) return;
|
|
68
67
|
// this prevents to initiate tracking for multiple incoming messages
|
|
69
|
-
if (this.
|
|
68
|
+
if (this.isTracking) {
|
|
70
69
|
return;
|
|
71
70
|
}
|
|
72
71
|
// this is to ensure we track only messages where bot is engaged
|
|
@@ -74,10 +73,24 @@ export let FirstResponseLatencyTracker = /*#__PURE__*/function () {
|
|
|
74
73
|
return;
|
|
75
74
|
}
|
|
76
75
|
// control of states to prevent clashing of messages
|
|
77
|
-
this.
|
|
78
|
-
this.isEnded = false;
|
|
76
|
+
this.isTracking = true;
|
|
79
77
|
// The idea of using types is to enrich telemetry data
|
|
80
78
|
this.startTrackingMessage = this.createTrackingMessage(payload, "userMessage");
|
|
79
|
+
|
|
80
|
+
// Start a 5-second timeout to auto-stop tracking if not stopped
|
|
81
|
+
if (this.trackingTimeoutId) {
|
|
82
|
+
clearTimeout(this.trackingTimeoutId);
|
|
83
|
+
}
|
|
84
|
+
this.trackingTimeoutId = setTimeout(() => {
|
|
85
|
+
// this means the start process is in progress, but the end wasn't called within the time limit
|
|
86
|
+
if (this.isTracking) {
|
|
87
|
+
// Reset state variables and skip stopTracking
|
|
88
|
+
this.isTracking = false;
|
|
89
|
+
this.startTrackingMessage = undefined;
|
|
90
|
+
this.stopTrackingMessage = undefined;
|
|
91
|
+
this.trackingTimeoutId = undefined;
|
|
92
|
+
}
|
|
93
|
+
}, 5000);
|
|
81
94
|
}
|
|
82
95
|
}, {
|
|
83
96
|
key: "handleAgentMessage",
|
|
@@ -93,13 +106,16 @@ export let FirstResponseLatencyTracker = /*#__PURE__*/function () {
|
|
|
93
106
|
value: function stopTracking(payload) {
|
|
94
107
|
var _this$stopTrackingMes, _this$startTrackingMe;
|
|
95
108
|
// this prevents execution for multiple incoming messages from the bot.
|
|
96
|
-
if (
|
|
109
|
+
if (!this.isTracking) {
|
|
97
110
|
return;
|
|
98
111
|
}
|
|
99
|
-
|
|
112
|
+
// Clear the timeout if it exists
|
|
113
|
+
if (this.trackingTimeoutId) {
|
|
114
|
+
clearTimeout(this.trackingTimeoutId);
|
|
115
|
+
this.trackingTimeoutId = undefined;
|
|
116
|
+
}
|
|
100
117
|
// control of states to prevent clashing of messages
|
|
101
|
-
this.
|
|
102
|
-
this.isStarted = false;
|
|
118
|
+
this.isTracking = false;
|
|
103
119
|
|
|
104
120
|
// The idea of using types is to enrich telemetry data
|
|
105
121
|
this.stopTrackingMessage = this.createTrackingMessage(payload, "botMessage");
|
|
@@ -154,12 +170,16 @@ export let FirstResponseLatencyTracker = /*#__PURE__*/function () {
|
|
|
154
170
|
if (!payload || !payload.Id) {
|
|
155
171
|
throw new Error("Invalid payload");
|
|
156
172
|
}
|
|
157
|
-
|
|
158
|
-
if
|
|
173
|
+
|
|
174
|
+
// Only allow stopTracking if sender is valid and tracking is active
|
|
175
|
+
if (!this.isMessageFromValidSender(payload)) {
|
|
176
|
+
// Do not change isTracking or stopTrackingMessage
|
|
177
|
+
return;
|
|
178
|
+
}
|
|
179
|
+
if (this.isABotConversation && this.isTracking) {
|
|
159
180
|
this.stopTracking(payload);
|
|
160
181
|
}
|
|
161
182
|
} catch (e) {
|
|
162
|
-
console.error("FRL : error while trying to stop the tracker", e);
|
|
163
183
|
TelemetryHelper.logActionEvent(LogLevel.ERROR, {
|
|
164
184
|
Event: TelemetryEvent.MessageStopLapTrackError,
|
|
165
185
|
Description: "Error while stopping the clock",
|
|
@@ -168,11 +188,6 @@ export let FirstResponseLatencyTracker = /*#__PURE__*/function () {
|
|
|
168
188
|
payload: payload
|
|
169
189
|
}
|
|
170
190
|
});
|
|
171
|
-
//reset state
|
|
172
|
-
this.startTrackingMessage = undefined;
|
|
173
|
-
this.stopTrackingMessage = undefined;
|
|
174
|
-
this.isStarted = false;
|
|
175
|
-
this.isEnded = false;
|
|
176
191
|
}
|
|
177
192
|
}
|
|
178
193
|
}, {
|
|
@@ -180,10 +195,13 @@ export let FirstResponseLatencyTracker = /*#__PURE__*/function () {
|
|
|
180
195
|
value: function deregister() {
|
|
181
196
|
// Reset State
|
|
182
197
|
this.isABotConversation = false;
|
|
183
|
-
this.
|
|
184
|
-
this.isEnded = false;
|
|
198
|
+
this.isTracking = false;
|
|
185
199
|
this.startTrackingMessage = undefined;
|
|
186
200
|
this.stopTrackingMessage = undefined;
|
|
201
|
+
if (this.trackingTimeoutId) {
|
|
202
|
+
clearTimeout(this.trackingTimeoutId);
|
|
203
|
+
this.trackingTimeoutId = undefined;
|
|
204
|
+
}
|
|
187
205
|
this.offlineNetworkListener.unsubscribe();
|
|
188
206
|
this.fmltrackingListener.unsubscribe();
|
|
189
207
|
this.rehydrateListener.unsubscribe();
|
|
@@ -1,38 +1,66 @@
|
|
|
1
1
|
import { ScenarioType } from "./Constants";
|
|
2
2
|
import { Constants } from "../common/Constants";
|
|
3
|
+
const DELTA_WITHIN_LIMITS_IN_MS = 250;
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Determines whether a given activity is a historical message.
|
|
7
|
+
*
|
|
8
|
+
* This function checks if the activity is a message type and uses a combination
|
|
9
|
+
* of legacy tags and timestamp-based logic to determine if the message is historical.
|
|
10
|
+
*
|
|
11
|
+
* @param {IActivity} activity - The activity object to evaluate.
|
|
12
|
+
* @param {number} startTime - The start time (in milliseconds since epoch) to compare against.
|
|
13
|
+
* @returns {boolean} - Returns true if the activity is a historical message, false otherwise.
|
|
14
|
+
*
|
|
15
|
+
* Logic:
|
|
16
|
+
* - If the activity type is not a message, it is not historical.
|
|
17
|
+
* - If the activity contains a legacy history message tag, it is considered historical.
|
|
18
|
+
* - Otherwise, the function extracts a timestamp from the activity ID using `extractTimestampFromId`.
|
|
19
|
+
* - If the ID is valid and the timestamp is older than the start time, the message is historical.
|
|
20
|
+
*/
|
|
3
21
|
export const isHistoryMessage = (activity, startTime) => {
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
22
|
+
var _activity$channelData;
|
|
23
|
+
// Only process message activities
|
|
24
|
+
if ((activity === null || activity === void 0 ? void 0 : activity.type) !== Constants.message) {
|
|
25
|
+
return false;
|
|
26
|
+
}
|
|
9
27
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
28
|
+
// Prioritize legacy history tag
|
|
29
|
+
if (activity !== null && activity !== void 0 && (_activity$channelData = activity.channelData) !== null && _activity$channelData !== void 0 && _activity$channelData.tags && activity.channelData.tags.includes(Constants.historyMessageTag)) {
|
|
30
|
+
return true;
|
|
31
|
+
}
|
|
32
|
+
const activityId = extractTimestampFromId(activity);
|
|
33
|
+
const isValidId = !isNaN(activityId) && activityId > 0;
|
|
34
|
+
const difference = startTime - activityId;
|
|
35
|
+
// Only consider historical if activityId < startTime and difference >= DELTA_WITHIN_LIMITS_IN_MS
|
|
36
|
+
const isOlderThanStartTime = activityId < startTime && difference >= DELTA_WITHIN_LIMITS_IN_MS;
|
|
37
|
+
const isHistoryById = isValidId && isOlderThanStartTime;
|
|
38
|
+
return isHistoryById;
|
|
39
|
+
};
|
|
40
|
+
export const extractTimestampFromId = activity => {
|
|
41
|
+
const id = (activity === null || activity === void 0 ? void 0 : activity.id) ?? "";
|
|
14
42
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
43
|
+
// Helper function to get timestamp fallback
|
|
44
|
+
const getTimestampFallback = () => {
|
|
45
|
+
const timestamp = new Date((activity === null || activity === void 0 ? void 0 : activity.timestamp) ?? "").getTime();
|
|
46
|
+
return isNaN(timestamp) ? 0 : timestamp;
|
|
47
|
+
};
|
|
19
48
|
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
console.error("Error in parsing activity id: ", e);
|
|
49
|
+
// Check if ID looks like a UUID (contains dashes or is very long)
|
|
50
|
+
const UUID_LENGTH_THRESHOLD = 13; // Threshold to distinguish UUIDs from epoch timestamps
|
|
51
|
+
if (id.includes("-") || id.length > UUID_LENGTH_THRESHOLD) {
|
|
52
|
+
// Likely UUID, use timestamp instead
|
|
53
|
+
return getTimestampFallback();
|
|
54
|
+
}
|
|
55
|
+
const activityId = parseInt(id);
|
|
56
|
+
// if activity id is not a number, then we use timestamp field
|
|
57
|
+
if (isNaN(activityId)) {
|
|
58
|
+
return getTimestampFallback();
|
|
31
59
|
}
|
|
32
|
-
return
|
|
60
|
+
return activityId;
|
|
33
61
|
};
|
|
34
62
|
export const buildMessagePayload = (activity, userId) => {
|
|
35
|
-
var _text, _text2, _activity$
|
|
63
|
+
var _text, _text2, _activity$channelData2, _activity$from;
|
|
36
64
|
return {
|
|
37
65
|
// To identify hidden contents vs empty content
|
|
38
66
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
@@ -40,7 +68,7 @@ export const buildMessagePayload = (activity, userId) => {
|
|
|
40
68
|
type: activity === null || activity === void 0 ? void 0 : activity.type,
|
|
41
69
|
timestamp: activity === null || activity === void 0 ? void 0 : activity.timestamp,
|
|
42
70
|
userId: userId,
|
|
43
|
-
tags: activity === null || activity === void 0 ? void 0 : (_activity$
|
|
71
|
+
tags: (activity === null || activity === void 0 ? void 0 : (_activity$channelData2 = activity.channelData) === null || _activity$channelData2 === void 0 ? void 0 : _activity$channelData2.tags) || [],
|
|
44
72
|
messageType: "",
|
|
45
73
|
Id: activity === null || activity === void 0 ? void 0 : activity.id,
|
|
46
74
|
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
|
|
|
64
92
|
};
|
|
65
93
|
};
|
|
66
94
|
export const getScenarioType = activity => {
|
|
67
|
-
var _activity$from3, _activity$
|
|
95
|
+
var _activity$from3, _activity$channelData3;
|
|
68
96
|
const role = activity === null || activity === void 0 ? void 0 : (_activity$from3 = activity.from) === null || _activity$from3 === void 0 ? void 0 : _activity$from3.role;
|
|
69
|
-
const tags = activity === null || activity === void 0 ? void 0 : (_activity$
|
|
97
|
+
const tags = activity === null || activity === void 0 ? void 0 : (_activity$channelData3 = activity.channelData) === null || _activity$channelData3 === void 0 ? void 0 : _activity$channelData3.tags;
|
|
70
98
|
if (role === Constants.userMessageTag) {
|
|
71
99
|
return ScenarioType.UserSendMessageStrategy;
|
|
72
100
|
}
|
|
@@ -6,13 +6,13 @@ import { Constants } from "../common/Constants";
|
|
|
6
6
|
import { FirstResponseLatencyTracker } from "../firstresponselatency/FirstResponseLatencyTracker";
|
|
7
7
|
import { TelemetryHelper } from "../common/telemetry/TelemetryHelper";
|
|
8
8
|
import { TelemetryManager } from "../common/telemetry/TelemetryManager";
|
|
9
|
-
export const createOnNewAdapterActivityHandler = (chatId, userId) => {
|
|
9
|
+
export const createOnNewAdapterActivityHandler = (chatId, userId, startTime) => {
|
|
10
10
|
// Hooking the message tracker in the listener, a bit invasive but easier to control.
|
|
11
11
|
const firstResponseLatencyTracker = new FirstResponseLatencyTracker();
|
|
12
12
|
// epoch time in utc for when start to listen.
|
|
13
13
|
// 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.
|
|
14
14
|
// 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
|
|
15
|
-
|
|
15
|
+
|
|
16
16
|
let isHistoryMessageReceivedEventRaised = false;
|
|
17
17
|
const onNewAdapterActivityHandler = activity => {
|
|
18
18
|
raiseMessageEvent(activity);
|
|
@@ -35,6 +35,7 @@ export const createOnNewAdapterActivityHandler = (chatId, userId) => {
|
|
|
35
35
|
});
|
|
36
36
|
};
|
|
37
37
|
const systemMessageStrategy = activity => {
|
|
38
|
+
var _TelemetryManager$Int3;
|
|
38
39
|
const payload = buildMessagePayload(activity, userId);
|
|
39
40
|
payload.messageType = Constants.systemMessageTag;
|
|
40
41
|
if (isHistoryMessage(activity, startTime)) {
|
|
@@ -42,6 +43,11 @@ export const createOnNewAdapterActivityHandler = (chatId, userId) => {
|
|
|
42
43
|
historyMessageStrategy(polyfillMessagePayloadForEvent(activity, payload, (_TelemetryManager$Int2 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int2 === void 0 ? void 0 : _TelemetryManager$Int2.conversationId));
|
|
43
44
|
return;
|
|
44
45
|
}
|
|
46
|
+
const newMessageReceivedEvent = {
|
|
47
|
+
eventName: BroadcastEvent.NewMessageReceived,
|
|
48
|
+
payload: polyfillMessagePayloadForEvent(activity, payload, (_TelemetryManager$Int3 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int3 === void 0 ? void 0 : _TelemetryManager$Int3.conversationId)
|
|
49
|
+
};
|
|
50
|
+
BroadcastService.postMessage(newMessageReceivedEvent);
|
|
45
51
|
TelemetryHelper.logActionEventToAllTelemetry(LogLevel.INFO, {
|
|
46
52
|
Event: TelemetryEvent.SystemMessageReceived,
|
|
47
53
|
Description: "System message received"
|
|
@@ -77,20 +83,20 @@ export const createOnNewAdapterActivityHandler = (chatId, userId) => {
|
|
|
77
83
|
return true;
|
|
78
84
|
};
|
|
79
85
|
const receivedMessageStrategy = activity => {
|
|
80
|
-
var _TelemetryManager$
|
|
86
|
+
var _TelemetryManager$Int5;
|
|
81
87
|
if (!isValidMessage(activity)) return;
|
|
82
88
|
const isHistoryMessageReceived = isHistoryMessage(activity, startTime);
|
|
83
89
|
const payload = buildMessagePayload(activity, userId);
|
|
84
90
|
payload.messageType = Constants.userMessageTag;
|
|
85
91
|
if (isHistoryMessageReceived) {
|
|
86
|
-
var _TelemetryManager$
|
|
87
|
-
historyMessageStrategy(polyfillMessagePayloadForEvent(activity, payload, (_TelemetryManager$
|
|
92
|
+
var _TelemetryManager$Int4;
|
|
93
|
+
historyMessageStrategy(polyfillMessagePayloadForEvent(activity, payload, (_TelemetryManager$Int4 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int4 === void 0 ? void 0 : _TelemetryManager$Int4.conversationId));
|
|
88
94
|
return;
|
|
89
95
|
}
|
|
90
96
|
firstResponseLatencyTracker.stopClock(payload);
|
|
91
97
|
const newMessageReceivedEvent = {
|
|
92
98
|
eventName: BroadcastEvent.NewMessageReceived,
|
|
93
|
-
payload: polyfillMessagePayloadForEvent(activity, payload, (_TelemetryManager$
|
|
99
|
+
payload: polyfillMessagePayloadForEvent(activity, payload, (_TelemetryManager$Int5 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int5 === void 0 ? void 0 : _TelemetryManager$Int5.conversationId)
|
|
94
100
|
};
|
|
95
101
|
BroadcastService.postMessage(newMessageReceivedEvent);
|
|
96
102
|
TelemetryHelper.logActionEventToAllTelemetry(LogLevel.INFO, {
|
|
@@ -7,6 +7,9 @@ export declare class Constants {
|
|
|
7
7
|
static readonly historyMessageTag = "history";
|
|
8
8
|
static readonly agentEndConversationMessageTag = "agentendconversation";
|
|
9
9
|
static readonly supervisorForceCloseMessageTag = "supervisorforceclosedconversation";
|
|
10
|
+
static readonly endConversationalSurveyMessageTag = "endconversationalsurvey";
|
|
11
|
+
static readonly startConversationalSurveyMessageTag = "startconversationalsurvey";
|
|
12
|
+
static readonly c2ConversationalSurveyMessageTag = "c2conversationalsurvey";
|
|
10
13
|
static readonly receivedMessageClassName = "ms_lcw_webchat_received_message";
|
|
11
14
|
static readonly sentMessageClassName = "ms_lcw_webchat_sent_message";
|
|
12
15
|
static readonly webchatChannelId = "webchat";
|
|
@@ -80,8 +83,7 @@ export declare class Constants {
|
|
|
80
83
|
static readonly TargetRelationship = "rel";
|
|
81
84
|
static readonly TargetRelationshipAttributes = "noopener noreferrer";
|
|
82
85
|
static readonly OpenLinkIconCssClass = "webchat__render-markdown__external-link-icon";
|
|
83
|
-
static readonly
|
|
84
|
-
static readonly internetConnectionTestUrlText = "Omnichannel Connect Test";
|
|
86
|
+
static readonly internetConnectionTestPath = "/livechatwidget/version.txt";
|
|
85
87
|
static readonly ChatWidgetStateChangedPrefix = "ChatWidgetStateChanged";
|
|
86
88
|
static readonly PostChatLoadingDurationInMs = 2000;
|
|
87
89
|
static readonly BrowserUnloadConfirmationMessage = "Do you want to leave chat?";
|
|
@@ -94,6 +96,7 @@ export declare class Constants {
|
|
|
94
96
|
static readonly OCOriginalMessageId = "OriginalMessageId";
|
|
95
97
|
static readonly WebchatSequenceIdAttribute = "webchat:sequence-id";
|
|
96
98
|
static readonly MessageSequenceIdOverride = "MessageSequenceIdOverride";
|
|
99
|
+
static readonly EndConversationDueToOverflow = "endconversationduetooverflow";
|
|
97
100
|
}
|
|
98
101
|
export declare const Regex: {
|
|
99
102
|
new (): {};
|
|
@@ -180,6 +183,9 @@ export declare enum ConversationMode {
|
|
|
180
183
|
Regular = "192350000",
|
|
181
184
|
Persistent = "192350001"
|
|
182
185
|
}
|
|
186
|
+
export declare enum SurveyProvider {
|
|
187
|
+
MicrosoftCopilotStudio = "600990001"
|
|
188
|
+
}
|
|
183
189
|
export declare enum LiveWorkItemState {
|
|
184
190
|
Active = "Active",
|
|
185
191
|
Closed = "Closed",
|
|
@@ -172,6 +172,7 @@ export declare enum TelemetryEvent {
|
|
|
172
172
|
BotAuthActivityUndefinedSignInId = "BotAuthActivityUndefinedSignInId",
|
|
173
173
|
ThirdPartyCookiesBlocked = "ThirdPartyCookiesBlocked",
|
|
174
174
|
ParticipantsRemovedEvent = "ParticipantsRemovedEvent",
|
|
175
|
+
QueueOverflowEvent = "QueueOverflowEvent",
|
|
175
176
|
ProcessingHTMLTextMiddlewareFailed = "ProcessingHTMLTextMiddlewareFailed",
|
|
176
177
|
ProcessingSanitizationMiddlewareFailed = "ProcessingSanitizationMiddlewareFailed",
|
|
177
178
|
FormatTagsMiddlewareJSONStringifyFailed = "FormatTagsMiddlewareJSONStringifyFailed",
|
|
@@ -47,3 +47,8 @@ export declare const formatTemplateString: (templateMessage: string, values: any
|
|
|
47
47
|
export declare const parseLowerCaseString: (property: string | boolean | undefined) => string;
|
|
48
48
|
export declare const setOcUserAgent: (chatSDK: any) => void;
|
|
49
49
|
export declare function getDeviceType(): string;
|
|
50
|
+
export declare function isEndConversationDueToOverflowActivity(activity: {
|
|
51
|
+
channelData?: {
|
|
52
|
+
tags?: string[];
|
|
53
|
+
};
|
|
54
|
+
}): boolean | undefined;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
1
|
import { FacadeChatSDK } from "../../../common/facades/FacadeChatSDK";
|
|
2
2
|
export declare const isPostChatSurveyEnabled: (facadeChatSDK: FacadeChatSDK) => Promise<boolean>;
|
|
3
|
+
export declare const getPostChatSurveyConfig: (facadeChatSDK: FacadeChatSDK) => Promise<any>;
|
|
3
4
|
export declare const isPersistentChatEnabled: (conversationMode: string | undefined) => boolean;
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Adds necessary tags if not present so that the rendering middlewares can process them later.
|
|
5
5
|
******/
|
|
6
6
|
import { IWebChatAction } from "../../../interfaces/IWebChatAction";
|
|
7
|
-
declare const channelDataMiddleware: ({ dispatch }: {
|
|
7
|
+
declare const channelDataMiddleware: (addConversationalSurveyTagsCallback: any) => ({ dispatch }: {
|
|
8
8
|
dispatch: any;
|
|
9
9
|
}) => (next: any) => (action: IWebChatAction) => any;
|
|
10
10
|
export default channelDataMiddleware;
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* The callback is then invoked to hide the send box (by default).
|
|
6
6
|
******/
|
|
7
7
|
import { IWebChatAction } from "../../../interfaces/IWebChatAction";
|
|
8
|
-
declare const createConversationEndMiddleware: (conversationEndCallback: any) => ({ dispatch }: {
|
|
8
|
+
declare const createConversationEndMiddleware: (conversationEndCallback: any, startConversationalSurveyCallback: any, endConversationalSurveyCallback: any) => ({ dispatch }: {
|
|
9
9
|
dispatch: any;
|
|
10
10
|
}) => (next: any) => (action: IWebChatAction) => any;
|
|
11
11
|
export default createConversationEndMiddleware;
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { IWebChatAction } from "../../../interfaces/IWebChatAction";
|
|
2
|
+
import { ILiveChatWidgetContext } from "../../../../../contexts/common/ILiveChatWidgetContext";
|
|
3
|
+
import { Dispatch } from "react";
|
|
4
|
+
import { ILiveChatWidgetAction } from "../../../../../contexts/common/ILiveChatWidgetAction";
|
|
5
|
+
export declare const createQueueOverflowMiddleware: (state: ILiveChatWidgetContext, dispatch: Dispatch<ILiveChatWidgetAction>) => () => (next: (action: IWebChatAction) => void) => (action: IWebChatAction) => void;
|
|
@@ -48,6 +48,8 @@ export interface ILiveChatWidgetContext {
|
|
|
48
48
|
chatDisconnectEventReceived: boolean;
|
|
49
49
|
selectedSurveyMode: string | null;
|
|
50
50
|
postChatParticipantType: undefined | ParticipantType;
|
|
51
|
+
isConversationalSurvey: boolean;
|
|
52
|
+
isConversationalSurveyEnabled: boolean;
|
|
51
53
|
};
|
|
52
54
|
uiStates: {
|
|
53
55
|
showConfirmationPane: boolean;
|
|
@@ -44,5 +44,7 @@ export declare enum LiveChatWidgetActionType {
|
|
|
44
44
|
SET_SURVEY_MODE = 42,
|
|
45
45
|
SET_CONFIRMATION_STATE = 43,
|
|
46
46
|
SET_POST_CHAT_PARTICIPANT_TYPE = 44,
|
|
47
|
-
|
|
47
|
+
SET_CONVERSATIONAL_SURVEY_ENABLED = 45,
|
|
48
|
+
SET_CONVERSATIONAL_SURVEY_DISPLAY = 46,
|
|
49
|
+
GET_IN_MEMORY_STATE = 47
|
|
48
50
|
}
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import { MessagePayload } from "./Constants";
|
|
2
2
|
export declare class FirstResponseLatencyTracker {
|
|
3
3
|
private isABotConversation;
|
|
4
|
-
private
|
|
5
|
-
private isEnded;
|
|
4
|
+
private isTracking;
|
|
6
5
|
private startTrackingMessage?;
|
|
7
6
|
private stopTrackingMessage?;
|
|
8
7
|
private isReady;
|
|
8
|
+
private trackingTimeoutId?;
|
|
9
9
|
constructor();
|
|
10
10
|
private createTrackingMessage;
|
|
11
11
|
private startTracking;
|
|
@@ -1,6 +1,23 @@
|
|
|
1
1
|
import { MessagePayload, ScenarioType, TrackingMessage } from "./Constants";
|
|
2
2
|
import { IActivity } from "botframework-directlinejs";
|
|
3
|
+
/**
|
|
4
|
+
* Determines whether a given activity is a historical message.
|
|
5
|
+
*
|
|
6
|
+
* This function checks if the activity is a message type and uses a combination
|
|
7
|
+
* of legacy tags and timestamp-based logic to determine if the message is historical.
|
|
8
|
+
*
|
|
9
|
+
* @param {IActivity} activity - The activity object to evaluate.
|
|
10
|
+
* @param {number} startTime - The start time (in milliseconds since epoch) to compare against.
|
|
11
|
+
* @returns {boolean} - Returns true if the activity is a historical message, false otherwise.
|
|
12
|
+
*
|
|
13
|
+
* Logic:
|
|
14
|
+
* - If the activity type is not a message, it is not historical.
|
|
15
|
+
* - If the activity contains a legacy history message tag, it is considered historical.
|
|
16
|
+
* - Otherwise, the function extracts a timestamp from the activity ID using `extractTimestampFromId`.
|
|
17
|
+
* - If the ID is valid and the timestamp is older than the start time, the message is historical.
|
|
18
|
+
*/
|
|
3
19
|
export declare const isHistoryMessage: (activity: IActivity, startTime: number) => boolean;
|
|
20
|
+
export declare const extractTimestampFromId: (activity: IActivity) => number;
|
|
4
21
|
export declare const buildMessagePayload: (activity: IActivity, userId: string) => MessagePayload;
|
|
5
22
|
export declare const polyfillMessagePayloadForEvent: (activity: IActivity, payload: MessagePayload, conversationId?: string) => MessagePayload;
|
|
6
23
|
export declare const getScenarioType: (activity: IActivity) => ScenarioType;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
import { IActivity } from "botframework-directlinejs";
|
|
2
|
-
export declare const createOnNewAdapterActivityHandler: (chatId: string, userId: string) => (activity: IActivity) => void;
|
|
2
|
+
export declare const createOnNewAdapterActivityHandler: (chatId: string, userId: string, startTime: number) => (activity: IActivity) => void;
|