Merge pull request #1089 from Real-Dev-Squad/feat/progresses-api-v1.5

Implement API endpoint for retrieving progress document by user or task for a particular date

Author: heyrandhir

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,
+};

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 };

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,
 };

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 };

routes/progresses.js

@@ -5,11 +5,18 @@ const {
   validateCreateProgressRecords,
   validateGetProgressRecordsQuery,
   validateGetRangeProgressRecordsParams,
+  validateGetDayProgressParams,
 } = require("../middlewares/validators/progresses");
-const { createProgress, getProgress, getProgressRangeData } = require("../controllers/progresses");
+const {
+  createProgress,
+  getProgress,
+  getProgressRangeData,
+  getProgressBydDateController,
+} = require("../controllers/progresses");
 
 router.post("/", authenticate, validateCreateProgressRecords, createProgress);
 router.get("/", validateGetProgressRecordsQuery, getProgress);
+router.get("/:type/:typeId/date/:date", validateGetDayProgressParams, getProgressBydDateController);
 router.get("/range", validateGetRangeProgressRecordsParams, getProgressRangeData);
 
 module.exports = router;