feat: acknowledge OOO request

Author: surajmaity1

constants/requests.ts

@@ -41,6 +41,7 @@ export const ERROR_WHILE_UPDATING_REQUEST = "Error while updating request";
 
 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_ACKNOWLEDGE_OOO_REQUEST = "Only super users are allowed to acknowledge OOO requests";
 
 export const TASK_REQUEST_MESSAGES = {
   NOT_AUTHORIZED_TO_CREATE_REQUEST: "Not authorized to create the request",

controllers/oooRequests.ts

@@ -9,15 +9,21 @@ import {
   ERROR_WHILE_UPDATING_REQUEST,
   REQUEST_APPROVED_SUCCESSFULLY,
   REQUEST_REJECTED_SUCCESSFULLY,
+  REQUEST_DOES_NOT_EXIST,
+  UNAUTHORIZED_TO_ACKNOWLEDGE_OOO_REQUEST,
+  REQUEST_ALREADY_APPROVED,
+  REQUEST_ALREADY_REJECTED,
 } from "../constants/requests";
 import { statusState } from "../constants/userStatus";
 import { addLog } from "../models/logs";
 import { createRequest, getRequestByKeyValues, getRequests, updateRequest } from "../models/requests";
 import { createUserFutureStatus } from "../models/userFutureStatus";
 import { addFutureStatus } from "../models/userStatus";
 import { CustomResponse } from "../typeDefinitions/global";
-import { OooRequestCreateRequest, OooStatusRequest } from "../types/oooRequest";
+import { AcknowledgeOOORequest, AcknowledgeOOORequestBody, OooRequestCreateRequest, OooRequestResponse, OooStatusRequest } from "../types/oooRequest";
 import { UpdateRequest } from "../types/requests";
+import firestore from "../utils/firestore";
+const requestModel = firestore.collection("requests");
 
 export const createOooRequestController = async (req: OooRequestCreateRequest, res: CustomResponse) => {
   const requestBody = req.body;
@@ -120,3 +126,98 @@ export const updateOooRequestController = async (req: UpdateRequest, res: Custom
     return res.boom.badImplementation(ERROR_WHILE_UPDATING_REQUEST);
   }
 };
+
+export const acknowledgeOOORequestController = async (
+  req: AcknowledgeOOORequest,
+  res: OooRequestResponse)
+  : Promise<OooRequestResponse> => {
+
+    const dev = req.query.dev === "true";
+
+    if(!dev) return res.boom.notImplemented("Feature not implemented");
+
+    const requestBody = req.body;
+    const userId = req?.userData?.id;
+    const requestId = req.params.id;
+    const isSuperuser = req?.userData?.roles?.super_user === true;
+
+    if (isSuperuser === false) {
+      return res.boom.unauthorized(UNAUTHORIZED_TO_ACKNOWLEDGE_OOO_REQUEST);
+    }
+
+    try {
+      const request = await requestModel.doc(requestId).get();
+
+      if (!request.exists) {
+        return res.boom.notFound(REQUEST_DOES_NOT_EXIST);
+      }
+
+      const requestData = request.data();
+
+      if (requestData.status === REQUEST_STATE.APPROVED) {
+        return res.boom.badRequest(REQUEST_ALREADY_APPROVED);
+      } 
+      else if (requestData.status === REQUEST_STATE.REJECTED) {
+        return res.boom.badRequest(REQUEST_ALREADY_REJECTED);
+      }
+
+      if (requestData.type === REQUEST_TYPE.OOO) {
+
+        requestBody.type = REQUEST_TYPE.OOO;
+
+        const requestResult = await updateRequest(requestId, requestBody, userId, REQUEST_TYPE.OOO);
+        if ("error" in requestResult) {
+          return res.boom.badRequest(requestResult.error);
+        }
+        const [logType, returnMessage] =
+          requestResult.status === REQUEST_STATE.APPROVED
+            ? [REQUEST_LOG_TYPE.REQUEST_APPROVED, REQUEST_APPROVED_SUCCESSFULLY]
+            : [REQUEST_LOG_TYPE.REQUEST_REJECTED, REQUEST_REJECTED_SUCCESSFULLY];
+
+        const requestLog = {
+          type: logType,
+          meta: {
+            requestId: requestId,
+            action: LOG_ACTION.UPDATE,
+            userId: userId,
+            createdAt: Date.now(),
+          },
+          body: requestResult,
+        };
+        await addLog(requestLog.type, requestLog.meta, requestLog.body);
+        if (requestResult.status === REQUEST_STATE.APPROVED) {
+          const requestData = await getRequests({ id: requestId });
+
+          if (requestData) {
+            const { from, until, requestedBy, comment } = requestData as any;
+            const userFutureStatusData = {
+              requestId,
+              status: REQUEST_TYPE.OOO,
+              state: statusState.UPCOMING,
+              from,
+              endsOn: until,
+              userId: requestedBy,
+              message: comment,
+            };
+            await createUserFutureStatus(userFutureStatusData);
+            await addFutureStatus(userFutureStatusData);
+          }
+
+          return res.status(201).json({
+            message: REQUEST_APPROVED_SUCCESSFULLY,
+          });
+        }
+        return res.status(201).json({
+          message: REQUEST_REJECTED_SUCCESSFULLY,
+        });
+
+      } else {
+        return res.boom.notImplemented("Feature not implemented");
+      }
+    }
+    catch(error){
+      logger.error(ERROR_WHILE_UPDATING_REQUEST, error);
+      return res.boom.badImplementation(ERROR_WHILE_UPDATING_REQUEST);
+  }
+
+}

controllers/requests.ts

@@ -5,8 +5,8 @@ import {
 } from "../constants/requests";
 import { getRequests } from "../models/requests";
 import { getPaginatedLink } from "../utils/helper";
-import { createOooRequestController, updateOooRequestController } from "./oooRequests";
-import { OooRequestCreateRequest, OooRequestResponse } from "../types/oooRequest";
+import { acknowledgeOOORequestController, createOooRequestController, updateOooRequestController } from "./oooRequests";
+import { AcknowledgeOOORequest, OooRequestCreateRequest, OooRequestResponse } from "../types/oooRequest";
 import { CustomResponse } from "../typeDefinitions/global";
 import { ExtensionRequestRequest, ExtensionRequestResponse } from "../types/extensionRequests";
 import { createTaskExtensionRequest, updateTaskExtensionRequest } from "./extensionRequestsv2";
@@ -123,6 +123,12 @@ export const getRequestsController = async (req: any, res: any) => {
  */
 export const updateRequestBeforeAcknowledgedController = async (req: Request, res: CustomResponse) => {
   const type = req.body.type;
+
+  if (type === undefined) {
+      await acknowledgeOOORequestController(req as AcknowledgeOOORequest, res as OooRequestResponse);
+      return;
+    }
+
   switch(type){
     case REQUEST_TYPE.ONBOARDING:
       await updateOnboardingExtensionRequestController(req as UpdateOnboardingExtensionRequest, res as OnboardingExtensionResponse);

middlewares/validators/oooRequests.ts

@@ -1,7 +1,7 @@
 import joi from "joi";
 import { NextFunction } from "express";
 import { REQUEST_STATE, REQUEST_TYPE } from "../../constants/requests";
-import { OooRequestCreateRequest, OooRequestResponse } from "../../types/oooRequest";
+import { AcknowledgeOOORequest, OooRequestCreateRequest, OooRequestResponse } from "../../types/oooRequest";
 
 export const createOooStatusRequestValidator = async (
   req: OooRequestCreateRequest,
@@ -38,3 +38,35 @@ export const createOooStatusRequestValidator = async (
 
   await schema.validateAsync(req.body, { abortEarly: false });
 };
+
+export const acknowledgeOOORequestsValidator = async (
+  req: AcknowledgeOOORequest,
+  res: OooRequestResponse,
+  next: NextFunction
+) => {
+  const schema = joi
+  .object()
+  .strict()
+  .keys({
+    comment: joi.string().optional()
+      .messages({
+        "string.empty": "comment cannot be empty",
+      }),
+    status: joi
+      .string()
+      .valid(REQUEST_STATE.APPROVED, REQUEST_STATE.REJECTED)
+      .required()
+      .messages({
+        "any.only": "status must be APPROVED or REJECTED",
+      })
+  });
+
+  try {
+    await schema.validateAsync(req.body, { abortEarly: false });
+    next();
+  } catch (error) {
+    const errorMessages = error.details.map((detail:any) => detail.message);
+    logger.error(`Error while validating request payload : ${errorMessages}`);
+    res.boom.badRequest(errorMessages);
+  }
+};

middlewares/validators/requests.ts

@@ -1,8 +1,8 @@
 import joi from "joi";
 import { NextFunction } from "express";
 import { REQUEST_STATE, REQUEST_TYPE } from "../../constants/requests";
-import { OooRequestCreateRequest, OooRequestResponse } from "../../types/oooRequest";
-import { createOooStatusRequestValidator } from "./oooRequests";
+import { AcknowledgeOOORequest, OooRequestCreateRequest, OooRequestResponse } from "../../types/oooRequest";
+import { acknowledgeOOORequestsValidator, createOooStatusRequestValidator } from "./oooRequests";
 import { createExtensionRequestValidator } from "./extensionRequestsv2";
 import {createTaskRequestValidator} from "./taskRequests";
 import { ExtensionRequestRequest, ExtensionRequestResponse } from "../../types/extensionRequests";
@@ -131,11 +131,17 @@ export const getRequestsMiddleware = async (req: OooRequestCreateRequest, res: O
  * @returns {Promise<void>} Resolves or sends errors.
  */
 export const updateRequestValidator = async (
-  req: UpdateOnboardingExtensionRequest,
+  req: UpdateOnboardingExtensionRequest | AcknowledgeOOORequest,
   res: CustomResponse,
   next: NextFunction
   ): Promise<void> => {
   const type = req.body.type;
+
+  if (type === undefined) {
+    await acknowledgeOOORequestsValidator(req, res as OooRequestResponse, next);
+    return;
+  }
+
   switch (type) {
       case REQUEST_TYPE.ONBOARDING:
           await updateOnboardingExtensionRequestValidator(
@@ -145,4 +151,4 @@ export const updateRequestValidator = async (
       default:
           return res.boom.badRequest("Invalid type");
   }
-};
+};

types/oooRequest.d.ts

@@ -9,25 +9,23 @@ export type OooStatusRequest = {
   id: string;
   type: REQUEST_TYPE.OOO;
   from: number;
-  until?: number;
-  message?: string;
-  status: userState;
-  state?: REQUEST_STATE;
-  lastModifiedBy?: string;
-  requestedBy?: string;
-  createdAt?: Timestamp;
-  updatedAt?: Timestamp;
-  reason?: string;
+  until: number;
+  reason: string;
+  userState: userState;
+  status: REQUEST_STATE;
+  lastModifiedBy?: string | null;
+  requestedBy: string;
+  userId: string;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  comment?: string | null;
 };
-export type OooStatusRequestBody = {
-  type: REQUEST_TYPE.OOO;
-  requestedBy?: string;
+
+export type CreateOooRequestBody  = {
   from: number;
   until: number;
-  message: string;
-  state: REQUEST_STATE.PENDING;
-  createdAt?: Timestamp;
-  updatedAt?: Timestamp;
+  type: REQUEST_TYPE.OOO;
+  reason: string;
 };
 
 export type OooRequestUpdateBody = {
@@ -40,6 +38,23 @@ export type OooRequestUpdateBody = {
 };
 
 export type OooRequestResponse = Response & { boom: Boom };
-export type OooRequestCreateRequest = Request & { OooStatusRequestBody , userData: userData , query: RequestQuery };
+export type OooRequestCreateRequest = Request & { OooStatusRequestBody; userData: userData; query: RequestQuery };
 
 export type OooRequestUpdateRequest = Request & { oooRequestUpdateBody , userData: userData , query: RequestQuery , params: RequestParams };
+
+
+export type AcknowledgeOOORequestQuery = RequestQuery & {
+  dev?: string
+};
+
+export type AcknowledgeOOORequestBody = {
+  comment?: string;
+  status: REQUEST_STATE.APPROVED | REQUEST_STATE.REJECTED;
+}
+
+export type AcknowledgeOOORequest = Request & {
+  body: AcknowledgeOOORequestBody;
+  userData: userData;
+  query: AcknowledgeOOORequestQuery;
+  params: RequestParams;
+}