chore: refactors and fix test

Author: Ajeyakrishna-k

models/discordactions.js

@@ -21,17 +21,13 @@ const discordMissedUpdatesRoleId = config.get("discordMissedUpdatesRoleId");
 const userStatusModel = firestore.collection("usersStatus");
 const usersUtils = require("../utils/users");
 const { getUsersBasedOnFilter, fetchUser } = require("./users");
-const {
-  convertDaysToMilliseconds,
-  convertMillisToSeconds,
-  convertTimestampToUTCStartOrEndOfDay,
-} = require("../utils/time");
+const { convertDaysToMilliseconds } = require("../utils/time");
 const { chunks } = require("../utils/array");
 const tasksModel = firestore.collection("tasks");
-const progressesModel = firestore.collection("progresses");
-const { COMPLETED_TASK_STATUS } = require("../constants/tasks.ts");
 const { FIRESTORE_IN_CLAUSE_SIZE } = require("../constants/users");
 const discordService = require("../services/discordService");
+const { buildTasksQueryForMissedUpdates } = require("../utils/tasks");
+const { buildProgressQueryForMissedUpdates } = require("../utils/progresses");
 
 /**
  *
@@ -844,7 +840,7 @@ const updateUsersWith31DaysPlusOnboarding = async () => {
   }
 };
 
-const addMissedProgressUpdatesRoleInDiscord = async (options = {}) => {
+const getMissedProgressUpdatesUsers = async (options = {}) => {
   const { cursor, size = 500, excludedDates = [], dateGap = 3 } = options;
   const stats = {
     tasks: 0,
@@ -854,21 +850,15 @@ const addMissedProgressUpdatesRoleInDiscord = async (options = {}) => {
     const discordUsersPromise = discordService.getDiscordMembers();
     const missedUpdatesRoleId = discordMissedUpdatesRoleId;
 
-    const completedTasksStatusList = Object.values(COMPLETED_TASK_STATUS);
     let gapWindowStart = Date.now() - convertDaysToMilliseconds(dateGap);
     const gapWindowEnd = Date.now();
-
     excludedDates.forEach((timestamp) => {
       if (timestamp > gapWindowStart && timestamp < gapWindowEnd) {
         gapWindowStart -= convertDaysToMilliseconds(1);
       }
     });
 
-    let taskQuery = tasksModel
-      .where("status", "not-in", completedTasksStatusList)
-      .where("startedOn", "<", convertMillisToSeconds(gapWindowStart))
-      .orderBy("assignee") // this order by will eliminate the documents which has no assignee field. https://firebase.google.com/docs/firestore/query-data/order-limit-data#limitations
-      .limit(size);
+    let taskQuery = buildTasksQueryForMissedUpdates(gapWindowStart, size);
 
     if (cursor) {
       const data = await tasksModel.doc(cursor).get();
@@ -902,13 +892,8 @@ const addMissedProgressUpdatesRoleInDiscord = async (options = {}) => {
         });
       }
       const updateTasksIdMap = async () => {
-        const progressSnapshot = await progressesModel
-          .where("type", "==", "task")
-          .where("taskId", "==", taskId)
-          .where("date", ">=", convertTimestampToUTCStartOrEndOfDay(gapWindowStart))
-          .where("date", "<=", convertTimestampToUTCStartOrEndOfDay(gapWindowEnd, true))
-          .count()
-          .get();
+        const progressQuery = buildProgressQueryForMissedUpdates(taskId, gapWindowStart, gapWindowEnd);
+        const progressSnapshot = await progressQuery.get();
         const userData = usersMap.get(taskAssignee);
         userData.latestProgressCount = Math.min(progressSnapshot.data().count, userData.latestProgressCount);
 
@@ -1055,7 +1040,7 @@ module.exports = {
   updateUsersNicknameStatus,
   updateIdle7dUsersOnDiscord,
   updateUsersWith31DaysPlusOnboarding,
-  addMissedProgressUpdatesRoleInDiscord,
+  getMissedProgressUpdatesUsers,
   getUserDiscordInvite,
   addInviteToInviteModel,
 };

test/unit/models/discordactions.test.js

@@ -27,7 +27,7 @@ const {
   enrichGroupDataWithMembershipInfo,
   fetchGroupToUserMapping,
   updateUsersNicknameStatus,
-  addMissedProgressUpdatesRoleInDiscord,
+  getMissedProgressUpdatesUsers,
   addInviteToInviteModel,
   getUserDiscordInvite,
 } = require("../../../models/discordactions");
@@ -591,7 +591,7 @@ describe("discordactions", function () {
     }).timeout(10000);
   });
 
-  describe("addMissedProgressUpdatesRoleInDiscord", function () {
+  describe("getMissedProgressUpdatesUsers", function () {
     let activeUserWithProgressUpdates;
     let idleUser;
     let userNotInDiscord;
@@ -639,10 +639,6 @@ describe("discordactions", function () {
       date.setDate(date.getDate() - 1);
       const progressData = stubbedModelTaskProgressData(null, taskIdList[2], date.getTime(), date.valueOf());
       progressDataList.push(progressData);
-      const date2 = new Date();
-      date2.setDate(date2.getDate() - 3);
-      const progressData2 = stubbedModelTaskProgressData(null, taskIdList[2], date2.getTime(), date2.valueOf());
-      progressDataList.push(progressData2);
 
       await Promise.all(progressDataList.map(async (progress) => await createProgressDocument(progress)));
 
@@ -653,7 +649,7 @@ describe("discordactions", function () {
       await cleanDb();
     });
     it("should list of users who missed updating progress", async function () {
-      const result = await addMissedProgressUpdatesRoleInDiscord();
+      const result = await getMissedProgressUpdatesUsers();
       expect(result).to.be.an("object");
       expect(result).to.be.deep.equal({
         tasks: 4,
@@ -663,7 +659,7 @@ describe("discordactions", function () {
     });
 
     it("should not list of users who are not active and who missed updating progress", async function () {
-      const result = await addMissedProgressUpdatesRoleInDiscord();
+      const result = await getMissedProgressUpdatesUsers();
       expect(result).to.be.an("object");
       expect(result.usersToAddRole).to.not.contain(idleUser.discordId);
       expect(result.usersToAddRole).to.not.contain(userNotInDiscord.discordId);
@@ -673,13 +669,13 @@ describe("discordactions", function () {
       const date = new Date();
       date.setDate(date.getDate() - 1);
       const date2 = new Date();
-      date.setDate(date2.getDate() - 2);
+      date2.setDate(date2.getDate() - 2);
       const date3 = new Date();
-      date.setDate(date3.getDate() - 3);
+      date3.setDate(date3.getDate() - 3);
       const date4 = new Date();
-      date.setDate(date4.getDate() - 4);
+      date4.setDate(date4.getDate() - 4);
       // this should now only get users who have not provided any update in last 7 days instead of 3;
-      const result = await addMissedProgressUpdatesRoleInDiscord({
+      const result = await getMissedProgressUpdatesUsers({
         excludedDates: [date.valueOf(), date2.valueOf(), date3.valueOf(), date4.valueOf()],
       });
       expect(result).to.be.an("object");
@@ -691,17 +687,17 @@ describe("discordactions", function () {
     });
 
     it("should process only 1 task when size is passed as 1", async function () {
-      const result = await addMissedProgressUpdatesRoleInDiscord({ size: 1 });
+      const result = await getMissedProgressUpdatesUsers({ size: 1 });
 
       expect(result).to.be.an("object");
       expect(result.tasks).to.be.equal(1);
     });
     it("should fetch process tasks when cursor is passed", async function () {
-      const result = await addMissedProgressUpdatesRoleInDiscord({ size: 4 });
+      const result = await getMissedProgressUpdatesUsers({ size: 4 });
 
       expect(result).to.be.an("object");
       expect(result).to.haveOwnProperty("cursor");
-      const nextResult = await addMissedProgressUpdatesRoleInDiscord({ size: 4, cursor: result.cursor });
+      const nextResult = await getMissedProgressUpdatesUsers({ size: 4, cursor: result.cursor });
       expect(nextResult).to.be.an("object");
       expect(nextResult).to.not.haveOwnProperty("cursor");
     });

utils/progresses.js

@@ -2,11 +2,14 @@ const { NotFound } = require("http-errors");
 const { fetchTask } = require("../models/tasks");
 const { fetchUser } = require("../models/users");
 const fireStore = require("../utils/firestore");
+const progressesModel = fireStore.collection("progresses");
+
 const {
   PROGRESSES_RESPONSE_MESSAGES: { PROGRESS_DOCUMENT_NOT_FOUND },
   MILLISECONDS_IN_DAY,
   PROGRESS_VALID_SORT_FIELDS,
 } = require("../constants/progresses");
+const { convertTimestampToUTCStartOrEndOfDay } = require("./time");
 const progressesCollection = fireStore.collection("progresses");
 
 /**
@@ -211,6 +214,14 @@ const buildQueryToSearchProgressByDay = (pathParams) => {
   return query;
 };
 
+const buildProgressQueryForMissedUpdates = (taskId, startTimestamp, endTimestamp) => {
+  return progressesModel
+    .where("type", "==", "task")
+    .where("taskId", "==", taskId)
+    .where("date", ">=", convertTimestampToUTCStartOrEndOfDay(startTimestamp))
+    .where("date", "<=", convertTimestampToUTCStartOrEndOfDay(endTimestamp, true))
+    .count();
+};
 module.exports = {
   getProgressDateTimestamp,
   buildQueryForPostingProgress,
@@ -222,4 +233,5 @@ module.exports = {
   buildRangeProgressQuery,
   getProgressRecords,
   buildQueryToSearchProgressByDay,
+  buildProgressQueryForMissedUpdates,
 };

utils/tasks.js

@@ -1,5 +1,9 @@
 const { getUsername, getUserId, getParticipantUsernames, getParticipantUserIds } = require("./users");
 const { TASK_TYPE, MAPPED_TASK_STATUS } = require("../constants/tasks");
+const fireStore = require("../utils/firestore");
+const tasksModel = fireStore.collection("tasks");
+const { COMPLETED_TASK_STATUS } = require("../constants/tasks.ts");
+const { convertMillisToSeconds } = require("./time");
 
 const fromFirestoreData = async (task) => {
   if (!task) {
@@ -110,10 +114,20 @@ const parseSearchQuery = (queryString) => {
   return searchParams;
 };
 
+const buildTasksQueryForMissedUpdates = (startedOnTimestamp, size) => {
+  const completedTasksStatusList = Object.values(COMPLETED_TASK_STATUS);
+  return tasksModel
+    .where("status", "not-in", completedTasksStatusList)
+    .where("startedOn", "<", convertMillisToSeconds(startedOnTimestamp))
+    .orderBy("assignee")
+    .limit(size);
+};
+
 module.exports = {
   fromFirestoreData,
   toFirestoreData,
   buildTasks,
   transformQuery,
   parseSearchQuery,
+  buildTasksQueryForMissedUpdates,
 };