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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (187) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +62 -62
  3. package/dist/account/AccountInfo.d.ts +31 -31
  4. package/dist/account/AuthToken.d.ts +20 -20
  5. package/dist/account/AuthToken.js +48 -48
  6. package/dist/account/CcsCredential.d.ts +9 -8
  7. package/dist/account/CcsCredential.d.ts.map +1 -1
  8. package/dist/account/CcsCredential.js +9 -10
  9. package/dist/account/CcsCredential.js.map +1 -1
  10. package/dist/account/ClientCredentials.d.ts +14 -14
  11. package/dist/account/ClientInfo.d.ts +19 -19
  12. package/dist/account/ClientInfo.js +37 -37
  13. package/dist/account/DecodedAuthToken.d.ts +8 -8
  14. package/dist/account/TokenClaims.d.ts +65 -65
  15. package/dist/authority/Authority.d.ts +228 -215
  16. package/dist/authority/Authority.d.ts.map +1 -1
  17. package/dist/authority/Authority.js +716 -682
  18. package/dist/authority/Authority.js.map +1 -1
  19. package/dist/authority/AuthorityFactory.d.ts +30 -30
  20. package/dist/authority/AuthorityFactory.js +47 -47
  21. package/dist/authority/AuthorityMetadata.d.ts +622 -622
  22. package/dist/authority/AuthorityMetadata.js +876 -876
  23. package/dist/authority/AuthorityOptions.d.ts +19 -18
  24. package/dist/authority/AuthorityOptions.d.ts.map +1 -1
  25. package/dist/authority/AuthorityOptions.js +19 -20
  26. package/dist/authority/AuthorityOptions.js.map +1 -1
  27. package/dist/authority/AuthorityType.d.ts +10 -9
  28. package/dist/authority/AuthorityType.d.ts.map +1 -1
  29. package/dist/authority/AuthorityType.js +14 -15
  30. package/dist/authority/AuthorityType.js.map +1 -1
  31. package/dist/authority/AzureRegion.d.ts +1 -1
  32. package/dist/authority/AzureRegionConfiguration.d.ts +5 -5
  33. package/dist/authority/CloudDiscoveryMetadata.d.ts +5 -5
  34. package/dist/authority/CloudInstanceDiscoveryErrorResponse.d.ts +13 -13
  35. package/dist/authority/CloudInstanceDiscoveryErrorResponse.js +8 -8
  36. package/dist/authority/CloudInstanceDiscoveryResponse.d.ts +9 -9
  37. package/dist/authority/CloudInstanceDiscoveryResponse.js +8 -8
  38. package/dist/authority/ImdsOptions.d.ts +5 -5
  39. package/dist/authority/OpenIdConfigResponse.d.ts +11 -11
  40. package/dist/authority/OpenIdConfigResponse.js +10 -10
  41. package/dist/authority/ProtocolMode.d.ts +8 -7
  42. package/dist/authority/ProtocolMode.d.ts.map +1 -1
  43. package/dist/authority/ProtocolMode.js +12 -13
  44. package/dist/authority/ProtocolMode.js.map +1 -1
  45. package/dist/authority/RegionDiscovery.d.ts +30 -30
  46. package/dist/authority/RegionDiscovery.js +108 -108
  47. package/dist/authority/RegionDiscoveryMetadata.d.ts +6 -6
  48. package/dist/broker/nativeBroker/INativeBrokerPlugin.d.ts +15 -15
  49. package/dist/cache/CacheManager.d.ts +443 -443
  50. package/dist/cache/CacheManager.js +1011 -1011
  51. package/dist/cache/entities/AccessTokenEntity.d.ts +56 -56
  52. package/dist/cache/entities/AccessTokenEntity.js +111 -111
  53. package/dist/cache/entities/AccountEntity.d.ts +99 -99
  54. package/dist/cache/entities/AccountEntity.js +248 -248
  55. package/dist/cache/entities/AppMetadataEntity.d.ts +39 -39
  56. package/dist/cache/entities/AppMetadataEntity.js +66 -66
  57. package/dist/cache/entities/AuthorityMetadataEntity.d.ts +47 -47
  58. package/dist/cache/entities/AuthorityMetadataEntity.js +77 -77
  59. package/dist/cache/entities/CacheRecord.d.ts +13 -13
  60. package/dist/cache/entities/CacheRecord.js +13 -13
  61. package/dist/cache/entities/CredentialEntity.d.ts +88 -88
  62. package/dist/cache/entities/CredentialEntity.js +136 -136
  63. package/dist/cache/entities/IdTokenEntity.d.ts +34 -34
  64. package/dist/cache/entities/IdTokenEntity.js +56 -56
  65. package/dist/cache/entities/RefreshTokenEntity.d.ts +36 -36
  66. package/dist/cache/entities/RefreshTokenEntity.js +59 -59
  67. package/dist/cache/entities/ServerTelemetryEntity.d.ts +12 -12
  68. package/dist/cache/entities/ServerTelemetryEntity.js +27 -27
  69. package/dist/cache/entities/ThrottlingEntity.d.ts +13 -13
  70. package/dist/cache/entities/ThrottlingEntity.js +23 -23
  71. package/dist/cache/interface/ICacheManager.d.ts +165 -165
  72. package/dist/cache/interface/ICachePlugin.d.ts +5 -5
  73. package/dist/cache/interface/ISerializableTokenCache.d.ts +4 -4
  74. package/dist/cache/persistence/TokenCacheContext.d.ts +23 -23
  75. package/dist/cache/persistence/TokenCacheContext.js +25 -25
  76. package/dist/cache/utils/CacheTypes.d.ts +62 -62
  77. package/dist/client/AuthorizationCodeClient.d.ts +71 -71
  78. package/dist/client/AuthorizationCodeClient.js +433 -433
  79. package/dist/client/BaseClient.d.ts +50 -50
  80. package/dist/client/BaseClient.js +92 -92
  81. package/dist/client/RefreshTokenClient.d.ts +34 -34
  82. package/dist/client/RefreshTokenClient.js +239 -239
  83. package/dist/client/SilentFlowClient.d.ts +24 -24
  84. package/dist/client/SilentFlowClient.js +94 -94
  85. package/dist/config/AppTokenProvider.d.ts +38 -38
  86. package/dist/config/ClientConfiguration.d.ts +133 -133
  87. package/dist/config/ClientConfiguration.js +88 -88
  88. package/dist/crypto/ICrypto.d.ts +62 -62
  89. package/dist/crypto/ICrypto.js +42 -42
  90. package/dist/crypto/IGuidGenerator.d.ts +4 -4
  91. package/dist/crypto/JoseHeader.d.ts +21 -21
  92. package/dist/crypto/JoseHeader.js +36 -36
  93. package/dist/crypto/PopTokenGenerator.d.ts +58 -57
  94. package/dist/crypto/PopTokenGenerator.d.ts.map +1 -1
  95. package/dist/crypto/PopTokenGenerator.js +82 -83
  96. package/dist/crypto/PopTokenGenerator.js.map +1 -1
  97. package/dist/crypto/SignedHttpRequest.d.ts +11 -11
  98. package/dist/error/AuthError.d.ts +47 -47
  99. package/dist/error/AuthError.js +51 -51
  100. package/dist/error/ClientAuthError.d.ts +412 -412
  101. package/dist/error/ClientAuthError.js +519 -519
  102. package/dist/error/ClientConfigurationError.d.ts +206 -198
  103. package/dist/error/ClientConfigurationError.d.ts.map +1 -1
  104. package/dist/error/ClientConfigurationError.js +259 -249
  105. package/dist/error/ClientConfigurationError.js.map +1 -1
  106. package/dist/error/InteractionRequiredAuthError.d.ts +59 -59
  107. package/dist/error/InteractionRequiredAuthError.js +78 -78
  108. package/dist/error/JoseHeaderError.d.ts +28 -28
  109. package/dist/error/JoseHeaderError.js +39 -39
  110. package/dist/error/ServerError.d.ts +7 -7
  111. package/dist/error/ServerError.js +14 -14
  112. package/dist/index.cjs.js +8826 -8813
  113. package/dist/index.cjs.js.map +1 -1
  114. package/dist/index.d.ts +93 -93
  115. package/dist/index.js +1 -1
  116. package/dist/logger/Logger.d.ts +95 -95
  117. package/dist/logger/Logger.js +197 -197
  118. package/dist/network/INetworkModule.d.ts +29 -29
  119. package/dist/network/INetworkModule.js +14 -14
  120. package/dist/network/NetworkManager.d.ts +32 -32
  121. package/dist/network/NetworkManager.js +33 -33
  122. package/dist/network/RequestThumbprint.d.ts +16 -16
  123. package/dist/network/ThrottlingUtils.d.ts +41 -41
  124. package/dist/network/ThrottlingUtils.js +94 -94
  125. package/dist/packageMetadata.d.ts +2 -2
  126. package/dist/packageMetadata.d.ts.map +1 -1
  127. package/dist/packageMetadata.js +4 -4
  128. package/dist/request/AuthenticationHeaderParser.d.ts +19 -19
  129. package/dist/request/AuthenticationHeaderParser.js +55 -55
  130. package/dist/request/BaseAuthRequest.d.ts +37 -37
  131. package/dist/request/CommonAuthorizationCodeRequest.d.ts +27 -27
  132. package/dist/request/CommonAuthorizationUrlRequest.d.ts +50 -50
  133. package/dist/request/CommonClientCredentialRequest.d.ts +17 -17
  134. package/dist/request/CommonDeviceCodeRequest.d.ts +21 -21
  135. package/dist/request/CommonEndSessionRequest.d.ts +21 -21
  136. package/dist/request/CommonOnBehalfOfRequest.d.ts +13 -13
  137. package/dist/request/CommonRefreshTokenRequest.d.ts +19 -19
  138. package/dist/request/CommonSilentFlowRequest.d.ts +18 -18
  139. package/dist/request/CommonUsernamePasswordRequest.d.ts +17 -17
  140. package/dist/request/NativeRequest.d.ts +19 -19
  141. package/dist/request/NativeSignOutRequest.d.ts +5 -5
  142. package/dist/request/RequestParameterBuilder.d.ts +216 -216
  143. package/dist/request/RequestParameterBuilder.js +374 -374
  144. package/dist/request/RequestValidator.d.ts +33 -33
  145. package/dist/request/RequestValidator.js +82 -83
  146. package/dist/request/RequestValidator.js.map +1 -1
  147. package/dist/request/ScopeSet.d.ts +88 -88
  148. package/dist/request/ScopeSet.js +197 -197
  149. package/dist/response/AuthenticationResult.d.ts +39 -39
  150. package/dist/response/AuthorizationCodePayload.d.ts +13 -13
  151. package/dist/response/DeviceCodeResponse.d.ts +25 -25
  152. package/dist/response/ExternalTokenResponse.d.ts +15 -15
  153. package/dist/response/IMDSBadResponse.d.ts +4 -4
  154. package/dist/response/ResponseHandler.d.ts +72 -72
  155. package/dist/response/ResponseHandler.js +300 -300
  156. package/dist/response/ServerAuthorizationCodeResponse.d.ts +25 -25
  157. package/dist/response/ServerAuthorizationTokenResponse.d.ts +44 -44
  158. package/dist/telemetry/performance/IPerformanceClient.d.ts +42 -42
  159. package/dist/telemetry/performance/IPerformanceMeasurement.d.ts +5 -5
  160. package/dist/telemetry/performance/PerformanceClient.d.ts +189 -189
  161. package/dist/telemetry/performance/PerformanceClient.js +406 -406
  162. package/dist/telemetry/performance/PerformanceEvent.d.ts +441 -439
  163. package/dist/telemetry/performance/PerformanceEvent.d.ts.map +1 -1
  164. package/dist/telemetry/performance/PerformanceEvent.js +225 -227
  165. package/dist/telemetry/performance/PerformanceEvent.js.map +1 -1
  166. package/dist/telemetry/performance/StubPerformanceClient.d.ts +15 -19
  167. package/dist/telemetry/performance/StubPerformanceClient.d.ts.map +1 -1
  168. package/dist/telemetry/performance/StubPerformanceClient.js +22 -36
  169. package/dist/telemetry/performance/StubPerformanceClient.js.map +1 -1
  170. package/dist/telemetry/server/ServerTelemetryManager.d.ts +65 -65
  171. package/dist/telemetry/server/ServerTelemetryManager.js +196 -196
  172. package/dist/telemetry/server/ServerTelemetryRequest.d.ts +8 -8
  173. package/dist/url/IUri.d.ts +12 -12
  174. package/dist/url/UrlString.d.ts +70 -70
  175. package/dist/url/UrlString.js +242 -242
  176. package/dist/utils/Constants.d.ts +345 -331
  177. package/dist/utils/Constants.d.ts.map +1 -1
  178. package/dist/utils/Constants.js +353 -373
  179. package/dist/utils/Constants.js.map +1 -1
  180. package/dist/utils/MsalTypes.d.ts +6 -6
  181. package/dist/utils/ProtocolUtils.d.ts +42 -42
  182. package/dist/utils/ProtocolUtils.js +71 -71
  183. package/dist/utils/StringUtils.d.ts +53 -53
  184. package/dist/utils/StringUtils.js +124 -124
  185. package/dist/utils/TimeUtils.d.ts +27 -27
  186. package/dist/utils/TimeUtils.js +45 -45
  187. package/package.json +86 -79
@@ -1,42 +1,28 @@
1
- /*! @azure/msal-common v14.0.0-alpha.1 2023-05-08 */
1
+ /*! @azure/msal-common v14.0.0-beta.0 2023-06-19 */
2
2
  'use strict';
3
3
  import { PerformanceClient } from './PerformanceClient.js';
4
4
 
5
- /*
6
- * Copyright (c) Microsoft Corporation. All rights reserved.
7
- * Licensed under the MIT License.
8
- */
9
- class StubPerformanceMeasurement {
10
- /* eslint-disable-next-line @typescript-eslint/no-empty-function */
11
- startMeasurement() { }
12
- /* eslint-disable-next-line @typescript-eslint/no-empty-function */
13
- endMeasurement() { }
14
- flushMeasurement() {
15
- return null;
16
- }
17
- }
18
- class StubPerformanceClient extends PerformanceClient {
19
- generateId() {
20
- return "callback-id";
21
- }
22
- startPerformanceMeasurement() {
23
- return new StubPerformanceMeasurement();
24
- }
25
- /* eslint-disable-next-line @typescript-eslint/no-unused-vars */
26
- calculateQueuedTime(preQueueTime, currentTime) {
27
- return 0;
28
- }
29
- addQueueMeasurement(eventName, // eslint-disable-line @typescript-eslint/no-unused-vars
30
- correlationId, // eslint-disable-line @typescript-eslint/no-unused-vars
31
- queueTime // eslint-disable-line @typescript-eslint/no-unused-vars
32
- ) {
33
- return;
34
- }
35
- setPreQueueTime(eventName, // eslint-disable-line @typescript-eslint/no-unused-vars
36
- correlationId // eslint-disable-line @typescript-eslint/no-unused-vars
37
- ) {
38
- return;
39
- }
5
+ /*
6
+ * Copyright (c) Microsoft Corporation. All rights reserved.
7
+ * Licensed under the MIT License.
8
+ */
9
+ class StubPerformanceMeasurement {
10
+ startMeasurement() { return; }
11
+ endMeasurement() { return; }
12
+ flushMeasurement() { return null; }
13
+ }
14
+ class StubPerformanceClient extends PerformanceClient {
15
+ generateId() {
16
+ return "callback-id";
17
+ }
18
+ startPerformanceMeasurement() {
19
+ return new StubPerformanceMeasurement();
20
+ }
21
+ calculateQueuedTime() {
22
+ return 0;
23
+ }
24
+ addQueueMeasurement() { return; }
25
+ setPreQueueTime() { return; }
40
26
  }
41
27
 
42
28
  export { StubPerformanceClient, StubPerformanceMeasurement };
@@ -1 +1 @@
1
- {"version":3,"file":"StubPerformanceClient.js","sources":["../../../src/telemetry/performance/StubPerformanceClient.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;AAAA;;;AAGG;MAOU,0BAA0B,CAAA;;AAEnC,IAAA,gBAAgB,MAAW;;AAE3B,IAAA,cAAc,MAAW;IACzB,gBAAgB,GAAA;AACZ,QAAA,OAAO,IAAI,CAAC;KACf;AACJ,CAAA;AAEK,MAAO,qBACT,SAAQ,iBAAiB,CAAA;IAGzB,UAAU,GAAA;AACN,QAAA,OAAO,aAAa,CAAC;KACxB;IAED,2BAA2B,GAAA;QACvB,OAAO,IAAI,0BAA0B,EAAE,CAAC;KAC3C;;IAGD,mBAAmB,CAAC,YAAoB,EAAE,WAAmB,EAAA;AACzD,QAAA,OAAO,CAAC,CAAC;KACZ;IAED,mBAAmB,CACf,SAA4B;AAC5B,IAAA,aAAqB;AACrB,IAAA,SAAiB;;QAEjB,OAAO;KACV;IAED,eAAe,CACX,SAA4B;AAC5B,IAAA,aAAkC;;QAElC,OAAO;KACV;AACJ;;;;"}
1
+ {"version":3,"file":"StubPerformanceClient.js","sources":["../../../src/telemetry/performance/StubPerformanceClient.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;AAAA;;;AAGG;MAMU,0BAA0B,CAAA;IACnC,gBAAgB,GAAA,EAAW,OAAO,EAAE;IACpC,cAAc,GAAA,EAAW,OAAO,EAAE;AAClC,IAAA,gBAAgB,GAAoB,EAAA,OAAO,IAAI,CAAC,EAAE;AACrD,CAAA;AAEK,MAAO,qBACT,SAAQ,iBAAiB,CAAA;IAGzB,UAAU,GAAA;AACN,QAAA,OAAO,aAAa,CAAC;KACxB;IAED,2BAA2B,GAAA;QACvB,OAAO,IAAI,0BAA0B,EAAE,CAAC;KAC3C;IAED,mBAAmB,GAAA;AACf,QAAA,OAAO,CAAC,CAAC;KACZ;IAED,mBAAmB,GAAA,EAAW,OAAO,EAAE;IAEvC,eAAe,GAAA,EAAW,OAAO,EAAE;AACtC;;;;"}
@@ -1,66 +1,66 @@
1
- import { CacheOutcome } from "../../utils/Constants";
2
- import { CacheManager } from "../../cache/CacheManager";
3
- import { ServerTelemetryRequest } from "./ServerTelemetryRequest";
4
- import { ServerTelemetryEntity } from "../../cache/entities/ServerTelemetryEntity";
5
- import { RegionDiscoveryMetadata } from "../../authority/RegionDiscoveryMetadata";
6
- export declare class ServerTelemetryManager {
7
- private cacheManager;
8
- private apiId;
9
- private correlationId;
10
- private telemetryCacheKey;
11
- private wrapperSKU;
12
- private wrapperVer;
13
- private regionUsed;
14
- private regionSource;
15
- private regionOutcome;
16
- private cacheOutcome;
17
- constructor(telemetryRequest: ServerTelemetryRequest, cacheManager: CacheManager);
18
- /**
19
- * API to add MSER Telemetry to request
20
- */
21
- generateCurrentRequestHeaderValue(): string;
22
- /**
23
- * API to add MSER Telemetry for the last failed request
24
- */
25
- generateLastRequestHeaderValue(): string;
26
- /**
27
- * API to cache token failures for MSER data capture
28
- * @param error
29
- */
30
- cacheFailedRequest(error: unknown): void;
31
- /**
32
- * Update server telemetry cache entry by incrementing cache hit counter
33
- */
34
- incrementCacheHits(): number;
35
- /**
36
- * Get the server telemetry entity from cache or initialize a new one
37
- */
38
- getLastRequests(): ServerTelemetryEntity;
39
- /**
40
- * Remove server telemetry cache entry
41
- */
42
- clearTelemetryCache(): void;
43
- /**
44
- * Returns the maximum number of errors that can be flushed to the server in the next network request
45
- * @param serverTelemetryEntity
46
- */
47
- static maxErrorsToSend(serverTelemetryEntity: ServerTelemetryEntity): number;
48
- /**
49
- * Get the region discovery fields
50
- *
51
- * @returns string
52
- */
53
- getRegionDiscoveryFields(): string;
54
- /**
55
- * Update the region discovery metadata
56
- *
57
- * @param regionDiscoveryMetadata
58
- * @returns void
59
- */
60
- updateRegionDiscoveryMetadata(regionDiscoveryMetadata: RegionDiscoveryMetadata): void;
61
- /**
62
- * Set cache outcome
63
- */
64
- setCacheOutcome(cacheOutcome: CacheOutcome): void;
65
- }
1
+ import { CacheOutcome } from "../../utils/Constants";
2
+ import { CacheManager } from "../../cache/CacheManager";
3
+ import { ServerTelemetryRequest } from "./ServerTelemetryRequest";
4
+ import { ServerTelemetryEntity } from "../../cache/entities/ServerTelemetryEntity";
5
+ import { RegionDiscoveryMetadata } from "../../authority/RegionDiscoveryMetadata";
6
+ export declare class ServerTelemetryManager {
7
+ private cacheManager;
8
+ private apiId;
9
+ private correlationId;
10
+ private telemetryCacheKey;
11
+ private wrapperSKU;
12
+ private wrapperVer;
13
+ private regionUsed;
14
+ private regionSource;
15
+ private regionOutcome;
16
+ private cacheOutcome;
17
+ constructor(telemetryRequest: ServerTelemetryRequest, cacheManager: CacheManager);
18
+ /**
19
+ * API to add MSER Telemetry to request
20
+ */
21
+ generateCurrentRequestHeaderValue(): string;
22
+ /**
23
+ * API to add MSER Telemetry for the last failed request
24
+ */
25
+ generateLastRequestHeaderValue(): string;
26
+ /**
27
+ * API to cache token failures for MSER data capture
28
+ * @param error
29
+ */
30
+ cacheFailedRequest(error: unknown): void;
31
+ /**
32
+ * Update server telemetry cache entry by incrementing cache hit counter
33
+ */
34
+ incrementCacheHits(): number;
35
+ /**
36
+ * Get the server telemetry entity from cache or initialize a new one
37
+ */
38
+ getLastRequests(): ServerTelemetryEntity;
39
+ /**
40
+ * Remove server telemetry cache entry
41
+ */
42
+ clearTelemetryCache(): void;
43
+ /**
44
+ * Returns the maximum number of errors that can be flushed to the server in the next network request
45
+ * @param serverTelemetryEntity
46
+ */
47
+ static maxErrorsToSend(serverTelemetryEntity: ServerTelemetryEntity): number;
48
+ /**
49
+ * Get the region discovery fields
50
+ *
51
+ * @returns string
52
+ */
53
+ getRegionDiscoveryFields(): string;
54
+ /**
55
+ * Update the region discovery metadata
56
+ *
57
+ * @param regionDiscoveryMetadata
58
+ * @returns void
59
+ */
60
+ updateRegionDiscoveryMetadata(regionDiscoveryMetadata: RegionDiscoveryMetadata): void;
61
+ /**
62
+ * Set cache outcome
63
+ */
64
+ setCacheOutcome(cacheOutcome: CacheOutcome): void;
65
+ }
66
66
  //# sourceMappingURL=ServerTelemetryManager.d.ts.map
@@ -1,205 +1,205 @@
1
- /*! @azure/msal-common v14.0.0-alpha.1 2023-05-08 */
1
+ /*! @azure/msal-common v14.0.0-beta.0 2023-06-19 */
2
2
  'use strict';
3
3
  import { CacheOutcome, Constants, SERVER_TELEM_CONSTANTS, Separators } from '../../utils/Constants.js';
4
4
  import { AuthError } from '../../error/AuthError.js';
5
5
  import { ServerTelemetryEntity } from '../../cache/entities/ServerTelemetryEntity.js';
6
6
  import { StringUtils } from '../../utils/StringUtils.js';
7
7
 
8
- /*
9
- * Copyright (c) Microsoft Corporation. All rights reserved.
10
- * Licensed under the MIT License.
11
- */
12
- class ServerTelemetryManager {
13
- constructor(telemetryRequest, cacheManager) {
14
- this.cacheOutcome = CacheOutcome.NO_CACHE_HIT;
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 (!StringUtils.isEmpty(error.subError)) {
85
- lastRequests.errors.push(error.subError);
86
- }
87
- else if (!StringUtils.isEmpty(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
- }
8
+ /*
9
+ * Copyright (c) Microsoft Corporation. All rights reserved.
10
+ * Licensed under the MIT License.
11
+ */
12
+ class ServerTelemetryManager {
13
+ constructor(telemetryRequest, cacheManager) {
14
+ this.cacheOutcome = CacheOutcome.NO_CACHE_HIT;
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 (!StringUtils.isEmpty(error.subError)) {
85
+ lastRequests.errors.push(error.subError);
86
+ }
87
+ else if (!StringUtils.isEmpty(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