Merge pull request #1307 from Real-Dev-Squad/feat/include-active-user-batch-script

Update Batch Script to include active users

Author: heyrandhir

controllers/userStatus.js

@@ -146,16 +146,16 @@ const updateAllUserStatus = async (req, res) => {
 };
 
 /**
- * Retrieve idle users based on task status where the status is not assigned and in progress
+ * Retrieve users status based on task status
  * @param req {Object} - Express request object
  * @param res {Object} - Express response object
  */
 
-const getIdleUsers = async (req, res) => {
+const getTaskBasedUsersStatus = async (req, res) => {
   try {
-    const data = await userStatusModel.getIdleUsers();
+    const data = await userStatusModel.getTaskBasedUsersStatus();
     return res.json({
-      message: "All idle users found successfully.",
+      message: "All users based on tasks found successfully.",
       data,
     });
   } catch (error) {
@@ -167,8 +167,8 @@ const getIdleUsers = async (req, res) => {
 };
 
 const getUserStatusControllers = async (req, res, next) => {
-  if (Object.keys(req.query).includes("taskStatus")) {
-    await getIdleUsers(req, res, next);
+  if (Object.keys(req.query).includes("aggregate")) {
+    await getTaskBasedUsersStatus(req, res, next);
   } else {
     await getAllUserStatus(req, res, next);
   }
@@ -180,9 +180,9 @@ const getUserStatusControllers = async (req, res, next) => {
  * @param req {Object} - Express request object
  * @param res {Object} - Express response object
  */
-const massUpdateIdleUsers = async (req, res) => {
+const batchUpdateUsersStatus = async (req, res) => {
   try {
-    const data = await userStatusModel.massUpdateIdleUsers(req.body.users);
+    const data = await userStatusModel.batchUpdateUsersStatus(req.body.users);
     return res.json({
       message: "users status updated successfully.",
       data,
@@ -242,8 +242,8 @@ module.exports = {
   getAllUserStatus,
   updateUserStatus,
   updateAllUserStatus,
-  getIdleUsers,
+  getTaskBasedUsersStatus,
   getUserStatusControllers,
-  massUpdateIdleUsers,
+  batchUpdateUsersStatus,
   updateUserStatusController,
 };

middlewares/validators/userStatus.js

@@ -97,10 +97,15 @@ const validateMassUpdate = async (req, res, next) => {
   const schema = Joi.object()
     .keys({
       users: Joi.array()
-        .items(Joi.string().trim())
+        .items(
+          Joi.object({
+            userId: Joi.string().trim().required(),
+            state: Joi.string().valid(userState.IDLE, userState.ACTIVE).required(),
+          })
+        )
         .min(1)
         .required()
-        .error(new Error(`Invalid state value passed for users.`)),
+        .error(new Error(`Invalid object passed in users.`)),
     })
     .messages({
       "object.unknown": "Invalid key in Request payload.",
@@ -118,10 +123,7 @@ const validateMassUpdate = async (req, res, next) => {
 const validateGetQueryParams = async (req, res, next) => {
   const schema = Joi.object()
     .keys({
-      taskStatus: Joi.string()
-        .trim()
-        .valid(userState.IDLE)
-        .error(new Error(`Invalid state value passed for taskStatus.`)),
+      aggregate: Joi.boolean().valid(true).error(new Error(`Invalid boolean value passed for aggregate.`)),
       state: Joi.string()
         .trim()
         .valid(userState.IDLE, userState.ACTIVE, userState.OOO, userState.ONBOARDING)

models/userStatus.js

@@ -327,101 +327,111 @@ const updateStatusOnTaskCompletion = async (userId) => {
   }
 };
 
-const massUpdateIdleUsers = async (users) => {
+const batchUpdateUsersStatus = async (users) => {
   const currentTimeStamp = new Date().getTime();
   const batch = firestore.batch();
-  let usersWithStatusUnchanged = 0;
-
-  await Promise.all(
-    users.map(async (userId) => {
-      let latestStatusData;
-      try {
-        latestStatusData = await getUserStatus(userId);
-      } catch (error) {
-        usersWithStatusUnchanged++;
-        return batch;
-      }
-      const { id, userStatusExists, data } = latestStatusData;
+  const summary = {
+    totalUsers: users.length,
+    totalUnprocessedUsers: 0,
+    totalOnboardingUsersAltered: 0,
+    totalOnboardingUsersUnAltered: 0,
+    totalActiveUsersAltered: 0,
+    totalActiveUsersUnAltered: 0,
+    totalIdleUsersAltered: 0,
+    totalIdleUsersUnAltered: 0,
+  };
 
-      if (!userStatusExists || !data?.currentStatus) {
-        const newUserStatusRef = userStatusModel.doc();
-        const newUserStatusData = {
-          userId,
-          currentStatus: {
-            state: userState.IDLE,
-            message: "",
-            from: currentTimeStamp,
-            until: "",
-            updatedAt: currentTimeStamp,
-          },
-        };
-        batch.set(newUserStatusRef, newUserStatusData);
-      } else {
-        const {
-          currentStatus: { state, until },
-        } = data;
+  for (const { userId, state } of users) {
+    let latestStatusData;
+    try {
+      latestStatusData = await getUserStatus(userId);
+    } catch (error) {
+      summary.totalUnprocessedUsers++;
+      continue;
+    }
+    const { id, userStatusExists, data } = latestStatusData;
+    const statusToUpdate = {
+      state,
+      message: "",
+      from: currentTimeStamp,
+      until: "",
+      updatedAt: currentTimeStamp,
+    };
 
-        if (state === userState.OOO || state === userState.ACTIVE) {
-          const docRef = userStatusModel.doc(id);
-          const updatedStatusData =
-            state === userState.OOO
-              ? {
-                  futureStatus: {
-                    state: userState.IDLE,
-                    message: "",
-                    from: until,
-                    until: "",
-                    updatedAt: currentTimeStamp,
-                  },
-                }
-              : {
-                  currentStatus: {
-                    state: userState.IDLE,
-                    message: "",
-                    from: currentTimeStamp,
-                    until: "",
-                    updatedAt: currentTimeStamp,
-                  },
-                };
+    if (!userStatusExists || !data?.currentStatus) {
+      const newUserStatusRef = userStatusModel.doc();
+      const newUserStatusData = {
+        userId,
+        currentStatus: statusToUpdate,
+      };
+      state === userState.ACTIVE ? summary.totalActiveUsersAltered++ : summary.totalIdleUsersAltered++;
+      batch.set(newUserStatusRef, newUserStatusData);
+    } else {
+      const {
+        currentStatus: { state: currentState, until },
+      } = data;
+      if (currentState === state) {
+        currentState === userState.ACTIVE ? summary.totalActiveUsersUnAltered++ : summary.totalIdleUsersUnAltered++;
+        continue;
+      }
+      if (currentState === userState.ONBOARDING) {
+        const docRef = userStatusModel.doc(id);
+        if (state === userState.ACTIVE) {
+          const updatedStatusData = {
+            currentStatus: statusToUpdate,
+          };
+          summary.totalOnboardingUsersAltered++;
           batch.update(docRef, updatedStatusData);
         } else {
-          usersWithStatusUnchanged++;
+          summary.totalOnboardingUsersUnAltered++;
         }
+      } else {
+        state === userState.ACTIVE ? summary.totalActiveUsersAltered++ : summary.totalIdleUsersAltered++;
+        const docRef = userStatusModel.doc(id);
+        const updatedStatusData =
+          currentState === userState.OOO
+            ? {
+                futureStatus: {
+                  ...statusToUpdate,
+                  from: until,
+                },
+              }
+            : {
+                currentStatus: statusToUpdate,
+              };
+        batch.update(docRef, updatedStatusData);
       }
-      return batch;
-    })
-  );
+    }
+  }
 
   try {
     await batch.commit();
-    return {
-      totalUsers: users.length,
-      usersWithStatusUpdated: users.length - usersWithStatusUnchanged,
-      usersOnboardingOrAlreadyIdle: usersWithStatusUnchanged,
-    };
+    return summary;
   } catch (error) {
     throw new Error("Batch operation failed");
   }
 };
 
-const getIdleUsers = async () => {
-  const idleUsers = [];
-  const usersNotProcessed = [];
+const getTaskBasedUsersStatus = async () => {
+  const users = [];
+  let totalIdleUsers = 0;
+  let totalActiveUsers = 0;
+  const unprocessedUsers = [];
   let errorCount = 0;
-  let discordActiveNonArchivedUsersQuerySnapshot;
+  let usersSnapshot;
   try {
-    discordActiveNonArchivedUsersQuerySnapshot = await usersCollection
+    usersSnapshot = await usersCollection
       .where("roles.in_discord", "==", true)
       .where("roles.archived", "==", false)
       .get();
   } catch (error) {
     logger.error(`unable to get users ${error.message}`);
     throw new Error("unable to get users");
   }
-  const totalValidUsersCount = discordActiveNonArchivedUsersQuerySnapshot.size;
-  if (totalValidUsersCount) {
+  const totalUsers = usersSnapshot.size;
+  if (totalUsers) {
     await Promise.all(
-      discordActiveNonArchivedUsersQuerySnapshot.docs.map(async (userDoc) => {
+      usersSnapshot.docs.map(async (userDoc) => {
         const assigneeId = userDoc.id;
         try {
           const tasksQuerySnapshot = await firestore
@@ -430,23 +440,28 @@ const getIdleUsers = async () => {
             .where("status", "in", [TASK_STATUS.ASSIGNED, TASK_STATUS.IN_PROGRESS])
             .get();
           if (tasksQuerySnapshot.empty) {
-            idleUsers.push(assigneeId);
+            totalIdleUsers++;
+            users.push({ userId: assigneeId, state: userState.IDLE });
+          } else {
+            totalActiveUsers++;
+            users.push({ userId: assigneeId, state: userState.ACTIVE });
           }
         } catch (error) {
           errorCount++;
-          usersNotProcessed.push(assigneeId);
+          unprocessedUsers.push(assigneeId);
           logger.error(`Error retrieving tasks for user ${assigneeId}: ${error.message}`);
         }
       })
     );
   }
 
   return {
-    totalValidUsersCount,
-    idleUsersCount: idleUsers.length,
-    idleUsers,
-    usersNotProcessedCount: errorCount,
-    usersNotProcessed,
+    totalUsers,
+    totalIdleUsers,
+    totalActiveUsers,
+    totalUnprocessedUsers: errorCount,
+    unprocessedUsers,
+    users,
   };
 };
 
@@ -503,7 +518,7 @@ module.exports = {
   updateUserStatusOnNewTaskAssignment,
   updateUserStatusOnTaskUpdate,
   updateStatusOnTaskCompletion,
-  massUpdateIdleUsers,
-  getIdleUsers,
+  batchUpdateUsersStatus,
+  getTaskBasedUsersStatus,
   cancelOooStatus,
 };

routes/userStatus.js

@@ -4,7 +4,7 @@ const {
   getUserStatus,
   updateUserStatus,
   updateAllUserStatus,
-  massUpdateIdleUsers,
+  batchUpdateUsersStatus,
   getUserStatusControllers,
   updateUserStatusController,
 } = require("../controllers/userStatus");
@@ -23,7 +23,7 @@ router.get("/self", authenticate, getUserStatus);
 router.get("/:userId", getUserStatus);
 router.patch("/self", authenticate, validateUserStatus, updateUserStatusController);
 router.patch("/update", authenticate, authorizeRoles([SUPERUSER]), updateAllUserStatus);
-router.patch("/batch", authenticate, authorizeRoles([SUPERUSER]), validateMassUpdate, massUpdateIdleUsers);
+router.patch("/batch", authenticate, authorizeRoles([SUPERUSER]), validateMassUpdate, batchUpdateUsersStatus);
 router.patch("/:userId", authenticate, authorizeRoles([SUPERUSER]), validateUserStatus, updateUserStatus);
 router.delete("/:userId", authenticate, authorizeRoles([SUPERUSER]), deleteUserStatus);