- Instrument scenario id for tracking custom user prompts

AzureAD · Apr 19, 2024 · 500e3b8 · 500e3b8
1 parent ad8a43f
commit 500e3b8
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 0 deletions.
diff --git a/lib/msal-browser/src/controllers/StandardController.ts b/lib/msal-browser/src/controllers/StandardController.ts
@@ -631,6 +631,8 @@ export class StandardController implements IController {
             correlationId
         );
 
+        atPopupMeasurement.add({ scenarioId: request.scenarioId });
+
         try {
             this.logger.verbose("acquireTokenPopup called", correlationId);
             BrowserUtils.preflightCheck(this.initialized);
@@ -811,6 +813,8 @@ export class StandardController implements IController {
         this.ssoSilentMeasurement?.increment({
             visibilityChangeCount: 0,
         });
+        this.ssoSilentMeasurement?.add({ scenarioId: request.scenarioId });
+
         document.addEventListener(
             "visibilitychange",
             this.trackPageVisibilityWithMeasurement
@@ -912,6 +916,7 @@ export class StandardController implements IController {
             PerformanceEvents.AcquireTokenByCode,
             correlationId
         );
+        atbcMeasurement.add({ scenarioId: request.scenarioId });
 
         try {
             if (request.code && request.nativeAccountId) {
@@ -1856,6 +1861,7 @@ export class StandardController implements IController {
         );
         atsMeasurement.add({
             cacheLookupPolicy: request.cacheLookupPolicy,
+            scenarioId: request.scenarioId,
         });
 
         BrowserUtils.preflightCheck(this.initialized);

diff --git a/lib/msal-browser/test/app/PublicClientApplication.spec.ts b/lib/msal-browser/test/app/PublicClientApplication.spec.ts
@@ -2424,6 +2424,47 @@ describe("PublicClientApplication.ts Class Unit Tests", () => {
                     window.opener = oldWindowOpener;
                 });
         });
+
+        it("emits successful performance telemetry event", (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: "AbeLi@microsoft.com",
+            };
+            const testTokenResponse: AuthenticationResult = {
+                authority: TEST_CONFIG.validAuthority,
+                uniqueId: testAccount.localAccountId,
+                tenantId: testAccount.tenantId,
+                scopes: TEST_CONFIG.DEFAULT_SCOPES,
+                idToken: "test-idToken",
+                idTokenClaims: {},
+                accessToken: "test-accessToken",
+                fromCache: false,
+                correlationId: RANDOM_TEST_GUID,
+                expiresOn: new Date(Date.now() + 3600000),
+                account: testAccount,
+                tokenType: AuthenticationScheme.BEARER,
+            };
+            const popupClientSpy = sinon
+                .stub(PopupClient.prototype, "acquireToken")
+                .resolves(testTokenResponse);
+
+            const callbackId = pca.addPerformanceCallback((events) => {
+                expect(events[0].correlationId).toBe(RANDOM_TEST_GUID);
+                expect(events[0].success).toBe(true);
+                expect(events[0].scenarioId).toBe("test-scenario-id");
+                pca.removePerformanceCallback(callbackId);
+                done();
+            });
+
+            pca.acquireTokenPopup({
+                scopes: ["openid"],
+                scenarioId: "test-scenario-id",
+                correlationId: RANDOM_TEST_GUID,
+            });
+        });
     });
 
     describe("ssoSilent", () => {
@@ -2811,12 +2852,14 @@ describe("PublicClientApplication.ts Class Unit Tests", () => {
                 expect(events[0].success).toBe(false);
                 expect(events[0].errorCode).toBe("abc");
                 expect(events[0].subErrorCode).toBe("defg");
+                expect(events[0].scenarioId).toBe("test-scenario-id");
                 pca.removePerformanceCallback(callbackId);
                 done();
             });
             pca.ssoSilent({
                 scopes: ["openid"],
                 correlationId: RANDOM_TEST_GUID,
+                scenarioId: "test-scenario-id",
             }).catch(() => {});
         });
     });
@@ -3175,12 +3218,14 @@ describe("PublicClientApplication.ts Class Unit Tests", () => {
                 expect(events[0].idTokenSize).toBe(12);
                 expect(events[0].requestId).toBe(undefined);
                 expect(events[0].visibilityChangeCount).toBe(0);
+                expect(events[0].scenarioId).toBe("test-scenario-id");
                 pca.removePerformanceCallback(callbackId);
                 done();
             });
             pca.acquireTokenByCode({
                 code: "auth-code",
                 correlationId: testTokenResponse.correlationId,
+                scenarioId: "test-scenario-id",
             });
         });
 
@@ -4854,6 +4899,7 @@ describe("PublicClientApplication.ts Class Unit Tests", () => {
                 scopes: ["User.Read"],
                 account: testAccount,
                 correlationId: RANDOM_TEST_GUID,
+                scenarioId: "test-scenario-id",
             };
 
             const atsSpy = sinon
@@ -4876,6 +4922,7 @@ describe("PublicClientApplication.ts Class Unit Tests", () => {
                 expect(events[0].idTokenSize).toBe(4);
                 expect(events[0].isNativeBroker).toBe(true);
                 expect(events[0].requestId).toBe(undefined);
+                expect(events[0].scenarioId).toBe("test-scenario-id");
 
                 pca.removePerformanceCallback(callbackId);
                 done();

diff --git a/lib/msal-common/src/request/BaseAuthRequest.ts b/lib/msal-common/src/request/BaseAuthRequest.ts
@@ -27,6 +27,7 @@ import { ShrOptions } from "../crypto/SignedHttpRequest";
  * - requestedClaimsHash     - SHA 256 hash string of the requested claims string, used as part of an access token cache key so tokens can be filtered by requested claims
  * - tokenQueryParameters    - String to string map of custom query parameters added to the /token call
  * - storeInCache            - Object containing boolean values indicating whether to store tokens in the cache or not (default is true)
+ * - scenarioId              - Scenario id to track custom user prompts
  */
 export type BaseAuthRequest = {
     authority: string;
@@ -46,4 +47,5 @@ export type BaseAuthRequest = {
     maxAge?: number;
     tokenQueryParameters?: StringDict;
     storeInCache?: StoreInCache;
+    scenarioId?: string;
 };
diff --git a/lib/msal-common/src/telemetry/performance/PerformanceEvent.ts b/lib/msal-common/src/telemetry/performance/PerformanceEvent.ts
@@ -814,6 +814,9 @@ export type PerformanceEvent = {
     cacheRtCount?: number;
     cacheIdCount?: number;
     cacheAtCount?: number;
+
+    // Scenario id to track custom user prompts
+    scenarioId?: string;
 };
 
 export type PerformanceEventContext = {