Merge branch 'dev' into preflightBrowserEnvironmentCheck-setinteractioninprogress

hectormmg · web-flow · commit b538c41f9b20 · 2022-06-13T15:19:49.000-07:00
diff --git a/change/@azure-msal-browser-157ea07b-c310-4aec-8a13-a6fbbd7565d3.json b/change/@azure-msal-browser-157ea07b-c310-4aec-8a13-a6fbbd7565d3.json
@@ -0,0 +1,7 @@
+{
+  "type": "minor",
+  "comment": "Add errorCode and subErrorCode to client telemetry events (#4863)",
+  "packageName": "@azure/msal-browser",
+  "email": "sameera.gajjarapu@microsoft.com",
+  "dependentChangeType": "patch"
+}
diff --git a/change/@azure-msal-common-3bcc600c-ddf9-44be-aadf-4b3d7c99b87d.json b/change/@azure-msal-common-3bcc600c-ddf9-44be-aadf-4b3d7c99b87d.json
@@ -0,0 +1,7 @@
+{
+  "type": "minor",
+  "comment": "Add errorCode and subErrorCode to performance telemetry events (#4863)",
+  "packageName": "@azure/msal-common",
+  "email": "sameera.gajjarapu@microsoft.com",
+  "dependentChangeType": "patch"
+}
diff --git a/lib/msal-browser/src/app/ClientApplication.ts b/lib/msal-browser/src/app/ClientApplication.ts
@@ -364,14 +364,16 @@ export abstract class ClientApplication {
             });
             atPopupMeasurement.flushMeasurement();
             return result;
-        }).catch((e) => {
+        }).catch((e: AuthError) => {
             if (loggedInAccounts.length > 0) {
                 this.eventHandler.emitEvent(EventType.ACQUIRE_TOKEN_FAILURE, InteractionType.Popup, null, e);
             } else {
                 this.eventHandler.emitEvent(EventType.LOGIN_FAILURE, InteractionType.Popup, null, e);
             }
 
             atPopupMeasurement.endMeasurement({
+                errorCode: e.errorCode,
+                subErrorCode: e.subError,
                 success: false
             });
             atPopupMeasurement.flushMeasurement();
@@ -432,13 +434,16 @@ export abstract class ClientApplication {
         return result.then((response) => {
             this.eventHandler.emitEvent(EventType.SSO_SILENT_SUCCESS, InteractionType.Silent, response);
             ssoSilentMeasurement.endMeasurement({
-                success: true
+                success: true,
+                isNativeBroker: response.fromNativeBroker
             });
             ssoSilentMeasurement.flushMeasurement();
             return response;
-        }).catch ((e) => {
+        }).catch ((e: AuthError) => {
             this.eventHandler.emitEvent(EventType.SSO_SILENT_FAILURE, InteractionType.Silent, null, e);
             ssoSilentMeasurement.endMeasurement({
+                errorCode: e.errorCode,
+                subErrorCode: e.subError,
                 success: false
             });
             ssoSilentMeasurement.flushMeasurement();
@@ -477,15 +482,18 @@ export abstract class ClientApplication {
                             this.eventHandler.emitEvent(EventType.ACQUIRE_TOKEN_BY_CODE_SUCCESS, InteractionType.Silent, result);
                             this.hybridAuthCodeResponses.delete(hybridAuthCode);
                             atbcMeasurement.endMeasurement({
-                                success: true
+                                success: true,
+                                isNativeBroker: result.fromNativeBroker
                             });
                             atbcMeasurement.flushMeasurement();
                             return result;
                         })
-                        .catch((error: Error) => {
+                        .catch((error: AuthError) => {
                             this.hybridAuthCodeResponses.delete(hybridAuthCode);
                             this.eventHandler.emitEvent(EventType.ACQUIRE_TOKEN_BY_CODE_FAILURE, InteractionType.Silent, null, error);
                             atbcMeasurement.endMeasurement({
+                                errorCode: error.errorCode,
+                                subErrorCode: error.subError,
                                 success: false
                             });
                             atbcMeasurement.flushMeasurement();
@@ -519,6 +527,8 @@ export abstract class ClientApplication {
         } catch (e) {
             this.eventHandler.emitEvent(EventType.ACQUIRE_TOKEN_BY_CODE_FAILURE, InteractionType.Silent, null, e);
             atbcMeasurement.endMeasurement({
+                errorCode: e instanceof AuthError && e.errorCode || undefined,
+                subErrorCode: e instanceof AuthError && e.subError || undefined,
                 success: false
             });
             throw e;
@@ -583,6 +593,8 @@ export abstract class ClientApplication {
                         })
                         .catch((error) => {
                             atbrtMeasurement.endMeasurement({
+                                errorCode: error.errorCode,
+                                subErrorCode: error.subError,
                                 success: false
                             });
                             throw error;
diff --git a/lib/msal-browser/src/app/PublicClientApplication.ts b/lib/msal-browser/src/app/PublicClientApplication.ts
@@ -125,14 +125,17 @@ export class PublicClientApplication extends ClientApplication implements IPubli
                     this.activeSilentTokenRequests.delete(silentRequestKey);
                     atsMeasurement.endMeasurement({
                         success: true,
-                        fromCache: result.fromCache
+                        fromCache: result.fromCache,
+                        isNativeBroker: result.fromNativeBroker
                     });
                     atsMeasurement.flushMeasurement();
                     return result;
                 })
-                .catch((error) => {
+                .catch((error: AuthError) => {
                     this.activeSilentTokenRequests.delete(silentRequestKey);
                     atsMeasurement.endMeasurement({
+                        errorCode: error.errorCode,
+                        subErrorCode: error.subError,
                         success: false
                     });
                     atsMeasurement.flushMeasurement();
@@ -193,12 +196,15 @@ export class PublicClientApplication extends ClientApplication implements IPubli
             this.eventHandler.emitEvent(EventType.ACQUIRE_TOKEN_SUCCESS, InteractionType.Silent, response);
             astsAsyncMeasurement.endMeasurement({
                 success: true,
-                fromCache: response.fromCache
+                fromCache: response.fromCache,
+                isNativeBroker: response.fromNativeBroker
             });
             return response;
-        }).catch((tokenRenewalError) => {
+        }).catch((tokenRenewalError: AuthError) => {
             this.eventHandler.emitEvent(EventType.ACQUIRE_TOKEN_FAILURE, InteractionType.Silent, null, tokenRenewalError);
             astsAsyncMeasurement.endMeasurement({
+                errorCode: tokenRenewalError.errorCode,
+                subErrorCode: tokenRenewalError.subError,
                 success: false
             });
             throw tokenRenewalError;
diff --git a/lib/msal-browser/src/interaction_client/NativeInteractionClient.ts b/lib/msal-browser/src/interaction_client/NativeInteractionClient.ts
@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { AuthenticationResult, Logger, ICrypto, PromptValue, AuthToken, Constants, AccountEntity, AuthorityType, ScopeSet, TimeUtils, AuthenticationScheme, UrlString, OIDC_DEFAULT_SCOPES, PopTokenGenerator, SignedHttpRequestParameters, IPerformanceClient, PerformanceEvents, ClientAuthError } from "@azure/msal-common";
+import { AuthenticationResult, Logger, ICrypto, PromptValue, AuthToken, Constants, AccountEntity, AuthorityType, ScopeSet, TimeUtils, AuthenticationScheme, UrlString, OIDC_DEFAULT_SCOPES, PopTokenGenerator, SignedHttpRequestParameters, IPerformanceClient, PerformanceEvents, ClientAuthError, AuthError } from "@azure/msal-common";
 import { BaseInteractionClient } from "./BaseInteractionClient";
 import { BrowserConfiguration } from "../config/Configuration";
 import { BrowserCacheManager } from "../cache/BrowserCacheManager";
@@ -61,9 +61,11 @@ export class NativeInteractionClient extends BaseInteractionClient {
                 });
                 return result;
             })
-            .catch((error) => {
+            .catch((error: AuthError) => {
                 nativeATMeasurement.endMeasurement({
                     success: false,
+                    errorCode: error.errorCode,
+                    subErrorCode: error.subError,
                     isNativeBroker: true
                 });
                 throw error;
diff --git a/lib/msal-browser/src/interaction_client/SilentCacheClient.ts b/lib/msal-browser/src/interaction_client/SilentCacheClient.ts
@@ -4,7 +4,7 @@
  */
 
 import { StandardInteractionClient } from "./StandardInteractionClient";
-import { CommonSilentFlowRequest, AuthenticationResult, SilentFlowClient, ServerTelemetryManager, AccountInfo, AzureCloudOptions, PerformanceEvents} from "@azure/msal-common";
+import { CommonSilentFlowRequest, AuthenticationResult, SilentFlowClient, ServerTelemetryManager, AccountInfo, AzureCloudOptions, PerformanceEvents, AuthError} from "@azure/msal-common";
 import { SilentRequest } from "../request/SilentRequest";
 import { ApiId } from "../utils/BrowserConstants";
 import { BrowserAuthError, BrowserAuthErrorMessage } from "../error/BrowserAuthError";
@@ -34,6 +34,8 @@ export class SilentCacheClient extends StandardInteractionClient {
                 this.logger.verbose("Signing keypair for bound access token not found. Refreshing bound access token and generating a new crypto keypair.");
             }
             acquireTokenMeasurement.endMeasurement({
+                errorCode: error instanceof AuthError && error.errorCode || undefined,
+                subErrorCode: error instanceof AuthError && error.subError || undefined,
                 success: false
             });
             throw error;
diff --git a/lib/msal-browser/src/interaction_client/SilentIframeClient.ts b/lib/msal-browser/src/interaction_client/SilentIframeClient.ts
@@ -73,6 +73,8 @@ export class SilentIframeClient extends StandardInteractionClient {
             serverTelemetryManager.cacheFailedRequest(e);
             this.browserStorage.cleanRequestByState(silentRequest.state);
             acquireTokenMeasurement.endMeasurement({
+                errorCode: e instanceof AuthError && e.errorCode || undefined,
+                subErrorCode: e instanceof AuthError && e.subError || undefined,
                 success: false
             });
             throw e;
diff --git a/lib/msal-browser/src/interaction_client/SilentRefreshClient.ts b/lib/msal-browser/src/interaction_client/SilentRefreshClient.ts
@@ -40,6 +40,8 @@ export class SilentRefreshClient extends StandardInteractionClient {
                 }
                 serverTelemetryManager.cacheFailedRequest(e);
                 acquireTokenMeasurement.endMeasurement({
+                    errorCode: e.errorCode,
+                    subErrorCode: e.subError,
                     success: false
                 });
                 throw e;
diff --git a/lib/msal-browser/src/interaction_client/StandardInteractionClient.ts b/lib/msal-browser/src/interaction_client/StandardInteractionClient.ts
@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { ServerTelemetryManager, CommonAuthorizationCodeRequest, Constants, AuthorizationCodeClient, ClientConfiguration, AuthorityOptions, Authority, AuthorityFactory, ServerAuthorizationCodeResponse, UrlString, CommonEndSessionRequest, ProtocolUtils, ResponseMode, StringUtils, IdTokenClaims, AccountInfo, AzureCloudOptions, PerformanceEvents } from "@azure/msal-common";
+import { ServerTelemetryManager, CommonAuthorizationCodeRequest, Constants, AuthorizationCodeClient, ClientConfiguration, AuthorityOptions, Authority, AuthorityFactory, ServerAuthorizationCodeResponse, UrlString, CommonEndSessionRequest, ProtocolUtils, ResponseMode, StringUtils, IdTokenClaims, AccountInfo, AzureCloudOptions, PerformanceEvents, AuthError } from "@azure/msal-common";
 import { BaseInteractionClient } from "./BaseInteractionClient";
 import { AuthorizationUrlRequest } from "../request/AuthorizationUrlRequest";
 import { BrowserConstants, InteractionType } from "../utils/BrowserConstants";
@@ -223,8 +223,10 @@ export abstract class StandardInteractionClient extends BaseInteractionClient {
 
                 return result;
             })
-            .catch((error:Error) => {
+            .catch((error:AuthError) => {
                 getAuthorityMeasurement.endMeasurement({
+                    errorCode: error.errorCode,
+                    subErrorCode: error.subError,
                     success: false
                 });
 
diff --git a/lib/msal-common/src/telemetry/performance/PerformanceEvent.ts b/lib/msal-common/src/telemetry/performance/PerformanceEvent.ts
@@ -202,6 +202,20 @@ export type PerformanceEvent = {
      */
     success?: boolean | null,
 
+    /**
+     * Add specific error code in case of failure
+     *
+     * @type {string}
+     */
+    errorCode?: string,
+
+    /**
+     * Add specific sub error code in case of failure
+     *
+     * @type {string}
+     */
+    subErrorCode?: string,
+
     /**
      * Name of the library used for the operation.
      *

Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,8 @@ export class SilentRefreshClient extends StandardInteractionClient {`
`40`	`40`	`}`
`41`	`41`	`serverTelemetryManager.cacheFailedRequest(e);`
`42`	`42`	`acquireTokenMeasurement.endMeasurement({`
	`43`	`+ errorCode: e.errorCode,`
	`44`	`+ subErrorCode: e.subError,`
`43`	`45`	`success: false`
`44`	`46`	`});`
`45`	`47`	`throw e;`