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

package/src/app/PublicClientApplication.ts

@@ -3,7 +3,6 @@
  * Licensed under the MIT License.
  */
 
-import { ITokenCache } from "../cache/ITokenCache.js";
 import { INavigationClient } from "../navigation/INavigationClient.js";
 import { AuthorizationCodeRequest } from "../request/AuthorizationCodeRequest.js";
 import { PopupRequest } from "../request/PopupRequest.js";
@@ -11,7 +10,10 @@ import { RedirectRequest } from "../request/RedirectRequest.js";
 import { SilentRequest } from "../request/SilentRequest.js";
 import { WrapperSKU } from "../utils/BrowserConstants.js";
 import { IPublicClientApplication } from "./IPublicClientApplication.js";
-import { IController } from "../controllers/IController.js";
+import {
+    HandleRedirectPromiseOptions,
+    IController,
+} from "../controllers/IController.js";
 import {
     PerformanceCallbackFunction,
     AccountInfo,
@@ -35,6 +37,7 @@ import { NestedAppAuthController } from "../controllers/NestedAppAuthController.
 import { NestedAppOperatingContext } from "../operatingcontext/NestedAppOperatingContext.js";
 import { InitializeApplicationRequest } from "../request/InitializeApplicationRequest.js";
 import { EventType } from "../event/EventType.js";
+import { createNewGuid } from "../crypto/BrowserCrypto.js";
 
 /**
  * The PublicClientApplication class is the object exposed by the library to perform authentication and authorization functions in Single Page Applications
@@ -190,20 +193,6 @@ export class PublicClientApplication implements IPublicClientApplication {
         return this.controller.removePerformanceCallback(callbackId);
     }
 
-    /**
-     * Adds event listener that emits an event when a user account is added or removed from localstorage in a different browser tab or window
-     */
-    enableAccountStorageEvents(): void {
-        this.controller.enableAccountStorageEvents();
-    }
-
-    /**
-     * Removes event listener that emits an event when a user account is added or removed from localstorage in a different browser tab or window
-     */
-    disableAccountStorageEvents(): void {
-        this.controller.disableAccountStorageEvents();
-    }
-
     /**
      * Returns the first account found in the cache that matches the account filter passed in.
      * @param accountFilter
@@ -213,43 +202,6 @@ export class PublicClientApplication implements IPublicClientApplication {
         return this.controller.getAccount(accountFilter);
     }
 
-    /**
-     * Returns the signed in account matching homeAccountId.
-     * (the account object is created at the time of successful login)
-     * or null when no matching account is found
-     * @param homeAccountId
-     * @returns The account object stored in MSAL
-     * @deprecated - Use getAccount instead
-     */
-    getAccountByHomeId(homeAccountId: string): AccountInfo | null {
-        return this.controller.getAccountByHomeId(homeAccountId);
-    }
-
-    /**
-     * Returns the signed in account matching localAccountId.
-     * (the account object is created at the time of successful login)
-     * or null when no matching account is found
-     * @param localAccountId
-     * @returns The account object stored in MSAL
-     * @deprecated - Use getAccount instead
-     */
-    getAccountByLocalId(localId: string): AccountInfo | null {
-        return this.controller.getAccountByLocalId(localId);
-    }
-
-    /**
-     * Returns the signed in account matching username.
-     * (the account object is created at the time of successful login)
-     * or null when no matching account is found.
-     * This API is provided for convenience but getAccountById should be used for best reliability
-     * @param userName
-     * @returns The account object stored in MSAL
-     * @deprecated - Use getAccount instead
-     */
-    getAccountByUsername(userName: string): AccountInfo | null {
-        return this.controller.getAccountByUsername(userName);
-    }
-
     /**
      * Returns all the accounts in the cache that match the optional filter. If no filter is provided, all accounts are returned.
      * @param accountFilter - (Optional) filter to narrow down the accounts returned
@@ -264,12 +216,13 @@ export class PublicClientApplication implements IPublicClientApplication {
      * has loaded during redirect flows. This should be invoked on all page loads involved in redirect
      * auth flows.
      * @param hash Hash to process. Defaults to the current value of window.location.hash. Only needs to be provided explicitly if the response to be handled is not contained in the current value.
+     * @param options Object containing optional configuration for redirect promise handling.
      * @returns Token response or null. If the return value is null, then no auth redirect was detected.
      */
     handleRedirectPromise(
-        hash?: string | undefined
+        options?: HandleRedirectPromiseOptions
     ): Promise<AuthenticationResult | null> {
-        return this.controller.handleRedirectPromise(hash);
+        return this.controller.handleRedirectPromise(options);
     }
 
     /**
@@ -298,15 +251,6 @@ export class PublicClientApplication implements IPublicClientApplication {
         return this.controller.loginRedirect(request);
     }
 
-    /**
-     * Deprecated logout function. Use logoutRedirect or logoutPopup instead
-     * @param logoutRequest
-     * @deprecated
-     */
-    logout(logoutRequest?: EndSessionRequest): Promise<void> {
-        return this.controller.logout(logoutRequest);
-    }
-
     /**
      * Use to log out the current user, and redirect the user to the postLogoutRedirectUri.
      * Default behaviour is to redirect the user to `window.location.href`.
@@ -343,13 +287,6 @@ export class PublicClientApplication implements IPublicClientApplication {
         return this.controller.ssoSilent(request);
     }
 
-    /**
-     * Gets the token cache for the application.
-     */
-    getTokenCache(): ITokenCache {
-        return this.controller.getTokenCache();
-    }
-
     /**
      * Returns the logger instance
      */
@@ -442,8 +379,9 @@ export class PublicClientApplication implements IPublicClientApplication {
 export async function createNestablePublicClientApplication(
     configuration: Configuration
 ): Promise<IPublicClientApplication> {
+    const correlationId = createNewGuid();
     const nestedAppAuth = new NestedAppOperatingContext(configuration);
-    await nestedAppAuth.initialize();
+    await nestedAppAuth.initialize(correlationId);
 
     if (nestedAppAuth.isAvailable()) {
         const controller = new NestedAppAuthController(nestedAppAuth);
@@ -451,7 +389,7 @@ export async function createNestablePublicClientApplication(
             configuration,
             controller
         );
-        await nestablePCA.initialize();
+        await nestablePCA.initialize({ correlationId });
         return nestablePCA;
     }
 

package/src/app/PublicClientNext.ts

@@ -3,7 +3,6 @@
  * Licensed under the MIT License.
  */
 
-import { ITokenCache } from "../cache/ITokenCache.js";
 import { INavigationClient } from "../navigation/INavigationClient.js";
 import { AuthorizationCodeRequest } from "../request/AuthorizationCodeRequest.js";
 import { PopupRequest } from "../request/PopupRequest.js";
@@ -11,7 +10,10 @@ import { RedirectRequest } from "../request/RedirectRequest.js";
 import { SilentRequest } from "../request/SilentRequest.js";
 import { WrapperSKU } from "../utils/BrowserConstants.js";
 import { IPublicClientApplication } from "./IPublicClientApplication.js";
-import { IController } from "../controllers/IController.js";
+import {
+    HandleRedirectPromiseOptions,
+    IController,
+} from "../controllers/IController.js";
 import {
     PerformanceCallbackFunction,
     AccountInfo,
@@ -212,20 +214,6 @@ export class PublicClientNext implements IPublicClientApplication {
         return this.controller.removePerformanceCallback(callbackId);
     }
 
-    /**
-     * Adds event listener that emits an event when a user account is added or removed from localstorage in a different browser tab or window
-     */
-    enableAccountStorageEvents(): void {
-        this.controller.enableAccountStorageEvents();
-    }
-
-    /**
-     * Removes event listener that emits an event when a user account is added or removed from localstorage in a different browser tab or window
-     */
-    disableAccountStorageEvents(): void {
-        this.controller.disableAccountStorageEvents();
-    }
-
     /**
      * Returns the first account found in the cache that matches the account filter passed in.
      * @param accountFilter
@@ -235,43 +223,6 @@ export class PublicClientNext implements IPublicClientApplication {
         return this.controller.getAccount(accountFilter);
     }
 
-    /**
-     * Returns the signed in account matching homeAccountId.
-     * (the account object is created at the time of successful login)
-     * or null when no matching account is found
-     * @param homeAccountId
-     * @returns The account object stored in MSAL
-     * @deprecated - Use getAccount instead
-     */
-    getAccountByHomeId(homeAccountId: string): AccountInfo | null {
-        return this.controller.getAccountByHomeId(homeAccountId);
-    }
-
-    /**
-     * Returns the signed in account matching localAccountId.
-     * (the account object is created at the time of successful login)
-     * or null when no matching account is found
-     * @param localAccountId
-     * @returns The account object stored in MSAL
-     * @deprecated - Use getAccount instead
-     */
-    getAccountByLocalId(localId: string): AccountInfo | null {
-        return this.controller.getAccountByLocalId(localId);
-    }
-
-    /**
-     * Returns the signed in account matching username.
-     * (the account object is created at the time of successful login)
-     * or null when no matching account is found.
-     * This API is provided for convenience but getAccountById should be used for best reliability
-     * @param userName
-     * @returns The account object stored in MSAL
-     * @deprecated - Use getAccount instead
-     */
-    getAccountByUsername(userName: string): AccountInfo | null {
-        return this.controller.getAccountByUsername(userName);
-    }
-
     /**
      * Returns all the accounts in the cache that match the optional filter. If no filter is provided, all accounts are returned.
      * @param accountFilter - (Optional) filter to narrow down the accounts returned
@@ -289,9 +240,9 @@ export class PublicClientNext implements IPublicClientApplication {
      * @returns Token response or null. If the return value is null, then no auth redirect was detected.
      */
     handleRedirectPromise(
-        hash?: string | undefined
+        options?: HandleRedirectPromiseOptions
     ): Promise<AuthenticationResult | null> {
-        return this.controller.handleRedirectPromise(hash);
+        return this.controller.handleRedirectPromise(options);
     }
 
     /**
@@ -320,15 +271,6 @@ export class PublicClientNext implements IPublicClientApplication {
         return this.controller.loginRedirect(request);
     }
 
-    /**
-     * Deprecated logout function. Use logoutRedirect or logoutPopup instead
-     * @param logoutRequest
-     * @deprecated
-     */
-    logout(logoutRequest?: EndSessionRequest): Promise<void> {
-        return this.controller.logout(logoutRequest);
-    }
-
     /**
      * Use to log out the current user, and redirect the user to the postLogoutRedirectUri.
      * Default behaviour is to redirect the user to `window.location.href`.
@@ -365,13 +307,6 @@ export class PublicClientNext implements IPublicClientApplication {
         return this.controller.ssoSilent(request);
     }
 
-    /**
-     * Gets the token cache for the application.
-     */
-    getTokenCache(): ITokenCache {
-        return this.controller.getTokenCache();
-    }
-
     /**
      * Returns the logger instance
      */

package/src/broker/nativeBroker/PlatformAuthDOMHandler.ts

@@ -45,7 +45,10 @@ export class PlatformAuthDOMHandler implements IPlatformAuthHandler {
         performanceClient: IPerformanceClient,
         correlationId: string
     ): Promise<PlatformAuthDOMHandler | undefined> {
-        logger.trace("PlatformAuthDOMHandler: createProvider called");
+        logger.trace(
+            "PlatformAuthDOMHandler: createProvider called",
+            correlationId
+        );
 
         // @ts-ignore
         if (window.navigator?.platformAuthentication) {
@@ -59,7 +62,10 @@ export class PlatformAuthDOMHandler implements IPlatformAuthHandler {
                     PlatformAuthConstants.PLATFORM_DOM_APIS
                 )
             ) {
-                logger.trace("Platform auth api available in DOM");
+                logger.trace(
+                    "Platform auth api available in DOM",
+                    correlationId
+                );
                 return new PlatformAuthDOMHandler(
                     logger,
                     performanceClient,
@@ -95,7 +101,8 @@ export class PlatformAuthDOMHandler implements IPlatformAuthHandler {
         request: PlatformAuthRequest
     ): Promise<PlatformAuthResponse> {
         this.logger.trace(
-            this.platformAuthType + " - Sending request to browser DOM API"
+            `'${this.platformAuthType}' - Sending request to browser DOM API`,
+            request.correlationId
         );
 
         try {
@@ -106,10 +113,14 @@ export class PlatformAuthDOMHandler implements IPlatformAuthHandler {
                 await window.navigator.platformAuthentication.executeGetToken(
                     platformDOMRequest
                 );
-            return this.validatePlatformBrokerResponse(response);
+            return this.validatePlatformBrokerResponse(
+                response,
+                request.correlationId
+            );
         } catch (e) {
             this.logger.error(
-                this.platformAuthType + " - executeGetToken DOM API error"
+                `'${this.platformAuthType}' - executeGetToken DOM API error`,
+                request.correlationId
             );
             throw e;
         }
@@ -119,7 +130,8 @@ export class PlatformAuthDOMHandler implements IPlatformAuthHandler {
         request: PlatformAuthRequest
     ): PlatformDOMTokenRequest {
         this.logger.trace(
-            this.platformAuthType + " - initializeNativeDOMRequest called"
+            `'${this.platformAuthType}' - initializeNativeDOMRequest called`,
+            request.correlationId
         );
 
         const {
@@ -158,7 +170,8 @@ export class PlatformAuthDOMHandler implements IPlatformAuthHandler {
     }
 
     private validatePlatformBrokerResponse(
-        response: object
+        response: object,
+        correlationId: string
     ): PlatformAuthResponse {
         if (response.hasOwnProperty("isSuccess")) {
             if (
@@ -170,11 +183,12 @@ export class PlatformAuthDOMHandler implements IPlatformAuthHandler {
                 response.hasOwnProperty("expiresIn")
             ) {
                 this.logger.trace(
-                    this.platformAuthType +
-                        " - platform broker returned successful and valid response"
+                    `'${this.platformAuthType}' - platform broker returned successful and valid response`,
+                    correlationId
                 );
                 return this.convertToPlatformBrokerResponse(
-                    response as PlatformDOMTokenResponse
+                    response as PlatformDOMTokenResponse,
+                    correlationId
                 );
             } else if (response.hasOwnProperty("error")) {
                 const errorResponse = response as PlatformDOMTokenResponse;
@@ -184,8 +198,8 @@ export class PlatformAuthDOMHandler implements IPlatformAuthHandler {
                     errorResponse.error.code
                 ) {
                     this.logger.trace(
-                        this.platformAuthType +
-                            " - platform broker returned error response"
+                        `'${this.platformAuthType}' - platform broker returned error response`,
+                        correlationId
                     );
                     throw createNativeAuthError(
                         errorResponse.error.code,
@@ -207,10 +221,12 @@ export class PlatformAuthDOMHandler implements IPlatformAuthHandler {
     }
 
     private convertToPlatformBrokerResponse(
-        response: PlatformDOMTokenResponse
+        response: PlatformDOMTokenResponse,
+        correlationId: string
     ): PlatformAuthResponse {
         this.logger.trace(
-            this.platformAuthType + " - convertToNativeResponse called"
+            `'${this.platformAuthType}' - convertToNativeResponse called`,
+            correlationId
         );
         const nativeResponse: PlatformAuthResponse = {
             access_token: response.accessToken,

package/src/broker/nativeBroker/PlatformAuthExtensionHandler.ts

@@ -13,9 +13,9 @@ import {
     createAuthError,
     AuthErrorCodes,
     InProgressPerformanceEvent,
-    PerformanceEvents,
     IPerformanceClient,
 } from "@azure/msal-common/browser";
+import * as BrowserPerformanceEvents from "../../telemetry/BrowserPerformanceEvents.js";
 import {
     NativeExtensionRequest,
     NativeExtensionRequestBody,
@@ -29,6 +29,7 @@ import {
 import { createNewGuid } from "../../crypto/BrowserCrypto.js";
 import { PlatformAuthResponse } from "./PlatformAuthResponse.js";
 import { IPlatformAuthHandler } from "./IPlatformAuthHandler.js";
+import { createGuid } from "../../utils/BrowserUtils.js";
 
 type ResponseResolvers<T> = {
     resolve: (value: T | PromiseLike<T>) => void;
@@ -66,7 +67,7 @@ export class PlatformAuthExtensionHandler implements IPlatformAuthHandler {
         this.windowListener = this.onWindowMessage.bind(this); // Window event callback doesn't have access to 'this' unless it's bound
         this.performanceClient = performanceClient;
         this.handshakeEvent = performanceClient.startMeasurement(
-            PerformanceEvents.NativeMessageHandlerHandshake
+            BrowserPerformanceEvents.NativeMessageHandlerHandshake
         );
         this.platformAuthType =
             PlatformAuthConstants.PLATFORM_EXTENSION_PROVIDER;
@@ -79,7 +80,10 @@ export class PlatformAuthExtensionHandler implements IPlatformAuthHandler {
     async sendMessage(
         request: PlatformAuthRequest
     ): Promise<PlatformAuthResponse> {
-        this.logger.trace(this.platformAuthType + " - sendMessage called.");
+        this.logger.trace(
+            `'${this.platformAuthType}' - sendMessage called.`,
+            request.correlationId
+        );
 
         // fall back to native calls
         const messageBody: NativeExtensionRequestBody = {
@@ -95,13 +99,16 @@ export class PlatformAuthExtensionHandler implements IPlatformAuthHandler {
         };
 
         this.logger.trace(
-            this.platformAuthType + " - Sending request to browser extension"
+            `'${this.platformAuthType}' - Sending request to browser extension`,
+            request.correlationId
         );
         this.logger.tracePii(
-            this.platformAuthType +
-                ` - Sending request to browser extension: ${JSON.stringify(
-                    req
-                )}`
+            `'${
+                this.platformAuthType
+            }' - Sending request to browser extension: '${JSON.stringify(
+                req
+            )}'`,
+            request.correlationId
         );
         this.messageChannel.port1.postMessage(req);
 
@@ -125,9 +132,13 @@ export class PlatformAuthExtensionHandler implements IPlatformAuthHandler {
     static async createProvider(
         logger: Logger,
         handshakeTimeoutMs: number,
-        performanceClient: IPerformanceClient
+        performanceClient: IPerformanceClient,
+        correlationId: string
     ): Promise<PlatformAuthExtensionHandler> {
-        logger.trace("PlatformAuthExtensionHandler - createProvider called.");
+        logger.trace(
+            "PlatformAuthExtensionHandler - createProvider called.",
+            correlationId
+        );
 
         try {
             const preferredProvider = new PlatformAuthExtensionHandler(
@@ -136,7 +147,7 @@ export class PlatformAuthExtensionHandler implements IPlatformAuthHandler {
                 performanceClient,
                 PlatformAuthConstants.PREFERRED_EXTENSION_ID
             );
-            await preferredProvider.sendHandshakeRequest();
+            await preferredProvider.sendHandshakeRequest(correlationId);
             return preferredProvider;
         } catch (e) {
             // If preferred extension fails for whatever reason, fallback to using any installed extension
@@ -145,7 +156,7 @@ export class PlatformAuthExtensionHandler implements IPlatformAuthHandler {
                 handshakeTimeoutMs,
                 performanceClient
             );
-            await backupProvider.sendHandshakeRequest();
+            await backupProvider.sendHandshakeRequest(correlationId);
             return backupProvider;
         }
     }
@@ -153,9 +164,10 @@ export class PlatformAuthExtensionHandler implements IPlatformAuthHandler {
     /**
      * Send handshake request helper.
      */
-    private async sendHandshakeRequest(): Promise<void> {
+    private async sendHandshakeRequest(correlationId: string): Promise<void> {
         this.logger.trace(
-            this.platformAuthType + " - sendHandshakeRequest called."
+            `'${this.platformAuthType}' - sendHandshakeRequest called.`,
+            correlationId
         );
         // Register this event listener before sending handshake
         window.addEventListener("message", this.windowListener, false); // false is important, because content script message processing should work first
@@ -212,7 +224,11 @@ export class PlatformAuthExtensionHandler implements IPlatformAuthHandler {
      * @param event
      */
     private onWindowMessage(event: MessageEvent): void {
-        this.logger.trace(this.platformAuthType + " - onWindowMessage called");
+        const correlationId = createGuid();
+        this.logger.trace(
+            `'${this.platformAuthType}' - onWindowMessage called`,
+            correlationId
+        );
         // We only accept messages from ourselves
         if (event.source !== window) {
             return;
@@ -241,8 +257,8 @@ export class PlatformAuthExtensionHandler implements IPlatformAuthHandler {
              */
             if (!handshakeResolver) {
                 this.logger.trace(
-                    this.platformAuthType +
-                        `.onWindowMessage - resolver can't be found for request ${request.responseId}`
+                    `'${this.platformAuthType}'.onWindowMessage - resolver can't be found for request '${request.responseId}'`,
+                    correlationId
                 );
                 return;
             }
@@ -251,7 +267,8 @@ export class PlatformAuthExtensionHandler implements IPlatformAuthHandler {
             this.logger.verbose(
                 request.extensionId
                     ? `Extension with id: ${request.extensionId} not installed`
-                    : "No extension installed"
+                    : "No extension installed",
+                correlationId
             );
             clearTimeout(this.timeoutId);
             this.messageChannel.port1.close();
@@ -274,8 +291,10 @@ export class PlatformAuthExtensionHandler implements IPlatformAuthHandler {
      * @param event
      */
     private onChannelMessage(event: MessageEvent): void {
+        const correlationId = createGuid();
         this.logger.trace(
-            this.platformAuthType + " - onChannelMessage called."
+            `'${this.platformAuthType}' - onChannelMessage called.`,
+            correlationId
         );
         const request = event.data;
 
@@ -293,14 +312,16 @@ export class PlatformAuthExtensionHandler implements IPlatformAuthHandler {
                 }
                 const response = request.body.response;
                 this.logger.trace(
-                    this.platformAuthType +
-                        " - Received response from browser extension"
+                    `'${this.platformAuthType}' - Received response from browser extension`,
+                    correlationId
                 );
                 this.logger.tracePii(
-                    this.platformAuthType +
-                        ` - Received response from browser extension: ${JSON.stringify(
-                            response
-                        )}`
+                    `'${
+                        this.platformAuthType
+                    }' - Received response from browser extension: '${JSON.stringify(
+                        response
+                    )}'`,
+                    correlationId
                 );
                 if (response.status !== "Success") {
                     resolver.reject(
@@ -335,8 +356,8 @@ export class PlatformAuthExtensionHandler implements IPlatformAuthHandler {
             } else if (method === NativeExtensionMethod.HandshakeResponse) {
                 if (!handshakeResolver) {
                     this.logger.trace(
-                        this.platformAuthType +
-                            `.onChannelMessage - resolver can't be found for request ${request.responseId}`
+                        `'${this.platformAuthType}'.onChannelMessage - resolver can't be found for request '${request.responseId}'`,
+                        correlationId
                     );
                     return;
                 }
@@ -349,8 +370,8 @@ export class PlatformAuthExtensionHandler implements IPlatformAuthHandler {
                 this.extensionId = request.extensionId;
                 this.extensionVersion = request.body.version;
                 this.logger.verbose(
-                    this.platformAuthType +
-                        ` - Received HandshakeResponse from extension: ${this.extensionId}`
+                    `'${this.platformAuthType}' - Received HandshakeResponse from extension: '${this.extensionId}'`,
+                    correlationId
                 );
                 this.handshakeEvent.end({
                     extensionInstalled: true,
@@ -362,11 +383,15 @@ export class PlatformAuthExtensionHandler implements IPlatformAuthHandler {
             }
             // Do nothing if method is not Response or HandshakeResponse
         } catch (err) {
-            this.logger.error("Error parsing response from WAM Extension");
+            this.logger.error(
+                "Error parsing response from WAM Extension",
+                correlationId
+            );
             this.logger.errorPii(
-                `Error parsing response from WAM Extension: ${err as string}`
+                `Error parsing response from WAM Extension: '${err as string}'`,
+                correlationId
             );
-            this.logger.errorPii(`Unable to parse ${event}`);
+            this.logger.errorPii(`Unable to parse '${event}'`, correlationId);
 
             if (resolver) {
                 resolver.reject(err as AuthError);