I1712 migration script to add created at updated at in task doc (#1715)

* feat: add function to add createdAt and updatedAt fields

* feat: use migration function

* test: add test for migration script createdAt and updatedAt

* test: fix task count

* refactor: update task title

* refactor: fix typo

* refactor: move task totalTasks

* fix: fix test

Author: prakashchoudhary07

controllers/tasks.js

@@ -12,6 +12,7 @@ const { getPaginatedLink } = require("../utils/helper");
 const { updateUserStatusOnTaskUpdate, updateStatusOnTaskCompletion } = require("../models/userStatus");
 const dataAccess = require("../services/dataAccessLayer");
 const { parseSearchQuery } = require("../utils/tasks");
+const { addTaskCreatedAtAndUpdatedAtFields } = require("../services/tasks");
 /**
  * Creates new task
  *
@@ -432,6 +433,11 @@ const assignTask = async (req, res) => {
 
 const updateStatus = async (req, res) => {
   try {
+    const { action, field } = req.body;
+    if (action === "ADD" && field === "CREATED_AT+UPDATED_AT") {
+      const updateStats = await addTaskCreatedAtAndUpdatedAtFields();
+      return res.json(updateStats);
+    }
     const response = await tasks.updateTaskStatus();
     return res.status(200).json(response);
   } catch (error) {

services/tasks.js

@@ -1,5 +1,8 @@
 const firestore = require("../utils/firestore");
 const tasksModel = firestore.collection("tasks");
+const { chunks } = require("../utils/array");
+const { DOCUMENT_WRITE_SIZE: FIRESTORE_BATCH_OPERATIONS_LIMIT } = require("../constants/constants");
+
 const updateTaskStatusToDone = async (tasksData) => {
   const batch = firestore.batch();
   const tasksBatch = [];
@@ -26,6 +29,51 @@ const updateTaskStatusToDone = async (tasksData) => {
     return { ...summary };
   }
 };
+
+const addTaskCreatedAtAndUpdatedAtFields = async () => {
+  const operationStats = {
+    failedTasksIds: [],
+    totalFailedTasks: 0,
+    totalTasks: 0,
+  };
+  const updatedTasks = [];
+  const tasks = await tasksModel.get();
+
+  if (tasks.empty) {
+    return operationStats;
+  }
+
+  operationStats.totalTasks = tasks.size;
+
+  tasks.forEach(async (task) => {
+    const taskData = task.data();
+    taskData.createdAt = task.createTime.seconds;
+    taskData.updatedAt = task.updateTime.seconds;
+    updatedTasks.push({ id: task.id, data: taskData });
+  });
+
+  const multipleTasksUpdateBatch = [];
+  const chunkedTasks = chunks(updatedTasks, FIRESTORE_BATCH_OPERATIONS_LIMIT);
+
+  chunkedTasks.forEach(async (tasks) => {
+    const batch = firestore.batch();
+    tasks.forEach(({ id, data }) => {
+      batch.update(tasksModel.doc(id), data);
+    });
+    try {
+      await batch.commit();
+      multipleTasksUpdateBatch.push(batch);
+    } catch (error) {
+      operationStats.totalFailedTasks += tasks.length;
+      tasks.forEach(({ id }) => operationStats.failedTasksIds.push(id));
+    }
+  });
+
+  await Promise.allSettled(multipleTasksUpdateBatch);
+  return operationStats;
+};
+
 module.exports = {
   updateTaskStatusToDone,
+  addTaskCreatedAtAndUpdatedAtFields,
 };

test/integration/tasks.test.js

@@ -1138,5 +1138,35 @@ describe("Tasks", function () {
       const res = await chai.request(app).post("/tasks/migration").set("cookie", `${cookieName}=${nonSuperUserJwt}`);
       expect(res).to.have.status(401);
     });
+
+    // TASK createdAt and updatedAt migration script
+    it("Should update status createdAt and updatedAt", 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.totalFailedTasks).to.be.equal(0);
+      expect(res.body.totalTasks).to.be.equal(23);
+      expect(res.body.failedTasksIds).to.deep.equal([]);
+    });
+
+    it("should return failed stats if firestore batch operations fail for adding createdAt and updatedAt", async function () {
+      const stub = sinon.stub(firestore, "batch");
+      stub.returns({
+        update: function () {},
+        commit: function () {
+          throw new Error("Firestore batch commit failed!");
+        },
+      });
+      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.totalFailedTasks).to.be.equal(23);
+      expect(res.body.totalTasks).to.be.equal(23);
+      expect(res.body.failedTasksIds.length).to.equal(23);
+    });
   });
 });