@azure/msal-browser 3.9.0 → 3.11.0

package/package.json

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

package/src/cache/AsyncMemoryStorage.ts

@@ -9,7 +9,7 @@ import {
     BrowserAuthErrorCodes,
 } from "../error/BrowserAuthError";
 import { DatabaseStorage } from "./DatabaseStorage";
-import { IAsyncStorage } from "./IAsyncMemoryStorage";
+import { IAsyncStorage } from "./IAsyncStorage";
 import { MemoryStorage } from "./MemoryStorage";
 
 /**
@@ -20,13 +20,11 @@ export class AsyncMemoryStorage<T> implements IAsyncStorage<T> {
     private inMemoryCache: MemoryStorage<T>;
     private indexedDBCache: DatabaseStorage<T>;
     private logger: Logger;
-    private storeName: string;
 
-    constructor(logger: Logger, storeName: string) {
+    constructor(logger: Logger) {
         this.inMemoryCache = new MemoryStorage<T>();
         this.indexedDBCache = new DatabaseStorage<T>();
         this.logger = logger;
-        this.storeName = storeName;
     }
 
     private handleDatabaseAccessError(error: unknown): void {
@@ -132,9 +130,9 @@ export class AsyncMemoryStorage<T> implements IAsyncStorage<T> {
      */
     clearInMemory(): void {
         // InMemory cache is a Map instance, clear is straightforward
-        this.logger.verbose(`Deleting in-memory keystore ${this.storeName}`);
+        this.logger.verbose(`Deleting in-memory keystore`);
         this.inMemoryCache.clear();
-        this.logger.verbose(`In-memory keystore ${this.storeName} deleted`);
+        this.logger.verbose(`In-memory keystore deleted`);
     }
 
     /**

package/src/cache/BrowserCacheManager.ts

@@ -189,21 +189,12 @@ export class BrowserCacheManager extends CacheManager {
             PersistentCacheKeys.ERROR_DESC,
         ];
 
-        keysToMigrate.forEach((cacheKey: string, index: number) =>
-            this.migrateCacheEntry(cacheKey, values[index])
-        );
-    }
-
-    /**
-     * Utility function to help with migration.
-     * @param newKey
-     * @param value
-     * @param storeAuthStateInCookie
-     */
-    protected migrateCacheEntry(newKey: string, value: string | null): void {
-        if (value) {
-            this.setTemporaryCache(newKey, value, true);
-        }
+        keysToMigrate.forEach((cacheKey: string, index: number) => {
+            const value = values[index];
+            if (value) {
+                this.setTemporaryCache(cacheKey, value, true);
+            }
+        });
     }
 
     /**
@@ -1206,11 +1197,18 @@ export class BrowserCacheManager extends CacheManager {
 
     /**
      * Removes the cache item with the given key.
-     * Will also clear the cookie item if storeAuthStateInCookie is set to true.
      * @param key
      */
     removeItem(key: string): void {
         this.browserStorage.removeItem(key);
+    }
+
+    /**
+     * Removes the temporary cache item with the given key.
+     * Will also clear the cookie item if storeAuthStateInCookie is set to true.
+     * @param key
+     */
+    removeTemporaryItem(key: string): void {
         this.temporaryCacheStorage.removeItem(key);
         if (this.cacheConfig.storeAuthStateInCookie) {
             this.logger.trace(
@@ -1220,25 +1218,11 @@ export class BrowserCacheManager extends CacheManager {
         }
     }
 
-    /**
-     * Checks whether key is in cache.
-     * @param key
-     */
-    containsKey(key: string): boolean {
-        return (
-            this.browserStorage.containsKey(key) ||
-            this.temporaryCacheStorage.containsKey(key)
-        );
-    }
-
     /**
      * Gets all keys in window.
      */
     getKeys(): string[] {
-        return [
-            ...this.browserStorage.getKeys(),
-            ...this.temporaryCacheStorage.getKeys(),
-        ];
+        return this.browserStorage.getKeys();
     }
 
     /**
@@ -1249,16 +1233,23 @@ export class BrowserCacheManager extends CacheManager {
         await this.removeAllAccounts();
         this.removeAppMetadata();
 
+        // Remove temp storage first to make sure any cookies are cleared
+        this.temporaryCacheStorage.getKeys().forEach((cacheKey: string) => {
+            if (
+                cacheKey.indexOf(Constants.CACHE_PREFIX) !== -1 ||
+                cacheKey.indexOf(this.clientId) !== -1
+            ) {
+                this.removeTemporaryItem(cacheKey);
+            }
+        });
+
         // Removes all remaining MSAL cache items
-        this.getKeys().forEach((cacheKey: string) => {
-            // Check if key contains msal prefix; For now, we are clearing all the cache items created by MSAL.js
+        this.browserStorage.getKeys().forEach((cacheKey: string) => {
             if (
-                (this.browserStorage.containsKey(cacheKey) ||
-                    this.temporaryCacheStorage.containsKey(cacheKey)) &&
-                (cacheKey.indexOf(Constants.CACHE_PREFIX) !== -1 ||
-                    cacheKey.indexOf(this.clientId) !== -1)
+                cacheKey.indexOf(Constants.CACHE_PREFIX) !== -1 ||
+                cacheKey.indexOf(this.clientId) !== -1
             ) {
-                this.removeItem(cacheKey);
+                this.browserStorage.removeItem(cacheKey);
             }
         });
 
@@ -1305,6 +1296,7 @@ export class BrowserCacheManager extends CacheManager {
      * @param cookieName
      * @param cookieValue
      * @param expires
+     * @deprecated
      */
     setItemCookie(
         cookieName: string,
@@ -1329,6 +1321,7 @@ export class BrowserCacheManager extends CacheManager {
     /**
      * Get one item by key from cookies
      * @param cookieName
+     * @deprecated
      */
     getItemCookie(cookieName: string): string {
         const name = `${encodeURIComponent(cookieName)}=`;
@@ -1349,6 +1342,7 @@ export class BrowserCacheManager extends CacheManager {
 
     /**
      * Clear all msal-related cookies currently set in the browser. Should only be used to clear temporary cache items.
+     * @deprecated
      */
     clearMsalCookies(): void {
         const cookiePrefix = `${Constants.CACHE_PREFIX}.${this.clientId}`;
@@ -1368,6 +1362,7 @@ export class BrowserCacheManager extends CacheManager {
     /**
      * Clear an item in the cookies by key
      * @param cookieName
+     * @deprecated
      */
     clearItemCookie(cookieName: string): void {
         this.setItemCookie(cookieName, Constants.EMPTY_STRING, -1);
@@ -1376,6 +1371,7 @@ export class BrowserCacheManager extends CacheManager {
     /**
      * Get cookie expiration time
      * @param cookieLifeDays
+     * @deprecated
      */
     getCookieExpirationTime(cookieLifeDays: number): string {
         const today = new Date();
@@ -1385,20 +1381,6 @@ export class BrowserCacheManager extends CacheManager {
         return expr.toUTCString();
     }
 
-    /**
-     * Gets the cache object referenced by the browser
-     */
-    getCache(): object {
-        return this.browserStorage;
-    }
-
-    /**
-     * interface compat, we cannot overwrite browser cache; Functionality is supported by individual entities in browser
-     */
-    setCache(): void {
-        // sets nothing
-    }
-
     /**
      * Prepend msal.<client-id> to each key; Skip for any JSON object as Key (defined schemas do not need the key appended: AccessToken Keys or the upcoming schema)
      * @param key
@@ -1531,29 +1513,33 @@ export class BrowserCacheManager extends CacheManager {
         this.logger.trace("BrowserCacheManager.resetRequestCache called");
         // check state and remove associated cache items
         if (state) {
-            this.getKeys().forEach((key) => {
+            this.temporaryCacheStorage.getKeys().forEach((key) => {
                 if (key.indexOf(state) !== -1) {
-                    this.removeItem(key);
+                    this.removeTemporaryItem(key);
                 }
             });
 
             // delete generic interactive request parameters
-            this.removeItem(this.generateStateKey(state));
-            this.removeItem(this.generateNonceKey(state));
-            this.removeItem(this.generateAuthorityKey(state));
+            this.removeTemporaryItem(this.generateStateKey(state));
+            this.removeTemporaryItem(this.generateNonceKey(state));
+            this.removeTemporaryItem(this.generateAuthorityKey(state));
         }
-        this.removeItem(
+        this.removeTemporaryItem(
             this.generateCacheKey(TemporaryCacheKeys.REQUEST_PARAMS)
         );
-        this.removeItem(this.generateCacheKey(TemporaryCacheKeys.ORIGIN_URI));
-        this.removeItem(this.generateCacheKey(TemporaryCacheKeys.URL_HASH));
-        this.removeItem(
+        this.removeTemporaryItem(
+            this.generateCacheKey(TemporaryCacheKeys.ORIGIN_URI)
+        );
+        this.removeTemporaryItem(
+            this.generateCacheKey(TemporaryCacheKeys.URL_HASH)
+        );
+        this.removeTemporaryItem(
             this.generateCacheKey(TemporaryCacheKeys.CORRELATION_ID)
         );
-        this.removeItem(
+        this.removeTemporaryItem(
             this.generateCacheKey(TemporaryCacheKeys.CCS_CREDENTIAL)
         );
-        this.removeItem(
+        this.removeTemporaryItem(
             this.generateCacheKey(TemporaryCacheKeys.NATIVE_REQUEST)
         );
         this.setInteractionInProgress(false);
@@ -1587,7 +1573,7 @@ export class BrowserCacheManager extends CacheManager {
             "BrowserCacheManager.cleanRequestByInteractionType called"
         );
         // Loop through all keys to find state key
-        this.getKeys().forEach((key) => {
+        this.temporaryCacheStorage.getKeys().forEach((key) => {
             // If this key is not the state key, move on
             if (key.indexOf(TemporaryCacheKeys.REQUEST_STATE) === -1) {
                 return;
@@ -1656,7 +1642,7 @@ export class BrowserCacheManager extends CacheManager {
                 BrowserAuthErrorCodes.unableToParseTokenRequestCacheError
             );
         }
-        this.removeItem(
+        this.removeTemporaryItem(
             this.generateCacheKey(TemporaryCacheKeys.REQUEST_PARAMS)
         );
 
@@ -1735,7 +1721,7 @@ export class BrowserCacheManager extends CacheManager {
             !inProgress &&
             this.getInteractionInProgress() === this.clientId
         ) {
-            this.removeItem(key);
+            this.removeTemporaryItem(key);
         }
     }
 
@@ -1759,7 +1745,7 @@ export class BrowserCacheManager extends CacheManager {
             true
         );
         if (msalIdTokenString) {
-            this.removeItem(
+            this.browserStorage.removeItem(
                 this.generateCacheKey(PersistentCacheKeys.ID_TOKEN)
             );
             this.logger.verbose("Cached MSAL.js v1 id token retrieved");
@@ -1803,7 +1789,7 @@ export class BrowserCacheManager extends CacheManager {
         if (currentCacheKey !== updatedCacheKey) {
             const cacheItem = this.getItem(currentCacheKey);
             if (cacheItem) {
-                this.removeItem(currentCacheKey);
+                this.browserStorage.removeItem(currentCacheKey);
                 this.setItem(updatedCacheKey, cacheItem);
                 this.logger.verbose(
                     `Updated an outdated ${credential.credentialType} cache key`
@@ -1819,28 +1805,6 @@ export class BrowserCacheManager extends CacheManager {
         return currentCacheKey;
     }
 
-    /**
-     * Returns application id as redirect context during AcquireTokenRedirect flow.
-     */
-    getRedirectRequestContext(): string | null {
-        return this.getTemporaryCache(
-            TemporaryCacheKeys.REDIRECT_CONTEXT,
-            true
-        );
-    }
-
-    /**
-     * Sets application id as the redirect context during AcquireTokenRedirect flow.
-     * @param value
-     */
-    setRedirectRequestContext(value: string): void {
-        this.setTemporaryCache(
-            TemporaryCacheKeys.REDIRECT_CONTEXT,
-            value,
-            true
-        );
-    }
-
     /**
      * Builds credential entities from AuthenticationResult object and saves the resulting credentials to the cache
      * @param result

package/src/cache/DatabaseStorage.ts

@@ -8,7 +8,7 @@ import {
     BrowserAuthErrorCodes,
 } from "../error/BrowserAuthError";
 import { DB_NAME, DB_TABLE_NAME, DB_VERSION } from "../utils/BrowserConstants";
-import { IAsyncStorage } from "./IAsyncMemoryStorage";
+import { IAsyncStorage } from "./IAsyncStorage";
 
 interface IDBOpenDBRequestEvent extends Event {
     target: IDBOpenDBRequest & EventTarget;
@@ -279,9 +279,19 @@ export class DatabaseStorage<T> implements IAsyncStorage<T> {
 
         return new Promise<boolean>((resolve: Function, reject: Function) => {
             const deleteDbRequest = window.indexedDB.deleteDatabase(DB_NAME);
-            deleteDbRequest.addEventListener("success", () => resolve(true));
-            deleteDbRequest.addEventListener("blocked", () => resolve(true));
-            deleteDbRequest.addEventListener("error", () => reject(false));
+            const id = setTimeout(() => reject(false), 200); // Reject if events aren't raised within 200ms
+            deleteDbRequest.addEventListener("success", () => {
+                clearTimeout(id);
+                return resolve(true);
+            });
+            deleteDbRequest.addEventListener("blocked", () => {
+                clearTimeout(id);
+                return resolve(true);
+            });
+            deleteDbRequest.addEventListener("error", () => {
+                clearTimeout(id);
+                return reject(false);
+            });
         });
     }
 }

package/src/controllers/IController.ts

@@ -15,7 +15,7 @@ import { PopupRequest } from "../request/PopupRequest";
 import { SilentRequest } from "../request/SilentRequest";
 import { SsoSilentRequest } from "../request/SsoSilentRequest";
 import { EndSessionRequest } from "../request/EndSessionRequest";
-import { ApiId, InteractionType, WrapperSKU } from "../utils/BrowserConstants";
+import { ApiId, WrapperSKU } from "../utils/BrowserConstants";
 import { INavigationClient } from "../navigation/INavigationClient";
 import { EndSessionPopupRequest } from "../request/EndSessionPopupRequest";
 import { ITokenCache } from "../cache/ITokenCache";
@@ -119,10 +119,4 @@ export interface IController {
 
     /** @internal */
     getEventHandler(): EventHandler;
-
-    /** @internal */
-    preflightBrowserEnvironmentCheck(
-        interactionType: InteractionType,
-        isAppEmbedded?: boolean
-    ): void;
 }

package/src/controllers/NestedAppAuthController.ts

@@ -116,25 +116,43 @@ export class NestedAppAuthController implements IController {
         return Promise.resolve();
     }
 
+    private ensureValidRequest<
+        T extends
+            | SsoSilentRequest
+            | SilentRequest
+            | PopupRequest
+            | RedirectRequest
+    >(request: T): T {
+        if (request?.correlationId) {
+            return request;
+        }
+        return {
+            ...request,
+            correlationId: this.browserCrypto.createNewGuid(),
+        };
+    }
+
     private async acquireTokenInteractive(
         request: PopupRequest | RedirectRequest
     ): Promise<AuthenticationResult> {
+        const validRequest = this.ensureValidRequest(request);
+
         this.eventHandler.emitEvent(
             EventType.ACQUIRE_TOKEN_START,
             InteractionType.Popup,
-            request
+            validRequest
         );
 
         const atPopupMeasurement = this.performanceClient.startMeasurement(
             PerformanceEvents.AcquireTokenPopup,
-            request.correlationId
+            validRequest.correlationId
         );
 
         atPopupMeasurement?.add({ nestedAppAuthRequest: true });
 
         try {
             const naaRequest =
-                this.nestedAppAuthAdapter.toNaaTokenRequest(request);
+                this.nestedAppAuthAdapter.toNaaTokenRequest(validRequest);
             const reqTimestamp = TimeUtils.nowSeconds();
             const response = await this.bridgeProxy.getTokenInteractive(
                 naaRequest
@@ -173,11 +191,12 @@ export class NestedAppAuthController implements IController {
                 e as EventError
             );
 
-            atPopupMeasurement.end({
-                errorCode: error.errorCode,
-                subErrorCode: error.subError,
-                success: false,
-            });
+            atPopupMeasurement.end(
+                {
+                    success: false,
+                },
+                e
+            );
 
             throw error;
         }
@@ -186,15 +205,16 @@ export class NestedAppAuthController implements IController {
     private async acquireTokenSilentInternal(
         request: SilentRequest
     ): Promise<AuthenticationResult> {
+        const validRequest = this.ensureValidRequest(request);
         this.eventHandler.emitEvent(
             EventType.ACQUIRE_TOKEN_START,
             InteractionType.Silent,
-            request
+            validRequest
         );
 
         const ssoSilentMeasurement = this.performanceClient.startMeasurement(
             PerformanceEvents.SsoSilent,
-            request.correlationId
+            validRequest.correlationId
         );
 
         ssoSilentMeasurement?.increment({
@@ -207,7 +227,7 @@ export class NestedAppAuthController implements IController {
 
         try {
             const naaRequest =
-                this.nestedAppAuthAdapter.toNaaTokenRequest(request);
+                this.nestedAppAuthAdapter.toNaaTokenRequest(validRequest);
             const reqTimestamp = TimeUtils.nowSeconds();
             const response = await this.bridgeProxy.getTokenSilent(naaRequest);
 
@@ -241,11 +261,12 @@ export class NestedAppAuthController implements IController {
                 null,
                 e as EventError
             );
-            ssoSilentMeasurement?.end({
-                errorCode: error.errorCode,
-                subErrorCode: error.subError,
-                success: false,
-            });
+            ssoSilentMeasurement?.end(
+                {
+                    success: false,
+                },
+                e
+            );
             throw error;
         }
     }
@@ -392,7 +413,7 @@ export class NestedAppAuthController implements IController {
     handleRedirectPromise(
         hash?: string | undefined // eslint-disable-line @typescript-eslint/no-unused-vars
     ): Promise<AuthenticationResult | null> {
-        throw NestedAppAuthError.createUnsupportedError();
+        return Promise.resolve(null);
     }
     loginPopup(
         request?: PopupRequest | undefined // eslint-disable-line @typescript-eslint/no-unused-vars
@@ -502,12 +523,6 @@ export class NestedAppAuthController implements IController {
     getRedirectResponse(): Map<string, Promise<AuthenticationResult | null>> {
         throw NestedAppAuthError.createUnsupportedError();
     }
-    preflightBrowserEnvironmentCheck(
-        interactionType: InteractionType, // eslint-disable-line @typescript-eslint/no-unused-vars
-        setInteractionInProgress?: boolean | undefined // eslint-disable-line @typescript-eslint/no-unused-vars
-    ): void {
-        throw NestedAppAuthError.createUnsupportedError();
-    }
 
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     async clearCache(logoutRequest?: ClearCacheRequest): Promise<void> {