Skip to content

Commit 5d05054

Browse files
Make eventName of type string for BrowserPerformanceClient and PerformanceClient (#6386)
- Make `eventName` of type string for `BrowserPerformanceClient` and `PerformanceClient`. - Expose `InProgressPerformanceEvent` to get rid of `msal-common` dep in 1p.
1 parent 908e97f commit 5d05054

6 files changed

+24
-11
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"type": "patch",
3+
"comment": "Make `eventName` of type string for `BrowserPerformanceClient` and `PerformanceClient` #6386",
4+
"packageName": "@azure/msal-browser",
5+
"email": "[email protected]",
6+
"dependentChangeType": "patch"
7+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"type": "patch",
3+
"comment": "Make `eventName` of type string for `BrowserPerformanceClient` and `PerformanceClient` #6386",
4+
"packageName": "@azure/msal-common",
5+
"email": "[email protected]",
6+
"dependentChangeType": "patch"
7+
}

lib/msal-browser/src/index.ts

+2
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,8 @@ export {
143143
PerformanceCallbackFunction,
144144
PerformanceEvent,
145145
PerformanceEvents,
146+
// Telemetry
147+
InProgressPerformanceEvent,
146148
} from "@azure/msal-common";
147149

148150
export { version } from "./packageMetadata";

lib/msal-browser/src/telemetry/BrowserPerformanceClient.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ export class BrowserPerformanceClient
104104
* @returns {((event?: Partial<PerformanceEvent>) => PerformanceEvent| null)}
105105
*/
106106
startMeasurement(
107-
measureName: PerformanceEvents,
107+
measureName: string,
108108
correlationId?: string
109109
): InProgressPerformanceEvent {
110110
// Capture page visibilityState and then invoke start/end measurement
@@ -195,7 +195,7 @@ export class BrowserPerformanceClient
195195
* @returns
196196
*/
197197
addQueueMeasurement(
198-
eventName: PerformanceEvents,
198+
eventName: string,
199199
correlationId?: string,
200200
queueTime?: number,
201201
manuallyCompleted?: boolean

lib/msal-common/src/telemetry/performance/IPerformanceClient.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* Licensed under the MIT License.
44
*/
55

6-
import { PerformanceEvent, PerformanceEvents } from "./PerformanceEvent";
6+
import { PerformanceEvent } from "./PerformanceEvent";
77
import { IPerformanceMeasurement } from "./IPerformanceMeasurement";
88

99
export type PerformanceCallbackFunction = (events: PerformanceEvent[]) => void;
@@ -42,12 +42,12 @@ export interface IPerformanceClient {
4242
generateId(): string;
4343
calculateQueuedTime(preQueueTime: number, currentTime: number): number;
4444
addQueueMeasurement(
45-
eventName: PerformanceEvents,
45+
eventName: string,
4646
correlationId?: string,
4747
queueTime?: number,
4848
manuallyCompleted?: boolean
4949
): void;
50-
setPreQueueTime(eventName: PerformanceEvents, correlationId?: string): void;
50+
setPreQueueTime(eventName: string, correlationId?: string): void;
5151
}
5252

5353
/**
@@ -57,7 +57,7 @@ export type QueueMeasurement = {
5757
/**
5858
* Name of performance event
5959
*/
60-
eventName: PerformanceEvents;
60+
eventName: string;
6161

6262
/**
6363
* Time spent in JS queue

lib/msal-common/src/telemetry/performance/PerformanceClient.ts

+2-5
Original file line numberDiff line numberDiff line change
@@ -139,10 +139,7 @@ export abstract class PerformanceClient implements IPerformanceClient {
139139
* @param {string} correlationId
140140
* @returns {number}
141141
*/
142-
getPreQueueTime(
143-
eventName: PerformanceEvents,
144-
correlationId: string
145-
): number | void {
142+
getPreQueueTime(eventName: string, correlationId: string): number | void {
146143
const preQueueEvent: PreQueueEvent | undefined =
147144
this.preQueueTimeByCorrelationId.get(correlationId);
148145

@@ -204,7 +201,7 @@ export abstract class PerformanceClient implements IPerformanceClient {
204201
* @returns
205202
*/
206203
addQueueMeasurement(
207-
eventName: PerformanceEvents,
204+
eventName: string,
208205
correlationId?: string,
209206
queueTime?: number,
210207
manuallyCompleted?: boolean

0 commit comments

Comments
 (0)