Merge pull request #131 from Code-Hammers/CHE-169/subtask/Add-Express…

…-Async-Errors-Dep

[CHE-169] Add Express Async Errors Dep

package.json

@@ -39,6 +39,7 @@
     "cookie-parser": "^1.4.6",
     "dotenv": "^16.4.5",
     "express": "^4.19.2",
+    "express-async-errors": "^3.1.1",
     "express-async-handler": "^1.2.0",
     "jsonwebtoken": "^9.0.2",
     "mongoose": "^8.3.4",

scripts/docker-remove-all.sh

@@ -29,7 +29,7 @@ fi
 
 # Remove images
 echo -e "${CYAN}Removing existing dev images from local environment:${NC}"
-IMAGES=$(docker images codehammers/$IMAGE_SEARCH_NAME_DEV* -q)
+IMAGES=$(docker images codehammers/*$IMAGE_SEARCH_NAME_DEV* -q)
 REMOVEDIMAGES=0
 if [ ! -z "$IMAGES" ]; then
   docker rmi $IMAGES --force

server/errors/badRequestError.ts

@@ -0,0 +1,15 @@
+import { CustomError } from './customError';
+
+export class BadRequestError extends CustomError {
+  statusCode = 400;
+
+  constructor(public message: string) {
+    super(`❌ Bad Request Error: ${message}`);
+
+    Object.setPrototypeOf(this, BadRequestError.prototype);
+  }
+
+  serializeErrors() {
+    return [{ message: this.message }];
+  }
+}

server/errors/customError.ts

@@ -0,0 +1,22 @@
+/*
+- This is an abstract class (cannot be instantiated) for all of our error types to inherit from
+- enforces that all of our error classes include:
+    1) statusCode & message (mostly used for console.logs) properties
+    2) serializeErrors method to ensure all errors are formatted the same
+*/
+export abstract class CustomError extends Error {
+  abstract statusCode: number;
+
+  constructor(message: string) {
+    super(message);
+
+    /*
+    This step is bc we are inheriting from a built in JS class
+    Helps correctly set the prototype chain of our custom error classes
+    Only really necessary if we are targeting es5 when transpiling typescript
+    */
+    Object.setPrototypeOf(this, CustomError.prototype);
+  }
+
+  abstract serializeErrors(): { message: string; field?: string }[];
+}

server/errors/databaseConnectionError.ts

@@ -0,0 +1,15 @@
+import { CustomError } from './customError';
+
+export class DatabaseConnectionError extends CustomError {
+  statusCode = 500;
+
+  constructor() {
+    super('❌ Database Connection Error');
+
+    Object.setPrototypeOf(this, DatabaseConnectionError.prototype);
+  }
+
+  serializeErrors() {
+    return [{ message: 'Something went wrong, please try again later' }];
+  }
+}

server/errors/internalError.ts

@@ -0,0 +1,15 @@
+import { CustomError } from './customError';
+
+export class InternalError extends CustomError {
+  statusCode = 500;
+
+  constructor() {
+    super('❌ Internal Error');
+
+    Object.setPrototypeOf(this, InternalError.prototype);
+  }
+
+  serializeErrors() {
+    return [{ message: 'Something went wrong, please try again later' }];
+  }
+}

server/errors/notAuthorizedError.ts

@@ -0,0 +1,15 @@
+import { CustomError } from './customError';
+
+export class NotAuthorizedError extends CustomError {
+  statusCode = 401;
+
+  constructor() {
+    super('❌ Not Authorized');
+
+    Object.setPrototypeOf(this, NotAuthorizedError.prototype);
+  }
+
+  serializeErrors() {
+    return [{ message: 'Not Authorized' }];
+  }
+}

server/errors/notFoundError.ts

@@ -0,0 +1,15 @@
+import { CustomError } from './customError';
+
+export class NotFoundError extends CustomError {
+  statusCode = 404;
+
+  constructor() {
+    super('❌ Not Found Error');
+
+    Object.setPrototypeOf(this, NotFoundError.prototype);
+  }
+
+  serializeErrors() {
+    return [{ message: 'Not Found' }];
+  }
+}

server/errors/requestValidationError.ts

@@ -0,0 +1,22 @@
+import { CustomError } from './customError';
+import { ValidationError } from './validationError';
+
+export class RequestValidationError extends CustomError {
+  statusCode = 400;
+
+  /* 
+  when instantiating, accepts an array of ValidationError's as an argument
+  in case 1 or more validations fail
+  */
+  constructor(public errors: ValidationError[]) {
+    super('❌ Request Validation Failed');
+
+    Object.setPrototypeOf(this, RequestValidationError.prototype);
+  }
+
+  serializeErrors() {
+    return this.errors.map(({ message, field }) => {
+      return { message, field };
+    });
+  }
+}

server/errors/validationError.ts

@@ -0,0 +1,11 @@
+export class ValidationError extends Error {
+  field: string;
+  // use field argument for info on what failed validation, eg. "email" or "password"
+  constructor(message: string, field: string) {
+    super(message);
+
+    this.field = field;
+
+    Object.setPrototypeOf(this, ValidationError.prototype);
+  }
+}

server/index.ts

@@ -1,5 +1,6 @@
 import path from 'path';
 import express, { Request, Response, Application } from 'express';
+import 'express-async-errors';
 import userRoutes from './routes/userRoutes';
 import profileRoutes from './routes/profileRoutes';
 import authRoutes from './routes/authRoutes';