Instrument correlation between silent and interactive requests

change/@azure-msal-browser-07e5fb07-4b66-4ca6-830a-ce01a1ea2861.json

@@ -0,0 +1,7 @@
+{
+  "type": "minor",
+  "comment": "Instrument a correlation between silent and interactive requests #7146",
+  "packageName": "@azure/msal-browser",
+  "email": "kshabelko@microsoft.com",
+  "dependentChangeType": "patch"
+}

change/@azure-msal-common-03130ac3-4ef1-4ffb-b11e-b3e30ff5edb5.json

@@ -0,0 +1,7 @@
+{
+  "type": "minor",
+  "comment": "Instrument a correlation between silent and interactive requests #7146",
+  "packageName": "@azure/msal-common",
+  "email": "kshabelko@microsoft.com",
+  "dependentChangeType": "patch"
+}

lib/msal-browser/apiReview/msal-browser.api.md

@@ -519,6 +519,10 @@ export class BrowserPerformanceClient extends PerformanceClient implements IPerf
     generateId(): string;
     // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
     // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}'
+    // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration
+    generateRequestThumbprint(request: SilentRequest | SsoSilentRequest | PopupRequest | RedirectRequest): string;
+    // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+    // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}'
     // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
     // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}'
     setPreQueueTime(eventName: PerformanceEvents, correlationId?: string): void;

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

@@ -698,6 +698,7 @@ export class StandardController implements IController {
         atPopupMeasurement.add({
             scenarioId: request.scenarioId,
             accountType: getAccountType(request.account),
+            request,
         });
 
         try {
@@ -879,6 +880,7 @@ export class StandardController implements IController {
         this.ssoSilentMeasurement?.add({
             scenarioId: request.scenarioId,
             accountType: getAccountType(request.account),
+            request,
         });
         preflightCheck(this.initialized, this.ssoSilentMeasurement);
         this.ssoSilentMeasurement?.increment({
@@ -1873,7 +1875,10 @@ export class StandardController implements IController {
         if (!account) {
             throw createBrowserAuthError(BrowserAuthErrorCodes.noAccountError);
         }
-        atsMeasurement.add({ accountType: getAccountType(account) });
+        atsMeasurement.add({
+            accountType: getAccountType(account),
+            request,
+        });
 
         const thumbprint: RequestThumbprint = {
             clientId: this.config.auth.clientId,

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

@@ -157,6 +157,12 @@ export class NativeInteractionClient extends BaseInteractionClient {
                 this.accountId,
                 nativeRequest
             );
+            nativeATMeasurement.add({
+                request: {
+                    ...request,
+                    account: result.account,
+                },
+            });
             nativeATMeasurement.end({
                 success: true,
                 isNativeBroker: false, // Should be true only when the result is coming directly from the broker
@@ -188,6 +194,12 @@ export class NativeInteractionClient extends BaseInteractionClient {
             reqTimestamp
         )
             .then((result: AuthenticationResult) => {
+                nativeATMeasurement.add({
+                    request: {
+                        ...request,
+                        account: result.account,
+                    },
+                });
                 nativeATMeasurement.end({
                     success: true,
                     isNativeBroker: true,

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

@@ -353,6 +353,16 @@ export class PopupClient extends StandardInteractionClient {
                 validRequest
             );
 
+            this.performanceClient.addFields(
+                {
+                    request: {
+                        ...request,
+                        account: result.account,
+                    },
+                },
+                this.correlationId
+            );
+
             return result;
         } catch (e) {
             if (popup) {

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

@@ -420,6 +420,10 @@ export class RedirectClient extends StandardInteractionClient {
         }
 
         const cachedRequest = this.browserStorage.getCachedRequest(state);
+        this.performanceClient.addFields(
+            { request: { cachedRequest } },
+            this.correlationId
+        );
         this.logger.verbose("handleResponse called, retrieved cached request");
 
         if (serverParams.accountId) {
@@ -488,7 +492,22 @@ export class RedirectClient extends StandardInteractionClient {
             this.logger,
             this.performanceClient
         );
-        return interactionHandler.handleCodeResponse(serverParams, state);
+        const result = await interactionHandler.handleCodeResponse(
+            serverParams,
+            state
+        );
+
+        this.performanceClient.addFields(
+            {
+                request: {
+                    ...cachedRequest,
+                    account: result.account,
+                },
+            },
+            this.correlationId
+        );
+
+        return result;
     }
 
     /**

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

@@ -12,6 +12,7 @@ import {
     PerformanceEvent,
     PerformanceEvents,
     PreQueueEvent,
+    RequestThumbprint,
     SubMeasurement,
 } from "@azure/msal-common";
 import { Configuration } from "../config/Configuration";
@@ -21,6 +22,11 @@ import {
     BrowserCacheLocation,
 } from "../utils/BrowserConstants";
 import * as BrowserCrypto from "../crypto/BrowserCrypto";
+import { SilentRequest } from "../request/SilentRequest";
+import { SsoSilentRequest } from "../request/SsoSilentRequest";
+import { RedirectRequest } from "../request/RedirectRequest";
+import { PopupRequest } from "../request/PopupRequest";
+import { base64Encode } from "../encode/Base64Encode";
 
 /**
  * Returns browser performance measurement module if session flag is enabled. Returns undefined otherwise.
@@ -97,6 +103,31 @@ export class BrowserPerformanceClient
         return BrowserCrypto.createNewGuid();
     }
 
+    /**
+     * Generates base64 encoded request thumbprint
+     * @param request { SilentRequest | SsoSilentRequest | RedirectRequest | PopupRequest }
+     * @return string
+     */
+    generateRequestThumbprint(
+        request:
+            | SilentRequest
+            | SsoSilentRequest
+            | PopupRequest
+            | RedirectRequest
+    ): string {
+        const thumbprint: RequestThumbprint = {
+            clientId: this.clientId,
+            authority: request.authority || "",
+            scopes: request.scopes || [],
+            authenticationScheme: request.authenticationScheme,
+            resourceRequestMethod: request.resourceRequestMethod,
+            resourceRequestUri: request.resourceRequestUri,
+            sshKid: request.sshKid,
+            shrOptions: request.shrOptions,
+        };
+        return base64Encode(JSON.stringify(thumbprint));
+    }
+
     private getPageVisibility(): string | null {
         return document.visibilityState?.toString() || null;
     }