@azure/msal-browser 3.9.0 → 3.11.0

package/src/controllers/StandardController.ts

@@ -52,10 +52,6 @@ import { SsoSilentRequest } from "../request/SsoSilentRequest";
 import { EventCallbackFunction, EventError } from "../event/EventMessage";
 import { EventType } from "../event/EventType";
 import { EndSessionRequest } from "../request/EndSessionRequest";
-import {
-    BrowserConfigurationAuthErrorCodes,
-    createBrowserConfigurationAuthError,
-} from "../error/BrowserConfigurationAuthError";
 import { EndSessionPopupRequest } from "../request/EndSessionPopupRequest";
 import { INavigationClient } from "../navigation/INavigationClient";
 import { EventHandler } from "../event/EventHandler";
@@ -86,6 +82,7 @@ import { IController } from "./IController";
 import { AuthenticationResult } from "../response/AuthenticationResult";
 import { ClearCacheRequest } from "../request/ClearCacheRequest";
 import { createNewGuid } from "../crypto/BrowserCrypto";
+import { initializeSilentRequest } from "../request/RequestHelpers";
 
 export class StandardController implements IController {
     // OperatingContext
@@ -143,7 +140,6 @@ export class StandardController implements IController {
         string,
         Promise<AuthenticationResult>
     >;
-    private atsAsyncMeasurement?: InProgressPerformanceEvent = undefined;
 
     private ssoSilentMeasurement?: InProgressPerformanceEvent;
     private acquireTokenByCodeAsyncMeasurement?: InProgressPerformanceEvent;
@@ -257,14 +253,15 @@ export class StandardController implements IController {
         return controller;
     }
 
-    private trackPageVisibility(): void {
-        if (!this.atsAsyncMeasurement) {
+    private trackPageVisibility(correlationId?: string): void {
+        if (!correlationId) {
             return;
         }
         this.logger.info("Perf: Visibility change detected");
-        this.atsAsyncMeasurement.increment({
-            visibilityChangeCount: 1,
-        });
+        this.performanceClient.incrementFields(
+            { visibilityChangeCount: 1 },
+            correlationId
+        );
     }
 
     /**
@@ -483,17 +480,13 @@ export class StandardController implements IController {
                             EventType.HANDLE_REDIRECT_END,
                             InteractionType.Redirect
                         );
-                        if (eventError instanceof AuthError) {
-                            rootMeasurement.end({
-                                success: false,
-                                errorCode: eventError.errorCode,
-                                subErrorCode: eventError.subError,
-                            });
-                        } else {
-                            rootMeasurement.end({
+
+                        rootMeasurement.end(
+                            {
                                 success: false,
-                            });
-                        }
+                            },
+                            eventError
+                        );
 
                         throw e;
                     });
@@ -525,7 +518,8 @@ export class StandardController implements IController {
         // Preflight request
         const correlationId = this.getRequestCorrelationId(request);
         this.logger.verbose("acquireTokenRedirect called", correlationId);
-        this.preflightBrowserEnvironmentCheck(InteractionType.Redirect);
+        BrowserUtils.redirectPreflightCheck(this.initialized, this.config);
+        this.browserStorage.setInteractionInProgress(true);
 
         // If logged in, emit acquire token events
         const isLoggedIn = this.getAllAccounts().length > 0;
@@ -579,7 +573,7 @@ export class StandardController implements IController {
                             this.createRedirectClient(correlationId);
                         return redirectClient.acquireToken(request);
                     }
-                    this.getBrowserStorage().setInteractionInProgress(false);
+                    this.browserStorage.setInteractionInProgress(false);
                     throw e;
                 });
         } else {
@@ -628,7 +622,8 @@ export class StandardController implements IController {
 
         try {
             this.logger.verbose("acquireTokenPopup called", correlationId);
-            this.preflightBrowserEnvironmentCheck(InteractionType.Popup);
+            BrowserUtils.preflightCheck(this.initialized);
+            this.browserStorage.setInteractionInProgress(true);
         } catch (e) {
             // Since this function is syncronous we need to reject
             return Promise.reject(e);
@@ -661,7 +656,7 @@ export class StandardController implements IController {
                 ApiId.acquireTokenPopup
             )
                 .then((response) => {
-                    this.getBrowserStorage().setInteractionInProgress(false);
+                    this.browserStorage.setInteractionInProgress(false);
                     atPopupMeasurement.end({
                         success: true,
                         isNativeBroker: true,
@@ -686,7 +681,7 @@ export class StandardController implements IController {
                             this.createPopupClient(correlationId);
                         return popupClient.acquireToken(request);
                     }
-                    this.getBrowserStorage().setInteractionInProgress(false);
+                    this.browserStorage.setInteractionInProgress(false);
                     throw e;
                 });
         } else {
@@ -725,7 +720,7 @@ export class StandardController implements IController {
                 });
                 return result;
             })
-            .catch((e: AuthError) => {
+            .catch((e: Error) => {
                 if (loggedInAccounts.length > 0) {
                     this.eventHandler.emitEvent(
                         EventType.ACQUIRE_TOKEN_FAILURE,
@@ -742,11 +737,13 @@ export class StandardController implements IController {
                     );
                 }
 
-                atPopupMeasurement.end({
-                    errorCode: e.errorCode,
-                    subErrorCode: e.subError,
-                    success: false,
-                });
+                atPopupMeasurement.end(
+                    {
+                        success: false,
+                    },
+                    e
+                );
+
                 // Since this function is syncronous we need to reject
                 return Promise.reject(e);
             });
@@ -795,7 +792,7 @@ export class StandardController implements IController {
             prompt: request.prompt,
             correlationId: correlationId,
         };
-        this.preflightBrowserEnvironmentCheck(InteractionType.Silent);
+        BrowserUtils.preflightCheck(this.initialized);
         this.ssoSilentMeasurement = this.performanceClient.startMeasurement(
             PerformanceEvents.SsoSilent,
             correlationId
@@ -856,18 +853,19 @@ export class StandardController implements IController {
                 });
                 return response;
             })
-            .catch((e: AuthError) => {
+            .catch((e: Error) => {
                 this.eventHandler.emitEvent(
                     EventType.SSO_SILENT_FAILURE,
                     InteractionType.Silent,
                     null,
                     e
                 );
-                this.ssoSilentMeasurement?.end({
-                    errorCode: e.errorCode,
-                    subErrorCode: e.subError,
-                    success: false,
-                });
+                this.ssoSilentMeasurement?.end(
+                    {
+                        success: false,
+                    },
+                    e
+                );
                 throw e;
             })
             .finally(() => {
@@ -892,8 +890,8 @@ export class StandardController implements IController {
         request: AuthorizationCodeRequest
     ): Promise<AuthenticationResult> {
         const correlationId = this.getRequestCorrelationId(request);
-        this.preflightBrowserEnvironmentCheck(InteractionType.Silent);
         this.logger.trace("acquireTokenByCode called", correlationId);
+        BrowserUtils.preflightCheck(this.initialized);
         this.eventHandler.emitEvent(
             EventType.ACQUIRE_TOKEN_BY_CODE_START,
             InteractionType.Silent,
@@ -940,7 +938,7 @@ export class StandardController implements IController {
                             });
                             return result;
                         })
-                        .catch((error: AuthError) => {
+                        .catch((error: Error) => {
                             this.hybridAuthCodeResponses.delete(hybridAuthCode);
                             this.eventHandler.emitEvent(
                                 EventType.ACQUIRE_TOKEN_BY_CODE_FAILURE,
@@ -948,11 +946,12 @@ export class StandardController implements IController {
                                 null,
                                 error
                             );
-                            atbcMeasurement.end({
-                                errorCode: error.errorCode,
-                                subErrorCode: error.subError,
-                                success: false,
-                            });
+                            atbcMeasurement.end(
+                                {
+                                    success: false,
+                                },
+                                error
+                            );
                             throw error;
                         });
                     this.hybridAuthCodeResponses.set(hybridAuthCode, response);
@@ -1000,12 +999,12 @@ export class StandardController implements IController {
                 null,
                 e as EventError
             );
-            atbcMeasurement.end({
-                errorCode: (e instanceof AuthError && e.errorCode) || undefined,
-                subErrorCode:
-                    (e instanceof AuthError && e.subError) || undefined,
-                success: false,
-            });
+            atbcMeasurement.end(
+                {
+                    success: false,
+                },
+                e
+            );
             throw e;
         }
     }
@@ -1048,12 +1047,13 @@ export class StandardController implements IController {
                 });
                 return response;
             })
-            .catch((tokenRenewalError: AuthError) => {
-                this.acquireTokenByCodeAsyncMeasurement?.end({
-                    errorCode: tokenRenewalError.errorCode,
-                    subErrorCode: tokenRenewalError.subError,
-                    success: false,
-                });
+            .catch((tokenRenewalError: Error) => {
+                this.acquireTokenByCodeAsyncMeasurement?.end(
+                    {
+                        success: false,
+                    },
+                    tokenRenewalError
+                );
                 throw tokenRenewalError;
             })
             .finally(() => {
@@ -1073,7 +1073,6 @@ export class StandardController implements IController {
      * @returns A promise that, when resolved, returns the access token
      */
     protected async acquireTokenFromCache(
-        silentCacheClient: SilentCacheClient,
         commonRequest: CommonSilentFlowRequest,
         cacheLookupPolicy: CacheLookupPolicy
     ): Promise<AuthenticationResult> {
@@ -1085,6 +1084,9 @@ export class StandardController implements IController {
             case CacheLookupPolicy.Default:
             case CacheLookupPolicy.AccessToken:
             case CacheLookupPolicy.AccessTokenAndRefreshToken:
+                const silentCacheClient = this.createSilentCacheClient(
+                    commonRequest.correlationId
+                );
                 return invokeAsync(
                     silentCacheClient.acquireToken.bind(silentCacheClient),
                     PerformanceEvents.SilentCacheClientAcquireToken,
@@ -1190,7 +1192,8 @@ export class StandardController implements IController {
      */
     async logoutRedirect(logoutRequest?: EndSessionRequest): Promise<void> {
         const correlationId = this.getRequestCorrelationId(logoutRequest);
-        this.preflightBrowserEnvironmentCheck(InteractionType.Redirect);
+        BrowserUtils.redirectPreflightCheck(this.initialized, this.config);
+        this.browserStorage.setInteractionInProgress(true);
 
         const redirectClient = this.createRedirectClient(correlationId);
         return redirectClient.logout(logoutRequest);
@@ -1203,7 +1206,9 @@ export class StandardController implements IController {
     logoutPopup(logoutRequest?: EndSessionPopupRequest): Promise<void> {
         try {
             const correlationId = this.getRequestCorrelationId(logoutRequest);
-            this.preflightBrowserEnvironmentCheck(InteractionType.Popup);
+            BrowserUtils.preflightCheck(this.initialized);
+            this.browserStorage.setInteractionInProgress(true);
+
             const popupClient = this.createPopupClient(correlationId);
             return popupClient.logout(logoutRequest);
         } catch (e) {
@@ -1424,77 +1429,6 @@ export class StandardController implements IController {
 
     // #region Helpers
 
-    /**
-     * Helper to validate app environment before making an auth request
-     *
-     * @protected
-     * @param {InteractionType} interactionType What kind of interaction is being used
-     * @param {boolean} [isAppEmbedded=false] Whether to set interaction in progress temp cache flag
-     */
-    public preflightBrowserEnvironmentCheck(
-        interactionType: InteractionType,
-        isAppEmbedded: boolean = false
-    ): void {
-        this.logger.verbose("preflightBrowserEnvironmentCheck started");
-        // Block request if not in browser environment
-        BrowserUtils.blockNonBrowserEnvironment(this.isBrowserEnvironment);
-
-        // Block redirects if in an iframe
-        BrowserUtils.blockRedirectInIframe(
-            interactionType,
-            this.config.system.allowRedirectInIframe
-        );
-
-        // Block auth requests inside a hidden iframe
-        BrowserUtils.blockReloadInHiddenIframes();
-
-        // Block redirectUri opened in a popup from calling MSAL APIs
-        BrowserUtils.blockAcquireTokenInPopups();
-
-        // Block token acquisition before initialize has been called
-        BrowserUtils.blockAPICallsBeforeInitialize(this.initialized);
-
-        // Block redirects if memory storage is enabled but storeAuthStateInCookie is not
-        if (
-            interactionType === InteractionType.Redirect &&
-            this.config.cache.cacheLocation ===
-                BrowserCacheLocation.MemoryStorage &&
-            !this.config.cache.storeAuthStateInCookie
-        ) {
-            throw createBrowserConfigurationAuthError(
-                BrowserConfigurationAuthErrorCodes.inMemRedirectUnavailable
-            );
-        }
-
-        if (
-            interactionType === InteractionType.Redirect ||
-            interactionType === InteractionType.Popup
-        ) {
-            this.preflightInteractiveRequest(!isAppEmbedded);
-        }
-    }
-
-    /**
-     * Preflight check for interactive requests
-     *
-     * @protected
-     * @param {boolean} setInteractionInProgress Whether to set interaction in progress temp cache flag
-     */
-    protected preflightInteractiveRequest(
-        setInteractionInProgress: boolean
-    ): void {
-        this.logger.verbose(
-            "preflightInteractiveRequest called, validating app environment"
-        );
-        // block the reload if it occurred inside a hidden iframe
-        BrowserUtils.blockReloadInHiddenIframes();
-
-        // Set interaction in progress temporary cache or throw if alread set.
-        if (setInteractionInProgress) {
-            this.getBrowserStorage().setInteractionInProgress(true);
-        }
-    }
-
     /**
      * Acquire a token from native device (e.g. WAM)
      * @param request
@@ -1820,13 +1754,6 @@ export class StandardController implements IController {
         return this.performanceClient;
     }
 
-    /**
-     * Returns the browser storage
-     */
-    public getBrowserStorage(): BrowserCacheManager {
-        return this.browserStorage;
-    }
-
     /**
      * Returns the browser env indicator
      */
@@ -1920,7 +1847,7 @@ export class StandardController implements IController {
             cacheLookupPolicy: request.cacheLookupPolicy,
         });
 
-        this.preflightBrowserEnvironmentCheck(InteractionType.Silent);
+        BrowserUtils.preflightCheck(this.initialized);
         this.logger.verbose("acquireTokenSilent called", correlationId);
 
         const account = request.account || this.getActiveAccount();
@@ -1979,13 +1906,14 @@ export class StandardController implements IController {
                     });
                     return result;
                 })
-                .catch((error: AuthError) => {
+                .catch((error: Error) => {
                     this.activeSilentTokenRequests.delete(silentRequestKey);
-                    atsMeasurement.end({
-                        errorCode: error.errorCode,
-                        subErrorCode: error.subError,
-                        success: false,
-                    });
+                    atsMeasurement.end(
+                        {
+                            success: false,
+                        },
+                        error
+                    );
                     throw error;
                 });
             this.activeSilentTokenRequests.set(silentRequestKey, response);
@@ -2014,7 +1942,7 @@ export class StandardController implements IController {
      * @returns {Promise.<AuthenticationResult>} - a promise that is fulfilled when this function has completed, or rejected if an error was raised. Returns the {@link AuthResponse}
      */
     protected async acquireTokenSilentAsync(
-        request: SilentRequest,
+        request: SilentRequest & { correlationId: string },
         account: AccountInfo
     ): Promise<AuthenticationResult> {
         this.performanceClient.addQueueMeasurement(
@@ -2027,14 +1955,17 @@ export class StandardController implements IController {
             InteractionType.Silent,
             request
         );
-        this.atsAsyncMeasurement = this.performanceClient.startMeasurement(
-            PerformanceEvents.AcquireTokenSilentAsync,
-            request.correlationId
+
+        if (request.correlationId) {
+            this.performanceClient.incrementFields(
+                { visibilityChangeCount: 0 },
+                request.correlationId
+            );
+        }
+
+        document.addEventListener("visibilitychange", () =>
+            this.trackPageVisibility(request.correlationId)
         );
-        this.atsAsyncMeasurement?.increment({
-            visibilityChangeCount: 0,
-        });
-        document.addEventListener("visibilitychange", this.trackPageVisibility);
         let result: Promise<AuthenticationResult>;
         if (
             NativeMessageHandler.isNativeAvailable(
@@ -2076,19 +2007,19 @@ export class StandardController implements IController {
                 "acquireTokenSilent - attempting to acquire token from web flow"
             );
 
-            const silentCacheClient = this.createSilentCacheClient(
-                request.correlationId
-            );
-
             const silentRequest = await invokeAsync(
-                silentCacheClient.initializeSilentRequest.bind(
-                    silentCacheClient
-                ),
+                initializeSilentRequest,
                 PerformanceEvents.InitializeSilentRequest,
                 this.logger,
                 this.performanceClient,
                 request.correlationId
-            )(request, account);
+            )(
+                request,
+                account,
+                this.config,
+                this.performanceClient,
+                this.logger
+            );
 
             const cacheLookupPolicy =
                 request.cacheLookupPolicy || CacheLookupPolicy.Default;
@@ -2099,7 +2030,7 @@ export class StandardController implements IController {
                 this.logger,
                 this.performanceClient,
                 silentRequest.correlationId
-            )(silentCacheClient, silentRequest, cacheLookupPolicy).catch(
+            )(silentRequest, cacheLookupPolicy).catch(
                 (cacheError: AuthError) => {
                     if (
                         request.cacheLookupPolicy ===
@@ -2108,8 +2039,6 @@ export class StandardController implements IController {
                         throw cacheError;
                     }
 
-                    // block the reload if it occurred inside a hidden iframe
-                    BrowserUtils.blockReloadInHiddenIframes();
                     this.eventHandler.emitEvent(
                         EventType.ACQUIRE_TOKEN_NETWORK_START,
                         InteractionType.Silent,
@@ -2160,32 +2089,31 @@ export class StandardController implements IController {
                     InteractionType.Silent,
                     response
                 );
-                this.atsAsyncMeasurement?.end({
-                    success: true,
-                    fromCache: response.fromCache,
-                    isNativeBroker: response.fromNativeBroker,
-                    requestId: response.requestId,
-                });
+                if (request.correlationId) {
+                    this.performanceClient.addFields(
+                        {
+                            fromCache: response.fromCache,
+                            isNativeBroker: response.fromNativeBroker,
+                            requestId: response.requestId,
+                        },
+                        request.correlationId
+                    );
+                }
+
                 return response;
             })
-            .catch((tokenRenewalError: AuthError) => {
+            .catch((tokenRenewalError: Error) => {
                 this.eventHandler.emitEvent(
                     EventType.ACQUIRE_TOKEN_FAILURE,
                     InteractionType.Silent,
                     null,
                     tokenRenewalError
                 );
-                this.atsAsyncMeasurement?.end({
-                    errorCode: tokenRenewalError.errorCode,
-                    subErrorCode: tokenRenewalError.subError,
-                    success: false,
-                });
                 throw tokenRenewalError;
             })
             .finally(() => {
-                document.removeEventListener(
-                    "visibilitychange",
-                    this.trackPageVisibility
+                document.removeEventListener("visibilitychange", () =>
+                    this.trackPageVisibility(request.correlationId)
                 );
             });
     }