@azure/msal-common 13.0.0 → 14.0.0-alpha.2

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