feat: acknowledge OOO request

Author: surajmaity1

constants/logs.ts

@@ -22,6 +22,8 @@ export const logType = {
   INVALID_REQUEST_TYPE: "INVALID_REQUEST_TYPE",
   PENDING_REQUEST_CAN_BE_UPDATED: "PENDING_REQUEST_CAN_BE_UPDATED",
   INVALID_REQUEST_DEADLINE: "INVALID_REQUEST_DEADLINE",
+  USER_STATUS_NOT_FOUND: "USER_STATUS_NOT_FOUND",
+  OOO_STATUS_FOUND: "OOO_STATUS_FOUND",
   ...REQUEST_LOG_TYPE,
 };
 

constants/requests.ts

@@ -25,6 +25,7 @@ export const REQUEST_LOG_TYPE = {
   REQUEST_BLOCKED: "REQUEST_BLOCKED",
   REQUEST_CANCELLED: "REQUEST_CANCELLED",
   REQUEST_UPDATED: "REQUEST_UPDATED",
+  PENDING_REQUEST_FOUND: "PENDING_REQUEST_FOUND",
   REQUEST_ALREADY_APPROVED: "REQUEST_ALREADY_APPROVED",
   REQUEST_ALREADY_REJECTED: "REQUEST_ALREADY_REJECTED",
 };
@@ -44,6 +45,9 @@ export const ERROR_WHILE_ACKNOWLEDGING_REQUEST = "Error while acknowledging requ
 
 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";
+export const USER_STATUS_NOT_FOUND = "User status not found";
+export const OOO_STATUS_ALREADY_EXIST = "Your status is already OOO. Please cancel OOO to raise new one";
 export const UNAUTHORIZED_TO_ACKNOWLEDGE_OOO_REQUEST = "Only super users are allowed to acknowledge OOO requests";
 
 export const TASK_REQUEST_MESSAGES = {

controllers/oooRequests.ts

@@ -3,12 +3,15 @@ import {
   LOG_ACTION,
   REQUEST_CREATED_SUCCESSFULLY,
   ERROR_WHILE_CREATING_REQUEST,
-  REQUEST_ALREADY_PENDING,
   REQUEST_STATE,
   REQUEST_TYPE,
   ERROR_WHILE_UPDATING_REQUEST,
   REQUEST_APPROVED_SUCCESSFULLY,
   REQUEST_REJECTED_SUCCESSFULLY,
+  UNAUTHORIZED_TO_CREATE_OOO_REQUEST,
+  REQUEST_ALREADY_PENDING,
+  USER_STATUS_NOT_FOUND,
+  OOO_STATUS_ALREADY_EXIST,
   UNAUTHORIZED_TO_ACKNOWLEDGE_OOO_REQUEST,
   ERROR_WHILE_ACKNOWLEDGING_REQUEST,
   REQUEST_DOES_NOT_EXIST,
@@ -17,50 +20,74 @@ import {
   REQUEST_ALREADY_REJECTED,
 } from "../constants/requests";
 import { statusState } from "../constants/userStatus";
+import { logType } from "../constants/logs";
 import { addLog } from "../models/logs";
-import { createRequest, getRequestByKeyValues, getRequests, updateRequest } from "../models/requests";
+import { getRequestByKeyValues, getRequests, updateRequest } from "../models/requests";
 import { createUserFutureStatus } from "../models/userFutureStatus";
-import { addFutureStatus } from "../models/userStatus";
-import { acknowledgeOOORequest } from "../services/oooRequest";
+import { getUserStatus, addFutureStatus } from "../models/userStatus";
+import { createOooRequest, validateUserStatus, acknowledgeOooRequest } from "../services/oooRequest";
 import { CustomResponse } from "../typeDefinitions/global";
-import { AcknowledgeOOORequest, OooRequestCreateRequest, OooRequestResponse, OooStatusRequest } from "../types/oooRequest";
+import { AcknowledgeOooRequest, OooRequestCreateRequest, OooRequestResponse, OooStatusRequest } from "../types/oooRequest";
 import { UpdateRequest } from "../types/requests";
 
-export const createOooRequestController = async (req: OooRequestCreateRequest, res: CustomResponse) => {
+/**
+ * Controller to handle the creation of OOO requests.
+ * 
+ * This function processes the request to create an OOO request,
+ * validates the user status, checks existing requests,
+ * and stores the new request in the database with logging.
+ * 
+ * @param {OooRequestCreateRequest} req - The Express request object containing the body with OOO details.
+ * @param {CustomResponse} res - The Express response object used to send back the response.
+ * @returns {Promise<OooRequestResponse>} Resolves to a response with the success or an error message.
+ */
+export const createOooRequestController = async (
+  req: OooRequestCreateRequest,
+  res: OooRequestResponse
+): Promise<OooRequestResponse> => {
+
   const requestBody = req.body;
-  const userId = req?.userData?.id;
+  const { id: userId, username } = req.userData;
+  const isUserPartOfDiscord = req.userData.roles.in_discord;
+  const dev = req.query.dev === "true";
 
-  if (!userId) {
-    return res.boom.unauthorized();
+  if (!dev) return res.boom.notImplemented("Feature not implemented");
+
+  if (!isUserPartOfDiscord) {
+    return res.boom.forbidden(UNAUTHORIZED_TO_CREATE_OOO_REQUEST);
   }
 
   try {
-    const latestOooRequest:OooStatusRequest = await getRequestByKeyValues({ requestedBy: userId, type: REQUEST_TYPE.OOO , state: REQUEST_STATE.PENDING });
+    const userStatus = await getUserStatus(userId);
+    const validationResponse = await validateUserStatus(userId, userStatus);
 
-    if (latestOooRequest && latestOooRequest.status === REQUEST_STATE.PENDING) {
-      return res.boom.badRequest(REQUEST_ALREADY_PENDING);
+    if (validationResponse) {
+      if (validationResponse.error === USER_STATUS_NOT_FOUND) {
+          return res.boom.notFound(validationResponse.error);
+      }
+      if (validationResponse.error === OOO_STATUS_ALREADY_EXIST) {
+          return res.boom.forbidden(validationResponse.error);
+      }
     }
 
-    const requestResult = await createRequest({ requestedBy: userId, ...requestBody });
+    const latestOooRequest: OooStatusRequest = await getRequestByKeyValues({
+        userId,
+        type: REQUEST_TYPE.OOO,
+        status: REQUEST_STATE.PENDING,
+    });
+
+    if (latestOooRequest) {
+        await addLog(logType.PENDING_REQUEST_FOUND,
+            { userId, oooRequestId: latestOooRequest.id },
+            { message: REQUEST_ALREADY_PENDING }
+        );
+        return res.boom.conflict(REQUEST_ALREADY_PENDING);
+    }
 
-    const requestLog = {
-      type: REQUEST_LOG_TYPE.REQUEST_CREATED,
-      meta: {
-        requestId: requestResult.id,
-        action: LOG_ACTION.CREATE,
-        userId: userId,
-        createdAt: Date.now(),
-      },
-      body: requestResult,
-    };
-    await addLog(requestLog.type, requestLog.meta, requestLog.body);
+    await createOooRequest(requestBody, username, userId);
 
     return res.status(201).json({
       message: REQUEST_CREATED_SUCCESSFULLY,
-      data: {
-        id: requestResult.id,
-        ...requestResult,
-      },
     });
   } catch (err) {
     logger.error(ERROR_WHILE_CREATING_REQUEST, err);
@@ -131,12 +158,12 @@ export const updateOooRequestController = async (req: UpdateRequest, res: Custom
 /**
  * Acknowledges an Out-of-Office (OOO) request
  * 
- * @param {AcknowledgeOOORequest} req - The request object.
+ * @param {AcknowledgeOooRequest} req - The request object.
  * @param {OooRequestResponse} res - The response object.
  * @returns {Promise<OooRequestResponse>} Resolves with success or failure.
  */
-export const acknowledgeOOORequestController = async (
-  req: AcknowledgeOOORequest,
+export const acknowledgeOooRequestController = async (
+  req: AcknowledgeOooRequest,
   res: OooRequestResponse,
 )
   : Promise<OooRequestResponse> => {
@@ -156,7 +183,7 @@ export const acknowledgeOOORequestController = async (
 
     try {
 
-      const response = await acknowledgeOOORequest(requestId, requestBody, superUserId);
+      const response = await acknowledgeOooRequest(requestId, requestBody, superUserId);
 
       if (response.error === REQUEST_DOES_NOT_EXIST) {
         return res.boom.notFound(REQUEST_DOES_NOT_EXIST);

controllers/requests.ts

@@ -5,8 +5,8 @@ import {
 } from "../constants/requests";
 import { getRequests } from "../models/requests";
 import { getPaginatedLink } from "../utils/helper";
-import { acknowledgeOOORequestController, createOooRequestController, updateOooRequestController } from "./oooRequests";
-import { AcknowledgeOOORequest, 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";
@@ -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);
+      await acknowledgeOooRequestController(req as AcknowledgeOooRequest, res as OooRequestResponse);
       break;
     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 { AcknowledgeOOORequest, OooRequestCreateRequest, OooRequestResponse } from "../../types/oooRequest";
+import { AcknowledgeOooRequest, OooRequestCreateRequest, OooRequestResponse } from "../../types/oooRequest";
 
 export const createOooStatusRequestValidator = async (
   req: OooRequestCreateRequest,
@@ -26,14 +26,14 @@ export const createOooStatusRequestValidator = async (
           "number.min": "until date must be greater than or equal to from date",
         })
         .required(),
-      message: joi.string().required().messages({
-        "any.required": "message is required",
-        "string.empty": "message cannot be empty",
+      reason: joi.string().required().messages({
+        "any.required": "reason is required",
+        "string.empty": "reason cannot be empty",
       }),
-      state: joi.string().valid(REQUEST_STATE.PENDING).required().messages({
-        "any.only": "state must be PENDING",
+      type: joi.string().valid(REQUEST_TYPE.OOO).required().messages({
+        "string.empty": "type cannot be empty",
+        "any.required": "type is required",
       }),
-      type: joi.string().valid(REQUEST_TYPE.OOO).required(),
     });
 
   await schema.validateAsync(req.body, { abortEarly: false });
@@ -42,13 +42,13 @@ export const createOooStatusRequestValidator = async (
 /**
  * Middleware to validate the acknowledge Out-Of-Office (OOO) request payload.
  * 
- * @param {AcknowledgeOOORequest} req - The request object containing the body to be validated.
+ * @param {AcknowledgeOooRequest} req - The request object containing the body to be validated.
  * @param {OooRequestResponse} res - The response object used to send error responses if validation fails.
  * @param {NextFunction} next - The next middleware function to call if validation succeeds.
  * @returns {Promise<void>} Resolves or sends errors.
  */
-export const acknowledgeOOORequestsValidator = async (
-  req: AcknowledgeOOORequest,
+export const acknowledgeOooRequestsValidator = async (
+  req: AcknowledgeOooRequest,
   res: OooRequestResponse,
   next: NextFunction
 ): Promise<void> => {

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 { AcknowledgeOOORequest, OooRequestCreateRequest, OooRequestResponse } from "../../types/oooRequest";
-import { acknowledgeOOORequestsValidator, 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";
@@ -125,21 +125,21 @@ export const getRequestsMiddleware = async (req: OooRequestCreateRequest, res: O
 /**
  * Validates update requests based on their type.
  * 
- * @param {UpdateOnboardingExtensionRequest | AcknowledgeOOORequest} req - Request object.
+ * @param {UpdateOnboardingExtensionRequest | AcknowledgeOooRequest} req - Request object.
  * @param {CustomResponse} res - Response object.
  * @param {NextFunction} next - Next middleware if valid.
  * @returns {Promise<void>} Resolves or sends errors.
  */
 export const updateRequestValidator = async (
-  req: UpdateOnboardingExtensionRequest | AcknowledgeOOORequest,
+  req: UpdateOnboardingExtensionRequest | AcknowledgeOooRequest,
   res: CustomResponse,
   next: NextFunction
   ): Promise<void> => {
   const type = req.body.type;
 
   switch (type) {
       case REQUEST_TYPE.OOO:
-          await acknowledgeOOORequestsValidator(
+          await acknowledgeOooRequestsValidator(
             req,
             res as OooRequestResponse, next);
           break;

models/discordactions.js

@@ -1019,7 +1019,7 @@ const getMissedProgressUpdatesUsers = async (options = {}) => {
         usersMap.set(taskAssignee, {
           tasksCount: 1,
           latestProgressCount: dateGap + 1,
-          isActive: false,
+          isOOO: false,
         });
       }
       const updateTasksIdMap = async () => {
@@ -1038,10 +1038,7 @@ const getMissedProgressUpdatesUsers = async (options = {}) => {
     const userIdChunks = chunks(Array.from(usersMap.keys()), FIRESTORE_IN_CLAUSE_SIZE);
     const userStatusSnapshotPromise = userIdChunks.map(
       async (userIdList) =>
-        await userStatusModel
-          .where("currentStatus.state", "==", userState.ACTIVE)
-          .where("userId", "in", userIdList)
-          .get()
+        await userStatusModel.where("currentStatus.state", "==", userState.OOO).where("userId", "in", userIdList).get()
     );
     const userDetailsPromise = userIdChunks.map(
       async (userIdList) =>
@@ -1055,7 +1052,7 @@ const getMissedProgressUpdatesUsers = async (options = {}) => {
 
     userStatusChunks.forEach((userStatusList) =>
       userStatusList.forEach((doc) => {
-        usersMap.get(doc.data().userId).isActive = true;
+        usersMap.get(doc.data().userId).isOOO = true;
       })
     );
 
@@ -1097,7 +1094,7 @@ const getMissedProgressUpdatesUsers = async (options = {}) => {
       const isDiscordMember = !!discordUserData;
       const shouldAddRole =
         userData.latestProgressCount === 0 &&
-        userData.isActive &&
+        !userData.isOOO &&
         isDiscordMember &&
         discordUserData.isDeveloper &&
         !discordUserData.isMaven &&