refactor: ooo acknowledge controller

Author: surajmaity1

constants/requests.ts

@@ -43,6 +43,7 @@ export const ERROR_WHILE_CREATING_REQUEST = "Error while creating request";
 export const ERROR_WHILE_UPDATING_REQUEST = "Error while updating request";
 export const ERROR_WHILE_ACKNOWLEDGING_REQUEST = "Error while acknowledging request";
 
+export const REQUEST_ID_REQUIRED = "Request id is required";
 export const REQUEST_DOES_NOT_EXIST = "Request does not exist";
 export const REQUEST_ALREADY_PENDING = "Request already exists please wait for approval or rejection";
 export const UNAUTHORIZED_TO_CREATE_OOO_REQUEST = "Unauthorized to create OOO request";

controllers/oooRequests.ts

@@ -14,14 +14,16 @@ import {
   OOO_STATUS_ALREADY_EXIST,
   UNAUTHORIZED_TO_UPDATE_REQUEST,
   ERROR_WHILE_ACKNOWLEDGING_REQUEST,
+  REQUEST_ID_REQUIRED,
 } from "../constants/requests";
 import { statusState } from "../constants/userStatus";
 import { logType } from "../constants/logs";
 import { addLog } from "../models/logs";
 import { getRequestByKeyValues, getRequests, updateRequest } from "../models/requests";
 import { createUserFutureStatus } from "../models/userFutureStatus";
 import { getUserStatus, addFutureStatus } from "../models/userStatus";
-import { createOooRequest, validateUserStatus, acknowledgeOooRequest } from "../services/oooRequest";
+import { createOooRequest, validateUserStatus } from "../services/oooRequest";
+import * as oooRequestService from "../services/oooRequest";
 import { CustomResponse } from "../typeDefinitions/global";
 import { AcknowledgeOooRequest, OooRequestCreateRequest, OooRequestResponse, OooStatusRequest } from "../types/oooRequest";
 import { UpdateRequest } from "../types/requests";
@@ -159,30 +161,30 @@ export const updateOooRequestController = async (req: UpdateRequest, res: Custom
  * @param {OooRequestResponse} res - The response object.
  * @returns {Promise<OooRequestResponse>} Resolves with success or failure.
  */
-export const acknowledgeOooRequestController = async (
+export const acknowledgeOooRequest = async (
   req: AcknowledgeOooRequest,
   res: OooRequestResponse,
   next: NextFunction
 )
   : Promise<OooRequestResponse> => {
+    try {
+      const dev = req.query.dev === "true";
+      if(!dev) return res.boom.notImplemented("Feature not implemented");
 
-    const dev = req.query.dev === "true";
-
-    if(!dev) return res.boom.notImplemented("Feature not implemented");
-
-    const isSuperuser = req.userData.roles?.super_user;
-
-    if (!isSuperuser) {
-      return res.boom.forbidden(UNAUTHORIZED_TO_UPDATE_REQUEST);
-    }
+      const isSuperuser = req.userData?.roles?.super_user;
+      if (!isSuperuser) {
+        return res.boom.forbidden(UNAUTHORIZED_TO_UPDATE_REQUEST);
+      }
 
-    const requestBody = req.body;
-    const superUserId = req.userData.id;
-    const requestId = req.params.id;
+      const requestBody = req.body;
+      const superUserId = req.userData.id;
+      const requestId = req.params.id;
 
-    try {
+      if (!requestId) {
+        return res.boom.badRequest(REQUEST_ID_REQUIRED);
+      }
 
-      const response = await acknowledgeOooRequest(requestId, requestBody, superUserId);
+      const response = await oooRequestService.acknowledgeOooRequest(requestId, requestBody, superUserId);
 
       return res.status(200).json({
         message: response.message,
@@ -191,5 +193,6 @@ export const acknowledgeOooRequestController = async (
     catch(error){
       logger.error(ERROR_WHILE_ACKNOWLEDGING_REQUEST, error);
       next(error);
+      return res;
   }
 };

controllers/requests.ts

@@ -5,7 +5,7 @@ import {
 } from "../constants/requests";
 import { getRequests } from "../models/requests";
 import { getPaginatedLink } from "../utils/helper";
-import { acknowledgeOooRequestController, createOooRequestController, updateOooRequestController } from "./oooRequests";
+import { acknowledgeOooRequest, createOooRequestController, updateOooRequestController } from "./oooRequests";
 import { AcknowledgeOooRequest, OooRequestCreateRequest, OooRequestResponse } from "../types/oooRequest";
 import { CustomResponse } from "../typeDefinitions/global";
 import { ExtensionRequestRequest, ExtensionRequestResponse } from "../types/extensionRequests";
@@ -125,7 +125,7 @@ export const updateRequestBeforeAcknowledgedController = async (req: Request, re
 
   switch(type){
     case REQUEST_TYPE.OOO:
-      await acknowledgeOooRequestController(req as AcknowledgeOooRequest, res as OooRequestResponse, next);
+      await acknowledgeOooRequest(req as AcknowledgeOooRequest, res as OooRequestResponse, next);
       break;
     case REQUEST_TYPE.ONBOARDING:
       await updateOnboardingExtensionRequestController(req as UpdateOnboardingExtensionRequest, res as OnboardingExtensionResponse);

middlewares/validators/oooRequests.ts

@@ -67,7 +67,7 @@ const schema = joi
  * @param {NextFunction} next - The next middleware function to call if validation succeeds.
  * @returns {Promise<void>} Resolves or sends errors.
  */
-export const acknowledgeOooRequestsValidator = async (
+export const acknowledgeOooRequest = async (
   req: AcknowledgeOooRequest,
   res: OooRequestResponse,
   next: NextFunction

middlewares/validators/requests.ts

@@ -2,7 +2,7 @@ import joi from "joi";
 import { NextFunction } from "express";
 import { REQUEST_STATE, REQUEST_TYPE } from "../../constants/requests";
 import { AcknowledgeOooRequest, OooRequestCreateRequest, OooRequestResponse } from "../../types/oooRequest";
-import { acknowledgeOooRequestsValidator, createOooStatusRequestValidator } from "./oooRequests";
+import { acknowledgeOooRequest, createOooStatusRequestValidator } from "./oooRequests";
 import { createExtensionRequestValidator } from "./extensionRequestsv2";
 import {createTaskRequestValidator} from "./taskRequests";
 import { ExtensionRequestRequest, ExtensionRequestResponse } from "../../types/extensionRequests";
@@ -139,7 +139,7 @@ export const updateRequestValidator = async (
 
   switch (type) {
       case REQUEST_TYPE.OOO:
-          await acknowledgeOooRequestsValidator(
+          await acknowledgeOooRequest(
             req,
             res as OooRequestResponse, next);
           break;

test/unit/middlewares/oooRequests.test.ts

@@ -4,7 +4,7 @@ const { expect } = chai;
 
 import {
   createOooStatusRequestValidator,
-  acknowledgeOooRequestsValidator,
+  acknowledgeOooRequest,
 } from "./../../../middlewares/validators/oooRequests";
 import { testAcknowledgeOooRequest, validOooStatusRequests, validOooStatusUpdate } from "../../fixtures/oooRequest/oooRequest";
 import _ from "lodash";
@@ -97,7 +97,7 @@ describe("OOO Status Request Validators", function () {
         body: { ...testAcknowledgeOooRequest, type: "XYZ"}
       };
 
-      await acknowledgeOooRequestsValidator(req, res, nextSpy);
+      await acknowledgeOooRequest(req, res, nextSpy);
       expect(nextSpy.notCalled).to.be.true;
     });
 
@@ -106,7 +106,7 @@ describe("OOO Status Request Validators", function () {
         body: { ...testAcknowledgeOooRequest, status: "PENDING"}
       };
 
-      await acknowledgeOooRequestsValidator(req, res, nextSpy);
+      await acknowledgeOooRequest(req, res, nextSpy);
       expect(nextSpy.notCalled).to.be.true;
     });
 
@@ -115,7 +115,7 @@ describe("OOO Status Request Validators", function () {
         body: _.omit(testAcknowledgeOooRequest, "comment")
       };
       res = {};
-      await acknowledgeOooRequestsValidator(req, res, nextSpy);
+      await acknowledgeOooRequest(req, res, nextSpy);
       expect(nextSpy.calledOnce).to.be.true;
     });
 
@@ -124,7 +124,7 @@ describe("OOO Status Request Validators", function () {
         body: testAcknowledgeOooRequest
       };
       res = {};
-      await acknowledgeOooRequestsValidator(req, res, nextSpy);
+      await acknowledgeOooRequest(req, res, nextSpy);
       expect(nextSpy.calledOnce).to.be.true;
     });
   });

test/unit/models/requests.test.ts

@@ -1,14 +1,15 @@
 import { expect } from "chai";
 import cleanDb from "../../utils/cleanDb";
-import { createRequest, getRequests, updateRequest, getRequestByKeyValues } from "../../../models/requests";
+import { createRequest, getRequests, updateRequest, getRequestByKeyValues, getRequestById } from "../../../models/requests";
 import {
   createOooRequests,
   createOooRequests2,
+  createOooRequests3,
   createOooStatusRequests,
   updateOooApprovedRequests,
   updateOooRejectedRequests,
 } from "./../../fixtures/oooRequest/oooRequest";
-import { REQUEST_STATE, REQUEST_TYPE } from "../../../constants/requests";
+import { REQUEST_DOES_NOT_EXIST, REQUEST_STATE, REQUEST_TYPE } from "../../../constants/requests";
 import userDataFixture from "./../../fixtures/user/user";
 import addUser from "../../utils/addUser";
 const userData = userDataFixture();
@@ -179,4 +180,20 @@ describe("models/oooRequests", () => {
       expect(oooRequestData).to.be.equal(null);
     });
   });
+
+  describe("getRequestById", () => {
+
+    it("should return request using request id", async () => {
+      const oooRequest = await createRequest(createOooRequests3);
+      const response = await getRequestById(oooRequest.id);
+      expect(response).to.deep.include(createOooRequests3);
+    });
+
+    it("should return REQUEST_DOES_NOT_EXIST for invalid request id", async () => {
+      await getRequestById("111111111111").catch((error) => {
+        expect(error).to.be.not.undefined;
+        expect(error.message).to.equal(REQUEST_DOES_NOT_EXIST);
+      });
+    });
+  });
 });