resolve comments on the PR

Author: heyrandhir

models/monitor.js

@@ -2,12 +2,7 @@ const { Conflict, NotFound } = require("http-errors");
 const fireStore = require("../utils/firestore");
 const trackedProgressesCollection = fireStore.collection("trackedProgresses");
 const { assertUserOrTaskExists } = require("../utils/progresses");
-const {
-  buildTrackedProgressQueryByType,
-  buildQueryForFetchingDocsOfType,
-  getTrackedProgressDocs,
-  buildQueryToFetchTrackedDoc,
-} = require("../utils/monitor");
+const { buildQueryByTypeId, buildQueryForFetchingDocsOfType, getTrackedProgressDocs } = require("../utils/monitor");
 const { RESPONSE_MESSAGES } = require("../constants/monitor");
 const { RESOURCE_NOT_FOUND, RESOURCE_ALREADY_TRACKED } = RESPONSE_MESSAGES;
 
@@ -27,7 +22,7 @@ const { RESOURCE_NOT_FOUND, RESOURCE_ALREADY_TRACKED } = RESPONSE_MESSAGES;
 const createTrackedProgressDocument = async (documentData) => {
   const { userId, taskId } = documentData;
   await assertUserOrTaskExists({ userId, taskId });
-  const query = buildTrackedProgressQueryByType({ userId, taskId });
+  const query = buildQueryByTypeId({ userId, taskId });
   const existingDocumentSnapshot = await query.get();
   if (!existingDocumentSnapshot.empty) {
     throw new Conflict(RESOURCE_ALREADY_TRACKED);
@@ -59,7 +54,7 @@ const createTrackedProgressDocument = async (documentData) => {
 const updateTrackedProgressDocument = async (req) => {
   const { type, typeId } = req.params;
   const updatedData = { type, [`${type}Id`]: typeId };
-  const query = buildTrackedProgressQueryByType(updatedData);
+  const query = buildQueryByTypeId(updatedData);
   const existingDocumentSnapshot = await query.get();
   if (existingDocumentSnapshot.empty) {
     throw new NotFound(RESOURCE_NOT_FOUND);
@@ -85,7 +80,7 @@ const getTrackedProgressDocuments = async (reqQuery) => {
   const { userId, taskId } = reqQuery;
   if (userId || taskId) {
     await assertUserOrTaskExists({ userId, taskId });
-    query = buildQueryToFetchTrackedDoc(reqQuery);
+    query = buildQueryByTypeId(reqQuery);
     docsData = (await getTrackedProgressDocs(query))[0];
   } else {
     query = buildQueryForFetchingDocsOfType(reqQuery);

test/integration/monitor.js

@@ -24,16 +24,16 @@ const cookieName = config.get("userToken.cookieName");
 const { expect } = chai;
 
 describe("Test the tracked Progress API", function () {
-  let userId0, userId1, superUser;
+  let userId0, userId1, superUserId;
   let userIdToken0, superUserToken;
   let taskId0, taskId1;
 
   beforeEach(async function () {
     userId0 = await addUser(userData0);
     userIdToken0 = authService.generateAuthToken({ userId: userId0 });
     userId1 = await addUser(userData1);
-    superUser = await addUser(superUserData);
-    superUserToken = authService.generateAuthToken({ userId: superUser });
+    superUserId = await addUser(superUserData);
+    superUserToken = authService.generateAuthToken({ userId: superUserId });
 
     const taskObject0 = await updateTask(taskData[0]);
     taskId0 = taskObject0.taskId;

utils/monitor.js

@@ -12,7 +12,7 @@ const { RESOURCE_NOT_FOUND } = RESPONSE_MESSAGES;
  * @param {string} queryParams.taskId - The ID of the task (optional).
  * @returns {Firestore.Query} - A Firestore query to check if a document exists.
  */
-const buildTrackedProgressQueryByType = (queryParams) => {
+const buildQueryByTypeId = (queryParams) => {
   const { userId, taskId } = queryParams;
   if (userId) {
     return trackedProgressesCollection.where("type", "==", "user").where("userId", "==", userId);
@@ -38,23 +38,6 @@ const buildQueryForFetchingDocsOfType = (queryParams) => {
   return query;
 };
 
-/**
- * Builds a Firestore query for fetching a specific tracked progress document based on the provided query parameters.
- *
- * @param {Object} queryParams - The query parameters for fetching a specific tracked progress document.
- * @param {string} queryParams.userId - The userId of the tracked progress document
- * @param {string} queryParams.taskId - The taskId of the tracked progress document
- * @returns {Firestore.Query} - A Firestore query for fetching a specific tracked progress document.
- */
-const buildQueryToFetchTrackedDoc = (queryParams) => {
-  const { userId, taskId } = queryParams;
-  if (userId) {
-    return trackedProgressesCollection.where("type", "==", "user").where("userId", "==", userId);
-  } else {
-    return trackedProgressesCollection.where("type", "==", "task").where("taskId", "==", taskId);
-  }
-};
-
 /**
  * Retrieves progress documents from Firestore based on the given query.
  * @param {Query} query - A Firestore query object for fetching progress documents.
@@ -74,8 +57,7 @@ const getTrackedProgressDocs = async (query) => {
 };
 
 module.exports = {
-  buildTrackedProgressQueryByType,
+  buildQueryByTypeId,
   buildQueryForFetchingDocsOfType,
   getTrackedProgressDocs,
-  buildQueryToFetchTrackedDoc,
 };