Dev to Main Sync (#2336)

* feat: Add api to create onboarding extension request from discord server (#2307)

* fix:added onboarding type in request

* feat: added types for onboarding extension request

* feat: added validator and skip-authenticate middleware

* fix: added missing field in user type

* feat: added controller for handling the create onboarding extension request feature

* fix: remove requestedBy field because validation for super-users is done before hitting this api

* refactor: moved constant messages from controller

* fix: remove super-users validation check as it is done before making this api call

* fix: create newEndsOn from current date when deadline has missed

* fix: wrap schema validation logic in try-catch block

* chore: refactor varibale name for better readability

* chore: refactor new deadline calculation logic in a separate utils file for reuse

* chore: use utils function to calculate days to milliseconds

* feat: added utils function to validate date

* fix: return error response for invalid date

* fix: return forbidden response for non-onboarding user

* chore: added semicolon for consistent code practise

* chore: added jsDoc for functions and refactor import statment

* fix: import addLog from service file and fix lint issue

* Add tests for create onboarding extension request api (#2306)

* feat: added tests for middlewares

* feat:added tests for controller

* refactor: create middleware in beforeEach hook

* refactor: remove requestBy field and super-users validation tests

* fix: expectation message as test was failing

* fix: change order of middleware creation as test was failing

* fix: assert statement and mock value

* feat: added tests for handling edges cases and fixed existing test

* chore: correct test name

* chore: fix lint issue

* feat: Integrate userData into Progresses API to reduce redundant calls (#2311)

* initial

* fix typos

* using batches to fetch userIds

* refactor the function

* added test for dev false case

* added unit tests

* fix response body containing email

---------

Co-authored-by: Achintya Chatterjee <[email protected]>
Co-authored-by: Prakash Choudhary <[email protected]>

* fix: Changed status code to 409 for sending Conflict response (#2339)

* chore(#2342) - upgraded dependency packages

* Revert "chore(#2342) - upgraded dependency packages" (#2343)

This reverts commit 5bc49c6.

---------

Co-authored-by: Pankaj <[email protected]>
Co-authored-by: Anuj Chhikara <[email protected]>
Co-authored-by: Prakash Choudhary <[email protected]>
Co-authored-by: Vikas Singh <[email protected]>
Co-authored-by: Yash Raj <[email protected]>

Author: 6 people

constants/requests.ts

@@ -15,6 +15,7 @@ export const REQUEST_TYPE = {
   EXTENSION: "EXTENSION",
   TASK: "TASK",
   ALL: "ALL",
+  ONBOARDING: "ONBOARDING",
 };
 
 export const REQUEST_LOG_TYPE = {
@@ -53,3 +54,6 @@ export const TASK_REQUEST_MESSAGES = {
   ERROR_CREATING_TASK_REQUEST: "Error while creating task request",
   TASK_REQUEST_UPDATED_SUCCESS: "Task request updated successfully",
 };
+
+export const ONBOARDING_REQUEST_CREATED_SUCCESSFULLY = "Onboarding extension request created successfully"
+export const UNAUTHORIZED_TO_CREATE_ONBOARDING_EXTENSION_REQUEST = "Only super user and onboarding user are authorized to create an onboarding extension request"

controllers/onboardingExtension.ts

@@ -0,0 +1,124 @@
+import {
+    ERROR_WHILE_CREATING_REQUEST,
+    LOG_ACTION,
+    ONBOARDING_REQUEST_CREATED_SUCCESSFULLY,
+    REQUEST_ALREADY_PENDING,
+    REQUEST_LOG_TYPE,
+    REQUEST_STATE,
+    REQUEST_TYPE,
+    UNAUTHORIZED_TO_CREATE_ONBOARDING_EXTENSION_REQUEST,
+} from "../constants/requests";
+import { userState } from "../constants/userStatus";
+import { addLog } from "../services/logService";
+import { createRequest, getRequestByKeyValues } from "../models/requests";
+import { fetchUser } from "../models/users";
+import { getUserStatus } from "../models/userStatus";
+import { User } from "../typeDefinitions/users";
+import { 
+    CreateOnboardingExtensionBody, 
+    OnboardingExtension, 
+    OnboardingExtensionCreateRequest, 
+    OnboardingExtensionResponse 
+} from "../types/onboardingExtension";
+import { convertDateStringToMilliseconds, getNewDeadline } from "../utils/requests";
+import { convertDaysToMilliseconds } from "../utils/time";
+
+/**
+* Controller to handle the creation of onboarding extension requests.
+*
+* This function processes the request to create an extension for the onboarding period,
+* validates the user status, checks existing requests, calculates new deadlines,
+* and stores the new request in the database with logging.
+*
+* @param {OnboardingExtensionCreateRequest} req - The Express request object containing the body with extension details.
+* @param {OnboardingExtensionResponse} res - The Express response object used to send back the response.
+* @returns {Promise<OnboardingExtensionResponse>} Resolves to a response with the status and data or an error message.
+*/
+export const createOnboardingExtensionRequestController = async (req: OnboardingExtensionCreateRequest, res: OnboardingExtensionResponse): Promise<OnboardingExtensionResponse> => {
+    try {
+
+        const data = req.body as CreateOnboardingExtensionBody;
+        const {user, userExists} = await fetchUser({discordId: data.userId});
+        
+        if(!userExists) {
+            return res.boom.notFound("User not found");
+        }
+
+        const { id: userId, discordJoinedAt, username} = user as User;
+        const { data: userStatus } =  await getUserStatus(userId);
+
+        if(!userStatus || userStatus.currentStatus.state != userState.ONBOARDING){
+            return res.boom.forbidden(UNAUTHORIZED_TO_CREATE_ONBOARDING_EXTENSION_REQUEST);
+        }
+
+        const latestExtensionRequest: OnboardingExtension = await getRequestByKeyValues({
+            userId: userId,
+            type: REQUEST_TYPE.ONBOARDING
+        });
+
+        if(latestExtensionRequest && latestExtensionRequest.state === REQUEST_STATE.PENDING){
+            return res.boom.conflict(REQUEST_ALREADY_PENDING);
+        }
+        
+        const millisecondsInThirtyOneDays = convertDaysToMilliseconds(31);
+        const numberOfDaysInMillisecond = convertDaysToMilliseconds(data.numberOfDays);
+        const { isDate, milliseconds: discordJoinedDateInMillisecond } = convertDateStringToMilliseconds(discordJoinedAt);
+
+        if(!isDate){
+            logger.error(ERROR_WHILE_CREATING_REQUEST, "Invalid date");
+            return res.boom.badImplementation(ERROR_WHILE_CREATING_REQUEST);
+        }
+
+        let requestNumber: number;
+        let oldEndsOn: number;
+        const currentDate = Date.now();
+
+        if(!latestExtensionRequest){
+            requestNumber = 1;
+            oldEndsOn = discordJoinedDateInMillisecond + millisecondsInThirtyOneDays;
+        }else if(latestExtensionRequest.state === REQUEST_STATE.REJECTED) {
+            requestNumber = latestExtensionRequest.requestNumber + 1;
+            oldEndsOn = latestExtensionRequest.oldEndsOn;
+        }else{
+            requestNumber = latestExtensionRequest.requestNumber + 1;
+            oldEndsOn = latestExtensionRequest.newEndsOn;
+        }
+        
+        const newEndsOn = getNewDeadline(currentDate, oldEndsOn, numberOfDaysInMillisecond);
+        
+        const onboardingExtension = await createRequest({
+            type: REQUEST_TYPE.ONBOARDING,
+            state: REQUEST_STATE.PENDING,
+            userId: userId,
+            requestedBy: username,
+            oldEndsOn: oldEndsOn,
+            newEndsOn: newEndsOn,
+            reason: data.reason,
+            requestNumber: requestNumber,
+        });
+
+        const onboardingExtensionLog = {
+            type: REQUEST_LOG_TYPE.REQUEST_CREATED,
+            meta: {
+                requestId: onboardingExtension.id,
+                action: LOG_ACTION.CREATE,
+                userId: userId,
+                createdAt: Date.now(),
+            },
+            body: onboardingExtension,
+        };
+
+        await addLog(onboardingExtensionLog.type, onboardingExtensionLog.meta, onboardingExtensionLog.body);
+
+        return res.status(201).json({
+            message: ONBOARDING_REQUEST_CREATED_SUCCESSFULLY,  
+            data: {
+                id: onboardingExtension.id,
+                ...onboardingExtension,
+            }
+        });
+    }catch (err) {
+        logger.error(ERROR_WHILE_CREATING_REQUEST, err);
+        return res.boom.badImplementation(ERROR_WHILE_CREATING_REQUEST);
+    }
+};

controllers/progresses.js

@@ -217,7 +217,7 @@ const getProgressRangeData = async (req, res) => {
 
 const getProgressBydDateController = async (req, res) => {
   try {
-    const data = await getProgressByDate(req.params);
+    const data = await getProgressByDate(req.params, req.query);
     return res.json({
       message: PROGRESS_DOCUMENT_RETRIEVAL_SUCCEEDED,
       data,

controllers/requests.ts

@@ -13,9 +13,11 @@ import { createTaskExtensionRequest, updateTaskExtensionRequest } from "./extens
 import { UpdateRequest } from "../types/requests";
 import { TaskRequestRequest } from "../types/taskRequests";
 import { createTaskRequestController } from "./taskRequestsv2";
+import { OnboardingExtensionCreateRequest, OnboardingExtensionResponse } from "../types/onboardingExtension";
+import { createOnboardingExtensionRequestController } from "./onboardingExtension";
 
 export const createRequestController = async (
-  req: OooRequestCreateRequest | ExtensionRequestRequest | TaskRequestRequest,
+  req: OooRequestCreateRequest | ExtensionRequestRequest | TaskRequestRequest | OnboardingExtensionCreateRequest,
   res: CustomResponse
 ) => {
   const type = req.body.type;
@@ -26,6 +28,8 @@ export const createRequestController = async (
       return await createTaskExtensionRequest(req as ExtensionRequestRequest, res as ExtensionRequestResponse);
     case REQUEST_TYPE.TASK:
       return await createTaskRequestController(req as TaskRequestRequest, res as CustomResponse);
+    case REQUEST_TYPE.ONBOARDING:
+      return await createOnboardingExtensionRequestController(req as OnboardingExtensionCreateRequest, res as OnboardingExtensionResponse);
     default:
       return res.boom.badRequest("Invalid request type");
   }

middlewares/skipAuthenticateForOnboardingExtension.ts

@@ -0,0 +1,30 @@
+import { NextFunction, Request, Response } from "express"
+import { REQUEST_TYPE } from "../constants/requests";
+/**
+* Middleware to selectively authenticate or verify Discord bot based on the request type.
+* Specifically handles requests for onboarding extensions by skipping authentication.
+*
+* @param {Function} authenticate - The authentication middleware to apply for general requests.
+* @param {Function} verifyDiscordBot - The middleware to verify requests from a Discord bot.
+* @returns {Function} A middleware function that processes the request based on its type.
+*
+* @example
+* app.use(skipAuthenticateForOnboardingExtensionRequest(authenticate, verifyDiscordBot));
+*/
+export const skipAuthenticateForOnboardingExtensionRequest = (authenticate, verifyDiscordBot) => {
+    return async (req: Request, res: Response, next: NextFunction) => {
+        const type = req.body.type;
+        const dev = req.query.dev;
+
+        if(type === REQUEST_TYPE.ONBOARDING){
+            if (dev != "true"){
+                return res.status(501).json({
+                    message: "Feature not implemented"
+                })
+            }
+            return await verifyDiscordBot(req, res, next);
+        }
+
+        return await authenticate(req, res, next)
+    }
+}

middlewares/validators/onboardingExtensionRequest.ts

@@ -0,0 +1,42 @@
+import joi from "joi";
+import { NextFunction } from "express";
+import { REQUEST_TYPE } from "../../constants/requests";
+import { OnboardingExtensionCreateRequest, OnboardingExtensionResponse } from "../../types/onboardingExtension";
+
+export const createOnboardingExtensionRequestValidator = async (
+  req: OnboardingExtensionCreateRequest,
+  _res: OnboardingExtensionResponse,
+  _next: NextFunction
+) => {
+
+  const schema = joi
+    .object()
+    .strict()
+    .keys({
+      numberOfDays: joi.number().required().positive().integer().min(1).messages({
+        "number.base": "numberOfDays must be a number",
+        "any.required": "numberOfDays is required",
+        "number.positive": "numberOfDays must be positive",
+        "number.min": "numberOfDays must be greater than zero",
+        "number.integer": "numberOfDays must be a integer"
+      }),
+      reason: joi.string().required().messages({
+        "string.empty": "reason cannot be empty",
+        "any.required": "reason is required",
+      }),
+      type: joi.string().valid(REQUEST_TYPE.ONBOARDING).required().messages({
+        "string.empty": "type cannot be empty",
+        "any.required": "type is required",
+      }),
+      userId: joi.string().required().messages({
+        "string.empty": "userId cannot be empty",
+        "any.required": "userId is required"
+      })
+    });
+  try{
+    await schema.validateAsync(req.body, { abortEarly: false });
+  }catch(error){
+    logger.error(`Error while validating request payload`, error);
+    throw error;
+  }
+};

middlewares/validators/progresses.js

@@ -63,6 +63,9 @@ const validateGetProgressRecordsQuery = async (req, res, next) => {
       taskId: joi.string().optional().allow("").messages({
         "string.base": "taskId must be a string",
       }),
+      dev: joi.boolean().optional().messages({
+        "boolean.base": "dev must be a boolean value (true or false).",
+      }),
       orderBy: joi
         .string()
         .optional()
@@ -92,6 +95,7 @@ const validateGetRangeProgressRecordsParams = async (req, res, next) => {
       taskId: joi.string().optional(),
       startDate: joi.date().iso().required(),
       endDate: joi.date().iso().min(joi.ref("startDate")).required(),
+      dev: joi.boolean().optional(),
     })
     .xor("userId", "taskId")
     .messages({
@@ -121,6 +125,7 @@ const validateGetDayProgressParams = async (req, res, next) => {
       }),
     typeId: joi.string().required(),
     date: joi.date().iso().required(),
+    dev: joi.boolean().optional(),
   });
   try {
     await schema.validateAsync(req.params, { abortEarly: false });

middlewares/validators/requests.ts

@@ -9,9 +9,11 @@ import { ExtensionRequestRequest, ExtensionRequestResponse } from "../../types/e
 import { CustomResponse } from "../../typeDefinitions/global";
 import { UpdateRequest } from "../../types/requests";
 import { TaskRequestRequest, TaskRequestResponse } from "../../types/taskRequests";
+import { createOnboardingExtensionRequestValidator } from "./onboardingExtensionRequest";
+import { OnboardingExtensionCreateRequest, OnboardingExtensionResponse } from "../../types/onboardingExtension";
 
 export const createRequestsMiddleware = async (
-  req: OooRequestCreateRequest|ExtensionRequestRequest | TaskRequestRequest,
+  req: OooRequestCreateRequest|ExtensionRequestRequest | TaskRequestRequest | OnboardingExtensionCreateRequest,
   res: CustomResponse,
   next: NextFunction
 ) => {
@@ -28,6 +30,9 @@ export const createRequestsMiddleware = async (
       case REQUEST_TYPE.TASK:
         await createTaskRequestValidator(req as TaskRequestRequest, res as TaskRequestResponse, next);
         break;
+      case REQUEST_TYPE.ONBOARDING:
+        await createOnboardingExtensionRequestValidator(req as OnboardingExtensionCreateRequest, res as OnboardingExtensionResponse, next);
+        break;
       default:
         res.boom.badRequest(`Invalid request type: ${type}`);
     }
@@ -36,7 +41,7 @@ export const createRequestsMiddleware = async (
   } catch (error) {
     const errorMessages = error.details.map((detail:any) => detail.message);
     logger.error(`Error while validating request payload : ${errorMessages}`);
-    res.boom.badRequest(errorMessages);
+    return res.boom.badRequest(errorMessages);
   }
 };
 

models/progresses.js

@@ -13,6 +13,7 @@ const {
   getProgressDateTimestamp,
   buildQueryToSearchProgressByDay,
 } = require("../utils/progresses");
+const { retrieveUsers } = require("../services/dataAccessLayer");
 const { PROGRESS_ALREADY_CREATED, PROGRESS_DOCUMENT_NOT_FOUND } = PROGRESSES_RESPONSE_MESSAGES;
 
 /**
@@ -47,9 +48,14 @@ const createProgressDocument = async (progressData) => {
  * @throws {Error} If the userId or taskId is invalid or does not exist.
  **/
 const getProgressDocument = async (queryParams) => {
+  const { dev } = queryParams;
   await assertUserOrTaskExists(queryParams);
   const query = buildQueryToFetchDocs(queryParams);
   const progressDocs = await getProgressDocs(query);
+
+  if (dev === "true") {
+    return await addUserDetailsToProgressDocs(progressDocs);
+  }
   return progressDocs;
 };
 
@@ -77,16 +83,59 @@ const getRangeProgressData = async (queryParams) => {
  * @returns {Promise<object>} A Promise that resolves with the progress records of the queried user or task.
  * @throws {Error} If the userId or taskId is invalid or does not exist.
  **/
-async function getProgressByDate(pathParams) {
+async function getProgressByDate(pathParams, queryParams) {
   const { type, typeId, date } = pathParams;
+  const { dev } = queryParams;
   await assertUserOrTaskExists({ [TYPE_MAP[type]]: typeId });
   const query = buildQueryToSearchProgressByDay({ [TYPE_MAP[type]]: typeId, date });
   const result = await query.get();
   if (!result.size) {
     throw new NotFound(PROGRESS_DOCUMENT_NOT_FOUND);
   }
   const doc = result.docs[0];
-  return { id: doc.id, ...doc.data() };
+  const docData = doc.data();
+  if (dev === "true") {
+    const { user: userData } = await retrieveUsers({ id: docData.userId });
+    return { id: doc.id, ...docData, userData };
+  }
+
+  return { id: doc.id, ...docData };
 }
 
-module.exports = { createProgressDocument, getProgressDocument, getRangeProgressData, getProgressByDate };
+/**
+ * Adds user details to progress documents by fetching unique users.
+ * This function retrieves user details for each user ID in the progress documents and attaches the user data to each document.
+ *
+ * @param {Array<object>} progressDocs - An array of progress documents. Each document should include a `userId` property.
+ * @returns {Promise<Array<object>>} A Promise that resolves to an array of progress documents with the `userData` field populated.
+ *                                   If an error occurs while fetching the user details, the `userData` field will be set to `null` for each document.
+ */
+const addUserDetailsToProgressDocs = async (progressDocs) => {
+  try {
+    const uniqueUserIds = [...new Set(progressDocs.map((doc) => doc.userId))];
+
+    const uniqueUsersData = await retrieveUsers({
+      userIds: uniqueUserIds,
+    });
+    const allUsers = uniqueUsersData.flat();
+    const userByIdMap = allUsers.reduce((lookup, user) => {
+      if (user) lookup[user.id] = user;
+      return lookup;
+    }, {});
+
+    return progressDocs.map((doc) => {
+      const userDetails = userByIdMap[doc.userId] || null;
+      return { ...doc, userData: userDetails };
+    });
+  } catch (err) {
+    return progressDocs.map((doc) => ({ ...doc, userData: null }));
+  }
+};
+
+module.exports = {
+  createProgressDocument,
+  getProgressDocument,
+  getRangeProgressData,
+  getProgressByDate,
+  addUserDetailsToProgressDocs,
+};