Update migration script to update createdAt and updatedAt only if it exists (#1719)

* feat: avoid update if field already present

* test: add test to check if field update is happening again

Author: prakashchoudhary07

services/tasks.js

@@ -32,9 +32,11 @@ const updateTaskStatusToDone = async (tasksData) => {
 
 const addTaskCreatedAtAndUpdatedAtFields = async () => {
   const operationStats = {
-    failedTasksIds: [],
-    totalFailedTasks: 0,
     totalTasks: 0,
+    totalTaskToBeUpdate: 0,
+    totalTasksUpdated: 0,
+    totalFailedTasks: 0,
+    failedTasksIds: [],
   };
   const updatedTasks = [];
   const tasks = await tasksModel.get();
@@ -45,31 +47,39 @@ const addTaskCreatedAtAndUpdatedAtFields = async () => {
 
   operationStats.totalTasks = tasks.size;
 
-  tasks.forEach(async (task) => {
+  tasks.forEach((task) => {
     const taskData = task.data();
-    taskData.createdAt = task.createTime.seconds;
-    taskData.updatedAt = task.updateTime.seconds;
-    updatedTasks.push({ id: task.id, data: taskData });
+    let didAddField = false;
+    if (!taskData.createdAt) {
+      taskData.createdAt = task.createTime.seconds;
+      didAddField = true;
+    }
+    if (!taskData.updatedAt) {
+      taskData.updatedAt = task.updateTime.seconds;
+      didAddField = true;
+    }
+    if (didAddField) {
+      updatedTasks.push({ id: task.id, data: taskData });
+    }
   });
 
-  const multipleTasksUpdateBatch = [];
+  operationStats.totalTaskToBeUpdate = updatedTasks.length;
+
   const chunkedTasks = chunks(updatedTasks, FIRESTORE_BATCH_OPERATIONS_LIMIT);
 
-  chunkedTasks.forEach(async (tasks) => {
+  chunkedTasks.forEach((tasks) => {
     const batch = firestore.batch();
     tasks.forEach(({ id, data }) => {
       batch.update(tasksModel.doc(id), data);
     });
     try {
-      await batch.commit();
-      multipleTasksUpdateBatch.push(batch);
+      batch.commit();
+      operationStats.totalTasksUpdated += tasks.length;
     } catch (error) {
       operationStats.totalFailedTasks += tasks.length;
       tasks.forEach(({ id }) => operationStats.failedTasksIds.push(id));
     }
   });
-
-  await Promise.allSettled(multipleTasksUpdateBatch);
   return operationStats;
 };
 

test/integration/tasks.test.js

@@ -1196,12 +1196,12 @@ describe("Tasks", function () {
       jwt = authService.generateAuthToken({ userId });
       superUserJwt = authService.generateAuthToken({ userId: superUserId });
       // Add the active task
-      taskId = (await tasks.updateTask(tasksData[0])).taskId;
-      taskId = (await tasks.updateTask(tasksData[1])).taskId;
-      taskId = (await tasks.updateTask(tasksData[3])).taskId;
-      taskId = (await tasks.updateTask(tasksData[4])).taskId;
-      taskId = (await tasks.updateTask(tasksData[5])).taskId;
-      taskId = (await tasks.updateTask(tasksData[6])).taskId;
+      await tasks.updateTask(tasksData[0]);
+      await tasks.updateTask(tasksData[1]);
+      await tasks.updateTask(tasksData[3]);
+      await tasks.updateTask(tasksData[4]);
+      await tasks.updateTask(tasksData[5]);
+      await tasks.updateTask(tasksData[6]);
     });
     afterEach(async function () {
       await cleanDb();
@@ -1213,17 +1213,41 @@ describe("Tasks", function () {
 
     // TASK createdAt and updatedAt migration script
     it("Should update status createdAt and updatedAt", async function () {
+      // Add new tasks with createdAt and updatedAt present
+      await tasks.updateTask({ ...tasksData[7], createdAt: null, updatedAt: null });
+      await tasks.updateTask({ ...tasksData[8], createdAt: null, updatedAt: null });
+      await tasks.updateTask({ ...tasksData[9], updatedAt: null });
+      await tasks.updateTask({ ...tasksData[10], createdAt: null });
       const res = await chai.request(app).post("/tasks/migration").set("cookie", `${cookieName}=${superUserJwt}`).send({
         action: "ADD",
         field: "CREATED_AT+UPDATED_AT",
       });
       expect(res).to.have.status(200);
+      expect(res.body.totalTasks).to.be.equal(10);
+      expect(res.body.totalTaskToBeUpdate).to.be.equal(4);
+      expect(res.body.totalTasksUpdated).to.be.equal(4);
       expect(res.body.totalFailedTasks).to.be.equal(0);
+      expect(res.body.failedTasksIds).to.deep.equal([]);
+    });
+
+    it("Should update status createdAt and updatedAt, if filed doesn't exists", async function () {
+      const res = await chai.request(app).post("/tasks/migration").set("cookie", `${cookieName}=${superUserJwt}`).send({
+        action: "ADD",
+        field: "CREATED_AT+UPDATED_AT",
+      });
+      expect(res).to.have.status(200);
       expect(res.body.totalTasks).to.be.equal(6);
+      expect(res.body.totalTaskToBeUpdate).to.be.equal(0);
+      expect(res.body.totalTasksUpdated).to.be.equal(0);
+      expect(res.body.totalFailedTasks).to.be.equal(0);
       expect(res.body.failedTasksIds).to.deep.equal([]);
     });
 
     it("should return failed stats if firestore batch operations fail for adding createdAt and updatedAt", async function () {
+      await tasks.updateTask({ ...tasksData[7], createdAt: null, updatedAt: null });
+      await tasks.updateTask({ ...tasksData[8], createdAt: null, updatedAt: null });
+      await tasks.updateTask({ ...tasksData[9], updatedAt: null });
+      await tasks.updateTask({ ...tasksData[10], createdAt: null });
       const stub = sinon.stub(firestore, "batch");
       stub.returns({
         update: function () {},
@@ -1236,9 +1260,11 @@ describe("Tasks", function () {
         field: "CREATED_AT+UPDATED_AT",
       });
       expect(res).to.have.status(200);
-      expect(res.body.totalFailedTasks).to.be.equal(6);
-      expect(res.body.totalTasks).to.be.equal(6);
-      expect(res.body.failedTasksIds.length).to.equal(6);
+      expect(res.body.totalTasks).to.be.equal(10);
+      expect(res.body.totalTaskToBeUpdate).to.be.equal(4);
+      expect(res.body.totalTasksUpdated).to.be.equal(0);
+      expect(res.body.totalFailedTasks).to.be.equal(4);
+      expect(res.body.failedTasksIds.length).to.equal(4);
     });
   });
 });