@azure/msal-browser 5.0.2 → 5.2.0

package/src/controllers/StandardController.ts

@@ -305,29 +305,30 @@ export class StandardController implements IController {
                 correlationId
             );
             this.initialized = true;
-            this.eventHandler.emitEvent(EventType.INITIALIZE_END);
+            this.eventHandler.emitEvent(
+                EventType.INITIALIZE_END,
+                correlationId
+            );
             return;
         }
 
-        const initCorrelationId =
-            request?.correlationId || this.getRequestCorrelationId();
         const allowPlatformBroker = this.config.system.allowPlatformBroker;
         const initMeasurement = this.performanceClient.startMeasurement(
             BrowserRootPerformanceEvents.InitializeClientApplication,
-            initCorrelationId
+            correlationId
         );
-        this.eventHandler.emitEvent(EventType.INITIALIZE_START);
+        this.eventHandler.emitEvent(EventType.INITIALIZE_START, correlationId);
 
         // Broker applications are initialized twice, so we avoid double-counting it
-        this.logMultipleInstances(initMeasurement, initCorrelationId);
+        this.logMultipleInstances(initMeasurement, correlationId);
 
         await invokeAsync(
             this.browserStorage.initialize.bind(this.browserStorage),
             BrowserPerformanceEvents.InitializeCache,
             this.logger,
             this.performanceClient,
-            initCorrelationId
-        )(initCorrelationId);
+            correlationId
+        )(correlationId);
 
         if (allowPlatformBroker) {
             try {
@@ -335,11 +336,11 @@ export class StandardController implements IController {
                 this.platformAuthProvider = await getPlatformAuthProvider(
                     this.logger,
                     this.performanceClient,
-                    initCorrelationId,
+                    correlationId,
                     this.config.system.nativeBrokerHandshakeTimeout
                 );
             } catch (e) {
-                this.logger.verbose(e as string, initCorrelationId);
+                this.logger.verbose(e as string, correlationId);
             }
         }
 
@@ -351,9 +352,9 @@ export class StandardController implements IController {
         }
 
         !this.config.system.navigatePopups &&
-            (await this.preGeneratePkceCodes(initCorrelationId));
+            (await this.preGeneratePkceCodes(correlationId));
         this.initialized = true;
-        this.eventHandler.emitEvent(EventType.INITIALIZE_END);
+        this.eventHandler.emitEvent(EventType.INITIALIZE_END, correlationId);
         initMeasurement.end({
             allowPlatformBroker: allowPlatformBroker,
             success: true,
@@ -444,16 +445,16 @@ export class StandardController implements IController {
 
         let rootMeasurement: InProgressPerformanceEvent;
 
-        this.eventHandler.emitEvent(
-            EventType.HANDLE_REDIRECT_START,
-            InteractionType.Redirect
-        );
-
         let redirectResponse: Promise<AuthenticationResult | null>;
         try {
             if (useNative && this.platformAuthProvider) {
                 const correlationId =
                     platformBrokerRequest?.correlationId || "";
+                this.eventHandler.emitEvent(
+                    EventType.HANDLE_REDIRECT_START,
+                    correlationId,
+                    InteractionType.Redirect
+                );
                 rootMeasurement = this.performanceClient.startMeasurement(
                     BrowserRootPerformanceEvents.AcquireTokenRedirect,
                     correlationId
@@ -488,6 +489,11 @@ export class StandardController implements IController {
                 const [standardRequest, codeVerifier] =
                     this.browserStorage.getCachedRequest("");
                 const correlationId = standardRequest.correlationId;
+                this.eventHandler.emitEvent(
+                    EventType.HANDLE_REDIRECT_START,
+                    correlationId,
+                    InteractionType.Redirect
+                );
                 // Reset rootMeasurement now that we have correlationId
                 rootMeasurement = this.performanceClient.startMeasurement(
                     BrowserRootPerformanceEvents.AcquireTokenRedirect,
@@ -517,6 +523,7 @@ export class StandardController implements IController {
                     this.browserStorage.resetRequestCache(result.correlationId);
                     this.eventHandler.emitEvent(
                         EventType.ACQUIRE_TOKEN_SUCCESS,
+                        result.correlationId,
                         InteractionType.Redirect,
                         result
                     );
@@ -530,6 +537,7 @@ export class StandardController implements IController {
                     if (isLoggingIn) {
                         this.eventHandler.emitEvent(
                             EventType.LOGIN_SUCCESS,
+                            result.correlationId,
                             InteractionType.Redirect,
                             result.account
                         );
@@ -559,6 +567,7 @@ export class StandardController implements IController {
 
                 this.eventHandler.emitEvent(
                     EventType.HANDLE_REDIRECT_END,
+                    rootMeasurement.event.correlationId,
                     InteractionType.Redirect
                 );
 
@@ -571,12 +580,14 @@ export class StandardController implements IController {
                 const eventError = e as EventError;
                 this.eventHandler.emitEvent(
                     EventType.ACQUIRE_TOKEN_FAILURE,
+                    rootMeasurement.event.correlationId,
                     InteractionType.Redirect,
                     null,
                     eventError
                 );
                 this.eventHandler.emitEvent(
                     EventType.HANDLE_REDIRECT_END,
+                    rootMeasurement.event.correlationId,
                     InteractionType.Redirect
                 );
 
@@ -640,6 +651,7 @@ export class StandardController implements IController {
 
             this.eventHandler.emitEvent(
                 EventType.ACQUIRE_TOKEN_START,
+                correlationId,
                 InteractionType.Redirect,
                 request
             );
@@ -711,6 +723,7 @@ export class StandardController implements IController {
 
             this.eventHandler.emitEvent(
                 EventType.ACQUIRE_TOKEN_FAILURE,
+                correlationId,
                 InteractionType.Redirect,
                 null,
                 e as EventError
@@ -763,6 +776,7 @@ export class StandardController implements IController {
         const loggedInAccounts = this.getAllAccounts();
         this.eventHandler.emitEvent(
             EventType.ACQUIRE_TOKEN_START,
+            correlationId,
             InteractionType.Popup,
             request
         );
@@ -823,12 +837,14 @@ export class StandardController implements IController {
                     loggedInAccounts.length < this.getAllAccounts().length;
                 this.eventHandler.emitEvent(
                     EventType.ACQUIRE_TOKEN_SUCCESS,
+                    correlationId,
                     InteractionType.Popup,
                     result
                 );
                 if (isLoggingIn) {
                     this.eventHandler.emitEvent(
                         EventType.LOGIN_SUCCESS,
+                        correlationId,
                         InteractionType.Popup,
                         result.account
                     );
@@ -848,6 +864,7 @@ export class StandardController implements IController {
             .catch((e: Error) => {
                 this.eventHandler.emitEvent(
                     EventType.ACQUIRE_TOKEN_FAILURE,
+                    correlationId,
                     InteractionType.Popup,
                     null,
                     e
@@ -935,6 +952,7 @@ export class StandardController implements IController {
         this.logger.verbose("ssoSilent called", correlationId);
         this.eventHandler.emitEvent(
             EventType.ACQUIRE_TOKEN_START,
+            correlationId,
             InteractionType.Silent,
             validRequest
         );
@@ -969,12 +987,14 @@ export class StandardController implements IController {
                     loggedInAccounts.length < this.getAllAccounts().length;
                 this.eventHandler.emitEvent(
                     EventType.ACQUIRE_TOKEN_SUCCESS,
+                    correlationId,
                     InteractionType.Silent,
                     response
                 );
                 if (isLoggingIn) {
                     this.eventHandler.emitEvent(
                         EventType.LOGIN_SUCCESS,
+                        correlationId,
                         InteractionType.Silent,
                         response.account
                     );
@@ -994,6 +1014,7 @@ export class StandardController implements IController {
             .catch((e: Error) => {
                 this.eventHandler.emitEvent(
                     EventType.ACQUIRE_TOKEN_FAILURE,
+                    correlationId,
                     InteractionType.Silent,
                     null,
                     e
@@ -1037,6 +1058,7 @@ export class StandardController implements IController {
         preflightCheck(this.initialized, atbcMeasurement);
         this.eventHandler.emitEvent(
             EventType.ACQUIRE_TOKEN_START,
+            correlationId,
             InteractionType.Silent,
             request
         );
@@ -1063,6 +1085,7 @@ export class StandardController implements IController {
                         .then((result: AuthenticationResult) => {
                             this.eventHandler.emitEvent(
                                 EventType.ACQUIRE_TOKEN_SUCCESS,
+                                correlationId,
                                 InteractionType.Silent,
                                 result
                             );
@@ -1083,6 +1106,7 @@ export class StandardController implements IController {
                             this.hybridAuthCodeResponses.delete(hybridAuthCode);
                             this.eventHandler.emitEvent(
                                 EventType.ACQUIRE_TOKEN_FAILURE,
+                                correlationId,
                                 InteractionType.Silent,
                                 null,
                                 error
@@ -1146,6 +1170,7 @@ export class StandardController implements IController {
         } catch (e) {
             this.eventHandler.emitEvent(
                 EventType.ACQUIRE_TOKEN_FAILURE,
+                correlationId,
                 InteractionType.Silent,
                 null,
                 e as EventError
@@ -1438,7 +1463,8 @@ export class StandardController implements IController {
         await this.browserStorage.setAccount(
             accountEntity,
             result.correlationId,
-            AuthToken.isKmsi(result.idTokenClaims)
+            AuthToken.isKmsi(result.idTokenClaims),
+            ApiId.hydrateCache
         );
 
         if (result.fromPlatformBroker) {
@@ -1983,6 +2009,7 @@ export class StandardController implements IController {
             this.trackPageVisibility(request.correlationId);
         this.eventHandler.emitEvent(
             EventType.ACQUIRE_TOKEN_START,
+            request.correlationId,
             InteractionType.Silent,
             request
         );
@@ -2110,6 +2137,7 @@ export class StandardController implements IController {
             .then((response) => {
                 this.eventHandler.emitEvent(
                     EventType.ACQUIRE_TOKEN_SUCCESS,
+                    request.correlationId,
                     InteractionType.Silent,
                     response
                 );
@@ -2128,6 +2156,7 @@ export class StandardController implements IController {
             .catch((tokenRenewalError: Error) => {
                 this.eventHandler.emitEvent(
                     EventType.ACQUIRE_TOKEN_FAILURE,
+                    request.correlationId,
                     InteractionType.Silent,
                     null,
                     tokenRenewalError
@@ -2213,6 +2242,7 @@ export class StandardController implements IController {
 
                     this.eventHandler.emitEvent(
                         EventType.ACQUIRE_TOKEN_NETWORK_START,
+                        silentRequest.correlationId,
                         InteractionType.Silent,
                         silentRequest
                     );

package/src/custom_auth/core/interaction_client/CustomAuthInteractionClientBase.ts

@@ -99,7 +99,8 @@ export abstract class CustomAuthInteractionClientBase extends StandardInteractio
     protected async handleTokenResponse(
         tokenResponse: SignInTokenResponse,
         requestScopes: string[],
-        correlationId: string
+        correlationId: string,
+        apiId: number
     ): Promise<AuthenticationResult> {
         this.logger.verbose("Processing token response.", correlationId);
 
@@ -116,7 +117,8 @@ export abstract class CustomAuthInteractionClientBase extends StandardInteractio
                     correlationId:
                         tokenResponse.correlation_id ?? correlationId,
                     scopes: requestScopes,
-                }
+                },
+                apiId
             );
 
         return result as AuthenticationResult;

package/src/custom_auth/core/interaction_client/jit/JitClient.ts

@@ -172,7 +172,8 @@ export class JitClient extends CustomAuthInteractionClientBase {
             scopes,
             tokenResponse.correlation_id ||
                 continueResponse.correlation_id ||
-                correlationId
+                correlationId,
+            apiId
         );
 
         return createJitCompletedResult({

package/src/custom_auth/core/interaction_client/mfa/MfaClient.ts

@@ -154,7 +154,8 @@ export class MfaClient extends CustomAuthInteractionClientBase {
         const result = await this.handleTokenResponse(
             tokenResponse,
             scopes,
-            tokenResponse.correlation_id || correlationId
+            tokenResponse.correlation_id || correlationId,
+            apiId
         );
 
         return createMfaCompletedResult({

package/src/custom_auth/get_account/interaction_client/CustomAuthSilentCacheClient.ts

@@ -98,7 +98,8 @@ export class CustomAuthSilentCacheClient extends CustomAuthInteractionClientBase
 
                 const refreshTokenResult =
                     await refreshTokenClient.acquireTokenByRefreshToken(
-                        silentRequest
+                        silentRequest,
+                        PublicApiId.ACCOUNT_GET_ACCESS_TOKEN
                     );
 
                 this.logger.verbose(

package/src/custom_auth/sign_in/interaction_client/SignInClient.ts

@@ -198,7 +198,8 @@ export class SignInClient extends CustomAuthInteractionClientBase {
                 ),
             scopes,
             correlationId,
-            telemetryManager
+            telemetryManager,
+            apiId
         );
     }
 
@@ -249,7 +250,8 @@ export class SignInClient extends CustomAuthInteractionClientBase {
                 ),
             scopes,
             correlationId,
-            telemetryManager
+            telemetryManager,
+            apiId
         );
     }
 
@@ -299,7 +301,8 @@ export class SignInClient extends CustomAuthInteractionClientBase {
                 ),
             scopes,
             correlationId,
-            telemetryManager
+            telemetryManager,
+            apiId
         );
     }
 
@@ -315,7 +318,8 @@ export class SignInClient extends CustomAuthInteractionClientBase {
         tokenEndpointCaller: () => Promise<SignInTokenResponse>,
         scopes: string[],
         correlationId: string,
-        telemetryManager: ServerTelemetryManager
+        telemetryManager: ServerTelemetryManager,
+        apiId: number
     ): Promise<
         | SignInCompletedResult
         | SignInJitRequiredResult
@@ -337,7 +341,8 @@ export class SignInClient extends CustomAuthInteractionClientBase {
             const authResult = await this.handleTokenResponse(
                 tokenResponse,
                 scopes,
-                tokenResponse.correlation_id || correlationId
+                tokenResponse.correlation_id || correlationId,
+                apiId
             );
 
             return createSignInCompleteResult({

package/src/event/EventHandler.ts

@@ -86,6 +86,7 @@ export class EventHandler {
      */
     emitEvent(
         eventType: EventType,
+        correlationId: string,
         interactionType?: InteractionType,
         payload?: EventPayload,
         error?: EventError
@@ -95,6 +96,7 @@ export class EventHandler {
             interactionType: interactionType || null,
             payload: payload || null,
             error: error || null,
+            correlationId: correlationId,
             timestamp: Date.now(),
         };
 

package/src/event/EventMessage.ts

@@ -21,6 +21,7 @@ export type EventMessage = {
     interactionType: InteractionType | null;
     payload: EventPayload;
     error: EventError;
+    correlationId: string;
     timestamp: number;
 };
 

package/src/interaction_client/PlatformAuthInteractionClient.ts

@@ -765,7 +765,8 @@ export class PlatformAuthInteractionClient extends BaseInteractionClient {
         await this.browserStorage.setAccount(
             accountEntity,
             this.correlationId,
-            kmsi
+            kmsi,
+            this.apiId
         );
         // Remove any existing cached tokens for this account in browser storage
         this.browserStorage.removeAccountContext(
@@ -841,6 +842,7 @@ export class PlatformAuthInteractionClient extends BaseInteractionClient {
             nativeCacheRecord,
             this.correlationId,
             AuthToken.isKmsi(idTokenClaims),
+            this.apiId,
             request.storeInCache
         );
     }

package/src/interaction_client/PopupClient.ts

@@ -361,6 +361,7 @@ export class PopupClient extends StandardInteractionClient {
                 );
                 this.eventHandler.emitEvent(
                     EventType.POPUP_OPENED,
+                    correlationId,
                     InteractionType.Popup,
                     { popupWindow },
                     null
@@ -684,6 +685,7 @@ export class PopupClient extends StandardInteractionClient {
         this.logger.verbose("logoutPopupAsync called", this.correlationId);
         this.eventHandler.emitEvent(
             EventType.LOGOUT_START,
+            this.correlationId,
             InteractionType.Popup,
             validRequest
         );
@@ -729,6 +731,7 @@ export class PopupClient extends StandardInteractionClient {
                 ) {
                     this.eventHandler.emitEvent(
                         EventType.LOGOUT_SUCCESS,
+                        validRequest.correlationId,
                         InteractionType.Popup,
                         validRequest
                     );
@@ -761,6 +764,7 @@ export class PopupClient extends StandardInteractionClient {
 
             this.eventHandler.emitEvent(
                 EventType.LOGOUT_SUCCESS,
+                validRequest.correlationId,
                 InteractionType.Popup,
                 validRequest
             );
@@ -769,6 +773,7 @@ export class PopupClient extends StandardInteractionClient {
             const popupWindow = this.openPopup(logoutUri, popupParams);
             this.eventHandler.emitEvent(
                 EventType.POPUP_OPENED,
+                validRequest.correlationId,
                 InteractionType.Popup,
                 { popupWindow },
                 null
@@ -822,12 +827,14 @@ export class PopupClient extends StandardInteractionClient {
             }
             this.eventHandler.emitEvent(
                 EventType.LOGOUT_FAILURE,
+                this.correlationId,
                 InteractionType.Popup,
                 null,
                 e as EventError
             );
             this.eventHandler.emitEvent(
                 EventType.LOGOUT_END,
+                this.correlationId,
                 InteractionType.Popup
             );
             throw e;
@@ -835,6 +842,7 @@ export class PopupClient extends StandardInteractionClient {
 
         this.eventHandler.emitEvent(
             EventType.LOGOUT_END,
+            this.correlationId,
             InteractionType.Popup
         );
     }

package/src/interaction_client/RedirectClient.ts

@@ -144,6 +144,7 @@ export class RedirectClient extends StandardInteractionClient {
                 this.browserStorage.resetRequestCache(this.correlationId);
                 this.eventHandler.emitEvent(
                     EventType.RESTORE_FROM_BFCACHE,
+                    this.correlationId,
                     InteractionType.Redirect
                 );
             }
@@ -819,6 +820,7 @@ export class RedirectClient extends StandardInteractionClient {
         try {
             this.eventHandler.emitEvent(
                 EventType.LOGOUT_START,
+                this.correlationId,
                 InteractionType.Redirect,
                 logoutRequest
             );
@@ -859,6 +861,7 @@ export class RedirectClient extends StandardInteractionClient {
                     if (validLogoutRequest.account?.homeAccountId) {
                         this.eventHandler.emitEvent(
                             EventType.LOGOUT_SUCCESS,
+                            this.correlationId,
                             InteractionType.Redirect,
                             validLogoutRequest
                         );
@@ -874,6 +877,7 @@ export class RedirectClient extends StandardInteractionClient {
             if (validLogoutRequest.account?.homeAccountId) {
                 this.eventHandler.emitEvent(
                     EventType.LOGOUT_SUCCESS,
+                    this.correlationId,
                     InteractionType.Redirect,
                     validLogoutRequest
                 );
@@ -929,12 +933,14 @@ export class RedirectClient extends StandardInteractionClient {
             }
             this.eventHandler.emitEvent(
                 EventType.LOGOUT_FAILURE,
+                this.correlationId,
                 InteractionType.Redirect,
                 null,
                 e as EventError
             );
             this.eventHandler.emitEvent(
                 EventType.LOGOUT_END,
+                this.correlationId,
                 InteractionType.Redirect
             );
             throw e;
@@ -942,6 +948,7 @@ export class RedirectClient extends StandardInteractionClient {
 
         this.eventHandler.emitEvent(
             EventType.LOGOUT_END,
+            this.correlationId,
             InteractionType.Redirect
         );
     }

package/src/interaction_client/SilentAuthCodeClient.ts

@@ -161,6 +161,7 @@ export class SilentAuthCodeClient extends StandardInteractionClient {
                     cloud_instance_host_name: request.cloudInstanceHostName,
                 },
                 silentRequest,
+                this.apiId,
                 false
             );
         } catch (e) {

package/src/interaction_client/SilentRefreshClient.ts

@@ -86,11 +86,13 @@ export class SilentRefreshClient extends StandardInteractionClient {
             this.logger,
             this.performanceClient,
             request.correlationId
-        )(silentRequest).catch((e: AuthError) => {
-            (e as AuthError).setCorrelationId(this.correlationId);
-            serverTelemetryManager.cacheFailedRequest(e);
-            throw e;
-        }) as Promise<AuthenticationResult>;
+        )(silentRequest, ApiId.acquireTokenSilent_silentFlow).catch(
+            (e: AuthError) => {
+                (e as AuthError).setCorrelationId(this.correlationId);
+                serverTelemetryManager.cacheFailedRequest(e);
+                throw e;
+            }
+        ) as Promise<AuthenticationResult>;
     }
 
     /**

package/src/interaction_handler/InteractionHandler.ts

@@ -18,6 +18,7 @@ import {
     AuthorizeProtocol,
     CommonAuthorizationUrlRequest,
 } from "@azure/msal-common/browser";
+import { ApiId } from "../utils/BrowserConstants.js";
 import * as BrowserPerformanceEvents from "../telemetry/BrowserPerformanceEvents.js";
 import { BrowserCacheManager } from "../cache/BrowserCacheManager.js";
 import {
@@ -56,7 +57,8 @@ export class InteractionHandler {
      */
     async handleCodeResponse(
         response: AuthorizeResponse,
-        request: CommonAuthorizationUrlRequest
+        request: CommonAuthorizationUrlRequest,
+        apiId: ApiId
     ): Promise<AuthenticationResult> {
         let authCodeResponse;
         try {
@@ -84,7 +86,7 @@ export class InteractionHandler {
             this.logger,
             this.performanceClient,
             request.correlationId
-        )(authCodeResponse, request);
+        )(authCodeResponse, request, apiId);
     }
 
     /**
@@ -97,6 +99,7 @@ export class InteractionHandler {
     async handleCodeResponseFromServer(
         authCodeResponse: AuthorizationCodePayload,
         request: CommonAuthorizationUrlRequest,
+        apiId: ApiId,
         validateNonce: boolean = true
     ): Promise<AuthenticationResult> {
         this.logger.trace(
@@ -132,7 +135,11 @@ export class InteractionHandler {
             this.logger,
             this.performanceClient,
             request.correlationId
-        )(this.authCodeRequest, authCodeResponse)) as AuthenticationResult;
+        )(
+            this.authCodeRequest,
+            apiId,
+            authCodeResponse
+        )) as AuthenticationResult;
         return tokenResponse;
     }