Merge pull request #1339 from Real-Dev-Squad/feat/refactor-total-with-count-in-update-script

Rename fields as per Ankush Suggestion

Author: heyrandhir

models/userStatus.js

@@ -331,22 +331,22 @@ const batchUpdateUsersStatus = async (users) => {
   const currentTimeStamp = new Date().getTime();
   const batch = firestore.batch();
   const summary = {
-    totalUsers: users.length,
-    totalUnprocessedUsers: 0,
-    totalOnboardingUsersAltered: 0,
-    totalOnboardingUsersUnAltered: 0,
-    totalActiveUsersAltered: 0,
-    totalActiveUsersUnAltered: 0,
-    totalIdleUsersAltered: 0,
-    totalIdleUsersUnAltered: 0,
+    usersCount: users.length,
+    unprocessedUsers: 0,
+    onboardingUsersAltered: 0,
+    onboardingUsersUnaltered: 0,
+    activeUsersAltered: 0,
+    activeUsersUnaltered: 0,
+    idleUsersAltered: 0,
+    idleUsersUnaltered: 0,
   };
 
   for (const { userId, state } of users) {
     let latestStatusData;
     try {
       latestStatusData = await getUserStatus(userId);
     } catch (error) {
-      summary.totalUnprocessedUsers++;
+      summary.unprocessedUsers++;
       continue;
     }
     const { id, userStatusExists, data } = latestStatusData;
@@ -364,14 +364,14 @@ const batchUpdateUsersStatus = async (users) => {
         userId,
         currentStatus: statusToUpdate,
       };
-      state === userState.ACTIVE ? summary.totalActiveUsersAltered++ : summary.totalIdleUsersAltered++;
+      state === userState.ACTIVE ? summary.activeUsersAltered++ : summary.idleUsersAltered++;
       batch.set(newUserStatusRef, newUserStatusData);
     } else {
       const {
         currentStatus: { state: currentState, until },
       } = data;
       if (currentState === state) {
-        currentState === userState.ACTIVE ? summary.totalActiveUsersUnAltered++ : summary.totalIdleUsersUnAltered++;
+        currentState === userState.ACTIVE ? summary.activeUsersUnaltered++ : summary.idleUsersUnaltered++;
         continue;
       }
       if (currentState === userState.ONBOARDING) {
@@ -380,13 +380,13 @@ const batchUpdateUsersStatus = async (users) => {
           const updatedStatusData = {
             currentStatus: statusToUpdate,
           };
-          summary.totalOnboardingUsersAltered++;
+          summary.onboardingUsersAltered++;
           batch.update(docRef, updatedStatusData);
         } else {
-          summary.totalOnboardingUsersUnAltered++;
+          summary.onboardingUsersUnaltered++;
         }
       } else {
-        state === userState.ACTIVE ? summary.totalActiveUsersAltered++ : summary.totalIdleUsersAltered++;
+        state === userState.ACTIVE ? summary.activeUsersAltered++ : summary.idleUsersAltered++;
         const docRef = userStatusModel.doc(id);
         const updatedStatusData =
           currentState === userState.OOO

test/integration/taskBasedStatusUpdate.test.js

@@ -398,23 +398,23 @@ describe("Task Based Status Updates", function () {
       expect(res.status).to.equal(200);
       const response = res.body.data;
       expect(response).to.have.all.keys(
-        "totalUsers",
-        "totalUnprocessedUsers",
-        "totalOnboardingUsersAltered",
-        "totalOnboardingUsersUnAltered",
-        "totalActiveUsersAltered",
-        "totalActiveUsersUnAltered",
-        "totalIdleUsersAltered",
-        "totalIdleUsersUnAltered"
+        "usersCount",
+        "unprocessedUsers",
+        "onboardingUsersAltered",
+        "onboardingUsersUnaltered",
+        "activeUsersAltered",
+        "activeUsersUnaltered",
+        "idleUsersAltered",
+        "idleUsersUnaltered"
       );
-      expect(response.totalUsers).to.equal(10);
-      expect(response.totalUnprocessedUsers).to.equal(0);
-      expect(response.totalOnboardingUsersAltered).to.equal(1);
-      expect(response.totalOnboardingUsersUnAltered).to.equal(1);
-      expect(response.totalActiveUsersAltered).to.equal(3);
-      expect(response.totalActiveUsersUnAltered).to.equal(1);
-      expect(response.totalIdleUsersAltered).to.equal(3);
-      expect(response.totalIdleUsersUnAltered).to.equal(1);
+      expect(response.usersCount).to.equal(10);
+      expect(response.unprocessedUsers).to.equal(0);
+      expect(response.onboardingUsersAltered).to.equal(1);
+      expect(response.onboardingUsersUnaltered).to.equal(1);
+      expect(response.activeUsersAltered).to.equal(3);
+      expect(response.activeUsersUnaltered).to.equal(1);
+      expect(response.idleUsersAltered).to.equal(3);
+      expect(response.idleUsersUnaltered).to.equal(1);
 
       const userStatus000Data = (await userStatusModel.doc("userStatus000").get()).data();
       expect(userStatus000Data.currentStatus.state).to.equal(userState.IDLE);

test/unit/models/taskBasedStatusUpdate.test.js

@@ -271,23 +271,23 @@ describe("Update Status based on task update", function () {
     it("should return the correct results when there are no errors", async function () {
       const result = await batchUpdateUsersStatus(listUsers);
       expect(result).to.have.all.keys(
-        "totalUsers",
-        "totalUnprocessedUsers",
-        "totalOnboardingUsersAltered",
-        "totalOnboardingUsersUnAltered",
-        "totalActiveUsersAltered",
-        "totalActiveUsersUnAltered",
-        "totalIdleUsersAltered",
-        "totalIdleUsersUnAltered"
+        "usersCount",
+        "unprocessedUsers",
+        "onboardingUsersAltered",
+        "onboardingUsersUnaltered",
+        "activeUsersAltered",
+        "activeUsersUnaltered",
+        "idleUsersAltered",
+        "idleUsersUnaltered"
       );
-      expect(result.totalUsers).to.equal(10);
-      expect(result.totalUnprocessedUsers).to.equal(0);
-      expect(result.totalOnboardingUsersAltered).to.equal(1);
-      expect(result.totalOnboardingUsersUnAltered).to.equal(1);
-      expect(result.totalActiveUsersAltered).to.equal(3);
-      expect(result.totalActiveUsersUnAltered).to.equal(1);
-      expect(result.totalIdleUsersAltered).to.equal(3);
-      expect(result.totalIdleUsersUnAltered).to.equal(1);
+      expect(result.usersCount).to.equal(10);
+      expect(result.unprocessedUsers).to.equal(0);
+      expect(result.onboardingUsersAltered).to.equal(1);
+      expect(result.onboardingUsersUnaltered).to.equal(1);
+      expect(result.activeUsersAltered).to.equal(3);
+      expect(result.activeUsersUnaltered).to.equal(1);
+      expect(result.idleUsersAltered).to.equal(3);
+      expect(result.idleUsersUnaltered).to.equal(1);
       const userStatus000Data = (await userStatusModel.doc("userStatus000").get()).data();
       expect(userStatus000Data.currentStatus.state).to.equal(userState.IDLE);
       const userStatus001Data = (await userStatusModel.doc("userStatus001").get()).data();