@azure/msal-common 14.0.3 → 14.1.0-alpha.0

package/src/authority/Authority.ts

@@ -10,7 +10,10 @@ import {
 } from "./OpenIdConfigResponse";
 import { UrlString } from "../url/UrlString";
 import { IUri } from "../url/IUri";
-import { ClientAuthError } from "../error/ClientAuthError";
+import {
+    createClientAuthError,
+    ClientAuthErrorCodes,
+} from "../error/ClientAuthError";
 import { INetworkModule } from "../network/INetworkModule";
 import {
     AADAuthorityConstants,
@@ -23,7 +26,10 @@ import {
     InstanceDiscoveryMetadata,
     InstanceDiscoveryMetadataAliases,
 } from "./AuthorityMetadata";
-import { ClientConfigurationError } from "../error/ClientConfigurationError";
+import {
+    createClientConfigurationError,
+    ClientConfigurationErrorCodes,
+} from "../error/ClientConfigurationError";
 import { ProtocolMode } from "./ProtocolMode";
 import { ICacheManager } from "../cache/interface/ICacheManager";
 import { AuthorityMetadataEntity } from "../cache/entities/AuthorityMetadataEntity";
@@ -45,6 +51,7 @@ import { Logger } from "../logger/Logger";
 import { AuthError } from "../error/AuthError";
 import { IPerformanceClient } from "../telemetry/performance/IPerformanceClient";
 import { PerformanceEvents } from "../telemetry/performance/PerformanceEvent";
+import { invokeAsync } from "../utils/FunctionWrappers";
 
 /**
  * The authority class validates the authority URIs used by the user, and retrieves the OpenID Configuration Data from the
@@ -107,6 +114,7 @@ export class Authority {
         this.correlationId = correlationId;
         this.regionDiscovery = new RegionDiscovery(
             networkInterface,
+            this.logger,
             this.performanceClient,
             this.correlationId
         );
@@ -205,8 +213,8 @@ export class Authority {
         if (this.discoveryComplete()) {
             return this.replacePath(this.metadata.authorization_endpoint);
         } else {
-            throw ClientAuthError.createEndpointDiscoveryIncompleteError(
-                "Discovery incomplete."
+            throw createClientAuthError(
+                ClientAuthErrorCodes.endpointResolutionError
             );
         }
     }
@@ -218,8 +226,8 @@ export class Authority {
         if (this.discoveryComplete()) {
             return this.replacePath(this.metadata.token_endpoint);
         } else {
-            throw ClientAuthError.createEndpointDiscoveryIncompleteError(
-                "Discovery incomplete."
+            throw createClientAuthError(
+                ClientAuthErrorCodes.endpointResolutionError
             );
         }
     }
@@ -230,8 +238,8 @@ export class Authority {
                 this.metadata.token_endpoint.replace("/token", "/devicecode")
             );
         } else {
-            throw ClientAuthError.createEndpointDiscoveryIncompleteError(
-                "Discovery incomplete."
+            throw createClientAuthError(
+                ClientAuthErrorCodes.endpointResolutionError
             );
         }
     }
@@ -243,12 +251,14 @@ export class Authority {
         if (this.discoveryComplete()) {
             // ROPC policies may not have end_session_endpoint set
             if (!this.metadata.end_session_endpoint) {
-                throw ClientAuthError.createLogoutNotSupportedError();
+                throw createClientAuthError(
+                    ClientAuthErrorCodes.endSessionEndpointNotSupported
+                );
             }
             return this.replacePath(this.metadata.end_session_endpoint);
         } else {
-            throw ClientAuthError.createEndpointDiscoveryIncompleteError(
-                "Discovery incomplete."
+            throw createClientAuthError(
+                ClientAuthErrorCodes.endpointResolutionError
             );
         }
     }
@@ -260,8 +270,8 @@ export class Authority {
         if (this.discoveryComplete()) {
             return this.replacePath(this.metadata.issuer);
         } else {
-            throw ClientAuthError.createEndpointDiscoveryIncompleteError(
-                "Discovery incomplete."
+            throw createClientAuthError(
+                ClientAuthErrorCodes.endpointResolutionError
             );
         }
     }
@@ -273,8 +283,8 @@ export class Authority {
         if (this.discoveryComplete()) {
             return this.replacePath(this.metadata.jwks_uri);
         } else {
-            throw ClientAuthError.createEndpointDiscoveryIncompleteError(
-                "Discovery incomplete."
+            throw createClientAuthError(
+                ClientAuthErrorCodes.endpointResolutionError
             );
         }
     }
@@ -356,6 +366,7 @@ export class Authority {
     protected get defaultOpenIdConfigurationEndpoint(): string {
         const canonicalAuthorityHost = this.hostnameAndPort;
         if (
+            this.canonicalAuthority.endsWith("v2.0/") ||
             this.authorityType === AuthorityType.Adfs ||
             (this.protocolMode !== ProtocolMode.AAD &&
                 !this.isAliasOfKnownMicrosoftAuthority(canonicalAuthorityHost))
@@ -391,24 +402,24 @@ export class Authority {
             metadataEntity.updateCanonicalAuthority(this.canonicalAuthority);
         }
 
-        this.performanceClient?.setPreQueueTime(
+        const cloudDiscoverySource = await invokeAsync(
+            this.updateCloudDiscoveryMetadata.bind(this),
             PerformanceEvents.AuthorityUpdateCloudDiscoveryMetadata,
+            this.logger,
+            this.performanceClient,
             this.correlationId
-        );
-        const cloudDiscoverySource = await this.updateCloudDiscoveryMetadata(
-            metadataEntity
-        );
+        )(metadataEntity);
         this.canonicalAuthority = this.canonicalAuthority.replace(
             this.hostnameAndPort,
             metadataEntity.preferred_network
         );
-        this.performanceClient?.setPreQueueTime(
+        const endpointSource = await invokeAsync(
+            this.updateEndpointMetadata.bind(this),
             PerformanceEvents.AuthorityUpdateEndpointMetadata,
+            this.logger,
+            this.performanceClient,
             this.correlationId
-        );
-        const endpointSource = await this.updateEndpointMetadata(
-            metadataEntity
-        );
+        )(metadataEntity);
 
         if (
             cloudDiscoverySource !== AuthorityMetadataSource.CACHE &&
@@ -469,17 +480,13 @@ export class Authority {
                 if (
                     this.authorityOptions.azureRegionConfiguration?.azureRegion
                 ) {
-                    this.performanceClient?.setPreQueueTime(
+                    hardcodedMetadata = await invokeAsync(
+                        this.updateMetadataWithRegionalInformation.bind(this),
                         PerformanceEvents.AuthorityUpdateMetadataWithRegionalInformation,
+                        this.logger,
+                        this.performanceClient,
                         this.correlationId
-                    );
-                    this.logger.verbose(
-                        "Found azure region configuration. Updating endpoints with regional information."
-                    );
-                    hardcodedMetadata =
-                        await this.updateMetadataWithRegionalInformation(
-                            hardcodedMetadata
-                        );
+                    )(hardcodedMetadata);
                 }
 
                 metadataEntity.updateEndpointMetadata(hardcodedMetadata, false);
@@ -505,41 +512,31 @@ export class Authority {
             this.logger.verbose("The metadata entity is expired.");
         }
 
-        this.logger.verbose(
-            "Did not find cached endpoint metadata... Attempting to get endpoint metadata from the network."
-        );
-
-        this.performanceClient?.setPreQueueTime(
+        metadata = await invokeAsync(
+            this.getEndpointMetadataFromNetwork.bind(this),
             PerformanceEvents.AuthorityGetEndpointMetadataFromNetwork,
+            this.logger,
+            this.performanceClient,
             this.correlationId
-        );
-        metadata = await this.getEndpointMetadataFromNetwork();
+        )();
         if (metadata) {
-            this.logger.verbose(
-                "Endpoint metadata was successfully returned from getEndpointMetadataFromNetwork()"
-            );
             // If the user prefers to use an azure region replace the global endpoints with regional information.
             if (this.authorityOptions.azureRegionConfiguration?.azureRegion) {
-                this.performanceClient?.setPreQueueTime(
+                metadata = await invokeAsync(
+                    this.updateMetadataWithRegionalInformation.bind(this),
                     PerformanceEvents.AuthorityUpdateMetadataWithRegionalInformation,
+                    this.logger,
+                    this.performanceClient,
                     this.correlationId
-                );
-                this.logger.verbose(
-                    "Found azure region configuration. Updating endpoints with regional information."
-                );
-                metadata = await this.updateMetadataWithRegionalInformation(
-                    metadata
-                );
+                )(metadata);
             }
 
             metadataEntity.updateEndpointMetadata(metadata, true);
             return AuthorityMetadataSource.NETWORK;
         } else {
             // Metadata could not be obtained from the config, cache, network or hardcoded values
-            this.logger.error(
-                "Did not find endpoint metadata from network... Metadata could not be obtained from config, cache, network or hardcoded values. Throwing Untrusted Authority Error."
-            );
-            throw ClientAuthError.createUnableToGetOpenidConfigError(
+            throw createClientAuthError(
+                ClientAuthErrorCodes.openIdConfigError,
                 this.defaultOpenIdConfigurationEndpoint
             );
         }
@@ -575,7 +572,9 @@ export class Authority {
                     this.authorityOptions.authorityMetadata
                 ) as OpenIdConfigResponse;
             } catch (e) {
-                throw ClientConfigurationError.createInvalidAuthorityMetadataError();
+                throw createClientConfigurationError(
+                    ClientConfigurationErrorCodes.invalidAuthorityMetadata
+                );
             }
         }
 
@@ -593,10 +592,6 @@ export class Authority {
             this.correlationId
         );
 
-        const perfEvent = this.performanceClient?.startMeasurement(
-            PerformanceEvents.AuthorityGetEndpointMetadataFromNetwork,
-            this.correlationId
-        );
         const options: ImdsOptions = {};
 
         /*
@@ -618,23 +613,14 @@ export class Authority {
                 );
             const isValidResponse = isOpenIdConfigResponse(response.body);
             if (isValidResponse) {
-                perfEvent?.end({ success: true });
                 return response.body;
             } else {
-                perfEvent?.end({
-                    success: false,
-                    errorCode: "invalid_response",
-                });
                 this.logger.verbose(
                     `Authority.getEndpointMetadataFromNetwork: could not parse response as OpenID configuration`
                 );
                 return null;
             }
         } catch (e) {
-            perfEvent?.end({
-                success: false,
-                errorCode: "request_failure",
-            });
             this.logger.verbose(
                 `Authority.getEndpointMetadataFromNetwork: ${e}`
             );
@@ -683,18 +669,18 @@ export class Authority {
                 );
             }
 
-            this.performanceClient?.setPreQueueTime(
+            const autodetectedRegionName = await invokeAsync(
+                this.regionDiscovery.detectRegion.bind(this.regionDiscovery),
                 PerformanceEvents.RegionDiscoveryDetectRegion,
+                this.logger,
+                this.performanceClient,
                 this.correlationId
+            )(
+                this.authorityOptions.azureRegionConfiguration
+                    ?.environmentRegion,
+                this.regionDiscoveryMetadata
             );
 
-            const autodetectedRegionName =
-                await this.regionDiscovery.detectRegion(
-                    this.authorityOptions.azureRegionConfiguration
-                        ?.environmentRegion,
-                    this.regionDiscoveryMetadata
-                );
-
             if (autodetectedRegionName) {
                 this.regionDiscoveryMetadata.region_outcome =
                     RegionDiscoveryOutcomes.AUTO_DETECTION_REQUESTED_SUCCESSFUL;
@@ -796,29 +782,23 @@ export class Authority {
             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."
-        );
-
-        this.performanceClient?.setPreQueueTime(
+        metadata = await invokeAsync(
+            this.getCloudDiscoveryMetadataFromNetwork.bind(this),
             PerformanceEvents.AuthorityGetCloudDiscoveryMetadataFromNetwork,
+            this.logger,
+            this.performanceClient,
             this.correlationId
-        );
-        metadata = await this.getCloudDiscoveryMetadataFromNetwork();
+        )();
 
         if (metadata) {
-            this.logger.verbose(
-                "cloud discovery metadata was successfully returned from getCloudDiscoveryMetadataFromNetwork()"
-            );
             metadataEntity.updateCloudDiscoveryMetadata(metadata, true);
             return AuthorityMetadataSource.NETWORK;
         }
 
         // Metadata could not be obtained from the config, cache, network or hardcoded values
-        this.logger.error(
-            "Did not find cloud discovery metadata from network... Metadata could not be obtained from config, cache, network or hardcoded values. Throwing Untrusted Authority Error."
+        throw createClientConfigurationError(
+            ClientConfigurationErrorCodes.untrustedAuthority
         );
-        throw ClientConfigurationError.createUntrustedAuthorityError();
     }
 
     /**
@@ -867,7 +847,9 @@ export class Authority {
                 this.logger.verbose(
                     "Unable to parse the cloud discovery metadata. Throwing Invalid Cloud Discovery Metadata Error."
                 );
-                throw ClientConfigurationError.createInvalidCloudDiscoveryMetadataError();
+                throw createClientConfigurationError(
+                    ClientConfigurationErrorCodes.invalidCloudDiscoveryMetadata
+                );
             }
         }
 
@@ -1090,8 +1072,8 @@ export class Authority {
         if (this.discoveryComplete()) {
             return this.metadata.preferred_cache;
         } else {
-            throw ClientAuthError.createEndpointDiscoveryIncompleteError(
-                "Discovery incomplete."
+            throw createClientAuthError(
+                ClientAuthErrorCodes.endpointResolutionError
             );
         }
     }

package/src/authority/AuthorityFactory.ts

@@ -4,14 +4,21 @@
  */
 
 import { Authority } from "./Authority";
-import { ClientConfigurationError } from "../error/ClientConfigurationError";
+import {
+    createClientConfigurationError,
+    ClientConfigurationErrorCodes,
+} from "../error/ClientConfigurationError";
 import { INetworkModule } from "../network/INetworkModule";
-import { ClientAuthError } from "../error/ClientAuthError";
+import {
+    createClientAuthError,
+    ClientAuthErrorCodes,
+} from "../error/ClientAuthError";
 import { ICacheManager } from "../cache/interface/ICacheManager";
 import { AuthorityOptions } from "./AuthorityOptions";
 import { Logger } from "../logger/Logger";
 import { IPerformanceClient } from "../telemetry/performance/IPerformanceClient";
 import { PerformanceEvents } from "../telemetry/performance/PerformanceEvent";
+import { invokeAsync } from "../utils/FunctionWrappers";
 
 /** @internal */
 export class AuthorityFactory {
@@ -55,16 +62,19 @@ export class AuthorityFactory {
             );
 
         try {
-            performanceClient?.setPreQueueTime(
+            await invokeAsync(
+                acquireTokenAuthority.resolveEndpointsAsync.bind(
+                    acquireTokenAuthority
+                ),
                 PerformanceEvents.AuthorityResolveEndpointsAsync,
+                logger,
+                performanceClient,
                 correlationId
-            );
-
-            await acquireTokenAuthority.resolveEndpointsAsync();
+            )();
             return acquireTokenAuthority;
         } catch (e) {
-            throw ClientAuthError.createEndpointDiscoveryIncompleteError(
-                e as string
+            throw createClientAuthError(
+                ClientAuthErrorCodes.endpointResolutionError
             );
         }
     }
@@ -90,7 +100,9 @@ export class AuthorityFactory {
     ): Authority {
         // Throw error if authority url is empty
         if (!authorityUrl) {
-            throw ClientConfigurationError.createUrlEmptyError();
+            throw createClientConfigurationError(
+                ClientConfigurationErrorCodes.urlEmptyError
+            );
         }
 
         return new Authority(

package/src/authority/RegionDiscovery.ts

@@ -15,10 +15,14 @@ import { RegionDiscoveryMetadata } from "./RegionDiscoveryMetadata";
 import { ImdsOptions } from "./ImdsOptions";
 import { IPerformanceClient } from "../telemetry/performance/IPerformanceClient";
 import { PerformanceEvents } from "../telemetry/performance/PerformanceEvent";
+import { invokeAsync } from "../utils/FunctionWrappers";
+import { Logger } from "../logger/Logger";
 
 export class RegionDiscovery {
     // Network interface to make requests with.
     protected networkInterface: INetworkModule;
+    // Logger
+    private logger: Logger;
     // Performance client
     protected performanceClient: IPerformanceClient | undefined;
     // CorrelationId
@@ -32,10 +36,12 @@ export class RegionDiscovery {
 
     constructor(
         networkInterface: INetworkModule,
+        logger: Logger,
         performanceClient?: IPerformanceClient,
         correlationId?: string
     ) {
         this.networkInterface = networkInterface;
+        this.logger = logger;
         this.performanceClient = performanceClient;
         this.correlationId = correlationId;
     }
@@ -62,14 +68,13 @@ export class RegionDiscovery {
             const options = RegionDiscovery.IMDS_OPTIONS;
 
             try {
-                this.performanceClient?.setPreQueueTime(
+                const localIMDSVersionResponse = await invokeAsync(
+                    this.getRegionFromIMDS.bind(this),
                     PerformanceEvents.RegionDiscoveryGetRegionFromIMDS,
+                    this.logger,
+                    this.performanceClient,
                     this.correlationId
-                );
-                const localIMDSVersionResponse = await this.getRegionFromIMDS(
-                    Constants.IMDS_VERSION,
-                    options
-                );
+                )(Constants.IMDS_VERSION, options);
                 if (
                     localIMDSVersionResponse.status ===
                     ResponseCodes.httpSuccess
@@ -84,28 +89,26 @@ export class RegionDiscovery {
                     localIMDSVersionResponse.status ===
                     ResponseCodes.httpBadRequest
                 ) {
-                    this.performanceClient?.setPreQueueTime(
+                    const currentIMDSVersion = await invokeAsync(
+                        this.getCurrentVersion.bind(this),
                         PerformanceEvents.RegionDiscoveryGetCurrentVersion,
+                        this.logger,
+                        this.performanceClient,
                         this.correlationId
-                    );
-                    const currentIMDSVersion = await this.getCurrentVersion(
-                        options
-                    );
+                    )(options);
                     if (!currentIMDSVersion) {
                         regionDiscoveryMetadata.region_source =
                             RegionDiscoverySources.FAILED_AUTO_DETECTION;
                         return null;
                     }
 
-                    this.performanceClient?.setPreQueueTime(
+                    const currentIMDSVersionResponse = await invokeAsync(
+                        this.getRegionFromIMDS.bind(this),
                         PerformanceEvents.RegionDiscoveryGetRegionFromIMDS,
+                        this.logger,
+                        this.performanceClient,
                         this.correlationId
-                    );
-                    const currentIMDSVersionResponse =
-                        await this.getRegionFromIMDS(
-                            currentIMDSVersion,
-                            options
-                        );
+                    )(currentIMDSVersion, options);
                     if (
                         currentIMDSVersionResponse.status ===
                         ResponseCodes.httpSuccess