@azure/msal-browser 4.27.0 → 5.0.0-beta.0

package/src/interaction_client/SilentAuthCodeClient.ts

@@ -13,7 +13,11 @@ import {
     invokeAsync,
     CommonAuthorizationUrlRequest,
 } from "@azure/msal-common/browser";
-import { StandardInteractionClient } from "./StandardInteractionClient.js";
+import {
+    initializeAuthorizationRequest,
+    StandardInteractionClient,
+} from "./StandardInteractionClient.js";
+import * as BrowserPerformanceEvents from "../telemetry/BrowserPerformanceEvents.js";
 import { BrowserConfiguration } from "../config/Configuration.js";
 import { BrowserCacheManager } from "../cache/BrowserCacheManager.js";
 import { EventHandler } from "../event/EventHandler.js";
@@ -28,6 +32,7 @@ import { HybridSpaAuthorizationCodeClient } from "./HybridSpaAuthorizationCodeCl
 import { AuthenticationResult } from "../response/AuthenticationResult.js";
 import { InteractionHandler } from "../interaction_handler/InteractionHandler.js";
 import { IPlatformAuthHandler } from "../broker/nativeBroker/IPlatformAuthHandler.js";
+import { initializeServerTelemetryManager } from "./BaseInteractionClient.js";
 
 export class SilentAuthCodeClient extends StandardInteractionClient {
     private apiId: ApiId;
@@ -41,8 +46,8 @@ export class SilentAuthCodeClient extends StandardInteractionClient {
         navigationClient: INavigationClient,
         apiId: ApiId,
         performanceClient: IPerformanceClient,
-        platformAuthProvider?: IPlatformAuthHandler,
-        correlationId?: string
+        correlationId: string,
+        platformAuthProvider?: IPlatformAuthHandler
     ) {
         super(
             config,
@@ -52,8 +57,8 @@ export class SilentAuthCodeClient extends StandardInteractionClient {
             eventHandler,
             navigationClient,
             performanceClient,
-            platformAuthProvider,
-            correlationId
+            correlationId,
+            platformAuthProvider
         );
         this.apiId = apiId;
     }
@@ -74,15 +79,32 @@ export class SilentAuthCodeClient extends StandardInteractionClient {
 
         // Create silent request
         const silentRequest: CommonAuthorizationUrlRequest = await invokeAsync(
-            this.initializeAuthorizationRequest.bind(this),
-            PerformanceEvents.StandardInteractionClientInitializeAuthorizationRequest,
+            initializeAuthorizationRequest,
+            BrowserPerformanceEvents.StandardInteractionClientInitializeAuthorizationRequest,
+            this.logger,
+            this.performanceClient,
+            this.correlationId
+        )(
+            request,
+            InteractionType.Silent,
+            this.config,
+            this.browserCrypto,
+            this.browserStorage,
             this.logger,
             this.performanceClient,
-            request.correlationId
-        )(request, InteractionType.Silent);
+            /*
+             * correlationId is optional in request payload, while this.correlationId is always instantiated as request.correlationId || createGuid().
+             * Each auth request creates a new instance of *Client so we can safely use this.correlationId.
+             */
+            this.correlationId
+        );
 
-        const serverTelemetryManager = this.initializeServerTelemetryManager(
-            this.apiId
+        const serverTelemetryManager = initializeServerTelemetryManager(
+            this.apiId,
+            this.config.auth.clientId,
+            this.correlationId,
+            this.browserStorage,
+            this.logger
         );
 
         try {
@@ -95,10 +117,10 @@ export class SilentAuthCodeClient extends StandardInteractionClient {
             // Initialize the client
             const clientConfig = await invokeAsync(
                 this.getClientConfiguration.bind(this),
-                PerformanceEvents.StandardInteractionClientGetClientConfiguration,
+                BrowserPerformanceEvents.StandardInteractionClientGetClientConfiguration,
                 this.logger,
                 this.performanceClient,
-                request.correlationId
+                this.correlationId
             )({
                 serverTelemetryManager,
                 requestAuthority: silentRequest.authority,
@@ -107,8 +129,11 @@ export class SilentAuthCodeClient extends StandardInteractionClient {
                 account: silentRequest.account,
             });
             const authClient: HybridSpaAuthorizationCodeClient =
-                new HybridSpaAuthorizationCodeClient(clientConfig);
-            this.logger.verbose("Auth code client created");
+                new HybridSpaAuthorizationCodeClient(
+                    clientConfig,
+                    this.performanceClient
+                );
+            this.logger.verbose("Auth code client created", this.correlationId);
 
             // Create silent handler
             const interactionHandler = new InteractionHandler(
@@ -127,7 +152,7 @@ export class SilentAuthCodeClient extends StandardInteractionClient {
                 PerformanceEvents.HandleCodeResponseFromServer,
                 this.logger,
                 this.performanceClient,
-                request.correlationId
+                this.correlationId
             )(
                 {
                     code: request.code,

package/src/interaction_client/SilentCacheClient.ts

@@ -7,9 +7,9 @@ import { StandardInteractionClient } from "./StandardInteractionClient.js";
 import {
     CommonSilentFlowRequest,
     SilentFlowClient,
-    PerformanceEvents,
     invokeAsync,
 } from "@azure/msal-common/browser";
+import * as BrowserPerformanceEvents from "../telemetry/BrowserPerformanceEvents.js";
 import { ApiId } from "../utils/BrowserConstants.js";
 import {
     BrowserAuthError,
@@ -17,6 +17,10 @@ import {
 } from "../error/BrowserAuthError.js";
 import { AuthenticationResult } from "../response/AuthenticationResult.js";
 import { ClearCacheRequest } from "../request/ClearCacheRequest.js";
+import {
+    clearCacheOnLogout,
+    initializeServerTelemetryManager,
+} from "./BaseInteractionClient.js";
 
 export class SilentCacheClient extends StandardInteractionClient {
     /**
@@ -26,18 +30,18 @@ export class SilentCacheClient extends StandardInteractionClient {
     async acquireToken(
         silentRequest: CommonSilentFlowRequest
     ): Promise<AuthenticationResult> {
-        this.performanceClient.addQueueMeasurement(
-            PerformanceEvents.SilentCacheClientAcquireToken,
-            silentRequest.correlationId
-        );
         // Telemetry manager only used to increment cacheHits here
-        const serverTelemetryManager = this.initializeServerTelemetryManager(
-            ApiId.acquireTokenSilent_silentFlow
+        const serverTelemetryManager = initializeServerTelemetryManager(
+            ApiId.acquireTokenSilent_silentFlow,
+            this.config.auth.clientId,
+            this.correlationId,
+            this.browserStorage,
+            this.logger
         );
 
         const clientConfig = await invokeAsync(
             this.getClientConfiguration.bind(this),
-            PerformanceEvents.StandardInteractionClientGetClientConfiguration,
+            BrowserPerformanceEvents.StandardInteractionClientGetClientConfiguration,
             this.logger,
             this.performanceClient,
             this.correlationId
@@ -51,12 +55,12 @@ export class SilentCacheClient extends StandardInteractionClient {
             clientConfig,
             this.performanceClient
         );
-        this.logger.verbose("Silent auth client created");
+        this.logger.verbose("Silent auth client created", this.correlationId);
 
         try {
             const response = await invokeAsync(
                 silentAuthClient.acquireCachedToken.bind(silentAuthClient),
-                PerformanceEvents.SilentFlowClientAcquireCachedToken,
+                BrowserPerformanceEvents.SilentFlowClientAcquireCachedToken,
                 this.logger,
                 this.performanceClient,
                 silentRequest.correlationId
@@ -76,7 +80,8 @@ export class SilentCacheClient extends StandardInteractionClient {
                 error.errorCode === BrowserAuthErrorCodes.cryptoKeyNotFound
             ) {
                 this.logger.verbose(
-                    "Signing keypair for bound access token not found. Refreshing bound access token and generating a new crypto keypair."
+                    "Signing keypair for bound access token not found. Refreshing bound access token and generating a new crypto keypair.",
+                    this.correlationId
                 );
             }
             throw error;
@@ -88,11 +93,14 @@ export class SilentCacheClient extends StandardInteractionClient {
      * @param logoutRequest
      */
     logout(logoutRequest?: ClearCacheRequest): Promise<void> {
-        this.logger.verbose("logoutRedirect called");
+        this.logger.verbose("logoutRedirect called", this.correlationId);
         const validLogoutRequest = this.initializeLogoutRequest(logoutRequest);
-        return this.clearCacheOnLogout(
-            validLogoutRequest.correlationId,
-            validLogoutRequest?.account
+        return clearCacheOnLogout(
+            this.browserStorage,
+            this.browserCrypto,
+            this.logger,
+            this.correlationId,
+            validLogoutRequest.account
         );
     }
 }

package/src/interaction_client/SilentIframeClient.ts

@@ -6,7 +6,7 @@
 import {
     ICrypto,
     Logger,
-    PromptValue,
+    Constants,
     AuthorizationCodeClient,
     AuthError,
     IPerformanceClient,
@@ -15,9 +15,12 @@ import {
     invoke,
     ProtocolMode,
     CommonAuthorizationUrlRequest,
-    HttpMethod,
 } from "@azure/msal-common/browser";
-import { StandardInteractionClient } from "./StandardInteractionClient.js";
+import {
+    initializeAuthorizationRequest,
+    StandardInteractionClient,
+} from "./StandardInteractionClient.js";
+import * as BrowserPerformanceEvents from "../telemetry/BrowserPerformanceEvents.js";
 import { BrowserConfiguration } from "../config/Configuration.js";
 import { BrowserCacheManager } from "../cache/BrowserCacheManager.js";
 import { EventHandler } from "../event/EventHandler.js";
@@ -35,7 +38,6 @@ import {
     initiateCodeRequest,
     initiateCodeFlowWithPost,
     initiateEarRequest,
-    monitorIframeForHash,
 } from "../interaction_handler/SilentHandler.js";
 import { SsoSilentRequest } from "../request/SsoSilentRequest.js";
 import { AuthenticationResult } from "../response/AuthenticationResult.js";
@@ -46,6 +48,10 @@ import { generatePkceCodes } from "../crypto/PkceGenerator.js";
 import { isPlatformAuthAllowed } from "../broker/nativeBroker/PlatformAuthProvider.js";
 import { generateEarKey } from "../crypto/BrowserCrypto.js";
 import { IPlatformAuthHandler } from "../broker/nativeBroker/IPlatformAuthHandler.js";
+import {
+    getDiscoveredAuthority,
+    initializeServerTelemetryManager,
+} from "./BaseInteractionClient.js";
 
 export class SilentIframeClient extends StandardInteractionClient {
     protected apiId: ApiId;
@@ -61,8 +67,8 @@ export class SilentIframeClient extends StandardInteractionClient {
         apiId: ApiId,
         performanceClient: IPerformanceClient,
         nativeStorageImpl: BrowserCacheManager,
-        platformAuthProvider?: IPlatformAuthHandler,
-        correlationId?: string
+        correlationId: string,
+        platformAuthProvider?: IPlatformAuthHandler
     ) {
         super(
             config,
@@ -72,8 +78,8 @@ export class SilentIframeClient extends StandardInteractionClient {
             eventHandler,
             navigationClient,
             performanceClient,
-            platformAuthProvider,
-            correlationId
+            correlationId,
+            platformAuthProvider
         );
         this.apiId = apiId;
         this.nativeStorage = nativeStorageImpl;
@@ -86,10 +92,6 @@ export class SilentIframeClient extends StandardInteractionClient {
     async acquireToken(
         request: SsoSilentRequest
     ): Promise<AuthenticationResult> {
-        this.performanceClient.addQueueMeasurement(
-            PerformanceEvents.SilentIframeClientAcquireToken,
-            request.correlationId
-        );
         // Check that we have some SSO data
         if (
             !request.loginHint &&
@@ -97,7 +99,8 @@ export class SilentIframeClient extends StandardInteractionClient {
             (!request.account || !request.account.username)
         ) {
             this.logger.warning(
-                "No user hint provided. The authorization server may need more information to complete this request."
+                "No user hint provided. The authorization server may need more information to complete this request.",
+                this.correlationId
             );
         }
 
@@ -105,35 +108,46 @@ export class SilentIframeClient extends StandardInteractionClient {
         const inputRequest = { ...request };
         if (inputRequest.prompt) {
             if (
-                inputRequest.prompt !== PromptValue.NONE &&
-                inputRequest.prompt !== PromptValue.NO_SESSION
+                inputRequest.prompt !== Constants.PromptValue.NONE &&
+                inputRequest.prompt !== Constants.PromptValue.NO_SESSION
             ) {
                 this.logger.warning(
-                    `SilentIframeClient. Replacing invalid prompt ${inputRequest.prompt} with ${PromptValue.NONE}`
+                    `SilentIframeClient. Replacing invalid prompt '${inputRequest.prompt}' with '${Constants.PromptValue.NONE}'`,
+                    this.correlationId
                 );
-                inputRequest.prompt = PromptValue.NONE;
+                inputRequest.prompt = Constants.PromptValue.NONE;
             }
         } else {
-            inputRequest.prompt = PromptValue.NONE;
+            inputRequest.prompt = Constants.PromptValue.NONE;
         }
 
         // Create silent request
         const silentRequest: CommonAuthorizationUrlRequest = await invokeAsync(
-            this.initializeAuthorizationRequest.bind(this),
-            PerformanceEvents.StandardInteractionClientInitializeAuthorizationRequest,
+            initializeAuthorizationRequest,
+            BrowserPerformanceEvents.StandardInteractionClientInitializeAuthorizationRequest,
             this.logger,
             this.performanceClient,
-            request.correlationId
-        )(inputRequest, InteractionType.Silent);
+            this.correlationId
+        )(
+            inputRequest,
+            InteractionType.Silent,
+            this.config,
+            this.browserCrypto,
+            this.browserStorage,
+            this.logger,
+            this.performanceClient,
+            this.correlationId
+        );
         silentRequest.platformBroker = isPlatformAuthAllowed(
             this.config,
             this.logger,
+            this.correlationId,
             this.platformAuthProvider,
             silentRequest.authenticationScheme
         );
         BrowserUtils.preconnect(silentRequest.authority);
 
-        if (this.config.auth.protocolMode === ProtocolMode.EAR) {
+        if (this.config.system.protocolMode === ProtocolMode.EAR) {
             return this.executeEarFlow(silentRequest);
         } else {
             return this.executeCodeFlow(silentRequest);
@@ -149,15 +163,19 @@ export class SilentIframeClient extends StandardInteractionClient {
         request: CommonAuthorizationUrlRequest
     ): Promise<AuthenticationResult> {
         let authClient: AuthorizationCodeClient | undefined;
-        const serverTelemetryManager = this.initializeServerTelemetryManager(
-            this.apiId
+        const serverTelemetryManager = initializeServerTelemetryManager(
+            this.apiId,
+            this.config.auth.clientId,
+            this.correlationId,
+            this.browserStorage,
+            this.logger
         );
 
         try {
             // Initialize the client
             authClient = await invokeAsync(
                 this.createAuthCodeClient.bind(this),
-                PerformanceEvents.StandardInteractionClientCreateAuthCodeClient,
+                BrowserPerformanceEvents.StandardInteractionClientCreateAuthCodeClient,
                 this.logger,
                 this.performanceClient,
                 request.correlationId
@@ -171,7 +189,7 @@ export class SilentIframeClient extends StandardInteractionClient {
 
             return await invokeAsync(
                 this.silentTokenHelper.bind(this),
-                PerformanceEvents.SilentIframeClientTokenHelper,
+                BrowserPerformanceEvents.SilentIframeClientTokenHelper,
                 this.logger,
                 this.performanceClient,
                 request.correlationId
@@ -199,7 +217,7 @@ export class SilentIframeClient extends StandardInteractionClient {
 
             return await invokeAsync(
                 this.silentTokenHelper.bind(this),
-                PerformanceEvents.SilentIframeClientTokenHelper,
+                BrowserPerformanceEvents.SilentIframeClientTokenHelper,
                 this.logger,
                 this.performanceClient,
                 this.correlationId
@@ -214,30 +232,41 @@ export class SilentIframeClient extends StandardInteractionClient {
     async executeEarFlow(
         request: CommonAuthorizationUrlRequest
     ): Promise<AuthenticationResult> {
-        const correlationId = request.correlationId;
+        const {
+            correlationId,
+            authority,
+            azureCloudOptions,
+            extraQueryParameters,
+            account,
+        } = request;
         const discoveredAuthority = await invokeAsync(
-            this.getDiscoveredAuthority.bind(this),
-            PerformanceEvents.StandardInteractionClientGetDiscoveredAuthority,
+            getDiscoveredAuthority,
+            BrowserPerformanceEvents.StandardInteractionClientGetDiscoveredAuthority,
             this.logger,
             this.performanceClient,
             correlationId
-        )({
-            requestAuthority: request.authority,
-            requestAzureCloudOptions: request.azureCloudOptions,
-            requestExtraQueryParameters: request.extraQueryParameters,
-            account: request.account,
-        });
+        )(
+            this.config,
+            this.correlationId,
+            this.performanceClient,
+            this.browserStorage,
+            this.logger,
+            authority,
+            azureCloudOptions,
+            extraQueryParameters,
+            account
+        );
 
         const earJwk = await invokeAsync(
             generateEarKey,
-            PerformanceEvents.GenerateEarKey,
+            BrowserPerformanceEvents.GenerateEarKey,
             this.logger,
             this.performanceClient,
             correlationId
         )();
         const pkceCodes = await invokeAsync(
             generatePkceCodes,
-            PerformanceEvents.GeneratePkceCodes,
+            BrowserPerformanceEvents.GeneratePkceCodes,
             this.logger,
             this.performanceClient,
             correlationId
@@ -247,9 +276,9 @@ export class SilentIframeClient extends StandardInteractionClient {
             earJwk: earJwk,
             codeChallenge: pkceCodes.challenge,
         };
-        const msalFrame = await invokeAsync(
+        await invokeAsync(
             initiateEarRequest,
-            PerformanceEvents.SilentHandlerInitiateAuthRequest,
+            BrowserPerformanceEvents.SilentHandlerInitiateAuthRequest,
             this.logger,
             this.performanceClient,
             correlationId
@@ -261,43 +290,43 @@ export class SilentIframeClient extends StandardInteractionClient {
             this.performanceClient
         );
 
-        const responseType = this.config.auth.OIDCOptions.serverResponseType;
-        // Monitor the window for the hash. Return the string value and close the popup when the hash is received. Default timeout is 60 seconds.
+        const responseType = this.config.auth.OIDCOptions.responseMode;
         const responseString = await invokeAsync(
-            monitorIframeForHash,
-            PerformanceEvents.SilentHandlerMonitorIframeForHash,
+            BrowserUtils.waitForBridgeResponse,
+            BrowserPerformanceEvents.SilentHandlerMonitorIframeForHash,
             this.logger,
             this.performanceClient,
             correlationId
         )(
-            msalFrame,
-            this.config.system.iframeHashTimeout,
-            this.config.system.pollIntervalMilliseconds,
-            this.performanceClient,
+            this.config.system.iframeBridgeTimeout,
             this.logger,
-            correlationId,
-            responseType
+            this.browserCrypto,
+            request
         );
 
         const serverParams = invoke(
             ResponseHandler.deserializeResponse,
-            PerformanceEvents.DeserializeResponse,
+            BrowserPerformanceEvents.DeserializeResponse,
             this.logger,
             this.performanceClient,
             correlationId
-        )(responseString, responseType, this.logger);
+        )(responseString, responseType, this.logger, this.correlationId);
 
         if (!serverParams.ear_jwe && serverParams.code) {
             // If server doesn't support EAR, they may fallback to auth code flow instead
             const authClient = await invokeAsync(
                 this.createAuthCodeClient.bind(this),
-                PerformanceEvents.StandardInteractionClientCreateAuthCodeClient,
+                BrowserPerformanceEvents.StandardInteractionClientCreateAuthCodeClient,
                 this.logger,
                 this.performanceClient,
                 correlationId
             )({
-                serverTelemetryManager: this.initializeServerTelemetryManager(
-                    this.apiId
+                serverTelemetryManager: initializeServerTelemetryManager(
+                    this.apiId,
+                    this.config.auth.clientId,
+                    correlationId,
+                    this.browserStorage,
+                    this.logger
                 ),
                 requestAuthority: request.authority,
                 requestAzureCloudOptions: request.azureCloudOptions,
@@ -308,7 +337,7 @@ export class SilentIframeClient extends StandardInteractionClient {
 
             return invokeAsync(
                 Authorize.handleResponseCode,
-                PerformanceEvents.HandleResponseCode,
+                BrowserPerformanceEvents.HandleResponseCode,
                 this.logger,
                 this.performanceClient,
                 correlationId
@@ -329,7 +358,7 @@ export class SilentIframeClient extends StandardInteractionClient {
         } else {
             return invokeAsync(
                 Authorize.handleResponseEAR,
-                PerformanceEvents.HandleResponseEar,
+                BrowserPerformanceEvents.HandleResponseEar,
                 this.logger,
                 this.performanceClient,
                 correlationId
@@ -372,13 +401,9 @@ export class SilentIframeClient extends StandardInteractionClient {
         request: CommonAuthorizationUrlRequest
     ): Promise<AuthenticationResult> {
         const correlationId = request.correlationId;
-        this.performanceClient.addQueueMeasurement(
-            PerformanceEvents.SilentIframeClientTokenHelper,
-            correlationId
-        );
         const pkceCodes = await invokeAsync(
             generatePkceCodes,
-            PerformanceEvents.GeneratePkceCodes,
+            BrowserPerformanceEvents.GeneratePkceCodes,
             this.logger,
             this.performanceClient,
             correlationId
@@ -389,12 +414,10 @@ export class SilentIframeClient extends StandardInteractionClient {
             codeChallenge: pkceCodes.challenge,
         };
 
-        let msalFrame: HTMLIFrameElement;
-
-        if (request.httpMethod === HttpMethod.POST) {
-            msalFrame = await invokeAsync(
+        if (request.httpMethod === Constants.HttpMethod.POST) {
+            await invokeAsync(
                 initiateCodeFlowWithPost,
-                PerformanceEvents.SilentHandlerInitiateAuthRequest,
+                BrowserPerformanceEvents.SilentHandlerInitiateAuthRequest,
                 this.logger,
                 this.performanceClient,
                 correlationId
@@ -422,49 +445,41 @@ export class SilentIframeClient extends StandardInteractionClient {
             );
 
             // Get the frame handle for the silent request
-            msalFrame = await invokeAsync(
+            await invokeAsync(
                 initiateCodeRequest,
-                PerformanceEvents.SilentHandlerInitiateAuthRequest,
+                BrowserPerformanceEvents.SilentHandlerInitiateAuthRequest,
                 this.logger,
                 this.performanceClient,
                 correlationId
-            )(
-                navigateUrl,
-                this.performanceClient,
-                this.logger,
-                correlationId,
-                this.config.system.navigateFrameWait
-            );
+            )(navigateUrl, this.performanceClient, this.logger, correlationId);
         }
 
-        const responseType = this.config.auth.OIDCOptions.serverResponseType;
-        // Monitor the window for the hash. Return the string value and close the popup when the hash is received. Default timeout is 60 seconds.
+        const responseType = this.config.auth.OIDCOptions.responseMode;
+        // Wait for response from the redirect bridge.
         const responseString = await invokeAsync(
-            monitorIframeForHash,
-            PerformanceEvents.SilentHandlerMonitorIframeForHash,
+            BrowserUtils.waitForBridgeResponse,
+            BrowserPerformanceEvents.SilentHandlerMonitorIframeForHash,
             this.logger,
             this.performanceClient,
             correlationId
         )(
-            msalFrame,
-            this.config.system.iframeHashTimeout,
-            this.config.system.pollIntervalMilliseconds,
-            this.performanceClient,
+            this.config.system.iframeBridgeTimeout,
             this.logger,
-            correlationId,
-            responseType
+            this.browserCrypto,
+            request
         );
+
         const serverParams = invoke(
             ResponseHandler.deserializeResponse,
-            PerformanceEvents.DeserializeResponse,
+            BrowserPerformanceEvents.DeserializeResponse,
             this.logger,
             this.performanceClient,
             correlationId
-        )(responseString, responseType, this.logger);
+        )(responseString, responseType, this.logger, this.correlationId);
 
         return invokeAsync(
             Authorize.handleResponseCode,
-            PerformanceEvents.HandleResponseCode,
+            BrowserPerformanceEvents.HandleResponseCode,
             this.logger,
             this.performanceClient,
             correlationId