Refactored Errors

errors.js

@@ -10,21 +10,21 @@ class ExtendableError {
 }
 
 /**
- * APIError is the base error that all application issued errors originate, they
- * are composed of data used by the front end and backend to handle errors
+ * TalkError is the base error that all application issued errors originate,
+ * they are composed of data used by the front end and backend to handle errors
  * consistently.
  */
-class APIError extends ExtendableError {
+class TalkError extends ExtendableError {
   constructor(
     message,
-    { status = 500, translation_key = null },
+    { status = 500, translation_key = null } = {},
     metadata = {}
   ) {
     super(message);
 
-    this.status = status;
-    this.translation_key = translation_key;
-    this.metadata = metadata;
+    this.status = status || 500;
+    this.translation_key = translation_key || null;
+    this.metadata = metadata || {};
   }
 
   toJSON() {
@@ -38,85 +38,114 @@ class APIError extends ExtendableError {
 }
 
 // ErrPasswordTooShort is returned when the password length is too short.
-const ErrPasswordTooShort = new APIError(
-  'password must be at least 8 characters',
-  {
-    status: 400,
-    translation_key: 'PASSWORD_LENGTH',
+class ErrPasswordTooShort extends TalkError {
+  constructor() {
+    super('password must be at least 8 characters', {
+      status: 400,
+      translation_key: 'PASSWORD_LENGTH',
+    });
   }
-);
+}
 
-const ErrMissingEmail = new APIError('email is required', {
-  translation_key: 'EMAIL_REQUIRED',
-  status: 400,
-});
-
-const ErrMissingPassword = new APIError('password is required', {
-  translation_key: 'PASSWORD_REQUIRED',
-  status: 400,
-});
-
-const ErrEmailTaken = new APIError('Email address already in use', {
-  translation_key: 'EMAIL_IN_USE',
-  status: 400,
-});
-
-const ErrUsernameTaken = new APIError('Username already in use', {
-  translation_key: 'USERNAME_IN_USE',
-  status: 400,
-});
-
-const ErrSameUsernameProvided = new APIError(
-  'Username provided for change is the same as current',
-  {
-    translation_key: 'SAME_USERNAME_PROVIDED',
-    status: 400,
+class ErrMissingEmail extends TalkError {
+  constructor() {
+    super('email is required', {
+      translation_key: 'EMAIL_REQUIRED',
+      status: 400,
+    });
   }
-);
+}
 
-const ErrSpecialChars = new APIError(
-  'No special characters are allowed in a username',
-  {
-    translation_key: 'NO_SPECIAL_CHARACTERS',
-    status: 400,
+class ErrMissingPassword extends TalkError {
+  constructor() {
+    super('password is required', {
+      translation_key: 'PASSWORD_REQUIRED',
+      status: 400,
+    });
   }
-);
+}
 
-const ErrMissingUsername = new APIError(
-  'A username is required to create a user',
-  {
-    translation_key: 'USERNAME_REQUIRED',
-    status: 400,
+class ErrEmailTaken extends TalkError {
+  constructor() {
+    super('Email address already in use', {
+      translation_key: 'EMAIL_IN_USE',
+      status: 400,
+    });
   }
-);
+}
+
+class ErrUsernameTaken extends TalkError {
+  constructor() {
+    super('Username already in use', {
+      translation_key: 'USERNAME_IN_USE',
+      status: 400,
+    });
+  }
+}
+
+class ErrSameUsernameProvided extends TalkError {
+  constructor() {
+    super('Username provided for change is the same as current', {
+      translation_key: 'SAME_USERNAME_PROVIDED',
+      status: 400,
+    });
+  }
+}
+
+class ErrSpecialChars extends TalkError {
+  constructor() {
+    super('No special characters are allowed in a username', {
+      translation_key: 'NO_SPECIAL_CHARACTERS',
+      status: 400,
+    });
+  }
+}
+
+class ErrMissingUsername extends TalkError {
+  constructor() {
+    super('A username is required to create a user', {
+      translation_key: 'USERNAME_REQUIRED',
+      status: 400,
+    });
+  }
+}
 
 // ErrEmailVerificationToken is returned in the event that the password reset is requested
 // without a token.
-const ErrEmailVerificationToken = new APIError('token is required', {
-  translation_key: 'EMAIL_VERIFICATION_TOKEN_INVALID',
-  status: 400,
-});
+class ErrEmailVerificationToken extends TalkError {
+  constructor() {
+    super('token is required', {
+      translation_key: 'EMAIL_VERIFICATION_TOKEN_INVALID',
+      status: 400,
+    });
+  }
+}
 
 // ErrEmailAlreadyVerified is returned when the user tries to verify an email
 // address that has already been verified.
-const ErrEmailAlreadyVerified = new APIError(
-  'email address is already verified',
-  {
-    translation_key: 'EMAIL_ALREADY_VERIFIED',
-    status: 409,
+class ErrEmailAlreadyVerified extends TalkError {
+  constructor() {
+    super('email address is already verified', {
+      translation_key: 'EMAIL_ALREADY_VERIFIED',
+      status: 409,
+    });
   }
-);
+}
 
 // ErrPasswordResetToken is returned in the event that the password reset is requested
 // without a token.
-const ErrPasswordResetToken = new APIError('token is required', {
-  translation_key: 'PASSWORD_RESET_TOKEN_INVALID',
-  status: 400,
-});
+class ErrPasswordResetToken extends TalkError {
+  constructor() {
+    super('token is required', {
+      translation_key: 'PASSWORD_RESET_TOKEN_INVALID',
+      status: 400,
+    });
+  }
+}
 
 // ErrAssetCommentingClosed is returned when a comment or action is attempted on
 // a stream where commenting has been closed.
-class ErrAssetCommentingClosed extends APIError {
+class ErrAssetCommentingClosed extends TalkError {
   constructor(closedMessage = null) {
     super(
       'asset commenting is closed',
@@ -136,7 +165,7 @@ class ErrAssetCommentingClosed extends APIError {
  * ErrAuthentication is returned when there is an error authenticating and the
  * message is provided.
  */
-class ErrAuthentication extends APIError {
+class ErrAuthentication extends TalkError {
   constructor(message = null) {
     super(
       'authentication error occurred',
@@ -154,7 +183,7 @@ class ErrAuthentication extends APIError {
 /**
  * ErrAlreadyExists is returned when an attempt to create a resource failed due to an existing one.
  */
-class ErrAlreadyExists extends APIError {
+class ErrAlreadyExists extends TalkError {
   constructor(existing = null) {
     super(
       'resource already exists',
@@ -171,121 +200,179 @@ class ErrAlreadyExists extends APIError {
 
 // ErrContainsProfanity is returned in the event that the middleware detects
 // profanity/banned/suspect words in the payload.
-const ErrContainsProfanity = new APIError(
-  'This username contains elements which are not permitted in our community. If you think this is in error, please contact us or try again.',
-  {
-    translation_key: 'PROFANITY_ERROR',
-    status: 400,
+class ErrContainsProfanity extends TalkError {
+  constructor(phrase) {
+    super(
+      'This username contains elements which are not permitted in our community. If you think this is in error, please contact us or try again.',
+      {
+        translation_key: 'PROFANITY_ERROR',
+        status: 400,
+      },
+      { phrase }
+    );
   }
-);
+}
 
-const ErrNotFound = new APIError('not found', {
-  translation_key: 'NOT_FOUND',
-  status: 404,
-});
+class ErrNotFound extends TalkError {
+  constructor() {
+    super('not found', {
+      translation_key: 'NOT_FOUND',
+      status: 404,
+    });
+  }
+}
 
-const ErrInvalidAssetURL = new APIError('asset_url is invalid', {
-  translation_key: 'INVALID_ASSET_URL',
-  status: 400,
-});
+class ErrInvalidAssetURL extends TalkError {
+  constructor() {
+    super('asset_url is invalid', {
+      translation_key: 'INVALID_ASSET_URL',
+      status: 400,
+    });
+  }
+}
 
 // ErrNotAuthorized is an error that is returned in the event an operation is
 // deemed not authorized.
-const ErrNotAuthorized = new APIError('not authorized', {
-  translation_key: 'NOT_AUTHORIZED',
-  status: 401,
-});
+class ErrNotAuthorized extends TalkError {
+  constructor() {
+    super('not authorized', {
+      translation_key: 'NOT_AUTHORIZED',
+      status: 401,
+    });
+  }
+}
 
 // ErrSettingsNotInit is returned when the settings are required but not
 // initialized.
-const ErrSettingsNotInit = new Error(
-  'Talk is currently not setup. Please proceed to our web installer at $ROOT_URL/admin/install or run ./bin/cli-setup. Visit https://docs.coralproject.net/talk/ for more information on installation and configuration instructions'
-);
+class ErrSettingsNotInit extends TalkError {
+  constructor() {
+    super(
+      'Talk is currently not setup. Please proceed to our web installer at $ROOT_URL/admin/install or run ./bin/cli-setup. Visit https://docs.coralproject.net/talk/ for more information on installation and configuration instructions'
+    );
+  }
+}
 
 // ErrSettingsInit is returned when the setup endpoint is hit and we are already
 // initialized.
-const ErrSettingsInit = new APIError('settings are already initialized', {
-  status: 500,
-});
+class ErrSettingsInit extends TalkError {
+  constructor() {
+    super('settings are already initialized', {
+      status: 500,
+    });
+  }
+}
 
 // ErrInstallLock is returned when the setup endpoint is hit and the install
 // lock is present.
-const ErrInstallLock = new APIError('install lock active', {
-  status: 500,
-});
+class ErrInstallLock extends TalkError {
+  constructor() {
+    super('install lock active', {
+      status: 500,
+    });
+  }
+}
 
 // ErrPermissionUpdateUsername is returned when the user does not have permission to update their username.
-const ErrPermissionUpdateUsername = new APIError(
-  'You do not have permission to update your username.',
-  {
-    translation_key: 'EDIT_USERNAME_NOT_AUTHORIZED',
-    status: 403,
+class ErrPermissionUpdateUsername extends TalkError {
+  constructor() {
+    super('You do not have permission to update your username.', {
+      translation_key: 'EDIT_USERNAME_NOT_AUTHORIZED',
+      status: 403,
+    });
   }
-);
+}
 
 // ErrLoginAttemptMaximumExceeded is returned when the login maximum is exceeded.
-const ErrLoginAttemptMaximumExceeded = new APIError(
-  'You have made too many incorrect password attempts.',
-  {
-    translation_key: 'LOGIN_MAXIMUM_EXCEEDED',
-    status: 429,
+class ErrLoginAttemptMaximumExceeded extends TalkError {
+  constructor() {
+    super('You have made too many incorrect password attempts.', {
+      translation_key: 'LOGIN_MAXIMUM_EXCEEDED',
+      status: 429,
+    });
   }
-);
+}
 
 // ErrEditWindowHasEnded is returned when the edit window has expired.
-const ErrEditWindowHasEnded = new APIError('Edit window is over', {
-  translation_key: 'EDIT_WINDOW_ENDED',
-  status: 403,
-});
+class ErrEditWindowHasEnded extends TalkError {
+  constructor() {
+    super('Edit window is over', {
+      translation_key: 'EDIT_WINDOW_ENDED',
+      status: 403,
+    });
+  }
+}
 
 // ErrCommentTooShort is returned when the comment is too short.
-const ErrCommentTooShort = new APIError('Comment was too short', {
-  translation_key: 'COMMENT_TOO_SHORT',
-  status: 400,
-});
+class ErrCommentTooShort extends TalkError {
+  constructor(length) {
+    super(
+      'Comment was too short',
+      {
+        translation_key: 'COMMENT_TOO_SHORT',
+        status: 400,
+      },
+      { length }
+    );
+  }
+}
 
 // ErrAssetURLAlreadyExists is returned when a rename operation is requested
 // but an asset already exists with the new url.
-const ErrAssetURLAlreadyExists = new APIError(
-  'Asset URL already exists, cannot rename',
-  {
-    translation_key: 'ASSET_URL_ALREADY_EXISTS',
-    status: 409,
+class ErrAssetURLAlreadyExists extends TalkError {
+  constructor() {
+    super('Asset URL already exists, cannot rename', {
+      translation_key: 'ASSET_URL_ALREADY_EXISTS',
+      status: 409,
+    });
   }
-);
+}
 
 // ErrNotVerified is returned when a user tries to login with valid credentials
 // but their email address is not yet verified.
-const ErrNotVerified = new APIError(
-  'User does not have a verified email address',
-  {
-    translation_key: 'EMAIL_NOT_VERIFIED',
-    status: 401,
+class ErrNotVerified extends TalkError {
+  constructor() {
+    super('User does not have a verified email address', {
+      translation_key: 'EMAIL_NOT_VERIFIED',
+      status: 401,
+    });
   }
-);
+}
 
-const ErrMaxRateLimit = new APIError('Rate limit exceeded', {
-  translation_key: 'RATE_LIMIT_EXCEEDED',
-  status: 429,
-});
+class ErrMaxRateLimit extends TalkError {
+  constructor(max, tries) {
+    super(
+      'Rate limit exceeded',
+      {
+        translation_key: 'RATE_LIMIT_EXCEEDED',
+        status: 429,
+      },
+      { tries, max }
+    );
+  }
+}
 
 // ErrCannotIgnoreStaff is returned when a user tries to ignore a staff member.
-const ErrCannotIgnoreStaff = new APIError('Cannot ignore staff members.', {
-  translation_key: 'CANNOT_IGNORE_STAFF',
-  status: 400,
-});
+class ErrCannotIgnoreStaff extends TalkError {
+  constructor() {
+    super('Cannot ignore staff members.', {
+      translation_key: 'CANNOT_IGNORE_STAFF',
+      status: 400,
+    });
+  }
+}
 
 // ErrParentDoesNotVisible is returned when the user tries to reply to a comment
 // that isn't visible.
-const ErrParentDoesNotVisible = new APIError(
-  'Cannot reply to a comment that is not visible',
-  {
-    translation_key: 'COMMENT_PARENT_NOT_VISIBLE',
+class ErrParentDoesNotVisible extends TalkError {
+  constructor() {
+    super('Cannot reply to a comment that is not visible', {
+      translation_key: 'COMMENT_PARENT_NOT_VISIBLE',
+    });
   }
-);
+}
 
 module.exports = {
-  APIError,
+  TalkError,
   ErrAlreadyExists,
   ErrAssetCommentingClosed,
   ErrAssetURLAlreadyExists,