@azure/msal-browser 3.17.0 → 3.19.0

package/src/controllers/StandardController.ts

@@ -84,6 +84,7 @@ import { AuthenticationResult } from "../response/AuthenticationResult";
 import { ClearCacheRequest } from "../request/ClearCacheRequest";
 import { createNewGuid } from "../crypto/BrowserCrypto";
 import { initializeSilentRequest } from "../request/RequestHelpers";
+import { InitializeApplicationRequest } from "../request/InitializeApplicationRequest";
 
 function getAccountType(
     account?: AccountInfo
@@ -281,10 +282,11 @@ export class StandardController implements IController {
     }
 
     static async createController(
-        operatingContext: BaseOperatingContext
+        operatingContext: BaseOperatingContext,
+        request?: InitializeApplicationRequest
     ): Promise<IController> {
         const controller = new StandardController(operatingContext);
-        await controller.initialize();
+        await controller.initialize(request);
         return controller;
     }
 
@@ -301,8 +303,9 @@ export class StandardController implements IController {
 
     /**
      * Initializer function to perform async startup tasks such as connecting to WAM extension
+     * @param request {?InitializeApplicationRequest} correlation id
      */
-    async initialize(): Promise<void> {
+    async initialize(request?: InitializeApplicationRequest): Promise<void> {
         this.logger.trace("initialize called");
         if (this.initialized) {
             this.logger.info(
@@ -311,9 +314,12 @@ export class StandardController implements IController {
             return;
         }
 
+        const initCorrelationId =
+            request?.correlationId || this.getRequestCorrelationId();
         const allowNativeBroker = this.config.system.allowNativeBroker;
         const initMeasurement = this.performanceClient.startMeasurement(
-            PerformanceEvents.InitializeClientApplication
+            PerformanceEvents.InitializeClientApplication,
+            initCorrelationId
         );
         this.eventHandler.emitEvent(EventType.INITIALIZE_START);
 
@@ -341,8 +347,9 @@ export class StandardController implements IController {
                 ),
                 PerformanceEvents.ClearTokensAndKeysWithClaims,
                 this.logger,
-                this.performanceClient
-            )(this.performanceClient);
+                this.performanceClient,
+                initCorrelationId
+            )(this.performanceClient, initCorrelationId);
         }
 
         this.initialized = true;
@@ -1963,6 +1970,8 @@ export class StandardController implements IController {
         request: SilentRequest & { correlationId: string },
         account: AccountInfo
     ): Promise<AuthenticationResult> {
+        const trackPageVisibility = () =>
+            this.trackPageVisibility(request.correlationId);
         this.performanceClient.addQueueMeasurement(
             PerformanceEvents.AcquireTokenSilentAsync,
             request.correlationId
@@ -1981,9 +1990,7 @@ export class StandardController implements IController {
             );
         }
 
-        document.addEventListener("visibilitychange", () =>
-            this.trackPageVisibility(request.correlationId)
-        );
+        document.addEventListener("visibilitychange", trackPageVisibility);
 
         const silentRequest = await invokeAsync(
             initializeSilentRequest,
@@ -2124,8 +2131,9 @@ export class StandardController implements IController {
                 throw tokenRenewalError;
             })
             .finally(() => {
-                document.removeEventListener("visibilitychange", () =>
-                    this.trackPageVisibility(request.correlationId)
+                document.removeEventListener(
+                    "visibilitychange",
+                    trackPageVisibility
                 );
             });
     }

package/src/error/NestedAppAuthError.ts

@@ -11,7 +11,7 @@ import { AuthError } from "@azure/msal-common";
 export const NestedAppAuthErrorMessage = {
     unsupportedMethod: {
         code: "unsupported_method",
-        desc: "The PKCE code challenge and verifier could not be generated.",
+        desc: "This method is not supported in nested app environment.",
     },
 };
 

package/src/index.ts

@@ -66,6 +66,7 @@ export { AuthorizationUrlRequest } from "./request/AuthorizationUrlRequest";
 export { AuthorizationCodeRequest } from "./request/AuthorizationCodeRequest";
 export { AuthenticationResult } from "./response/AuthenticationResult";
 export { ClearCacheRequest } from "./request/ClearCacheRequest";
+export { InitializeApplicationRequest } from "./request/InitializeApplicationRequest";
 
 // Cache
 export { LoadTokenOptions } from "./cache/TokenCache";

package/src/interaction_client/NativeInteractionClient.ts

@@ -25,7 +25,6 @@ import {
     AuthError,
     CommonSilentFlowRequest,
     AccountInfo,
-    CacheRecord,
     AADServerParamKeys,
     TokenClaims,
     createClientAuthError,
@@ -289,13 +288,17 @@ export class NativeInteractionClient extends BaseInteractionClient {
         this.logger.trace(
             "NativeInteractionClient - acquireTokenRedirect called."
         );
-        const nativeRequest = await this.initializeNativeRequest(request);
 
-        const { ...nativeTokenRequest } = nativeRequest;
+        const { ...remainingParameters } = request;
+        delete remainingParameters.onRedirectNavigate;
+
+        const nativeRequest = await this.initializeNativeRequest(
+            remainingParameters
+        );
 
         const messageBody: NativeExtensionRequestBody = {
             method: NativeExtensionMethod.GetToken,
-            request: nativeTokenRequest,
+            request: nativeRequest,
         };
 
         try {
@@ -458,8 +461,8 @@ export class NativeInteractionClient extends BaseInteractionClient {
             this.browserStorage,
             authority,
             homeAccountIdentifier,
-            idTokenClaims,
             base64Decode,
+            idTokenClaims,
             response.client_info,
             undefined, // environment
             idTokenClaims.tid,
@@ -739,11 +742,10 @@ export class NativeInteractionClient extends BaseInteractionClient {
                 request.keyId
             );
 
-        const nativeCacheRecord = new CacheRecord(
-            undefined,
-            cachedIdToken,
-            cachedAccessToken
-        );
+        const nativeCacheRecord = {
+            idToken: cachedIdToken,
+            accessToken: cachedAccessToken,
+        };
 
         void this.nativeStorageManager.saveCacheRecord(
             nativeCacheRecord,

package/src/packageMetadata.ts

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

package/src/request/InitializeApplicationRequest.ts

@@ -0,0 +1,13 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * InitializeApplicationRequest: Request object passed by user to initialize application
+ *
+ * - correlationId              - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
+ */
+export type InitializeApplicationRequest = {
+    correlationId?: string;
+};