@microsoft/omnichannel-chat-widget 2.0.1-main.a610fd8 → 2.0.1-main.bc685f2
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/lib/cjs/common/telemetry/TelemetryConstants.js +8 -0
- package/lib/cjs/common/telemetry/TelemetryHelper.js +8 -0
- package/lib/cjs/components/livechatwidget/LiveChatWidget.js +2 -0
- package/lib/cjs/components/livechatwidget/common/recoveryEligibilityTelemetry.js +11 -1
- package/lib/cjs/components/livechatwidget/common/useChatTokenRenewal.js +252 -0
- package/lib/esm/common/telemetry/TelemetryConstants.js +8 -0
- package/lib/esm/common/telemetry/TelemetryHelper.js +8 -0
- package/lib/esm/components/livechatwidget/LiveChatWidget.js +3 -1
- package/lib/esm/components/livechatwidget/common/recoveryEligibilityTelemetry.js +11 -1
- package/lib/esm/components/livechatwidget/common/useChatTokenRenewal.js +245 -0
- package/lib/types/common/telemetry/TelemetryConstants.d.ts +4 -0
- package/lib/types/common/telemetry/TelemetryHelper.d.ts +6 -0
- package/lib/types/common/telemetry/definitions/Contracts.d.ts +6 -0
- package/lib/types/common/telemetry/definitions/Payload.d.ts +6 -0
- package/lib/types/components/livechatwidget/common/useChatTokenRenewal.d.ts +5 -0
- package/package.json +2 -2
|
@@ -115,6 +115,10 @@ let TelemetryEvent = exports.TelemetryEvent = /*#__PURE__*/function (TelemetryEv
|
|
|
115
115
|
TelemetryEvent["GetConversationDetailsCallStarted"] = "GetConversationDetailsCallStarted";
|
|
116
116
|
TelemetryEvent["GetConversationDetailsCallFailed"] = "GetConversationDetailsCallFailed";
|
|
117
117
|
TelemetryEvent["UpdateTelemetryDataFailed"] = "UpdateTelemetryDataFailed";
|
|
118
|
+
TelemetryEvent["ChatTokenRenewalStateSyncFailed"] = "ChatTokenRenewalStateSyncFailed";
|
|
119
|
+
TelemetryEvent["ChatTokenRenewalStateSynced"] = "ChatTokenRenewalStateSynced";
|
|
120
|
+
TelemetryEvent["ChatTokenRenewalStateSyncSkipped"] = "ChatTokenRenewalStateSyncSkipped";
|
|
121
|
+
TelemetryEvent["ChatTokenRenewalStateSyncDeferred"] = "ChatTokenRenewalStateSyncDeferred";
|
|
118
122
|
TelemetryEvent["EndChatSDKCallFailed"] = "EndChatSDKCallFailed";
|
|
119
123
|
TelemetryEvent["DisconnectEndChatSDKCallFailed"] = "DisconnectEndChatSDKCallFailed";
|
|
120
124
|
TelemetryEvent["GetChatReconnectContextSDKCallStarted"] = "GetChatReconnectContextSDKCallStarted";
|
|
@@ -432,6 +436,10 @@ let TelemetryConstants = exports.TelemetryConstants = /*#__PURE__*/function () {
|
|
|
432
436
|
case TelemetryEvent.OnNewMessageAudioNotificationFailed:
|
|
433
437
|
case TelemetryEvent.GetConversationDetailsCallFailed:
|
|
434
438
|
case TelemetryEvent.UpdateTelemetryDataFailed:
|
|
439
|
+
case TelemetryEvent.ChatTokenRenewalStateSyncFailed:
|
|
440
|
+
case TelemetryEvent.ChatTokenRenewalStateSynced:
|
|
441
|
+
case TelemetryEvent.ChatTokenRenewalStateSyncSkipped:
|
|
442
|
+
case TelemetryEvent.ChatTokenRenewalStateSyncDeferred:
|
|
435
443
|
case TelemetryEvent.EndChatSDKCall:
|
|
436
444
|
case TelemetryEvent.EndChatEventReceived:
|
|
437
445
|
case TelemetryEvent.EndChatSDKCallFailed:
|
|
@@ -83,6 +83,14 @@ let TelemetryHelper = exports.TelemetryHelper = /*#__PURE__*/function () {
|
|
|
83
83
|
event.ExceptionDetails = JSON.stringify(payload.ExceptionDetails);
|
|
84
84
|
event.Description = payload.Description;
|
|
85
85
|
event.CustomProperties = JSON.stringify(payload.CustomProperties);
|
|
86
|
+
if (payload.Event === _TelemetryConstants.TelemetryEvent.RecoveryEligibilityEvaluated) {
|
|
87
|
+
event.conversationState = payload.conversationState;
|
|
88
|
+
event.hasReconnectId = payload.hasReconnectId;
|
|
89
|
+
event.hasLiveChatContext = payload.hasLiveChatContext;
|
|
90
|
+
event.hasRequestId = payload.hasRequestId;
|
|
91
|
+
event.eligible = payload.eligible;
|
|
92
|
+
event.reason = payload.reason;
|
|
93
|
+
}
|
|
86
94
|
});
|
|
87
95
|
}
|
|
88
96
|
}, {
|
|
@@ -18,6 +18,7 @@ var _utils = require("../../common/utils");
|
|
|
18
18
|
var _liveChatConfigUtils = require("./common/liveChatConfigUtils");
|
|
19
19
|
var _overridePropsOnMockIfApplicable = _interopRequireDefault(require("./common/overridePropsOnMockIfApplicable"));
|
|
20
20
|
var _registerTelemetryLoggers = require("./common/registerTelemetryLoggers");
|
|
21
|
+
var _useChatTokenRenewal = require("./common/useChatTokenRenewal");
|
|
21
22
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
|
|
22
23
|
function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
|
|
23
24
|
function _slicedToArray(r, e) { return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _nonIterableRest(); }
|
|
@@ -73,6 +74,7 @@ const LiveChatWidget = props => {
|
|
|
73
74
|
(0, _react.useEffect)(() => {
|
|
74
75
|
(0, _registerTelemetryLoggers.registerTelemetryLoggers)(props, dispatch);
|
|
75
76
|
}, [dispatch]);
|
|
77
|
+
(0, _useChatTokenRenewal.useChatTokenRenewal)(facadeChatSDK, state, dispatch, (0, _utils.getWidgetCacheIdfromProps)(props));
|
|
76
78
|
return /*#__PURE__*/_react.default.createElement(_FacadeChatSDKStore.FacadeChatSDKStore.Provider, {
|
|
77
79
|
value: [facadeChatSDK, setFacadeChatSDK]
|
|
78
80
|
}, /*#__PURE__*/_react.default.createElement(_ChatSDKStore.ChatSDKStore.Provider, {
|
|
@@ -47,11 +47,21 @@ const getRecoveryEligibilityTelemetryProperties = (state, eligible) => {
|
|
|
47
47
|
};
|
|
48
48
|
};
|
|
49
49
|
exports.getRecoveryEligibilityTelemetryProperties = getRecoveryEligibilityTelemetryProperties;
|
|
50
|
+
const getRecoveryEligibilityScalarTelemetryProperties = properties => ({
|
|
51
|
+
conversationState: properties.conversationState,
|
|
52
|
+
hasReconnectId: String(properties.hasReconnectId),
|
|
53
|
+
hasLiveChatContext: String(properties.hasLiveChatContext),
|
|
54
|
+
hasRequestId: String(properties.hasRequestId),
|
|
55
|
+
eligible: String(properties.eligible),
|
|
56
|
+
reason: properties.reason
|
|
57
|
+
});
|
|
50
58
|
const logRecoveryEligibilityTelemetry = (state, eligible) => {
|
|
51
59
|
try {
|
|
60
|
+
const properties = getRecoveryEligibilityTelemetryProperties(state, eligible);
|
|
52
61
|
_TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.INFO, {
|
|
53
62
|
Event: _TelemetryConstants.TelemetryEvent.RecoveryEligibilityEvaluated,
|
|
54
|
-
CustomProperties:
|
|
63
|
+
CustomProperties: properties,
|
|
64
|
+
...getRecoveryEligibilityScalarTelemetryProperties(properties)
|
|
55
65
|
});
|
|
56
66
|
} catch (error) {
|
|
57
67
|
console.warn(error);
|
|
@@ -0,0 +1,252 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports.useChatTokenRenewal = void 0;
|
|
7
|
+
var _react = require("react");
|
|
8
|
+
var _omnichannelChatComponents = require("@microsoft/omnichannel-chat-components");
|
|
9
|
+
var _TelemetryConstants = require("../../../common/telemetry/TelemetryConstants");
|
|
10
|
+
var _Constants = require("../../../common/Constants");
|
|
11
|
+
var _ConversationState = require("../../../contexts/common/ConversationState");
|
|
12
|
+
var _LiveChatWidgetActionType = require("../../../contexts/common/LiveChatWidgetActionType");
|
|
13
|
+
var _TelemetryHelper = require("../../../common/telemetry/TelemetryHelper");
|
|
14
|
+
function _slicedToArray(r, e) { return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _nonIterableRest(); }
|
|
15
|
+
function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
|
|
16
|
+
function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
|
|
17
|
+
function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
|
|
18
|
+
function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t.return && (u = t.return(), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
|
|
19
|
+
function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
|
|
20
|
+
const logSyncFailure = description => {
|
|
21
|
+
try {
|
|
22
|
+
_TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.ERROR, {
|
|
23
|
+
Event: _TelemetryConstants.TelemetryEvent.ChatTokenRenewalStateSyncFailed,
|
|
24
|
+
Description: description
|
|
25
|
+
});
|
|
26
|
+
} catch {
|
|
27
|
+
// A telemetry listener must not interrupt token recovery or teardown.
|
|
28
|
+
}
|
|
29
|
+
};
|
|
30
|
+
const logSyncInfo = (event, reason) => {
|
|
31
|
+
try {
|
|
32
|
+
_TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.INFO, {
|
|
33
|
+
Event: event,
|
|
34
|
+
Description: reason
|
|
35
|
+
});
|
|
36
|
+
} catch {
|
|
37
|
+
// Telemetry must not interrupt credential synchronization.
|
|
38
|
+
}
|
|
39
|
+
};
|
|
40
|
+
const useChatTokenRenewal = (facade, state, dispatch, widgetCacheId) => {
|
|
41
|
+
var _previous$state$domai, _state$domainStates$l, _previous$state$domai2, _state$domainStates$l2, _previous$state$domai3, _state$domainStates$c, _previous$state$domai4, _state$domainStates$c2, _state$domainStates$c3, _state$domainStates$l3;
|
|
42
|
+
const current = (0, _react.useRef)({
|
|
43
|
+
facade,
|
|
44
|
+
state,
|
|
45
|
+
generation: 0,
|
|
46
|
+
lifecycle: 0
|
|
47
|
+
});
|
|
48
|
+
const pending = (0, _react.useRef)();
|
|
49
|
+
const reconcile = (0, _react.useRef)();
|
|
50
|
+
const supersededTokens = (0, _react.useRef)(new Set());
|
|
51
|
+
const previous = current.current;
|
|
52
|
+
let generation = previous.generation;
|
|
53
|
+
const lifecycleChanged = previous.facade !== facade || previous.state.appStates.conversationState !== state.appStates.conversationState || previous.state.appStates.conversationEndedBy !== state.appStates.conversationEndedBy;
|
|
54
|
+
if (lifecycleChanged || ((_previous$state$domai = previous.state.domainStates.liveChatContext) === null || _previous$state$domai === void 0 ? void 0 : _previous$state$domai.requestId) !== ((_state$domainStates$l = state.domainStates.liveChatContext) === null || _state$domainStates$l === void 0 ? void 0 : _state$domainStates$l.requestId) || ((_previous$state$domai2 = previous.state.domainStates.liveChatContext) === null || _previous$state$domai2 === void 0 ? void 0 : _previous$state$domai2.sessionId) !== ((_state$domainStates$l2 = state.domainStates.liveChatContext) === null || _state$domainStates$l2 === void 0 ? void 0 : _state$domainStates$l2.sessionId) || ((_previous$state$domai3 = previous.state.domainStates.chatToken) === null || _previous$state$domai3 === void 0 ? void 0 : _previous$state$domai3.requestId) !== ((_state$domainStates$c = state.domainStates.chatToken) === null || _state$domainStates$c === void 0 ? void 0 : _state$domainStates$c.requestId) || ((_previous$state$domai4 = previous.state.domainStates.chatToken) === null || _previous$state$domai4 === void 0 ? void 0 : _previous$state$domai4.chatId) !== ((_state$domainStates$c2 = state.domainStates.chatToken) === null || _state$domainStates$c2 === void 0 ? void 0 : _state$domainStates$c2.chatId)) {
|
|
55
|
+
generation++;
|
|
56
|
+
}
|
|
57
|
+
current.current = {
|
|
58
|
+
facade,
|
|
59
|
+
state,
|
|
60
|
+
generation,
|
|
61
|
+
lifecycle: previous.lifecycle + (lifecycleChanged ? 1 : 0)
|
|
62
|
+
};
|
|
63
|
+
(0, _react.useEffect)(() => {
|
|
64
|
+
if (!facade) {
|
|
65
|
+
return;
|
|
66
|
+
}
|
|
67
|
+
let disposed = false;
|
|
68
|
+
let revision = 0;
|
|
69
|
+
let unsubscribe;
|
|
70
|
+
let stateSubscription;
|
|
71
|
+
const refresh = async () => {
|
|
72
|
+
const renewal = ++revision;
|
|
73
|
+
const owner = current.current;
|
|
74
|
+
try {
|
|
75
|
+
var _savedContext$chatTok, _liveChatContext$chat, _liveChatContext$chat2;
|
|
76
|
+
const endedBy = owner.state.appStates.conversationEndedBy;
|
|
77
|
+
if (disposed || owner.facade !== facade || endedBy !== undefined && endedBy !== _Constants.ConversationEndEntity.NotSet) {
|
|
78
|
+
logSyncInfo(_TelemetryConstants.TelemetryEvent.ChatTokenRenewalStateSyncSkipped, "endedOrDisposed");
|
|
79
|
+
return;
|
|
80
|
+
}
|
|
81
|
+
const sdk = facade.getChatSDK();
|
|
82
|
+
const requestId = sdk.requestId;
|
|
83
|
+
const sessionId = sdk.sessionId;
|
|
84
|
+
if (owner.state.appStates.conversationState === _ConversationState.ConversationState.Loading) {
|
|
85
|
+
// A saved-state restore can replace post-start state with the old snapshot.
|
|
86
|
+
// Defer this notification until that same loading session becomes active.
|
|
87
|
+
if (pending.current) {
|
|
88
|
+
logSyncInfo(_TelemetryConstants.TelemetryEvent.ChatTokenRenewalStateSyncSkipped, "supersededDeferredRenewal");
|
|
89
|
+
}
|
|
90
|
+
logSyncInfo(_TelemetryConstants.TelemetryEvent.ChatTokenRenewalStateSyncDeferred, "restoringSession");
|
|
91
|
+
pending.current = async () => {
|
|
92
|
+
// Let Active and the subsequent saved snapshot finish dispatching first.
|
|
93
|
+
await Promise.resolve();
|
|
94
|
+
try {
|
|
95
|
+
if (!disposed && renewal === revision && current.current.facade === facade && current.current.lifecycle === owner.lifecycle + 1 && facade.getChatSDK() === sdk && sdk.requestId === requestId && sdk.sessionId === sessionId) {
|
|
96
|
+
await refresh();
|
|
97
|
+
} else {
|
|
98
|
+
logSyncInfo(_TelemetryConstants.TelemetryEvent.ChatTokenRenewalStateSyncSkipped, "deferredSessionChanged");
|
|
99
|
+
}
|
|
100
|
+
} catch {
|
|
101
|
+
logSyncFailure("Unable to synchronize deferred renewed chat state");
|
|
102
|
+
}
|
|
103
|
+
};
|
|
104
|
+
return;
|
|
105
|
+
}
|
|
106
|
+
if (owner.state.appStates.conversationState !== _ConversationState.ConversationState.Active) {
|
|
107
|
+
logSyncInfo(_TelemetryConstants.TelemetryEvent.ChatTokenRenewalStateSyncSkipped, "inactiveSession");
|
|
108
|
+
return;
|
|
109
|
+
}
|
|
110
|
+
const savedContext = owner.state.domainStates.liveChatContext;
|
|
111
|
+
const savedToken = owner.state.domainStates.chatToken;
|
|
112
|
+
const previousToken = savedToken === null || savedToken === void 0 ? void 0 : savedToken.token;
|
|
113
|
+
const previousContextToken = savedContext === null || savedContext === void 0 || (_savedContext$chatTok = savedContext.chatToken) === null || _savedContext$chatTok === void 0 ? void 0 : _savedContext$chatTok.token;
|
|
114
|
+
const chatId = savedToken === null || savedToken === void 0 ? void 0 : savedToken.chatId;
|
|
115
|
+
if (!requestId || !chatId || savedToken.requestId && savedToken.requestId !== requestId || savedContext && (savedContext.requestId !== requestId || savedContext.sessionId && savedContext.sessionId !== sessionId)) {
|
|
116
|
+
logSyncInfo(_TelemetryConstants.TelemetryEvent.ChatTokenRenewalStateSyncSkipped, "savedSessionMismatch");
|
|
117
|
+
return;
|
|
118
|
+
}
|
|
119
|
+
const isCurrent = () => !disposed && renewal === revision && current.current.facade === facade && current.current.generation === owner.generation && facade.getChatSDK() === sdk && sdk.requestId === requestId && sdk.sessionId === sessionId;
|
|
120
|
+
if (!isCurrent()) {
|
|
121
|
+
logSyncInfo(_TelemetryConstants.TelemetryEvent.ChatTokenRenewalStateSyncSkipped, "supersededOrSessionChanged");
|
|
122
|
+
return;
|
|
123
|
+
}
|
|
124
|
+
const _await$Promise$all = await Promise.all([facade.getCurrentLiveChatContext(), facade.getChatToken()]),
|
|
125
|
+
_await$Promise$all2 = _slicedToArray(_await$Promise$all, 2),
|
|
126
|
+
context = _await$Promise$all2[0],
|
|
127
|
+
chatToken = _await$Promise$all2[1];
|
|
128
|
+
if (!isCurrent()) {
|
|
129
|
+
logSyncInfo(_TelemetryConstants.TelemetryEvent.ChatTokenRenewalStateSyncSkipped, "supersededOrSessionChanged");
|
|
130
|
+
return;
|
|
131
|
+
}
|
|
132
|
+
const liveChatContext = context;
|
|
133
|
+
if ((liveChatContext === null || liveChatContext === void 0 ? void 0 : liveChatContext.requestId) !== requestId || liveChatContext.sessionId && liveChatContext.sessionId !== sessionId || (chatToken === null || chatToken === void 0 ? void 0 : chatToken.chatId) !== chatId || ((_liveChatContext$chat = liveChatContext.chatToken) === null || _liveChatContext$chat === void 0 ? void 0 : _liveChatContext$chat.chatId) !== chatId || ((_liveChatContext$chat2 = liveChatContext.chatToken) === null || _liveChatContext$chat2 === void 0 ? void 0 : _liveChatContext$chat2.token) !== chatToken.token) {
|
|
134
|
+
logSyncInfo(_TelemetryConstants.TelemetryEvent.ChatTokenRenewalStateSyncSkipped, "renewedSessionMismatch");
|
|
135
|
+
return;
|
|
136
|
+
}
|
|
137
|
+
// The normal state publisher/cache writer owns persistence, scope and TTL.
|
|
138
|
+
// Persistent chat keeps using reconnectId instead of creating a live context.
|
|
139
|
+
// A late saved-state restore must not replace this same session's renewal.
|
|
140
|
+
if (previousToken) {
|
|
141
|
+
supersededTokens.current.add(previousToken);
|
|
142
|
+
}
|
|
143
|
+
if (previousContextToken) {
|
|
144
|
+
supersededTokens.current.add(previousContextToken);
|
|
145
|
+
}
|
|
146
|
+
reconcile.current = snapshot => {
|
|
147
|
+
var _snapshot$appStates, _snapshot$domainState, _snapshot$domainState2, _snapshot$domainState3, _latest$liveChatConte, _latest$chatToken;
|
|
148
|
+
if (!isCurrent()) {
|
|
149
|
+
return;
|
|
150
|
+
}
|
|
151
|
+
if (snapshot && (((_snapshot$appStates = snapshot.appStates) === null || _snapshot$appStates === void 0 ? void 0 : _snapshot$appStates.conversationState) !== _ConversationState.ConversationState.Active || snapshot.appStates.conversationEndedBy !== undefined && snapshot.appStates.conversationEndedBy !== _Constants.ConversationEndEntity.NotSet || ((_snapshot$domainState = snapshot.domainStates) === null || _snapshot$domainState === void 0 || (_snapshot$domainState = _snapshot$domainState.chatToken) === null || _snapshot$domainState === void 0 ? void 0 : _snapshot$domainState.chatId) !== chatId || snapshot.domainStates.chatToken.requestId && snapshot.domainStates.chatToken.requestId !== requestId || snapshot.domainStates.liveChatContext && (snapshot.domainStates.liveChatContext.requestId !== requestId || snapshot.domainStates.liveChatContext.sessionId && snapshot.domainStates.liveChatContext.sessionId !== sessionId))) {
|
|
152
|
+
return;
|
|
153
|
+
}
|
|
154
|
+
// Another window may publish a newer credential we have never replaced.
|
|
155
|
+
if (snapshot && (snapshot.domainStates.chatToken.token !== chatToken.token && !supersededTokens.current.has(snapshot.domainStates.chatToken.token) || snapshot.domainStates.liveChatContext && ((_snapshot$domainState2 = snapshot.domainStates.liveChatContext.chatToken) === null || _snapshot$domainState2 === void 0 ? void 0 : _snapshot$domainState2.token) !== chatToken.token && !supersededTokens.current.has((_snapshot$domainState3 = snapshot.domainStates.liveChatContext.chatToken) === null || _snapshot$domainState3 === void 0 ? void 0 : _snapshot$domainState3.token))) {
|
|
156
|
+
return;
|
|
157
|
+
}
|
|
158
|
+
const latest = (snapshot ?? current.current.state).domainStates;
|
|
159
|
+
if (savedContext && ((_latest$liveChatConte = latest.liveChatContext) === null || _latest$liveChatConte === void 0 || (_latest$liveChatConte = _latest$liveChatConte.chatToken) === null || _latest$liveChatConte === void 0 ? void 0 : _latest$liveChatConte.token) !== chatToken.token) {
|
|
160
|
+
dispatch({
|
|
161
|
+
type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_LIVE_CHAT_CONTEXT,
|
|
162
|
+
payload: liveChatContext
|
|
163
|
+
});
|
|
164
|
+
}
|
|
165
|
+
if (((_latest$chatToken = latest.chatToken) === null || _latest$chatToken === void 0 ? void 0 : _latest$chatToken.token) !== chatToken.token) {
|
|
166
|
+
dispatch({
|
|
167
|
+
type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_CHAT_TOKEN,
|
|
168
|
+
payload: chatToken
|
|
169
|
+
});
|
|
170
|
+
logSyncInfo(_TelemetryConstants.TelemetryEvent.ChatTokenRenewalStateSynced, "republished");
|
|
171
|
+
}
|
|
172
|
+
};
|
|
173
|
+
if (savedContext) {
|
|
174
|
+
dispatch({
|
|
175
|
+
type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_LIVE_CHAT_CONTEXT,
|
|
176
|
+
payload: liveChatContext
|
|
177
|
+
});
|
|
178
|
+
}
|
|
179
|
+
dispatch({
|
|
180
|
+
type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_CHAT_TOKEN,
|
|
181
|
+
payload: chatToken
|
|
182
|
+
});
|
|
183
|
+
logSyncInfo(_TelemetryConstants.TelemetryEvent.ChatTokenRenewalStateSynced, "dispatched");
|
|
184
|
+
} catch {
|
|
185
|
+
logSyncFailure("Unable to synchronize renewed chat state");
|
|
186
|
+
}
|
|
187
|
+
};
|
|
188
|
+
try {
|
|
189
|
+
var _sdk$onChatTokenRenew;
|
|
190
|
+
const sdk = facade.getChatSDK();
|
|
191
|
+
unsubscribe = (_sdk$onChatTokenRenew = sdk.onChatTokenRenewed) === null || _sdk$onChatTokenRenew === void 0 ? void 0 : _sdk$onChatTokenRenew.call(sdk, () => {
|
|
192
|
+
void refresh();
|
|
193
|
+
});
|
|
194
|
+
} catch {
|
|
195
|
+
logSyncFailure("Unable to subscribe to chat token renewal");
|
|
196
|
+
}
|
|
197
|
+
try {
|
|
198
|
+
// Delayed broadcast retries can overwrite storage after React state is current.
|
|
199
|
+
stateSubscription = _omnichannelChatComponents.BroadcastService.getMessageByEventName(widgetCacheId).subscribe(message => {
|
|
200
|
+
var _reconcile$current;
|
|
201
|
+
return (_reconcile$current = reconcile.current) === null || _reconcile$current === void 0 ? void 0 : _reconcile$current.call(reconcile, message.payload);
|
|
202
|
+
});
|
|
203
|
+
} catch {
|
|
204
|
+
logSyncFailure("Unable to subscribe to renewed chat state publication");
|
|
205
|
+
}
|
|
206
|
+
return () => {
|
|
207
|
+
disposed = true;
|
|
208
|
+
revision++;
|
|
209
|
+
if (pending.current) {
|
|
210
|
+
logSyncInfo(_TelemetryConstants.TelemetryEvent.ChatTokenRenewalStateSyncSkipped, "subscriptionDisposed");
|
|
211
|
+
}
|
|
212
|
+
pending.current = undefined;
|
|
213
|
+
reconcile.current = undefined;
|
|
214
|
+
supersededTokens.current.clear();
|
|
215
|
+
try {
|
|
216
|
+
var _unsubscribe;
|
|
217
|
+
(_unsubscribe = unsubscribe) === null || _unsubscribe === void 0 || _unsubscribe();
|
|
218
|
+
} catch {
|
|
219
|
+
logSyncFailure("Unable to unsubscribe from chat token renewal");
|
|
220
|
+
}
|
|
221
|
+
try {
|
|
222
|
+
var _stateSubscription;
|
|
223
|
+
(_stateSubscription = stateSubscription) === null || _stateSubscription === void 0 || _stateSubscription.unsubscribe();
|
|
224
|
+
} catch {
|
|
225
|
+
logSyncFailure("Unable to unsubscribe from renewed chat state publication");
|
|
226
|
+
}
|
|
227
|
+
};
|
|
228
|
+
}, [facade, dispatch, widgetCacheId]);
|
|
229
|
+
(0, _react.useEffect)(() => {
|
|
230
|
+
if (state.appStates.conversationState === _ConversationState.ConversationState.Active) {
|
|
231
|
+
const refresh = pending.current;
|
|
232
|
+
pending.current = undefined;
|
|
233
|
+
try {
|
|
234
|
+
var _reconcile$current2;
|
|
235
|
+
refresh === null || refresh === void 0 || refresh();
|
|
236
|
+
(_reconcile$current2 = reconcile.current) === null || _reconcile$current2 === void 0 || _reconcile$current2.call(reconcile);
|
|
237
|
+
} catch {
|
|
238
|
+
logSyncFailure("Unable to synchronize renewed chat state");
|
|
239
|
+
}
|
|
240
|
+
} else {
|
|
241
|
+
reconcile.current = undefined;
|
|
242
|
+
supersededTokens.current.clear();
|
|
243
|
+
if (state.appStates.conversationState !== _ConversationState.ConversationState.Loading) {
|
|
244
|
+
if (pending.current) {
|
|
245
|
+
logSyncInfo(_TelemetryConstants.TelemetryEvent.ChatTokenRenewalStateSyncSkipped, "inactiveSession");
|
|
246
|
+
}
|
|
247
|
+
pending.current = undefined;
|
|
248
|
+
}
|
|
249
|
+
}
|
|
250
|
+
}, [facade, state.appStates.conversationState, (_state$domainStates$c3 = state.domainStates.chatToken) === null || _state$domainStates$c3 === void 0 ? void 0 : _state$domainStates$c3.token, (_state$domainStates$l3 = state.domainStates.liveChatContext) === null || _state$domainStates$l3 === void 0 || (_state$domainStates$l3 = _state$domainStates$l3.chatToken) === null || _state$domainStates$l3 === void 0 ? void 0 : _state$domainStates$l3.token]);
|
|
251
|
+
};
|
|
252
|
+
exports.useChatTokenRenewal = useChatTokenRenewal;
|
|
@@ -113,6 +113,10 @@ export let TelemetryEvent = /*#__PURE__*/function (TelemetryEvent) {
|
|
|
113
113
|
TelemetryEvent["GetConversationDetailsCallStarted"] = "GetConversationDetailsCallStarted";
|
|
114
114
|
TelemetryEvent["GetConversationDetailsCallFailed"] = "GetConversationDetailsCallFailed";
|
|
115
115
|
TelemetryEvent["UpdateTelemetryDataFailed"] = "UpdateTelemetryDataFailed";
|
|
116
|
+
TelemetryEvent["ChatTokenRenewalStateSyncFailed"] = "ChatTokenRenewalStateSyncFailed";
|
|
117
|
+
TelemetryEvent["ChatTokenRenewalStateSynced"] = "ChatTokenRenewalStateSynced";
|
|
118
|
+
TelemetryEvent["ChatTokenRenewalStateSyncSkipped"] = "ChatTokenRenewalStateSyncSkipped";
|
|
119
|
+
TelemetryEvent["ChatTokenRenewalStateSyncDeferred"] = "ChatTokenRenewalStateSyncDeferred";
|
|
116
120
|
TelemetryEvent["EndChatSDKCallFailed"] = "EndChatSDKCallFailed";
|
|
117
121
|
TelemetryEvent["DisconnectEndChatSDKCallFailed"] = "DisconnectEndChatSDKCallFailed";
|
|
118
122
|
TelemetryEvent["GetChatReconnectContextSDKCallStarted"] = "GetChatReconnectContextSDKCallStarted";
|
|
@@ -430,6 +434,10 @@ export let TelemetryConstants = /*#__PURE__*/function () {
|
|
|
430
434
|
case TelemetryEvent.OnNewMessageAudioNotificationFailed:
|
|
431
435
|
case TelemetryEvent.GetConversationDetailsCallFailed:
|
|
432
436
|
case TelemetryEvent.UpdateTelemetryDataFailed:
|
|
437
|
+
case TelemetryEvent.ChatTokenRenewalStateSyncFailed:
|
|
438
|
+
case TelemetryEvent.ChatTokenRenewalStateSynced:
|
|
439
|
+
case TelemetryEvent.ChatTokenRenewalStateSyncSkipped:
|
|
440
|
+
case TelemetryEvent.ChatTokenRenewalStateSyncDeferred:
|
|
433
441
|
case TelemetryEvent.EndChatSDKCall:
|
|
434
442
|
case TelemetryEvent.EndChatEventReceived:
|
|
435
443
|
case TelemetryEvent.EndChatSDKCallFailed:
|
|
@@ -77,6 +77,14 @@ export let TelemetryHelper = /*#__PURE__*/function () {
|
|
|
77
77
|
event.ExceptionDetails = JSON.stringify(payload.ExceptionDetails);
|
|
78
78
|
event.Description = payload.Description;
|
|
79
79
|
event.CustomProperties = JSON.stringify(payload.CustomProperties);
|
|
80
|
+
if (payload.Event === TelemetryEvent.RecoveryEligibilityEvaluated) {
|
|
81
|
+
event.conversationState = payload.conversationState;
|
|
82
|
+
event.hasReconnectId = payload.hasReconnectId;
|
|
83
|
+
event.hasLiveChatContext = payload.hasLiveChatContext;
|
|
84
|
+
event.hasRequestId = payload.hasRequestId;
|
|
85
|
+
event.eligible = payload.eligible;
|
|
86
|
+
event.reason = payload.reason;
|
|
87
|
+
}
|
|
80
88
|
});
|
|
81
89
|
}
|
|
82
90
|
}, {
|
|
@@ -14,10 +14,11 @@ import LiveChatWidgetStateful from "./livechatwidgetstateful/LiveChatWidgetState
|
|
|
14
14
|
import { createReducer } from "../../contexts/createReducer";
|
|
15
15
|
import { getLiveChatWidgetContextInitialState } from "../../contexts/common/LiveChatWidgetContextInitialState";
|
|
16
16
|
import { getMockChatSDKIfApplicable } from "./common/getMockChatSDKIfApplicable";
|
|
17
|
-
import { isNullOrUndefined } from "../../common/utils";
|
|
17
|
+
import { getWidgetCacheIdfromProps, isNullOrUndefined } from "../../common/utils";
|
|
18
18
|
import { isPersistentChatEnabled } from "./common/liveChatConfigUtils";
|
|
19
19
|
import overridePropsOnMockIfApplicable from "./common/overridePropsOnMockIfApplicable";
|
|
20
20
|
import { registerTelemetryLoggers } from "./common/registerTelemetryLoggers";
|
|
21
|
+
import { useChatTokenRenewal } from "./common/useChatTokenRenewal";
|
|
21
22
|
export const LiveChatWidget = props => {
|
|
22
23
|
var _props$featureConfigP, _props$chatConfig, _props$chatConfig2;
|
|
23
24
|
const reducer = createReducer();
|
|
@@ -65,6 +66,7 @@ export const LiveChatWidget = props => {
|
|
|
65
66
|
useEffect(() => {
|
|
66
67
|
registerTelemetryLoggers(props, dispatch);
|
|
67
68
|
}, [dispatch]);
|
|
69
|
+
useChatTokenRenewal(facadeChatSDK, state, dispatch, getWidgetCacheIdfromProps(props));
|
|
68
70
|
return /*#__PURE__*/React.createElement(FacadeChatSDKStore.Provider, {
|
|
69
71
|
value: [facadeChatSDK, setFacadeChatSDK]
|
|
70
72
|
}, /*#__PURE__*/React.createElement(ChatSDKStore.Provider, {
|
|
@@ -40,11 +40,21 @@ export const getRecoveryEligibilityTelemetryProperties = (state, eligible) => {
|
|
|
40
40
|
reason
|
|
41
41
|
};
|
|
42
42
|
};
|
|
43
|
+
const getRecoveryEligibilityScalarTelemetryProperties = properties => ({
|
|
44
|
+
conversationState: properties.conversationState,
|
|
45
|
+
hasReconnectId: String(properties.hasReconnectId),
|
|
46
|
+
hasLiveChatContext: String(properties.hasLiveChatContext),
|
|
47
|
+
hasRequestId: String(properties.hasRequestId),
|
|
48
|
+
eligible: String(properties.eligible),
|
|
49
|
+
reason: properties.reason
|
|
50
|
+
});
|
|
43
51
|
export const logRecoveryEligibilityTelemetry = (state, eligible) => {
|
|
44
52
|
try {
|
|
53
|
+
const properties = getRecoveryEligibilityTelemetryProperties(state, eligible);
|
|
45
54
|
TelemetryHelper.logActionEvent(LogLevel.INFO, {
|
|
46
55
|
Event: TelemetryEvent.RecoveryEligibilityEvaluated,
|
|
47
|
-
CustomProperties:
|
|
56
|
+
CustomProperties: properties,
|
|
57
|
+
...getRecoveryEligibilityScalarTelemetryProperties(properties)
|
|
48
58
|
});
|
|
49
59
|
} catch (error) {
|
|
50
60
|
console.warn(error);
|
|
@@ -0,0 +1,245 @@
|
|
|
1
|
+
function _slicedToArray(r, e) { return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _nonIterableRest(); }
|
|
2
|
+
function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
|
|
3
|
+
function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
|
|
4
|
+
function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
|
|
5
|
+
function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t.return && (u = t.return(), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
|
|
6
|
+
function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
|
|
7
|
+
import { useEffect, useRef } from "react";
|
|
8
|
+
import { BroadcastService } from "@microsoft/omnichannel-chat-components";
|
|
9
|
+
import { LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
|
|
10
|
+
import { ConversationEndEntity } from "../../../common/Constants";
|
|
11
|
+
import { ConversationState } from "../../../contexts/common/ConversationState";
|
|
12
|
+
import { LiveChatWidgetActionType } from "../../../contexts/common/LiveChatWidgetActionType";
|
|
13
|
+
import { TelemetryHelper } from "../../../common/telemetry/TelemetryHelper";
|
|
14
|
+
const logSyncFailure = description => {
|
|
15
|
+
try {
|
|
16
|
+
TelemetryHelper.logSDKEvent(LogLevel.ERROR, {
|
|
17
|
+
Event: TelemetryEvent.ChatTokenRenewalStateSyncFailed,
|
|
18
|
+
Description: description
|
|
19
|
+
});
|
|
20
|
+
} catch {
|
|
21
|
+
// A telemetry listener must not interrupt token recovery or teardown.
|
|
22
|
+
}
|
|
23
|
+
};
|
|
24
|
+
const logSyncInfo = (event, reason) => {
|
|
25
|
+
try {
|
|
26
|
+
TelemetryHelper.logSDKEvent(LogLevel.INFO, {
|
|
27
|
+
Event: event,
|
|
28
|
+
Description: reason
|
|
29
|
+
});
|
|
30
|
+
} catch {
|
|
31
|
+
// Telemetry must not interrupt credential synchronization.
|
|
32
|
+
}
|
|
33
|
+
};
|
|
34
|
+
export const useChatTokenRenewal = (facade, state, dispatch, widgetCacheId) => {
|
|
35
|
+
var _previous$state$domai, _state$domainStates$l, _previous$state$domai2, _state$domainStates$l2, _previous$state$domai3, _state$domainStates$c, _previous$state$domai4, _state$domainStates$c2, _state$domainStates$c3, _state$domainStates$l3;
|
|
36
|
+
const current = useRef({
|
|
37
|
+
facade,
|
|
38
|
+
state,
|
|
39
|
+
generation: 0,
|
|
40
|
+
lifecycle: 0
|
|
41
|
+
});
|
|
42
|
+
const pending = useRef();
|
|
43
|
+
const reconcile = useRef();
|
|
44
|
+
const supersededTokens = useRef(new Set());
|
|
45
|
+
const previous = current.current;
|
|
46
|
+
let generation = previous.generation;
|
|
47
|
+
const lifecycleChanged = previous.facade !== facade || previous.state.appStates.conversationState !== state.appStates.conversationState || previous.state.appStates.conversationEndedBy !== state.appStates.conversationEndedBy;
|
|
48
|
+
if (lifecycleChanged || ((_previous$state$domai = previous.state.domainStates.liveChatContext) === null || _previous$state$domai === void 0 ? void 0 : _previous$state$domai.requestId) !== ((_state$domainStates$l = state.domainStates.liveChatContext) === null || _state$domainStates$l === void 0 ? void 0 : _state$domainStates$l.requestId) || ((_previous$state$domai2 = previous.state.domainStates.liveChatContext) === null || _previous$state$domai2 === void 0 ? void 0 : _previous$state$domai2.sessionId) !== ((_state$domainStates$l2 = state.domainStates.liveChatContext) === null || _state$domainStates$l2 === void 0 ? void 0 : _state$domainStates$l2.sessionId) || ((_previous$state$domai3 = previous.state.domainStates.chatToken) === null || _previous$state$domai3 === void 0 ? void 0 : _previous$state$domai3.requestId) !== ((_state$domainStates$c = state.domainStates.chatToken) === null || _state$domainStates$c === void 0 ? void 0 : _state$domainStates$c.requestId) || ((_previous$state$domai4 = previous.state.domainStates.chatToken) === null || _previous$state$domai4 === void 0 ? void 0 : _previous$state$domai4.chatId) !== ((_state$domainStates$c2 = state.domainStates.chatToken) === null || _state$domainStates$c2 === void 0 ? void 0 : _state$domainStates$c2.chatId)) {
|
|
49
|
+
generation++;
|
|
50
|
+
}
|
|
51
|
+
current.current = {
|
|
52
|
+
facade,
|
|
53
|
+
state,
|
|
54
|
+
generation,
|
|
55
|
+
lifecycle: previous.lifecycle + (lifecycleChanged ? 1 : 0)
|
|
56
|
+
};
|
|
57
|
+
useEffect(() => {
|
|
58
|
+
if (!facade) {
|
|
59
|
+
return;
|
|
60
|
+
}
|
|
61
|
+
let disposed = false;
|
|
62
|
+
let revision = 0;
|
|
63
|
+
let unsubscribe;
|
|
64
|
+
let stateSubscription;
|
|
65
|
+
const refresh = async () => {
|
|
66
|
+
const renewal = ++revision;
|
|
67
|
+
const owner = current.current;
|
|
68
|
+
try {
|
|
69
|
+
var _savedContext$chatTok, _liveChatContext$chat, _liveChatContext$chat2;
|
|
70
|
+
const endedBy = owner.state.appStates.conversationEndedBy;
|
|
71
|
+
if (disposed || owner.facade !== facade || endedBy !== undefined && endedBy !== ConversationEndEntity.NotSet) {
|
|
72
|
+
logSyncInfo(TelemetryEvent.ChatTokenRenewalStateSyncSkipped, "endedOrDisposed");
|
|
73
|
+
return;
|
|
74
|
+
}
|
|
75
|
+
const sdk = facade.getChatSDK();
|
|
76
|
+
const requestId = sdk.requestId;
|
|
77
|
+
const sessionId = sdk.sessionId;
|
|
78
|
+
if (owner.state.appStates.conversationState === ConversationState.Loading) {
|
|
79
|
+
// A saved-state restore can replace post-start state with the old snapshot.
|
|
80
|
+
// Defer this notification until that same loading session becomes active.
|
|
81
|
+
if (pending.current) {
|
|
82
|
+
logSyncInfo(TelemetryEvent.ChatTokenRenewalStateSyncSkipped, "supersededDeferredRenewal");
|
|
83
|
+
}
|
|
84
|
+
logSyncInfo(TelemetryEvent.ChatTokenRenewalStateSyncDeferred, "restoringSession");
|
|
85
|
+
pending.current = async () => {
|
|
86
|
+
// Let Active and the subsequent saved snapshot finish dispatching first.
|
|
87
|
+
await Promise.resolve();
|
|
88
|
+
try {
|
|
89
|
+
if (!disposed && renewal === revision && current.current.facade === facade && current.current.lifecycle === owner.lifecycle + 1 && facade.getChatSDK() === sdk && sdk.requestId === requestId && sdk.sessionId === sessionId) {
|
|
90
|
+
await refresh();
|
|
91
|
+
} else {
|
|
92
|
+
logSyncInfo(TelemetryEvent.ChatTokenRenewalStateSyncSkipped, "deferredSessionChanged");
|
|
93
|
+
}
|
|
94
|
+
} catch {
|
|
95
|
+
logSyncFailure("Unable to synchronize deferred renewed chat state");
|
|
96
|
+
}
|
|
97
|
+
};
|
|
98
|
+
return;
|
|
99
|
+
}
|
|
100
|
+
if (owner.state.appStates.conversationState !== ConversationState.Active) {
|
|
101
|
+
logSyncInfo(TelemetryEvent.ChatTokenRenewalStateSyncSkipped, "inactiveSession");
|
|
102
|
+
return;
|
|
103
|
+
}
|
|
104
|
+
const savedContext = owner.state.domainStates.liveChatContext;
|
|
105
|
+
const savedToken = owner.state.domainStates.chatToken;
|
|
106
|
+
const previousToken = savedToken === null || savedToken === void 0 ? void 0 : savedToken.token;
|
|
107
|
+
const previousContextToken = savedContext === null || savedContext === void 0 || (_savedContext$chatTok = savedContext.chatToken) === null || _savedContext$chatTok === void 0 ? void 0 : _savedContext$chatTok.token;
|
|
108
|
+
const chatId = savedToken === null || savedToken === void 0 ? void 0 : savedToken.chatId;
|
|
109
|
+
if (!requestId || !chatId || savedToken.requestId && savedToken.requestId !== requestId || savedContext && (savedContext.requestId !== requestId || savedContext.sessionId && savedContext.sessionId !== sessionId)) {
|
|
110
|
+
logSyncInfo(TelemetryEvent.ChatTokenRenewalStateSyncSkipped, "savedSessionMismatch");
|
|
111
|
+
return;
|
|
112
|
+
}
|
|
113
|
+
const isCurrent = () => !disposed && renewal === revision && current.current.facade === facade && current.current.generation === owner.generation && facade.getChatSDK() === sdk && sdk.requestId === requestId && sdk.sessionId === sessionId;
|
|
114
|
+
if (!isCurrent()) {
|
|
115
|
+
logSyncInfo(TelemetryEvent.ChatTokenRenewalStateSyncSkipped, "supersededOrSessionChanged");
|
|
116
|
+
return;
|
|
117
|
+
}
|
|
118
|
+
const _await$Promise$all = await Promise.all([facade.getCurrentLiveChatContext(), facade.getChatToken()]),
|
|
119
|
+
_await$Promise$all2 = _slicedToArray(_await$Promise$all, 2),
|
|
120
|
+
context = _await$Promise$all2[0],
|
|
121
|
+
chatToken = _await$Promise$all2[1];
|
|
122
|
+
if (!isCurrent()) {
|
|
123
|
+
logSyncInfo(TelemetryEvent.ChatTokenRenewalStateSyncSkipped, "supersededOrSessionChanged");
|
|
124
|
+
return;
|
|
125
|
+
}
|
|
126
|
+
const liveChatContext = context;
|
|
127
|
+
if ((liveChatContext === null || liveChatContext === void 0 ? void 0 : liveChatContext.requestId) !== requestId || liveChatContext.sessionId && liveChatContext.sessionId !== sessionId || (chatToken === null || chatToken === void 0 ? void 0 : chatToken.chatId) !== chatId || ((_liveChatContext$chat = liveChatContext.chatToken) === null || _liveChatContext$chat === void 0 ? void 0 : _liveChatContext$chat.chatId) !== chatId || ((_liveChatContext$chat2 = liveChatContext.chatToken) === null || _liveChatContext$chat2 === void 0 ? void 0 : _liveChatContext$chat2.token) !== chatToken.token) {
|
|
128
|
+
logSyncInfo(TelemetryEvent.ChatTokenRenewalStateSyncSkipped, "renewedSessionMismatch");
|
|
129
|
+
return;
|
|
130
|
+
}
|
|
131
|
+
// The normal state publisher/cache writer owns persistence, scope and TTL.
|
|
132
|
+
// Persistent chat keeps using reconnectId instead of creating a live context.
|
|
133
|
+
// A late saved-state restore must not replace this same session's renewal.
|
|
134
|
+
if (previousToken) {
|
|
135
|
+
supersededTokens.current.add(previousToken);
|
|
136
|
+
}
|
|
137
|
+
if (previousContextToken) {
|
|
138
|
+
supersededTokens.current.add(previousContextToken);
|
|
139
|
+
}
|
|
140
|
+
reconcile.current = snapshot => {
|
|
141
|
+
var _snapshot$appStates, _snapshot$domainState, _snapshot$domainState2, _snapshot$domainState3, _latest$liveChatConte, _latest$chatToken;
|
|
142
|
+
if (!isCurrent()) {
|
|
143
|
+
return;
|
|
144
|
+
}
|
|
145
|
+
if (snapshot && (((_snapshot$appStates = snapshot.appStates) === null || _snapshot$appStates === void 0 ? void 0 : _snapshot$appStates.conversationState) !== ConversationState.Active || snapshot.appStates.conversationEndedBy !== undefined && snapshot.appStates.conversationEndedBy !== ConversationEndEntity.NotSet || ((_snapshot$domainState = snapshot.domainStates) === null || _snapshot$domainState === void 0 || (_snapshot$domainState = _snapshot$domainState.chatToken) === null || _snapshot$domainState === void 0 ? void 0 : _snapshot$domainState.chatId) !== chatId || snapshot.domainStates.chatToken.requestId && snapshot.domainStates.chatToken.requestId !== requestId || snapshot.domainStates.liveChatContext && (snapshot.domainStates.liveChatContext.requestId !== requestId || snapshot.domainStates.liveChatContext.sessionId && snapshot.domainStates.liveChatContext.sessionId !== sessionId))) {
|
|
146
|
+
return;
|
|
147
|
+
}
|
|
148
|
+
// Another window may publish a newer credential we have never replaced.
|
|
149
|
+
if (snapshot && (snapshot.domainStates.chatToken.token !== chatToken.token && !supersededTokens.current.has(snapshot.domainStates.chatToken.token) || snapshot.domainStates.liveChatContext && ((_snapshot$domainState2 = snapshot.domainStates.liveChatContext.chatToken) === null || _snapshot$domainState2 === void 0 ? void 0 : _snapshot$domainState2.token) !== chatToken.token && !supersededTokens.current.has((_snapshot$domainState3 = snapshot.domainStates.liveChatContext.chatToken) === null || _snapshot$domainState3 === void 0 ? void 0 : _snapshot$domainState3.token))) {
|
|
150
|
+
return;
|
|
151
|
+
}
|
|
152
|
+
const latest = (snapshot ?? current.current.state).domainStates;
|
|
153
|
+
if (savedContext && ((_latest$liveChatConte = latest.liveChatContext) === null || _latest$liveChatConte === void 0 || (_latest$liveChatConte = _latest$liveChatConte.chatToken) === null || _latest$liveChatConte === void 0 ? void 0 : _latest$liveChatConte.token) !== chatToken.token) {
|
|
154
|
+
dispatch({
|
|
155
|
+
type: LiveChatWidgetActionType.SET_LIVE_CHAT_CONTEXT,
|
|
156
|
+
payload: liveChatContext
|
|
157
|
+
});
|
|
158
|
+
}
|
|
159
|
+
if (((_latest$chatToken = latest.chatToken) === null || _latest$chatToken === void 0 ? void 0 : _latest$chatToken.token) !== chatToken.token) {
|
|
160
|
+
dispatch({
|
|
161
|
+
type: LiveChatWidgetActionType.SET_CHAT_TOKEN,
|
|
162
|
+
payload: chatToken
|
|
163
|
+
});
|
|
164
|
+
logSyncInfo(TelemetryEvent.ChatTokenRenewalStateSynced, "republished");
|
|
165
|
+
}
|
|
166
|
+
};
|
|
167
|
+
if (savedContext) {
|
|
168
|
+
dispatch({
|
|
169
|
+
type: LiveChatWidgetActionType.SET_LIVE_CHAT_CONTEXT,
|
|
170
|
+
payload: liveChatContext
|
|
171
|
+
});
|
|
172
|
+
}
|
|
173
|
+
dispatch({
|
|
174
|
+
type: LiveChatWidgetActionType.SET_CHAT_TOKEN,
|
|
175
|
+
payload: chatToken
|
|
176
|
+
});
|
|
177
|
+
logSyncInfo(TelemetryEvent.ChatTokenRenewalStateSynced, "dispatched");
|
|
178
|
+
} catch {
|
|
179
|
+
logSyncFailure("Unable to synchronize renewed chat state");
|
|
180
|
+
}
|
|
181
|
+
};
|
|
182
|
+
try {
|
|
183
|
+
var _sdk$onChatTokenRenew;
|
|
184
|
+
const sdk = facade.getChatSDK();
|
|
185
|
+
unsubscribe = (_sdk$onChatTokenRenew = sdk.onChatTokenRenewed) === null || _sdk$onChatTokenRenew === void 0 ? void 0 : _sdk$onChatTokenRenew.call(sdk, () => {
|
|
186
|
+
void refresh();
|
|
187
|
+
});
|
|
188
|
+
} catch {
|
|
189
|
+
logSyncFailure("Unable to subscribe to chat token renewal");
|
|
190
|
+
}
|
|
191
|
+
try {
|
|
192
|
+
// Delayed broadcast retries can overwrite storage after React state is current.
|
|
193
|
+
stateSubscription = BroadcastService.getMessageByEventName(widgetCacheId).subscribe(message => {
|
|
194
|
+
var _reconcile$current;
|
|
195
|
+
return (_reconcile$current = reconcile.current) === null || _reconcile$current === void 0 ? void 0 : _reconcile$current.call(reconcile, message.payload);
|
|
196
|
+
});
|
|
197
|
+
} catch {
|
|
198
|
+
logSyncFailure("Unable to subscribe to renewed chat state publication");
|
|
199
|
+
}
|
|
200
|
+
return () => {
|
|
201
|
+
disposed = true;
|
|
202
|
+
revision++;
|
|
203
|
+
if (pending.current) {
|
|
204
|
+
logSyncInfo(TelemetryEvent.ChatTokenRenewalStateSyncSkipped, "subscriptionDisposed");
|
|
205
|
+
}
|
|
206
|
+
pending.current = undefined;
|
|
207
|
+
reconcile.current = undefined;
|
|
208
|
+
supersededTokens.current.clear();
|
|
209
|
+
try {
|
|
210
|
+
var _unsubscribe;
|
|
211
|
+
(_unsubscribe = unsubscribe) === null || _unsubscribe === void 0 || _unsubscribe();
|
|
212
|
+
} catch {
|
|
213
|
+
logSyncFailure("Unable to unsubscribe from chat token renewal");
|
|
214
|
+
}
|
|
215
|
+
try {
|
|
216
|
+
var _stateSubscription;
|
|
217
|
+
(_stateSubscription = stateSubscription) === null || _stateSubscription === void 0 || _stateSubscription.unsubscribe();
|
|
218
|
+
} catch {
|
|
219
|
+
logSyncFailure("Unable to unsubscribe from renewed chat state publication");
|
|
220
|
+
}
|
|
221
|
+
};
|
|
222
|
+
}, [facade, dispatch, widgetCacheId]);
|
|
223
|
+
useEffect(() => {
|
|
224
|
+
if (state.appStates.conversationState === ConversationState.Active) {
|
|
225
|
+
const refresh = pending.current;
|
|
226
|
+
pending.current = undefined;
|
|
227
|
+
try {
|
|
228
|
+
var _reconcile$current2;
|
|
229
|
+
refresh === null || refresh === void 0 || refresh();
|
|
230
|
+
(_reconcile$current2 = reconcile.current) === null || _reconcile$current2 === void 0 || _reconcile$current2.call(reconcile);
|
|
231
|
+
} catch {
|
|
232
|
+
logSyncFailure("Unable to synchronize renewed chat state");
|
|
233
|
+
}
|
|
234
|
+
} else {
|
|
235
|
+
reconcile.current = undefined;
|
|
236
|
+
supersededTokens.current.clear();
|
|
237
|
+
if (state.appStates.conversationState !== ConversationState.Loading) {
|
|
238
|
+
if (pending.current) {
|
|
239
|
+
logSyncInfo(TelemetryEvent.ChatTokenRenewalStateSyncSkipped, "inactiveSession");
|
|
240
|
+
}
|
|
241
|
+
pending.current = undefined;
|
|
242
|
+
}
|
|
243
|
+
}
|
|
244
|
+
}, [facade, state.appStates.conversationState, (_state$domainStates$c3 = state.domainStates.chatToken) === null || _state$domainStates$c3 === void 0 ? void 0 : _state$domainStates$c3.token, (_state$domainStates$l3 = state.domainStates.liveChatContext) === null || _state$domainStates$l3 === void 0 || (_state$domainStates$l3 = _state$domainStates$l3.chatToken) === null || _state$domainStates$l3 === void 0 ? void 0 : _state$domainStates$l3.token]);
|
|
245
|
+
};
|
|
@@ -99,6 +99,10 @@ export declare enum TelemetryEvent {
|
|
|
99
99
|
GetConversationDetailsCallStarted = "GetConversationDetailsCallStarted",
|
|
100
100
|
GetConversationDetailsCallFailed = "GetConversationDetailsCallFailed",
|
|
101
101
|
UpdateTelemetryDataFailed = "UpdateTelemetryDataFailed",
|
|
102
|
+
ChatTokenRenewalStateSyncFailed = "ChatTokenRenewalStateSyncFailed",
|
|
103
|
+
ChatTokenRenewalStateSynced = "ChatTokenRenewalStateSynced",
|
|
104
|
+
ChatTokenRenewalStateSyncSkipped = "ChatTokenRenewalStateSyncSkipped",
|
|
105
|
+
ChatTokenRenewalStateSyncDeferred = "ChatTokenRenewalStateSyncDeferred",
|
|
102
106
|
EndChatSDKCallFailed = "EndChatSDKCallFailed",
|
|
103
107
|
DisconnectEndChatSDKCallFailed = "DisconnectEndChatSDKCallFailed",
|
|
104
108
|
GetChatReconnectContextSDKCallStarted = "GetChatReconnectContextSDKCallStarted",
|
|
@@ -13,6 +13,12 @@ export interface TelemetryEventWrapper {
|
|
|
13
13
|
ElapsedTimeInMilliseconds?: number;
|
|
14
14
|
Data?: any;
|
|
15
15
|
CustomProperties?: any;
|
|
16
|
+
conversationState?: string;
|
|
17
|
+
hasReconnectId?: string;
|
|
18
|
+
hasLiveChatContext?: string;
|
|
19
|
+
hasRequestId?: string;
|
|
20
|
+
eligible?: string;
|
|
21
|
+
reason?: string;
|
|
16
22
|
}
|
|
17
23
|
export declare class TelemetryHelper {
|
|
18
24
|
static callId: string;
|
|
@@ -38,6 +38,12 @@ export interface ActionsContract extends BaseContract {
|
|
|
38
38
|
ActionType?: string;
|
|
39
39
|
Description?: string;
|
|
40
40
|
CustomProperties?: any;
|
|
41
|
+
conversationState?: string;
|
|
42
|
+
hasReconnectId?: string;
|
|
43
|
+
hasLiveChatContext?: string;
|
|
44
|
+
hasRequestId?: string;
|
|
45
|
+
eligible?: string;
|
|
46
|
+
reason?: string;
|
|
41
47
|
}
|
|
42
48
|
export interface IC3ClientContract extends BaseContract {
|
|
43
49
|
Event?: string;
|
|
@@ -88,6 +88,12 @@ export interface ActionTelemetryData extends BaseTelemetryData {
|
|
|
88
88
|
ExceptionDetails?: object;
|
|
89
89
|
Description?: string;
|
|
90
90
|
CustomProperties?: any;
|
|
91
|
+
conversationState?: string;
|
|
92
|
+
hasReconnectId?: string;
|
|
93
|
+
hasLiveChatContext?: string;
|
|
94
|
+
hasRequestId?: string;
|
|
95
|
+
eligible?: string;
|
|
96
|
+
reason?: string;
|
|
91
97
|
}
|
|
92
98
|
export interface CallingTelemetryData extends BaseTelemetryData {
|
|
93
99
|
CallId?: string;
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { Dispatch } from "react";
|
|
2
|
+
import { FacadeChatSDK } from "../../../common/facades/FacadeChatSDK";
|
|
3
|
+
import { ILiveChatWidgetAction } from "../../../contexts/common/ILiveChatWidgetAction";
|
|
4
|
+
import { ILiveChatWidgetContext } from "../../../contexts/common/ILiveChatWidgetContext";
|
|
5
|
+
export declare const useChatTokenRenewal: (facade: FacadeChatSDK | undefined, state: ILiveChatWidgetContext, dispatch: Dispatch<ILiveChatWidgetAction>, widgetCacheId: string) => void;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@microsoft/omnichannel-chat-widget",
|
|
3
|
-
"version": "2.0.1-main.
|
|
3
|
+
"version": "2.0.1-main.bc685f2",
|
|
4
4
|
"description": "Microsoft Omnichannel Chat Widget",
|
|
5
5
|
"main": "lib/cjs/index.js",
|
|
6
6
|
"types": "lib/types/index.d.ts",
|
|
@@ -93,7 +93,7 @@
|
|
|
93
93
|
"@azure/core-tracing": "^1.2.0",
|
|
94
94
|
"@microsoft/applicationinsights-web": "^3.3.6",
|
|
95
95
|
"@microsoft/omnichannel-chat-components": "1.2.0",
|
|
96
|
-
"@microsoft/omnichannel-chat-sdk": "2.0.2-main.
|
|
96
|
+
"@microsoft/omnichannel-chat-sdk": "2.0.2-main.355218f",
|
|
97
97
|
"@opentelemetry/api": "^1.9.0",
|
|
98
98
|
"abort-controller": "^3",
|
|
99
99
|
"botframework-webchat": "4.18.1-hotfix.20260308.b15b405",
|