Stringify telemetry context (#6984)

- Stringify telemetry context.
AzureAD · Mar 27, 2024 · 877818b · 877818b
1 parent 00c09f5
commit 877818b
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 14 deletions.
diff --git a/change/@azure-msal-common-e35f930c-c990-4df1-bbe9-fc014afae2a3.json b/change/@azure-msal-common-e35f930c-c990-4df1-bbe9-fc014afae2a3.json
@@ -0,0 +1,7 @@
+{
+  "type": "patch",
+  "comment": "Stringify telemetry context #6984",
+  "packageName": "@azure/msal-common",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}
diff --git a/lib/msal-common/src/telemetry/performance/PerformanceClient.ts b/lib/msal-common/src/telemetry/performance/PerformanceClient.ts
@@ -597,11 +597,13 @@ export abstract class PerformanceClient implements IPerformanceClient {
             event.durationMs || this.getDurationMs(event.startTimeMs)
         );
 
-        const context = endContext(
-            event,
-            this.abbreviations,
-            this.eventStack.get(rootEvent.correlationId),
-            error
+        const context = JSON.stringify(
+            endContext(
+                event,
+                this.abbreviations,
+                this.eventStack.get(rootEvent.correlationId),
+                error
+            )
         );
 
         if (isRoot) {

diff --git a/lib/msal-common/src/telemetry/performance/PerformanceEvent.ts b/lib/msal-common/src/telemetry/performance/PerformanceEvent.ts
@@ -796,8 +796,8 @@ export type PerformanceEvent = {
     errorName?: string;
     errorStack?: string[];
 
-    //
-    context?: object;
+    // Event context as JSON string
+    context?: string;
 };
 
 export type PerformanceEventContext = {

diff --git a/lib/msal-common/test/telemetry/PerformanceClient.spec.ts b/lib/msal-common/test/telemetry/PerformanceClient.spec.ts
@@ -627,7 +627,7 @@ describe("PerformanceClient.spec.ts", () => {
             mockPerfClient.addPerformanceCallback((events) => {
                 expect(events.length).toBe(1);
                 const event = events[0];
-                expect(event.context).toEqual({
+                expect(JSON.parse(event.context || "")).toEqual({
                     [abbrEventName(rootEvent.event.name)]: {
                         dur: perfDuration,
                     },
@@ -647,7 +647,7 @@ describe("PerformanceClient.spec.ts", () => {
             mockPerfClient.addPerformanceCallback((events) => {
                 expect(events.length).toBe(1);
                 const event = events[0];
-                expect(event.context).toEqual({
+                expect(JSON.parse(event.context || "")).toEqual({
                     [abbrEventName(rootEvent.event.name)]: {
                         dur: perfDuration,
                         [abbrEventName(
@@ -711,7 +711,7 @@ describe("PerformanceClient.spec.ts", () => {
             mockPerfClient.addPerformanceCallback((events) => {
                 expect(events.length).toBe(1);
                 const event = events[0];
-                expect(event.context).toEqual({
+                expect(JSON.parse(event.context || "")).toEqual({
                     [abbrEventName(rootEvent.event.name)]: {
                         dur: perfDuration,
                         [abbrEventName(firstLevelFirstChildEvent.event.name)]: {
@@ -779,7 +779,7 @@ describe("PerformanceClient.spec.ts", () => {
             mockPerfClient.addPerformanceCallback((events) => {
                 expect(events.length).toBe(1);
                 const event = events[0];
-                expect(event.context).toEqual({
+                expect(JSON.parse(event.context || "")).toEqual({
                     [abbrEventName(rootEvent.event.name)]: {
                         dur: perfDuration,
                         [abbrEventName(firstLevelFirstChildEvent.event.name)]: {
@@ -856,7 +856,7 @@ describe("PerformanceClient.spec.ts", () => {
             mockPerfClient.addPerformanceCallback((events) => {
                 expect(events.length).toBe(1);
                 const event = events[0];
-                expect(event.context).toEqual({
+                expect(JSON.parse(event.context || "")).toEqual({
                     [abbrEventName(rootEvent.event.name)]: {
                         dur: perfDuration,
                         [abbrEventName(firstLevelFirstChildEvent.event.name)]: {
@@ -931,7 +931,7 @@ describe("PerformanceClient.spec.ts", () => {
             mockPerfClient.addPerformanceCallback((events) => {
                 expect(events.length).toBe(1);
                 const event = events[0];
-                expect(event.context).toEqual({
+                expect(JSON.parse(event.context || "")).toEqual({
                     [abbrEventName(rootEvent.event.name)]: {
                         dur: perfDuration,
                         [abbrEventName(firstLevelFirstChildEvent.event.name)]: {
@@ -1000,7 +1000,7 @@ describe("PerformanceClient.spec.ts", () => {
             mockPerfClient.addPerformanceCallback((events) => {
                 expect(events.length).toBe(1);
                 const event = events[0];
-                expect(event.context).toEqual({
+                expect(JSON.parse(event.context || "")).toEqual({
                     [abbrEventName(rootEvent.event.name)]: {
                         dur: perfDuration,
                         [abbrEventName(firstLevelFirstChildEvent.event.name)]: {