@azure/msal-browser 3.0.0-alpha.1 → 3.0.0-alpha.2

package/dist/telemetry/BrowserPerformanceClient.js

@@ -1,133 +1,133 @@
-/*! @azure/msal-browser v3.0.0-alpha.1 2023-05-08 */
+/*! @azure/msal-browser v3.0.0-alpha.2 2023-05-17 */
 'use strict';
 import { PerformanceClient } from '@azure/msal-common';
 import { BrowserCrypto } from '../crypto/BrowserCrypto.js';
 import { GuidGenerator } from '../crypto/GuidGenerator.js';
 import { BrowserPerformanceMeasurement } from './BrowserPerformanceMeasurement.js';
 
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-class BrowserPerformanceClient extends PerformanceClient {
-    constructor(clientId, authority, logger, libraryName, libraryVersion, applicationTelemetry, cryptoOptions) {
-        super(clientId, authority, logger, libraryName, libraryVersion, applicationTelemetry);
-        this.browserCrypto = new BrowserCrypto(this.logger, cryptoOptions);
-        this.guidGenerator = new GuidGenerator(this.browserCrypto);
-    }
-    startPerformanceMeasurement(measureName, correlationId) {
-        return new BrowserPerformanceMeasurement(measureName, correlationId);
-    }
-    generateId() {
-        return this.guidGenerator.generateGuid();
-    }
-    getPageVisibility() {
-        return document.visibilityState?.toString() || null;
-    }
-    deleteIncompleteSubMeasurements(inProgressEvent) {
-        const rootEvent = this.eventsByCorrelationId.get(inProgressEvent.event.correlationId);
-        const isRootEvent = rootEvent && rootEvent.eventId === inProgressEvent.event.eventId;
-        const incompleteMeasurements = [];
-        if (isRootEvent && rootEvent?.incompleteSubMeasurements) {
-            rootEvent.incompleteSubMeasurements.forEach((subMeasurement) => {
-                incompleteMeasurements.push({ ...subMeasurement });
-            });
-        }
-        // Clean up remaining marks for incomplete sub-measurements
-        if (incompleteMeasurements.length > 0) {
-            BrowserPerformanceMeasurement.flushMeasurements(inProgressEvent.event.correlationId, incompleteMeasurements);
-        }
-    }
-    supportsBrowserPerformanceNow() {
-        return (typeof window !== "undefined" &&
-            typeof window.performance !== "undefined" &&
-            typeof window.performance.now === "function");
-    }
-    /**
-     * Starts measuring performance for a given operation. Returns a function that should be used to end the measurement.
-     * Also captures browser page visibilityState.
-     *
-     * @param {PerformanceEvents} measureName
-     * @param {?string} [correlationId]
-     * @returns {((event?: Partial<PerformanceEvent>) => PerformanceEvent| null)}
-     */
-    startMeasurement(measureName, correlationId) {
-        // Capture page visibilityState and then invoke start/end measurement
-        const startPageVisibility = this.getPageVisibility();
-        const inProgressEvent = super.startMeasurement(measureName, correlationId);
-        return {
-            ...inProgressEvent,
-            endMeasurement: (event) => {
-                const res = inProgressEvent.endMeasurement({
-                    startPageVisibility,
-                    endPageVisibility: this.getPageVisibility(),
-                    ...event,
-                });
-                this.deleteIncompleteSubMeasurements(inProgressEvent);
-                return res;
-            },
-            discardMeasurement: () => {
-                inProgressEvent.discardMeasurement();
-                this.deleteIncompleteSubMeasurements(inProgressEvent);
-                inProgressEvent.measurement.flushMeasurement();
-            },
-        };
-    }
-    /**
-     * Adds pre-queue time to preQueueTimeByCorrelationId map.
-     * @param {PerformanceEvents} eventName
-     * @param {?string} correlationId
-     * @returns
-     */
-    setPreQueueTime(eventName, correlationId) {
-        if (!this.supportsBrowserPerformanceNow()) {
-            this.logger.trace(`BrowserPerformanceClient: window performance API not available, unable to set telemetry queue time for ${eventName}`);
-            return;
-        }
-        if (!correlationId) {
-            this.logger.trace(`BrowserPerformanceClient: correlationId for ${eventName} not provided, unable to set telemetry queue time`);
-            return;
-        }
-        const preQueueEvent = this.preQueueTimeByCorrelationId.get(correlationId);
-        /**
-         * Manually complete queue measurement if there is an incomplete pre-queue event.
-         * Incomplete pre-queue events are instrumentation bugs that should be fixed.
-         */
-        if (preQueueEvent) {
-            this.logger.trace(`BrowserPerformanceClient: Incomplete pre-queue ${preQueueEvent.name} found`, correlationId);
-            this.addQueueMeasurement(preQueueEvent.name, correlationId, undefined, true);
-        }
-        this.preQueueTimeByCorrelationId.set(correlationId, {
-            name: eventName,
-            time: window.performance.now(),
-        });
-    }
-    /**
-     * Calculates and adds queue time measurement for given performance event.
-     *
-     * @param {PerformanceEvents} eventName
-     * @param {?string} correlationId
-     * @param {?number} queueTime
-     * @param {?boolean} manuallyCompleted - indicator for manually completed queue measurements
-     * @returns
-     */
-    addQueueMeasurement(eventName, correlationId, queueTime, manuallyCompleted) {
-        if (!this.supportsBrowserPerformanceNow()) {
-            this.logger.trace(`BrowserPerformanceClient: window performance API not available, unable to add queue measurement for ${eventName}`);
-            return;
-        }
-        if (!correlationId) {
-            this.logger.trace(`BrowserPerformanceClient: correlationId for ${eventName} not provided, unable to add queue measurement`);
-            return;
-        }
-        const preQueueTime = super.getPreQueueTime(eventName, correlationId);
-        if (!preQueueTime) {
-            return;
-        }
-        const currentTime = window.performance.now();
-        const resQueueTime = queueTime || super.calculateQueuedTime(preQueueTime, currentTime);
-        return super.addQueueMeasurement(eventName, correlationId, resQueueTime, manuallyCompleted);
-    }
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+class BrowserPerformanceClient extends PerformanceClient {
+    constructor(clientId, authority, logger, libraryName, libraryVersion, applicationTelemetry, cryptoOptions) {
+        super(clientId, authority, logger, libraryName, libraryVersion, applicationTelemetry);
+        this.browserCrypto = new BrowserCrypto(this.logger, cryptoOptions);
+        this.guidGenerator = new GuidGenerator(this.browserCrypto);
+    }
+    startPerformanceMeasurement(measureName, correlationId) {
+        return new BrowserPerformanceMeasurement(measureName, correlationId);
+    }
+    generateId() {
+        return this.guidGenerator.generateGuid();
+    }
+    getPageVisibility() {
+        return document.visibilityState?.toString() || null;
+    }
+    deleteIncompleteSubMeasurements(inProgressEvent) {
+        const rootEvent = this.eventsByCorrelationId.get(inProgressEvent.event.correlationId);
+        const isRootEvent = rootEvent && rootEvent.eventId === inProgressEvent.event.eventId;
+        const incompleteMeasurements = [];
+        if (isRootEvent && rootEvent?.incompleteSubMeasurements) {
+            rootEvent.incompleteSubMeasurements.forEach((subMeasurement) => {
+                incompleteMeasurements.push({ ...subMeasurement });
+            });
+        }
+        // Clean up remaining marks for incomplete sub-measurements
+        if (incompleteMeasurements.length > 0) {
+            BrowserPerformanceMeasurement.flushMeasurements(inProgressEvent.event.correlationId, incompleteMeasurements);
+        }
+    }
+    supportsBrowserPerformanceNow() {
+        return (typeof window !== "undefined" &&
+            typeof window.performance !== "undefined" &&
+            typeof window.performance.now === "function");
+    }
+    /**
+     * Starts measuring performance for a given operation. Returns a function that should be used to end the measurement.
+     * Also captures browser page visibilityState.
+     *
+     * @param {PerformanceEvents} measureName
+     * @param {?string} [correlationId]
+     * @returns {((event?: Partial<PerformanceEvent>) => PerformanceEvent| null)}
+     */
+    startMeasurement(measureName, correlationId) {
+        // Capture page visibilityState and then invoke start/end measurement
+        const startPageVisibility = this.getPageVisibility();
+        const inProgressEvent = super.startMeasurement(measureName, correlationId);
+        return {
+            ...inProgressEvent,
+            endMeasurement: (event) => {
+                const res = inProgressEvent.endMeasurement({
+                    startPageVisibility,
+                    endPageVisibility: this.getPageVisibility(),
+                    ...event,
+                });
+                this.deleteIncompleteSubMeasurements(inProgressEvent);
+                return res;
+            },
+            discardMeasurement: () => {
+                inProgressEvent.discardMeasurement();
+                this.deleteIncompleteSubMeasurements(inProgressEvent);
+                inProgressEvent.measurement.flushMeasurement();
+            },
+        };
+    }
+    /**
+     * Adds pre-queue time to preQueueTimeByCorrelationId map.
+     * @param {PerformanceEvents} eventName
+     * @param {?string} correlationId
+     * @returns
+     */
+    setPreQueueTime(eventName, correlationId) {
+        if (!this.supportsBrowserPerformanceNow()) {
+            this.logger.trace(`BrowserPerformanceClient: window performance API not available, unable to set telemetry queue time for ${eventName}`);
+            return;
+        }
+        if (!correlationId) {
+            this.logger.trace(`BrowserPerformanceClient: correlationId for ${eventName} not provided, unable to set telemetry queue time`);
+            return;
+        }
+        const preQueueEvent = this.preQueueTimeByCorrelationId.get(correlationId);
+        /**
+         * Manually complete queue measurement if there is an incomplete pre-queue event.
+         * Incomplete pre-queue events are instrumentation bugs that should be fixed.
+         */
+        if (preQueueEvent) {
+            this.logger.trace(`BrowserPerformanceClient: Incomplete pre-queue ${preQueueEvent.name} found`, correlationId);
+            this.addQueueMeasurement(preQueueEvent.name, correlationId, undefined, true);
+        }
+        this.preQueueTimeByCorrelationId.set(correlationId, {
+            name: eventName,
+            time: window.performance.now(),
+        });
+    }
+    /**
+     * Calculates and adds queue time measurement for given performance event.
+     *
+     * @param {PerformanceEvents} eventName
+     * @param {?string} correlationId
+     * @param {?number} queueTime
+     * @param {?boolean} manuallyCompleted - indicator for manually completed queue measurements
+     * @returns
+     */
+    addQueueMeasurement(eventName, correlationId, queueTime, manuallyCompleted) {
+        if (!this.supportsBrowserPerformanceNow()) {
+            this.logger.trace(`BrowserPerformanceClient: window performance API not available, unable to add queue measurement for ${eventName}`);
+            return;
+        }
+        if (!correlationId) {
+            this.logger.trace(`BrowserPerformanceClient: correlationId for ${eventName} not provided, unable to add queue measurement`);
+            return;
+        }
+        const preQueueTime = super.getPreQueueTime(eventName, correlationId);
+        if (!preQueueTime) {
+            return;
+        }
+        const currentTime = window.performance.now();
+        const resQueueTime = queueTime || super.calculateQueuedTime(preQueueTime, currentTime);
+        return super.addQueueMeasurement(eventName, correlationId, resQueueTime, manuallyCompleted);
+    }
 }
 
 export { BrowserPerformanceClient };

package/dist/telemetry/BrowserPerformanceMeasurement.d.ts

@@ -1,22 +1,22 @@
-import { IPerformanceMeasurement, SubMeasurement } from "@azure/msal-common";
-export declare class BrowserPerformanceMeasurement implements IPerformanceMeasurement {
-    private readonly measureName;
-    private readonly correlationId;
-    private readonly startMark;
-    private readonly endMark;
-    constructor(name: string, correlationId: string);
-    private static makeMeasureName;
-    private static makeStartMark;
-    private static makeEndMark;
-    static supportsBrowserPerformance(): boolean;
-    /**
-     * Flush browser marks and measurements.
-     * @param {string} correlationId
-     * @param {SubMeasurement} measurements
-     */
-    static flushMeasurements(correlationId: string, measurements: SubMeasurement[]): void;
-    startMeasurement(): void;
-    endMeasurement(): void;
-    flushMeasurement(): number | null;
-}
+import { IPerformanceMeasurement, SubMeasurement } from "@azure/msal-common";
+export declare class BrowserPerformanceMeasurement implements IPerformanceMeasurement {
+    private readonly measureName;
+    private readonly correlationId;
+    private readonly startMark;
+    private readonly endMark;
+    constructor(name: string, correlationId: string);
+    private static makeMeasureName;
+    private static makeStartMark;
+    private static makeEndMark;
+    static supportsBrowserPerformance(): boolean;
+    /**
+     * Flush browser marks and measurements.
+     * @param {string} correlationId
+     * @param {SubMeasurement} measurements
+     */
+    static flushMeasurements(correlationId: string, measurements: SubMeasurement[]): void;
+    startMeasurement(): void;
+    endMeasurement(): void;
+    flushMeasurement(): number | null;
+}
 //# sourceMappingURL=BrowserPerformanceMeasurement.d.ts.map

package/dist/telemetry/BrowserPerformanceMeasurement.js

@@ -1,96 +1,96 @@
-/*! @azure/msal-browser v3.0.0-alpha.1 2023-05-08 */
+/*! @azure/msal-browser v3.0.0-alpha.2 2023-05-17 */
 'use strict';
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-class BrowserPerformanceMeasurement {
-    constructor(name, correlationId) {
-        this.correlationId = correlationId;
-        this.measureName = BrowserPerformanceMeasurement.makeMeasureName(name, correlationId);
-        this.startMark = BrowserPerformanceMeasurement.makeStartMark(name, correlationId);
-        this.endMark = BrowserPerformanceMeasurement.makeEndMark(name, correlationId);
-    }
-    static makeMeasureName(name, correlationId) {
-        return `msal.measure.${name}.${correlationId}`;
-    }
-    static makeStartMark(name, correlationId) {
-        return `msal.start.${name}.${correlationId}`;
-    }
-    static makeEndMark(name, correlationId) {
-        return `msal.end.${name}.${correlationId}`;
-    }
-    static supportsBrowserPerformance() {
-        return (typeof window !== "undefined" &&
-            typeof window.performance !== "undefined" &&
-            typeof window.performance.mark === "function" &&
-            typeof window.performance.measure === "function" &&
-            typeof window.performance.clearMarks === "function" &&
-            typeof window.performance.clearMeasures === "function" &&
-            typeof window.performance.getEntriesByName === "function");
-    }
-    /**
-     * Flush browser marks and measurements.
-     * @param {string} correlationId
-     * @param {SubMeasurement} measurements
-     */
-    static flushMeasurements(correlationId, measurements) {
-        if (BrowserPerformanceMeasurement.supportsBrowserPerformance()) {
-            try {
-                measurements.forEach((measurement) => {
-                    const measureName = BrowserPerformanceMeasurement.makeMeasureName(measurement.name, correlationId);
-                    const entriesForMeasurement = window.performance.getEntriesByName(measureName, "measure");
-                    if (entriesForMeasurement.length > 0) {
-                        window.performance.clearMeasures(measureName);
-                        window.performance.clearMarks(BrowserPerformanceMeasurement.makeStartMark(measureName, correlationId));
-                        window.performance.clearMarks(BrowserPerformanceMeasurement.makeEndMark(measureName, correlationId));
-                    }
-                });
-            }
-            catch (e) {
-                // Silently catch and return null
-            }
-        }
-    }
-    startMeasurement() {
-        if (BrowserPerformanceMeasurement.supportsBrowserPerformance()) {
-            try {
-                window.performance.mark(this.startMark);
-            }
-            catch (e) {
-                // Silently catch
-            }
-        }
-    }
-    endMeasurement() {
-        if (BrowserPerformanceMeasurement.supportsBrowserPerformance()) {
-            try {
-                window.performance.mark(this.endMark);
-                window.performance.measure(this.measureName, this.startMark, this.endMark);
-            }
-            catch (e) {
-                // Silently catch
-            }
-        }
-    }
-    flushMeasurement() {
-        if (BrowserPerformanceMeasurement.supportsBrowserPerformance()) {
-            try {
-                const entriesForMeasurement = window.performance.getEntriesByName(this.measureName, "measure");
-                if (entriesForMeasurement.length > 0) {
-                    const durationMs = entriesForMeasurement[0].duration;
-                    window.performance.clearMeasures(this.measureName);
-                    window.performance.clearMarks(this.startMark);
-                    window.performance.clearMarks(this.endMark);
-                    return durationMs;
-                }
-            }
-            catch (e) {
-                // Silently catch and return null
-            }
-        }
-        return null;
-    }
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+class BrowserPerformanceMeasurement {
+    constructor(name, correlationId) {
+        this.correlationId = correlationId;
+        this.measureName = BrowserPerformanceMeasurement.makeMeasureName(name, correlationId);
+        this.startMark = BrowserPerformanceMeasurement.makeStartMark(name, correlationId);
+        this.endMark = BrowserPerformanceMeasurement.makeEndMark(name, correlationId);
+    }
+    static makeMeasureName(name, correlationId) {
+        return `msal.measure.${name}.${correlationId}`;
+    }
+    static makeStartMark(name, correlationId) {
+        return `msal.start.${name}.${correlationId}`;
+    }
+    static makeEndMark(name, correlationId) {
+        return `msal.end.${name}.${correlationId}`;
+    }
+    static supportsBrowserPerformance() {
+        return (typeof window !== "undefined" &&
+            typeof window.performance !== "undefined" &&
+            typeof window.performance.mark === "function" &&
+            typeof window.performance.measure === "function" &&
+            typeof window.performance.clearMarks === "function" &&
+            typeof window.performance.clearMeasures === "function" &&
+            typeof window.performance.getEntriesByName === "function");
+    }
+    /**
+     * Flush browser marks and measurements.
+     * @param {string} correlationId
+     * @param {SubMeasurement} measurements
+     */
+    static flushMeasurements(correlationId, measurements) {
+        if (BrowserPerformanceMeasurement.supportsBrowserPerformance()) {
+            try {
+                measurements.forEach((measurement) => {
+                    const measureName = BrowserPerformanceMeasurement.makeMeasureName(measurement.name, correlationId);
+                    const entriesForMeasurement = window.performance.getEntriesByName(measureName, "measure");
+                    if (entriesForMeasurement.length > 0) {
+                        window.performance.clearMeasures(measureName);
+                        window.performance.clearMarks(BrowserPerformanceMeasurement.makeStartMark(measureName, correlationId));
+                        window.performance.clearMarks(BrowserPerformanceMeasurement.makeEndMark(measureName, correlationId));
+                    }
+                });
+            }
+            catch (e) {
+                // Silently catch and return null
+            }
+        }
+    }
+    startMeasurement() {
+        if (BrowserPerformanceMeasurement.supportsBrowserPerformance()) {
+            try {
+                window.performance.mark(this.startMark);
+            }
+            catch (e) {
+                // Silently catch
+            }
+        }
+    }
+    endMeasurement() {
+        if (BrowserPerformanceMeasurement.supportsBrowserPerformance()) {
+            try {
+                window.performance.mark(this.endMark);
+                window.performance.measure(this.measureName, this.startMark, this.endMark);
+            }
+            catch (e) {
+                // Silently catch
+            }
+        }
+    }
+    flushMeasurement() {
+        if (BrowserPerformanceMeasurement.supportsBrowserPerformance()) {
+            try {
+                const entriesForMeasurement = window.performance.getEntriesByName(this.measureName, "measure");
+                if (entriesForMeasurement.length > 0) {
+                    const durationMs = entriesForMeasurement[0].duration;
+                    window.performance.clearMeasures(this.measureName);
+                    window.performance.clearMarks(this.startMark);
+                    window.performance.clearMarks(this.endMark);
+                    return durationMs;
+                }
+            }
+            catch (e) {
+                // Silently catch and return null
+            }
+        }
+        return null;
+    }
 }
 
 export { BrowserPerformanceMeasurement };