@microsoft/omnichannel-chat-widget 2.0.1-main.84e2c02 → 2.0.1-main.a610fd8
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 +57 -0
- package/lib/cjs/common/telemetry/TelemetryConstants.js +6 -0
- package/lib/cjs/components/chatbuttonstateful/ChatButtonStateful.js +42 -25
- package/lib/cjs/components/livechatwidget/common/endChat.js +39 -0
- package/lib/cjs/components/livechatwidget/common/initWebChatComposer.js +33 -9
- package/lib/cjs/components/livechatwidget/common/reconnectChatHelper.js +29 -1
- package/lib/cjs/components/livechatwidget/common/startChat.js +118 -36
- package/lib/cjs/components/livechatwidget/common/updateSessionDataForTelemetry.js +34 -5
- package/lib/cjs/components/livechatwidget/livechatwidgetstateful/LiveChatWidgetStateful.js +5 -17
- package/lib/cjs/components/webchatcontainerstateful/common/defaultProps/defaultMiddlewareLocalizedTexts.js +2 -1
- package/lib/cjs/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/attachmentForScreenReaderMiddleware.js +159 -0
- package/lib/cjs/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/attachments/AdaptiveCardAccessibilityWrapper.js +16 -2
- package/lib/cjs/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/attachmentSentAnnouncementMiddleware.js +68 -40
- package/lib/cjs/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/attachmentUploadValidatorMiddleware.js +0 -27
- package/lib/esm/common/telemetry/TelemetryConstants.js +6 -0
- package/lib/esm/components/chatbuttonstateful/ChatButtonStateful.js +42 -25
- package/lib/esm/components/livechatwidget/common/endChat.js +39 -0
- package/lib/esm/components/livechatwidget/common/initWebChatComposer.js +31 -9
- package/lib/esm/components/livechatwidget/common/reconnectChatHelper.js +28 -1
- package/lib/esm/components/livechatwidget/common/startChat.js +115 -34
- package/lib/esm/components/livechatwidget/common/updateSessionDataForTelemetry.js +34 -5
- package/lib/esm/components/livechatwidget/livechatwidgetstateful/LiveChatWidgetStateful.js +6 -18
- package/lib/esm/components/webchatcontainerstateful/common/defaultProps/defaultMiddlewareLocalizedTexts.js +2 -1
- package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/attachmentForScreenReaderMiddleware.js +153 -0
- package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/attachments/AdaptiveCardAccessibilityWrapper.js +16 -2
- package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/attachmentSentAnnouncementMiddleware.js +65 -39
- package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/attachmentUploadValidatorMiddleware.js +0 -27
- package/lib/types/common/telemetry/TelemetryConstants.d.ts +3 -0
- package/lib/types/components/livechatwidget/common/initWebChatComposer.d.ts +8 -0
- package/lib/types/components/livechatwidget/common/reconnectChatHelper.d.ts +6 -1
- package/lib/types/components/livechatwidget/common/startChat.d.ts +5 -1
- package/lib/types/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/attachmentForScreenReaderMiddleware.d.ts +11 -0
- package/lib/types/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/attachmentSentAnnouncementMiddleware.d.ts +11 -4
- package/lib/types/contexts/common/ILiveChatWidgetLocalizedTexts.d.ts +9 -2
- package/package.json +5 -6
package/README.md
CHANGED
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
1. [Installation](#installation)
|
|
14
14
|
1. [WebChat dependency constraint](#webchat-dependency-constraint)
|
|
15
15
|
1. [Example Usage](#example-usage)
|
|
16
|
+
1. [Bot authentication and the sign-in card](#bot-authentication-and-the-sign-in-card)
|
|
16
17
|
1. [Components](#components)
|
|
17
18
|
1. [See Also](#see-also)
|
|
18
19
|
|
|
@@ -81,6 +82,8 @@ This hotfix still declares these vulnerable transitive versions:
|
|
|
81
82
|
| `swiper` | `8.4.7` |
|
|
82
83
|
| `valibot` | `1.1.0` |
|
|
83
84
|
| `uuid` | `3.4.0`, `8.3.2`, and `9.0.1` |
|
|
85
|
+
| `deepmerge` (via `sanitize-html@2.14.0`) | `4.3.1` |
|
|
86
|
+
| `minimatch` (via the Speech SDK's `rimraf@3` → `glob@7`) | `3.1.5` |
|
|
84
87
|
|
|
85
88
|
The consumer audit permits only the reviewed advisories from this hotfix. It rejects each new advisory.
|
|
86
89
|
|
|
@@ -142,6 +145,60 @@ A typescript sample widget can be found [here](https://github.com/microsoft/omni
|
|
|
142
145
|
|
|
143
146
|
```react-scripts``` has deprecated to build the sample project, please refer to vite building instructions: [BuildingUsingVite.md](https://github.com/microsoft/omnichannel-chat-widget/blob/main/docs/BuildingUsingVite.md)
|
|
144
147
|
|
|
148
|
+
## Bot authentication and the sign-in card
|
|
149
|
+
|
|
150
|
+
A bot that uses single sign-on (SSO) can send a sign-in (OAuth) card. The host page decides whether the widget shows the card. It passes a callback to the Omnichannel SDK method [`setBotAuthTokenProvider`](https://learn.microsoft.com/dynamics365/customer-service/develop/reference/methods/setbotauthtokenprovider), and the callback calls `callback({show: false})` for a customer who is already signed in.
|
|
151
|
+
|
|
152
|
+
When a sign-in card arrives, the widget asks the host for this result. It tries `fetchBotAuthConfigRetries` times (default `3`), `fetchBotAuthConfigRetryInterval` milliseconds apart (default `1000`), so it waits about 2 seconds by default. If the host doesn't answer in that time, `fallbackShowSignInCard` decides what happens:
|
|
153
|
+
|
|
154
|
+
| `fallbackShowSignInCard` | Card when the host doesn't answer in time | Telemetry |
|
|
155
|
+
| --- | --- | --- |
|
|
156
|
+
| Not set (default) | Shown | `SetBotAuthProviderNotFound` (with the error) |
|
|
157
|
+
| `false` | Hidden | `SetBotAuthProviderNotFound` (with the fallback value), then `SetBotAuthProviderHideCard` |
|
|
158
|
+
| `true` | Shown | `SetBotAuthProviderNotFound` (with the fallback value), then `SetBotAuthProviderDisplayCard` |
|
|
159
|
+
|
|
160
|
+
Which value to use:
|
|
161
|
+
|
|
162
|
+
| Your setup | `fallbackShowSignInCard` |
|
|
163
|
+
| --- | --- |
|
|
164
|
+
| Your page signs the customer in, and your `setBotAuthTokenProvider` callback passes the token to the bot (bot SSO) | `false` |
|
|
165
|
+
| You want the card to show whenever the callback is late, and you want this logged as a decision | `true` |
|
|
166
|
+
| Customers sign in through the sign-in card itself | Leave it unset |
|
|
167
|
+
|
|
168
|
+
```js
|
|
169
|
+
const liveChatWidgetProps = {
|
|
170
|
+
chatSDK: chatSDK, // mandatory
|
|
171
|
+
chatConfig: chatConfig, // mandatory
|
|
172
|
+
webChatContainerProps: {
|
|
173
|
+
botAuthConfig: {
|
|
174
|
+
fallbackShowSignInCard: false // hide the card if the host doesn't answer in time
|
|
175
|
+
}
|
|
176
|
+
}
|
|
177
|
+
};
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
If you use the live chat widget 2.0 script instead of this package, the function that the script's `data-customization-callback` attribute references must return a root props object that contains the setting, for example `{ webChatContainerProps: { botAuthConfig: { fallbackShowSignInCard: false } } }`. See [Develop a custom live chat widget](https://learn.microsoft.com/dynamics365/customer-service/develop/develop-live-chat-widget).
|
|
181
|
+
|
|
182
|
+
What the customer sees:
|
|
183
|
+
|
|
184
|
+
| Situation | Card |
|
|
185
|
+
| --- | --- |
|
|
186
|
+
| The host answers `callback({show: false})` in time | Hidden (`SetBotAuthProviderHideCard`) |
|
|
187
|
+
| The host answers `callback({show: true})` in time | Shown (`SetBotAuthProviderDisplayCard`) |
|
|
188
|
+
| The host doesn't answer in time (slow request, error, or no `callback(...)` call) | Depends on `fallbackShowSignInCard` (see the previous table) |
|
|
189
|
+
| The widget can't extract a sign-in ID from the card, or can't get a token exchange URL (from the card or from the Bot Framework token service) | Shown. The widget doesn't ask the host. |
|
|
190
|
+
|
|
191
|
+
`fallbackShowSignInCard` changes only what happens when the host doesn't answer in time. It isn't a substitute for a working `setBotAuthTokenProvider` callback. If you set it to `false` and the callback fails for a customer who isn't signed in, that customer doesn't see the card and can't sign in.
|
|
192
|
+
|
|
193
|
+
**Troubleshooting: a signed-in customer sometimes sees the sign-in card.** The `setBotAuthTokenProvider` callback probably didn't answer in time. Look for `SetBotAuthProviderNotFound` in the widget telemetry. To fix it:
|
|
194
|
+
|
|
195
|
+
1. Call `callback(...)` on every code path of the function, including error paths. If the function throws before it calls `callback(...)`, the widget gets no answer.
|
|
196
|
+
1. Make the whole function finish quickly. With the live chat widget 2.0 script, the widget gets the `callback(...)` value only after the function finishes, so slow work after `callback(...)` still delays the answer. For a sign-in card that your page already completed, call `callback({show: false})` and return at once. Otherwise, complete the token exchange, then call `callback(...)` with its result.
|
|
197
|
+
1. If the function is correct but can't finish in about 2 seconds, increase `fetchBotAuthConfigRetries` or `fetchBotAuthConfigRetryInterval`.
|
|
198
|
+
1. If your function passes a token to the bot for every customer before the chat needs it (bot SSO works), set `fallbackShowSignInCard: false`. Signing the customer in to your page, or using authenticated chat, doesn't by itself sign the customer in to the bot.
|
|
199
|
+
|
|
200
|
+
For the host-side callback, see [Pass authentication token to bot during single sign-on in live chat](https://learn.microsoft.com/dynamics365/customer-service/develop/pass-auth-token-sso-live-chat).
|
|
201
|
+
|
|
145
202
|
## Components
|
|
146
203
|
|
|
147
204
|
For a detailed guide on how to customize each component with sample usages, please see our new [Developer Guide](https://github.com/microsoft/omnichannel-chat-widget/blob/main/docs/customizations/getstarted.md).
|
|
@@ -114,6 +114,7 @@ let TelemetryEvent = exports.TelemetryEvent = /*#__PURE__*/function (TelemetryEv
|
|
|
114
114
|
TelemetryEvent["RecoveryEligibilityEvaluated"] = "RecoveryEligibilityEvaluated";
|
|
115
115
|
TelemetryEvent["GetConversationDetailsCallStarted"] = "GetConversationDetailsCallStarted";
|
|
116
116
|
TelemetryEvent["GetConversationDetailsCallFailed"] = "GetConversationDetailsCallFailed";
|
|
117
|
+
TelemetryEvent["UpdateTelemetryDataFailed"] = "UpdateTelemetryDataFailed";
|
|
117
118
|
TelemetryEvent["EndChatSDKCallFailed"] = "EndChatSDKCallFailed";
|
|
118
119
|
TelemetryEvent["DisconnectEndChatSDKCallFailed"] = "DisconnectEndChatSDKCallFailed";
|
|
119
120
|
TelemetryEvent["GetChatReconnectContextSDKCallStarted"] = "GetChatReconnectContextSDKCallStarted";
|
|
@@ -143,6 +144,8 @@ let TelemetryEvent = exports.TelemetryEvent = /*#__PURE__*/function (TelemetryEv
|
|
|
143
144
|
TelemetryEvent["PrechatSubmitted"] = "PrechatSubmitted";
|
|
144
145
|
TelemetryEvent["StartChatSDKCall"] = "StartChatCall";
|
|
145
146
|
TelemetryEvent["StartChatEventReceived"] = "StartChatEventReceived";
|
|
147
|
+
TelemetryEvent["ConcurrentStartChatRejected"] = "ConcurrentStartChatRejected";
|
|
148
|
+
TelemetryEvent["ChatSDKStateCleanUpDisconnectFailed"] = "ChatSDKStateCleanUpDisconnectFailed";
|
|
146
149
|
TelemetryEvent["EndChatSDKCall"] = "EndChatSDKCall";
|
|
147
150
|
TelemetryEvent["PrepareEndChat"] = "PrepareEndChat";
|
|
148
151
|
TelemetryEvent["EndChatEventReceived"] = "EndChatEventReceived";
|
|
@@ -415,6 +418,8 @@ let TelemetryConstants = exports.TelemetryConstants = /*#__PURE__*/function () {
|
|
|
415
418
|
case TelemetryEvent.SecureEventBusDispatchError:
|
|
416
419
|
case TelemetryEvent.AgentJoinedConversation:
|
|
417
420
|
case TelemetryEvent.BrowserTabHidden:
|
|
421
|
+
case TelemetryEvent.ConcurrentStartChatRejected:
|
|
422
|
+
case TelemetryEvent.ChatSDKStateCleanUpDisconnectFailed:
|
|
418
423
|
case TelemetryEvent.RecoveryEligibilityEvaluated:
|
|
419
424
|
return ScenarioType.ACTIONS;
|
|
420
425
|
case TelemetryEvent.StartChatSDKCall:
|
|
@@ -426,6 +431,7 @@ let TelemetryConstants = exports.TelemetryConstants = /*#__PURE__*/function () {
|
|
|
426
431
|
case TelemetryEvent.OnNewMessageFailed:
|
|
427
432
|
case TelemetryEvent.OnNewMessageAudioNotificationFailed:
|
|
428
433
|
case TelemetryEvent.GetConversationDetailsCallFailed:
|
|
434
|
+
case TelemetryEvent.UpdateTelemetryDataFailed:
|
|
429
435
|
case TelemetryEvent.EndChatSDKCall:
|
|
430
436
|
case TelemetryEvent.EndChatEventReceived:
|
|
431
437
|
case TelemetryEvent.EndChatSDKCallFailed:
|
|
@@ -58,37 +58,54 @@ const ChatButtonStateful = props => {
|
|
|
58
58
|
const ref = (0, _react.useRef)(() => {
|
|
59
59
|
return;
|
|
60
60
|
});
|
|
61
|
+
// Optimistic guard against rapid double-clicks. `conversationState` only flips to
|
|
62
|
+
// `Loading` after React re-renders, so the button stays visible and clickable for the
|
|
63
|
+
// whole duration of the first click's async work. Without this ref two concurrent
|
|
64
|
+
// startChat() calls can create two conversations on the backend.
|
|
65
|
+
const startChatInProgressRef = (0, _react.useRef)(false);
|
|
61
66
|
ref.current = async () => {
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
ConversationStage: _TelemetryConstants.ConversationStage.Initialization
|
|
67
|
-
}
|
|
68
|
-
});
|
|
69
|
-
if (state.appStates.isMinimized) {
|
|
70
|
-
dispatch({
|
|
71
|
-
type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_MINIMIZED,
|
|
72
|
-
payload: false
|
|
67
|
+
if (startChatInProgressRef.current) {
|
|
68
|
+
_TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.WARN, {
|
|
69
|
+
Event: _TelemetryConstants.TelemetryEvent.ConcurrentStartChatRejected,
|
|
70
|
+
Description: "Chat button click ignored, a start chat operation is already in progress."
|
|
73
71
|
});
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
72
|
+
return;
|
|
73
|
+
}
|
|
74
|
+
startChatInProgressRef.current = true;
|
|
75
|
+
try {
|
|
76
|
+
_TelemetryHelper.TelemetryHelper.logActionEventToAllTelemetry(_TelemetryConstants.LogLevel.INFO, {
|
|
77
|
+
Event: _TelemetryConstants.TelemetryEvent.LCWChatButtonClicked,
|
|
78
|
+
Description: "Chat button click action started",
|
|
79
|
+
CustomProperties: {
|
|
80
|
+
ConversationStage: _TelemetryConstants.ConversationStage.Initialization
|
|
81
|
+
}
|
|
77
82
|
});
|
|
78
|
-
|
|
79
|
-
|
|
83
|
+
if (state.appStates.isMinimized) {
|
|
84
|
+
dispatch({
|
|
85
|
+
type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_MINIMIZED,
|
|
86
|
+
payload: false
|
|
87
|
+
});
|
|
88
|
+
dispatch({
|
|
89
|
+
type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_UNREAD_MESSAGE_COUNT,
|
|
90
|
+
payload: 0
|
|
91
|
+
});
|
|
92
|
+
// If chat is minimized and then unminimized, start a chat if convesation state is closed.
|
|
93
|
+
if (state.appStates.conversationState === _ConversationState.ConversationState.Closed) {
|
|
94
|
+
await startChat();
|
|
95
|
+
}
|
|
96
|
+
} else {
|
|
80
97
|
await startChat();
|
|
81
98
|
}
|
|
82
|
-
|
|
83
|
-
|
|
99
|
+
_TelemetryHelper.TelemetryHelper.logActionEventToAllTelemetry(_TelemetryConstants.LogLevel.INFO, {
|
|
100
|
+
Event: _TelemetryConstants.TelemetryEvent.LCWChatButtonActionCompleted,
|
|
101
|
+
Description: "Chat button action completed",
|
|
102
|
+
CustomProperties: {
|
|
103
|
+
ConversationStage: _TelemetryConstants.ConversationStage.Initialization
|
|
104
|
+
}
|
|
105
|
+
});
|
|
106
|
+
} finally {
|
|
107
|
+
startChatInProgressRef.current = false;
|
|
84
108
|
}
|
|
85
|
-
_TelemetryHelper.TelemetryHelper.logActionEventToAllTelemetry(_TelemetryConstants.LogLevel.INFO, {
|
|
86
|
-
Event: _TelemetryConstants.TelemetryEvent.LCWChatButtonActionCompleted,
|
|
87
|
-
Description: "Chat button action completed",
|
|
88
|
-
CustomProperties: {
|
|
89
|
-
ConversationStage: _TelemetryConstants.ConversationStage.Initialization
|
|
90
|
-
}
|
|
91
|
-
});
|
|
92
109
|
};
|
|
93
110
|
const outOfOfficeStyleProps = Object.assign({}, _defaultOutOfOfficeChatButtonStyleProps.defaultOutOfOfficeChatButtonStyleProps, outOfOfficeButtonProps === null || outOfOfficeButtonProps === void 0 ? void 0 : outOfOfficeButtonProps.styleProps);
|
|
94
111
|
const controlProps = {
|
|
@@ -360,13 +360,52 @@ const closeChatStateCleanUp = dispatch => {
|
|
|
360
360
|
|
|
361
361
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
362
362
|
exports.closeChatStateCleanUp = closeChatStateCleanUp;
|
|
363
|
+
const logCleanUpDisconnectFailure = error => {
|
|
364
|
+
_TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.WARN, {
|
|
365
|
+
Event: _TelemetryConstants.TelemetryEvent.ChatSDKStateCleanUpDisconnectFailed,
|
|
366
|
+
Description: "Failed to disconnect the previous conversation during chat SDK state clean up.",
|
|
367
|
+
ExceptionDetails: {
|
|
368
|
+
exception: (error === null || error === void 0 ? void 0 : error.message) ?? error
|
|
369
|
+
}
|
|
370
|
+
});
|
|
371
|
+
};
|
|
372
|
+
|
|
373
|
+
// Releases the previous session's conversation. Mirrors the cleanup OmnichannelChatSDK.endChat()
|
|
374
|
+
// runs in its finally block (disconnect, then drop the reference). Without it, a conversation
|
|
375
|
+
// left over from a failed or orphaned start chat, or from a chat ended in another tab (which
|
|
376
|
+
// skips the SDK endChat), keeps its messaging session open and leaks into the next chat.
|
|
377
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
378
|
+
const disconnectConversation = chatSDK => {
|
|
379
|
+
const conversation = chatSDK.conversation;
|
|
380
|
+
if (!conversation || typeof conversation.disconnect !== "function") {
|
|
381
|
+
return;
|
|
382
|
+
}
|
|
383
|
+
try {
|
|
384
|
+
// ACS conversations disconnect asynchronously; legacy IC3 conversations may not return a promise.
|
|
385
|
+
const result = conversation.disconnect();
|
|
386
|
+
if (result && typeof result.catch === "function") {
|
|
387
|
+
result.catch(logCleanUpDisconnectFailure);
|
|
388
|
+
}
|
|
389
|
+
} catch (error) {
|
|
390
|
+
logCleanUpDisconnectFailure(error);
|
|
391
|
+
}
|
|
392
|
+
};
|
|
393
|
+
|
|
394
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
363
395
|
const chatSDKStateCleanUp = chatSDK => {
|
|
396
|
+
if (!chatSDK) {
|
|
397
|
+
return;
|
|
398
|
+
}
|
|
399
|
+
|
|
364
400
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
365
401
|
chatSDK.requestId = (0, _omnichannelChatSdk.uuidv4)();
|
|
366
402
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
367
403
|
chatSDK.chatToken = {};
|
|
368
404
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
369
405
|
chatSDK.reconnectId = null;
|
|
406
|
+
disconnectConversation(chatSDK);
|
|
407
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
408
|
+
chatSDK.conversation = null;
|
|
370
409
|
};
|
|
371
410
|
|
|
372
411
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
Object.defineProperty(exports, "__esModule", {
|
|
4
4
|
value: true
|
|
5
5
|
});
|
|
6
|
-
exports.initWebChatComposer = void 0;
|
|
6
|
+
exports.initWebChatComposer = exports.createScreenReaderMarkdownRenderer = void 0;
|
|
7
7
|
var _Constants = require("../../../common/Constants");
|
|
8
8
|
var _TelemetryConstants = require("../../../common/telemetry/TelemetryConstants");
|
|
9
9
|
var _utils = require("../../../common/utils");
|
|
@@ -20,6 +20,7 @@ var _attachmentSentAnnouncementMiddleware = _interopRequireDefault(require("../.
|
|
|
20
20
|
var _channelDataMiddleware = _interopRequireDefault(require("../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/channelDataMiddleware"));
|
|
21
21
|
var _activityMiddleware = require("../../webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/activityMiddleware");
|
|
22
22
|
var _activityStatusMiddleware = require("../../webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/activityStatusMiddleware");
|
|
23
|
+
var _attachmentForScreenReaderMiddleware = require("../../webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/attachmentForScreenReaderMiddleware");
|
|
23
24
|
var _attachmentMiddleware = require("../../webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/attachmentMiddleware");
|
|
24
25
|
var _attachmentUploadValidatorMiddleware = _interopRequireDefault(require("../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/attachmentUploadValidatorMiddleware"));
|
|
25
26
|
var _avatarMiddleware = require("../../webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/avatarMiddleware");
|
|
@@ -48,7 +49,34 @@ var _htmlTextMiddleware = _interopRequireDefault(require("../../webchatcontainer
|
|
|
48
49
|
var _preProcessingMiddleware = _interopRequireDefault(require("../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/preProcessingMiddleware"));
|
|
49
50
|
var _sanitizationMiddleware = _interopRequireDefault(require("../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/sanitizationMiddleware"));
|
|
50
51
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
|
|
52
|
+
const markdownSanitizeConfig = {
|
|
53
|
+
FORBID_TAGS: ["form", "button", "script", "div", "input"],
|
|
54
|
+
FORBID_ATTR: ["action"],
|
|
55
|
+
ADD_ATTR: ["target"]
|
|
56
|
+
};
|
|
57
|
+
|
|
58
|
+
/**
|
|
59
|
+
* Renders Markdown for the screen reader text of Adaptive Cards, from the same pieces as the visible card:
|
|
60
|
+
* the host renderMarkdown when set, the hyperlink text override, and the same sanitization.
|
|
61
|
+
* Markdown is always formatted, also when the widget shows Markdown unformatted, so that screen readers do not read the syntax.
|
|
62
|
+
* Styles are removed with their content because the card does not show them.
|
|
63
|
+
*/
|
|
64
|
+
const createScreenReaderMarkdownRenderer = webChatContainerProps => {
|
|
65
|
+
var _webChatContainerProp;
|
|
66
|
+
const hostRenderMarkdown = webChatContainerProps === null || webChatContainerProps === void 0 || (_webChatContainerProp = webChatContainerProps.webChatProps) === null || _webChatContainerProp === void 0 ? void 0 : _webChatContainerProp.renderMarkdown;
|
|
67
|
+
const markdown = (0, _createMarkdown.createMarkdown)(false, (webChatContainerProps === null || webChatContainerProps === void 0 ? void 0 : webChatContainerProps.disableNewLineMarkdownSupport) ?? _defaultWebChatContainerStatefulProps.defaultWebChatContainerStatefulProps.disableNewLineMarkdownSupport, webChatContainerProps === null || webChatContainerProps === void 0 ? void 0 : webChatContainerProps.opensMarkdownLinksInSameTab);
|
|
68
|
+
const hyperlinkTextOverrideRenderer = new _HyperlinkTextOverrideRenderer.default((webChatContainerProps === null || webChatContainerProps === void 0 ? void 0 : webChatContainerProps.hyperlinkTextOverride) ?? _defaultWebChatContainerStatefulProps.defaultWebChatContainerStatefulProps.hyperlinkTextOverride);
|
|
69
|
+
return text => {
|
|
70
|
+
const html = hostRenderMarkdown ? hostRenderMarkdown(text) : markdown.render(text);
|
|
71
|
+
return _dompurify.default.sanitize(hyperlinkTextOverrideRenderer.render(html), {
|
|
72
|
+
...markdownSanitizeConfig,
|
|
73
|
+
FORBID_TAGS: [...markdownSanitizeConfig.FORBID_TAGS, "style"]
|
|
74
|
+
});
|
|
75
|
+
};
|
|
76
|
+
};
|
|
77
|
+
|
|
51
78
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
79
|
+
exports.createScreenReaderMarkdownRenderer = createScreenReaderMarkdownRenderer;
|
|
52
80
|
const initWebChatComposer = (props, state, dispatch, facadeChatSDK, endChat) => {
|
|
53
81
|
var _props$webChatContain, _props$webChatContain2, _props$webChatContain3, _props$webChatContain4, _props$webChatContain5, _props$webChatContain6, _state$domainStates$l4, _props$webChatContain0, _state$domainStates$r, _state$domainStates$r2, _props$webChatContain1, _state$domainStates$r3, _props$webChatContain10, _state$domainStates$l5, _props$webChatContain11, _props$webChatContain12, _state$domainStates$r4, _state$domainStates$r5, _props$webChatContain13, _defaultWebChatContai, _props$webChatContain14, _defaultWebChatContai2, _props$webChatContain15, _props$webChatContain16, _props$webChatContain17;
|
|
54
82
|
// Add a hook to make all links open a new window
|
|
@@ -67,7 +95,7 @@ const initWebChatComposer = (props, state, dispatch, facadeChatSDK, endChat) =>
|
|
|
67
95
|
// Initialize Web Chat's redux store
|
|
68
96
|
let webChatStore = _WebChatStoreLoader.WebChatStoreLoader.store;
|
|
69
97
|
if (!webChatStore) {
|
|
70
|
-
var _state$domainStates$l, _state$domainStates$l2, _state$domainStates$l3, _props$webChatContain7;
|
|
98
|
+
var _state$domainStates$l, _state$domainStates$l2, _props$controlProps, _state$domainStates$l3, _props$webChatContain7;
|
|
71
99
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
72
100
|
const addConversationalSurveyTagsCallback = action => {
|
|
73
101
|
var _inMemoryState$appSta;
|
|
@@ -126,7 +154,7 @@ const initWebChatComposer = (props, state, dispatch, facadeChatSDK, endChat) =>
|
|
|
126
154
|
};
|
|
127
155
|
webChatStore = (0, _botframeworkWebchat.createStore)({},
|
|
128
156
|
//initial state
|
|
129
|
-
_preProcessingMiddleware.default, _attachmentProcessingMiddleware.default, (0, _attachmentUploadValidatorMiddleware.default)((_state$domainStates$l = state.domainStates.liveChatConfig) === null || _state$domainStates$l === void 0 ? void 0 : _state$domainStates$l.allowedFileExtensions, (_state$domainStates$l2 = state.domainStates.liveChatConfig) === null || _state$domainStates$l2 === void 0 ? void 0 : _state$domainStates$l2.maxUploadFileSize, localizedTexts), _attachmentSentAnnouncementMiddleware.default, (0, _customEventMiddleware.default)(_omnichannelChatComponents.BroadcastService), (0, _queueOverflowHandlerMiddleware.createQueueOverflowMiddleware)(state, dispatch), (0, _channelDataMiddleware.default)(addConversationalSurveyTagsCallback), (0, _conversationEndMiddleware.default)(conversationEndCallback, startConversationalSurveyCallback, endConversationalSurveyCallback), (0, _dataMaskingMiddleware.default)((_state$domainStates$l3 = state.domainStates.liveChatConfig) === null || _state$domainStates$l3 === void 0 ? void 0 : _state$domainStates$l3.DataMaskingInfo), _messageTimestampMiddleware.createMessageTimeStampMiddleware, _messageSequenceIdOverrideMiddleware.createMessageSequenceIdOverrideMiddleware, (0, _citationsMiddleware.createCitationsMiddleware)(state, dispatch), _gifUploadMiddleware.default, _htmlPlayerMiddleware.default, (0, _htmlTextMiddleware.default)(honorsTargetInHTMLLinks), (0, _maxMessageSizeValidator.default)(localizedTexts), _sanitizationMiddleware.default, (0, _callActionMiddleware.default)(),
|
|
157
|
+
_preProcessingMiddleware.default, _attachmentProcessingMiddleware.default, (0, _attachmentUploadValidatorMiddleware.default)((_state$domainStates$l = state.domainStates.liveChatConfig) === null || _state$domainStates$l === void 0 ? void 0 : _state$domainStates$l.allowedFileExtensions, (_state$domainStates$l2 = state.domainStates.liveChatConfig) === null || _state$domainStates$l2 === void 0 ? void 0 : _state$domainStates$l2.maxUploadFileSize, localizedTexts), (0, _attachmentSentAnnouncementMiddleware.default)(localizedTexts, ((_props$controlProps = props.controlProps) === null || _props$controlProps === void 0 ? void 0 : _props$controlProps.id) || "oc-lcw"), (0, _customEventMiddleware.default)(_omnichannelChatComponents.BroadcastService), (0, _queueOverflowHandlerMiddleware.createQueueOverflowMiddleware)(state, dispatch), (0, _channelDataMiddleware.default)(addConversationalSurveyTagsCallback), (0, _conversationEndMiddleware.default)(conversationEndCallback, startConversationalSurveyCallback, endConversationalSurveyCallback), (0, _dataMaskingMiddleware.default)((_state$domainStates$l3 = state.domainStates.liveChatConfig) === null || _state$domainStates$l3 === void 0 ? void 0 : _state$domainStates$l3.DataMaskingInfo), _messageTimestampMiddleware.createMessageTimeStampMiddleware, _messageSequenceIdOverrideMiddleware.createMessageSequenceIdOverrideMiddleware, (0, _citationsMiddleware.createCitationsMiddleware)(state, dispatch), _gifUploadMiddleware.default, _htmlPlayerMiddleware.default, (0, _htmlTextMiddleware.default)(honorsTargetInHTMLLinks), (0, _maxMessageSizeValidator.default)(localizedTexts), _sanitizationMiddleware.default, (0, _callActionMiddleware.default)(),
|
|
130
158
|
// Pass a callback so middleware can push initials into React context for reactivity
|
|
131
159
|
(0, _localizedStringsBotInitialsMiddleware.localizedStringsBotInitialsMiddleware)(initials => {
|
|
132
160
|
dispatch({
|
|
@@ -154,12 +182,7 @@ const initWebChatComposer = (props, state, dispatch, facadeChatSDK, endChat) =>
|
|
|
154
182
|
});
|
|
155
183
|
|
|
156
184
|
// EXISTING sanitization (continues to work as before)
|
|
157
|
-
|
|
158
|
-
FORBID_TAGS: ["form", "button", "script", "div", "input"],
|
|
159
|
-
FORBID_ATTR: ["action"],
|
|
160
|
-
ADD_ATTR: ["target"]
|
|
161
|
-
};
|
|
162
|
-
text = _dompurify.default.sanitize(text, config);
|
|
185
|
+
text = _dompurify.default.sanitize(text, markdownSanitizeConfig);
|
|
163
186
|
|
|
164
187
|
// MONITOR-ONLY: Test what the stricter allowlist would remove (Phase 1)
|
|
165
188
|
// This does NOT modify the text, only logs telemetry
|
|
@@ -363,6 +386,7 @@ const initWebChatComposer = (props, state, dispatch, facadeChatSDK, endChat) =>
|
|
|
363
386
|
store: webChatStore,
|
|
364
387
|
activityMiddleware: (_props$webChatContain0 = props.webChatContainerProps) !== null && _props$webChatContain0 !== void 0 && (_props$webChatContain0 = _props$webChatContain0.renderingMiddlewareProps) !== null && _props$webChatContain0 !== void 0 && _props$webChatContain0.disableActivityMiddleware ? undefined : (0, _activityMiddleware.createActivityMiddleware)(renderMarkdown, (_state$domainStates$r = state.domainStates.renderingMiddlewareProps) === null || _state$domainStates$r === void 0 ? void 0 : _state$domainStates$r.systemMessageStyleProps, (_state$domainStates$r2 = state.domainStates.renderingMiddlewareProps) === null || _state$domainStates$r2 === void 0 ? void 0 : _state$domainStates$r2.userMessageStyleProps, localizedTexts),
|
|
365
388
|
attachmentMiddleware: (_props$webChatContain1 = props.webChatContainerProps) !== null && _props$webChatContain1 !== void 0 && (_props$webChatContain1 = _props$webChatContain1.renderingMiddlewareProps) !== null && _props$webChatContain1 !== void 0 && _props$webChatContain1.disableAttachmentMiddleware ? undefined : (0, _attachmentMiddleware.createAttachmentMiddleware)(((_state$domainStates$r3 = state.domainStates.renderingMiddlewareProps) === null || _state$domainStates$r3 === void 0 || (_state$domainStates$r3 = _state$domainStates$r3.attachmentProps) === null || _state$domainStates$r3 === void 0 ? void 0 : _state$domainStates$r3.enableInlinePlaying) ?? _defaultAttachmentProps.defaultAttachmentProps.enableInlinePlaying),
|
|
389
|
+
attachmentForScreenReaderMiddleware: (0, _attachmentForScreenReaderMiddleware.createAttachmentForScreenReaderMiddleware)(createScreenReaderMarkdownRenderer(props.webChatContainerProps)),
|
|
366
390
|
activityStatusMiddleware: (_props$webChatContain10 = props.webChatContainerProps) !== null && _props$webChatContain10 !== void 0 && (_props$webChatContain10 = _props$webChatContain10.renderingMiddlewareProps) !== null && _props$webChatContain10 !== void 0 && _props$webChatContain10.disableActivityStatusMiddleware ? undefined : (0, _activityStatusMiddleware.createActivityStatusMiddleware)((0, _omnichannelChatSdk.getLocaleStringFromId)((_state$domainStates$l5 = state.domainStates.liveChatConfig) === null || _state$domainStates$l5 === void 0 || (_state$domainStates$l5 = _state$domainStates$l5.ChatWidgetLanguage) === null || _state$domainStates$l5 === void 0 ? void 0 : _state$domainStates$l5.msdyn_localeid)),
|
|
367
391
|
toastMiddleware: (_props$webChatContain11 = props.webChatContainerProps) !== null && _props$webChatContain11 !== void 0 && (_props$webChatContain11 = _props$webChatContain11.renderingMiddlewareProps) !== null && _props$webChatContain11 !== void 0 && _props$webChatContain11.disableToastMiddleware ? undefined : (0, _toastMiddleware.createToastMiddleware)(props.notificationPaneProps, endChat),
|
|
368
392
|
renderMarkdown,
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
Object.defineProperty(exports, "__esModule", {
|
|
4
4
|
value: true
|
|
5
5
|
});
|
|
6
|
-
exports.isReconnectEnabled = exports.isPersistentEnabled = exports.handleChatReconnect = exports.getChatReconnectContext = void 0;
|
|
6
|
+
exports.isReconnectTriggered = exports.isReconnectEnabled = exports.isPersistentEnabled = exports.handleChatReconnect = exports.getChatReconnectContext = void 0;
|
|
7
7
|
require("regenerator-runtime/runtime");
|
|
8
8
|
var _TelemetryConstants = require("../../../common/telemetry/TelemetryConstants");
|
|
9
9
|
var _Constants = require("../../../common/Constants");
|
|
@@ -13,6 +13,7 @@ var _omnichannelChatComponents = require("@microsoft/omnichannel-chat-components
|
|
|
13
13
|
var _ConversationState = require("../../../contexts/common/ConversationState");
|
|
14
14
|
var _LiveChatWidgetActionType = require("../../../contexts/common/LiveChatWidgetActionType");
|
|
15
15
|
var _TelemetryHelper = require("../../../common/telemetry/TelemetryHelper");
|
|
16
|
+
var _createReducer = require("../../../contexts/createReducer");
|
|
16
17
|
var _startChatErrorHandler = require("./startChatErrorHandler");
|
|
17
18
|
// Return value: should start normal chat flow when reconnect is enabled
|
|
18
19
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
@@ -55,8 +56,35 @@ const handleChatReconnect = async (facadeChatSDK, props, dispatch, setAdapter, i
|
|
|
55
56
|
return true;
|
|
56
57
|
};
|
|
57
58
|
|
|
59
|
+
/**
|
|
60
|
+
* Returns true when chat reconnect took over the start: it started the chat itself or showed the reconnect pane.
|
|
61
|
+
* In that case the caller must not start another chat.
|
|
62
|
+
*/
|
|
58
63
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
59
64
|
exports.handleChatReconnect = handleChatReconnect;
|
|
65
|
+
const isReconnectTriggered = async (facadeChatSDK, props, dispatch, setAdapter, initStartChat, state) => {
|
|
66
|
+
if (isReconnectEnabled(props.chatConfig) === true && !isPersistentEnabled(props.chatConfig)) {
|
|
67
|
+
let reconnectChatStarted = false;
|
|
68
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
69
|
+
const initStartChatAndTrack = async function () {
|
|
70
|
+
reconnectChatStarted = await initStartChat(...arguments);
|
|
71
|
+
};
|
|
72
|
+
const noValidReconnectId = await handleChatReconnect(facadeChatSDK, props, dispatch, setAdapter, initStartChatAndTrack, state);
|
|
73
|
+
// initStartChat resolves before React renders Active, so the in-memory state can still read Loading here.
|
|
74
|
+
// Its result tells whether reconnect started the chat; the in-memory state covers the reconnect pane.
|
|
75
|
+
const inMemoryState = (0, _createReducer.executeReducer)(state, {
|
|
76
|
+
type: _LiveChatWidgetActionType.LiveChatWidgetActionType.GET_IN_MEMORY_STATE,
|
|
77
|
+
payload: null
|
|
78
|
+
});
|
|
79
|
+
if (!noValidReconnectId && (reconnectChatStarted || inMemoryState.appStates.conversationState === _ConversationState.ConversationState.Active || inMemoryState.appStates.conversationState === _ConversationState.ConversationState.ReconnectChat)) {
|
|
80
|
+
return true;
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
return false;
|
|
84
|
+
};
|
|
85
|
+
|
|
86
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
87
|
+
exports.isReconnectTriggered = isReconnectTriggered;
|
|
60
88
|
const getChatReconnectContext = async (facadeChatSDK, chatConfig, props, isAuthenticatedChat, dispatch) => {
|
|
61
89
|
try {
|
|
62
90
|
var _props$reconnectChatP4;
|
|
@@ -24,18 +24,87 @@ var _authHelper = require("./authHelper");
|
|
|
24
24
|
var _setPostChatContextAndLoadSurvey = require("./setPostChatContextAndLoadSurvey");
|
|
25
25
|
var _persistentChatHelper = require("./persistentChatHelper");
|
|
26
26
|
var _updateSessionDataForTelemetry = require("./updateSessionDataForTelemetry");
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
27
|
+
/**
|
|
28
|
+
* Per widget instance mutexes for the two chat creation entry points.
|
|
29
|
+
*
|
|
30
|
+
* Every guard in the prepareStartChat -> setPreChatAndInitiateChat -> initStartChat chain
|
|
31
|
+
* checks `conversationState === Closed`, but React state is updated asynchronously. A second
|
|
32
|
+
* invocation fired within the same render cycle (for example a rapid double click on the chat
|
|
33
|
+
* button, or a chat button click racing a BroadcastEvent.StartChat) therefore still observes
|
|
34
|
+
* the stale `Closed` state, reaches `facadeChatSDK.startChat()` and creates a second
|
|
35
|
+
* conversation on the backend which is then orphaned and never ended.
|
|
36
|
+
*
|
|
37
|
+
* The locks are keyed by FacadeChatSDK instance rather than being module wide, because a host
|
|
38
|
+
* page can mount several independent widgets, each with its own widgetInstanceId and its own
|
|
39
|
+
* FacadeChatSDK (created once per widget in LiveChatWidget.tsx). A module wide lock would make
|
|
40
|
+
* widget A's start chat silently drop widget B's legitimate simultaneous start chat.
|
|
41
|
+
*
|
|
42
|
+
* The two maps are separate because prepareStartChat calls initStartChat; sharing a single lock
|
|
43
|
+
* would make the nested call see its own parent as in flight and drop it. prepareStartChat is
|
|
44
|
+
* additionally blocked by an in flight initStartChat (pre-chat submit, reconnect, or the
|
|
45
|
+
* hideStartChatButton bootstrap call initStartChat directly). Otherwise a later prepareStartChat
|
|
46
|
+
* would dispatch Loading and maximize the widget, and only then have its nested initStartChat
|
|
47
|
+
* dropped.
|
|
48
|
+
*/
|
|
49
|
+
const prepareStartChatGuards = new WeakMap();
|
|
50
|
+
const initStartChatGuards = new WeakMap();
|
|
51
|
+
|
|
52
|
+
// Fallback owner used only when no FacadeChatSDK instance is available to key on, so the guard
|
|
53
|
+
// degrades to the module wide behaviour instead of disappearing altogether.
|
|
54
|
+
const unkeyedGuardOwner = {};
|
|
55
|
+
const getGuard = (guards, facadeChatSDK) => {
|
|
56
|
+
const owner = facadeChatSDK ?? unkeyedGuardOwner;
|
|
57
|
+
let guard = guards.get(owner);
|
|
58
|
+
if (!guard) {
|
|
59
|
+
guard = {
|
|
60
|
+
inFlight: false
|
|
61
|
+
};
|
|
62
|
+
guards.set(owner, guard);
|
|
63
|
+
}
|
|
64
|
+
return guard;
|
|
65
|
+
};
|
|
66
|
+
|
|
67
|
+
/**
|
|
68
|
+
* Runs `operation` only if no other invocation for the same widget instance is already in
|
|
69
|
+
* flight. Concurrent invocations are dropped (and reported through telemetry) rather than
|
|
70
|
+
* awaiting the in-flight promise, so a future re-entrant call can never deadlock on itself.
|
|
71
|
+
* A dropped invocation resolves to `undefined`.
|
|
72
|
+
*
|
|
73
|
+
* `blockedBy` lets an operation also yield to a different, already running operation for the
|
|
74
|
+
* same widget instance without claiming that operation's lock.
|
|
75
|
+
*/
|
|
76
|
+
const runExclusively = async (guards, facadeChatSDK, description, operation, props, blockedBy) => {
|
|
77
|
+
const guard = getGuard(guards, facadeChatSDK);
|
|
78
|
+
const blockingGuard = blockedBy ? getGuard(blockedBy, facadeChatSDK) : undefined;
|
|
79
|
+
if (guard.inFlight || blockingGuard !== null && blockingGuard !== void 0 && blockingGuard.inFlight) {
|
|
80
|
+
_TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.WARN, {
|
|
81
|
+
Event: _TelemetryConstants.TelemetryEvent.ConcurrentStartChatRejected,
|
|
82
|
+
Description: description,
|
|
83
|
+
CustomProperties: {
|
|
84
|
+
WidgetCacheId: props ? (0, _utils.getWidgetCacheIdfromProps)(props) : undefined
|
|
85
|
+
}
|
|
86
|
+
});
|
|
87
|
+
return undefined;
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
// Claim the lock before invoking the operation, so a re-entrant call made from the
|
|
91
|
+
// operation's synchronous preamble (before its first await) cannot slip past the check above.
|
|
92
|
+
guard.inFlight = true;
|
|
93
|
+
try {
|
|
94
|
+
return await operation();
|
|
95
|
+
} finally {
|
|
96
|
+
guard.inFlight = false;
|
|
97
|
+
}
|
|
98
|
+
};
|
|
33
99
|
|
|
34
100
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
35
101
|
const prepareStartChat = async (props, facadeChatSDK, state, dispatch, setAdapter) => {
|
|
36
|
-
|
|
37
|
-
|
|
102
|
+
return runExclusively(prepareStartChatGuards, facadeChatSDK, "Concurrent prepareStartChat call ignored, a start chat operation is already in progress for this widget instance.", () => prepareStartChatInternal(props, facadeChatSDK, state, dispatch, setAdapter), props, initStartChatGuards);
|
|
103
|
+
};
|
|
38
104
|
|
|
105
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
106
|
+
exports.prepareStartChat = prepareStartChat;
|
|
107
|
+
const prepareStartChatInternal = async (props, facadeChatSDK, state, dispatch, setAdapter) => {
|
|
39
108
|
// reconnect > chat from cache
|
|
40
109
|
if ((0, _reconnectChatHelper.isReconnectEnabled)(props.chatConfig) === true && !(0, _reconnectChatHelper.isPersistentEnabled)(props.chatConfig)) {
|
|
41
110
|
const shouldStartChatNormally = await (0, _reconnectChatHelper.handleChatReconnect)(facadeChatSDK, props, dispatch, setAdapter, initStartChat, state);
|
|
@@ -63,7 +132,6 @@ const prepareStartChat = async (props, facadeChatSDK, state, dispatch, setAdapte
|
|
|
63
132
|
};
|
|
64
133
|
|
|
65
134
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
66
|
-
exports.prepareStartChat = prepareStartChat;
|
|
67
135
|
const setPreChatAndInitiateChat = async (facadeChatSDK, dispatch, setAdapter, isProactiveChat, proactiveChatEnablePrechatState, state, props) => {
|
|
68
136
|
var _props$preChatSurveyP, _props$controlProps, _state$domainStates, _state$appStates2;
|
|
69
137
|
// Reset before loading prechat to avoid starting chat with previous requestId
|
|
@@ -160,9 +228,20 @@ const setPreChatAndInitiateChat = async (facadeChatSDK, dispatch, setAdapter, is
|
|
|
160
228
|
await initStartChat(facadeChatSDK, dispatch, setAdapter, state, props, optionalParams);
|
|
161
229
|
};
|
|
162
230
|
|
|
231
|
+
/**
|
|
232
|
+
* Resolves to `true` when the chat reached Active, and `false` when it failed or the call was dropped.
|
|
233
|
+
* It resolves before React renders Active, so callers must use this value rather than reading the conversation state.
|
|
234
|
+
*/
|
|
163
235
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
164
236
|
exports.setPreChatAndInitiateChat = setPreChatAndInitiateChat;
|
|
165
237
|
const initStartChat = async (facadeChatSDK, dispatch, setAdapter, state, props, params, persistedState) => {
|
|
238
|
+
const chatStarted = await runExclusively(initStartChatGuards, facadeChatSDK, "Concurrent initStartChat call ignored, a start chat operation is already in progress for this widget instance.", () => initStartChatInternal(facadeChatSDK, dispatch, setAdapter, state, props, params, persistedState), props);
|
|
239
|
+
return chatStarted === true;
|
|
240
|
+
};
|
|
241
|
+
|
|
242
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
243
|
+
exports.initStartChat = initStartChat;
|
|
244
|
+
const initStartChatInternal = async (facadeChatSDK, dispatch, setAdapter, state, props, params, persistedState) => {
|
|
166
245
|
var _state$domainStates7;
|
|
167
246
|
let isStartChatSuccessful = false;
|
|
168
247
|
const persistentChatEnabled = (0, _liveChatConfigUtils.isPersistentChatEnabled)(state === null || state === void 0 || (_state$domainStates7 = state.domainStates) === null || _state$domainStates7 === void 0 || (_state$domainStates7 = _state$domainStates7.liveChatConfig) === null || _state$domainStates7 === void 0 || (_state$domainStates7 = _state$domainStates7.LiveWSAndLiveChatEngJoin) === null || _state$domainStates7 === void 0 ? void 0 : _state$domainStates7.msdyn_conversationmode);
|
|
@@ -201,14 +280,15 @@ const initStartChat = async (facadeChatSDK, dispatch, setAdapter, state, props,
|
|
|
201
280
|
}
|
|
202
281
|
try {
|
|
203
282
|
var _window$Microsoft, _state$domainStates8;
|
|
204
|
-
// Set custom context params
|
|
205
|
-
|
|
283
|
+
// Set custom context params. Returned (not stored module-side) so that concurrent
|
|
284
|
+
// widget instances cannot overwrite each other's custom context.
|
|
285
|
+
const customContextParams = await setCustomContextParams(state, props);
|
|
206
286
|
const defaultOptionalParams = {
|
|
207
287
|
sendDefaultInitContext: true,
|
|
208
288
|
isProactiveChat: !!(params !== null && params !== void 0 && params.isProactiveChat),
|
|
209
289
|
portalContactId: (_window$Microsoft = window.Microsoft) === null || _window$Microsoft === void 0 || (_window$Microsoft = _window$Microsoft.Dynamic365) === null || _window$Microsoft === void 0 || (_window$Microsoft = _window$Microsoft.Portal) === null || _window$Microsoft === void 0 || (_window$Microsoft = _window$Microsoft.User) === null || _window$Microsoft === void 0 ? void 0 : _window$Microsoft.contactId
|
|
210
290
|
};
|
|
211
|
-
const startChatOptionalParams = Object.assign({}, params,
|
|
291
|
+
const startChatOptionalParams = Object.assign({}, params, customContextParams, defaultOptionalParams);
|
|
212
292
|
|
|
213
293
|
// MID-AUTH: Add wasAuthenticated flag for reconnect scenarios
|
|
214
294
|
// Tells FacadeChatSDK whether the previous session was authenticated
|
|
@@ -271,7 +351,7 @@ const initStartChat = async (facadeChatSDK, dispatch, setAdapter, state, props,
|
|
|
271
351
|
(0, _startChatErrorHandler.logWidgetLoadComplete)(_Constants.WidgetLoadTelemetryMessage.PersistedStateRetrievedMessage);
|
|
272
352
|
// Set post chat context in state, load in background to do not block the load
|
|
273
353
|
(0, _setPostChatContextAndLoadSurvey.setPostChatContextAndLoadSurvey)(facadeChatSDK, dispatch, true);
|
|
274
|
-
return;
|
|
354
|
+
return true;
|
|
275
355
|
}
|
|
276
356
|
|
|
277
357
|
// Persistent Chat relies on the `reconnectId` retrieved from reconnectablechats API to reconnect upon start chat and not `liveChatContext`
|
|
@@ -287,18 +367,17 @@ const initStartChat = async (facadeChatSDK, dispatch, setAdapter, state, props,
|
|
|
287
367
|
(0, _startChatErrorHandler.logWidgetLoadComplete)();
|
|
288
368
|
// Set post chat context in state, load in background to do not block the load
|
|
289
369
|
(0, _setPostChatContextAndLoadSurvey.setPostChatContextAndLoadSurvey)(facadeChatSDK, dispatch);
|
|
290
|
-
// Updating chat session detail for telemetry
|
|
291
|
-
|
|
370
|
+
// Updating chat session detail for telemetry, in background: getConversationDetails retries until the
|
|
371
|
+
// live work item exists (several seconds), and awaiting it would hold the start chat locks and drop the next start chat
|
|
372
|
+
(0, _updateSessionDataForTelemetry.updateTelemetryData)(facadeChatSDK, dispatch);
|
|
373
|
+
return true;
|
|
292
374
|
} catch (ex) {
|
|
293
375
|
(0, _startChatErrorHandler.handleStartChatError)(dispatch, facadeChatSDK, props, ex, isStartChatSuccessful);
|
|
294
|
-
|
|
295
|
-
optionalParams = {};
|
|
296
|
-
widgetInstanceId = "";
|
|
376
|
+
return false;
|
|
297
377
|
}
|
|
298
378
|
};
|
|
299
379
|
|
|
300
380
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
301
|
-
exports.initStartChat = initStartChat;
|
|
302
381
|
const createAdapterAndSubscribe = async (facadeChatSDK, dispatch, setAdapter, startTime, props) => {
|
|
303
382
|
// New adapter creation
|
|
304
383
|
const newAdapter = await (0, _createAdapter.createAdapter)(facadeChatSDK, props);
|
|
@@ -338,19 +417,22 @@ const canConnectToExistingChat = async (props, facadeChatSDK, state, dispatch, s
|
|
|
338
417
|
return false;
|
|
339
418
|
};
|
|
340
419
|
|
|
341
|
-
|
|
420
|
+
/**
|
|
421
|
+
* Resolves the custom context to start the chat with.
|
|
422
|
+
*
|
|
423
|
+
* Returns the resolved params instead of mutating module-level state: a page can host several
|
|
424
|
+
* independent widgets, and once per-instance start-chat guards allow them to run concurrently,
|
|
425
|
+
* shared mutable state would let one widget overwrite another widget's custom context.
|
|
426
|
+
*/
|
|
342
427
|
const setCustomContextParams = async (state, props) => {
|
|
343
428
|
var _state$domainStates9, _persistedState$domai5;
|
|
344
429
|
if (state !== null && state !== void 0 && (_state$domainStates9 = state.domainStates) !== null && _state$domainStates9 !== void 0 && _state$domainStates9.customContext) {
|
|
345
430
|
var _state$domainStates0;
|
|
346
|
-
|
|
431
|
+
return {
|
|
347
432
|
customContext: JSON.parse(JSON.stringify(state === null || state === void 0 || (_state$domainStates0 = state.domainStates) === null || _state$domainStates0 === void 0 ? void 0 : _state$domainStates0.customContext))
|
|
348
|
-
}
|
|
349
|
-
return;
|
|
350
|
-
}
|
|
351
|
-
if ((0, _utils.isNullOrEmptyString)(widgetInstanceId)) {
|
|
352
|
-
widgetInstanceId = (0, _utils.getWidgetCacheIdfromProps)(props);
|
|
433
|
+
};
|
|
353
434
|
}
|
|
435
|
+
const widgetInstanceId = props ? (0, _utils.getWidgetCacheIdfromProps)(props) : "";
|
|
354
436
|
// Add custom context only for unauthenticated chat
|
|
355
437
|
const persistedState = (0, _utils.getStateFromCache)(widgetInstanceId);
|
|
356
438
|
const customContextLocal = (persistedState === null || persistedState === void 0 || (_persistedState$domai5 = persistedState.domainStates) === null || _persistedState$domai5 === void 0 ? void 0 : _persistedState$domai5.customContext) ?? (props === null || props === void 0 ? void 0 : props.initialCustomContext);
|
|
@@ -359,23 +441,23 @@ const setCustomContextParams = async (state, props) => {
|
|
|
359
441
|
Event: _TelemetryConstants.TelemetryEvent.SettingCustomContext,
|
|
360
442
|
Description: "Setting custom context for unauthenticated chat"
|
|
361
443
|
});
|
|
362
|
-
|
|
444
|
+
return {
|
|
363
445
|
customContext: JSON.parse(JSON.stringify(customContextLocal))
|
|
364
|
-
}
|
|
365
|
-
}
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
}
|
|
446
|
+
};
|
|
447
|
+
}
|
|
448
|
+
const customContextFromParent = await getInitContextParamsForPopout();
|
|
449
|
+
if (!(0, _utils.isUndefinedOrEmpty)(customContextFromParent === null || customContextFromParent === void 0 ? void 0 : customContextFromParent.contextVariables)) {
|
|
450
|
+
return {
|
|
451
|
+
customContext: JSON.parse(JSON.stringify(customContextFromParent.contextVariables))
|
|
452
|
+
};
|
|
372
453
|
}
|
|
454
|
+
return {};
|
|
373
455
|
};
|
|
374
456
|
const canStartPopoutChat = async props => {
|
|
375
457
|
if (props.allowSdkChatSupport === false) {
|
|
376
458
|
return false;
|
|
377
459
|
}
|
|
378
|
-
popoutWidgetInstanceId = (0, _utils.getWidgetCacheIdfromProps)(props, true);
|
|
460
|
+
const popoutWidgetInstanceId = (0, _utils.getWidgetCacheIdfromProps)(props, true);
|
|
379
461
|
if (!(0, _utils.isNullOrEmptyString)(popoutWidgetInstanceId)) {
|
|
380
462
|
var _persistedState$domai6, _persistedState$appSt3;
|
|
381
463
|
const persistedState = (0, _utils.getStateFromCache)(popoutWidgetInstanceId);
|