@azure/msal-common 14.0.0-alpha.1 → 14.0.0-beta.0

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.
Files changed (187) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +62 -62
  3. package/dist/account/AccountInfo.d.ts +31 -31
  4. package/dist/account/AuthToken.d.ts +20 -20
  5. package/dist/account/AuthToken.js +48 -48
  6. package/dist/account/CcsCredential.d.ts +9 -8
  7. package/dist/account/CcsCredential.d.ts.map +1 -1
  8. package/dist/account/CcsCredential.js +9 -10
  9. package/dist/account/CcsCredential.js.map +1 -1
  10. package/dist/account/ClientCredentials.d.ts +14 -14
  11. package/dist/account/ClientInfo.d.ts +19 -19
  12. package/dist/account/ClientInfo.js +37 -37
  13. package/dist/account/DecodedAuthToken.d.ts +8 -8
  14. package/dist/account/TokenClaims.d.ts +65 -65
  15. package/dist/authority/Authority.d.ts +228 -215
  16. package/dist/authority/Authority.d.ts.map +1 -1
  17. package/dist/authority/Authority.js +716 -682
  18. package/dist/authority/Authority.js.map +1 -1
  19. package/dist/authority/AuthorityFactory.d.ts +30 -30
  20. package/dist/authority/AuthorityFactory.js +47 -47
  21. package/dist/authority/AuthorityMetadata.d.ts +622 -622
  22. package/dist/authority/AuthorityMetadata.js +876 -876
  23. package/dist/authority/AuthorityOptions.d.ts +19 -18
  24. package/dist/authority/AuthorityOptions.d.ts.map +1 -1
  25. package/dist/authority/AuthorityOptions.js +19 -20
  26. package/dist/authority/AuthorityOptions.js.map +1 -1
  27. package/dist/authority/AuthorityType.d.ts +10 -9
  28. package/dist/authority/AuthorityType.d.ts.map +1 -1
  29. package/dist/authority/AuthorityType.js +14 -15
  30. package/dist/authority/AuthorityType.js.map +1 -1
  31. package/dist/authority/AzureRegion.d.ts +1 -1
  32. package/dist/authority/AzureRegionConfiguration.d.ts +5 -5
  33. package/dist/authority/CloudDiscoveryMetadata.d.ts +5 -5
  34. package/dist/authority/CloudInstanceDiscoveryErrorResponse.d.ts +13 -13
  35. package/dist/authority/CloudInstanceDiscoveryErrorResponse.js +8 -8
  36. package/dist/authority/CloudInstanceDiscoveryResponse.d.ts +9 -9
  37. package/dist/authority/CloudInstanceDiscoveryResponse.js +8 -8
  38. package/dist/authority/ImdsOptions.d.ts +5 -5
  39. package/dist/authority/OpenIdConfigResponse.d.ts +11 -11
  40. package/dist/authority/OpenIdConfigResponse.js +10 -10
  41. package/dist/authority/ProtocolMode.d.ts +8 -7
  42. package/dist/authority/ProtocolMode.d.ts.map +1 -1
  43. package/dist/authority/ProtocolMode.js +12 -13
  44. package/dist/authority/ProtocolMode.js.map +1 -1
  45. package/dist/authority/RegionDiscovery.d.ts +30 -30
  46. package/dist/authority/RegionDiscovery.js +108 -108
  47. package/dist/authority/RegionDiscoveryMetadata.d.ts +6 -6
  48. package/dist/broker/nativeBroker/INativeBrokerPlugin.d.ts +15 -15
  49. package/dist/cache/CacheManager.d.ts +443 -443
  50. package/dist/cache/CacheManager.js +1011 -1011
  51. package/dist/cache/entities/AccessTokenEntity.d.ts +56 -56
  52. package/dist/cache/entities/AccessTokenEntity.js +111 -111
  53. package/dist/cache/entities/AccountEntity.d.ts +99 -99
  54. package/dist/cache/entities/AccountEntity.js +248 -248
  55. package/dist/cache/entities/AppMetadataEntity.d.ts +39 -39
  56. package/dist/cache/entities/AppMetadataEntity.js +66 -66
  57. package/dist/cache/entities/AuthorityMetadataEntity.d.ts +47 -47
  58. package/dist/cache/entities/AuthorityMetadataEntity.js +77 -77
  59. package/dist/cache/entities/CacheRecord.d.ts +13 -13
  60. package/dist/cache/entities/CacheRecord.js +13 -13
  61. package/dist/cache/entities/CredentialEntity.d.ts +88 -88
  62. package/dist/cache/entities/CredentialEntity.js +136 -136
  63. package/dist/cache/entities/IdTokenEntity.d.ts +34 -34
  64. package/dist/cache/entities/IdTokenEntity.js +56 -56
  65. package/dist/cache/entities/RefreshTokenEntity.d.ts +36 -36
  66. package/dist/cache/entities/RefreshTokenEntity.js +59 -59
  67. package/dist/cache/entities/ServerTelemetryEntity.d.ts +12 -12
  68. package/dist/cache/entities/ServerTelemetryEntity.js +27 -27
  69. package/dist/cache/entities/ThrottlingEntity.d.ts +13 -13
  70. package/dist/cache/entities/ThrottlingEntity.js +23 -23
  71. package/dist/cache/interface/ICacheManager.d.ts +165 -165
  72. package/dist/cache/interface/ICachePlugin.d.ts +5 -5
  73. package/dist/cache/interface/ISerializableTokenCache.d.ts +4 -4
  74. package/dist/cache/persistence/TokenCacheContext.d.ts +23 -23
  75. package/dist/cache/persistence/TokenCacheContext.js +25 -25
  76. package/dist/cache/utils/CacheTypes.d.ts +62 -62
  77. package/dist/client/AuthorizationCodeClient.d.ts +71 -71
  78. package/dist/client/AuthorizationCodeClient.js +433 -433
  79. package/dist/client/BaseClient.d.ts +50 -50
  80. package/dist/client/BaseClient.js +92 -92
  81. package/dist/client/RefreshTokenClient.d.ts +34 -34
  82. package/dist/client/RefreshTokenClient.js +239 -239
  83. package/dist/client/SilentFlowClient.d.ts +24 -24
  84. package/dist/client/SilentFlowClient.js +94 -94
  85. package/dist/config/AppTokenProvider.d.ts +38 -38
  86. package/dist/config/ClientConfiguration.d.ts +133 -133
  87. package/dist/config/ClientConfiguration.js +88 -88
  88. package/dist/crypto/ICrypto.d.ts +62 -62
  89. package/dist/crypto/ICrypto.js +42 -42
  90. package/dist/crypto/IGuidGenerator.d.ts +4 -4
  91. package/dist/crypto/JoseHeader.d.ts +21 -21
  92. package/dist/crypto/JoseHeader.js +36 -36
  93. package/dist/crypto/PopTokenGenerator.d.ts +58 -57
  94. package/dist/crypto/PopTokenGenerator.d.ts.map +1 -1
  95. package/dist/crypto/PopTokenGenerator.js +82 -83
  96. package/dist/crypto/PopTokenGenerator.js.map +1 -1
  97. package/dist/crypto/SignedHttpRequest.d.ts +11 -11
  98. package/dist/error/AuthError.d.ts +47 -47
  99. package/dist/error/AuthError.js +51 -51
  100. package/dist/error/ClientAuthError.d.ts +412 -412
  101. package/dist/error/ClientAuthError.js +519 -519
  102. package/dist/error/ClientConfigurationError.d.ts +206 -198
  103. package/dist/error/ClientConfigurationError.d.ts.map +1 -1
  104. package/dist/error/ClientConfigurationError.js +259 -249
  105. package/dist/error/ClientConfigurationError.js.map +1 -1
  106. package/dist/error/InteractionRequiredAuthError.d.ts +59 -59
  107. package/dist/error/InteractionRequiredAuthError.js +78 -78
  108. package/dist/error/JoseHeaderError.d.ts +28 -28
  109. package/dist/error/JoseHeaderError.js +39 -39
  110. package/dist/error/ServerError.d.ts +7 -7
  111. package/dist/error/ServerError.js +14 -14
  112. package/dist/index.cjs.js +8826 -8813
  113. package/dist/index.cjs.js.map +1 -1
  114. package/dist/index.d.ts +93 -93
  115. package/dist/index.js +1 -1
  116. package/dist/logger/Logger.d.ts +95 -95
  117. package/dist/logger/Logger.js +197 -197
  118. package/dist/network/INetworkModule.d.ts +29 -29
  119. package/dist/network/INetworkModule.js +14 -14
  120. package/dist/network/NetworkManager.d.ts +32 -32
  121. package/dist/network/NetworkManager.js +33 -33
  122. package/dist/network/RequestThumbprint.d.ts +16 -16
  123. package/dist/network/ThrottlingUtils.d.ts +41 -41
  124. package/dist/network/ThrottlingUtils.js +94 -94
  125. package/dist/packageMetadata.d.ts +2 -2
  126. package/dist/packageMetadata.d.ts.map +1 -1
  127. package/dist/packageMetadata.js +4 -4
  128. package/dist/request/AuthenticationHeaderParser.d.ts +19 -19
  129. package/dist/request/AuthenticationHeaderParser.js +55 -55
  130. package/dist/request/BaseAuthRequest.d.ts +37 -37
  131. package/dist/request/CommonAuthorizationCodeRequest.d.ts +27 -27
  132. package/dist/request/CommonAuthorizationUrlRequest.d.ts +50 -50
  133. package/dist/request/CommonClientCredentialRequest.d.ts +17 -17
  134. package/dist/request/CommonDeviceCodeRequest.d.ts +21 -21
  135. package/dist/request/CommonEndSessionRequest.d.ts +21 -21
  136. package/dist/request/CommonOnBehalfOfRequest.d.ts +13 -13
  137. package/dist/request/CommonRefreshTokenRequest.d.ts +19 -19
  138. package/dist/request/CommonSilentFlowRequest.d.ts +18 -18
  139. package/dist/request/CommonUsernamePasswordRequest.d.ts +17 -17
  140. package/dist/request/NativeRequest.d.ts +19 -19
  141. package/dist/request/NativeSignOutRequest.d.ts +5 -5
  142. package/dist/request/RequestParameterBuilder.d.ts +216 -216
  143. package/dist/request/RequestParameterBuilder.js +374 -374
  144. package/dist/request/RequestValidator.d.ts +33 -33
  145. package/dist/request/RequestValidator.js +82 -83
  146. package/dist/request/RequestValidator.js.map +1 -1
  147. package/dist/request/ScopeSet.d.ts +88 -88
  148. package/dist/request/ScopeSet.js +197 -197
  149. package/dist/response/AuthenticationResult.d.ts +39 -39
  150. package/dist/response/AuthorizationCodePayload.d.ts +13 -13
  151. package/dist/response/DeviceCodeResponse.d.ts +25 -25
  152. package/dist/response/ExternalTokenResponse.d.ts +15 -15
  153. package/dist/response/IMDSBadResponse.d.ts +4 -4
  154. package/dist/response/ResponseHandler.d.ts +72 -72
  155. package/dist/response/ResponseHandler.js +300 -300
  156. package/dist/response/ServerAuthorizationCodeResponse.d.ts +25 -25
  157. package/dist/response/ServerAuthorizationTokenResponse.d.ts +44 -44
  158. package/dist/telemetry/performance/IPerformanceClient.d.ts +42 -42
  159. package/dist/telemetry/performance/IPerformanceMeasurement.d.ts +5 -5
  160. package/dist/telemetry/performance/PerformanceClient.d.ts +189 -189
  161. package/dist/telemetry/performance/PerformanceClient.js +406 -406
  162. package/dist/telemetry/performance/PerformanceEvent.d.ts +441 -439
  163. package/dist/telemetry/performance/PerformanceEvent.d.ts.map +1 -1
  164. package/dist/telemetry/performance/PerformanceEvent.js +225 -227
  165. package/dist/telemetry/performance/PerformanceEvent.js.map +1 -1
  166. package/dist/telemetry/performance/StubPerformanceClient.d.ts +15 -19
  167. package/dist/telemetry/performance/StubPerformanceClient.d.ts.map +1 -1
  168. package/dist/telemetry/performance/StubPerformanceClient.js +22 -36
  169. package/dist/telemetry/performance/StubPerformanceClient.js.map +1 -1
  170. package/dist/telemetry/server/ServerTelemetryManager.d.ts +65 -65
  171. package/dist/telemetry/server/ServerTelemetryManager.js +196 -196
  172. package/dist/telemetry/server/ServerTelemetryRequest.d.ts +8 -8
  173. package/dist/url/IUri.d.ts +12 -12
  174. package/dist/url/UrlString.d.ts +70 -70
  175. package/dist/url/UrlString.js +242 -242
  176. package/dist/utils/Constants.d.ts +345 -331
  177. package/dist/utils/Constants.d.ts.map +1 -1
  178. package/dist/utils/Constants.js +353 -373
  179. package/dist/utils/Constants.js.map +1 -1
  180. package/dist/utils/MsalTypes.d.ts +6 -6
  181. package/dist/utils/ProtocolUtils.d.ts +42 -42
  182. package/dist/utils/ProtocolUtils.js +71 -71
  183. package/dist/utils/StringUtils.d.ts +53 -53
  184. package/dist/utils/StringUtils.js +124 -124
  185. package/dist/utils/TimeUtils.d.ts +27 -27
  186. package/dist/utils/TimeUtils.js +45 -45
  187. package/package.json +86 -79
@@ -1,412 +1,412 @@
1
- /*! @azure/msal-common v14.0.0-alpha.1 2023-05-08 */
1
+ /*! @azure/msal-common v14.0.0-beta.0 2023-06-19 */
2
2
  'use strict';
3
3
  import { IntFields, PerformanceEventStatus } from './PerformanceEvent.js';
4
4
 
5
- /*
6
- * Copyright (c) Microsoft Corporation. All rights reserved.
7
- * Licensed under the MIT License.
8
- */
9
- class PerformanceClient {
10
- /**
11
- * Creates an instance of PerformanceClient,
12
- * an abstract class containing core performance telemetry logic.
13
- *
14
- * @constructor
15
- * @param {string} clientId Client ID of the application
16
- * @param {string} authority Authority used by the application
17
- * @param {Logger} logger Logger used by the application
18
- * @param {string} libraryName Name of the library
19
- * @param {string} libraryVersion Version of the library
20
- */
21
- constructor(clientId, authority, logger, libraryName, libraryVersion, applicationTelemetry) {
22
- this.authority = authority;
23
- this.libraryName = libraryName;
24
- this.libraryVersion = libraryVersion;
25
- this.applicationTelemetry = applicationTelemetry;
26
- this.clientId = clientId;
27
- this.logger = logger;
28
- this.callbacks = new Map();
29
- this.eventsByCorrelationId = new Map();
30
- this.queueMeasurements = new Map();
31
- this.preQueueTimeByCorrelationId = new Map();
32
- }
33
- /**
34
- * Starts and returns an platform-specific implementation of IPerformanceMeasurement.
35
- * Note: this function can be changed to abstract at the next major version bump.
36
- *
37
- * @param {string} measureName
38
- * @param {string} correlationId
39
- * @returns {IPerformanceMeasurement}
40
- */
41
- startPerformanceMeasurement(measureName, // eslint-disable-line @typescript-eslint/no-unused-vars
42
- correlationId // eslint-disable-line @typescript-eslint/no-unused-vars
43
- ) {
44
- return {};
45
- }
46
- /**
47
- * Get integral fields.
48
- * Override to change the set.
49
- */
50
- getIntFields() {
51
- return IntFields;
52
- }
53
- /**
54
- * Gets map of pre-queue times by correlation Id
55
- *
56
- * @param {PerformanceEvents} eventName
57
- * @param {string} correlationId
58
- * @returns {number}
59
- */
60
- getPreQueueTime(eventName, correlationId) {
61
- const preQueueEvent = this.preQueueTimeByCorrelationId.get(correlationId);
62
- if (!preQueueEvent) {
63
- this.logger.trace(`PerformanceClient.getPreQueueTime: no pre-queue times found for correlationId: ${correlationId}, unable to add queue measurement`);
64
- return;
65
- }
66
- else if (preQueueEvent.name !== eventName) {
67
- this.logger.trace(`PerformanceClient.getPreQueueTime: no pre-queue time found for ${eventName}, unable to add queue measurement`);
68
- return;
69
- }
70
- return preQueueEvent.time;
71
- }
72
- /**
73
- * Calculates the difference between current time and time when function was queued.
74
- * Note: It is possible to have 0 as the queue time if the current time and the queued time was the same.
75
- *
76
- * @param {number} preQueueTime
77
- * @param {number} currentTime
78
- * @returns {number}
79
- */
80
- calculateQueuedTime(preQueueTime, currentTime) {
81
- if (preQueueTime < 1) {
82
- this.logger.trace(`PerformanceClient: preQueueTime should be a positive integer and not ${preQueueTime}`);
83
- return 0;
84
- }
85
- if (currentTime < 1) {
86
- this.logger.trace(`PerformanceClient: currentTime should be a positive integer and not ${currentTime}`);
87
- return 0;
88
- }
89
- if (currentTime < preQueueTime) {
90
- this.logger.trace("PerformanceClient: currentTime is less than preQueueTime, check how time is being retrieved");
91
- return 0;
92
- }
93
- return currentTime - preQueueTime;
94
- }
95
- /**
96
- * Adds queue measurement time to QueueMeasurements array for given correlation ID.
97
- *
98
- * @param {PerformanceEvents} eventName
99
- * @param {?string} correlationId
100
- * @param {?number} queueTime
101
- * @param {?boolean} manuallyCompleted - indicator for manually completed queue measurements
102
- * @returns
103
- */
104
- addQueueMeasurement(eventName, correlationId, queueTime, manuallyCompleted) {
105
- if (!correlationId) {
106
- this.logger.trace(`PerformanceClient.addQueueMeasurement: correlationId not provided for ${eventName}, cannot add queue measurement`);
107
- return;
108
- }
109
- if (queueTime === 0) {
110
- // Possible for there to be no queue time after calculation
111
- this.logger.trace(`PerformanceClient.addQueueMeasurement: queue time provided for ${eventName} is ${queueTime}`);
112
- }
113
- else if (!queueTime) {
114
- this.logger.trace(`PerformanceClient.addQueueMeasurement: no queue time provided for ${eventName}`);
115
- return;
116
- }
117
- const queueMeasurement = {
118
- eventName,
119
- queueTime,
120
- manuallyCompleted,
121
- };
122
- // Adds to existing correlation Id if present in queueMeasurements
123
- const existingMeasurements = this.queueMeasurements.get(correlationId);
124
- if (existingMeasurements) {
125
- existingMeasurements.push(queueMeasurement);
126
- this.queueMeasurements.set(correlationId, existingMeasurements);
127
- }
128
- else {
129
- // Sets new correlation Id if not present in queueMeasurements
130
- this.logger.trace(`PerformanceClient.addQueueMeasurement: adding correlationId ${correlationId} to queue measurements`);
131
- const measurementArray = [queueMeasurement];
132
- this.queueMeasurements.set(correlationId, measurementArray);
133
- }
134
- // Delete processed pre-queue event.
135
- this.preQueueTimeByCorrelationId.delete(correlationId);
136
- }
137
- /**
138
- * Starts measuring performance for a given operation. Returns a function that should be used to end the measurement.
139
- *
140
- * @param {PerformanceEvents} measureName
141
- * @param {?string} [correlationId]
142
- * @returns {InProgressPerformanceEvent}
143
- */
144
- startMeasurement(measureName, correlationId) {
145
- // Generate a placeholder correlation if the request does not provide one
146
- const eventCorrelationId = correlationId || this.generateId();
147
- if (!correlationId) {
148
- this.logger.info(`PerformanceClient: No correlation id provided for ${measureName}, generating`, eventCorrelationId);
149
- }
150
- this.logger.trace(`PerformanceClient: Performance measurement started for ${measureName}`, eventCorrelationId);
151
- const performanceMeasurement = this.startPerformanceMeasurement(measureName, eventCorrelationId);
152
- performanceMeasurement.startMeasurement();
153
- const inProgressEvent = {
154
- eventId: this.generateId(),
155
- status: PerformanceEventStatus.InProgress,
156
- authority: this.authority,
157
- libraryName: this.libraryName,
158
- libraryVersion: this.libraryVersion,
159
- clientId: this.clientId,
160
- name: measureName,
161
- startTimeMs: Date.now(),
162
- correlationId: eventCorrelationId,
163
- appName: this.applicationTelemetry?.appName,
164
- appVersion: this.applicationTelemetry?.appVersion,
165
- };
166
- // Store in progress events so they can be discarded if not ended properly
167
- this.cacheEventByCorrelationId(inProgressEvent);
168
- // Return the event and functions the caller can use to properly end/flush the measurement
169
- return {
170
- endMeasurement: (event) => {
171
- return this.endMeasurement({
172
- // Initial set of event properties
173
- ...inProgressEvent,
174
- // Properties set when event ends
175
- ...event,
176
- }, performanceMeasurement);
177
- },
178
- discardMeasurement: () => {
179
- return this.discardMeasurements(inProgressEvent.correlationId);
180
- },
181
- addStaticFields: (fields) => {
182
- return this.addStaticFields(fields, inProgressEvent.correlationId);
183
- },
184
- increment: (counters) => {
185
- return this.increment(counters, inProgressEvent.correlationId);
186
- },
187
- measurement: performanceMeasurement,
188
- event: inProgressEvent,
189
- };
190
- }
191
- /**
192
- * Stops measuring the performance for an operation. Should only be called directly by PerformanceClient classes,
193
- * as consumers should instead use the function returned by startMeasurement.
194
- * Adds a new field named as "[event name]DurationMs" for sub-measurements, completes and emits an event
195
- * otherwise.
196
- *
197
- * @param {PerformanceEvent} event
198
- * @param {IPerformanceMeasurement} measurement
199
- * @returns {(PerformanceEvent | null)}
200
- */
201
- endMeasurement(event, measurement) {
202
- const rootEvent = this.eventsByCorrelationId.get(event.correlationId);
203
- if (!rootEvent) {
204
- this.logger.trace(`PerformanceClient: Measurement not found for ${event.eventId}`, event.correlationId);
205
- return null;
206
- }
207
- const isRoot = event.eventId === rootEvent.eventId;
208
- let queueInfo = {
209
- totalQueueTime: 0,
210
- totalQueueCount: 0,
211
- manuallyCompletedCount: 0,
212
- };
213
- if (isRoot) {
214
- queueInfo = this.getQueueInfo(event.correlationId);
215
- this.discardCache(rootEvent.correlationId);
216
- }
217
- else {
218
- rootEvent.incompleteSubMeasurements?.delete(event.eventId);
219
- }
220
- measurement?.endMeasurement();
221
- const durationMs = measurement?.flushMeasurement();
222
- // null indicates no measurement was taken (e.g. needed performance APIs not present)
223
- if (!durationMs) {
224
- this.logger.trace("PerformanceClient: Performance measurement not taken", rootEvent.correlationId);
225
- return null;
226
- }
227
- this.logger.trace(`PerformanceClient: Performance measurement ended for ${event.name}: ${durationMs} ms`, event.correlationId);
228
- // Add sub-measurement attribute to root event.
229
- if (!isRoot) {
230
- rootEvent[event.name + "DurationMs"] = Math.floor(durationMs);
231
- return { ...rootEvent };
232
- }
233
- let finalEvent = { ...rootEvent, ...event };
234
- let incompleteSubsCount = 0;
235
- // Incomplete sub-measurements are discarded. They are likely an instrumentation bug that should be fixed.
236
- finalEvent.incompleteSubMeasurements?.forEach((subMeasurement) => {
237
- this.logger.trace(`PerformanceClient: Incomplete submeasurement ${subMeasurement.name} found for ${event.name}`, finalEvent.correlationId);
238
- incompleteSubsCount++;
239
- });
240
- finalEvent.incompleteSubMeasurements = undefined;
241
- finalEvent = {
242
- ...finalEvent,
243
- durationMs: Math.round(durationMs),
244
- queuedTimeMs: queueInfo.totalQueueTime,
245
- queuedCount: queueInfo.totalQueueCount,
246
- queuedManuallyCompletedCount: queueInfo.manuallyCompletedCount,
247
- status: PerformanceEventStatus.Completed,
248
- incompleteSubsCount,
249
- };
250
- this.truncateIntegralFields(finalEvent, this.getIntFields());
251
- this.emitEvents([finalEvent], event.correlationId);
252
- return finalEvent;
253
- }
254
- /**
255
- * Saves extra information to be emitted when the measurements are flushed
256
- * @param fields
257
- * @param correlationId
258
- */
259
- addStaticFields(fields, correlationId) {
260
- this.logger.trace("PerformanceClient: Updating static fields");
261
- const event = this.eventsByCorrelationId.get(correlationId);
262
- if (event) {
263
- this.eventsByCorrelationId.set(correlationId, {
264
- ...event,
265
- ...fields,
266
- });
267
- }
268
- else {
269
- this.logger.trace("PerformanceClient: Event not found for", correlationId);
270
- }
271
- }
272
- /**
273
- * Increment counters to be emitted when the measurements are flushed
274
- * @param counters {Counters}
275
- * @param correlationId {string} correlation identifier
276
- */
277
- increment(counters, correlationId) {
278
- this.logger.trace("PerformanceClient: Updating counters");
279
- const event = this.eventsByCorrelationId.get(correlationId);
280
- if (event) {
281
- for (const counter in counters) {
282
- if (!event.hasOwnProperty(counter)) {
283
- event[counter] = 0;
284
- }
285
- event[counter] += counters[counter];
286
- }
287
- }
288
- else {
289
- this.logger.trace("PerformanceClient: Event not found for", correlationId);
290
- }
291
- }
292
- /**
293
- * Upserts event into event cache.
294
- * First key is the correlation id, second key is the event id.
295
- * Allows for events to be grouped by correlation id,
296
- * and to easily allow for properties on them to be updated.
297
- *
298
- * @private
299
- * @param {PerformanceEvent} event
300
- */
301
- cacheEventByCorrelationId(event) {
302
- const rootEvent = this.eventsByCorrelationId.get(event.correlationId);
303
- if (rootEvent) {
304
- this.logger.trace(`PerformanceClient: Performance measurement for ${event.name} added/updated`, event.correlationId);
305
- rootEvent.incompleteSubMeasurements =
306
- rootEvent.incompleteSubMeasurements || new Map();
307
- rootEvent.incompleteSubMeasurements.set(event.eventId, {
308
- name: event.name,
309
- startTimeMs: event.startTimeMs,
310
- });
311
- }
312
- else {
313
- this.logger.trace(`PerformanceClient: Performance measurement for ${event.name} started`, event.correlationId);
314
- this.eventsByCorrelationId.set(event.correlationId, { ...event });
315
- }
316
- }
317
- getQueueInfo(correlationId) {
318
- const queueMeasurementForCorrelationId = this.queueMeasurements.get(correlationId);
319
- if (!queueMeasurementForCorrelationId) {
320
- this.logger.trace(`PerformanceClient: no queue measurements found for for correlationId: ${correlationId}`);
321
- }
322
- let totalQueueTime = 0;
323
- let totalQueueCount = 0;
324
- let manuallyCompletedCount = 0;
325
- queueMeasurementForCorrelationId?.forEach((measurement) => {
326
- totalQueueTime += measurement.queueTime;
327
- totalQueueCount++;
328
- manuallyCompletedCount += measurement.manuallyCompleted ? 1 : 0;
329
- });
330
- return {
331
- totalQueueTime,
332
- totalQueueCount,
333
- manuallyCompletedCount,
334
- };
335
- }
336
- /**
337
- * Removes measurements for a given correlation id.
338
- *
339
- * @param {string} correlationId
340
- */
341
- discardMeasurements(correlationId) {
342
- this.logger.trace("PerformanceClient: Performance measurements discarded", correlationId);
343
- this.eventsByCorrelationId.delete(correlationId);
344
- }
345
- /**
346
- * Removes cache for a given correlation id.
347
- *
348
- * @param {string} correlationId correlation identifier
349
- */
350
- discardCache(correlationId) {
351
- this.discardMeasurements(correlationId);
352
- this.logger.trace("PerformanceClient: QueueMeasurements discarded", correlationId);
353
- this.queueMeasurements.delete(correlationId);
354
- this.logger.trace("PerformanceClient: Pre-queue times discarded", correlationId);
355
- this.preQueueTimeByCorrelationId.delete(correlationId);
356
- }
357
- /**
358
- * Registers a callback function to receive performance events.
359
- *
360
- * @param {PerformanceCallbackFunction} callback
361
- * @returns {string}
362
- */
363
- addPerformanceCallback(callback) {
364
- const callbackId = this.generateId();
365
- this.callbacks.set(callbackId, callback);
366
- this.logger.verbose(`PerformanceClient: Performance callback registered with id: ${callbackId}`);
367
- return callbackId;
368
- }
369
- /**
370
- * Removes a callback registered with addPerformanceCallback.
371
- *
372
- * @param {string} callbackId
373
- * @returns {boolean}
374
- */
375
- removePerformanceCallback(callbackId) {
376
- const result = this.callbacks.delete(callbackId);
377
- if (result) {
378
- this.logger.verbose(`PerformanceClient: Performance callback ${callbackId} removed.`);
379
- }
380
- else {
381
- this.logger.verbose(`PerformanceClient: Performance callback ${callbackId} not removed.`);
382
- }
383
- return result;
384
- }
385
- /**
386
- * Emits events to all registered callbacks.
387
- *
388
- * @param {PerformanceEvent[]} events
389
- * @param {?string} [correlationId]
390
- */
391
- emitEvents(events, correlationId) {
392
- this.logger.verbose("PerformanceClient: Emitting performance events", correlationId);
393
- this.callbacks.forEach((callback, callbackId) => {
394
- this.logger.trace(`PerformanceClient: Emitting event to callback ${callbackId}`, correlationId);
395
- callback.apply(null, [events]);
396
- });
397
- }
398
- /**
399
- * Enforce truncation of integral fields in performance event.
400
- * @param {PerformanceEvent} event performance event to update.
401
- * @param {Set<string>} intFields integral fields.
402
- */
403
- truncateIntegralFields(event, intFields) {
404
- intFields.forEach((key) => {
405
- if (key in event && typeof event[key] === "number") {
406
- event[key] = Math.floor(event[key]);
407
- }
408
- });
409
- }
5
+ /*
6
+ * Copyright (c) Microsoft Corporation. All rights reserved.
7
+ * Licensed under the MIT License.
8
+ */
9
+ class PerformanceClient {
10
+ /**
11
+ * Creates an instance of PerformanceClient,
12
+ * an abstract class containing core performance telemetry logic.
13
+ *
14
+ * @constructor
15
+ * @param {string} clientId Client ID of the application
16
+ * @param {string} authority Authority used by the application
17
+ * @param {Logger} logger Logger used by the application
18
+ * @param {string} libraryName Name of the library
19
+ * @param {string} libraryVersion Version of the library
20
+ */
21
+ constructor(clientId, authority, logger, libraryName, libraryVersion, applicationTelemetry) {
22
+ this.authority = authority;
23
+ this.libraryName = libraryName;
24
+ this.libraryVersion = libraryVersion;
25
+ this.applicationTelemetry = applicationTelemetry;
26
+ this.clientId = clientId;
27
+ this.logger = logger;
28
+ this.callbacks = new Map();
29
+ this.eventsByCorrelationId = new Map();
30
+ this.queueMeasurements = new Map();
31
+ this.preQueueTimeByCorrelationId = new Map();
32
+ }
33
+ /**
34
+ * Starts and returns an platform-specific implementation of IPerformanceMeasurement.
35
+ * Note: this function can be changed to abstract at the next major version bump.
36
+ *
37
+ * @param {string} measureName
38
+ * @param {string} correlationId
39
+ * @returns {IPerformanceMeasurement}
40
+ */
41
+ startPerformanceMeasurement(measureName, // eslint-disable-line @typescript-eslint/no-unused-vars
42
+ correlationId // eslint-disable-line @typescript-eslint/no-unused-vars
43
+ ) {
44
+ return {};
45
+ }
46
+ /**
47
+ * Get integral fields.
48
+ * Override to change the set.
49
+ */
50
+ getIntFields() {
51
+ return IntFields;
52
+ }
53
+ /**
54
+ * Gets map of pre-queue times by correlation Id
55
+ *
56
+ * @param {PerformanceEvents} eventName
57
+ * @param {string} correlationId
58
+ * @returns {number}
59
+ */
60
+ getPreQueueTime(eventName, correlationId) {
61
+ const preQueueEvent = this.preQueueTimeByCorrelationId.get(correlationId);
62
+ if (!preQueueEvent) {
63
+ this.logger.trace(`PerformanceClient.getPreQueueTime: no pre-queue times found for correlationId: ${correlationId}, unable to add queue measurement`);
64
+ return;
65
+ }
66
+ else if (preQueueEvent.name !== eventName) {
67
+ this.logger.trace(`PerformanceClient.getPreQueueTime: no pre-queue time found for ${eventName}, unable to add queue measurement`);
68
+ return;
69
+ }
70
+ return preQueueEvent.time;
71
+ }
72
+ /**
73
+ * Calculates the difference between current time and time when function was queued.
74
+ * Note: It is possible to have 0 as the queue time if the current time and the queued time was the same.
75
+ *
76
+ * @param {number} preQueueTime
77
+ * @param {number} currentTime
78
+ * @returns {number}
79
+ */
80
+ calculateQueuedTime(preQueueTime, currentTime) {
81
+ if (preQueueTime < 1) {
82
+ this.logger.trace(`PerformanceClient: preQueueTime should be a positive integer and not ${preQueueTime}`);
83
+ return 0;
84
+ }
85
+ if (currentTime < 1) {
86
+ this.logger.trace(`PerformanceClient: currentTime should be a positive integer and not ${currentTime}`);
87
+ return 0;
88
+ }
89
+ if (currentTime < preQueueTime) {
90
+ this.logger.trace("PerformanceClient: currentTime is less than preQueueTime, check how time is being retrieved");
91
+ return 0;
92
+ }
93
+ return currentTime - preQueueTime;
94
+ }
95
+ /**
96
+ * Adds queue measurement time to QueueMeasurements array for given correlation ID.
97
+ *
98
+ * @param {PerformanceEvents} eventName
99
+ * @param {?string} correlationId
100
+ * @param {?number} queueTime
101
+ * @param {?boolean} manuallyCompleted - indicator for manually completed queue measurements
102
+ * @returns
103
+ */
104
+ addQueueMeasurement(eventName, correlationId, queueTime, manuallyCompleted) {
105
+ if (!correlationId) {
106
+ this.logger.trace(`PerformanceClient.addQueueMeasurement: correlationId not provided for ${eventName}, cannot add queue measurement`);
107
+ return;
108
+ }
109
+ if (queueTime === 0) {
110
+ // Possible for there to be no queue time after calculation
111
+ this.logger.trace(`PerformanceClient.addQueueMeasurement: queue time provided for ${eventName} is ${queueTime}`);
112
+ }
113
+ else if (!queueTime) {
114
+ this.logger.trace(`PerformanceClient.addQueueMeasurement: no queue time provided for ${eventName}`);
115
+ return;
116
+ }
117
+ const queueMeasurement = {
118
+ eventName,
119
+ queueTime,
120
+ manuallyCompleted,
121
+ };
122
+ // Adds to existing correlation Id if present in queueMeasurements
123
+ const existingMeasurements = this.queueMeasurements.get(correlationId);
124
+ if (existingMeasurements) {
125
+ existingMeasurements.push(queueMeasurement);
126
+ this.queueMeasurements.set(correlationId, existingMeasurements);
127
+ }
128
+ else {
129
+ // Sets new correlation Id if not present in queueMeasurements
130
+ this.logger.trace(`PerformanceClient.addQueueMeasurement: adding correlationId ${correlationId} to queue measurements`);
131
+ const measurementArray = [queueMeasurement];
132
+ this.queueMeasurements.set(correlationId, measurementArray);
133
+ }
134
+ // Delete processed pre-queue event.
135
+ this.preQueueTimeByCorrelationId.delete(correlationId);
136
+ }
137
+ /**
138
+ * Starts measuring performance for a given operation. Returns a function that should be used to end the measurement.
139
+ *
140
+ * @param {PerformanceEvents} measureName
141
+ * @param {?string} [correlationId]
142
+ * @returns {InProgressPerformanceEvent}
143
+ */
144
+ startMeasurement(measureName, correlationId) {
145
+ // Generate a placeholder correlation if the request does not provide one
146
+ const eventCorrelationId = correlationId || this.generateId();
147
+ if (!correlationId) {
148
+ this.logger.info(`PerformanceClient: No correlation id provided for ${measureName}, generating`, eventCorrelationId);
149
+ }
150
+ this.logger.trace(`PerformanceClient: Performance measurement started for ${measureName}`, eventCorrelationId);
151
+ const performanceMeasurement = this.startPerformanceMeasurement(measureName, eventCorrelationId);
152
+ performanceMeasurement.startMeasurement();
153
+ const inProgressEvent = {
154
+ eventId: this.generateId(),
155
+ status: PerformanceEventStatus.InProgress,
156
+ authority: this.authority,
157
+ libraryName: this.libraryName,
158
+ libraryVersion: this.libraryVersion,
159
+ clientId: this.clientId,
160
+ name: measureName,
161
+ startTimeMs: Date.now(),
162
+ correlationId: eventCorrelationId,
163
+ appName: this.applicationTelemetry?.appName,
164
+ appVersion: this.applicationTelemetry?.appVersion,
165
+ };
166
+ // Store in progress events so they can be discarded if not ended properly
167
+ this.cacheEventByCorrelationId(inProgressEvent);
168
+ // Return the event and functions the caller can use to properly end/flush the measurement
169
+ return {
170
+ endMeasurement: (event) => {
171
+ return this.endMeasurement({
172
+ // Initial set of event properties
173
+ ...inProgressEvent,
174
+ // Properties set when event ends
175
+ ...event,
176
+ }, performanceMeasurement);
177
+ },
178
+ discardMeasurement: () => {
179
+ return this.discardMeasurements(inProgressEvent.correlationId);
180
+ },
181
+ addStaticFields: (fields) => {
182
+ return this.addStaticFields(fields, inProgressEvent.correlationId);
183
+ },
184
+ increment: (counters) => {
185
+ return this.increment(counters, inProgressEvent.correlationId);
186
+ },
187
+ measurement: performanceMeasurement,
188
+ event: inProgressEvent,
189
+ };
190
+ }
191
+ /**
192
+ * Stops measuring the performance for an operation. Should only be called directly by PerformanceClient classes,
193
+ * as consumers should instead use the function returned by startMeasurement.
194
+ * Adds a new field named as "[event name]DurationMs" for sub-measurements, completes and emits an event
195
+ * otherwise.
196
+ *
197
+ * @param {PerformanceEvent} event
198
+ * @param {IPerformanceMeasurement} measurement
199
+ * @returns {(PerformanceEvent | null)}
200
+ */
201
+ endMeasurement(event, measurement) {
202
+ const rootEvent = this.eventsByCorrelationId.get(event.correlationId);
203
+ if (!rootEvent) {
204
+ this.logger.trace(`PerformanceClient: Measurement not found for ${event.eventId}`, event.correlationId);
205
+ return null;
206
+ }
207
+ const isRoot = event.eventId === rootEvent.eventId;
208
+ let queueInfo = {
209
+ totalQueueTime: 0,
210
+ totalQueueCount: 0,
211
+ manuallyCompletedCount: 0,
212
+ };
213
+ if (isRoot) {
214
+ queueInfo = this.getQueueInfo(event.correlationId);
215
+ this.discardCache(rootEvent.correlationId);
216
+ }
217
+ else {
218
+ rootEvent.incompleteSubMeasurements?.delete(event.eventId);
219
+ }
220
+ measurement?.endMeasurement();
221
+ const durationMs = measurement?.flushMeasurement();
222
+ // null indicates no measurement was taken (e.g. needed performance APIs not present)
223
+ if (!durationMs) {
224
+ this.logger.trace("PerformanceClient: Performance measurement not taken", rootEvent.correlationId);
225
+ return null;
226
+ }
227
+ this.logger.trace(`PerformanceClient: Performance measurement ended for ${event.name}: ${durationMs} ms`, event.correlationId);
228
+ // Add sub-measurement attribute to root event.
229
+ if (!isRoot) {
230
+ rootEvent[event.name + "DurationMs"] = Math.floor(durationMs);
231
+ return { ...rootEvent };
232
+ }
233
+ let finalEvent = { ...rootEvent, ...event };
234
+ let incompleteSubsCount = 0;
235
+ // Incomplete sub-measurements are discarded. They are likely an instrumentation bug that should be fixed.
236
+ finalEvent.incompleteSubMeasurements?.forEach((subMeasurement) => {
237
+ this.logger.trace(`PerformanceClient: Incomplete submeasurement ${subMeasurement.name} found for ${event.name}`, finalEvent.correlationId);
238
+ incompleteSubsCount++;
239
+ });
240
+ finalEvent.incompleteSubMeasurements = undefined;
241
+ finalEvent = {
242
+ ...finalEvent,
243
+ durationMs: Math.round(durationMs),
244
+ queuedTimeMs: queueInfo.totalQueueTime,
245
+ queuedCount: queueInfo.totalQueueCount,
246
+ queuedManuallyCompletedCount: queueInfo.manuallyCompletedCount,
247
+ status: PerformanceEventStatus.Completed,
248
+ incompleteSubsCount,
249
+ };
250
+ this.truncateIntegralFields(finalEvent, this.getIntFields());
251
+ this.emitEvents([finalEvent], event.correlationId);
252
+ return finalEvent;
253
+ }
254
+ /**
255
+ * Saves extra information to be emitted when the measurements are flushed
256
+ * @param fields
257
+ * @param correlationId
258
+ */
259
+ addStaticFields(fields, correlationId) {
260
+ this.logger.trace("PerformanceClient: Updating static fields");
261
+ const event = this.eventsByCorrelationId.get(correlationId);
262
+ if (event) {
263
+ this.eventsByCorrelationId.set(correlationId, {
264
+ ...event,
265
+ ...fields,
266
+ });
267
+ }
268
+ else {
269
+ this.logger.trace("PerformanceClient: Event not found for", correlationId);
270
+ }
271
+ }
272
+ /**
273
+ * Increment counters to be emitted when the measurements are flushed
274
+ * @param counters {Counters}
275
+ * @param correlationId {string} correlation identifier
276
+ */
277
+ increment(counters, correlationId) {
278
+ this.logger.trace("PerformanceClient: Updating counters");
279
+ const event = this.eventsByCorrelationId.get(correlationId);
280
+ if (event) {
281
+ for (const counter in counters) {
282
+ if (!event.hasOwnProperty(counter)) {
283
+ event[counter] = 0;
284
+ }
285
+ event[counter] += counters[counter];
286
+ }
287
+ }
288
+ else {
289
+ this.logger.trace("PerformanceClient: Event not found for", correlationId);
290
+ }
291
+ }
292
+ /**
293
+ * Upserts event into event cache.
294
+ * First key is the correlation id, second key is the event id.
295
+ * Allows for events to be grouped by correlation id,
296
+ * and to easily allow for properties on them to be updated.
297
+ *
298
+ * @private
299
+ * @param {PerformanceEvent} event
300
+ */
301
+ cacheEventByCorrelationId(event) {
302
+ const rootEvent = this.eventsByCorrelationId.get(event.correlationId);
303
+ if (rootEvent) {
304
+ this.logger.trace(`PerformanceClient: Performance measurement for ${event.name} added/updated`, event.correlationId);
305
+ rootEvent.incompleteSubMeasurements =
306
+ rootEvent.incompleteSubMeasurements || new Map();
307
+ rootEvent.incompleteSubMeasurements.set(event.eventId, {
308
+ name: event.name,
309
+ startTimeMs: event.startTimeMs,
310
+ });
311
+ }
312
+ else {
313
+ this.logger.trace(`PerformanceClient: Performance measurement for ${event.name} started`, event.correlationId);
314
+ this.eventsByCorrelationId.set(event.correlationId, { ...event });
315
+ }
316
+ }
317
+ getQueueInfo(correlationId) {
318
+ const queueMeasurementForCorrelationId = this.queueMeasurements.get(correlationId);
319
+ if (!queueMeasurementForCorrelationId) {
320
+ this.logger.trace(`PerformanceClient: no queue measurements found for for correlationId: ${correlationId}`);
321
+ }
322
+ let totalQueueTime = 0;
323
+ let totalQueueCount = 0;
324
+ let manuallyCompletedCount = 0;
325
+ queueMeasurementForCorrelationId?.forEach((measurement) => {
326
+ totalQueueTime += measurement.queueTime;
327
+ totalQueueCount++;
328
+ manuallyCompletedCount += measurement.manuallyCompleted ? 1 : 0;
329
+ });
330
+ return {
331
+ totalQueueTime,
332
+ totalQueueCount,
333
+ manuallyCompletedCount,
334
+ };
335
+ }
336
+ /**
337
+ * Removes measurements for a given correlation id.
338
+ *
339
+ * @param {string} correlationId
340
+ */
341
+ discardMeasurements(correlationId) {
342
+ this.logger.trace("PerformanceClient: Performance measurements discarded", correlationId);
343
+ this.eventsByCorrelationId.delete(correlationId);
344
+ }
345
+ /**
346
+ * Removes cache for a given correlation id.
347
+ *
348
+ * @param {string} correlationId correlation identifier
349
+ */
350
+ discardCache(correlationId) {
351
+ this.discardMeasurements(correlationId);
352
+ this.logger.trace("PerformanceClient: QueueMeasurements discarded", correlationId);
353
+ this.queueMeasurements.delete(correlationId);
354
+ this.logger.trace("PerformanceClient: Pre-queue times discarded", correlationId);
355
+ this.preQueueTimeByCorrelationId.delete(correlationId);
356
+ }
357
+ /**
358
+ * Registers a callback function to receive performance events.
359
+ *
360
+ * @param {PerformanceCallbackFunction} callback
361
+ * @returns {string}
362
+ */
363
+ addPerformanceCallback(callback) {
364
+ const callbackId = this.generateId();
365
+ this.callbacks.set(callbackId, callback);
366
+ this.logger.verbose(`PerformanceClient: Performance callback registered with id: ${callbackId}`);
367
+ return callbackId;
368
+ }
369
+ /**
370
+ * Removes a callback registered with addPerformanceCallback.
371
+ *
372
+ * @param {string} callbackId
373
+ * @returns {boolean}
374
+ */
375
+ removePerformanceCallback(callbackId) {
376
+ const result = this.callbacks.delete(callbackId);
377
+ if (result) {
378
+ this.logger.verbose(`PerformanceClient: Performance callback ${callbackId} removed.`);
379
+ }
380
+ else {
381
+ this.logger.verbose(`PerformanceClient: Performance callback ${callbackId} not removed.`);
382
+ }
383
+ return result;
384
+ }
385
+ /**
386
+ * Emits events to all registered callbacks.
387
+ *
388
+ * @param {PerformanceEvent[]} events
389
+ * @param {?string} [correlationId]
390
+ */
391
+ emitEvents(events, correlationId) {
392
+ this.logger.verbose("PerformanceClient: Emitting performance events", correlationId);
393
+ this.callbacks.forEach((callback, callbackId) => {
394
+ this.logger.trace(`PerformanceClient: Emitting event to callback ${callbackId}`, correlationId);
395
+ callback.apply(null, [events]);
396
+ });
397
+ }
398
+ /**
399
+ * Enforce truncation of integral fields in performance event.
400
+ * @param {PerformanceEvent} event performance event to update.
401
+ * @param {Set<string>} intFields integral fields.
402
+ */
403
+ truncateIntegralFields(event, intFields) {
404
+ intFields.forEach((key) => {
405
+ if (key in event && typeof event[key] === "number") {
406
+ event[key] = Math.floor(event[key]);
407
+ }
408
+ });
409
+ }
410
410
  }
411
411
 
412
412
  export { PerformanceClient };