@azure/msal-common 14.0.1 → 14.0.3

package/src/telemetry/performance/IPerformanceClient.ts

@@ -0,0 +1,71 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { PerformanceEvent } from "./PerformanceEvent";
+import { IPerformanceMeasurement } from "./IPerformanceMeasurement";
+
+export type PerformanceCallbackFunction = (events: PerformanceEvent[]) => void;
+
+export type InProgressPerformanceEvent = {
+    end: (event?: Partial<PerformanceEvent>) => PerformanceEvent | null;
+    discard: () => void;
+    add: (fields: { [key: string]: {} | undefined }) => void;
+    increment: (fields: { [key: string]: number | undefined }) => void;
+    event: PerformanceEvent;
+    measurement: IPerformanceMeasurement;
+};
+
+export interface IPerformanceClient {
+    startMeasurement(
+        measureName: string,
+        correlationId?: string
+    ): InProgressPerformanceEvent;
+    endMeasurement(event: PerformanceEvent): PerformanceEvent | null;
+    discardMeasurements(correlationId: string): void;
+    addFields(
+        fields: { [key: string]: {} | undefined },
+        correlationId: string
+    ): void;
+    incrementFields(
+        fields: { [key: string]: number | undefined },
+        correlationId: string
+    ): void;
+    removePerformanceCallback(callbackId: string): boolean;
+    addPerformanceCallback(callback: PerformanceCallbackFunction): string;
+    emitEvents(events: PerformanceEvent[], correlationId: string): void;
+    startPerformanceMeasurement(
+        measureName: string,
+        correlationId: string
+    ): IPerformanceMeasurement;
+    generateId(): string;
+    calculateQueuedTime(preQueueTime: number, currentTime: number): number;
+    addQueueMeasurement(
+        eventName: string,
+        correlationId?: string,
+        queueTime?: number,
+        manuallyCompleted?: boolean
+    ): void;
+    setPreQueueTime(eventName: string, correlationId?: string): void;
+}
+
+/**
+ * Queue measurement type
+ */
+export type QueueMeasurement = {
+    /**
+     * Name of performance event
+     */
+    eventName: string;
+
+    /**
+     * Time spent in JS queue
+     */
+    queueTime: number;
+
+    /**
+     * Incomplete pre-queue events are instrumentation bugs that should be fixed.
+     */
+    manuallyCompleted?: boolean;
+};

package/src/telemetry/performance/IPerformanceMeasurement.ts

@@ -0,0 +1,10 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export interface IPerformanceMeasurement {
+    startMeasurement(): void;
+    endMeasurement(): void;
+    flushMeasurement(): number | null;
+}