Correctly parses error codes with details messages in Firebase Auth. (#422)

* Correctly parses error codes with details messages in Firebase Auth.

```
{
 "error": {
  "errors": [
   {
    "domain": "global",
    "reason": "invalid",
    "message": "INVALID_PHONE_NUMBER : Phone number is too short"
   }
  ],
  "code": 400,
  "message": "INVALID_PHONE_NUMBER : Phone number is too short"
 }
}
```

The above will throw error code auth/invalid-phone-number and the
message will be "Phone number is too short".

* Adds CHANGELOG note for fix.

Author: bojeil-google

CHANGELOG.md

@@ -1,5 +1,6 @@
 # Unreleased
 
+- [fixed] Correctly parses error codes with details messages in Firebase Auth.
 - [fixed] Fixed optional fields in UserRecord types to be optional.
 
 # v6.4.0

src/utils/error.ts

@@ -148,10 +148,19 @@ export class FirebaseAuthError extends PrefixedFirebaseError {
     message?: string,
     rawServerResponse?: object,
   ): FirebaseAuthError {
+    // serverErrorCode could contain additional details:
+    // ERROR_CODE : Detailed message which can also contain colons
+    const colonSeparator = (serverErrorCode || '').indexOf(':');
+    let customMessage = null;
+    if (colonSeparator !== -1) {
+      customMessage = serverErrorCode.substring(colonSeparator + 1).trim();
+      serverErrorCode = serverErrorCode.substring(0, colonSeparator).trim();
+    }
     // If not found, default to internal error.
     const clientCodeKey = AUTH_SERVER_TO_CLIENT_CODE[serverErrorCode] || 'INTERNAL_ERROR';
     const error: ErrorInfo = deepCopy((AuthClientErrorCode as any)[clientCodeKey]);
-    error.message = message || error.message;
+    // Server detailed message should have highest priority.
+    error.message = customMessage || message || error.message;
 
     if (clientCodeKey === 'INTERNAL_ERROR' && typeof rawServerResponse !== 'undefined') {
       try {
@@ -330,6 +339,10 @@ export class AuthClientErrorCode {
     code: 'claims-too-large',
     message: 'Developer claims maximum payload size exceeded.',
   };
+  public static CONFIGURATION_NOT_FOUND = {
+    code: 'configuration-not-found',
+    message: 'There is no configuration corresponding to the provided identifier.',
+  };
   public static ID_TOKEN_EXPIRED = {
     code: 'id-token-expired',
     message: 'The provided Firebase ID token is expired.',
@@ -680,8 +693,8 @@ export type ProjectManagementErrorCode =
 const AUTH_SERVER_TO_CLIENT_CODE: ServerToClientCode = {
   // Claims payload is too large.
   CLAIMS_TOO_LARGE: 'CLAIMS_TOO_LARGE',
-  // Project not found.
-  CONFIGURATION_NOT_FOUND: 'PROJECT_NOT_FOUND',
+  // Configuration not found.
+  CONFIGURATION_NOT_FOUND: 'CONFIGURATION_NOT_FOUND',
   // Provided credential has insufficient permissions.
   INSUFFICIENT_PERMISSION: 'INSUFFICIENT_PERMISSION',
   // ActionCodeSettings missing continue URL.

test/unit/utils/error.spec.ts

@@ -88,6 +88,13 @@ describe('FirebaseAuthError', () => {
         expect(error.code).to.be.equal('auth/internal-error');
         expect(error.message).to.be.equal('An internal error has occurred.');
       });
+
+      it('should initialize an error from an expected server with server detailed message', () => {
+        // Error code should be separated from detailed message at first colon.
+        const error = FirebaseAuthError.fromServerError('CONFIGURATION_NOT_FOUND : more details key: value');
+        expect(error.code).to.be.equal('auth/configuration-not-found');
+        expect(error.message).to.be.equal('more details key: value');
+      });
     });
 
     describe('with message specified', () => {
@@ -104,6 +111,14 @@ describe('FirebaseAuthError', () => {
         expect(error.code).to.be.equal('auth/internal-error');
         expect(error.message).to.be.equal('An unexpected error occurred.');
       });
+
+      it('should initialize an error from an expected server with server detailed message', () => {
+        const error = FirebaseAuthError.fromServerError(
+            'CONFIGURATION_NOT_FOUND : more details',
+            'Ignored message');
+        expect(error.code).to.be.equal('auth/configuration-not-found');
+        expect(error.message).to.be.equal('more details');
+      });
     });
 
     describe('with raw server response specified', () => {