@azure/msal-browser 5.1.0 → 5.3.0

package/package.json

@@ -10,7 +10,7 @@
     "type": "git",
     "url": "https://github.com/AzureAD/microsoft-authentication-library-for-js.git"
   },
-  "version": "5.1.0",
+  "version": "5.3.0",
   "description": "Microsoft Authentication Library for js",
   "keywords": [
     "implicit",
@@ -128,6 +128,6 @@
     "typescript": "^4.9.5"
   },
   "dependencies": {
-    "@azure/msal-common": "16.0.3"
+    "@azure/msal-common": "16.1.0"
   }
 }

package/src/cache/BrowserCacheManager.ts

@@ -1821,7 +1821,10 @@ export class BrowserCacheManager extends CacheManager {
             );
             this.browserStorage.removeItem(activeAccountKey);
         }
-        this.eventHandler.emitEvent(EventType.ACTIVE_ACCOUNT_CHANGED);
+        this.eventHandler.emitEvent(
+            EventType.ACTIVE_ACCOUNT_CHANGED,
+            correlationId
+        );
     }
 
     /**

package/src/controllers/NestedAppAuthController.ts

@@ -203,6 +203,7 @@ export class NestedAppAuthController implements IController {
 
         this.eventHandler.emitEvent(
             EventType.ACQUIRE_TOKEN_START,
+            correlationId,
             InteractionType.Popup,
             validRequest
         );
@@ -249,6 +250,7 @@ export class NestedAppAuthController implements IController {
 
             this.eventHandler.emitEvent(
                 EventType.ACQUIRE_TOKEN_SUCCESS,
+                correlationId,
                 InteractionType.Popup,
                 result
             );
@@ -275,6 +277,7 @@ export class NestedAppAuthController implements IController {
                     : this.nestedAppAuthAdapter.fromBridgeError(e);
             this.eventHandler.emitEvent(
                 EventType.ACQUIRE_TOKEN_FAILURE,
+                correlationId,
                 InteractionType.Popup,
                 null,
                 e as EventError
@@ -304,6 +307,7 @@ export class NestedAppAuthController implements IController {
         const correlationId = validRequest.correlationId || createNewGuid();
         this.eventHandler.emitEvent(
             EventType.ACQUIRE_TOKEN_START,
+            correlationId,
             InteractionType.Silent,
             validRequest
         );
@@ -313,6 +317,7 @@ export class NestedAppAuthController implements IController {
         if (result) {
             this.eventHandler.emitEvent(
                 EventType.ACQUIRE_TOKEN_SUCCESS,
+                correlationId,
                 InteractionType.Silent,
                 result
             );
@@ -366,6 +371,7 @@ export class NestedAppAuthController implements IController {
 
             this.eventHandler.emitEvent(
                 EventType.ACQUIRE_TOKEN_SUCCESS,
+                correlationId,
                 InteractionType.Silent,
                 result
             );
@@ -389,6 +395,7 @@ export class NestedAppAuthController implements IController {
                     : this.nestedAppAuthAdapter.fromBridgeError(e);
             this.eventHandler.emitEvent(
                 EventType.ACQUIRE_TOKEN_FAILURE,
+                correlationId,
                 InteractionType.Silent,
                 null,
                 e as EventError
@@ -459,6 +466,7 @@ export class NestedAppAuthController implements IController {
         if (result) {
             this.eventHandler.emitEvent(
                 EventType.ACQUIRE_TOKEN_SUCCESS,
+                correlationId,
                 InteractionType.Silent,
                 result
             );
@@ -483,6 +491,7 @@ export class NestedAppAuthController implements IController {
 
         this.eventHandler.emitEvent(
             EventType.ACQUIRE_TOKEN_FAILURE,
+            correlationId,
             InteractionType.Silent,
             null
         );

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
@@ -1984,6 +2009,7 @@ export class StandardController implements IController {
             this.trackPageVisibility(request.correlationId);
         this.eventHandler.emitEvent(
             EventType.ACQUIRE_TOKEN_START,
+            request.correlationId,
             InteractionType.Silent,
             request
         );
@@ -2018,6 +2044,15 @@ export class StandardController implements IController {
                 );
 
             if (shouldTryToResolveSilently) {
+                const silentRefreshReason = `${refreshTokenError.errorCode}${
+                    refreshTokenError.subError
+                        ? `|${refreshTokenError.subError}`
+                        : ""
+                }`;
+                this.performanceClient.addFields(
+                    { silentRefreshReason },
+                    request.correlationId
+                );
                 if (!this.activeIframeRequest) {
                     let _resolve: (result: boolean) => void;
                     // Always set the active request tracker immediately after checking it to prevent races
@@ -2111,6 +2146,7 @@ export class StandardController implements IController {
             .then((response) => {
                 this.eventHandler.emitEvent(
                     EventType.ACQUIRE_TOKEN_SUCCESS,
+                    request.correlationId,
                     InteractionType.Silent,
                     response
                 );
@@ -2129,6 +2165,7 @@ export class StandardController implements IController {
             .catch((tokenRenewalError: Error) => {
                 this.eventHandler.emitEvent(
                     EventType.ACQUIRE_TOKEN_FAILURE,
+                    request.correlationId,
                     InteractionType.Silent,
                     null,
                     tokenRenewalError
@@ -2214,6 +2251,7 @@ export class StandardController implements IController {
 
                     this.eventHandler.emitEvent(
                         EventType.ACQUIRE_TOKEN_NETWORK_START,
+                        silentRequest.correlationId,
                         InteractionType.Silent,
                         silentRequest
                     );

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/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/naa/mapping/NestedAppAuthAdapter.ts

@@ -27,6 +27,7 @@ import {
     AccessTokenEntity,
     TenantProfile,
     buildTenantProfile,
+    getTenantIdFromIdTokenClaims,
     TimeUtils,
     Constants,
 } from "@azure/msal-common/browser";
@@ -178,18 +179,41 @@ export class NestedAppAuthAdapter {
             effectiveIdTokenClaims?.sub ||
             "";
 
+        /*
+         * In B2C scenarios tid may not be present, use getTenantIdFromIdTokenClaims
+         * which handles tid, tfp (modern B2C), and acr (legacy B2C) claims
+         */
         const tenantId =
-            fromAccount.tenantId || effectiveIdTokenClaims?.tid || "";
+            fromAccount.tenantId ||
+            getTenantIdFromIdTokenClaims(effectiveIdTokenClaims) ||
+            "";
 
         const homeAccountId =
             fromAccount.homeAccountId || `${localAccountId}.${tenantId}`;
 
-        const username =
-            fromAccount.username ||
+        // Validate environment - required field
+        const environment = fromAccount.environment;
+        if (!environment) {
+            throw createClientAuthError(
+                ClientAuthErrorCodes.invalidCacheEnvironment
+            );
+        }
+
+        /*
+         * In B2C scenarios the emails claim is used instead of preferred_username and it is an array.
+         * In most cases it will contain a single email. This field should not be relied upon if a custom
+         * policy is configured to return more than 1 email.
+         */
+        const preferredUsername =
             effectiveIdTokenClaims?.preferred_username ||
-            "";
+            effectiveIdTokenClaims?.upn;
+
+        const email = effectiveIdTokenClaims?.emails?.[0] || null;
+
+        const username =
+            fromAccount.username || preferredUsername || email || "";
 
-        const name = fromAccount.name || effectiveIdTokenClaims?.name;
+        const name = fromAccount.name || effectiveIdTokenClaims?.name || "";
 
         const loginHint =
             fromAccount.loginHint || effectiveIdTokenClaims?.login_hint;
@@ -206,7 +230,7 @@ export class NestedAppAuthAdapter {
 
         const account: MsalAccountInfo = {
             homeAccountId,
-            environment: fromAccount.environment,
+            environment,
             tenantId,
             username,
             localAccountId,

package/src/packageMetadata.ts

@@ -1,3 +1,3 @@
 /* eslint-disable header/header */
 export const name = "@azure/msal-browser";
-export const version = "5.1.0";
+export const version = "5.3.0";

package/src/protocol/Authorize.ts

@@ -214,6 +214,13 @@ export async function getEARForm(
         queryParams,
         request.extraQueryParameters || {}
     );
+
+    // Add correlationId to query params so gateway can propagate it to IDPs
+    RequestParameterBuilder.addCorrelationId(
+        queryParams,
+        request.correlationId
+    );
+
     const url = AuthorizeProtocol.getAuthorizeUrl(authority, queryParams);
 
     return createForm(frame, url, parameters);
@@ -261,6 +268,12 @@ export async function getCodeForm(
         request.extraQueryParameters || {}
     );
 
+    // Add correlationId to query params so gateway can propagate it to IDPs
+    RequestParameterBuilder.addCorrelationId(
+        queryParams,
+        request.correlationId
+    );
+
     const url = AuthorizeProtocol.getAuthorizeUrl(authority, queryParams);
 
     return createForm(frame, url, parameters);

package/src/redirect_bridge/index.ts

@@ -66,7 +66,7 @@ export async function broadcastResponseToMainFrame(
         };
 
         let navigateToUrl = "";
-        const interactionKey = `${PREFIX}.${TemporaryCacheKeys.INTERACTION_STATUS_KEY}}`;
+        const interactionKey = `${PREFIX}.${TemporaryCacheKeys.INTERACTION_STATUS_KEY}`;
         try {
             /*
              * Retrieve the original navigation URL from sessionStorage