@azure/msal-common 14.4.0 → 14.4.1-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 (199) hide show
  1. package/dist/account/AccountInfo.d.ts +31 -31
  2. package/dist/account/AuthToken.d.ts +17 -17
  3. package/dist/account/AuthToken.mjs +58 -58
  4. package/dist/account/CcsCredential.d.ts +9 -9
  5. package/dist/account/CcsCredential.mjs +8 -8
  6. package/dist/account/ClientCredentials.d.ts +14 -14
  7. package/dist/account/ClientInfo.d.ts +19 -19
  8. package/dist/account/ClientInfo.mjs +37 -37
  9. package/dist/account/TokenClaims.d.ts +65 -65
  10. package/dist/authority/Authority.d.ts +249 -249
  11. package/dist/authority/Authority.mjs +788 -788
  12. package/dist/authority/AuthorityFactory.d.ts +31 -31
  13. package/dist/authority/AuthorityFactory.mjs +47 -47
  14. package/dist/authority/AuthorityMetadata.d.ts +503 -503
  15. package/dist/authority/AuthorityMetadata.mjs +603 -603
  16. package/dist/authority/AuthorityOptions.d.ts +27 -27
  17. package/dist/authority/AuthorityOptions.mjs +18 -18
  18. package/dist/authority/AuthorityType.d.ts +10 -10
  19. package/dist/authority/AuthorityType.mjs +13 -13
  20. package/dist/authority/AzureRegion.d.ts +1 -1
  21. package/dist/authority/AzureRegionConfiguration.d.ts +5 -5
  22. package/dist/authority/CloudDiscoveryMetadata.d.ts +5 -5
  23. package/dist/authority/CloudInstanceDiscoveryErrorResponse.d.ts +13 -13
  24. package/dist/authority/CloudInstanceDiscoveryErrorResponse.mjs +8 -8
  25. package/dist/authority/CloudInstanceDiscoveryResponse.d.ts +9 -9
  26. package/dist/authority/CloudInstanceDiscoveryResponse.mjs +8 -8
  27. package/dist/authority/ImdsOptions.d.ts +5 -5
  28. package/dist/authority/OIDCOptions.d.ts +8 -8
  29. package/dist/authority/OpenIdConfigResponse.d.ts +11 -11
  30. package/dist/authority/OpenIdConfigResponse.mjs +10 -10
  31. package/dist/authority/ProtocolMode.d.ts +8 -8
  32. package/dist/authority/ProtocolMode.mjs +11 -11
  33. package/dist/authority/RegionDiscovery.d.ts +32 -32
  34. package/dist/authority/RegionDiscovery.mjs +106 -106
  35. package/dist/authority/RegionDiscoveryMetadata.d.ts +6 -6
  36. package/dist/broker/nativeBroker/INativeBrokerPlugin.d.ts +15 -15
  37. package/dist/cache/CacheManager.d.ts +485 -485
  38. package/dist/cache/CacheManager.mjs +1102 -1102
  39. package/dist/cache/entities/AccessTokenEntity.d.ts +25 -25
  40. package/dist/cache/entities/AccountEntity.d.ts +101 -101
  41. package/dist/cache/entities/AccountEntity.mjs +218 -218
  42. package/dist/cache/entities/AppMetadataEntity.d.ts +39 -39
  43. package/dist/cache/entities/AppMetadataEntity.mjs +66 -66
  44. package/dist/cache/entities/AuthorityMetadataEntity.d.ts +48 -48
  45. package/dist/cache/entities/AuthorityMetadataEntity.mjs +78 -78
  46. package/dist/cache/entities/CacheRecord.d.ts +14 -14
  47. package/dist/cache/entities/CacheRecord.mjs +14 -14
  48. package/dist/cache/entities/CredentialEntity.d.ts +30 -30
  49. package/dist/cache/entities/IdTokenEntity.d.ts +8 -8
  50. package/dist/cache/entities/RefreshTokenEntity.d.ts +7 -5
  51. package/dist/cache/entities/RefreshTokenEntity.d.ts.map +1 -1
  52. package/dist/cache/entities/ServerTelemetryEntity.d.ts +5 -5
  53. package/dist/cache/entities/ThrottlingEntity.d.ts +13 -13
  54. package/dist/cache/entities/ThrottlingEntity.mjs +23 -23
  55. package/dist/cache/interface/ICacheManager.d.ts +166 -166
  56. package/dist/cache/interface/ICachePlugin.d.ts +5 -5
  57. package/dist/cache/interface/ISerializableTokenCache.d.ts +4 -4
  58. package/dist/cache/persistence/TokenCacheContext.d.ts +23 -23
  59. package/dist/cache/persistence/TokenCacheContext.mjs +25 -25
  60. package/dist/cache/utils/CacheHelpers.d.ts +64 -64
  61. package/dist/cache/utils/CacheHelpers.d.ts.map +1 -1
  62. package/dist/cache/utils/CacheHelpers.mjs +234 -231
  63. package/dist/cache/utils/CacheHelpers.mjs.map +1 -1
  64. package/dist/cache/utils/CacheTypes.d.ts +67 -67
  65. package/dist/client/AuthorizationCodeClient.d.ts +74 -74
  66. package/dist/client/AuthorizationCodeClient.d.ts.map +1 -1
  67. package/dist/client/AuthorizationCodeClient.mjs +402 -402
  68. package/dist/client/AuthorizationCodeClient.mjs.map +1 -1
  69. package/dist/client/BaseClient.d.ts +51 -51
  70. package/dist/client/BaseClient.mjs +100 -100
  71. package/dist/client/RefreshTokenClient.d.ts +35 -35
  72. package/dist/client/RefreshTokenClient.d.ts.map +1 -1
  73. package/dist/client/RefreshTokenClient.mjs +193 -187
  74. package/dist/client/RefreshTokenClient.mjs.map +1 -1
  75. package/dist/client/SilentFlowClient.d.ts +27 -27
  76. package/dist/client/SilentFlowClient.mjs +118 -118
  77. package/dist/config/AppTokenProvider.d.ts +38 -38
  78. package/dist/config/ClientConfiguration.d.ts +150 -150
  79. package/dist/config/ClientConfiguration.mjs +97 -97
  80. package/dist/crypto/ICrypto.d.ts +58 -58
  81. package/dist/crypto/ICrypto.mjs +30 -30
  82. package/dist/crypto/IGuidGenerator.d.ts +4 -4
  83. package/dist/crypto/JoseHeader.d.ts +22 -22
  84. package/dist/crypto/JoseHeader.mjs +37 -37
  85. package/dist/crypto/PopTokenGenerator.d.ts +60 -60
  86. package/dist/crypto/PopTokenGenerator.mjs +82 -82
  87. package/dist/crypto/SignedHttpRequest.d.ts +15 -15
  88. package/dist/error/AuthError.d.ts +44 -44
  89. package/dist/error/AuthError.mjs +46 -46
  90. package/dist/error/AuthErrorCodes.d.ts +5 -5
  91. package/dist/error/AuthErrorCodes.mjs +9 -9
  92. package/dist/error/ClientAuthError.d.ts +237 -237
  93. package/dist/error/ClientAuthError.mjs +249 -249
  94. package/dist/error/ClientAuthErrorCodes.d.ts +44 -44
  95. package/dist/error/ClientAuthErrorCodes.mjs +48 -48
  96. package/dist/error/ClientConfigurationError.d.ts +128 -128
  97. package/dist/error/ClientConfigurationError.mjs +135 -135
  98. package/dist/error/ClientConfigurationErrorCodes.d.ts +22 -22
  99. package/dist/error/ClientConfigurationErrorCodes.mjs +26 -26
  100. package/dist/error/InteractionRequiredAuthError.d.ts +57 -57
  101. package/dist/error/InteractionRequiredAuthError.d.ts.map +1 -1
  102. package/dist/error/InteractionRequiredAuthError.mjs +78 -77
  103. package/dist/error/InteractionRequiredAuthError.mjs.map +1 -1
  104. package/dist/error/InteractionRequiredAuthErrorCodes.d.ts +6 -5
  105. package/dist/error/InteractionRequiredAuthErrorCodes.d.ts.map +1 -1
  106. package/dist/error/InteractionRequiredAuthErrorCodes.mjs +13 -12
  107. package/dist/error/InteractionRequiredAuthErrorCodes.mjs.map +1 -1
  108. package/dist/error/JoseHeaderError.d.ts +15 -15
  109. package/dist/error/JoseHeaderError.mjs +22 -22
  110. package/dist/error/JoseHeaderErrorCodes.d.ts +2 -2
  111. package/dist/error/JoseHeaderErrorCodes.mjs +6 -6
  112. package/dist/error/ServerError.d.ts +7 -7
  113. package/dist/error/ServerError.mjs +14 -14
  114. package/dist/index.cjs +8289 -8277
  115. package/dist/index.cjs.map +1 -1
  116. package/dist/index.d.ts +98 -98
  117. package/dist/index.mjs +1 -1
  118. package/dist/logger/Logger.d.ts +95 -95
  119. package/dist/logger/Logger.mjs +188 -188
  120. package/dist/network/INetworkModule.d.ts +29 -29
  121. package/dist/network/INetworkModule.mjs +12 -12
  122. package/dist/network/NetworkManager.d.ts +33 -33
  123. package/dist/network/NetworkManager.mjs +34 -34
  124. package/dist/network/RequestThumbprint.d.ts +18 -18
  125. package/dist/network/ThrottlingUtils.d.ts +42 -42
  126. package/dist/network/ThrottlingUtils.mjs +95 -95
  127. package/dist/packageMetadata.d.ts +2 -2
  128. package/dist/packageMetadata.mjs +3 -3
  129. package/dist/request/AuthenticationHeaderParser.d.ts +19 -19
  130. package/dist/request/AuthenticationHeaderParser.mjs +55 -55
  131. package/dist/request/BaseAuthRequest.d.ts +43 -43
  132. package/dist/request/CommonAuthorizationCodeRequest.d.ts +27 -27
  133. package/dist/request/CommonAuthorizationUrlRequest.d.ts +50 -50
  134. package/dist/request/CommonClientCredentialRequest.d.ts +17 -17
  135. package/dist/request/CommonDeviceCodeRequest.d.ts +21 -21
  136. package/dist/request/CommonEndSessionRequest.d.ts +21 -21
  137. package/dist/request/CommonOnBehalfOfRequest.d.ts +13 -13
  138. package/dist/request/CommonRefreshTokenRequest.d.ts +23 -22
  139. package/dist/request/CommonRefreshTokenRequest.d.ts.map +1 -1
  140. package/dist/request/CommonSilentFlowRequest.d.ts +21 -20
  141. package/dist/request/CommonSilentFlowRequest.d.ts.map +1 -1
  142. package/dist/request/CommonUsernamePasswordRequest.d.ts +17 -17
  143. package/dist/request/NativeRequest.d.ts +19 -19
  144. package/dist/request/NativeSignOutRequest.d.ts +5 -5
  145. package/dist/request/RequestParameterBuilder.d.ts +217 -217
  146. package/dist/request/RequestParameterBuilder.mjs +381 -381
  147. package/dist/request/RequestValidator.d.ts +33 -33
  148. package/dist/request/RequestValidator.mjs +81 -81
  149. package/dist/request/ScopeSet.d.ts +88 -88
  150. package/dist/request/ScopeSet.mjs +197 -197
  151. package/dist/request/StoreInCache.d.ts +8 -8
  152. package/dist/response/AuthenticationResult.d.ts +41 -41
  153. package/dist/response/AuthorizationCodePayload.d.ts +13 -13
  154. package/dist/response/DeviceCodeResponse.d.ts +25 -25
  155. package/dist/response/ExternalTokenResponse.d.ts +15 -15
  156. package/dist/response/IMDSBadResponse.d.ts +4 -4
  157. package/dist/response/ResponseHandler.d.ts +67 -67
  158. package/dist/response/ResponseHandler.d.ts.map +1 -1
  159. package/dist/response/ResponseHandler.mjs +312 -312
  160. package/dist/response/ResponseHandler.mjs.map +1 -1
  161. package/dist/response/ServerAuthorizationCodeResponse.d.ts +25 -25
  162. package/dist/response/ServerAuthorizationTokenResponse.d.ts +46 -46
  163. package/dist/telemetry/performance/IPerformanceClient.d.ts +51 -51
  164. package/dist/telemetry/performance/IPerformanceMeasurement.d.ts +5 -5
  165. package/dist/telemetry/performance/PerformanceClient.d.ts +191 -191
  166. package/dist/telemetry/performance/PerformanceClient.mjs +409 -409
  167. package/dist/telemetry/performance/PerformanceEvent.d.ts +464 -464
  168. package/dist/telemetry/performance/PerformanceEvent.mjs +253 -253
  169. package/dist/telemetry/performance/StubPerformanceClient.d.ts +24 -24
  170. package/dist/telemetry/performance/StubPerformanceClient.mjs +76 -76
  171. package/dist/telemetry/server/ServerTelemetryManager.d.ts +66 -66
  172. package/dist/telemetry/server/ServerTelemetryManager.mjs +201 -201
  173. package/dist/telemetry/server/ServerTelemetryRequest.d.ts +8 -8
  174. package/dist/url/IUri.d.ts +12 -12
  175. package/dist/url/UrlString.d.ts +48 -48
  176. package/dist/url/UrlString.mjs +161 -161
  177. package/dist/utils/Constants.d.ts +365 -365
  178. package/dist/utils/Constants.mjs +375 -375
  179. package/dist/utils/FunctionWrappers.d.ts +27 -27
  180. package/dist/utils/FunctionWrappers.mjs +84 -84
  181. package/dist/utils/MsalTypes.d.ts +6 -6
  182. package/dist/utils/ProtocolUtils.d.ts +42 -42
  183. package/dist/utils/ProtocolUtils.mjs +69 -69
  184. package/dist/utils/StringUtils.d.ts +40 -40
  185. package/dist/utils/StringUtils.mjs +95 -95
  186. package/dist/utils/TimeUtils.d.ts +27 -27
  187. package/dist/utils/TimeUtils.mjs +45 -45
  188. package/dist/utils/UrlUtils.d.ts +10 -10
  189. package/dist/utils/UrlUtils.mjs +44 -44
  190. package/package.json +92 -92
  191. package/src/cache/entities/RefreshTokenEntity.ts +3 -1
  192. package/src/cache/utils/CacheHelpers.ts +6 -1
  193. package/src/client/AuthorizationCodeClient.ts +2 -1
  194. package/src/client/RefreshTokenClient.ts +13 -1
  195. package/src/error/InteractionRequiredAuthError.ts +2 -0
  196. package/src/error/InteractionRequiredAuthErrorCodes.ts +1 -0
  197. package/src/request/CommonRefreshTokenRequest.ts +1 -0
  198. package/src/request/CommonSilentFlowRequest.ts +1 -0
  199. package/src/response/ResponseHandler.ts +8 -4
@@ -1,415 +1,415 @@
1
- /*! @azure/msal-common v14.4.0 2023-11-07 */
1
+ /*! @azure/msal-common v14.4.1-beta.0 2023-11-14 */
2
2
  'use strict';
3
3
  import { IntFields, PerformanceEventStatus } from './PerformanceEvent.mjs';
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
- * @param {ApplicationTelemetry} applicationTelemetry application name and version
21
- * @param {Set<String>} intFields integer fields to be truncated
22
- */
23
- constructor(clientId, authority, logger, libraryName, libraryVersion, applicationTelemetry, intFields) {
24
- this.authority = authority;
25
- this.libraryName = libraryName;
26
- this.libraryVersion = libraryVersion;
27
- this.applicationTelemetry = applicationTelemetry;
28
- this.clientId = clientId;
29
- this.logger = logger;
30
- this.callbacks = new Map();
31
- this.eventsByCorrelationId = new Map();
32
- this.queueMeasurements = new Map();
33
- this.preQueueTimeByCorrelationId = new Map();
34
- this.intFields = intFields || new Set();
35
- for (const item of IntFields) {
36
- this.intFields.add(item);
37
- }
38
- }
39
- /**
40
- * Starts and returns an platform-specific implementation of IPerformanceMeasurement.
41
- * Note: this function can be changed to abstract at the next major version bump.
42
- *
43
- * @param {string} measureName
44
- * @param {string} correlationId
45
- * @returns {IPerformanceMeasurement}
46
- */
47
- startPerformanceMeasurement(measureName, // eslint-disable-line @typescript-eslint/no-unused-vars
48
- correlationId // eslint-disable-line @typescript-eslint/no-unused-vars
49
- ) {
50
- return {};
51
- }
52
- /**
53
- * Gets map of pre-queue times by correlation Id
54
- *
55
- * @param {PerformanceEvents} eventName
56
- * @param {string} correlationId
57
- * @returns {number}
58
- */
59
- getPreQueueTime(eventName, correlationId) {
60
- const preQueueEvent = this.preQueueTimeByCorrelationId.get(correlationId);
61
- if (!preQueueEvent) {
62
- this.logger.trace(`PerformanceClient.getPreQueueTime: no pre-queue times found for correlationId: ${correlationId}, unable to add queue measurement`);
63
- return;
64
- }
65
- else if (preQueueEvent.name !== eventName) {
66
- this.logger.trace(`PerformanceClient.getPreQueueTime: no pre-queue time found for ${eventName}, unable to add queue measurement`);
67
- return;
68
- }
69
- return preQueueEvent.time;
70
- }
71
- /**
72
- * Calculates the difference between current time and time when function was queued.
73
- * Note: It is possible to have 0 as the queue time if the current time and the queued time was the same.
74
- *
75
- * @param {number} preQueueTime
76
- * @param {number} currentTime
77
- * @returns {number}
78
- */
79
- calculateQueuedTime(preQueueTime, currentTime) {
80
- if (preQueueTime < 1) {
81
- this.logger.trace(`PerformanceClient: preQueueTime should be a positive integer and not ${preQueueTime}`);
82
- return 0;
83
- }
84
- if (currentTime < 1) {
85
- this.logger.trace(`PerformanceClient: currentTime should be a positive integer and not ${currentTime}`);
86
- return 0;
87
- }
88
- if (currentTime < preQueueTime) {
89
- this.logger.trace("PerformanceClient: currentTime is less than preQueueTime, check how time is being retrieved");
90
- return 0;
91
- }
92
- return currentTime - preQueueTime;
93
- }
94
- /**
95
- * Adds queue measurement time to QueueMeasurements array for given correlation ID.
96
- *
97
- * @param {PerformanceEvents} eventName
98
- * @param {?string} correlationId
99
- * @param {?number} queueTime
100
- * @param {?boolean} manuallyCompleted - indicator for manually completed queue measurements
101
- * @returns
102
- */
103
- addQueueMeasurement(eventName, correlationId, queueTime, manuallyCompleted) {
104
- if (!correlationId) {
105
- this.logger.trace(`PerformanceClient.addQueueMeasurement: correlationId not provided for ${eventName}, cannot add queue measurement`);
106
- return;
107
- }
108
- if (queueTime === 0) {
109
- // Possible for there to be no queue time after calculation
110
- this.logger.trace(`PerformanceClient.addQueueMeasurement: queue time provided for ${eventName} is ${queueTime}`);
111
- }
112
- else if (!queueTime) {
113
- this.logger.trace(`PerformanceClient.addQueueMeasurement: no queue time provided for ${eventName}`);
114
- return;
115
- }
116
- const queueMeasurement = {
117
- eventName,
118
- // Always default queue time to 0 for manually completed (improperly instrumented)
119
- queueTime: manuallyCompleted ? 0 : 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
- end: (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
- discard: () => {
179
- return this.discardMeasurements(inProgressEvent.correlationId);
180
- },
181
- add: (fields) => {
182
- return this.addFields(fields, inProgressEvent.correlationId);
183
- },
184
- increment: (fields) => {
185
- return this.incrementFields(fields, 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);
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
- addFields(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 fields {string[]}
275
- * @param correlationId {string} correlation identifier
276
- */
277
- incrementFields(fields, correlationId) {
278
- this.logger.trace("PerformanceClient: Updating counters");
279
- const event = this.eventsByCorrelationId.get(correlationId);
280
- if (event) {
281
- for (const counter in fields) {
282
- if (!event.hasOwnProperty(counter)) {
283
- event[counter] = 0;
284
- }
285
- else if (isNaN(Number(event[counter]))) {
286
- return;
287
- }
288
- event[counter] += fields[counter];
289
- }
290
- }
291
- else {
292
- this.logger.trace("PerformanceClient: Event not found for", correlationId);
293
- }
294
- }
295
- /**
296
- * Upserts event into event cache.
297
- * First key is the correlation id, second key is the event id.
298
- * Allows for events to be grouped by correlation id,
299
- * and to easily allow for properties on them to be updated.
300
- *
301
- * @private
302
- * @param {PerformanceEvent} event
303
- */
304
- cacheEventByCorrelationId(event) {
305
- const rootEvent = this.eventsByCorrelationId.get(event.correlationId);
306
- if (rootEvent) {
307
- this.logger.trace(`PerformanceClient: Performance measurement for ${event.name} added/updated`, event.correlationId);
308
- rootEvent.incompleteSubMeasurements =
309
- rootEvent.incompleteSubMeasurements || new Map();
310
- rootEvent.incompleteSubMeasurements.set(event.eventId, {
311
- name: event.name,
312
- startTimeMs: event.startTimeMs,
313
- });
314
- }
315
- else {
316
- this.logger.trace(`PerformanceClient: Performance measurement for ${event.name} started`, event.correlationId);
317
- this.eventsByCorrelationId.set(event.correlationId, { ...event });
318
- }
319
- }
320
- getQueueInfo(correlationId) {
321
- const queueMeasurementForCorrelationId = this.queueMeasurements.get(correlationId);
322
- if (!queueMeasurementForCorrelationId) {
323
- this.logger.trace(`PerformanceClient: no queue measurements found for for correlationId: ${correlationId}`);
324
- }
325
- let totalQueueTime = 0;
326
- let totalQueueCount = 0;
327
- let manuallyCompletedCount = 0;
328
- queueMeasurementForCorrelationId?.forEach((measurement) => {
329
- totalQueueTime += measurement.queueTime;
330
- totalQueueCount++;
331
- manuallyCompletedCount += measurement.manuallyCompleted ? 1 : 0;
332
- });
333
- return {
334
- totalQueueTime,
335
- totalQueueCount,
336
- manuallyCompletedCount,
337
- };
338
- }
339
- /**
340
- * Removes measurements for a given correlation id.
341
- *
342
- * @param {string} correlationId
343
- */
344
- discardMeasurements(correlationId) {
345
- this.logger.trace("PerformanceClient: Performance measurements discarded", correlationId);
346
- this.eventsByCorrelationId.delete(correlationId);
347
- }
348
- /**
349
- * Removes cache for a given correlation id.
350
- *
351
- * @param {string} correlationId correlation identifier
352
- */
353
- discardCache(correlationId) {
354
- this.discardMeasurements(correlationId);
355
- this.logger.trace("PerformanceClient: QueueMeasurements discarded", correlationId);
356
- this.queueMeasurements.delete(correlationId);
357
- this.logger.trace("PerformanceClient: Pre-queue times discarded", correlationId);
358
- this.preQueueTimeByCorrelationId.delete(correlationId);
359
- }
360
- /**
361
- * Registers a callback function to receive performance events.
362
- *
363
- * @param {PerformanceCallbackFunction} callback
364
- * @returns {string}
365
- */
366
- addPerformanceCallback(callback) {
367
- const callbackId = this.generateId();
368
- this.callbacks.set(callbackId, callback);
369
- this.logger.verbose(`PerformanceClient: Performance callback registered with id: ${callbackId}`);
370
- return callbackId;
371
- }
372
- /**
373
- * Removes a callback registered with addPerformanceCallback.
374
- *
375
- * @param {string} callbackId
376
- * @returns {boolean}
377
- */
378
- removePerformanceCallback(callbackId) {
379
- const result = this.callbacks.delete(callbackId);
380
- if (result) {
381
- this.logger.verbose(`PerformanceClient: Performance callback ${callbackId} removed.`);
382
- }
383
- else {
384
- this.logger.verbose(`PerformanceClient: Performance callback ${callbackId} not removed.`);
385
- }
386
- return result;
387
- }
388
- /**
389
- * Emits events to all registered callbacks.
390
- *
391
- * @param {PerformanceEvent[]} events
392
- * @param {?string} [correlationId]
393
- */
394
- emitEvents(events, correlationId) {
395
- this.logger.verbose("PerformanceClient: Emitting performance events", correlationId);
396
- this.callbacks.forEach((callback, callbackId) => {
397
- this.logger.trace(`PerformanceClient: Emitting event to callback ${callbackId}`, correlationId);
398
- callback.apply(null, [events]);
399
- });
400
- }
401
- /**
402
- * Enforce truncation of integral fields in performance event.
403
- * @param {PerformanceEvent} event performance event to update.
404
- * @param {Set<string>} intFields integral fields.
405
- */
406
- truncateIntegralFields(event) {
407
- this.intFields.forEach((key) => {
408
- if (key in event && typeof event[key] === "number") {
409
- event[key] = Math.floor(event[key]);
410
- }
411
- });
412
- }
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
+ * @param {ApplicationTelemetry} applicationTelemetry application name and version
21
+ * @param {Set<String>} intFields integer fields to be truncated
22
+ */
23
+ constructor(clientId, authority, logger, libraryName, libraryVersion, applicationTelemetry, intFields) {
24
+ this.authority = authority;
25
+ this.libraryName = libraryName;
26
+ this.libraryVersion = libraryVersion;
27
+ this.applicationTelemetry = applicationTelemetry;
28
+ this.clientId = clientId;
29
+ this.logger = logger;
30
+ this.callbacks = new Map();
31
+ this.eventsByCorrelationId = new Map();
32
+ this.queueMeasurements = new Map();
33
+ this.preQueueTimeByCorrelationId = new Map();
34
+ this.intFields = intFields || new Set();
35
+ for (const item of IntFields) {
36
+ this.intFields.add(item);
37
+ }
38
+ }
39
+ /**
40
+ * Starts and returns an platform-specific implementation of IPerformanceMeasurement.
41
+ * Note: this function can be changed to abstract at the next major version bump.
42
+ *
43
+ * @param {string} measureName
44
+ * @param {string} correlationId
45
+ * @returns {IPerformanceMeasurement}
46
+ */
47
+ startPerformanceMeasurement(measureName, // eslint-disable-line @typescript-eslint/no-unused-vars
48
+ correlationId // eslint-disable-line @typescript-eslint/no-unused-vars
49
+ ) {
50
+ return {};
51
+ }
52
+ /**
53
+ * Gets map of pre-queue times by correlation Id
54
+ *
55
+ * @param {PerformanceEvents} eventName
56
+ * @param {string} correlationId
57
+ * @returns {number}
58
+ */
59
+ getPreQueueTime(eventName, correlationId) {
60
+ const preQueueEvent = this.preQueueTimeByCorrelationId.get(correlationId);
61
+ if (!preQueueEvent) {
62
+ this.logger.trace(`PerformanceClient.getPreQueueTime: no pre-queue times found for correlationId: ${correlationId}, unable to add queue measurement`);
63
+ return;
64
+ }
65
+ else if (preQueueEvent.name !== eventName) {
66
+ this.logger.trace(`PerformanceClient.getPreQueueTime: no pre-queue time found for ${eventName}, unable to add queue measurement`);
67
+ return;
68
+ }
69
+ return preQueueEvent.time;
70
+ }
71
+ /**
72
+ * Calculates the difference between current time and time when function was queued.
73
+ * Note: It is possible to have 0 as the queue time if the current time and the queued time was the same.
74
+ *
75
+ * @param {number} preQueueTime
76
+ * @param {number} currentTime
77
+ * @returns {number}
78
+ */
79
+ calculateQueuedTime(preQueueTime, currentTime) {
80
+ if (preQueueTime < 1) {
81
+ this.logger.trace(`PerformanceClient: preQueueTime should be a positive integer and not ${preQueueTime}`);
82
+ return 0;
83
+ }
84
+ if (currentTime < 1) {
85
+ this.logger.trace(`PerformanceClient: currentTime should be a positive integer and not ${currentTime}`);
86
+ return 0;
87
+ }
88
+ if (currentTime < preQueueTime) {
89
+ this.logger.trace("PerformanceClient: currentTime is less than preQueueTime, check how time is being retrieved");
90
+ return 0;
91
+ }
92
+ return currentTime - preQueueTime;
93
+ }
94
+ /**
95
+ * Adds queue measurement time to QueueMeasurements array for given correlation ID.
96
+ *
97
+ * @param {PerformanceEvents} eventName
98
+ * @param {?string} correlationId
99
+ * @param {?number} queueTime
100
+ * @param {?boolean} manuallyCompleted - indicator for manually completed queue measurements
101
+ * @returns
102
+ */
103
+ addQueueMeasurement(eventName, correlationId, queueTime, manuallyCompleted) {
104
+ if (!correlationId) {
105
+ this.logger.trace(`PerformanceClient.addQueueMeasurement: correlationId not provided for ${eventName}, cannot add queue measurement`);
106
+ return;
107
+ }
108
+ if (queueTime === 0) {
109
+ // Possible for there to be no queue time after calculation
110
+ this.logger.trace(`PerformanceClient.addQueueMeasurement: queue time provided for ${eventName} is ${queueTime}`);
111
+ }
112
+ else if (!queueTime) {
113
+ this.logger.trace(`PerformanceClient.addQueueMeasurement: no queue time provided for ${eventName}`);
114
+ return;
115
+ }
116
+ const queueMeasurement = {
117
+ eventName,
118
+ // Always default queue time to 0 for manually completed (improperly instrumented)
119
+ queueTime: manuallyCompleted ? 0 : 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
+ end: (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
+ discard: () => {
179
+ return this.discardMeasurements(inProgressEvent.correlationId);
180
+ },
181
+ add: (fields) => {
182
+ return this.addFields(fields, inProgressEvent.correlationId);
183
+ },
184
+ increment: (fields) => {
185
+ return this.incrementFields(fields, 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);
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
+ addFields(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 fields {string[]}
275
+ * @param correlationId {string} correlation identifier
276
+ */
277
+ incrementFields(fields, correlationId) {
278
+ this.logger.trace("PerformanceClient: Updating counters");
279
+ const event = this.eventsByCorrelationId.get(correlationId);
280
+ if (event) {
281
+ for (const counter in fields) {
282
+ if (!event.hasOwnProperty(counter)) {
283
+ event[counter] = 0;
284
+ }
285
+ else if (isNaN(Number(event[counter]))) {
286
+ return;
287
+ }
288
+ event[counter] += fields[counter];
289
+ }
290
+ }
291
+ else {
292
+ this.logger.trace("PerformanceClient: Event not found for", correlationId);
293
+ }
294
+ }
295
+ /**
296
+ * Upserts event into event cache.
297
+ * First key is the correlation id, second key is the event id.
298
+ * Allows for events to be grouped by correlation id,
299
+ * and to easily allow for properties on them to be updated.
300
+ *
301
+ * @private
302
+ * @param {PerformanceEvent} event
303
+ */
304
+ cacheEventByCorrelationId(event) {
305
+ const rootEvent = this.eventsByCorrelationId.get(event.correlationId);
306
+ if (rootEvent) {
307
+ this.logger.trace(`PerformanceClient: Performance measurement for ${event.name} added/updated`, event.correlationId);
308
+ rootEvent.incompleteSubMeasurements =
309
+ rootEvent.incompleteSubMeasurements || new Map();
310
+ rootEvent.incompleteSubMeasurements.set(event.eventId, {
311
+ name: event.name,
312
+ startTimeMs: event.startTimeMs,
313
+ });
314
+ }
315
+ else {
316
+ this.logger.trace(`PerformanceClient: Performance measurement for ${event.name} started`, event.correlationId);
317
+ this.eventsByCorrelationId.set(event.correlationId, { ...event });
318
+ }
319
+ }
320
+ getQueueInfo(correlationId) {
321
+ const queueMeasurementForCorrelationId = this.queueMeasurements.get(correlationId);
322
+ if (!queueMeasurementForCorrelationId) {
323
+ this.logger.trace(`PerformanceClient: no queue measurements found for for correlationId: ${correlationId}`);
324
+ }
325
+ let totalQueueTime = 0;
326
+ let totalQueueCount = 0;
327
+ let manuallyCompletedCount = 0;
328
+ queueMeasurementForCorrelationId?.forEach((measurement) => {
329
+ totalQueueTime += measurement.queueTime;
330
+ totalQueueCount++;
331
+ manuallyCompletedCount += measurement.manuallyCompleted ? 1 : 0;
332
+ });
333
+ return {
334
+ totalQueueTime,
335
+ totalQueueCount,
336
+ manuallyCompletedCount,
337
+ };
338
+ }
339
+ /**
340
+ * Removes measurements for a given correlation id.
341
+ *
342
+ * @param {string} correlationId
343
+ */
344
+ discardMeasurements(correlationId) {
345
+ this.logger.trace("PerformanceClient: Performance measurements discarded", correlationId);
346
+ this.eventsByCorrelationId.delete(correlationId);
347
+ }
348
+ /**
349
+ * Removes cache for a given correlation id.
350
+ *
351
+ * @param {string} correlationId correlation identifier
352
+ */
353
+ discardCache(correlationId) {
354
+ this.discardMeasurements(correlationId);
355
+ this.logger.trace("PerformanceClient: QueueMeasurements discarded", correlationId);
356
+ this.queueMeasurements.delete(correlationId);
357
+ this.logger.trace("PerformanceClient: Pre-queue times discarded", correlationId);
358
+ this.preQueueTimeByCorrelationId.delete(correlationId);
359
+ }
360
+ /**
361
+ * Registers a callback function to receive performance events.
362
+ *
363
+ * @param {PerformanceCallbackFunction} callback
364
+ * @returns {string}
365
+ */
366
+ addPerformanceCallback(callback) {
367
+ const callbackId = this.generateId();
368
+ this.callbacks.set(callbackId, callback);
369
+ this.logger.verbose(`PerformanceClient: Performance callback registered with id: ${callbackId}`);
370
+ return callbackId;
371
+ }
372
+ /**
373
+ * Removes a callback registered with addPerformanceCallback.
374
+ *
375
+ * @param {string} callbackId
376
+ * @returns {boolean}
377
+ */
378
+ removePerformanceCallback(callbackId) {
379
+ const result = this.callbacks.delete(callbackId);
380
+ if (result) {
381
+ this.logger.verbose(`PerformanceClient: Performance callback ${callbackId} removed.`);
382
+ }
383
+ else {
384
+ this.logger.verbose(`PerformanceClient: Performance callback ${callbackId} not removed.`);
385
+ }
386
+ return result;
387
+ }
388
+ /**
389
+ * Emits events to all registered callbacks.
390
+ *
391
+ * @param {PerformanceEvent[]} events
392
+ * @param {?string} [correlationId]
393
+ */
394
+ emitEvents(events, correlationId) {
395
+ this.logger.verbose("PerformanceClient: Emitting performance events", correlationId);
396
+ this.callbacks.forEach((callback, callbackId) => {
397
+ this.logger.trace(`PerformanceClient: Emitting event to callback ${callbackId}`, correlationId);
398
+ callback.apply(null, [events]);
399
+ });
400
+ }
401
+ /**
402
+ * Enforce truncation of integral fields in performance event.
403
+ * @param {PerformanceEvent} event performance event to update.
404
+ * @param {Set<string>} intFields integral fields.
405
+ */
406
+ truncateIntegralFields(event) {
407
+ this.intFields.forEach((key) => {
408
+ if (key in event && typeof event[key] === "number") {
409
+ event[key] = Math.floor(event[key]);
410
+ }
411
+ });
412
+ }
413
413
  }
414
414
 
415
415
  export { PerformanceClient };