Discard empty redirect telemetry events with no error codes

change/@azure-msal-browser-2e85fe15-6556-4439-ae1e-6999a0c982a5.json

@@ -0,0 +1,7 @@
+{
+  "type": "minor",
+  "comment": "Discard empty redirect telemetry events with no error codes #7058",
+  "packageName": "@azure/msal-browser",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}

lib/msal-browser/src/controllers/StandardController.ts

@@ -455,11 +455,7 @@ export class StandardController implements IController {
                 this.logger,
                 this.performanceClient,
                 rootMeasurement.event.correlationId
-            )(
-                hash,
-                this.performanceClient,
-                rootMeasurement.event.correlationId
-            );
+            )(hash, rootMeasurement);
         }
 
         return redirectResponse
@@ -492,12 +488,22 @@ export class StandardController implements IController {
                         success: true,
                         accountType: getAccountType(result.account),
                     });
+                } else {
+                    /*
+                     * Instrument an event only if an error code is set. Otherwise, discard it when the redirect response
+                     * is empty and the error code is missing.
+                     */
+                    if (rootMeasurement.event.errorCode) {
+                        rootMeasurement.end({ success: false });
+                    } else {
+                        rootMeasurement.discard();
+                    }
                 }
+
                 this.eventHandler.emitEvent(
                     EventType.HANDLE_REDIRECT_END,
                     InteractionType.Redirect
                 );
-                rootMeasurement.end({ success: false });
 
                 return result;
             })

lib/msal-browser/src/interaction_client/RedirectClient.ts

@@ -21,6 +21,7 @@ import {
     invokeAsync,
     ServerResponseType,
     UrlUtils,
+    InProgressPerformanceEvent,
 } from "@azure/msal-common";
 import { StandardInteractionClient } from "./StandardInteractionClient";
 import {
@@ -190,14 +191,12 @@ export class RedirectClient extends StandardInteractionClient {
      * Checks if navigateToLoginRequestUrl is set, and:
      * - if true, performs logic to cache and navigate
      * - if false, handles hash string and parses response
-     * @param hash {string?} url hash
-     * @param performanceClient {IPerformanceClient?}
-     * @param correlationId {string?} correlation identifier
+     * @param hash {string} url hash
+     * @param parentMeasurement {InProgressPerformanceEvent} parent measurement
      */
     async handleRedirectPromise(
-        hash?: string,
-        performanceClient?: IPerformanceClient,
-        correlationId?: string
+        hash: string = "",
+        parentMeasurement: InProgressPerformanceEvent
     ): Promise<AuthenticationResult | null> {
         const serverTelemetryManager = this.initializeServerTelemetryManager(
             ApiId.handleRedirectPromise
@@ -220,12 +219,7 @@ export class RedirectClient extends StandardInteractionClient {
                 this.browserStorage.cleanRequestByInteractionType(
                     InteractionType.Redirect
                 );
-                if (performanceClient && correlationId) {
-                    performanceClient?.addFields(
-                        { errorCode: "no_server_response" },
-                        correlationId
-                    );
-                }
+                parentMeasurement.event.errorCode = "no_server_response";
                 return null;
             }
 

lib/msal-browser/test/app/PublicClientApplication.spec.ts

@@ -45,6 +45,7 @@ import {
     InteractionRequiredAuthErrorCodes,
     Logger,
     LogLevel,
+    PerformanceClient,
     PerformanceEvent,
     PerformanceEvents,
     PersistentCacheKeys,
@@ -1020,6 +1021,66 @@ describe("PublicClientApplication.ts Class Unit Tests", () => {
             expect(tokenResponse1).toEqual(tokenResponse2);
             expect(tokenResponse4).toEqual(tokenResponse1);
         });
+
+        it("Emits performance event with error code if no response is provided", (done) => {
+            const testAccount: AccountInfo = {
+                homeAccountId: TEST_DATA_CLIENT_INFO.TEST_HOME_ACCOUNT_ID,
+                localAccountId: TEST_DATA_CLIENT_INFO.TEST_UID,
+                environment: "login.windows.net",
+                tenantId: "3338040d-6c67-4c5b-b112-36a304b66dad",
+                username: "[email protected]",
+            };
+            sinon
+                .stub(StandardController.prototype, "getAllAccounts")
+                .returns([testAccount]);
+            sinon
+                // @ts-ignore
+                .stub(RedirectClient.prototype, "getRedirectResponse")
+                // @ts-ignore
+                .returns([null, ""]);
+
+            const callbackId = pca.addPerformanceCallback((events) => {
+                expect(events.length).toEqual(1);
+                expect(events[0].success).toBe(false);
+                expect(events[0].errorCode).toBe("no_server_response");
+                pca.removePerformanceCallback(callbackId);
+                done();
+            });
+
+            window.sessionStorage.setItem(
+                `${Constants.CACHE_PREFIX}.${TEST_CONFIG.MSAL_CLIENT_ID}.${TemporaryCacheKeys.CORRELATION_ID}`,
+                RANDOM_TEST_GUID
+            );
+            window.sessionStorage.setItem(
+                `${Constants.CACHE_PREFIX}.${TemporaryCacheKeys.INTERACTION_STATUS_KEY}`,
+                TEST_CONFIG.MSAL_CLIENT_ID
+            );
+            pca.handleRedirectPromise();
+        });
+
+        it("Discards performance event if handleRedirectPromise returns null and no error code is set", async () => {
+            const testAccount: AccountInfo = {
+                homeAccountId: TEST_DATA_CLIENT_INFO.TEST_HOME_ACCOUNT_ID,
+                localAccountId: TEST_DATA_CLIENT_INFO.TEST_UID,
+                environment: "login.windows.net",
+                tenantId: "3338040d-6c67-4c5b-b112-36a304b66dad",
+                username: "[email protected]",
+            };
+            sinon
+                .stub(StandardController.prototype, "getAllAccounts")
+                .returns([testAccount]);
+            sinon
+                .stub(RedirectClient.prototype, "handleRedirectPromise")
+                .resolves(null);
+
+            const emitSpy = jest.spyOn(
+                PerformanceClient.prototype,
+                "emitEvents"
+            );
+
+            await pca.handleRedirectPromise();
+            expect(emitSpy).toHaveBeenCalledTimes(0);
+        });
     });
     describe("OIDC Protocol Mode tests", () => {
         beforeEach(async () => {