@azure/msal-common 14.1.0-alpha.0 → 14.1.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 (205) hide show
  1. package/dist/account/AccountInfo.d.ts +31 -32
  2. package/dist/account/AccountInfo.d.ts.map +1 -1
  3. package/dist/account/AuthToken.d.ts +17 -17
  4. package/dist/account/AuthToken.mjs +58 -58
  5. package/dist/account/CcsCredential.d.ts +9 -9
  6. package/dist/account/CcsCredential.mjs +8 -8
  7. package/dist/account/ClientCredentials.d.ts +14 -14
  8. package/dist/account/ClientInfo.d.ts +19 -19
  9. package/dist/account/ClientInfo.mjs +37 -37
  10. package/dist/account/TokenClaims.d.ts +65 -65
  11. package/dist/authority/Authority.d.ts +235 -235
  12. package/dist/authority/Authority.mjs +738 -738
  13. package/dist/authority/AuthorityFactory.d.ts +31 -31
  14. package/dist/authority/AuthorityFactory.mjs +47 -47
  15. package/dist/authority/AuthorityMetadata.d.ts +623 -623
  16. package/dist/authority/AuthorityMetadata.mjs +884 -884
  17. package/dist/authority/AuthorityOptions.d.ts +21 -21
  18. package/dist/authority/AuthorityOptions.mjs +18 -18
  19. package/dist/authority/AuthorityType.d.ts +10 -10
  20. package/dist/authority/AuthorityType.mjs +13 -13
  21. package/dist/authority/AzureRegion.d.ts +1 -1
  22. package/dist/authority/AzureRegionConfiguration.d.ts +5 -5
  23. package/dist/authority/CloudDiscoveryMetadata.d.ts +5 -5
  24. package/dist/authority/CloudInstanceDiscoveryErrorResponse.d.ts +13 -13
  25. package/dist/authority/CloudInstanceDiscoveryErrorResponse.mjs +8 -8
  26. package/dist/authority/CloudInstanceDiscoveryResponse.d.ts +9 -9
  27. package/dist/authority/CloudInstanceDiscoveryResponse.mjs +8 -8
  28. package/dist/authority/ImdsOptions.d.ts +5 -5
  29. package/dist/authority/OIDCOptions.d.ts +8 -8
  30. package/dist/authority/OpenIdConfigResponse.d.ts +11 -11
  31. package/dist/authority/OpenIdConfigResponse.mjs +10 -10
  32. package/dist/authority/ProtocolMode.d.ts +8 -8
  33. package/dist/authority/ProtocolMode.mjs +11 -11
  34. package/dist/authority/RegionDiscovery.d.ts +32 -32
  35. package/dist/authority/RegionDiscovery.mjs +106 -106
  36. package/dist/authority/RegionDiscoveryMetadata.d.ts +6 -6
  37. package/dist/broker/nativeBroker/INativeBrokerPlugin.d.ts +15 -15
  38. package/dist/cache/CacheManager.d.ts +464 -446
  39. package/dist/cache/CacheManager.d.ts.map +1 -1
  40. package/dist/cache/CacheManager.mjs +1049 -998
  41. package/dist/cache/CacheManager.mjs.map +1 -1
  42. package/dist/cache/entities/AccessTokenEntity.d.ts +56 -56
  43. package/dist/cache/entities/AccessTokenEntity.mjs +109 -109
  44. package/dist/cache/entities/AccountEntity.d.ts +101 -101
  45. package/dist/cache/entities/AccountEntity.mjs +220 -220
  46. package/dist/cache/entities/AppMetadataEntity.d.ts +39 -39
  47. package/dist/cache/entities/AppMetadataEntity.mjs +66 -66
  48. package/dist/cache/entities/AuthorityMetadataEntity.d.ts +48 -48
  49. package/dist/cache/entities/AuthorityMetadataEntity.mjs +78 -78
  50. package/dist/cache/entities/CacheRecord.d.ts +14 -14
  51. package/dist/cache/entities/CacheRecord.mjs +14 -14
  52. package/dist/cache/entities/CredentialEntity.d.ts +88 -88
  53. package/dist/cache/entities/CredentialEntity.mjs +136 -136
  54. package/dist/cache/entities/IdTokenEntity.d.ts +34 -34
  55. package/dist/cache/entities/IdTokenEntity.mjs +56 -56
  56. package/dist/cache/entities/RefreshTokenEntity.d.ts +36 -36
  57. package/dist/cache/entities/RefreshTokenEntity.mjs +59 -59
  58. package/dist/cache/entities/ServerTelemetryEntity.d.ts +12 -12
  59. package/dist/cache/entities/ServerTelemetryEntity.mjs +27 -27
  60. package/dist/cache/entities/ThrottlingEntity.d.ts +13 -13
  61. package/dist/cache/entities/ThrottlingEntity.mjs +23 -23
  62. package/dist/cache/interface/ICacheManager.d.ts +166 -166
  63. package/dist/cache/interface/ICachePlugin.d.ts +5 -5
  64. package/dist/cache/interface/ISerializableTokenCache.d.ts +4 -4
  65. package/dist/cache/persistence/TokenCacheContext.d.ts +23 -23
  66. package/dist/cache/persistence/TokenCacheContext.mjs +25 -25
  67. package/dist/cache/utils/CacheTypes.d.ts +66 -69
  68. package/dist/cache/utils/CacheTypes.d.ts.map +1 -1
  69. package/dist/client/AuthorizationCodeClient.d.ts +73 -73
  70. package/dist/client/AuthorizationCodeClient.d.ts.map +1 -1
  71. package/dist/client/AuthorizationCodeClient.mjs +408 -407
  72. package/dist/client/AuthorizationCodeClient.mjs.map +1 -1
  73. package/dist/client/BaseClient.d.ts +51 -51
  74. package/dist/client/BaseClient.mjs +98 -98
  75. package/dist/client/RefreshTokenClient.d.ts +35 -35
  76. package/dist/client/RefreshTokenClient.d.ts.map +1 -1
  77. package/dist/client/RefreshTokenClient.mjs +187 -179
  78. package/dist/client/RefreshTokenClient.mjs.map +1 -1
  79. package/dist/client/SilentFlowClient.d.ts +26 -26
  80. package/dist/client/SilentFlowClient.mjs +123 -123
  81. package/dist/config/AppTokenProvider.d.ts +38 -38
  82. package/dist/config/ClientConfiguration.d.ts +150 -150
  83. package/dist/config/ClientConfiguration.mjs +97 -97
  84. package/dist/crypto/ICrypto.d.ts +58 -62
  85. package/dist/crypto/ICrypto.d.ts.map +1 -1
  86. package/dist/crypto/ICrypto.mjs +30 -33
  87. package/dist/crypto/ICrypto.mjs.map +1 -1
  88. package/dist/crypto/IGuidGenerator.d.ts +4 -4
  89. package/dist/crypto/JoseHeader.d.ts +22 -22
  90. package/dist/crypto/JoseHeader.mjs +37 -37
  91. package/dist/crypto/PopTokenGenerator.d.ts +60 -60
  92. package/dist/crypto/PopTokenGenerator.mjs +82 -82
  93. package/dist/crypto/SignedHttpRequest.d.ts +11 -11
  94. package/dist/error/AuthError.d.ts +44 -44
  95. package/dist/error/AuthError.mjs +46 -46
  96. package/dist/error/AuthErrorCodes.d.ts +5 -5
  97. package/dist/error/AuthErrorCodes.mjs +9 -9
  98. package/dist/error/ClientAuthError.d.ts +232 -232
  99. package/dist/error/ClientAuthError.mjs +244 -244
  100. package/dist/error/ClientAuthErrorCodes.d.ts +43 -43
  101. package/dist/error/ClientAuthErrorCodes.mjs +47 -47
  102. package/dist/error/ClientConfigurationError.d.ts +128 -128
  103. package/dist/error/ClientConfigurationError.mjs +135 -135
  104. package/dist/error/ClientConfigurationErrorCodes.d.ts +22 -22
  105. package/dist/error/ClientConfigurationErrorCodes.mjs +26 -26
  106. package/dist/error/InteractionRequiredAuthError.d.ts +57 -57
  107. package/dist/error/InteractionRequiredAuthError.mjs +76 -76
  108. package/dist/error/InteractionRequiredAuthErrorCodes.d.ts +5 -5
  109. package/dist/error/InteractionRequiredAuthErrorCodes.mjs +11 -11
  110. package/dist/error/JoseHeaderError.d.ts +15 -15
  111. package/dist/error/JoseHeaderError.mjs +22 -22
  112. package/dist/error/JoseHeaderErrorCodes.d.ts +2 -2
  113. package/dist/error/JoseHeaderErrorCodes.mjs +6 -6
  114. package/dist/error/ServerError.d.ts +7 -7
  115. package/dist/error/ServerError.mjs +14 -14
  116. package/dist/index.cjs +8672 -8608
  117. package/dist/index.cjs.map +1 -1
  118. package/dist/index.d.ts +96 -96
  119. package/dist/index.d.ts.map +1 -1
  120. package/dist/index.mjs +1 -1
  121. package/dist/logger/Logger.d.ts +95 -95
  122. package/dist/logger/Logger.mjs +188 -188
  123. package/dist/network/INetworkModule.d.ts +29 -29
  124. package/dist/network/INetworkModule.mjs +12 -12
  125. package/dist/network/NetworkManager.d.ts +33 -33
  126. package/dist/network/NetworkManager.mjs +34 -34
  127. package/dist/network/RequestThumbprint.d.ts +16 -16
  128. package/dist/network/ThrottlingUtils.d.ts +42 -42
  129. package/dist/network/ThrottlingUtils.mjs +95 -95
  130. package/dist/packageMetadata.d.ts +2 -2
  131. package/dist/packageMetadata.mjs +4 -4
  132. package/dist/request/AuthenticationHeaderParser.d.ts +19 -19
  133. package/dist/request/AuthenticationHeaderParser.mjs +55 -55
  134. package/dist/request/BaseAuthRequest.d.ts +40 -40
  135. package/dist/request/CommonAuthorizationCodeRequest.d.ts +27 -27
  136. package/dist/request/CommonAuthorizationUrlRequest.d.ts +50 -50
  137. package/dist/request/CommonClientCredentialRequest.d.ts +17 -17
  138. package/dist/request/CommonDeviceCodeRequest.d.ts +21 -21
  139. package/dist/request/CommonEndSessionRequest.d.ts +21 -21
  140. package/dist/request/CommonOnBehalfOfRequest.d.ts +13 -13
  141. package/dist/request/CommonRefreshTokenRequest.d.ts +22 -19
  142. package/dist/request/CommonRefreshTokenRequest.d.ts.map +1 -1
  143. package/dist/request/CommonSilentFlowRequest.d.ts +20 -18
  144. package/dist/request/CommonSilentFlowRequest.d.ts.map +1 -1
  145. package/dist/request/CommonUsernamePasswordRequest.d.ts +17 -17
  146. package/dist/request/NativeRequest.d.ts +19 -19
  147. package/dist/request/NativeSignOutRequest.d.ts +5 -5
  148. package/dist/request/RequestParameterBuilder.d.ts +217 -217
  149. package/dist/request/RequestParameterBuilder.mjs +381 -381
  150. package/dist/request/RequestValidator.d.ts +33 -33
  151. package/dist/request/RequestValidator.mjs +81 -81
  152. package/dist/request/ScopeSet.d.ts +88 -88
  153. package/dist/request/ScopeSet.mjs +197 -197
  154. package/dist/request/StoreInCache.d.ts +8 -8
  155. package/dist/response/AuthenticationResult.d.ts +41 -41
  156. package/dist/response/AuthorizationCodePayload.d.ts +13 -13
  157. package/dist/response/DeviceCodeResponse.d.ts +25 -25
  158. package/dist/response/ExternalTokenResponse.d.ts +15 -15
  159. package/dist/response/IMDSBadResponse.d.ts +4 -4
  160. package/dist/response/ResponseHandler.d.ts +67 -67
  161. package/dist/response/ResponseHandler.mjs +311 -311
  162. package/dist/response/ServerAuthorizationCodeResponse.d.ts +25 -25
  163. package/dist/response/ServerAuthorizationTokenResponse.d.ts +46 -46
  164. package/dist/telemetry/performance/IPerformanceClient.d.ts +51 -51
  165. package/dist/telemetry/performance/IPerformanceMeasurement.d.ts +5 -5
  166. package/dist/telemetry/performance/PerformanceClient.d.ts +191 -191
  167. package/dist/telemetry/performance/PerformanceClient.mjs +409 -409
  168. package/dist/telemetry/performance/PerformanceEvent.d.ts +441 -433
  169. package/dist/telemetry/performance/PerformanceEvent.d.ts.map +1 -1
  170. package/dist/telemetry/performance/PerformanceEvent.mjs +242 -234
  171. package/dist/telemetry/performance/PerformanceEvent.mjs.map +1 -1
  172. package/dist/telemetry/performance/StubPerformanceClient.d.ts +24 -24
  173. package/dist/telemetry/performance/StubPerformanceClient.mjs +76 -76
  174. package/dist/telemetry/server/ServerTelemetryManager.d.ts +66 -66
  175. package/dist/telemetry/server/ServerTelemetryManager.mjs +197 -197
  176. package/dist/telemetry/server/ServerTelemetryRequest.d.ts +8 -8
  177. package/dist/url/IUri.d.ts +12 -12
  178. package/dist/url/UrlString.d.ts +83 -83
  179. package/dist/url/UrlString.mjs +279 -279
  180. package/dist/utils/Constants.d.ts +366 -366
  181. package/dist/utils/Constants.mjs +376 -376
  182. package/dist/utils/FunctionWrappers.d.ts +27 -27
  183. package/dist/utils/FunctionWrappers.d.ts.map +1 -1
  184. package/dist/utils/FunctionWrappers.mjs +84 -85
  185. package/dist/utils/FunctionWrappers.mjs.map +1 -1
  186. package/dist/utils/MsalTypes.d.ts +6 -6
  187. package/dist/utils/ProtocolUtils.d.ts +42 -42
  188. package/dist/utils/ProtocolUtils.mjs +69 -69
  189. package/dist/utils/StringUtils.d.ts +40 -40
  190. package/dist/utils/StringUtils.mjs +95 -95
  191. package/dist/utils/TimeUtils.d.ts +27 -27
  192. package/dist/utils/TimeUtils.mjs +45 -45
  193. package/package.json +1 -1
  194. package/src/account/AccountInfo.ts +0 -1
  195. package/src/cache/CacheManager.ts +96 -18
  196. package/src/cache/utils/CacheTypes.ts +6 -6
  197. package/src/client/AuthorizationCodeClient.ts +3 -1
  198. package/src/client/RefreshTokenClient.ts +19 -2
  199. package/src/crypto/ICrypto.ts +0 -7
  200. package/src/index.ts +1 -0
  201. package/src/packageMetadata.ts +1 -1
  202. package/src/request/CommonRefreshTokenRequest.ts +3 -0
  203. package/src/request/CommonSilentFlowRequest.ts +2 -0
  204. package/src/telemetry/performance/PerformanceEvent.ts +9 -0
  205. package/src/utils/FunctionWrappers.ts +0 -1
@@ -1,205 +1,205 @@
1
- /*! @azure/msal-common v14.1.0-alpha.0 2023-09-20 */
1
+ /*! @azure/msal-common v14.1.0 2023-10-05 */
2
2
  'use strict';
3
3
  import { CacheOutcome, Constants, SERVER_TELEM_CONSTANTS, Separators } from '../../utils/Constants.mjs';
4
4
  import { AuthError } from '../../error/AuthError.mjs';
5
5
  import { ServerTelemetryEntity } from '../../cache/entities/ServerTelemetryEntity.mjs';
6
6
 
7
- /*
8
- * Copyright (c) Microsoft Corporation. All rights reserved.
9
- * Licensed under the MIT License.
10
- */
11
- /** @internal */
12
- class ServerTelemetryManager {
13
- constructor(telemetryRequest, cacheManager) {
14
- this.cacheOutcome = CacheOutcome.NOT_APPLICABLE;
15
- this.cacheManager = cacheManager;
16
- this.apiId = telemetryRequest.apiId;
17
- this.correlationId = telemetryRequest.correlationId;
18
- this.wrapperSKU = telemetryRequest.wrapperSKU || Constants.EMPTY_STRING;
19
- this.wrapperVer = telemetryRequest.wrapperVer || Constants.EMPTY_STRING;
20
- this.telemetryCacheKey =
21
- SERVER_TELEM_CONSTANTS.CACHE_KEY +
22
- Separators.CACHE_KEY_SEPARATOR +
23
- telemetryRequest.clientId;
24
- }
25
- /**
26
- * API to add MSER Telemetry to request
27
- */
28
- generateCurrentRequestHeaderValue() {
29
- const request = `${this.apiId}${SERVER_TELEM_CONSTANTS.VALUE_SEPARATOR}${this.cacheOutcome}`;
30
- const platformFields = [this.wrapperSKU, this.wrapperVer].join(SERVER_TELEM_CONSTANTS.VALUE_SEPARATOR);
31
- const regionDiscoveryFields = this.getRegionDiscoveryFields();
32
- const requestWithRegionDiscoveryFields = [
33
- request,
34
- regionDiscoveryFields,
35
- ].join(SERVER_TELEM_CONSTANTS.VALUE_SEPARATOR);
36
- return [
37
- SERVER_TELEM_CONSTANTS.SCHEMA_VERSION,
38
- requestWithRegionDiscoveryFields,
39
- platformFields,
40
- ].join(SERVER_TELEM_CONSTANTS.CATEGORY_SEPARATOR);
41
- }
42
- /**
43
- * API to add MSER Telemetry for the last failed request
44
- */
45
- generateLastRequestHeaderValue() {
46
- const lastRequests = this.getLastRequests();
47
- const maxErrors = ServerTelemetryManager.maxErrorsToSend(lastRequests);
48
- const failedRequests = lastRequests.failedRequests
49
- .slice(0, 2 * maxErrors)
50
- .join(SERVER_TELEM_CONSTANTS.VALUE_SEPARATOR);
51
- const errors = lastRequests.errors
52
- .slice(0, maxErrors)
53
- .join(SERVER_TELEM_CONSTANTS.VALUE_SEPARATOR);
54
- const errorCount = lastRequests.errors.length;
55
- // Indicate whether this header contains all data or partial data
56
- const overflow = maxErrors < errorCount
57
- ? SERVER_TELEM_CONSTANTS.OVERFLOW_TRUE
58
- : SERVER_TELEM_CONSTANTS.OVERFLOW_FALSE;
59
- const platformFields = [errorCount, overflow].join(SERVER_TELEM_CONSTANTS.VALUE_SEPARATOR);
60
- return [
61
- SERVER_TELEM_CONSTANTS.SCHEMA_VERSION,
62
- lastRequests.cacheHits,
63
- failedRequests,
64
- errors,
65
- platformFields,
66
- ].join(SERVER_TELEM_CONSTANTS.CATEGORY_SEPARATOR);
67
- }
68
- /**
69
- * API to cache token failures for MSER data capture
70
- * @param error
71
- */
72
- cacheFailedRequest(error) {
73
- const lastRequests = this.getLastRequests();
74
- if (lastRequests.errors.length >=
75
- SERVER_TELEM_CONSTANTS.MAX_CACHED_ERRORS) {
76
- // Remove a cached error to make room, first in first out
77
- lastRequests.failedRequests.shift(); // apiId
78
- lastRequests.failedRequests.shift(); // correlationId
79
- lastRequests.errors.shift();
80
- }
81
- lastRequests.failedRequests.push(this.apiId, this.correlationId);
82
- if (error instanceof Error && !!error && error.toString()) {
83
- if (error instanceof AuthError) {
84
- if (error.subError) {
85
- lastRequests.errors.push(error.subError);
86
- }
87
- else if (error.errorCode) {
88
- lastRequests.errors.push(error.errorCode);
89
- }
90
- else {
91
- lastRequests.errors.push(error.toString());
92
- }
93
- }
94
- else {
95
- lastRequests.errors.push(error.toString());
96
- }
97
- }
98
- else {
99
- lastRequests.errors.push(SERVER_TELEM_CONSTANTS.UNKNOWN_ERROR);
100
- }
101
- this.cacheManager.setServerTelemetry(this.telemetryCacheKey, lastRequests);
102
- return;
103
- }
104
- /**
105
- * Update server telemetry cache entry by incrementing cache hit counter
106
- */
107
- incrementCacheHits() {
108
- const lastRequests = this.getLastRequests();
109
- lastRequests.cacheHits += 1;
110
- this.cacheManager.setServerTelemetry(this.telemetryCacheKey, lastRequests);
111
- return lastRequests.cacheHits;
112
- }
113
- /**
114
- * Get the server telemetry entity from cache or initialize a new one
115
- */
116
- getLastRequests() {
117
- const initialValue = new ServerTelemetryEntity();
118
- const lastRequests = this.cacheManager.getServerTelemetry(this.telemetryCacheKey);
119
- return lastRequests || initialValue;
120
- }
121
- /**
122
- * Remove server telemetry cache entry
123
- */
124
- clearTelemetryCache() {
125
- const lastRequests = this.getLastRequests();
126
- const numErrorsFlushed = ServerTelemetryManager.maxErrorsToSend(lastRequests);
127
- const errorCount = lastRequests.errors.length;
128
- if (numErrorsFlushed === errorCount) {
129
- // All errors were sent on last request, clear Telemetry cache
130
- this.cacheManager.removeItem(this.telemetryCacheKey);
131
- }
132
- else {
133
- // Partial data was flushed to server, construct a new telemetry cache item with errors that were not flushed
134
- const serverTelemEntity = new ServerTelemetryEntity();
135
- serverTelemEntity.failedRequests =
136
- lastRequests.failedRequests.slice(numErrorsFlushed * 2); // failedRequests contains 2 items for each error
137
- serverTelemEntity.errors =
138
- lastRequests.errors.slice(numErrorsFlushed);
139
- this.cacheManager.setServerTelemetry(this.telemetryCacheKey, serverTelemEntity);
140
- }
141
- }
142
- /**
143
- * Returns the maximum number of errors that can be flushed to the server in the next network request
144
- * @param serverTelemetryEntity
145
- */
146
- static maxErrorsToSend(serverTelemetryEntity) {
147
- let i;
148
- let maxErrors = 0;
149
- let dataSize = 0;
150
- const errorCount = serverTelemetryEntity.errors.length;
151
- for (i = 0; i < errorCount; i++) {
152
- // failedRequests parameter contains pairs of apiId and correlationId, multiply index by 2 to preserve pairs
153
- const apiId = serverTelemetryEntity.failedRequests[2 * i] ||
154
- Constants.EMPTY_STRING;
155
- const correlationId = serverTelemetryEntity.failedRequests[2 * i + 1] ||
156
- Constants.EMPTY_STRING;
157
- const errorCode = serverTelemetryEntity.errors[i] || Constants.EMPTY_STRING;
158
- // Count number of characters that would be added to header, each character is 1 byte. Add 3 at the end to account for separators
159
- dataSize +=
160
- apiId.toString().length +
161
- correlationId.toString().length +
162
- errorCode.length +
163
- 3;
164
- if (dataSize < SERVER_TELEM_CONSTANTS.MAX_LAST_HEADER_BYTES) {
165
- // Adding this entry to the header would still keep header size below the limit
166
- maxErrors += 1;
167
- }
168
- else {
169
- break;
170
- }
171
- }
172
- return maxErrors;
173
- }
174
- /**
175
- * Get the region discovery fields
176
- *
177
- * @returns string
178
- */
179
- getRegionDiscoveryFields() {
180
- const regionDiscoveryFields = [];
181
- regionDiscoveryFields.push(this.regionUsed || Constants.EMPTY_STRING);
182
- regionDiscoveryFields.push(this.regionSource || Constants.EMPTY_STRING);
183
- regionDiscoveryFields.push(this.regionOutcome || Constants.EMPTY_STRING);
184
- return regionDiscoveryFields.join(",");
185
- }
186
- /**
187
- * Update the region discovery metadata
188
- *
189
- * @param regionDiscoveryMetadata
190
- * @returns void
191
- */
192
- updateRegionDiscoveryMetadata(regionDiscoveryMetadata) {
193
- this.regionUsed = regionDiscoveryMetadata.region_used;
194
- this.regionSource = regionDiscoveryMetadata.region_source;
195
- this.regionOutcome = regionDiscoveryMetadata.region_outcome;
196
- }
197
- /**
198
- * Set cache outcome
199
- */
200
- setCacheOutcome(cacheOutcome) {
201
- this.cacheOutcome = cacheOutcome;
202
- }
7
+ /*
8
+ * Copyright (c) Microsoft Corporation. All rights reserved.
9
+ * Licensed under the MIT License.
10
+ */
11
+ /** @internal */
12
+ class ServerTelemetryManager {
13
+ constructor(telemetryRequest, cacheManager) {
14
+ this.cacheOutcome = CacheOutcome.NOT_APPLICABLE;
15
+ this.cacheManager = cacheManager;
16
+ this.apiId = telemetryRequest.apiId;
17
+ this.correlationId = telemetryRequest.correlationId;
18
+ this.wrapperSKU = telemetryRequest.wrapperSKU || Constants.EMPTY_STRING;
19
+ this.wrapperVer = telemetryRequest.wrapperVer || Constants.EMPTY_STRING;
20
+ this.telemetryCacheKey =
21
+ SERVER_TELEM_CONSTANTS.CACHE_KEY +
22
+ Separators.CACHE_KEY_SEPARATOR +
23
+ telemetryRequest.clientId;
24
+ }
25
+ /**
26
+ * API to add MSER Telemetry to request
27
+ */
28
+ generateCurrentRequestHeaderValue() {
29
+ const request = `${this.apiId}${SERVER_TELEM_CONSTANTS.VALUE_SEPARATOR}${this.cacheOutcome}`;
30
+ const platformFields = [this.wrapperSKU, this.wrapperVer].join(SERVER_TELEM_CONSTANTS.VALUE_SEPARATOR);
31
+ const regionDiscoveryFields = this.getRegionDiscoveryFields();
32
+ const requestWithRegionDiscoveryFields = [
33
+ request,
34
+ regionDiscoveryFields,
35
+ ].join(SERVER_TELEM_CONSTANTS.VALUE_SEPARATOR);
36
+ return [
37
+ SERVER_TELEM_CONSTANTS.SCHEMA_VERSION,
38
+ requestWithRegionDiscoveryFields,
39
+ platformFields,
40
+ ].join(SERVER_TELEM_CONSTANTS.CATEGORY_SEPARATOR);
41
+ }
42
+ /**
43
+ * API to add MSER Telemetry for the last failed request
44
+ */
45
+ generateLastRequestHeaderValue() {
46
+ const lastRequests = this.getLastRequests();
47
+ const maxErrors = ServerTelemetryManager.maxErrorsToSend(lastRequests);
48
+ const failedRequests = lastRequests.failedRequests
49
+ .slice(0, 2 * maxErrors)
50
+ .join(SERVER_TELEM_CONSTANTS.VALUE_SEPARATOR);
51
+ const errors = lastRequests.errors
52
+ .slice(0, maxErrors)
53
+ .join(SERVER_TELEM_CONSTANTS.VALUE_SEPARATOR);
54
+ const errorCount = lastRequests.errors.length;
55
+ // Indicate whether this header contains all data or partial data
56
+ const overflow = maxErrors < errorCount
57
+ ? SERVER_TELEM_CONSTANTS.OVERFLOW_TRUE
58
+ : SERVER_TELEM_CONSTANTS.OVERFLOW_FALSE;
59
+ const platformFields = [errorCount, overflow].join(SERVER_TELEM_CONSTANTS.VALUE_SEPARATOR);
60
+ return [
61
+ SERVER_TELEM_CONSTANTS.SCHEMA_VERSION,
62
+ lastRequests.cacheHits,
63
+ failedRequests,
64
+ errors,
65
+ platformFields,
66
+ ].join(SERVER_TELEM_CONSTANTS.CATEGORY_SEPARATOR);
67
+ }
68
+ /**
69
+ * API to cache token failures for MSER data capture
70
+ * @param error
71
+ */
72
+ cacheFailedRequest(error) {
73
+ const lastRequests = this.getLastRequests();
74
+ if (lastRequests.errors.length >=
75
+ SERVER_TELEM_CONSTANTS.MAX_CACHED_ERRORS) {
76
+ // Remove a cached error to make room, first in first out
77
+ lastRequests.failedRequests.shift(); // apiId
78
+ lastRequests.failedRequests.shift(); // correlationId
79
+ lastRequests.errors.shift();
80
+ }
81
+ lastRequests.failedRequests.push(this.apiId, this.correlationId);
82
+ if (error instanceof Error && !!error && error.toString()) {
83
+ if (error instanceof AuthError) {
84
+ if (error.subError) {
85
+ lastRequests.errors.push(error.subError);
86
+ }
87
+ else if (error.errorCode) {
88
+ lastRequests.errors.push(error.errorCode);
89
+ }
90
+ else {
91
+ lastRequests.errors.push(error.toString());
92
+ }
93
+ }
94
+ else {
95
+ lastRequests.errors.push(error.toString());
96
+ }
97
+ }
98
+ else {
99
+ lastRequests.errors.push(SERVER_TELEM_CONSTANTS.UNKNOWN_ERROR);
100
+ }
101
+ this.cacheManager.setServerTelemetry(this.telemetryCacheKey, lastRequests);
102
+ return;
103
+ }
104
+ /**
105
+ * Update server telemetry cache entry by incrementing cache hit counter
106
+ */
107
+ incrementCacheHits() {
108
+ const lastRequests = this.getLastRequests();
109
+ lastRequests.cacheHits += 1;
110
+ this.cacheManager.setServerTelemetry(this.telemetryCacheKey, lastRequests);
111
+ return lastRequests.cacheHits;
112
+ }
113
+ /**
114
+ * Get the server telemetry entity from cache or initialize a new one
115
+ */
116
+ getLastRequests() {
117
+ const initialValue = new ServerTelemetryEntity();
118
+ const lastRequests = this.cacheManager.getServerTelemetry(this.telemetryCacheKey);
119
+ return lastRequests || initialValue;
120
+ }
121
+ /**
122
+ * Remove server telemetry cache entry
123
+ */
124
+ clearTelemetryCache() {
125
+ const lastRequests = this.getLastRequests();
126
+ const numErrorsFlushed = ServerTelemetryManager.maxErrorsToSend(lastRequests);
127
+ const errorCount = lastRequests.errors.length;
128
+ if (numErrorsFlushed === errorCount) {
129
+ // All errors were sent on last request, clear Telemetry cache
130
+ this.cacheManager.removeItem(this.telemetryCacheKey);
131
+ }
132
+ else {
133
+ // Partial data was flushed to server, construct a new telemetry cache item with errors that were not flushed
134
+ const serverTelemEntity = new ServerTelemetryEntity();
135
+ serverTelemEntity.failedRequests =
136
+ lastRequests.failedRequests.slice(numErrorsFlushed * 2); // failedRequests contains 2 items for each error
137
+ serverTelemEntity.errors =
138
+ lastRequests.errors.slice(numErrorsFlushed);
139
+ this.cacheManager.setServerTelemetry(this.telemetryCacheKey, serverTelemEntity);
140
+ }
141
+ }
142
+ /**
143
+ * Returns the maximum number of errors that can be flushed to the server in the next network request
144
+ * @param serverTelemetryEntity
145
+ */
146
+ static maxErrorsToSend(serverTelemetryEntity) {
147
+ let i;
148
+ let maxErrors = 0;
149
+ let dataSize = 0;
150
+ const errorCount = serverTelemetryEntity.errors.length;
151
+ for (i = 0; i < errorCount; i++) {
152
+ // failedRequests parameter contains pairs of apiId and correlationId, multiply index by 2 to preserve pairs
153
+ const apiId = serverTelemetryEntity.failedRequests[2 * i] ||
154
+ Constants.EMPTY_STRING;
155
+ const correlationId = serverTelemetryEntity.failedRequests[2 * i + 1] ||
156
+ Constants.EMPTY_STRING;
157
+ const errorCode = serverTelemetryEntity.errors[i] || Constants.EMPTY_STRING;
158
+ // Count number of characters that would be added to header, each character is 1 byte. Add 3 at the end to account for separators
159
+ dataSize +=
160
+ apiId.toString().length +
161
+ correlationId.toString().length +
162
+ errorCode.length +
163
+ 3;
164
+ if (dataSize < SERVER_TELEM_CONSTANTS.MAX_LAST_HEADER_BYTES) {
165
+ // Adding this entry to the header would still keep header size below the limit
166
+ maxErrors += 1;
167
+ }
168
+ else {
169
+ break;
170
+ }
171
+ }
172
+ return maxErrors;
173
+ }
174
+ /**
175
+ * Get the region discovery fields
176
+ *
177
+ * @returns string
178
+ */
179
+ getRegionDiscoveryFields() {
180
+ const regionDiscoveryFields = [];
181
+ regionDiscoveryFields.push(this.regionUsed || Constants.EMPTY_STRING);
182
+ regionDiscoveryFields.push(this.regionSource || Constants.EMPTY_STRING);
183
+ regionDiscoveryFields.push(this.regionOutcome || Constants.EMPTY_STRING);
184
+ return regionDiscoveryFields.join(",");
185
+ }
186
+ /**
187
+ * Update the region discovery metadata
188
+ *
189
+ * @param regionDiscoveryMetadata
190
+ * @returns void
191
+ */
192
+ updateRegionDiscoveryMetadata(regionDiscoveryMetadata) {
193
+ this.regionUsed = regionDiscoveryMetadata.region_used;
194
+ this.regionSource = regionDiscoveryMetadata.region_source;
195
+ this.regionOutcome = regionDiscoveryMetadata.region_outcome;
196
+ }
197
+ /**
198
+ * Set cache outcome
199
+ */
200
+ setCacheOutcome(cacheOutcome) {
201
+ this.cacheOutcome = cacheOutcome;
202
+ }
203
203
  }
204
204
 
205
205
  export { ServerTelemetryManager };
@@ -1,9 +1,9 @@
1
- export type ServerTelemetryRequest = {
2
- clientId: string;
3
- apiId: number;
4
- correlationId: string;
5
- forceRefresh?: boolean;
6
- wrapperSKU?: string;
7
- wrapperVer?: string;
8
- };
1
+ export type ServerTelemetryRequest = {
2
+ clientId: string;
3
+ apiId: number;
4
+ correlationId: string;
5
+ forceRefresh?: boolean;
6
+ wrapperSKU?: string;
7
+ wrapperVer?: string;
8
+ };
9
9
  //# sourceMappingURL=ServerTelemetryRequest.d.ts.map
@@ -1,13 +1,13 @@
1
- /**
2
- * Interface which describes URI components.
3
- */
4
- export interface IUri {
5
- Protocol: string;
6
- HostNameAndPort: string;
7
- AbsolutePath: string;
8
- Search: string;
9
- Hash: string;
10
- PathSegments: string[];
11
- QueryString: string;
12
- }
1
+ /**
2
+ * Interface which describes URI components.
3
+ */
4
+ export interface IUri {
5
+ Protocol: string;
6
+ HostNameAndPort: string;
7
+ AbsolutePath: string;
8
+ Search: string;
9
+ Hash: string;
10
+ PathSegments: string[];
11
+ QueryString: string;
12
+ }
13
13
  //# sourceMappingURL=IUri.d.ts.map
@@ -1,84 +1,84 @@
1
- import { ServerAuthorizationCodeResponse } from "../response/ServerAuthorizationCodeResponse";
2
- import { IUri } from "./IUri";
3
- import { ServerResponseType } from "../utils/Constants";
4
- /**
5
- * Url object class which can perform various transformations on url strings.
6
- */
7
- export declare class UrlString {
8
- private _urlString;
9
- get urlString(): string;
10
- constructor(url: string);
11
- /**
12
- * Ensure urls are lower case and end with a / character.
13
- * @param url
14
- */
15
- static canonicalizeUri(url: string): string;
16
- /**
17
- * Throws if urlString passed is not a valid authority URI string.
18
- */
19
- validateAsUri(): void;
20
- /**
21
- * Given a url and a query string return the url with provided query string appended
22
- * @param url
23
- * @param queryString
24
- */
25
- static appendQueryString(url: string, queryString: string): string;
26
- /**
27
- * Returns a url with the hash removed
28
- * @param url
29
- */
30
- static removeHashFromUrl(url: string): string;
31
- /**
32
- * Given a url like https://a:b/common/d?e=f#g, and a tenantId, returns https://a:b/tenantId/d
33
- * @param href The url
34
- * @param tenantId The tenant id to replace
35
- */
36
- replaceTenantPath(tenantId: string): UrlString;
37
- /**
38
- * Returns the anchor part(#) of the URL
39
- */
40
- getHash(): string;
41
- /**
42
- * Parses out the components from a url string.
43
- * @returns An object with the various components. Please cache this value insted of calling this multiple times on the same url.
44
- */
45
- getUrlComponents(): IUri;
46
- static getDomainFromUrl(url: string): string;
47
- static getAbsoluteUrl(relativeUrl: string, baseUrl: string): string;
48
- /**
49
- * Parses hash string from given string. Returns empty string if no hash symbol is found.
50
- * @param hashString
51
- */
52
- static parseHash(hashString: string): string;
53
- /**
54
- * Parses query string from given string. Returns empty string if no query symbol is found.
55
- * @param queryString
56
- */
57
- static parseQueryString(queryString: string): string;
58
- /**
59
- * Parses query server response string from given string.
60
- * Extract hash between '?code=' and '#' if trailing '# is present.
61
- * Returns empty string if no query symbol is found.
62
- * @param queryString
63
- */
64
- static parseQueryServerResponse(queryString: string): string;
65
- static constructAuthorityUriFromObject(urlObject: IUri): UrlString;
66
- /**
67
- * Returns URL hash as server auth code response object.
68
- */
69
- static getDeserializedHash(hash: string): ServerAuthorizationCodeResponse;
70
- /**
71
- * Returns URL query string as server auth code response object.
72
- */
73
- static getDeserializedQueryString(query: string): ServerAuthorizationCodeResponse;
74
- /**
75
- * Returns either deserialized query string or deserialized hash, depending on the serverResponseType
76
- * as a server auth code response object.
77
- */
78
- static getDeserializedCodeResponse(serverResponseType: ServerResponseType | undefined, hashFragment: string): ServerAuthorizationCodeResponse;
79
- /**
80
- * Check if the hash of the URL string contains known properties
81
- */
82
- static hashContainsKnownProperties(hash: string): boolean;
83
- }
1
+ import { ServerAuthorizationCodeResponse } from "../response/ServerAuthorizationCodeResponse";
2
+ import { IUri } from "./IUri";
3
+ import { ServerResponseType } from "../utils/Constants";
4
+ /**
5
+ * Url object class which can perform various transformations on url strings.
6
+ */
7
+ export declare class UrlString {
8
+ private _urlString;
9
+ get urlString(): string;
10
+ constructor(url: string);
11
+ /**
12
+ * Ensure urls are lower case and end with a / character.
13
+ * @param url
14
+ */
15
+ static canonicalizeUri(url: string): string;
16
+ /**
17
+ * Throws if urlString passed is not a valid authority URI string.
18
+ */
19
+ validateAsUri(): void;
20
+ /**
21
+ * Given a url and a query string return the url with provided query string appended
22
+ * @param url
23
+ * @param queryString
24
+ */
25
+ static appendQueryString(url: string, queryString: string): string;
26
+ /**
27
+ * Returns a url with the hash removed
28
+ * @param url
29
+ */
30
+ static removeHashFromUrl(url: string): string;
31
+ /**
32
+ * Given a url like https://a:b/common/d?e=f#g, and a tenantId, returns https://a:b/tenantId/d
33
+ * @param href The url
34
+ * @param tenantId The tenant id to replace
35
+ */
36
+ replaceTenantPath(tenantId: string): UrlString;
37
+ /**
38
+ * Returns the anchor part(#) of the URL
39
+ */
40
+ getHash(): string;
41
+ /**
42
+ * Parses out the components from a url string.
43
+ * @returns An object with the various components. Please cache this value insted of calling this multiple times on the same url.
44
+ */
45
+ getUrlComponents(): IUri;
46
+ static getDomainFromUrl(url: string): string;
47
+ static getAbsoluteUrl(relativeUrl: string, baseUrl: string): string;
48
+ /**
49
+ * Parses hash string from given string. Returns empty string if no hash symbol is found.
50
+ * @param hashString
51
+ */
52
+ static parseHash(hashString: string): string;
53
+ /**
54
+ * Parses query string from given string. Returns empty string if no query symbol is found.
55
+ * @param queryString
56
+ */
57
+ static parseQueryString(queryString: string): string;
58
+ /**
59
+ * Parses query server response string from given string.
60
+ * Extract hash between '?code=' and '#' if trailing '# is present.
61
+ * Returns empty string if no query symbol is found.
62
+ * @param queryString
63
+ */
64
+ static parseQueryServerResponse(queryString: string): string;
65
+ static constructAuthorityUriFromObject(urlObject: IUri): UrlString;
66
+ /**
67
+ * Returns URL hash as server auth code response object.
68
+ */
69
+ static getDeserializedHash(hash: string): ServerAuthorizationCodeResponse;
70
+ /**
71
+ * Returns URL query string as server auth code response object.
72
+ */
73
+ static getDeserializedQueryString(query: string): ServerAuthorizationCodeResponse;
74
+ /**
75
+ * Returns either deserialized query string or deserialized hash, depending on the serverResponseType
76
+ * as a server auth code response object.
77
+ */
78
+ static getDeserializedCodeResponse(serverResponseType: ServerResponseType | undefined, hashFragment: string): ServerAuthorizationCodeResponse;
79
+ /**
80
+ * Check if the hash of the URL string contains known properties
81
+ */
82
+ static hashContainsKnownProperties(hash: string): boolean;
83
+ }
84
84
  //# sourceMappingURL=UrlString.d.ts.map