Merge pull request #1104 from Real-Dev-Squad/develop

dev to main sync

Author: RitikJaiswal75

constants/progresses.js

@@ -3,6 +3,8 @@ const PROGRESS_DOCUMENT_RETRIEVAL_SUCCEEDED = "Progress document retrieved succe
 const PROGRESS_DOCUMENT_NOT_FOUND = "No progress records found.";
 const PROGRESS_ALREADY_CREATED = "Progress for the day has already been created.";
 const MILLISECONDS_IN_DAY = 24 * 60 * 60 * 1000;
+const INTERNAL_SERVER_ERROR_MESSAGE =
+  "The server has encountered an unexpected error. Please contact the administrator for more information.";
 
 const RESPONSE_MESSAGES = {
   PROGRESS_DOCUMENT_CREATED_SUCCEEDED,
@@ -11,4 +13,17 @@ const RESPONSE_MESSAGES = {
   PROGRESS_ALREADY_CREATED,
 };
 
-module.exports = { RESPONSE_MESSAGES, MILLISECONDS_IN_DAY };
+const TYPE_MAP = {
+  user: "userId",
+  task: "taskId",
+};
+
+const VALID_PROGRESS_TYPES = ["task", "user"];
+
+module.exports = {
+  RESPONSE_MESSAGES,
+  MILLISECONDS_IN_DAY,
+  INTERNAL_SERVER_ERROR_MESSAGE,
+  TYPE_MAP,
+  VALID_PROGRESS_TYPES,
+};

constants/roles.js

@@ -4,6 +4,7 @@ const ROLES = {
   APPOWNER: "app_owner",
   MEMBER: "member",
   ARCHIVED: "archived",
+  INDISCORD: "in_discord",
 };
 
 module.exports = ROLES;

constants/users.js

@@ -13,6 +13,7 @@ const USER_STATUS = {
 const ALLOWED_FILTER_PARAMS = {
   ITEM_TAG: ["levelId", "levelName", "levelValue", "tagId"],
   USER_STATE: ["state"],
+  ROLE: ["role"],
 };
 
 module.exports = { profileStatus, USER_STATUS, ALLOWED_FILTER_PARAMS };

controllers/progresses.js

@@ -1,6 +1,11 @@
 const { Conflict, NotFound } = require("http-errors");
-const { createProgressDocument, getProgressDocument, getRangeProgressData } = require("../models/progresses");
-const { RESPONSE_MESSAGES } = require("../constants/progresses");
+const {
+  createProgressDocument,
+  getProgressDocument,
+  getRangeProgressData,
+  getProgressByDate,
+} = require("../models/progresses");
+const { RESPONSE_MESSAGES, INTERNAL_SERVER_ERROR_MESSAGE } = require("../constants/progresses");
 const { PROGRESS_DOCUMENT_RETRIEVAL_SUCCEEDED, PROGRESS_DOCUMENT_CREATED_SUCCEEDED } = RESPONSE_MESSAGES;
 
 /**
@@ -58,8 +63,9 @@ const createProgress = async (req, res) => {
         message: error.message,
       });
     }
-    return res.status(400).json({
-      message: error.message,
+    logger.error(error.message);
+    return res.status(500).json({
+      message: INTERNAL_SERVER_ERROR_MESSAGE,
     });
   }
 };
@@ -112,8 +118,9 @@ const getProgress = async (req, res) => {
         message: error.message,
       });
     }
-    return res.status(400).json({
-      message: error.message,
+    logger.error(error.message);
+    return res.status(500).json({
+      message: INTERNAL_SERVER_ERROR_MESSAGE,
     });
   }
 };
@@ -165,10 +172,65 @@ const getProgressRangeData = async (req, res) => {
         message: error.message,
       });
     }
-    return res.status(400).json({
-      message: error.message,
+    logger.error(error.message);
+    return res.status(500).json({
+      message: INTERNAL_SERVER_ERROR_MESSAGE,
     });
   }
 };
 
-module.exports = { createProgress, getProgress, getProgressRangeData };
+/**
+ * @typedef {Object} progressPathParams
+ * @property {string} type - The type of progress document user or task.
+ * @property {string} typeId - The ID of the type.
+ * @property {string} date - The iso format date of the query.
+ */
+
+/**
+ * @typedef {Object} ProgressDocument
+ * @property {string} id - The id of the progress document.
+ * @property {string} type - The type of progress document.
+ * @property {string} completed - The completed progress.
+ * @property {string} planned - The planned progress.
+ * @property {string} blockers - The blockers.
+ * @property {string} userId - The User ID
+ * @property {string} [taskId] - The task ID (optional).
+ * @property {number} createdAt - The timestamp when the progress document was created.
+ * @property {number} date - The timestamp for the day the progress document was created.
+ */
+
+/**
+ * @typedef {Object} GetProgressByDateResponse
+ * @property {string} message - The success message.
+ * @property {ProgressDocument} data - An array of progress documents
+ */
+
+/**
+ * Retrieves the progress documents based on provided query parameters.
+ * @param {Object} req - The HTTP request object.
+ * @param {progressPathParams} req.params - The query parameters
+ * @param {Object} res - The HTTP response object.
+ * @returns {Promise<void>} A Promise that resolves when the response is sent.
+ */
+
+const getProgressBydDateController = async (req, res) => {
+  try {
+    const data = await getProgressByDate(req.params);
+    return res.json({
+      message: PROGRESS_DOCUMENT_RETRIEVAL_SUCCEEDED,
+      data,
+    });
+  } catch (error) {
+    if (error instanceof NotFound) {
+      return res.status(404).json({
+        message: error.message,
+      });
+    }
+    logger.error(error.message);
+    return res.status(500).json({
+      message: INTERNAL_SERVER_ERROR_MESSAGE,
+    });
+  }
+};
+
+module.exports = { createProgress, getProgress, getProgressRangeData, getProgressBydDateController };

controllers/tasks.js

@@ -6,6 +6,7 @@ const { addOrUpdate, getRdsUserInfoByGitHubUsername } = require("../models/users
 const { OLD_ACTIVE, OLD_BLOCKED, OLD_PENDING } = TASK_STATUS_OLD;
 const { IN_PROGRESS, BLOCKED, SMOKE_TESTING, ASSIGNED } = TASK_STATUS;
 const { INTERNAL_SERVER_ERROR, SOMETHING_WENT_WRONG } = require("../constants/errorMessages");
+const dependencyModel = require("../models/tasks");
 /**
  * Creates new task
  *
@@ -16,17 +17,25 @@ const { INTERNAL_SERVER_ERROR, SOMETHING_WENT_WRONG } = require("../constants/er
 const addNewTask = async (req, res) => {
   try {
     const { id: createdBy } = req.userData;
+    const dependsOn = req.body.dependsOn;
     const body = {
       ...req.body,
       createdBy,
     };
-
-    const task = await tasks.updateTask(body);
-
+    delete body.dependsOn;
+    const { taskId, taskDetails } = await tasks.updateTask(body);
+    const data = {
+      taskId,
+      dependsOn,
+    };
+    const taskDependency = dependsOn && (await dependencyModel.addDependency(data));
     return res.json({
       message: "Task created successfully!",
-      task: task.taskDetails,
-      id: task.taskId,
+      task: {
+        ...taskDetails,
+        ...(taskDependency && { dependsOn: taskDependency }),
+        id: taskId,
+      },
     });
   } catch (err) {
     logger.error(`Error while creating new task: ${err}`);

controllers/users.js

@@ -5,7 +5,7 @@ const logsQuery = require("../models/logs");
 const imageService = require("../services/imageService");
 const { profileDiffStatus } = require("../constants/profileDiff");
 const { logType } = require("../constants/logs");
-const { fetch } = require("../utils/fetch");
+
 const logger = require("../utils/logger");
 const obfuscate = require("../utils/obfuscate");
 const { getPaginationLink, getUsernamesFromPRs } = require("../utils/users");
@@ -24,7 +24,11 @@ const verifyUser = async (req, res) => {
     logger.error(`Error while verifying user: ${error}`);
     return res.boom.serverUnavailable(SOMETHING_WENT_WRONG);
   }
-  fetch(process.env.IDENTITY_SERVICE_URL, "POST", null, { userId }, { "Content-Type": "application/json" });
+  fetch(process.env.IDENTITY_SERVICE_URL, {
+    method: "POST",
+    body: { userId },
+    headers: { "Content-Type": "application/json" },
+  });
   return res.json({
     message: "Your request has been queued successfully",
   });

middlewares/validators/progresses.js

@@ -1,14 +1,20 @@
 const joi = require("joi");
+const { VALID_PROGRESS_TYPES } = require("../../constants/progresses");
 
 const validateCreateProgressRecords = async (req, res, next) => {
   const baseSchema = joi
     .object()
     .strict()
     .keys({
-      type: joi.string().trim().valid("user", "task").required().messages({
-        "any.required": "Required field 'type' is missing.",
-        "any.only": "Type field is restricted to either 'user' or 'task'.",
-      }),
+      type: joi
+        .string()
+        .trim()
+        .valid(...VALID_PROGRESS_TYPES)
+        .required()
+        .messages({
+          "any.required": "Required field 'type' is missing.",
+          "any.only": "Type field is restricted to either 'user' or 'task'.",
+        }),
       completed: joi.string().trim().required().messages({
         "any.required": "Required field 'completed' is missing.",
         "string.trim": "completed must not have leading or trailing whitespace",
@@ -44,9 +50,13 @@ const validateCreateProgressRecords = async (req, res, next) => {
 const validateGetProgressRecordsQuery = async (req, res, next) => {
   const schema = joi
     .object({
-      type: joi.string().valid("user", "task").optional().messages({
-        "any.only": "Type field is restricted to either 'user' or 'task'.",
-      }),
+      type: joi
+        .string()
+        .valid(...VALID_PROGRESS_TYPES)
+        .optional()
+        .messages({
+          "any.only": "Type field is restricted to either 'user' or 'task'.",
+        }),
       userId: joi.string().optional().allow("").messages({
         "string.base": "userId must be a string",
       }),
@@ -92,8 +102,30 @@ const validateGetRangeProgressRecordsParams = async (req, res, next) => {
     res.boom.badRequest(error.details[0].message);
   }
 };
+
+const validateGetDayProgressParams = async (req, res, next) => {
+  const schema = joi.object({
+    type: joi
+      .string()
+      .valid(...VALID_PROGRESS_TYPES)
+      .required()
+      .messages({
+        "any.only": "Type field is restricted to either 'user' or 'task'.",
+      }),
+    typeId: joi.string().required(),
+    date: joi.date().iso().required(),
+  });
+  try {
+    await schema.validateAsync(req.params, { abortEarly: false });
+    next();
+  } catch (error) {
+    logger.error(`Error validating payload: ${error}`);
+    res.boom.badRequest(error.details[0].message);
+  }
+};
 module.exports = {
   validateCreateProgressRecords,
   validateGetProgressRecordsQuery,
   validateGetRangeProgressRecordsParams,
+  validateGetDayProgressParams,
 };

middlewares/validators/user.js

@@ -1,5 +1,6 @@
 const joi = require("joi");
 const { USER_STATUS } = require("../../constants/users");
+const ROLES = require("../../constants/roles");
 
 const updateUser = async (req, res, next) => {
   const schema = joi
@@ -172,6 +173,8 @@ async function validateUserQueryParams(req, res, next) {
           joi.array().items(joi.string().valid("IDLE", "OOO", "ACTIVE"))
         )
         .optional(),
+      role: joi.string().valid(ROLES.MEMBER, ROLES.INDISCORD).optional(),
+      verified: joi.string().optional(),
     })
     .messages({
       "object.min": "Please provide at least one filter criteria",

models/progresses.js

@@ -1,7 +1,7 @@
-const { Conflict } = require("http-errors");
+const { Conflict, NotFound } = require("http-errors");
 const fireStore = require("../utils/firestore");
 const progressesCollection = fireStore.collection("progresses");
-const { RESPONSE_MESSAGES } = require("../constants/progresses");
+const { RESPONSE_MESSAGES, TYPE_MAP } = require("../constants/progresses");
 const {
   buildQueryToFetchDocs,
   getProgressDocs,
@@ -11,8 +11,9 @@ const {
   buildQueryForPostingProgress,
   assertTaskExists,
   getProgressDateTimestamp,
+  buildQueryToSearchProgressByDay,
 } = require("../utils/progresses");
-const { PROGRESS_ALREADY_CREATED } = RESPONSE_MESSAGES;
+const { PROGRESS_ALREADY_CREATED, PROGRESS_DOCUMENT_NOT_FOUND } = RESPONSE_MESSAGES;
 
 /**
  * Adds a new progress document for the given user or task, with a limit of one progress document per day.
@@ -68,4 +69,22 @@ const getRangeProgressData = async (queryParams) => {
   };
 };
 
-module.exports = { createProgressDocument, getProgressDocument, getRangeProgressData };
+/**
+ * This function fetches the progress records for a particular user or task on the specified date.
+ * @param pathParams {object} This is the data that will be used for querying the db. It should contain type, typeId and date
+ * @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) {
+  const { type, typeId, date } = pathParams;
+  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() };
+}
+
+module.exports = { createProgressDocument, getProgressDocument, getRangeProgressData, getProgressByDate };

models/tasks.js

@@ -1,6 +1,7 @@
 const firestore = require("../utils/firestore");
 const tasksModel = firestore.collection("tasks");
 const ItemModel = firestore.collection("itemTags");
+const dependencyModel = firestore.collection("taskDependencies");
 const userUtils = require("../utils/users");
 const { fromFirestoreData, toFirestoreData, buildTasks } = require("../utils/tasks");
 const { TASK_TYPE, TASK_STATUS, TASK_STATUS_OLD } = require("../constants/tasks");
@@ -32,13 +33,34 @@ const updateTask = async (taskData, taskId = null) => {
       taskId: taskInfo.id,
       taskDetails: await fromFirestoreData(taskData),
     };
-
     return result;
   } catch (err) {
     logger.error("Error in updating task", err);
     throw err;
   }
 };
+const addDependency = async (data) => {
+  try {
+    const { taskId, dependsOn } = data;
+    const batch = firestore.batch();
+    if (dependsOn.length > 500) {
+      throw new Error("Error cannot add more than 500 taskId");
+    }
+    for (const dependsId of dependsOn) {
+      const taskDependOn = {
+        taskId,
+        dependsId,
+      };
+      const docid = dependencyModel.doc();
+      batch.set(docid, taskDependOn);
+    }
+    await batch.commit();
+    return data.dependsOn;
+  } catch (err) {
+    logger.error("Error in creating dependency");
+    throw err;
+  }
+};
 
 /**
  * Fetch all tasks
@@ -352,5 +374,6 @@ module.exports = {
   fetchSelfTask,
   fetchSkillLevelTask,
   overdueTasks,
+  addDependency,
   fetchTaskByIssueId,
 };