@azure/msal-browser 3.18.0 → 3.19.0

package/package.json

@@ -10,7 +10,7 @@
     "type": "git",
     "url": "https://github.com/AzureAD/microsoft-authentication-library-for-js.git"
   },
-  "version": "3.18.0",
+  "version": "3.19.0",
   "description": "Microsoft Authentication Library for js",
   "keywords": [
     "implicit",

package/src/app/IPublicClientApplication.ts

@@ -27,9 +27,11 @@ import { BrowserConfiguration } from "../config/Configuration";
 import { AuthenticationResult } from "../response/AuthenticationResult";
 import { EventCallbackFunction } from "../event/EventMessage";
 import { ClearCacheRequest } from "../request/ClearCacheRequest";
+import { InitializeApplicationRequest } from "../request/InitializeApplicationRequest";
 
 export interface IPublicClientApplication {
-    initialize(): Promise<void>;
+    // TODO: Make request mandatory in the next major version?
+    initialize(request?: InitializeApplicationRequest): Promise<void>;
     acquireTokenPopup(request: PopupRequest): Promise<AuthenticationResult>;
     acquireTokenRedirect(request: RedirectRequest): Promise<void>;
     acquireTokenSilent(

package/src/app/PublicClientApplication.ts

@@ -30,6 +30,7 @@ import { ClearCacheRequest } from "../request/ClearCacheRequest";
 import { EndSessionPopupRequest } from "../request/EndSessionPopupRequest";
 import { NestedAppAuthController } from "../controllers/NestedAppAuthController";
 import { NestedAppOperatingContext } from "../operatingcontext/NestedAppOperatingContext";
+import { InitializeApplicationRequest } from "../request/InitializeApplicationRequest";
 
 /**
  * The PublicClientApplication class is the object exposed by the library to perform authentication and authorization functions in Single Page Applications
@@ -38,7 +39,11 @@ import { NestedAppOperatingContext } from "../operatingcontext/NestedAppOperatin
 export class PublicClientApplication implements IPublicClientApplication {
     protected controller: IController;
 
-    // creates StandardController and passes it to the PublicClientApplication
+    /**
+     * Creates StandardController and passes it to the PublicClientApplication
+     *
+     * @param configuration {Configuration}
+     */
     public static async createPublicClientApplication(
         configuration: Configuration
     ): Promise<IPublicClientApplication> {
@@ -80,9 +85,10 @@ export class PublicClientApplication implements IPublicClientApplication {
 
     /**
      * Initializer function to perform async startup tasks such as connecting to WAM extension
+     * @param request {?InitializeApplicationRequest}
      */
-    async initialize(): Promise<void> {
-        return this.controller.initialize();
+    async initialize(request?: InitializeApplicationRequest): Promise<void> {
+        return this.controller.initialize(request);
     }
 
     /**

package/src/cache/BrowserCacheManager.ts

@@ -1266,13 +1266,16 @@ export class BrowserCacheManager extends CacheManager {
     /**
      * Clears all access tokes that have claims prior to saving the current one
      * @param performanceClient {IPerformanceClient}
+     * @param correlationId {string} correlation id
      * @returns
      */
     async clearTokensAndKeysWithClaims(
-        performanceClient: IPerformanceClient
+        performanceClient: IPerformanceClient,
+        correlationId: string
     ): Promise<void> {
         performanceClient.addQueueMeasurement(
-            PerformanceEvents.ClearTokensAndKeysWithClaims
+            PerformanceEvents.ClearTokensAndKeysWithClaims,
+            correlationId
         );
 
         const tokenKeys = this.getTokenKeys();

package/src/controllers/ControllerFactory.ts

@@ -9,14 +9,16 @@ import { IController } from "./IController";
 import { Configuration } from "../config/Configuration";
 import { StandardController } from "./StandardController";
 import { NestedAppAuthController } from "./NestedAppAuthController";
+import { InitializeApplicationRequest } from "../request/InitializeApplicationRequest";
 
 export async function createV3Controller(
-    config: Configuration
+    config: Configuration,
+    request?: InitializeApplicationRequest
 ): Promise<IController> {
     const standard = new StandardOperatingContext(config);
 
     await standard.initialize();
-    return StandardController.createController(standard);
+    return StandardController.createController(standard, request);
 }
 
 export async function createController(

package/src/controllers/IController.ts

@@ -25,9 +25,11 @@ import { EventHandler } from "../event/EventHandler";
 import { AuthenticationResult } from "../response/AuthenticationResult";
 import { EventCallbackFunction } from "../event/EventMessage";
 import { ClearCacheRequest } from "../request/ClearCacheRequest";
+import { InitializeApplicationRequest } from "../request/InitializeApplicationRequest";
 
 export interface IController {
-    initialize(): Promise<void>;
+    // TODO: Make request mandatory in the next major version?
+    initialize(request?: InitializeApplicationRequest): Promise<void>;
 
     acquireTokenPopup(request: PopupRequest): Promise<AuthenticationResult>;
 

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;

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

@@ -288,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 {

package/src/packageMetadata.ts

@@ -1,3 +1,3 @@
 /* eslint-disable header/header */
 export const name = "@azure/msal-browser";
-export const version = "3.18.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;
+};