Handle MsalRuntime Error Surfacing (#8120)

Aimed to solve the problem discussed
[here:](https://identitydivision.visualstudio.com/DevEx/_git/AuthLibrariesApiReview/pullrequest/20409?path=/MSALJS/%5Bmsal-node%5D%20MsalRuntime/Surface_MsalRuntime_Errors.md)
Solution 5 implementation

Author: Ugonnaak1

change/@azure-msal-common-fa718400-1f30-4ec0-a922-9ab96a7fe335.json

@@ -0,0 +1,7 @@
+{
+  "type": "patch",
+  "comment": "error surfacing changes",
+  "packageName": "@azure/msal-common",
+  "email": "akaliugonna@microsoft.com",
+  "dependentChangeType": "patch"
+}

change/@azure-msal-node-extensions-05784d6a-75fa-4bbf-adf4-543636d3ae42.json

@@ -0,0 +1,7 @@
+{
+  "type": "patch",
+  "comment": "error surfacing changes",
+  "packageName": "@azure/msal-node-extensions",
+  "email": "akaliugonna@microsoft.com",
+  "dependentChangeType": "patch"
+}

docs/errors.md

@@ -172,6 +172,9 @@ This error occurs when MSAL.js surpasses the allotted storage limit when attempt
 
 -   The nested app auth bridge is disabled.
 
+### `platform_broker_error`
+-   An error occurred in the native broker. See the platformBrokerError property for details.
+
 ## Client configuration errors
 
 ### `redirect_uri_empty`

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

@@ -17,6 +17,7 @@ import {
     InteractionRequiredAuthError,
     Logger,
     LoggerOptions,
+    PlatformBrokerError,
     NativeRequest,
     NativeSignOutRequest,
     ServerError,
@@ -36,8 +37,6 @@ import {
     LogLevel as MsalRuntimeLogLevel,
 } from "@azure/msal-node-runtime";
 import { ErrorCodes } from "../utils/Constants.js";
-import { StringUtils } from "../utils/StringUtils.js";
-import { NativeAuthError } from "../error/NativeAuthError.js";
 import { version, name } from "../packageMetadata.js";
 
 export class NativeBrokerPlugin implements INativeBrokerPlugin {
@@ -650,58 +649,70 @@ export class NativeBrokerPlugin implements INativeBrokerPlugin {
         );
     }
 
-    private wrapError(error: unknown): NativeAuthError | Object | null {
+    private wrapError(error: unknown): PlatformBrokerError | Object | null {
         if (
             error &&
             typeof error === "object" &&
             this.isMsalRuntimeError(error)
         ) {
             const { errorCode, errorStatus, errorContext, errorTag } =
                 error as MsalRuntimeError;
-            const tagString = StringUtils.tagToString(errorTag);
-            const enhancedErrorContext = errorContext
-                ? `${errorContext} (Error Code: ${errorCode}, Tag: ${tagString})`
-                : `(Error Code: ${errorCode}, Tag: ${tagString})`;
+
+            const msalNodeRuntimeError = new PlatformBrokerError(
+                ErrorStatus[errorStatus],
+                errorContext,
+                errorCode,
+                errorTag
+            );
+
+            let wrappedError;
+
             switch (errorStatus) {
                 case ErrorStatus.InteractionRequired:
                 case ErrorStatus.AccountUnusable:
-                    return new InteractionRequiredAuthError(
+                    wrappedError = new InteractionRequiredAuthError(
                         ErrorCodes.INTERATION_REQUIRED_ERROR_CODE,
-                        enhancedErrorContext
+                        msalNodeRuntimeError.message
                     );
+                    break;
                 case ErrorStatus.NoNetwork:
                 case ErrorStatus.NetworkTemporarilyUnavailable:
-                    return createClientAuthError(
+                    wrappedError = createClientAuthError(
                         ClientAuthErrorCodes.noNetworkConnectivity
                     );
+                    break;
                 case ErrorStatus.ServerTemporarilyUnavailable:
-                    return new ServerError(
+                    wrappedError = new ServerError(
                         ErrorCodes.SERVER_UNAVAILABLE,
                         errorContext
                     );
+                    break;
                 case ErrorStatus.UserCanceled:
-                    return createClientAuthError(
+                    wrappedError = createClientAuthError(
                         ClientAuthErrorCodes.userCanceled
                     );
+                    break;
                 case ErrorStatus.AuthorityUntrusted:
-                    return createClientConfigurationError(
+                    wrappedError = createClientConfigurationError(
                         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:
-                    return createClientAuthError(
+                    wrappedError = createClientAuthError(
                         ClientAuthErrorCodes.noAccountFound
                     );
+                    break;
                 default:
-                    return new NativeAuthError(
-                        ErrorStatus[errorStatus],
-                        enhancedErrorContext,
-                        errorCode,
-                        errorTag
+                    wrappedError = createClientAuthError(
+                        ClientAuthErrorCodes.platformBrokerError
                     );
             }
+
+            wrappedError.platformBrokerError = msalNodeRuntimeError;
+            return wrappedError;
         }
         throw error;
     }

extensions/msal-node-extensions/src/error/NativeAuthError.ts

@@ -14,5 +14,4 @@ export { CrossPlatformLockOptions } from "./lock/CrossPlatformLockOptions.js";
 export { PersistenceCreator } from "./persistence/PersistenceCreator.js";
 export { IPersistenceConfiguration } from "./persistence/IPersistenceConfiguration.js";
 export { Environment } from "./utils/Environment.js";
-export { StringUtils } from "./utils/StringUtils.js";
 export { NativeBrokerPlugin } from "./broker/NativeBrokerPlugin.js";