refactoring controller responses (in progress)

server/controllers/RecipeCtl.ts

@@ -1,14 +1,14 @@
-import createError from "http-errors";
 import { IRecipe } from "../schemas";
 import { Recipe } from "../models/recipe";
+import ControllerResponse from "../util/ControllerResponse";
 const RecipeInstance = new Recipe();
 
 export default class RecipeCtl {
     async getOne(id: string) {
         try {
             const result = await RecipeInstance.getOneByID(id);
-            if (!result) throw createError('404', "Recipe not found");
+            const ok = result !== null;
-            return result;
+            return new ControllerResponse(ok, (ok ? 200 : 404), (ok ? result : "No recipe found with this ID"));
         } catch (error: any) {
             throw new Error(error);
         }
@@ -17,8 +17,8 @@ export default class RecipeCtl {
     async getAllAuthored(id: string) {
         try {
             const result = await RecipeInstance.getAllAuthored(id);
-            if (!result) throw createError('404', "No recipes found");
+            const ok = result !== null;
-            return result;
+            return new ControllerResponse(ok, (ok ? 200 : 404), (ok ? result : "No recipes found authored by user with this ID"));
         } catch (e: any) {
             throw new Error(e);
         }
@@ -35,8 +35,8 @@ export default class RecipeCtl {
     async updateOne(id: string, data: IRecipe) {
         try {
             const result = await RecipeInstance.updateOneByID(id, data);
-            if (!result) throw createError('400', "Bad request");
+            const ok = result !== null;
-            return result;
+            return new ControllerResponse(ok, (ok ? 200 : 400), (ok ? result : "Something went wrong"));
         } catch (error: any) {
             throw new Error(error);
         }
@@ -45,8 +45,8 @@ export default class RecipeCtl {
     async post(userid: string, data: IRecipe) {
         try {
             const result = await RecipeInstance.post(userid, data);
-            if (!result) throw createError('400', "Bad request");
+            const ok = result !== null;
-            return result;
+            return new ControllerResponse(ok, (ok ? 201 : 400), (ok ? result : "Something went wrong"));
         } catch (error: any) {
             throw new Error(error);
         }

server/controllers/UserCtl.ts

@@ -1,24 +1,31 @@
-import createError from 'http-errors';
 import { IUser } from '../schemas';
 import { User } from "../models/user";
+import ControllerResponse from '../util/ControllerResponse';
 const UserInstance = new User();
 
 export default class UserCtl {
+    ok?: boolean
+    code?: number
+
     async getAll() {
         try {
             const users = await UserInstance.getAllUsers();
-            if (!users) throw createError(404, "No users found");
+            const ok = users.length > 0;
-            return users;
+            const code = ok ? 200 : 404;
+            const data = ok ? users : "No users found.";
+            return new ControllerResponse(ok, code, data)
         } catch (error: any) {
             throw new Error(error);
         }
     }
 
-    async post(data: IUser) {
+    async post(body: IUser) {
         try {
-            const response = await UserInstance.post(data);
+            const response = await UserInstance.post(body);
-            // if (!response) throw createError(400, "Bad request");
+            const ok: boolean = response !== null;
-            return response;
+            const code = ok ? 201 : 400
+            const data = ok ? response : "Bad request"
+            return new ControllerResponse(ok, code, data);
         } catch (error: any) {
             throw new Error(error);
         }
@@ -27,18 +34,22 @@ export default class UserCtl {
     async getOne(id: number | string) {
         try {
             const user = await UserInstance.getOneByID(id);
-            if (!user) throw createError(404, "User not found");
+            const ok: boolean = user !== null;
-            return user;
+            const code = ok ? 200 : 404;
+            const data = ok ? user : "User by this ID not found";
+            return new ControllerResponse(ok, code, data);
         } catch (error: any) {
             throw new Error(error);
         }
     }
 
-    async updateOne(id: number | string, data: IUser) {
+    async updateOne(id: number | string, body: IUser) {
         try {
-            const result = await UserInstance.updateOneByID(id, data);
+            const result = await UserInstance.updateOneByID(id, body);
-            if (!result) throw createError(400, "Bad request");
+            const ok = result !== null;
-            return result;
+            const code = ok ? 200 : 400;
+            const data = ok ? result : "Update unsuccessful"
+            return new ControllerResponse(ok, code, data);
         } catch (error: any) {
             throw new Error(error);
         }
@@ -47,8 +58,10 @@ export default class UserCtl {
     async getFriends(id: number | string) {
         try {
             const result = await UserInstance.getFriends(id);
-            if (!result) return createError(404, "You have no friends");
+            const ok = result !== null
-            return result;
+            const code = ok ? 200 : 404;
+            const data = ok ? result : "No friends found"
+            return new ControllerResponse(ok, code, data);
         } catch (e: any) {
             throw new Error(e);
         }
@@ -57,8 +70,7 @@ export default class UserCtl {
     async getFriendshipByID(id: number | string, userid: number | string) {
         try {
             const { ok, code, result } = await UserInstance.getFriendshipByID(id, userid);
-            if (ok) return result;
+            return new ControllerResponse(ok, code, result);
-            throw createError(code, result);
         } catch (e: any) {
             throw new Error(e);
         }
@@ -67,8 +79,7 @@ export default class UserCtl {
     async getPendingFriendRequests(senderid: string | number) {
         try {
             const { ok, code, result } = await UserInstance.getPendingFriendRequests(senderid);
-            if (ok) return result;
+            return new ControllerResponse(ok, code, result);
-            throw createError(code, result);
         } catch (e: any) {
             throw new Error(e);
         }
@@ -77,8 +88,10 @@ export default class UserCtl {
     async addFriendship(userid: number | string, targetid: number | string) {
         try {
             const result = await UserInstance.addFriendship(userid, targetid);
-            if (!result) throw createError(400, "something went wrong");
+            const ok = result !== null;
-            return result;
+            const code = ok ? 201 : 400;
+            const data = ok ? result : "Something went wrong"
+            return new ControllerResponse(ok, code, data);
         } catch (e: any) {
             throw new Error(e);
         }
@@ -87,8 +100,7 @@ export default class UserCtl {
     async updateFriendship(id: number | string, userid: number | string, data: { active: boolean, pending: boolean, dateterminated?: string }) {
         try {
             const { ok, code, result } = await UserInstance.updateFriendship(id, userid, data);
-            if (ok) return result;
+            return new ControllerResponse(ok, code, result);
-            throw createError(code, result);
         } catch (e: any) {
             throw new Error(e);
         }

server/models/user.ts

@@ -11,7 +11,7 @@ export class User {
             const statement = `SELECT * FROM recipin.appusers`;
             const result = await pool.query(statement);
             if (result.rows.length) return result.rows;
-            return null;
+            return [];
         } catch (error: any) {
             throw new Error(error);
         }

server/routes/users.ts

@@ -1,6 +1,7 @@
 import { Express, Router } from 'express';
 import UserCtl from '../controllers/UserCtl';
 import { IUser } from '../schemas';
+import { CtlResponse } from '../util/types';
 const router = Router();
 const userCtl = new UserCtl();
 
@@ -9,23 +10,27 @@ export const userRoute = (app: Express) => {
 
     // get all users
     router.get('/', async (req, res) => {
-        const data = await userCtl.getAll();
+        const result: CtlResponse<IUser | string> = await userCtl.getAll();
-        res.status(200).send(data);
+        res.status(result.code).send(result.data);
     })
 
     // get, put by id
     router.get('/:userid', async (req, res, next) => {
         const { userid } = req.params;
         try {
-            const result: IUser = await userCtl.getOne(userid);
+            const result: CtlResponse<IUser | string> = await userCtl.getOne(userid);
-            const { email, id, firstname, lastname, handle } = result;
+            if (result.ok) {
-            res.status(200).send({
+                const { email, id, firstname, lastname, handle } = result.data as IUser;
-                id: id,
+                res.status(result.code).send({
-                email: email,
+                    id: id,
-                firstname: firstname,
+                    email: email,
-                lastname: lastname,
+                    firstname: firstname,
-                handle: handle
+                    lastname: lastname,
-            });
+                    handle: handle
+                });
+            } else {
+                res.status(result.code).send(result.data as string);
+            }
         } catch(e) {
             next(e);
         }

server/util/ControllerResponse.ts

@@ -0,0 +1,17 @@
+import { CtlResponse } from "./types";
+
+export default class ControllerResponse<T> implements CtlResponse<T> {
+    ok: boolean
+    code: number
+    data: T | T[] | string
+
+    constructor(ok: boolean, code: number, data: T | T[] | string) {
+        this.ok = ok
+        this.code = code
+        this.data = data
+    }
+
+    send() {
+        return { ok: this.ok, code: this.code, data: this.data }
+    }
+}

server/util/types.ts

@@ -0,0 +1,5 @@
+export interface CtlResponse<T> {
+    ok: boolean
+    code: number
+    data: T | T[] | string
+}