@azure/msal-browser 3.28.1 → 3.30.0

package/src/cache/TokenCache.ts

@@ -85,6 +85,8 @@ export class TokenCache implements ITokenCache {
                 BrowserAuthErrorCodes.nonBrowserEnvironment
             );
         }
+        const correlationId =
+            request.correlationId || BrowserCrypto.createNewGuid();
 
         const idTokenClaims = response.id_token
             ? AuthToken.extractTokenClaims(response.id_token, base64Decode)
@@ -115,6 +117,7 @@ export class TokenCache implements ITokenCache {
         const cacheRecordAccount: AccountEntity = this.loadAccount(
             request,
             options.clientInfo || response.client_info || "",
+            correlationId,
             idTokenClaims,
             authority
         );
@@ -123,7 +126,8 @@ export class TokenCache implements ITokenCache {
             response,
             cacheRecordAccount.homeAccountId,
             cacheRecordAccount.environment,
-            cacheRecordAccount.realm
+            cacheRecordAccount.realm,
+            correlationId
         );
 
         const accessToken = this.loadAccessToken(
@@ -132,13 +136,15 @@ export class TokenCache implements ITokenCache {
             cacheRecordAccount.homeAccountId,
             cacheRecordAccount.environment,
             cacheRecordAccount.realm,
-            options
+            options,
+            correlationId
         );
 
         const refreshToken = this.loadRefreshToken(
             response,
             cacheRecordAccount.homeAccountId,
-            cacheRecordAccount.environment
+            cacheRecordAccount.environment,
+            correlationId
         );
 
         return this.generateAuthenticationResult(
@@ -166,6 +172,7 @@ export class TokenCache implements ITokenCache {
     private loadAccount(
         request: SilentRequest,
         clientInfo: string,
+        correlationId: string,
         idTokenClaims?: TokenClaims,
         authority?: Authority
     ): AccountEntity {
@@ -175,7 +182,7 @@ export class TokenCache implements ITokenCache {
             const accountEntity = AccountEntity.createFromAccountInfo(
                 request.account
             );
-            this.storage.setAccount(accountEntity);
+            this.storage.setAccount(accountEntity, correlationId);
             return accountEntity;
         } else if (!authority || (!clientInfo && !idTokenClaims)) {
             this.logger.error(
@@ -201,6 +208,7 @@ export class TokenCache implements ITokenCache {
             authority,
             homeAccountId,
             base64Decode,
+            correlationId,
             idTokenClaims,
             clientInfo,
             authority.hostnameAndPort,
@@ -210,7 +218,7 @@ export class TokenCache implements ITokenCache {
             this.logger
         );
 
-        this.storage.setAccount(cachedAccount);
+        this.storage.setAccount(cachedAccount, correlationId);
         return cachedAccount;
     }
 
@@ -226,7 +234,8 @@ export class TokenCache implements ITokenCache {
         response: ExternalTokenResponse,
         homeAccountId: string,
         environment: string,
-        tenantId: string
+        tenantId: string,
+        correlationId: string
     ): IdTokenEntity | null {
         if (!response.id_token) {
             this.logger.verbose("TokenCache - no id token found in response");
@@ -242,7 +251,7 @@ export class TokenCache implements ITokenCache {
             tenantId
         );
 
-        this.storage.setIdTokenCredential(idTokenEntity);
+        this.storage.setIdTokenCredential(idTokenEntity, correlationId);
         return idTokenEntity;
     }
 
@@ -261,7 +270,8 @@ export class TokenCache implements ITokenCache {
         homeAccountId: string,
         environment: string,
         tenantId: string,
-        options: LoadTokenOptions
+        options: LoadTokenOptions,
+        correlationId: string
     ): AccessTokenEntity | null {
         if (!response.access_token) {
             this.logger.verbose(
@@ -309,7 +319,7 @@ export class TokenCache implements ITokenCache {
             base64Decode
         );
 
-        this.storage.setAccessTokenCredential(accessTokenEntity);
+        this.storage.setAccessTokenCredential(accessTokenEntity, correlationId);
         return accessTokenEntity;
     }
 
@@ -324,7 +334,8 @@ export class TokenCache implements ITokenCache {
     private loadRefreshToken(
         response: ExternalTokenResponse,
         homeAccountId: string,
-        environment: string
+        environment: string,
+        correlationId: string
     ): RefreshTokenEntity | null {
         if (!response.refresh_token) {
             this.logger.verbose(
@@ -344,7 +355,10 @@ export class TokenCache implements ITokenCache {
             response.refresh_token_expires_in
         );
 
-        this.storage.setRefreshTokenCredential(refreshTokenEntity);
+        this.storage.setRefreshTokenCredential(
+            refreshTokenEntity,
+            correlationId
+        );
         return refreshTokenEntity;
     }
 

package/src/controllers/NestedAppAuthController.ts

@@ -53,6 +53,7 @@ import {
 } from "../cache/BrowserCacheManager.js";
 import { ClearCacheRequest } from "../request/ClearCacheRequest.js";
 import * as AccountManager from "../cache/AccountManager.js";
+import * as BrowserCrypto from "../crypto/BrowserCrypto.js";
 
 export class NestedAppAuthController implements IController {
     // OperatingContext
@@ -131,13 +132,19 @@ export class NestedAppAuthController implements IController {
         // Set the active account if available
         const accountContext = this.bridgeProxy.getAccountContext();
         if (accountContext) {
+            const correlationId = BrowserCrypto.createNewGuid();
             const cachedAccount = AccountManager.getAccount(
                 accountContext,
                 this.logger,
-                this.browserStorage
+                this.browserStorage,
+                correlationId
             );
 
-            AccountManager.setActiveAccount(cachedAccount, this.browserStorage);
+            AccountManager.setActiveAccount(
+                cachedAccount,
+                this.browserStorage,
+                correlationId
+            );
         }
     }
 
@@ -224,7 +231,10 @@ export class NestedAppAuthController implements IController {
             // cache the tokens in the response
             await this.hydrateCache(result, request);
 
-            this.browserStorage.setActiveAccount(result.account);
+            this.browserStorage.setActiveAccount(
+                result.account,
+                result.correlationId
+            );
             this.eventHandler.emitEvent(
                 EventType.ACQUIRE_TOKEN_SUCCESS,
                 InteractionType.Popup,
@@ -318,7 +328,10 @@ export class NestedAppAuthController implements IController {
             // cache the tokens in the response
             await this.hydrateCache(result, request);
 
-            this.browserStorage.setActiveAccount(result.account);
+            this.browserStorage.setActiveAccount(
+                result.account,
+                result.correlationId
+            );
             this.eventHandler.emitEvent(
                 EventType.ACQUIRE_TOKEN_SUCCESS,
                 InteractionType.Silent,
@@ -428,13 +441,16 @@ export class NestedAppAuthController implements IController {
     private async acquireTokenFromCacheInternal(
         request: SilentRequest
     ): Promise<AuthenticationResult | null> {
+        const correlationId =
+            request.correlationId || BrowserCrypto.createNewGuid();
         const accountContext = this.bridgeProxy.getAccountContext();
         let currentAccount = null;
         if (accountContext) {
             const hubAccount = AccountManager.getAccount(
                 accountContext,
                 this.logger,
-                this.browserStorage
+                this.browserStorage,
+                correlationId
             );
             // always prioritize for hub account context, the reqirement of `request.account` will be removed soon
             currentAccount = hubAccount || request.account;
@@ -454,8 +470,7 @@ export class NestedAppAuthController implements IController {
 
         const authRequest: BaseAuthRequest = {
             ...request,
-            correlationId:
-                request.correlationId || this.browserCrypto.createNewGuid(),
+            correlationId: correlationId,
             authority: request.authority || currentAccount.environment,
             scopes: request.scopes?.length
                 ? request.scopes
@@ -469,8 +484,7 @@ export class NestedAppAuthController implements IController {
             authRequest,
             tokenKeys,
             currentAccount.tenantId,
-            this.performanceClient,
-            authRequest.correlationId
+            this.performanceClient
         );
 
         // If there is no access token, log it and return null
@@ -490,10 +504,10 @@ export class NestedAppAuthController implements IController {
 
         const cachedIdToken = this.browserStorage.getIdToken(
             currentAccount,
+            authRequest.correlationId,
             tokenKeys,
             currentAccount.tenantId,
-            this.performanceClient,
-            authRequest.correlationId
+            this.performanceClient
         );
 
         if (!cachedIdToken) {
@@ -636,10 +650,12 @@ export class NestedAppAuthController implements IController {
      * @returns Array of AccountInfo objects in cache
      */
     getAllAccounts(accountFilter?: AccountFilter): AccountInfo[] {
+        const correlationId = BrowserCrypto.createNewGuid();
         return AccountManager.getAllAccounts(
             this.logger,
             this.browserStorage,
             this.isBrowserEnv(),
+            correlationId,
             accountFilter
         );
     }
@@ -650,10 +666,12 @@ export class NestedAppAuthController implements IController {
      * @returns The first account found in the cache matching the provided filter or null if no account could be found.
      */
     getAccount(accountFilter: AccountFilter): AccountInfo | null {
+        const correlationId = BrowserCrypto.createNewGuid();
         return AccountManager.getAccount(
             accountFilter,
             this.logger,
-            this.browserStorage
+            this.browserStorage,
+            correlationId
         );
     }
 
@@ -666,10 +684,12 @@ export class NestedAppAuthController implements IController {
      * @returns The account object stored in MSAL
      */
     getAccountByUsername(username: string): AccountInfo | null {
+        const correlationId = BrowserCrypto.createNewGuid();
         return AccountManager.getAccountByUsername(
             username,
             this.logger,
-            this.browserStorage
+            this.browserStorage,
+            correlationId
         );
     }
 
@@ -681,10 +701,12 @@ export class NestedAppAuthController implements IController {
      * @returns The account object stored in MSAL
      */
     getAccountByHomeId(homeAccountId: string): AccountInfo | null {
+        const correlationId = BrowserCrypto.createNewGuid();
         return AccountManager.getAccountByHomeId(
             homeAccountId,
             this.logger,
-            this.browserStorage
+            this.browserStorage,
+            correlationId
         );
     }
 
@@ -696,10 +718,12 @@ export class NestedAppAuthController implements IController {
      * @returns The account object stored in MSAL
      */
     getAccountByLocalId(localAccountId: string): AccountInfo | null {
+        const correlationId = BrowserCrypto.createNewGuid();
         return AccountManager.getAccountByLocalId(
             localAccountId,
             this.logger,
-            this.browserStorage
+            this.browserStorage,
+            correlationId
         );
     }
 
@@ -712,14 +736,23 @@ export class NestedAppAuthController implements IController {
          * StandardController uses this to allow the developer to set the active account
          * in the nested app auth scenario the active account is controlled by the app hosting the nested app
          */
-        return AccountManager.setActiveAccount(account, this.browserStorage);
+        const correlationId = BrowserCrypto.createNewGuid();
+        return AccountManager.setActiveAccount(
+            account,
+            this.browserStorage,
+            correlationId
+        );
     }
 
     /**
      * Gets the currently active account
      */
     getActiveAccount(): AccountInfo | null {
-        return AccountManager.getActiveAccount(this.browserStorage);
+        const correlationId = BrowserCrypto.createNewGuid();
+        return AccountManager.getActiveAccount(
+            this.browserStorage,
+            correlationId
+        );
     }
 
     // #endregion
@@ -842,7 +875,7 @@ export class NestedAppAuthController implements IController {
             result.cloudGraphHostName,
             result.msGraphHost
         );
-        this.browserStorage.setAccount(accountEntity);
+        this.browserStorage.setAccount(accountEntity, result.correlationId);
         return this.browserStorage.hydrateCache(result, request);
     }
 }

package/src/controllers/StandardController.ts

@@ -1366,10 +1366,12 @@ export class StandardController implements IController {
      * @returns Array of AccountInfo objects in cache
      */
     getAllAccounts(accountFilter?: AccountFilter): AccountInfo[] {
+        const correlationId = this.getRequestCorrelationId();
         return AccountManager.getAllAccounts(
             this.logger,
             this.browserStorage,
             this.isBrowserEnvironment,
+            correlationId,
             accountFilter
         );
     }
@@ -1380,10 +1382,12 @@ export class StandardController implements IController {
      * @returns The first account found in the cache matching the provided filter or null if no account could be found.
      */
     getAccount(accountFilter: AccountFilter): AccountInfo | null {
+        const correlationId = this.getRequestCorrelationId();
         return AccountManager.getAccount(
             accountFilter,
             this.logger,
-            this.browserStorage
+            this.browserStorage,
+            correlationId
         );
     }
 
@@ -1396,10 +1400,12 @@ export class StandardController implements IController {
      * @returns The account object stored in MSAL
      */
     getAccountByUsername(username: string): AccountInfo | null {
+        const correlationId = this.getRequestCorrelationId();
         return AccountManager.getAccountByUsername(
             username,
             this.logger,
-            this.browserStorage
+            this.browserStorage,
+            correlationId
         );
     }
 
@@ -1411,10 +1417,12 @@ export class StandardController implements IController {
      * @returns The account object stored in MSAL
      */
     getAccountByHomeId(homeAccountId: string): AccountInfo | null {
+        const correlationId = this.getRequestCorrelationId();
         return AccountManager.getAccountByHomeId(
             homeAccountId,
             this.logger,
-            this.browserStorage
+            this.browserStorage,
+            correlationId
         );
     }
 
@@ -1426,10 +1434,12 @@ export class StandardController implements IController {
      * @returns The account object stored in MSAL
      */
     getAccountByLocalId(localAccountId: string): AccountInfo | null {
+        const correlationId = this.getRequestCorrelationId();
         return AccountManager.getAccountByLocalId(
             localAccountId,
             this.logger,
-            this.browserStorage
+            this.browserStorage,
+            correlationId
         );
     }
 
@@ -1438,14 +1448,23 @@ export class StandardController implements IController {
      * @param account
      */
     setActiveAccount(account: AccountInfo | null): void {
-        AccountManager.setActiveAccount(account, this.browserStorage);
+        const correlationId = this.getRequestCorrelationId();
+        AccountManager.setActiveAccount(
+            account,
+            this.browserStorage,
+            correlationId
+        );
     }
 
     /**
      * Gets the currently active account
      */
     getActiveAccount(): AccountInfo | null {
-        return AccountManager.getActiveAccount(this.browserStorage);
+        const correlationId = this.getRequestCorrelationId();
+        return AccountManager.getActiveAccount(
+            this.browserStorage,
+            correlationId
+        );
     }
 
     // #endregion
@@ -1472,7 +1491,7 @@ export class StandardController implements IController {
             result.cloudGraphHostName,
             result.msGraphHost
         );
-        this.browserStorage.setAccount(accountEntity);
+        this.browserStorage.setAccount(accountEntity, result.correlationId);
 
         if (result.fromNativeBroker) {
             this.logger.verbose(

package/src/interaction_client/BaseInteractionClient.ts

@@ -93,17 +93,18 @@ export abstract class BaseInteractionClient {
             if (
                 AccountEntity.accountInfoIsEqual(
                     account,
-                    this.browserStorage.getActiveAccount(),
+                    this.browserStorage.getActiveAccount(this.correlationId),
                     false
                 )
             ) {
                 this.logger.verbose("Setting active account to null");
-                this.browserStorage.setActiveAccount(null);
+                this.browserStorage.setActiveAccount(null, this.correlationId);
             }
             // Clear given account.
             try {
                 await this.browserStorage.removeAccount(
-                    AccountEntity.generateAccountCacheKey(account)
+                    AccountEntity.generateAccountCacheKey(account),
+                    this.correlationId
                 );
                 this.logger.verbose(
                     "Cleared cache items belonging to the account provided in the logout request."
@@ -120,7 +121,7 @@ export abstract class BaseInteractionClient {
                     this.correlationId
                 );
                 // Clear all accounts and tokens
-                await this.browserStorage.clear();
+                await this.browserStorage.clear(this.correlationId);
                 // Clear any stray keys from IndexedDB
                 await this.browserCrypto.clearKeystore();
             } catch (e) {

package/src/interaction_client/NativeInteractionClient.ts

@@ -281,9 +281,12 @@ export class NativeInteractionClient extends BaseInteractionClient {
             throw createClientAuthError(ClientAuthErrorCodes.noAccountFound);
         }
         // fetch the account from browser cache
-        const account = this.browserStorage.getBaseAccountInfo({
-            nativeAccountId,
-        });
+        const account = this.browserStorage.getBaseAccountInfo(
+            {
+                nativeAccountId,
+            },
+            request.correlationId
+        );
 
         if (!account) {
             throw createClientAuthError(ClientAuthErrorCodes.noAccountFound);
@@ -487,9 +490,12 @@ export class NativeInteractionClient extends BaseInteractionClient {
         );
 
         const cachedhomeAccountId =
-            this.browserStorage.getAccountInfoFilteredBy({
-                nativeAccountId: request.accountId,
-            })?.homeAccountId;
+            this.browserStorage.getAccountInfoFilteredBy(
+                {
+                    nativeAccountId: request.accountId,
+                },
+                this.correlationId
+            )?.homeAccountId;
 
         if (
             homeAccountIdentifier !== cachedhomeAccountId &&
@@ -509,6 +515,7 @@ export class NativeInteractionClient extends BaseInteractionClient {
             authority,
             homeAccountIdentifier,
             base64Decode,
+            this.correlationId,
             idTokenClaims,
             response.client_info,
             undefined, // environment
@@ -724,14 +731,16 @@ export class NativeInteractionClient extends BaseInteractionClient {
      */
     cacheAccount(accountEntity: AccountEntity): void {
         // Store the account info and hence `nativeAccountId` in browser cache
-        this.browserStorage.setAccount(accountEntity);
+        this.browserStorage.setAccount(accountEntity, this.correlationId);
 
         // Remove any existing cached tokens for this account in browser storage
-        this.browserStorage.removeAccountContext(accountEntity).catch((e) => {
-            this.logger.error(
-                `Error occurred while removing account context from browser storage. ${e}`
-            );
-        });
+        this.browserStorage
+            .removeAccountContext(accountEntity, this.correlationId)
+            .catch((e) => {
+                this.logger.error(
+                    `Error occurred while removing account context from browser storage. ${e}`
+                );
+            });
     }
 
     /**
@@ -796,6 +805,7 @@ export class NativeInteractionClient extends BaseInteractionClient {
 
         void this.nativeStorageManager.saveCacheRecord(
             nativeCacheRecord,
+            request.correlationId,
             request.storeInCache
         );
     }

package/src/interaction_client/PopupClient.ts

@@ -408,7 +408,8 @@ export class PopupClient extends StandardInteractionClient {
                     authClient.authority.protocolMode === ProtocolMode.OIDC
                 ) {
                     void this.browserStorage.removeAccount(
-                        validRequest.account?.homeAccountId
+                        validRequest.account?.homeAccountId,
+                        this.correlationId
                     );
 
                     this.eventHandler.emitEvent(

package/src/interaction_client/RedirectClient.ts

@@ -567,7 +567,8 @@ export class RedirectClient extends StandardInteractionClient {
                 } catch {
                     if (validLogoutRequest.account?.homeAccountId) {
                         void this.browserStorage.removeAccount(
-                            validLogoutRequest.account?.homeAccountId
+                            validLogoutRequest.account?.homeAccountId,
+                            this.correlationId
                         );
 
                         this.eventHandler.emitEvent(

package/src/interaction_client/StandardInteractionClient.ts

@@ -368,7 +368,8 @@ export abstract class StandardInteractionClient extends BaseInteractionClient {
         }
 
         const account =
-            request.account || this.browserStorage.getActiveAccount();
+            request.account ||
+            this.browserStorage.getActiveAccount(this.correlationId);
         if (account) {
             this.logger.verbose(
                 "Setting validated request account",

package/src/packageMetadata.ts

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

package/src/utils/BrowserConstants.ts

@@ -100,6 +100,7 @@ export type TemporaryCacheKeys =
 export const StaticCacheKeys = {
     ACCOUNT_KEYS: "msal.account.keys",
     TOKEN_KEYS: "msal.token.keys",
+    VERSION: "msal.version",
 } as const;
 export type StaticCacheKeys =
     (typeof StaticCacheKeys)[keyof typeof StaticCacheKeys];