[correlationId] Make correlationId a required parameter on AuthError constructors (breaking)

change/@azure-msal-angular-correlationid-required-8609.json

@@ -0,0 +1,7 @@
+{
+    "type": "minor",
+    "comment": "Pass correlationId to BrowserConfigurationAuthError constructors in MsalGuard and MsalInterceptor to match the updated msal-browser error signature [#8609](https://github.com/AzureAD/microsoft-authentication-library-for-js/pull/8609)",
+    "packageName": "@azure/msal-angular",
+    "email": "sameera.gajjarapu@microsoft.com",
+    "dependentChangeType": "patch"
+}

change/@azure-msal-browser-7c559b7a-066d-486b-b68f-4b4359e3f053.json

@@ -0,0 +1,7 @@
+{
+    "type": "minor",
+    "comment": "Make correlationId a required parameter on AuthError and all derived error classes; remove setCorrelationId in favor of direct assignment [#8609](https://github.com/AzureAD/microsoft-authentication-library-for-js/pull/8609)",
+    "packageName": "@azure/msal-browser",
+    "email": "sameera.gajjarapu@microsoft.com",
+    "dependentChangeType": "patch"
+}

change/@azure-msal-common-151e2ba1-220e-4a47-a4dc-e421d262da2a.json

@@ -0,0 +1,7 @@
+{
+    "type": "minor",
+    "comment": "Make correlationId a required parameter on AuthError and all derived error classes (ClientAuthError, ClientConfigurationError, ServerError, InteractionRequiredAuthError, NetworkError, PlatformBrokerError); remove setCorrelationId in favor of direct assignment [#8609](https://github.com/AzureAD/microsoft-authentication-library-for-js/pull/8609)",
+    "packageName": "@azure/msal-common",
+    "email": "sameera.gajjarapu@microsoft.com",
+    "dependentChangeType": "patch"
+}

change/@azure-msal-node-correlationid-required-8609.json

@@ -0,0 +1,7 @@
+{
+    "type": "minor",
+    "comment": "Make correlationId a required parameter on NodeAuthError and ManagedIdentityError; update all error throw sites and remove setCorrelationId usages [#8609](https://github.com/AzureAD/microsoft-authentication-library-for-js/pull/8609)",
+    "packageName": "@azure/msal-node",
+    "email": "sameera.gajjarapu@microsoft.com",
+    "dependentChangeType": "patch"
+}

change/@azure-msal-node-extensions-correlationid-required-8609.json

@@ -0,0 +1,7 @@
+{
+    "type": "minor",
+    "comment": "Pass correlationId to PlatformBrokerError, InteractionRequiredAuthError, and ServerError constructors in NativeBrokerPlugin to match the updated msal-common error signatures [#8609](https://github.com/AzureAD/microsoft-authentication-library-for-js/pull/8609)",
+    "packageName": "@azure/msal-node-extensions",
+    "email": "sameera.gajjarapu@microsoft.com",
+    "dependentChangeType": "patch"
+}

change/@azure-msal-react-correlationid-required-8609.json

@@ -0,0 +1,7 @@
+{
+    "type": "minor",
+    "comment": "Make correlationId a required parameter on ReactAuthError to match the updated msal-browser AuthError signature [#8609](https://github.com/AzureAD/microsoft-authentication-library-for-js/pull/8609)",
+    "packageName": "@azure/msal-react",
+    "email": "sameera.gajjarapu@microsoft.com",
+    "dependentChangeType": "patch"
+}

extensions/msal-node-extensions/src/broker/NativeBrokerPlugin.ts

@@ -377,7 +377,10 @@ export class NativeBrokerPlugin implements INativeBrokerPlugin {
 
         const account = await this.getAccount(request);
         if (!account) {
-            throw createClientAuthError(ClientAuthErrorCodes.noAccountFound);
+            throw createClientAuthError(
+                ClientAuthErrorCodes.noAccountFound,
+                ""
+            );
         }
 
         return new Promise((resolve, reject) => {
@@ -668,6 +671,7 @@ export class NativeBrokerPlugin implements INativeBrokerPlugin {
 
             const msalNodeRuntimeError = new PlatformBrokerError(
                 ErrorStatus[errorStatus],
+                "",
                 errorContext,
                 errorCode,
                 errorTag
@@ -680,42 +684,49 @@ export class NativeBrokerPlugin implements INativeBrokerPlugin {
                 case ErrorStatus.AccountUnusable:
                     wrappedError = new InteractionRequiredAuthError(
                         ErrorCodes.INTERATION_REQUIRED_ERROR_CODE,
+                        "",
                         msalNodeRuntimeError.message
                     );
                     break;
                 case ErrorStatus.NoNetwork:
                 case ErrorStatus.NetworkTemporarilyUnavailable:
                     wrappedError = createClientAuthError(
-                        ClientAuthErrorCodes.noNetworkConnectivity
+                        ClientAuthErrorCodes.noNetworkConnectivity,
+                        ""
                     );
                     break;
                 case ErrorStatus.ServerTemporarilyUnavailable:
                     wrappedError = new ServerError(
                         ErrorCodes.SERVER_UNAVAILABLE,
+                        "",
                         msalNodeRuntimeError.message
                     );
                     break;
                 case ErrorStatus.UserCanceled:
                     wrappedError = createClientAuthError(
-                        ClientAuthErrorCodes.userCanceled
+                        ClientAuthErrorCodes.userCanceled,
+                        ""
                     );
                     break;
                 case ErrorStatus.AuthorityUntrusted:
                     wrappedError = createClientConfigurationError(
-                        ClientConfigurationErrorCodes.untrustedAuthority
+                        ClientConfigurationErrorCodes.untrustedAuthority,
+                        ""
                     );
                     break;
                 case ErrorStatus.UserSwitched:
                     // Not an error case, if there's customer demand we can surface this as a response property
                     return null;
                 case ErrorStatus.AccountNotFound:
                     wrappedError = createClientAuthError(
-                        ClientAuthErrorCodes.noAccountFound
+                        ClientAuthErrorCodes.noAccountFound,
+                        ""
                     );
                     break;
                 default:
                     wrappedError = createClientAuthError(
-                        ClientAuthErrorCodes.platformBrokerError
+                        ClientAuthErrorCodes.platformBrokerError,
+                        ""
                     );
             }
 

extensions/msal-node-extensions/test/broker/NativeBrokerPlugin.spec.ts

@@ -88,14 +88,16 @@ if (process.platform === "win32") {
     describe("NativeBrokerPlugin", () => {
         const testPlatformBrokerError = new PlatformBrokerError(
             ErrorStatus[msalRuntimeExampleError.errorStatus],
+            "",
             msalRuntimeExampleError.errorContext,
             msalRuntimeExampleError.errorCode,
             msalRuntimeExampleError.errorTag
         );
 
         // Expected wrapped error for the default case (Unexpected status)
         const testWrappedBrokerError = createClientAuthError(
-            ClientAuthErrorCodes.platformBrokerError
+            ClientAuthErrorCodes.platformBrokerError,
+            ""
         );
         testWrappedBrokerError.platformBrokerError = testPlatformBrokerError;
 
@@ -1770,7 +1772,10 @@ if (process.platform === "win32") {
                 await expect(
                     nativeBrokerPlugin.signOut(request)
                 ).rejects.toThrowError(
-                    createClientAuthError(ClientAuthErrorCodes.noAccountFound)
+                    createClientAuthError(
+                        ClientAuthErrorCodes.noAccountFound,
+                        ""
+                    )
                 );
             });
 
@@ -2040,7 +2045,8 @@ if (process.platform === "win32") {
                     .catch((error) => {
                         expect(error).toStrictEqual(
                             createClientAuthError(
-                                ClientAuthErrorCodes.noNetworkConnectivity
+                                ClientAuthErrorCodes.noNetworkConnectivity,
+                                ""
                             )
                         );
                         done();
@@ -2100,7 +2106,8 @@ if (process.platform === "win32") {
                     .catch((error) => {
                         expect(error).toStrictEqual(
                             createClientAuthError(
-                                ClientAuthErrorCodes.noNetworkConnectivity
+                                ClientAuthErrorCodes.noNetworkConnectivity,
+                                ""
                             )
                         );
                         done();
@@ -2215,7 +2222,8 @@ if (process.platform === "win32") {
                     .catch((error) => {
                         expect(error).toStrictEqual(
                             createClientAuthError(
-                                ClientAuthErrorCodes.userCanceled
+                                ClientAuthErrorCodes.userCanceled,
+                                ""
                             )
                         );
                         done();
@@ -2274,7 +2282,8 @@ if (process.platform === "win32") {
                     .catch((error) => {
                         expect(error).toStrictEqual(
                             createClientConfigurationError(
-                                ClientConfigurationErrorCodes.untrustedAuthority
+                                ClientConfigurationErrorCodes.untrustedAuthority,
+                                ""
                             )
                         );
                         done();
@@ -2397,7 +2406,8 @@ if (process.platform === "win32") {
                     .catch((error) => {
                         expect(error).toStrictEqual(
                             createClientAuthError(
-                                ClientAuthErrorCodes.noAccountFound
+                                ClientAuthErrorCodes.noAccountFound,
+                                ""
                             )
                         );
                         done();

lib/msal-angular/src/msal.guard.ts

@@ -132,6 +132,7 @@ export class MsalGuard {
     ) {
       throw new BrowserConfigurationAuthError(
         "invalid_interaction_type",
+        "",
         "Invalid interaction type provided to MSAL Guard. InteractionType.Popup or InteractionType.Redirect must be provided in the MsalGuardConfiguration"
       );
     }

lib/msal-angular/src/msal.interceptor.spec.ts

@@ -490,7 +490,7 @@ describe("MsalInterceptor", () => {
 
     msalBroadcastService.inProgress$ = _inProgress.asObservable();
 
-    const sampleError = new AuthError("123", "message");
+    const sampleError = new AuthError("123", "", "message");
     const sampleAccessToken = {
       accessToken: "123abc",
     };
@@ -549,7 +549,7 @@ describe("MsalInterceptor", () => {
 
     msalBroadcastService.inProgress$ = _inProgress.asObservable();
 
-    const sampleError = new AuthError("123", "message");
+    const sampleError = new AuthError("123", "", "message");
 
     spyOn(
       PublicClientApplication.prototype,
@@ -593,7 +593,7 @@ describe("MsalInterceptor", () => {
 
     msalBroadcastService.inProgress$ = _inProgress.asObservable();
 
-    const sampleError = new AuthError("123", "message");
+    const sampleError = new AuthError("123", "", "message");
     const sampleAccessToken = {
       accessToken: "123abc",
     };
@@ -656,7 +656,7 @@ describe("MsalInterceptor", () => {
 
     msalBroadcastService.inProgress$ = _inProgress.asObservable();
 
-    const sampleError = new AuthError("123", "message");
+    const sampleError = new AuthError("123", "", "message");
     const sampleAccessToken = {
       accessToken: "123abc",
     };

lib/msal-angular/src/msal.interceptor.ts

@@ -65,6 +65,7 @@ export class MsalInterceptor implements HttpInterceptor {
     ) {
       throw new BrowserConfigurationAuthError(
         "invalid_interaction_type",
+        "",
         "Invalid interaction type provided to MSAL Interceptor. InteractionType.Popup, InteractionType.Redirect must be provided in the msalInterceptorConfiguration"
       );
     }

lib/msal-angular/src/msal.service.spec.ts

@@ -71,7 +71,7 @@ describe("MsalService", () => {
     });
 
     it("failure", (done) => {
-      const sampleError = new AuthError("123", "message");
+      const sampleError = new AuthError("123", "", "message");
 
       spyOn(PublicClientApplication.prototype, "loginPopup").and.returnValue(
         new Promise((resolve, reject) => {
@@ -174,7 +174,7 @@ describe("MsalService", () => {
     });
 
     it("failure", (done) => {
-      const sampleError = new AuthError("123", "message");
+      const sampleError = new AuthError("123", "", "message");
 
       spyOn(PublicClientApplication.prototype, "ssoSilent").and.returnValue(
         new Promise((resolve, reject) => {
@@ -232,7 +232,7 @@ describe("MsalService", () => {
     });
 
     it("failure", (done) => {
-      const sampleError = new AuthError("123", "message");
+      const sampleError = new AuthError("123", "", "message");
 
       spyOn(
         PublicClientApplication.prototype,
@@ -313,7 +313,7 @@ describe("MsalService", () => {
     });
 
     it("failure", (done) => {
-      const sampleError = new AuthError("123", "message");
+      const sampleError = new AuthError("123", "", "message");
 
       spyOn(
         PublicClientApplication.prototype,
@@ -381,7 +381,7 @@ describe("MsalService", () => {
     });
 
     it("failure and also resets inProgress event to none", (done) => {
-      const sampleError = new AuthError("123", "message");
+      const sampleError = new AuthError("123", "", "message");
 
       //@ts-ignore
       broadcastService._inProgress.next(InteractionStatus.Startup);