Batch operation to Migrate status COMPLETED to DONE in tasks model (#1691)

* written test for service file

* implement batch operation for task status from COMPLETED to DONE

Author: shubhamsinghbundela

services/tasks.js

@@ -0,0 +1,31 @@
+const firestore = require("../utils/firestore");
+const tasksModel = firestore.collection("tasks");
+const updateTaskStatusToDone = async (tasksData) => {
+  const batch = firestore.batch();
+  const tasksBatch = [];
+  const summary = {
+    totalUpdatedStatus: 0,
+    totalOperationsFailed: 0,
+    updatedTaskDetails: [],
+    failedTaskDetails: [],
+  };
+  tasksData.forEach((task) => {
+    const updateTaskData = { ...task, status: "DONE" };
+    batch.update(tasksModel.doc(task.id), updateTaskData);
+    tasksBatch.push(task.id);
+  });
+  try {
+    await batch.commit();
+    summary.totalUpdatedStatus += tasksData.length;
+    summary.updatedTaskDetails = [...tasksBatch];
+    return { ...summary };
+  } catch (err) {
+    logger.error("Firebase batch Operation Failed!");
+    summary.totalOperationsFailed += tasksData.length;
+    summary.failedTaskDetails = [...tasksBatch];
+    return { ...summary };
+  }
+};
+module.exports = {
+  updateTaskStatusToDone,
+};

test/unit/services/tasks.test.js

@@ -0,0 +1,74 @@
+const Sinon = require("sinon");
+const { expect } = require("chai");
+
+const firestore = require("../../../utils/firestore");
+const tasksModel = firestore.collection("tasks");
+const cleanDb = require("../../utils/cleanDb");
+const taskDataArray = require("../../fixtures/tasks/tasks")();
+const { updateTaskStatusToDone } = require("../../../services/tasks");
+
+describe("Tasks services", function () {
+  describe("task status COMPLETED to DONE in bulk", function () {
+    const tasks = [];
+    const taskDetails = [];
+    beforeEach(async function () {
+      const addTasksPromises = [];
+      taskDataArray.forEach((task) => {
+        const taskData = {
+          ...task,
+          status: "COMPLETED",
+        };
+        addTasksPromises.push(tasksModel.add(taskData));
+      });
+
+      await Promise.all(addTasksPromises);
+
+      tasks.length = 0;
+      taskDetails.length = 0;
+
+      const snapshot = await tasksModel.where("status", "==", "COMPLETED").get();
+
+      snapshot.forEach((task) => {
+        const id = task.id;
+        const taskData = task.data();
+        tasks.push({ ...taskData, id });
+        taskDetails.push(id);
+      });
+    });
+
+    afterEach(async function () {
+      await cleanDb();
+      Sinon.restore();
+    });
+
+    it("successfully updated task status COMPLETED To DONE", async function () {
+      const res = await updateTaskStatusToDone(tasks);
+
+      expect(res).to.deep.equal({
+        totalUpdatedStatus: 8,
+        totalOperationsFailed: 0,
+        updatedTaskDetails: taskDetails,
+        failedTaskDetails: [],
+      });
+    });
+
+    it("should throw an error if firebase batch operation fails", async function () {
+      const batchStub = Sinon.stub(firestore, "batch");
+      batchStub.returns({
+        update: function () {},
+        commit: function () {
+          throw new Error("Firebase batch operation failed");
+        },
+      });
+
+      const res = await updateTaskStatusToDone(tasks);
+
+      expect(res).to.deep.equal({
+        totalUpdatedStatus: 0,
+        totalOperationsFailed: 8,
+        updatedTaskDetails: [],
+        failedTaskDetails: taskDetails,
+      });
+    });
+  });
+});