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

package/src/cache/IAsyncStorage.ts

@@ -7,30 +7,35 @@ export interface IAsyncStorage<T> {
     /**
      * Get the item from the asynchronous storage object matching the given key.
      * @param key
+     * @param correlationId
      */
-    getItem(key: string): Promise<T | null>;
+    getItem(key: string, correlationId: string): Promise<T | null>;
 
     /**
      * Sets the item in the asynchronous storage object with the given key.
      * @param key
      * @param value
+     * @param correlationId
      */
-    setItem(key: string, value: T): Promise<void>;
+    setItem(key: string, value: T, correlationId: string): Promise<void>;
 
     /**
      * Removes the item in the asynchronous storage object matching the given key.
      * @param key
+     * @param correlationId
      */
-    removeItem(key: string): Promise<void>;
+    removeItem(key: string, correlationId: string): Promise<void>;
 
     /**
      * Get all the keys from the asynchronous storage object as an iterable array of strings.
+     * @param correlationId
      */
-    getKeys(): Promise<string[]>;
+    getKeys(correlationId: string): Promise<string[]>;
 
     /**
      * Returns true or false if the given key is present in the cache.
      * @param key
+     * @param correlationId
      */
-    containsKey(key: string): Promise<boolean>;
+    containsKey(key: string, correlationId: string): Promise<boolean>;
 }

package/src/cache/LocalStorage.ts

@@ -7,10 +7,11 @@ import {
     TokenKeys,
     IPerformanceClient,
     invokeAsync,
-    PerformanceEvents,
     Logger,
     invoke,
 } from "@azure/msal-common/browser";
+import * as BrowserPerformanceEvents from "../telemetry/BrowserPerformanceEvents.js";
+import * as BrowserRootPerformanceEvents from "../telemetry/BrowserRootPerformanceEvents.js";
 import {
     createNewGuid,
     decrypt,
@@ -83,7 +84,7 @@ export class LocalStorage implements IWindowStorage<string> {
             // Encryption key already exists, import
             const baseKey = invoke(
                 base64DecToArr,
-                PerformanceEvents.Base64Decode,
+                BrowserPerformanceEvents.Base64Decode,
                 this.logger,
                 this.performanceClient,
                 correlationId
@@ -92,7 +93,7 @@ export class LocalStorage implements IWindowStorage<string> {
                 id: parsedCookie.id,
                 key: await invokeAsync(
                     generateHKDF,
-                    PerformanceEvents.GenerateHKDF,
+                    BrowserPerformanceEvents.GenerateHKDF,
                     this.logger,
                     this.performanceClient,
                     correlationId
@@ -103,14 +104,14 @@ export class LocalStorage implements IWindowStorage<string> {
             const id = createNewGuid();
             const baseKey = await invokeAsync(
                 generateBaseKey,
-                PerformanceEvents.GenerateBaseKey,
+                BrowserPerformanceEvents.GenerateBaseKey,
                 this.logger,
                 this.performanceClient,
                 correlationId
             )();
             const keyStr = invoke(
                 urlEncodeArr,
-                PerformanceEvents.UrlEncodeArr,
+                BrowserPerformanceEvents.UrlEncodeArr,
                 this.logger,
                 this.performanceClient,
                 correlationId
@@ -119,7 +120,7 @@ export class LocalStorage implements IWindowStorage<string> {
                 id: id,
                 key: await invokeAsync(
                     generateHKDF,
-                    PerformanceEvents.GenerateHKDF,
+                    BrowserPerformanceEvents.GenerateHKDF,
                     this.logger,
                     this.performanceClient,
                     correlationId
@@ -142,14 +143,16 @@ export class LocalStorage implements IWindowStorage<string> {
 
         await invokeAsync(
             this.importExistingCache.bind(this),
-            PerformanceEvents.ImportExistingCache,
+            BrowserPerformanceEvents.ImportExistingCache,
             this.logger,
             this.performanceClient,
             correlationId
         )(correlationId);
 
         // Register listener for cache updates in other tabs
-        this.broadcast.addEventListener("message", this.updateCache.bind(this));
+        this.broadcast.addEventListener("message", (event: MessageEvent) => {
+            this.updateCache(event, correlationId);
+        });
 
         this.initialized = true;
     }
@@ -189,7 +192,7 @@ export class LocalStorage implements IWindowStorage<string> {
 
         const decryptedData = await invokeAsync(
             decrypt,
-            PerformanceEvents.Decrypt,
+            BrowserPerformanceEvents.Decrypt,
             this.logger,
             this.performanceClient,
             correlationId
@@ -233,7 +236,7 @@ export class LocalStorage implements IWindowStorage<string> {
 
         const { data, nonce } = await invokeAsync(
             encrypt,
-            PerformanceEvents.Encrypt,
+            BrowserPerformanceEvents.Encrypt,
             this.logger,
             this.performanceClient,
             correlationId
@@ -396,7 +399,7 @@ export class LocalStorage implements IWindowStorage<string> {
 
         return invokeAsync(
             decrypt,
-            PerformanceEvents.Decrypt,
+            BrowserPerformanceEvents.Decrypt,
             this.logger,
             this.performanceClient,
             correlationId
@@ -453,23 +456,27 @@ export class LocalStorage implements IWindowStorage<string> {
         return context;
     }
 
-    private updateCache(event: MessageEvent): void {
-        this.logger.trace("Updating internal cache from broadcast event");
+    private updateCache(event: MessageEvent, correlationId: string): void {
+        this.logger.trace(
+            "Updating internal cache from broadcast event",
+            correlationId
+        );
         const perfMeasurement = this.performanceClient.startMeasurement(
-            PerformanceEvents.LocalStorageUpdated
+            BrowserRootPerformanceEvents.LocalStorageUpdated
         );
         perfMeasurement.add({ isBackground: true });
 
         const { key, value, context } = event.data;
         if (!key) {
-            this.logger.error("Broadcast event missing key");
+            this.logger.error("Broadcast event missing key", correlationId);
             perfMeasurement.end({ success: false, errorCode: "noKey" });
             return;
         }
 
         if (context && context !== this.clientId) {
             this.logger.trace(
-                `Ignoring broadcast event from clientId: ${context}`
+                `Ignoring broadcast event from clientId: '${context}'`,
+                correlationId
             );
             perfMeasurement.end({
                 success: false,
@@ -480,10 +487,16 @@ export class LocalStorage implements IWindowStorage<string> {
 
         if (!value) {
             this.memoryStorage.removeItem(key);
-            this.logger.verbose("Removed item from internal cache");
+            this.logger.verbose(
+                "Removed item from internal cache",
+                correlationId
+            );
         } else {
             this.memoryStorage.setItem(key, value);
-            this.logger.verbose("Updated item in internal cache");
+            this.logger.verbose(
+                "Updated item in internal cache",
+                correlationId
+            );
         }
         perfMeasurement.end({ success: true });
     }