@azure/msal-browser 4.24.0 → 5.0.0-alpha.0

package/src/controllers/NestedAppAuthController.ts

@@ -12,16 +12,15 @@ import {
     ICrypto,
     IPerformanceClient,
     DEFAULT_CRYPTO_IMPLEMENTATION,
-    PerformanceEvents,
     TimeUtils,
     buildStaticAuthorityOptions,
-    AccountEntity,
-    OIDC_DEFAULT_SCOPES,
+    Constants,
     BaseAuthRequest,
     AccountFilter,
     AuthError,
+    AccountEntityUtils,
 } from "@azure/msal-common/browser";
-import { ITokenCache } from "../cache/ITokenCache.js";
+import * as RootPerformanceEvents from "../telemetry/BrowserRootPerformanceEvents.js";
 import { BrowserConfiguration } from "../config/Configuration.js";
 import { INavigationClient } from "../navigation/INavigationClient.js";
 import { AuthorizationCodeRequest } from "../request/AuthorizationCodeRequest.js";
@@ -38,7 +37,7 @@ import {
     DEFAULT_REQUEST,
     CacheLookupPolicy,
 } from "../utils/BrowserConstants.js";
-import { IController } from "./IController.js";
+import { IController, HandleRedirectPromiseOptions } from "./IController.js";
 import { NestedAppOperatingContext } from "../operatingcontext/NestedAppOperatingContext.js";
 import { IBridgeProxy } from "../naa/IBridgeProxy.js";
 import { CryptoOps } from "../crypto/CryptoOps.js";
@@ -57,7 +56,6 @@ import * as AccountManager from "../cache/AccountManager.js";
 import { AccountContext } from "../naa/BridgeAccountContext.js";
 import { InitializeApplicationRequest } from "../request/InitializeApplicationRequest.js";
 import { createNewGuid } from "../crypto/BrowserCrypto.js";
-
 export class NestedAppAuthController implements IController {
     // OperatingContext
     protected readonly operatingContext: NestedAppOperatingContext;
@@ -199,6 +197,7 @@ export class NestedAppAuthController implements IController {
         request: PopupRequest | RedirectRequest
     ): Promise<AuthenticationResult> {
         const validRequest = this.ensureValidRequest(request);
+        const correlationId = validRequest.correlationId || createNewGuid();
 
         this.eventHandler.emitEvent(
             EventType.ACQUIRE_TOKEN_START,
@@ -207,11 +206,11 @@ export class NestedAppAuthController implements IController {
         );
 
         const atPopupMeasurement = this.performanceClient.startMeasurement(
-            PerformanceEvents.AcquireTokenPopup,
-            validRequest.correlationId
+            RootPerformanceEvents.AcquireTokenPopup,
+            correlationId
         );
 
-        atPopupMeasurement.add({ nestedAppAuthRequest: true });
+        atPopupMeasurement?.add({ nestedAppAuthRequest: true });
 
         try {
             const naaRequest =
@@ -235,7 +234,7 @@ export class NestedAppAuthController implements IController {
             } catch (error) {
                 this.logger.warningPii(
                     `Failed to hydrate cache. Error: ${error}`,
-                    validRequest.correlationId
+                    correlationId
                 );
             }
 
@@ -257,14 +256,10 @@ export class NestedAppAuthController implements IController {
                 idTokenSize: result.idToken.length,
             });
 
-            atPopupMeasurement.end(
-                {
-                    success: true,
-                    requestId: result.requestId,
-                },
-                undefined,
-                result.account
-            );
+            atPopupMeasurement.end({
+                success: true,
+                requestId: result.requestId,
+            });
 
             return result;
         } catch (e) {
@@ -283,8 +278,7 @@ export class NestedAppAuthController implements IController {
                 {
                     success: false,
                 },
-                e,
-                request.account
+                e
             );
 
             throw error;
@@ -300,6 +294,7 @@ export class NestedAppAuthController implements IController {
         request: SilentRequest
     ): Promise<AuthenticationResult> {
         const validRequest = this.ensureValidRequest(request);
+        const correlationId = validRequest.correlationId || createNewGuid();
         this.eventHandler.emitEvent(
             EventType.ACQUIRE_TOKEN_START,
             InteractionType.Silent,
@@ -319,14 +314,15 @@ export class NestedAppAuthController implements IController {
 
         // proceed with acquiring tokens via the host
         const ssoSilentMeasurement = this.performanceClient.startMeasurement(
-            PerformanceEvents.SsoSilent,
-            validRequest.correlationId
+            RootPerformanceEvents.SsoSilent,
+            correlationId
         );
 
-        ssoSilentMeasurement.increment({
+        ssoSilentMeasurement?.increment({
             visibilityChangeCount: 0,
         });
-        ssoSilentMeasurement.add({
+
+        ssoSilentMeasurement?.add({
             nestedAppAuthRequest: true,
         });
 
@@ -351,7 +347,7 @@ export class NestedAppAuthController implements IController {
             } catch (error) {
                 this.logger.warningPii(
                     `Failed to hydrate cache. Error: ${error}`,
-                    validRequest.correlationId
+                    correlationId
                 );
             }
 
@@ -371,14 +367,10 @@ export class NestedAppAuthController implements IController {
                 accessTokenSize: result.accessToken.length,
                 idTokenSize: result.idToken.length,
             });
-            ssoSilentMeasurement?.end(
-                {
-                    success: true,
-                    requestId: result.requestId,
-                },
-                undefined,
-                result.account
-            );
+            ssoSilentMeasurement?.end({
+                success: true,
+                requestId: result.requestId,
+            });
             return result;
         } catch (e) {
             const error =
@@ -395,8 +387,7 @@ export class NestedAppAuthController implements IController {
                 {
                     success: false,
                 },
-                e,
-                request.account
+                e
             );
             throw error;
         }
@@ -410,9 +401,10 @@ export class NestedAppAuthController implements IController {
     private async acquireTokenFromCache(
         request: SilentRequest
     ): Promise<AuthenticationResult | null> {
+        const correlationId = request.correlationId || createNewGuid();
         const atsMeasurement = this.performanceClient.startMeasurement(
-            PerformanceEvents.AcquireTokenSilent,
-            request.correlationId
+            RootPerformanceEvents.AcquireTokenSilent,
+            correlationId
         );
 
         atsMeasurement?.add({
@@ -422,7 +414,8 @@ export class NestedAppAuthController implements IController {
         // if the request has claims, we cannot look up in the cache
         if (request.claims) {
             this.logger.verbose(
-                "Claims are present in the request, skipping cache lookup"
+                "Claims are present in the request, skipping cache lookup",
+                correlationId
             );
             return null;
         }
@@ -430,7 +423,8 @@ export class NestedAppAuthController implements IController {
         // if the request has forceRefresh, we cannot look up in the cache
         if (request.forceRefresh) {
             this.logger.verbose(
-                "forceRefresh is set to true, skipping cache lookup"
+                "forceRefresh is set to true, skipping cache lookup",
+                correlationId
             );
             return null;
         }
@@ -457,22 +451,19 @@ export class NestedAppAuthController implements IController {
                 InteractionType.Silent,
                 result
             );
-            atsMeasurement.add({
-                accessTokenSize: result.accessToken.length,
-                idTokenSize: result.idToken.length,
+            atsMeasurement?.add({
+                accessTokenSize: result?.accessToken.length,
+                idTokenSize: result?.idToken.length,
+            });
+            atsMeasurement?.end({
+                success: true,
             });
-            atsMeasurement.end(
-                {
-                    success: true,
-                },
-                undefined,
-                result.account
-            );
             return result;
         }
 
         this.logger.warning(
-            "Cached tokens are not found for the account, proceeding with silent token request."
+            "Cached tokens are not found for the account, proceeding with silent token request.",
+            correlationId
         );
 
         this.eventHandler.emitEvent(
@@ -480,13 +471,9 @@ export class NestedAppAuthController implements IController {
             InteractionType.Silent,
             null
         );
-        atsMeasurement.end(
-            {
-                success: false,
-            },
-            undefined,
-            request.account
-        );
+        atsMeasurement?.end({
+            success: false,
+        });
 
         return null;
     }
@@ -502,9 +489,8 @@ export class NestedAppAuthController implements IController {
         // always prioritize the account context from the bridge
         const accountContext =
             this.bridgeProxy.getAccountContext() || this.currentAccountContext;
+        const correlationId = request.correlationId || createNewGuid();
         let currentAccount: AccountInfo | null = null;
-        const correlationId =
-            request.correlationId || this.browserCrypto.createNewGuid();
         if (accountContext) {
             currentAccount = AccountManager.getAccount(
                 accountContext,
@@ -517,23 +503,24 @@ export class NestedAppAuthController implements IController {
         // fall back to brokering if no cached account is found
         if (!currentAccount) {
             this.logger.verbose(
-                "No active account found, falling back to the host"
+                "No active account found, falling back to the host",
+                correlationId
             );
             return Promise.resolve(null);
         }
 
         this.logger.verbose(
-            "active account found, attempting to acquire token silently"
+            "active account found, attempting to acquire token silently",
+            correlationId
         );
 
         const authRequest: BaseAuthRequest = {
             ...request,
-            correlationId:
-                request.correlationId || this.browserCrypto.createNewGuid(),
+            correlationId: correlationId,
             authority: request.authority || currentAccount.environment,
             scopes: request.scopes?.length
                 ? request.scopes
-                : [...OIDC_DEFAULT_SCOPES],
+                : [...Constants.OIDC_DEFAULT_SCOPES],
         };
 
         // fetch access token and check for expiry
@@ -547,7 +534,7 @@ export class NestedAppAuthController implements IController {
 
         // If there is no access token, log it and return null
         if (!cachedAccessToken) {
-            this.logger.verbose("No cached access token found");
+            this.logger.verbose("No cached access token found", correlationId);
             return Promise.resolve(null);
         } else if (
             TimeUtils.wasClockTurnedBack(cachedAccessToken.cachedAt) ||
@@ -556,7 +543,10 @@ export class NestedAppAuthController implements IController {
                 this.config.system.tokenRenewalOffsetSeconds
             )
         ) {
-            this.logger.verbose("Cached access token has expired");
+            this.logger.verbose(
+                "Cached access token has expired",
+                correlationId
+            );
             return Promise.resolve(null);
         }
 
@@ -564,12 +554,11 @@ export class NestedAppAuthController implements IController {
             currentAccount,
             authRequest.correlationId,
             tokenKeys,
-            currentAccount.tenantId,
-            this.performanceClient
+            currentAccount.tenantId
         );
 
         if (!cachedIdToken) {
-            this.logger.verbose("No cached id token found");
+            this.logger.verbose("No cached id token found", correlationId);
             return Promise.resolve(null);
         }
 
@@ -636,7 +625,6 @@ export class NestedAppAuthController implements IController {
             | Partial<
                   Omit<
                       CommonAuthorizationUrlRequest,
-                      | "requestedClaimsHash"
                       | "responseMode"
                       | "earJwk"
                       | "codeChallenge"
@@ -693,14 +681,6 @@ export class NestedAppAuthController implements IController {
         throw NestedAppAuthError.createUnsupportedError();
     }
 
-    enableAccountStorageEvents(): void {
-        throw NestedAppAuthError.createUnsupportedError();
-    }
-
-    disableAccountStorageEvents(): void {
-        throw NestedAppAuthError.createUnsupportedError();
-    }
-
     // #region Account APIs
 
     /**
@@ -709,12 +689,11 @@ export class NestedAppAuthController implements IController {
      * @returns Array of AccountInfo objects in cache
      */
     getAllAccounts(accountFilter?: AccountFilter): AccountInfo[] {
-        const correlationId = this.browserCrypto.createNewGuid();
         return AccountManager.getAllAccounts(
             this.logger,
             this.browserStorage,
             this.isBrowserEnv(),
-            correlationId,
+            createNewGuid(),
             accountFilter
         );
     }
@@ -725,12 +704,11 @@ 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 = this.browserCrypto.createNewGuid();
         return AccountManager.getAccount(
             accountFilter,
             this.logger,
             this.browserStorage,
-            correlationId
+            createNewGuid()
         );
     }
 
@@ -743,12 +721,11 @@ export class NestedAppAuthController implements IController {
      * @returns The account object stored in MSAL
      */
     getAccountByUsername(username: string): AccountInfo | null {
-        const correlationId = this.browserCrypto.createNewGuid();
         return AccountManager.getAccountByUsername(
             username,
             this.logger,
             this.browserStorage,
-            correlationId
+            createNewGuid()
         );
     }
 
@@ -760,12 +737,11 @@ export class NestedAppAuthController implements IController {
      * @returns The account object stored in MSAL
      */
     getAccountByHomeId(homeAccountId: string): AccountInfo | null {
-        const correlationId = this.browserCrypto.createNewGuid();
         return AccountManager.getAccountByHomeId(
             homeAccountId,
             this.logger,
             this.browserStorage,
-            correlationId
+            createNewGuid()
         );
     }
 
@@ -777,12 +753,11 @@ export class NestedAppAuthController implements IController {
      * @returns The account object stored in MSAL
      */
     getAccountByLocalId(localAccountId: string): AccountInfo | null {
-        const correlationId = this.browserCrypto.createNewGuid();
         return AccountManager.getAccountByLocalId(
             localAccountId,
             this.logger,
             this.browserStorage,
-            correlationId
+            createNewGuid()
         );
     }
 
@@ -795,11 +770,10 @@ 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
          */
-        const correlationId = this.browserCrypto.createNewGuid();
         return AccountManager.setActiveAccount(
             account,
             this.browserStorage,
-            correlationId
+            createNewGuid()
         );
     }
 
@@ -807,17 +781,16 @@ export class NestedAppAuthController implements IController {
      * Gets the currently active account
      */
     getActiveAccount(): AccountInfo | null {
-        const correlationId = this.browserCrypto.createNewGuid();
         return AccountManager.getActiveAccount(
             this.browserStorage,
-            correlationId
+            createNewGuid()
         );
     }
 
     // #endregion
 
     handleRedirectPromise(
-        hash?: string | undefined // eslint-disable-line @typescript-eslint/no-unused-vars
+        options?: HandleRedirectPromiseOptions // eslint-disable-line @typescript-eslint/no-unused-vars
     ): Promise<AuthenticationResult | null> {
         return Promise.resolve(null);
     }
@@ -830,10 +803,6 @@ export class NestedAppAuthController implements IController {
     loginRedirect(request?: RedirectRequest | undefined): Promise<void> {
         throw NestedAppAuthError.createUnsupportedError();
     }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    logout(logoutRequest?: EndSessionRequest | undefined): Promise<void> {
-        throw NestedAppAuthError.createUnsupportedError();
-    }
     logoutRedirect(
         logoutRequest?: EndSessionRequest | undefined // eslint-disable-line @typescript-eslint/no-unused-vars
     ): Promise<void> {
@@ -849,7 +818,6 @@ export class NestedAppAuthController implements IController {
         request: Partial<
             Omit<
                 CommonAuthorizationUrlRequest,
-                | "requestedClaimsHash"
                 | "responseMode"
                 | "earJwk"
                 | "codeChallenge"
@@ -860,9 +828,6 @@ export class NestedAppAuthController implements IController {
     ): Promise<AuthenticationResult> {
         return this.acquireTokenSilentInternal(request as SilentRequest);
     }
-    getTokenCache(): ITokenCache {
-        throw NestedAppAuthError.createUnsupportedError();
-    }
 
     /**
      * Returns the logger instance
@@ -891,7 +856,8 @@ export class NestedAppAuthController implements IController {
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     setNavigationClient(navigationClient: INavigationClient): void {
         this.logger.warning(
-            "setNavigationClient is not supported in nested app auth"
+            "setNavigationClient is not supported in nested app auth",
+            ""
         );
     }
 
@@ -928,13 +894,14 @@ export class NestedAppAuthController implements IController {
             | RedirectRequest
             | PopupRequest
     ): Promise<void> {
-        this.logger.verbose("hydrateCache called");
+        this.logger.verbose("hydrateCache called", result.correlationId);
 
-        const accountEntity = AccountEntity.createFromAccountInfo(
-            result.account,
-            result.cloudGraphHostName,
-            result.msGraphHost
-        );
+        const accountEntity =
+            AccountEntityUtils.createAccountEntityFromAccountInfo(
+                result.account,
+                result.cloudGraphHostName,
+                result.msGraphHost
+            );
         await this.browserStorage.setAccount(
             accountEntity,
             result.correlationId