@azure/msal-common 14.6.0-alpha.0 → 14.6.1

package/src/authority/Authority.ts

@@ -57,6 +57,7 @@ import { AuthError } from "../error/AuthError";
 import { IPerformanceClient } from "../telemetry/performance/IPerformanceClient";
 import { PerformanceEvents } from "../telemetry/performance/PerformanceEvent";
 import { invokeAsync } from "../utils/FunctionWrappers";
+import * as CacheHelpers from "../cache/utils/CacheHelpers";
 
 /**
  * The authority class validates the authority URIs used by the user, and retrieves the OpenID Configuration Data from the
@@ -85,9 +86,7 @@ export class Authority {
     // Performance client
     protected performanceClient: IPerformanceClient | undefined;
     // Correlation Id
-    protected correlationId: string | undefined;
-    // Indicates if the authority is fake, for the purpose of a Managed Identity Application
-    private managedIdentity: boolean;
+    protected correlationId: string;
     // Reserved tenant domain names that will not be replaced with tenant id
     private static reservedTenantDomains: Set<string> = new Set([
         "{tenant}",
@@ -103,9 +102,8 @@ export class Authority {
         cacheManager: ICacheManager,
         authorityOptions: AuthorityOptions,
         logger: Logger,
-        performanceClient?: IPerformanceClient,
-        correlationId?: string,
-        managedIdentity?: boolean
+        correlationId: string,
+        performanceClient?: IPerformanceClient
     ) {
         this.canonicalAuthority = authority;
         this._canonicalAuthority.validateAsUri();
@@ -120,7 +118,6 @@ export class Authority {
         this.logger = logger;
         this.performanceClient = performanceClient;
         this.correlationId = correlationId;
-        this.managedIdentity = managedIdentity || false;
         this.regionDiscovery = new RegionDiscovery(
             networkInterface,
             this.logger,
@@ -386,7 +383,7 @@ export class Authority {
     }
 
     /**
-     * Boolean that returns whether or not tenant discovery has been completed.
+     * Boolean that returns whethr or not tenant discovery has been completed.
      */
     discoveryComplete(): boolean {
         return !!this.metadata;
@@ -425,6 +422,13 @@ export class Authority {
         this.updateCachedMetadata(metadataEntity, cloudDiscoverySource, {
             source: endpointSource,
         });
+        this.performanceClient?.addFields(
+            {
+                cloudDiscoverySource: cloudDiscoverySource,
+                authorityEndpointSource: endpointSource,
+            },
+            this.correlationId
+        );
     }
 
     /**
@@ -433,13 +437,24 @@ export class Authority {
      * @returns
      */
     private getCurrentMetadataEntity(): AuthorityMetadataEntity {
-        let metadataEntity = this.cacheManager.getAuthorityMetadataByAlias(
-            this.hostnameAndPort
-        );
+        let metadataEntity: AuthorityMetadataEntity | null =
+            this.cacheManager.getAuthorityMetadataByAlias(this.hostnameAndPort);
 
         if (!metadataEntity) {
-            metadataEntity = new AuthorityMetadataEntity();
-            metadataEntity.updateCanonicalAuthority(this.canonicalAuthority);
+            metadataEntity = {
+                aliases: [],
+                preferred_cache: this.hostnameAndPort,
+                preferred_network: this.hostnameAndPort,
+                canonical_authority: this.canonicalAuthority,
+                authorization_endpoint: "",
+                token_endpoint: "",
+                end_session_endpoint: "",
+                issuer: "",
+                aliasesFromNetwork: false,
+                endpointsFromNetwork: false,
+                expiresAt: CacheHelpers.generateAuthorityMetadataExpiresAt(),
+                jwks_uri: "",
+            };
         }
         return metadataEntity;
     }
@@ -464,8 +479,9 @@ export class Authority {
             endpointMetadataResult?.source !== AuthorityMetadataSource.CACHE
         ) {
             // Reset the expiration time unless both values came from a successful cache lookup
-            metadataEntity.resetExpiresAt();
-            metadataEntity.updateCanonicalAuthority(this.canonicalAuthority);
+            metadataEntity.expiresAt =
+                CacheHelpers.generateAuthorityMetadataExpiresAt();
+            metadataEntity.canonical_authority = this.canonicalAuthority;
         }
 
         const cacheKey = this.cacheManager.generateAuthorityMetadataCacheKey(
@@ -510,10 +526,13 @@ export class Authority {
                             this.performanceClient,
                             this.correlationId
                         )(localMetadata.metadata);
-                        metadataEntity.updateEndpointMetadata(
+                        CacheHelpers.updateAuthorityEndpointMetadata(
+                            metadataEntity,
                             hardcodedMetadata,
                             false
                         );
+                        metadataEntity.canonical_authority =
+                            this.canonicalAuthority;
                     }
                 }
             }
@@ -540,7 +559,11 @@ export class Authority {
                 )(metadata);
             }
 
-            metadataEntity.updateEndpointMetadata(metadata, true);
+            CacheHelpers.updateAuthorityEndpointMetadata(
+                metadataEntity,
+                metadata,
+                true
+            );
             return AuthorityMetadataSource.NETWORK;
         } else {
             // Metadata could not be obtained from the config, cache, network or hardcoded values
@@ -571,7 +594,11 @@ export class Authority {
             this.logger.verbose(
                 "Found endpoint metadata in authority configuration"
             );
-            metadataEntity.updateEndpointMetadata(configMetadata, false);
+            CacheHelpers.updateAuthorityEndpointMetadata(
+                metadataEntity,
+                configMetadata,
+                false
+            );
             return {
                 source: AuthorityMetadataSource.CONFIG,
             };
@@ -590,7 +617,11 @@ export class Authority {
             const hardcodedMetadata =
                 this.getEndpointMetadataFromHardcodedValues();
             if (hardcodedMetadata) {
-                metadataEntity.updateEndpointMetadata(hardcodedMetadata, false);
+                CacheHelpers.updateAuthorityEndpointMetadata(
+                    metadataEntity,
+                    hardcodedMetadata,
+                    false
+                );
                 return {
                     source: AuthorityMetadataSource.HARDCODED_VALUES,
                     metadata: hardcodedMetadata,
@@ -603,7 +634,8 @@ export class Authority {
         }
 
         // Check cached metadata entity expiration status
-        const metadataEntityExpired = metadataEntity.isExpired();
+        const metadataEntityExpired =
+            CacheHelpers.isAuthorityMetadataExpired(metadataEntity);
         if (
             this.isAuthoritySameType(metadataEntity) &&
             metadataEntity.endpointsFromNetwork &&
@@ -709,8 +741,8 @@ export class Authority {
      * Get OAuth endpoints for common authorities.
      */
     private getEndpointMetadataFromHardcodedValues(): OpenIdConfigResponse | null {
-        if (this.canonicalAuthority in EndpointMetadata) {
-            return EndpointMetadata[this.canonicalAuthority];
+        if (this.hostnameAndPort in EndpointMetadata) {
+            return EndpointMetadata[this.hostnameAndPort];
         }
 
         return null;
@@ -805,7 +837,11 @@ export class Authority {
         )();
 
         if (metadata) {
-            metadataEntity.updateCloudDiscoveryMetadata(metadata, true);
+            CacheHelpers.updateCloudDiscoveryMetadata(
+                metadataEntity,
+                metadata,
+                true
+            );
             return AuthorityMetadataSource.NETWORK;
         }
 
@@ -843,7 +879,11 @@ export class Authority {
             this.logger.verbose(
                 "Found cloud discovery metadata in authority configuration"
             );
-            metadataEntity.updateCloudDiscoveryMetadata(metadata, false);
+            CacheHelpers.updateCloudDiscoveryMetadata(
+                metadataEntity,
+                metadata,
+                false
+            );
             return AuthorityMetadataSource.CONFIG;
         }
 
@@ -865,7 +905,8 @@ export class Authority {
                 this.logger.verbose(
                     "Found cloud discovery metadata from hardcoded values."
                 );
-                metadataEntity.updateCloudDiscoveryMetadata(
+                CacheHelpers.updateCloudDiscoveryMetadata(
+                    metadataEntity,
                     hardcodedMetadata,
                     false
                 );
@@ -877,7 +918,8 @@ export class Authority {
             );
         }
 
-        const metadataEntityExpired = metadataEntity.isExpired();
+        const metadataEntityExpired =
+            CacheHelpers.isAuthorityMetadataExpired(metadataEntity);
         if (
             this.isAuthoritySameType(metadataEntity) &&
             metadataEntity.aliasesFromNetwork &&
@@ -1123,9 +1165,7 @@ export class Authority {
      * helper function to generate environment from authority object
      */
     getPreferredCache(): string {
-        if (this.managedIdentity) {
-            return Constants.DEFAULT_AUTHORITY_HOST;
-        } else if (this.discoveryComplete()) {
+        if (this.discoveryComplete()) {
             return this.metadata.preferred_cache;
         } else {
             throw createClientAuthError(

package/src/authority/AuthorityFactory.ts

@@ -4,10 +4,6 @@
  */
 
 import { Authority, formatAuthorityUri } from "./Authority";
-import {
-    createClientConfigurationError,
-    ClientConfigurationErrorCodes,
-} from "../error/ClientConfigurationError";
 import { INetworkModule } from "../network/INetworkModule";
 import {
     createClientAuthError,
@@ -20,99 +16,59 @@ import { IPerformanceClient } from "../telemetry/performance/IPerformanceClient"
 import { PerformanceEvents } from "../telemetry/performance/PerformanceEvent";
 import { invokeAsync } from "../utils/FunctionWrappers";
 
-/** @internal */
-export class AuthorityFactory {
-    /**
-     * Create an authority object of the correct type based on the url
-     * Performs basic authority validation - checks to see if the authority is of a valid type (i.e. aad, b2c, adfs)
-     *
-     * Also performs endpoint discovery.
-     *
-     * @param authorityUri
-     * @param networkClient
-     * @param protocolMode
-     */
-    static async createDiscoveredInstance(
-        authorityUri: string,
-        networkClient: INetworkModule,
-        cacheManager: ICacheManager,
-        authorityOptions: AuthorityOptions,
-        logger: Logger,
-        performanceClient?: IPerformanceClient,
-        correlationId?: string
-    ): Promise<Authority> {
-        performanceClient?.addQueueMeasurement(
-            PerformanceEvents.AuthorityFactoryCreateDiscoveredInstance,
-            correlationId
-        );
-        const authorityUriFinal = Authority.transformCIAMAuthority(
-            formatAuthorityUri(authorityUri)
-        );
-
-        // Initialize authority and perform discovery endpoint check.
-        const acquireTokenAuthority: Authority =
-            AuthorityFactory.createInstance(
-                authorityUriFinal,
-                networkClient,
-                cacheManager,
-                authorityOptions,
-                logger,
-                performanceClient,
-                correlationId
-            );
-
-        try {
-            await invokeAsync(
-                acquireTokenAuthority.resolveEndpointsAsync.bind(
-                    acquireTokenAuthority
-                ),
-                PerformanceEvents.AuthorityResolveEndpointsAsync,
-                logger,
-                performanceClient,
-                correlationId
-            )();
-            return acquireTokenAuthority;
-        } catch (e) {
-            throw createClientAuthError(
-                ClientAuthErrorCodes.endpointResolutionError
-            );
-        }
-    }
+/**
+ * Create an authority object of the correct type based on the url
+ * Performs basic authority validation - checks to see if the authority is of a valid type (i.e. aad, b2c, adfs)
+ *
+ * Also performs endpoint discovery.
+ *
+ * @param authorityUri
+ * @param networkClient
+ * @param protocolMode
+ * @internal
+ */
+export async function createDiscoveredInstance(
+    authorityUri: string,
+    networkClient: INetworkModule,
+    cacheManager: ICacheManager,
+    authorityOptions: AuthorityOptions,
+    logger: Logger,
+    correlationId: string,
+    performanceClient?: IPerformanceClient
+): Promise<Authority> {
+    performanceClient?.addQueueMeasurement(
+        PerformanceEvents.AuthorityFactoryCreateDiscoveredInstance,
+        correlationId
+    );
+    const authorityUriFinal = Authority.transformCIAMAuthority(
+        formatAuthorityUri(authorityUri)
+    );
 
-    /**
-     * Create an authority object of the correct type based on the url
-     * Performs basic authority validation - checks to see if the authority is of a valid type (i.e. aad, b2c, adfs)
-     *
-     * Does not perform endpoint discovery.
-     *
-     * @param authorityUrl
-     * @param networkInterface
-     * @param protocolMode
-     */
-    static createInstance(
-        authorityUrl: string,
-        networkInterface: INetworkModule,
-        cacheManager: ICacheManager,
-        authorityOptions: AuthorityOptions,
-        logger: Logger,
-        performanceClient?: IPerformanceClient,
-        correlationId?: string
-    ): Authority {
-        // Throw error if authority url is empty
-        if (!authorityUrl) {
-            throw createClientConfigurationError(
-                ClientConfigurationErrorCodes.urlEmptyError
-            );
-        }
+    // Initialize authority and perform discovery endpoint check.
+    const acquireTokenAuthority: Authority = new Authority(
+        authorityUriFinal,
+        networkClient,
+        cacheManager,
+        authorityOptions,
+        logger,
+        correlationId,
+        performanceClient
+    );
 
-        return new Authority(
-            authorityUrl,
-            networkInterface,
-            cacheManager,
-            authorityOptions,
+    try {
+        await invokeAsync(
+            acquireTokenAuthority.resolveEndpointsAsync.bind(
+                acquireTokenAuthority
+            ),
+            PerformanceEvents.AuthorityResolveEndpointsAsync,
             logger,
             performanceClient,
             correlationId
+        )();
+        return acquireTokenAuthority;
+    } catch (e) {
+        throw createClientAuthError(
+            ClientAuthErrorCodes.endpointResolutionError
         );
     }
 }