@azure/msal-common 7.6.0 → 9.0.0

package/dist/index.cjs.js

@@ -1,4 +1,4 @@
-/*! @azure/msal-common v7.6.0 2022-10-10 */
+/*! @azure/msal-common v9.0.0 2022-11-22 */
 'use strict';
 'use strict';
 
@@ -131,6 +131,7 @@ var Constants = {
     AUTHORIZATION_PENDING: "authorization_pending",
     NOT_DEFINED: "not_defined",
     EMPTY_STRING: "",
+    NOT_APPLICABLE: "N/A",
     FORWARD_SLASH: "/",
     IMDS_ENDPOINT: "http://169.254.169.254/metadata/instance/compute/location",
     IMDS_VERSION: "2020-06-01",
@@ -1409,7 +1410,7 @@ var Logger = /** @class */ (function () {
 
 /* eslint-disable header/header */
 var name = "@azure/msal-common";
-var version = "7.6.0";
+var version = "9.0.0";
 
 /*
  * Copyright (c) Microsoft Corporation. All rights reserved.
@@ -6010,27 +6011,28 @@ var RefreshTokenClient = /** @class */ (function (_super) {
         return _super.call(this, configuration, performanceClient) || this;
     }
     RefreshTokenClient.prototype.acquireToken = function (request) {
-        var _a, _b;
+        var _a, _b, _c;
         return __awaiter(this, void 0, void 0, function () {
             var atsMeasurement, reqTimestamp, response, requestId, responseHandler;
             var _this = this;
-            return __generator(this, function (_c) {
-                switch (_c.label) {
+            return __generator(this, function (_d) {
+                switch (_d.label) {
                     case 0:
                         atsMeasurement = (_a = this.performanceClient) === null || _a === void 0 ? void 0 : _a.startMeasurement(exports.PerformanceEvents.RefreshTokenClientAcquireToken, request.correlationId);
                         this.logger.verbose("RefreshTokenClientAcquireToken called", request.correlationId);
                         reqTimestamp = TimeUtils.nowSeconds();
                         return [4 /*yield*/, this.executeTokenRequest(request, this.authority)];
                     case 1:
-                        response = _c.sent();
-                        requestId = (_b = response.headers) === null || _b === void 0 ? void 0 : _b[exports.HeaderNames.X_MS_REQUEST_ID];
+                        response = _d.sent();
+                        atsMeasurement === null || atsMeasurement === void 0 ? void 0 : atsMeasurement.addStaticFields({
+                            refreshTokenSize: ((_b = response.body.refresh_token) === null || _b === void 0 ? void 0 : _b.length) || 0
+                        });
+                        requestId = (_c = response.headers) === null || _c === void 0 ? void 0 : _c[exports.HeaderNames.X_MS_REQUEST_ID];
                         responseHandler = new ResponseHandler(this.config.authOptions.clientId, this.cacheManager, this.cryptoUtils, this.logger, this.config.serializableCache, this.config.persistencePlugin);
                         responseHandler.validateTokenResponse(response.body);
                         return [2 /*return*/, responseHandler.handleServerTokenResponse(response.body, this.authority, reqTimestamp, request, undefined, undefined, true, request.forceCache, requestId).then(function (result) {
-                                var _a;
                                 atsMeasurement === null || atsMeasurement === void 0 ? void 0 : atsMeasurement.endMeasurement({
-                                    success: true,
-                                    refreshTokenSize: ((_a = response.body.refresh_token) === null || _a === void 0 ? void 0 : _a.length) || 0
+                                    success: true
                                 });
                                 return result;
                             })
@@ -6039,8 +6041,7 @@ var RefreshTokenClient = /** @class */ (function (_super) {
                                 atsMeasurement === null || atsMeasurement === void 0 ? void 0 : atsMeasurement.endMeasurement({
                                     errorCode: error.errorCode,
                                     subErrorCode: error.subError,
-                                    success: false,
-                                    refreshTokenSize: undefined
+                                    success: false
                                 });
                                 throw error;
                             })];
@@ -7152,7 +7153,7 @@ var RegionDiscovery = /** @class */ (function () {
  * endpoint. It will store the pertinent config data in this object for use during token calls.
  */
 var Authority = /** @class */ (function () {
-    function Authority(authority, networkInterface, cacheManager, authorityOptions, proxyUrl) {
+    function Authority(authority, networkInterface, cacheManager, authorityOptions, logger, proxyUrl) {
         this.canonicalAuthority = authority;
         this._canonicalAuthority.validateAsUri();
         this.networkInterface = networkInterface;
@@ -7161,6 +7162,7 @@ var Authority = /** @class */ (function () {
         this.regionDiscovery = new RegionDiscovery(networkInterface);
         this.regionDiscoveryMetadata = { region_used: undefined, region_source: undefined, region_outcome: undefined };
         this.proxyUrl = proxyUrl || Constants.EMPTY_STRING;
+        this.logger = logger;
     }
     Object.defineProperty(Authority.prototype, "authorityType", {
         // See above for AuthorityType
@@ -7587,36 +7589,50 @@ var Authority = /** @class */ (function () {
      */
     Authority.prototype.updateCloudDiscoveryMetadata = function (metadataEntity) {
         return __awaiter(this, void 0, void 0, function () {
-            var metadata, harcodedMetadata;
+            var metadata, metadataEntityExpired, harcodedMetadata;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
+                        this.logger.verbose("Attempting to get cloud discovery metadata in the config");
+                        this.logger.verbosePii("Known Authorities: " + (this.authorityOptions.knownAuthorities || Constants.NOT_APPLICABLE));
+                        this.logger.verbosePii("Authority Metadata: " + (this.authorityOptions.authorityMetadata || Constants.NOT_APPLICABLE));
+                        this.logger.verbosePii("Canonical Authority: " + (metadataEntity.canonical_authority || Constants.NOT_APPLICABLE));
                         metadata = this.getCloudDiscoveryMetadataFromConfig();
                         if (metadata) {
+                            this.logger.verbose("Found cloud discovery metadata in the config.");
                             metadataEntity.updateCloudDiscoveryMetadata(metadata, false);
                             return [2 /*return*/, AuthorityMetadataSource.CONFIG];
                         }
-                        // If The cached metadata came from config but that config was not passed to this instance, we must go to the network
-                        if (this.isAuthoritySameType(metadataEntity) && metadataEntity.aliasesFromNetwork && !metadataEntity.isExpired()) {
+                        // If the cached metadata came from config but that config was not passed to this instance, we must go to the network
+                        this.logger.verbose("Did not find cloud discovery metadata in the config... Attempting to get cloud discovery metadata from the cache.");
+                        metadataEntityExpired = metadataEntity.isExpired();
+                        if (this.isAuthoritySameType(metadataEntity) && metadataEntity.aliasesFromNetwork && !metadataEntityExpired) {
+                            this.logger.verbose("Found metadata in the cache.");
                             // No need to update
                             return [2 /*return*/, AuthorityMetadataSource.CACHE];
                         }
-                        harcodedMetadata = this.getCloudDiscoveryMetadataFromHarcodedValues();
+                        else if (metadataEntityExpired) {
+                            this.logger.verbose("The metadata entity is expired.");
+                        }
+                        this.logger.verbose("Did not find cloud discovery metadata in the cache... Attempting to get cloud discovery metadata from the network.");
                         return [4 /*yield*/, this.getCloudDiscoveryMetadataFromNetwork()];
                     case 1:
                         metadata = _a.sent();
                         if (metadata) {
+                            this.logger.verbose("Found cloud discovery metadata from the network.");
                             metadataEntity.updateCloudDiscoveryMetadata(metadata, true);
                             return [2 /*return*/, AuthorityMetadataSource.NETWORK];
                         }
+                        this.logger.verbose("Did not find cloud discovery metadata from the network... Attempting to get cloud discovery metadata from hardcoded values.");
+                        harcodedMetadata = this.getCloudDiscoveryMetadataFromHarcodedValues();
                         if (harcodedMetadata && !this.options.skipAuthorityMetadataCache) {
+                            this.logger.verbose("Found cloud discovery metadata from hardcoded values.");
                             metadataEntity.updateCloudDiscoveryMetadata(harcodedMetadata, false);
                             return [2 /*return*/, AuthorityMetadataSource.HARDCODED_VALUES];
                         }
-                        else {
-                            // Metadata could not be obtained from config, cache or network
-                            throw ClientConfigurationError.createUntrustedAuthorityError();
-                        }
+                        // Metadata could not be obtained from config, cache or network
+                        this.logger.verbose("Did not find cloud discovery metadata from hardcoded values... Metadata could not be obtained from config, cache, network or hardcoded value. Throwing Untrusted Authority Error.");
+                        throw ClientConfigurationError.createUntrustedAuthorityError();
                 }
             });
         });
@@ -7627,19 +7643,28 @@ var Authority = /** @class */ (function () {
     Authority.prototype.getCloudDiscoveryMetadataFromConfig = function () {
         // Check if network response was provided in config
         if (this.authorityOptions.cloudDiscoveryMetadata) {
+            this.logger.verbose("The cloud discovery metadata has been provided as a network response, in the config.");
             try {
+                this.logger.verbose("Attempting to parse the cloud discovery metadata.");
                 var parsedResponse = JSON.parse(this.authorityOptions.cloudDiscoveryMetadata);
                 var metadata = Authority.getCloudDiscoveryMetadataFromNetworkResponse(parsedResponse.metadata, this.hostnameAndPort);
+                this.logger.verbose("Parsed the cloud discovery metadata.");
                 if (metadata) {
+                    this.logger.verbose("There is returnable metadata attached to the parsed cloud discovery metadata.");
                     return metadata;
                 }
+                else {
+                    this.logger.verbose("There is no metadata attached to the parsed cloud discovery metadata.");
+                }
             }
             catch (e) {
+                this.logger.verbose("Unable to parse the cloud discovery metadata. Throwing Invalid Cloud Discovery Metadata Error.");
                 throw ClientConfigurationError.createInvalidCloudDiscoveryMetadataError();
             }
         }
         // If cloudDiscoveryMetadata is empty or does not contain the host, check knownAuthorities
         if (this.isInKnownAuthorities()) {
+            this.logger.verbose("The host is included in knownAuthorities. Creating new cloud discovery metadata from the host.");
             return Authority.createCloudDiscoveryMetadataFromHost(this.hostnameAndPort);
         }
         return null;
@@ -7830,13 +7855,13 @@ var AuthorityFactory = /** @class */ (function () {
      * @param networkClient
      * @param protocolMode
      */
-    AuthorityFactory.createDiscoveredInstance = function (authorityUri, networkClient, cacheManager, authorityOptions, proxyUrl) {
+    AuthorityFactory.createDiscoveredInstance = function (authorityUri, networkClient, cacheManager, authorityOptions, logger, proxyUrl) {
         return __awaiter(this, void 0, void 0, function () {
             var acquireTokenAuthority, e_1;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        acquireTokenAuthority = AuthorityFactory.createInstance(authorityUri, networkClient, cacheManager, authorityOptions, proxyUrl);
+                        acquireTokenAuthority = AuthorityFactory.createInstance(authorityUri, networkClient, cacheManager, authorityOptions, logger, proxyUrl);
                         _a.label = 1;
                     case 1:
                         _a.trys.push([1, 3, , 4]);
@@ -7862,12 +7887,12 @@ var AuthorityFactory = /** @class */ (function () {
      * @param networkInterface
      * @param protocolMode
      */
-    AuthorityFactory.createInstance = function (authorityUrl, networkInterface, cacheManager, authorityOptions, proxyUrl) {
+    AuthorityFactory.createInstance = function (authorityUrl, networkInterface, cacheManager, authorityOptions, logger, proxyUrl) {
         // Throw error if authority url is empty
         if (StringUtils.isEmpty(authorityUrl)) {
             throw ClientConfigurationError.createUrlEmptyError();
         }
-        return new Authority(authorityUrl, networkInterface, cacheManager, authorityOptions, proxyUrl);
+        return new Authority(authorityUrl, networkInterface, cacheManager, authorityOptions, logger, proxyUrl);
     };
     return AuthorityFactory;
 }());
@@ -8265,6 +8290,7 @@ var PerformanceClient = /** @class */ (function () {
         this.logger = logger;
         this.callbacks = new Map();
         this.eventsByCorrelationId = new Map();
+        this.staticFieldsByCorrelationId = new Map();
         this.measurementsById = new Map();
     }
     /**
@@ -8291,8 +8317,6 @@ var PerformanceClient = /** @class */ (function () {
             authority: this.authority,
             libraryName: this.libraryName,
             libraryVersion: this.libraryVersion,
-            appName: (_a = this.applicationTelemetry) === null || _a === void 0 ? void 0 : _a.appName,
-            appVersion: (_b = this.applicationTelemetry) === null || _b === void 0 ? void 0 : _b.appVersion,
             clientId: this.clientId,
             name: measureName,
             startTimeMs: Date.now(),
@@ -8300,6 +8324,11 @@ var PerformanceClient = /** @class */ (function () {
         };
         // Store in progress events so they can be discarded if not ended properly
         this.cacheEventByCorrelationId(inProgressEvent);
+        var staticFields = {
+            appName: (_a = this.applicationTelemetry) === null || _a === void 0 ? void 0 : _a.appName,
+            appVersion: (_b = this.applicationTelemetry) === null || _b === void 0 ? void 0 : _b.appVersion,
+        };
+        this.addStaticFields(staticFields, eventCorrelationId);
         this.cacheMeasurement(inProgressEvent, performanceMeasurement);
         // Return the event and functions the caller can use to properly end/flush the measurement
         return {
@@ -8317,6 +8346,9 @@ var PerformanceClient = /** @class */ (function () {
             discardMeasurement: function () {
                 return _this.discardMeasurements(inProgressEvent.correlationId);
             },
+            addStaticFields: function (fields) {
+                return _this.addStaticFields(fields, inProgressEvent.correlationId);
+            },
             measurement: performanceMeasurement,
             event: inProgressEvent
         };
@@ -8352,6 +8384,22 @@ var PerformanceClient = /** @class */ (function () {
         }
         return null;
     };
+    /**
+     * Saves extra information to be emitted when the measurements are flushed
+     * @param fields
+     * @param correlationId
+     */
+    PerformanceClient.prototype.addStaticFields = function (fields, correlationId) {
+        var existingStaticFields = this.staticFieldsByCorrelationId.get(correlationId);
+        if (existingStaticFields) {
+            this.logger.trace("PerformanceClient: Updating static fields");
+            this.staticFieldsByCorrelationId.set(correlationId, __assign(__assign({}, existingStaticFields), fields));
+        }
+        else {
+            this.logger.trace("PerformanceClient: Adding static fields");
+            this.staticFieldsByCorrelationId.set(correlationId, fields);
+        }
+    };
     /**
      * Upserts event into event cache.
      * First key is the correlation id, second key is the event id.
@@ -8441,19 +8489,12 @@ var PerformanceClient = /** @class */ (function () {
                         else {
                             _this.logger.verbose("PerformanceClient: Submeasurement for " + measureName + " already exists for " + current.name + ", ignoring", correlationId);
                         }
-                        if (current.accessTokenSize) {
-                            previous.accessTokenSize = current.accessTokenSize;
-                        }
-                        if (current.idTokenSize) {
-                            previous.idTokenSize = current.idTokenSize;
-                        }
-                        if (current.refreshTokenSize) {
-                            previous.refreshTokenSize = current.refreshTokenSize;
-                        }
                     }
                     return previous;
                 }, topLevelEvent);
-                this.emitEvents([eventToEmit], eventToEmit.correlationId);
+                var staticFields = this.staticFieldsByCorrelationId.get(correlationId);
+                var finalEvent = __assign(__assign({}, eventToEmit), staticFields);
+                this.emitEvents([finalEvent], eventToEmit.correlationId);
             }
             else {
                 this.logger.verbose("PerformanceClient: No completed top-level measurements found for " + measureName, correlationId);