refactor: controller & service layer

Author: surajmaity1

controllers/oooRequests.ts

@@ -14,10 +14,6 @@ import {
   OOO_STATUS_ALREADY_EXIST,
   UNAUTHORIZED_TO_UPDATE_REQUEST,
   ERROR_WHILE_ACKNOWLEDGING_REQUEST,
-  REQUEST_DOES_NOT_EXIST,
-  INVALID_REQUEST_TYPE,
-  REQUEST_ALREADY_APPROVED,
-  REQUEST_ALREADY_REJECTED,
 } from "../constants/requests";
 import { statusState } from "../constants/userStatus";
 import { logType } from "../constants/logs";
@@ -29,6 +25,7 @@ import { createOooRequest, validateUserStatus, acknowledgeOooRequest } from "../
 import { CustomResponse } from "../typeDefinitions/global";
 import { AcknowledgeOooRequest, OooRequestCreateRequest, OooRequestResponse, OooStatusRequest } from "../types/oooRequest";
 import { UpdateRequest } from "../types/requests";
+import { NextFunction } from "express";
 
 /**
  * Controller to handle the creation of OOO requests.
@@ -165,6 +162,7 @@ export const updateOooRequestController = async (req: UpdateRequest, res: Custom
 export const acknowledgeOooRequestController = async (
   req: AcknowledgeOooRequest,
   res: OooRequestResponse,
+  next: NextFunction
 )
   : Promise<OooRequestResponse> => {
 
@@ -186,25 +184,12 @@ export const acknowledgeOooRequestController = async (
 
       const response = await acknowledgeOooRequest(requestId, requestBody, superUserId);
 
-      if (response.error === REQUEST_DOES_NOT_EXIST) {
-        return res.boom.notFound(REQUEST_DOES_NOT_EXIST);
-      }
-      if (response.error === INVALID_REQUEST_TYPE) {
-        return res.boom.badRequest(INVALID_REQUEST_TYPE);
-      }
-      if (response.error === REQUEST_ALREADY_APPROVED) {
-        return res.boom.conflict(REQUEST_ALREADY_APPROVED);
-      }
-      if (response.error === REQUEST_ALREADY_REJECTED) {
-        return res.boom.conflict(REQUEST_ALREADY_REJECTED);
-      }
-
       return res.status(200).json({
         message: response.message,
       });
     }
     catch(error){
       logger.error(ERROR_WHILE_ACKNOWLEDGING_REQUEST, error);
-      return res.boom.badImplementation(ERROR_WHILE_ACKNOWLEDGING_REQUEST);
+      next(error);
   }
 };

controllers/requests.ts

@@ -16,7 +16,7 @@ import { createTaskRequestController } from "./taskRequestsv2";
 import { OnboardingExtensionCreateRequest, OnboardingExtensionResponse, UpdateOnboardingExtensionStateRequest } from "../types/onboardingExtension";
 import { createOnboardingExtensionRequestController, updateOnboardingExtensionRequestController, updateOnboardingExtensionRequestState } from "./onboardingExtension";
 import { UpdateOnboardingExtensionRequest } from "../types/onboardingExtension";
-import { Request } from "express";
+import { NextFunction, Request } from "express";
 
 export const createRequestController = async (
   req: OooRequestCreateRequest | ExtensionRequestRequest | TaskRequestRequest | OnboardingExtensionCreateRequest,
@@ -120,12 +120,12 @@ export const getRequestsController = async (req: any, res: any) => {
  * @param {CustomResponse} res - The response object.
  * @returns {Promise<void>} Resolves or sends an error for invalid types.
  */
-export const updateRequestBeforeAcknowledgedController = async (req: Request, res: CustomResponse) => {
+export const updateRequestBeforeAcknowledgedController = async (req: Request, res: CustomResponse, next: NextFunction) => {
   const type = req.body.type;
 
   switch(type){
     case REQUEST_TYPE.OOO:
-      await acknowledgeOooRequestController(req as AcknowledgeOooRequest, res as OooRequestResponse);
+      await acknowledgeOooRequestController(req as AcknowledgeOooRequest, res as OooRequestResponse, next);
       break;
     case REQUEST_TYPE.ONBOARDING:
       await updateOnboardingExtensionRequestController(req as UpdateOnboardingExtensionRequest, res as OnboardingExtensionResponse);

models/requests.ts

@@ -8,6 +8,7 @@ import {
   REQUEST_DOES_NOT_EXIST,
 } from "../constants/requests";
 import { getUserId } from "../utils/users";
+import { NotFound } from "http-errors";
 const SIZE = 5;
 
 export const createRequest = async (body: any) => {
@@ -74,9 +75,7 @@ export const getRequestById = async (id: string) => {
     const requestDoc = await requestModel.doc(id).get();
 
     if (!requestDoc.exists) {
-      return {
-        error: REQUEST_DOES_NOT_EXIST,
-      };
+      throw new NotFound(REQUEST_DOES_NOT_EXIST);
     }
 
     return requestDoc.data();

services/oooRequest.ts

@@ -6,7 +6,6 @@ import {
     REQUEST_STATE,
     USER_STATUS_NOT_FOUND,
     REQUEST_TYPE,
-    REQUEST_DOES_NOT_EXIST,
     REQUEST_ALREADY_APPROVED,
     REQUEST_ALREADY_REJECTED,
     REQUEST_APPROVED_SUCCESSFULLY,
@@ -18,7 +17,7 @@ import { createRequest, getRequestById } from "../models/requests";
 import { OooStatusRequest, OooStatusRequestBody } from "../types/oooRequest";
 import { UserStatus } from "../types/userStatus";
 import { addLog } from "./logService";
-import { BadRequest } from "http-errors";
+import { BadRequest, Conflict } from "http-errors";
 import { updateRequest } from "../models/requests";
 import { AcknowledgeOooRequestBody } from "../types/oooRequest";
 import { addFutureStatus } from "../models/userStatus";
@@ -114,29 +113,22 @@ export const createOooRequest = async (
  * @throws {Error} Throws an error if an issue occurs during validation.
  */
 export const validateOooAcknowledgeRequest = async (
-    requestId: string,
     requestType: string,
     requestStatus: string,
 ) => {
 
     try {
 
         if (requestType !== REQUEST_TYPE.OOO) {
-            return {
-                error: INVALID_REQUEST_TYPE
-            };
+            throw new BadRequest(INVALID_REQUEST_TYPE);
         }
 
         if (requestStatus === REQUEST_STATE.APPROVED) {
-            return {
-                error: REQUEST_ALREADY_APPROVED
-            };
+            throw new Conflict(REQUEST_ALREADY_APPROVED);
         }
 
         if (requestStatus === REQUEST_STATE.REJECTED) {
-            return {
-                error: REQUEST_ALREADY_REJECTED
-            };
+            throw new Conflict(REQUEST_ALREADY_REJECTED);
         }
     } catch (error) {
         logger.error("Error while validating OOO acknowledge request", error);
@@ -161,26 +153,12 @@ export const acknowledgeOooRequest = async (
     try {
         const requestData = await getRequestById(requestId);
 
-        if (requestData.error) {
-            logger.error("Error while acknowledging OOO request", { requestId, reason: REQUEST_DOES_NOT_EXIST });
-            return {
-                error: REQUEST_DOES_NOT_EXIST
-            };
-        }
-
-        const validationError = await validateOooAcknowledgeRequest(requestId, requestData.type, requestData.status);
-
-        if (validationError) {
-            logger.error(`Error while validating OOO acknowledge request`, { requestId, reason: validationError.error });
-            return {
-                error: validationError.error
-            };
-        }
+        await validateOooAcknowledgeRequest(requestData.type, requestData.status);
 
         const requestResult = await updateRequest(requestId, body, superUserId, REQUEST_TYPE.OOO);
 
         if ("error" in requestResult) {
-            throw BadRequest(requestResult.error);
+            throw new BadRequest(requestResult.error);
         }
 
         const [acknowledgeLogType, returnMessage] =
@@ -201,16 +179,14 @@ export const acknowledgeOooRequest = async (
         await addLog(requestLog.type, requestLog.meta, requestLog.body);
 
         if (requestResult.status === REQUEST_STATE.APPROVED) {
-            const { from, until, userId } = requestData;
-            const userFutureStatusData = {
+            await addFutureStatus({
                 requestId,
                 state: REQUEST_TYPE.OOO,
-                from,
-                endsOn: until,
-                userId,
+                from: requestData.from,
+                endsOn: requestData.until,
+                userId: requestData.userId,
                 message: body.comment,
-            };
-            await addFutureStatus(userFutureStatusData);
+            });
         }
 
         return {