Merge pull request #191 from felixmosh/fix-190

Change error name to reflect the type

5 files changed, 51 insertions, 41 deletions

diff --git a/packages/browser/src/helpers/identifyAuthenticationError.ts b/packages/browser/src/helpers/identifyAuthenticationError.ts
index 7f9bd82..c994947 100644
--- a/packages/browser/src/helpers/identifyAuthenticationError.ts
+++ b/packages/browser/src/helpers/identifyAuthenticationError.ts
@@ -20,38 +20,42 @@ export function identifyAuthenticationError({
   if (error.name === 'AbortError') {
     if (options.signal === new AbortController().signal) {
       // https://www.w3.org/TR/webauthn-2/#sctn-createCredential (Step 16)
-      return new WebAuthnError('Authentication ceremony was sent an abort signal (AbortError)');
+      return new WebAuthnError('Authentication ceremony was sent an abort signal', 'AbortError');
     }
   } else if (error.name === 'NotAllowedError') {
     if (publicKey.allowCredentials?.length) {
       // https://www.w3.org/TR/webauthn-2/#sctn-discover-from-external-source (Step 17)
       // https://www.w3.org/TR/webauthn-2/#sctn-op-get-assertion (Step 6)
       return new WebAuthnError(
-        'No available authenticator recognized any of the allowed credentials (NotAllowedError)',
+        'No available authenticator recognized any of the allowed credentials',
+        'NotAllowedError',
       );
     }
 
     // https://www.w3.org/TR/webauthn-2/#sctn-discover-from-external-source (Step 18)
     // https://www.w3.org/TR/webauthn-2/#sctn-op-get-assertion (Step 7)
     return new WebAuthnError(
-      'User clicked cancel, or the authentication ceremony timed out (NotAllowedError)',
+      'User clicked cancel, or the authentication ceremony timed out',
+      'NotAllowedError',
     );
   } else if (error.name === 'SecurityError') {
     const effectiveDomain = window.location.hostname;
     if (!isValidDomain(effectiveDomain)) {
       // https://www.w3.org/TR/webauthn-2/#sctn-discover-from-external-source (Step 5)
-      return new WebAuthnError(`${window.location.hostname} is an invalid domain (SecurityError)`);
+      return new WebAuthnError(`${window.location.hostname} is an invalid domain`, 'SecurityError');
     } else if (publicKey.rpId !== effectiveDomain) {
       // https://www.w3.org/TR/webauthn-2/#sctn-discover-from-external-source (Step 6)
       return new WebAuthnError(
-        `The RP ID "${publicKey.rpId}" is invalid for this domain (SecurityError)`,
+        `The RP ID "${publicKey.rpId}" is invalid for this domain`,
+        'SecurityError',
       );
     }
   } else if (error.name === 'UnknownError') {
     // https://www.w3.org/TR/webauthn-2/#sctn-op-get-assertion (Step 1)
     // https://www.w3.org/TR/webauthn-2/#sctn-op-get-assertion (Step 12)
     return new WebAuthnError(
-      'The authenticator was unable to process the specified options, or could not create a new assertion signature (UnknownError)',
+      'The authenticator was unable to process the specified options, or could not create a new assertion signature',
+      'UnknownError',
     );
   }
 
diff --git a/packages/browser/src/helpers/identifyRegistrationError.ts b/packages/browser/src/helpers/identifyRegistrationError.ts
index 544953b..5b560e1 100644
--- a/packages/browser/src/helpers/identifyRegistrationError.ts
+++ b/packages/browser/src/helpers/identifyRegistrationError.ts
@@ -20,29 +20,31 @@ export function identifyRegistrationError({
   if (error.name === 'AbortError') {
     if (options.signal === new AbortController().signal) {
       // https://www.w3.org/TR/webauthn-2/#sctn-createCredential (Step 16)
-      return new WebAuthnError('Registration ceremony was sent an abort signal');
+      return new WebAuthnError('Registration ceremony was sent an abort signal', 'AbortError');
     }
   } else if (error.name === 'ConstraintError') {
     if (publicKey.authenticatorSelection?.requireResidentKey === true) {
       // https://www.w3.org/TR/webauthn-2/#sctn-op-make-cred (Step 4)
       return new WebAuthnError(
-        'Discoverable credentials were required but no available authenticator supported it (ConstraintError)',
+        'Discoverable credentials were required but no available authenticator supported it',
+        'ConstraintError'
       );
     } else if (publicKey.authenticatorSelection?.userVerification === 'required') {
       // https://www.w3.org/TR/webauthn-2/#sctn-op-make-cred (Step 5)
       return new WebAuthnError(
-        'User verification was required but no available authenticator supported it (ConstraintError)',
+        'User verification was required but no available authenticator supported it',
+        'ConstraintError'
       );
     }
   } else if (error.name === 'InvalidStateError') {
     // https://www.w3.org/TR/webauthn-2/#sctn-createCredential (Step 20)
     // https://www.w3.org/TR/webauthn-2/#sctn-op-make-cred (Step 3)
-    return new WebAuthnError('The authenticator was previously registered (InvalidStateError)');
+    return new WebAuthnError('The authenticator was previously registered', 'InvalidStateError');
   } else if (error.name === 'NotAllowedError') {
     // https://www.w3.org/TR/webauthn-2/#sctn-createCredential (Step 20)
     // https://www.w3.org/TR/webauthn-2/#sctn-createCredential (Step 21)
     return new WebAuthnError(
-      'User clicked cancel, or the registration ceremony timed out (NotAllowedError)',
+      'User clicked cancel, or the registration ceremony timed out', 'NotAllowedError'
     );
   } else if (error.name === 'NotSupportedError') {
     const validPubKeyCredParams = publicKey.pubKeyCredParams.filter(
@@ -52,35 +54,39 @@ export function identifyRegistrationError({
     if (validPubKeyCredParams.length === 0) {
       // https://www.w3.org/TR/webauthn-2/#sctn-createCredential (Step 10)
       return new WebAuthnError(
-        'No entry in pubKeyCredParams was of type "public-key" (NotSupportedError)',
+        'No entry in pubKeyCredParams was of type "public-key"',
+        'NotSupportedError'
       );
     }
 
     // https://www.w3.org/TR/webauthn-2/#sctn-op-make-cred (Step 2)
     return new WebAuthnError(
-      'No available authenticator supported any of the specified pubKeyCredParams algorithms (NotSupportedError)',
+      'No available authenticator supported any of the specified pubKeyCredParams algorithms',
+      'NotSupportedError'
     );
   } else if (error.name === 'SecurityError') {
     const effectiveDomain = window.location.hostname;
     if (!isValidDomain(effectiveDomain)) {
       // https://www.w3.org/TR/webauthn-2/#sctn-createCredential (Step 7)
-      return new WebAuthnError(`${window.location.hostname} is an invalid domain (SecurityError)`);
+      return new WebAuthnError(`${window.location.hostname} is an invalid domain`, 'SecurityError');
     } else if (publicKey.rp.id !== effectiveDomain) {
       // https://www.w3.org/TR/webauthn-2/#sctn-createCredential (Step 8)
       return new WebAuthnError(
-        `The RP ID "${publicKey.rp.id}" is invalid for this domain (SecurityError)`,
+        `The RP ID "${publicKey.rp.id}" is invalid for this domain`,
+        'SecurityError'
       );
     }
   } else if (error.name === 'TypeError') {
     if (publicKey.user.id.byteLength < 1 || publicKey.user.id.byteLength > 64) {
       // https://www.w3.org/TR/webauthn-2/#sctn-createCredential (Step 5)
-      return new WebAuthnError('User ID was not between 1 and 64 characters (TypeError)');
+      return new WebAuthnError('User ID was not between 1 and 64 characters', 'TypeError');
     }
   } else if (error.name === 'UnknownError') {
     // https://www.w3.org/TR/webauthn-2/#sctn-op-make-cred (Step 1)
     // https://www.w3.org/TR/webauthn-2/#sctn-op-make-cred (Step 8)
     return new WebAuthnError(
-      'The authenticator was unable to process the specified options, or could not create a new credential (UnknownError)',
+      'The authenticator was unable to process the specified options, or could not create a new credential',
+      'UnknownError'
     );
   }
 
diff --git a/packages/browser/src/helpers/structs.ts b/packages/browser/src/helpers/structs.ts
index 66b6d63..8ae01b7 100644
--- a/packages/browser/src/helpers/structs.ts
+++ b/packages/browser/src/helpers/structs.ts
@@ -16,8 +16,8 @@
  * scenarios a given error would be raised.
  */
 export class WebAuthnError extends Error {
-  constructor(message: string) {
+  constructor(message: string, name = 'WebAuthnError') {
     super(message);
-    this.name = 'WebAuthnError';
+    this.name = name;
   }
 }
diff --git a/packages/browser/src/methods/startAuthentication.test.ts b/packages/browser/src/methods/startAuthentication.test.ts
index 848e9db..725cd4e 100644
--- a/packages/browser/src/methods/startAuthentication.test.ts
+++ b/packages/browser/src/methods/startAuthentication.test.ts
@@ -219,7 +219,7 @@ describe('WebAuthnError', () => {
       const rejected = await expect(startAuthentication(goodOpts1)).rejects;
       rejected.toThrow(WebAuthnError);
       rejected.toThrow(/abort signal/i);
-      rejected.toThrow(/AbortError/);
+      rejected.toHaveProperty('name', 'AbortError');
     });
   });
 
@@ -232,7 +232,7 @@ describe('WebAuthnError', () => {
       const rejected = await expect(startAuthentication(goodOpts1)).rejects;
       rejected.toThrow(WebAuthnError);
       rejected.toThrow(/allowed credentials/i);
-      rejected.toThrow(/NotAllowedError/);
+      rejected.toHaveProperty('name', 'NotAllowedError');
     });
 
     test('should identify cancellation or timeout', async () => {
@@ -247,7 +247,7 @@ describe('WebAuthnError', () => {
       rejected.toThrow(WebAuthnError);
       rejected.toThrow(/cancel/i);
       rejected.toThrow(/timed out/i);
-      rejected.toThrow(/NotAllowedError/);
+      rejected.toHaveProperty('name', 'NotAllowedError');
     });
   });
 
@@ -273,7 +273,7 @@ describe('WebAuthnError', () => {
       rejected.toThrowError(WebAuthnError);
       rejected.toThrow(/1\.2\.3\.4/);
       rejected.toThrow(/invalid domain/i);
-      rejected.toThrow(/SecurityError/);
+      rejected.toHaveProperty('name', 'SecurityError');
     });
 
     test('should identify invalid RP ID', async () => {
@@ -285,7 +285,7 @@ describe('WebAuthnError', () => {
       rejected.toThrowError(WebAuthnError);
       rejected.toThrow(goodOpts1.rpId);
       rejected.toThrow(/invalid for this domain/i);
-      rejected.toThrow(/SecurityError/);
+      rejected.toHaveProperty('name', 'SecurityError');
     });
   });
 
@@ -299,8 +299,8 @@ describe('WebAuthnError', () => {
       rejected.toThrow(WebAuthnError);
       rejected.toThrow(/authenticator/i);
       rejected.toThrow(/unable to process the specified options/i);
-      rejected.toThrow(/could not create a new assertion signature /i);
-      rejected.toThrow(/UnknownError/);
+      rejected.toThrow(/could not create a new assertion signature/i);
+      rejected.toHaveProperty('name', 'UnknownError');
     });
   });
 });
diff --git a/packages/browser/src/methods/startRegistration.test.ts b/packages/browser/src/methods/startRegistration.test.ts
index 8322642..360884e 100644
--- a/packages/browser/src/methods/startRegistration.test.ts
+++ b/packages/browser/src/methods/startRegistration.test.ts
@@ -1,15 +1,15 @@
 import {
-  RegistrationCredential,
   AuthenticationExtensionsClientInputs,
   AuthenticationExtensionsClientOutputs,
   PublicKeyCredentialCreationOptionsJSON,
+  RegistrationCredential,
 } from '@simplewebauthn/typescript-types';
-
-import utf8StringToBuffer from '../helpers/utf8StringToBuffer';
+import { generateCustomError } from '../helpers/__jest__/generateCustomError';
 import { browserSupportsWebauthn } from '../helpers/browserSupportsWebauthn';
 import bufferToBase64URLString from '../helpers/bufferToBase64URLString';
 import { WebAuthnError } from '../helpers/structs';
-import { generateCustomError } from '../helpers/__jest__/generateCustomError';
+
+import utf8StringToBuffer from '../helpers/utf8StringToBuffer';
 
 import startRegistration from './startRegistration';
 
@@ -105,7 +105,7 @@ test('should return base64url-encoded response values', async () => {
   expect(response.response.clientDataJSON).toEqual('bW9ja0NsaWU');
 });
 
-test("should throw error if WebAuthn isn't supported", async () => {
+test('should throw error if WebAuthn isn\'t supported', async () => {
   mockSupportsWebauthn.mockReturnValue(false);
 
   await expect(startRegistration(goodOpts1)).rejects.toThrow(
@@ -214,7 +214,7 @@ describe('WebAuthnError', () => {
       rejected.toThrow(WebAuthnError);
       rejected.toThrow(/discoverable credentials were required/i);
       rejected.toThrow(/no available authenticator supported/i);
-      rejected.toThrow(/ConstraintError/);
+      rejected.toHaveProperty('name', 'ConstraintError');
     });
 
     test('should identify unsupported user verification', async () => {
@@ -231,7 +231,7 @@ describe('WebAuthnError', () => {
       rejected.toThrow(WebAuthnError);
       rejected.toThrow(/user verification was required/i);
       rejected.toThrow(/no available authenticator supported/i);
-      rejected.toThrow(/ConstraintError/);
+      rejected.toHaveProperty('name', 'ConstraintError');
     });
   });
 
@@ -245,7 +245,7 @@ describe('WebAuthnError', () => {
       rejected.toThrow(WebAuthnError);
       rejected.toThrow(/authenticator/i);
       rejected.toThrow(/previously registered/i);
-      rejected.toThrow(/InvalidStateError/);
+      rejected.toHaveProperty('name', 'InvalidStateError');
     });
   });
 
@@ -259,7 +259,7 @@ describe('WebAuthnError', () => {
       rejected.toThrow(WebAuthnError);
       rejected.toThrow(/cancel/i);
       rejected.toThrow(/timed out/i);
-      rejected.toThrow(/NotAllowedError/);
+      rejected.toHaveProperty('name', 'NotAllowedError');
     });
   });
 
@@ -278,7 +278,7 @@ describe('WebAuthnError', () => {
       rejected.toThrow(WebAuthnError);
       rejected.toThrow(/pubKeyCredParams/i);
       rejected.toThrow(/public-key/i);
-      rejected.toThrow(/NotSupportedError/);
+      rejected.toHaveProperty('name', 'NotSupportedError');
     });
 
     test('should identify no authenticator supports algs in pubKeyCredParams', async () => {
@@ -293,7 +293,7 @@ describe('WebAuthnError', () => {
       rejected.toThrow(WebAuthnError);
       rejected.toThrow(/No available authenticator/i);
       rejected.toThrow(/pubKeyCredParams/i);
-      rejected.toThrow(/NotSupportedError/);
+      rejected.toHaveProperty('name', 'NotSupportedError');
     });
   });
 
@@ -319,7 +319,7 @@ describe('WebAuthnError', () => {
       rejected.toThrowError(WebAuthnError);
       rejected.toThrow(/1\.2\.3\.4/);
       rejected.toThrow(/invalid domain/i);
-      rejected.toThrow(/SecurityError/);
+      rejected.toHaveProperty('name', 'SecurityError');
     });
 
     test('should identify invalid RP ID', async () => {
@@ -331,7 +331,7 @@ describe('WebAuthnError', () => {
       rejected.toThrowError(WebAuthnError);
       rejected.toThrow(goodOpts1.rp.id);
       rejected.toThrow(/invalid for this domain/i);
-      rejected.toThrow(/SecurityError/);
+      rejected.toHaveProperty('name', 'SecurityError');
     });
   });
 
@@ -351,7 +351,7 @@ describe('WebAuthnError', () => {
       rejected.toThrowError(WebAuthnError);
       rejected.toThrow(/user id/i);
       rejected.toThrow(/not between 1 and 64 characters/i);
-      rejected.toThrow(/TypeError/);
+      rejected.toHaveProperty('name', 'TypeError');
     });
   });
 
@@ -366,7 +366,7 @@ describe('WebAuthnError', () => {
       rejected.toThrow(/authenticator/i);
       rejected.toThrow(/unable to process the specified options/i);
       rejected.toThrow(/could not create a new credential/i);
-      rejected.toThrow(/UnknownError/);
+      rejected.toHaveProperty('name', 'UnknownError');
     });
   });
 });