feat: ✨ Added error handling

Author: nabadeep25

README.md

@@ -144,8 +144,8 @@ src\
  |--services\       # Service 
  |--utils\          # Utility classes and functions
  |--validations\    # Request data validation schemas
- |--app.ts          # Express app
- |--server.ts       # App entry point
+ |--app.ts\         # Express app
+ |--server.ts\      # App entry point
 ```
 
 ## API Documentation
@@ -156,16 +156,16 @@ To view the list of available APIs and their specifications, run the server and
 
 List of available routes:
 
-**Auth routes**:\
-`POST api/v1/auth/register` - register\
-`POST api/v1/auth/login` - login\
-`POST api/v1/auth/forgot-password` - send reset password email\
-`POST api/v1/auth/reset-password` - reset password\
+**Auth routes**:
+`POST api/v1/auth/register` - register
+`POST api/v1/auth/login` - login
+`POST api/v1/auth/forgot-password` - send reset password email
+`POST api/v1/auth/reset-password` - reset password
 
 
-**User routes**:\
-`GET api/v1/user` - get user info\
-`PATCH api/v1/user` - update user\
+**User routes**:
+`GET api/v1/user` - get user info
+`PATCH api/v1/user` - update user
 
 
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nabadeep25/create-ts-node-app",
-  "version": "0.1.5",
+  "version": "0.2.0",
   "description": "",
   "author": "Nabadeep Thakuria",
   "bin": "bin/cli.js",

src/controllers/auth.ts

@@ -5,22 +5,23 @@ import {
   userExists,
   validatePassword,
 } from "../services/userService";
-import { Request, Response } from "express";
+import { NextFunction, Request, Response } from "express";
 import { omit } from "lodash";
 import { sign } from "../util/jwt";
 import { generateOTP, verifyOTP } from "../util/otp";
 import { sendOTP } from "../helpers/mailHelper";
+import { ApiError } from "../util/ApiError";
 const omitData = ["password"];
 
-export const registerUser = async (req: Request, res: Response) => {
+export const registerUser = async (req: Request, res: Response,next:NextFunction) => {
   try {
     let user = req.body;
     const userExist = await userExists({
       email: user.email,
       mobile: user.mobile,
     });
     if (userExist) {
-      throw new Error("Email or Mobile is alredy used");
+      throw new ApiError(400,"Email or Mobile is alredy used");
     }
     user = await createUser(user);
     const userData = omit(user?.toJSON(), omitData);
@@ -33,28 +34,22 @@ export const registerUser = async (req: Request, res: Response) => {
       msg: "User registered successfully",
     });
   } catch (err) {
-    let msg = "Internal Server Error";
-    if (err instanceof Error) {
-      msg = err.message;
-    } else if (err) {
-      msg = err;
-    }
-    return res.status(400).json({ errorMsg: msg, error: true });
+    next(err);
   }
 };
 
-export const loginUser = async (req: Request, res: Response) => {
+export const loginUser = async (req: Request, res: Response,next:NextFunction) => {
   try {
     const { email, password } = req.body;
 
     const user = await findOneUser({ email });
     if (!user) {
-      throw new Error("Email id is incorrect");
+      throw new ApiError(400,"Email id is incorrect");
     }
 
     const validPassword = await validatePassword(user.email, password);
     if (!validPassword) {
-      throw new Error("Password is incorrect");
+      throw new ApiError(400,"Password is incorrect");
     }
     const userData = omit(user?.toJSON(), omitData);
     const accessToken = sign({ ...userData });
@@ -65,24 +60,17 @@ export const loginUser = async (req: Request, res: Response) => {
       error: false,
     });
   } catch (err) {
-    console.error(err);
-    let msg = "Internal Server Error";
-    if (err instanceof Error) {
-      msg = err.message;
-    } else if (err) {
-      msg = err;
-    }
-    return res.status(400).json({ errorMsg: msg, error: true });
+    next(err);
   }
 };
 
-export const forgotPassword = async (req: Request, res: Response) => {
+export const forgotPassword = async (req: Request, res: Response,next:NextFunction) => {
   try {
     const { email } = req.body;
 
     let user = await findOneUser({ email });
     if (!user) {
-      throw new Error("Email id is incorrect");
+      throw new ApiError(400,"Email id is incorrect");
     }
     user = user?.toJSON();
     // generate otp
@@ -91,32 +79,25 @@ export const forgotPassword = async (req: Request, res: Response) => {
     const send = await sendOTP(user.email, otp);
     // send otp to email
     if (!send) {
-      throw new Error("Failed to send OTP");
+      throw new ApiError(400,"Failed to send OTP");
     }
 
     return res.status(200).json({
       msg: "Email sent sucessfully",
       error: false,
     });
   } catch (err) {
-    console.error(err);
-    let msg = "Internal Server Error";
-    if (err instanceof Error) {
-      msg = err.message;
-    } else if (err) {
-      msg = err;
-    }
-    return res.status(400).json({ errorMsg: msg, error: true });
+    next(err);
   }
 };
 
-export const resetPassword = async (req: Request, res: Response) => {
+export const resetPassword = async (req: Request, res: Response,next:NextFunction) => {
   try {
     const { email, otp, password } = req.body;
 
     let user = await findOneUser({ email });
     if (!user) {
-      throw new Error("Email id is incorrect");
+      throw new ApiError(400,"Email id is incorrect");
     }
     user = user?.toJSON();
     const isValid = verifyOTP(user.email, otp);
@@ -136,13 +117,6 @@ export const resetPassword = async (req: Request, res: Response) => {
       error: false,
     });
   } catch (err) {
-    console.error(err);
-    let msg = "Internal Server Error";
-    if (err instanceof Error) {
-      msg = err.message;
-    } else if (err) {
-      msg = err;
-    }
-    return res.status(400).json({ errorMsg: msg, error: true });
+   next(err);
   }
 };

src/controllers/user.ts

@@ -1,10 +1,10 @@
 import { findOneUser, updateUserById } from "../services/userService";
-import { Response } from "express";
+import { NextFunction, Response } from "express";
 import { omit } from "lodash";
 import { customRequest } from "../types/customDefinition";
-
+import { ApiError } from "../util/ApiError";
 const omitData = ["password"];
-export const updateUser = async (req: customRequest, res: Response) => {
+export const updateUser = async (req: customRequest, res: Response,next:NextFunction) => {
   try {
     const { id: userId } = req.user;
 
@@ -14,7 +14,7 @@ export const updateUser = async (req: customRequest, res: Response) => {
     const user = await findOneUser({ id: userId });
 
     if (!user) {
-      throw new Error("User not found");
+      throw new ApiError(400,"User not found");
     }
 
     const updated = await updateUserById(body, parseInt(userId, 10));
@@ -25,30 +25,18 @@ export const updateUser = async (req: customRequest, res: Response) => {
       error: false,
     });
   } catch (err) {
-    let msg = "Internal Server Error";
-    if (err instanceof Error) {
-      msg = err.message;
-    } else if (err) {
-      msg = err;
-    }
-    return res.status(400).json({ errorMsg: msg, error: true });
+    next(err);
   }
 };
 
-export const getUserData = async (req: customRequest, res: Response) => {
+export const getUserData = async (req: customRequest, res: Response,next:NextFunction) => {
   try {
     return res.status(200).json({
       data: req.user,
       error: false,
     });
   } catch (err) {
-    let msg = "Internal Server Error";
-    if (err instanceof Error) {
-      msg = err.message;
-    } else if (err) {
-      msg = err;
-    }
-    return res.status(400).json({ errorMsg: msg, error: true });
+    next(err);
   }
 };
 

src/util/handleError.ts

@@ -1,7 +1,7 @@
 import { ControllerFunction } from "customDefinition";
 import { NextFunction, Request, Response } from "express";
 
-export function handleError(fn: ControllerFunction) {
+export function catchError(fn: ControllerFunction) {
   return (req: Request, res: Response, next: NextFunction): void => {
     Promise.resolve(fn(req, res, next)).catch(err => next(err));
   };