@azure/msal-common 14.16.0 → 14.16.1

package/src/cache/entities/AccountEntity.ts

@@ -62,6 +62,7 @@ export class AccountEntity {
     msGraphHost?: string;
     nativeAccountId?: string;
     tenantProfiles?: Array<TenantProfile>;
+    lastUpdatedAt?: string;
 
     /**
      * Generate Account Id key component as per the schema: <home_account_id>-<environment>

package/src/cache/entities/CredentialEntity.ts

@@ -33,4 +33,6 @@ export type CredentialEntity = {
     keyId?: string;
     /** Matches the SHA 256 hash of the claims object included in the token request */
     requestedClaimsHash?: string;
+    /** Timestamp when the entry was last updated */
+    lastUpdatedAt?: string;
 };

package/src/cache/interface/ICacheManager.ts

@@ -21,13 +21,13 @@ export interface ICacheManager {
      * fetch the account entity from the platform cache
      * @param accountKey
      */
-    getAccount(accountKey: string): AccountEntity | null;
+    getAccount(accountKey: string, correlationId: string): AccountEntity | null;
 
     /**
      * set account entity in the platform cache
      * @param account
      */
-    setAccount(account: AccountEntity): void;
+    setAccount(account: AccountEntity, correlationId: string): void;
 
     /**
      * Returns true if the given key matches our account key schema. Also matches homeAccountId and/or tenantId if provided
@@ -46,39 +46,52 @@ export interface ICacheManager {
      * fetch the idToken entity from the platform cache
      * @param idTokenKey
      */
-    getIdTokenCredential(idTokenKey: string): IdTokenEntity | null;
+    getIdTokenCredential(
+        idTokenKey: string,
+        correlationId: string
+    ): IdTokenEntity | null;
 
     /**
      * set idToken entity to the platform cache
      * @param idToken
      */
-    setIdTokenCredential(idToken: IdTokenEntity): void;
+    setIdTokenCredential(idToken: IdTokenEntity, correlationId: string): void;
 
     /**
      * fetch the idToken entity from the platform cache
      * @param accessTokenKey
      */
-    getAccessTokenCredential(accessTokenKey: string): AccessTokenEntity | null;
+    getAccessTokenCredential(
+        accessTokenKey: string,
+        correlationId: string
+    ): AccessTokenEntity | null;
 
     /**
      * set idToken entity to the platform cache
      * @param accessToken
      */
-    setAccessTokenCredential(accessToken: AccessTokenEntity): void;
+    setAccessTokenCredential(
+        accessToken: AccessTokenEntity,
+        correlationId: string
+    ): void;
 
     /**
      * fetch the idToken entity from the platform cache
      * @param refreshTokenKey
      */
     getRefreshTokenCredential(
-        refreshTokenKey: string
+        refreshTokenKey: string,
+        correlationId: string
     ): RefreshTokenEntity | null;
 
     /**
      * set idToken entity to the platform cache
      * @param refreshToken
      */
-    setRefreshTokenCredential(refreshToken: RefreshTokenEntity): void;
+    setRefreshTokenCredential(
+        refreshToken: RefreshTokenEntity,
+        correlationId: string
+    ): void;
 
     /**
      * fetch appMetadata entity from the platform cache
@@ -90,7 +103,7 @@ export interface ICacheManager {
      * set appMetadata entity to the platform cache
      * @param appMetadata
      */
-    setAppMetadata(appMetadata: AppMetadataEntity): void;
+    setAppMetadata(appMetadata: AppMetadataEntity, correlationId: string): void;
 
     /**
      * fetch server telemetry entity from the platform cache
@@ -107,7 +120,8 @@ export interface ICacheManager {
      */
     setServerTelemetry(
         serverTelemetryKey: string,
-        serverTelemetry: ServerTelemetryEntity
+        serverTelemetry: ServerTelemetryEntity,
+        correlationId: string
     ): void;
 
     /**
@@ -153,13 +167,14 @@ export interface ICacheManager {
      */
     setThrottlingCache(
         throttlingCacheKey: string,
-        throttlingCache: ThrottlingEntity
+        throttlingCache: ThrottlingEntity,
+        correlationId: string
     ): void;
 
     /**
      * Returns all accounts in cache
      */
-    getAllAccounts(): AccountInfo[];
+    getAllAccounts(correlationId: string): AccountInfo[];
 
     /**
      * saves a cache record
@@ -167,6 +182,7 @@ export interface ICacheManager {
      */
     saveCacheRecord(
         cacheRecord: CacheRecord,
+        correlationId: string,
         storeInCache?: StoreInCache
     ): Promise<void>;
 
@@ -176,43 +192,52 @@ export interface ICacheManager {
      * @param environment
      * @param realm
      */
-    getAccountsFilteredBy(filter: AccountFilter): AccountEntity[];
+    getAccountsFilteredBy(
+        filter: AccountFilter,
+        correlationId: string
+    ): AccountEntity[];
 
     /**
      * Get AccountInfo object based on provided filters
      * @param filter
      */
-    getAccountInfoFilteredBy(filter: AccountFilter): AccountInfo | null;
+    getAccountInfoFilteredBy(
+        filter: AccountFilter,
+        correlationId: string
+    ): AccountInfo | null;
 
     /**
      * Removes all accounts and related tokens from cache.
      */
-    removeAllAccounts(): Promise<void>;
+    removeAllAccounts(correlationId: string): Promise<void>;
 
     /**
      * returns a boolean if the given account is removed
      * @param account
      */
-    removeAccount(accountKey: string): Promise<void>;
+    removeAccount(accountKey: string, correlationId: string): Promise<void>;
 
     /**
      * returns a boolean if the given account is removed
      * @param account
      */
-    removeAccountContext(account: AccountEntity): Promise<void>;
+    removeAccountContext(
+        account: AccountEntity,
+        correlationId: string
+    ): Promise<void>;
 
     /**
      * @param key
      */
-    removeIdToken(key: string): void;
+    removeIdToken(key: string, correlationId: string): void;
 
     /**
      * @param key
      */
-    removeAccessToken(key: string): Promise<void>;
+    removeAccessToken(key: string, correlationId: string): void;
 
     /**
      * @param key
      */
-    removeRefreshToken(key: string): void;
+    removeRefreshToken(key: string, correlationId: string): void;
 }

package/src/client/BaseClient.ts

@@ -186,7 +186,11 @@ export abstract class BaseClient {
         options: NetworkRequestOptions,
         correlationId: string
     ): Promise<NetworkResponse<T>> {
-        ThrottlingUtils.preProcess(this.cacheManager, thumbprint);
+        ThrottlingUtils.preProcess(
+            this.cacheManager,
+            thumbprint,
+            correlationId
+        );
 
         let response;
         try {
@@ -243,7 +247,12 @@ export abstract class BaseClient {
             }
         }
 
-        ThrottlingUtils.postProcess(this.cacheManager, thumbprint, response);
+        ThrottlingUtils.postProcess(
+            this.cacheManager,
+            thumbprint,
+            response,
+            correlationId
+        );
 
         return response;
     }

package/src/client/RefreshTokenClient.ts

@@ -211,9 +211,9 @@ export class RefreshTokenClient extends BaseClient {
         )(
             request.account,
             foci,
+            request.correlationId,
             undefined,
-            this.performanceClient,
-            request.correlationId
+            this.performanceClient
         );
 
         if (!refreshToken) {
@@ -265,7 +265,10 @@ export class RefreshTokenClient extends BaseClient {
                     "acquireTokenWithRefreshToken: bad refresh token, removing from cache"
                 );
                 const badRefreshTokenKey = generateCredentialKey(refreshToken);
-                this.cacheManager.removeRefreshToken(badRefreshTokenKey);
+                this.cacheManager.removeRefreshToken(
+                    badRefreshTokenKey,
+                    request.correlationId
+                );
             }
 
             throw e;

package/src/client/SilentFlowClient.ts

@@ -131,8 +131,7 @@ export class SilentFlowClient extends BaseClient {
             request,
             tokenKeys,
             requestTenantId,
-            this.performanceClient,
-            request.correlationId
+            this.performanceClient
         );
 
         if (!cachedAccessToken) {
@@ -172,14 +171,17 @@ export class SilentFlowClient extends BaseClient {
         const environment =
             request.authority || this.authority.getPreferredCache();
         const cacheRecord: CacheRecord = {
-            account: this.cacheManager.readAccountFromCache(request.account),
+            account: this.cacheManager.readAccountFromCache(
+                request.account,
+                request.correlationId
+            ),
             accessToken: cachedAccessToken,
             idToken: this.cacheManager.getIdToken(
                 request.account,
+                request.correlationId,
                 tokenKeys,
                 requestTenantId,
-                this.performanceClient,
-                request.correlationId
+                this.performanceClient
             ),
             refreshToken: null,
             appMetadata:

package/src/error/CacheError.ts

@@ -7,9 +7,8 @@ import * as CacheErrorCodes from "./CacheErrorCodes.js";
 export { CacheErrorCodes };
 
 export const CacheErrorMessages = {
-    [CacheErrorCodes.cacheQuotaExceededErrorCode]:
-        "Exceeded cache storage capacity.",
-    [CacheErrorCodes.cacheUnknownErrorCode]:
+    [CacheErrorCodes.cacheQuotaExceeded]: "Exceeded cache storage capacity.",
+    [CacheErrorCodes.cacheErrorUnknown]:
         "Unexpected error occurred when using cache storage.",
 };
 
@@ -32,7 +31,7 @@ export class CacheError extends Error {
             errorMessage ||
             (CacheErrorMessages[errorCode]
                 ? CacheErrorMessages[errorCode]
-                : CacheErrorMessages[CacheErrorCodes.cacheUnknownErrorCode]);
+                : CacheErrorMessages[CacheErrorCodes.cacheErrorUnknown]);
 
         super(`${errorCode}: ${message}`);
         Object.setPrototypeOf(this, CacheError.prototype);
@@ -42,3 +41,24 @@ export class CacheError extends Error {
         this.errorMessage = message;
     }
 }
+
+/**
+ * Helper function to wrap browser errors in a CacheError object
+ * @param e
+ * @returns
+ */
+export function createCacheError(e: unknown): CacheError {
+    if (!(e instanceof Error)) {
+        return new CacheError(CacheErrorCodes.cacheErrorUnknown);
+    }
+
+    if (
+        e.name === "QuotaExceededError" ||
+        e.name === "NS_ERROR_DOM_QUOTA_REACHED" ||
+        e.message.includes("exceeded the quota")
+    ) {
+        return new CacheError(CacheErrorCodes.cacheQuotaExceeded);
+    } else {
+        return new CacheError(e.name, e.message);
+    }
+}

package/src/error/CacheErrorCodes.ts

@@ -3,5 +3,5 @@
  * Licensed under the MIT License.
  */
 
-export const cacheQuotaExceededErrorCode = "cache_quota_exceeded";
-export const cacheUnknownErrorCode = "cache_error_unknown";
+export const cacheQuotaExceeded = "cache_quota_exceeded";
+export const cacheErrorUnknown = "cache_error_unknown";

package/src/exports-common.ts

@@ -137,7 +137,11 @@ export {
 } from "./error/AuthError.js";
 export { ServerError } from "./error/ServerError.js";
 export { NetworkError, createNetworkError } from "./error/NetworkError.js";
-export { CacheError, CacheErrorCodes } from "./error/CacheError.js";
+export {
+    CacheError,
+    CacheErrorCodes,
+    createCacheError,
+} from "./error/CacheError.js";
 export {
     ClientAuthError,
     ClientAuthErrorMessage,

package/src/network/ThrottlingUtils.ts

@@ -35,14 +35,15 @@ export class ThrottlingUtils {
      */
     static preProcess(
         cacheManager: CacheManager,
-        thumbprint: RequestThumbprint
+        thumbprint: RequestThumbprint,
+        correlationId: string
     ): void {
         const key = ThrottlingUtils.generateThrottlingStorageKey(thumbprint);
         const value = cacheManager.getThrottlingCache(key);
 
         if (value) {
             if (value.throttleTime < Date.now()) {
-                cacheManager.removeItem(key);
+                cacheManager.removeItem(key, correlationId);
                 return;
             }
             throw new ServerError(
@@ -62,7 +63,8 @@ export class ThrottlingUtils {
     static postProcess(
         cacheManager: CacheManager,
         thumbprint: RequestThumbprint,
-        response: NetworkResponse<ServerAuthorizationTokenResponse>
+        response: NetworkResponse<ServerAuthorizationTokenResponse>,
+        correlationId: string
     ): void {
         if (
             ThrottlingUtils.checkResponseStatus(response) ||
@@ -79,7 +81,8 @@ export class ThrottlingUtils {
             };
             cacheManager.setThrottlingCache(
                 ThrottlingUtils.generateThrottlingStorageKey(thumbprint),
-                thumbprintValue
+                thumbprintValue,
+                correlationId
             );
         }
     }
@@ -151,6 +154,6 @@ export class ThrottlingUtils {
         };
 
         const key = this.generateThrottlingStorageKey(thumbprint);
-        cacheManager.removeItem(key);
+        cacheManager.removeItem(key, request.correlationId);
     }
 }

package/src/packageMetadata.ts

@@ -1,3 +1,3 @@
 /* eslint-disable header/header */
 export const name = "@azure/msal-common";
-export const version = "14.16.0";
+export const version = "14.16.1";

package/src/response/ResponseHandler.ts

@@ -376,7 +376,11 @@ export class ResponseHandler {
                 cacheRecord.account
             ) {
                 const key = cacheRecord.account.generateAccountKey();
-                const account = this.cacheStorage.getAccount(key, this.logger);
+                const account = this.cacheStorage.getAccount(
+                    key,
+                    request.correlationId,
+                    this.logger
+                );
                 if (!account) {
                     this.logger.warning(
                         "Account used to refresh tokens not in persistence, refreshed tokens will not be stored in the cache"
@@ -396,8 +400,8 @@ export class ResponseHandler {
             }
             await this.cacheStorage.saveCacheRecord(
                 cacheRecord,
-                request.storeInCache,
-                request.correlationId
+                request.correlationId,
+                request.storeInCache
             );
         } finally {
             if (
@@ -466,6 +470,7 @@ export class ResponseHandler {
                 authority,
                 this.homeAccountIdentifier,
                 this.cryptoObj.base64Decode,
+                request.correlationId,
                 idTokenClaims,
                 serverTokenResponse.client_info,
                 env,
@@ -706,6 +711,7 @@ export function buildAccountToCache(
     authority: Authority,
     homeAccountId: string,
     base64Decode: (input: string) => string,
+    correlationId: string,
     idTokenClaims?: TokenClaims,
     clientInfo?: string,
     environment?: string,
@@ -724,7 +730,11 @@ export function buildAccountToCache(
 
     let cachedAccount: AccountEntity | null = null;
     if (baseAccountKey) {
-        cachedAccount = cacheStorage.getAccount(baseAccountKey, logger);
+        cachedAccount = cacheStorage.getAccount(
+            baseAccountKey,
+            correlationId,
+            logger
+        );
     }
 
     const baseAccount =

package/src/telemetry/server/ServerTelemetryManager.ts

@@ -204,7 +204,8 @@ export class ServerTelemetryManager {
 
         this.cacheManager.setServerTelemetry(
             this.telemetryCacheKey,
-            lastRequests
+            lastRequests,
+            this.correlationId
         );
 
         return;
@@ -219,7 +220,8 @@ export class ServerTelemetryManager {
 
         this.cacheManager.setServerTelemetry(
             this.telemetryCacheKey,
-            lastRequests
+            lastRequests,
+            this.correlationId
         );
         return lastRequests.cacheHits;
     }
@@ -250,7 +252,10 @@ export class ServerTelemetryManager {
         const errorCount = lastRequests.errors.length;
         if (numErrorsFlushed === errorCount) {
             // All errors were sent on last request, clear Telemetry cache
-            this.cacheManager.removeItem(this.telemetryCacheKey);
+            this.cacheManager.removeItem(
+                this.telemetryCacheKey,
+                this.correlationId
+            );
         } else {
             // Partial data was flushed to server, construct a new telemetry cache item with errors that were not flushed
             const serverTelemEntity: ServerTelemetryEntity = {
@@ -263,7 +268,8 @@ export class ServerTelemetryManager {
 
             this.cacheManager.setServerTelemetry(
                 this.telemetryCacheKey,
-                serverTelemEntity
+                serverTelemEntity,
+                this.correlationId
             );
         }
     }
@@ -351,7 +357,8 @@ export class ServerTelemetryManager {
         lastRequests.nativeBrokerErrorCode = errorCode;
         this.cacheManager.setServerTelemetry(
             this.telemetryCacheKey,
-            lastRequests
+            lastRequests,
+            this.correlationId
         );
     }
 
@@ -364,7 +371,8 @@ export class ServerTelemetryManager {
         delete lastRequests.nativeBrokerErrorCode;
         this.cacheManager.setServerTelemetry(
             this.telemetryCacheKey,
-            lastRequests
+            lastRequests,
+            this.correlationId
         );
     }