Enhancement: Allow Null Values for startsOn and endsOn in /tasks PATCH Endpoint (#1756)

* test and code changes for task un assignment

* fix the failing test on ci cd pipeline

* resets the field internally for task update

* moved the payload update method to controller

* update the model test as previous

* remove the extra line

Author: heyrandhir

controllers/tasks.js

@@ -285,6 +285,18 @@ const updateTask = async (req, res) => {
       }
     }
 
+    // currently the task is assigned to a user and the superuser is trying to un assign this task from them.
+    if (
+      requestData?.status === TASK_STATUS.AVAILABLE &&
+      task.taskData.status !== TASK_STATUS.AVAILABLE &&
+      Object.keys(req.body).length === 1
+    ) {
+      requestData.assignee = null;
+      requestData.percentCompleted = 0;
+      requestData.startedOn = null;
+      requestData.endsOn = null;
+    }
+
     await tasks.updateTask(requestData, req.params.id);
     if (requestData.assignee) {
       // New Assignee Status Update

middlewares/validators/tasks.js

@@ -77,8 +77,8 @@ const updateTask = async (req, res, next) => {
       featureUrl: joi.string().optional(),
       type: joi.string().optional(),
       links: joi.array().items(joi.string()).optional(),
-      endsOn: joi.number().optional(),
-      startedOn: joi.number().optional(),
+      endsOn: joi.alternatives().try(joi.number().optional(), joi.valid(null)),
+      startedOn: joi.alternatives().try(joi.number().optional(), joi.valid(null)),
       category: joi.string().optional(),
       level: joi.number().optional(),
       status: joi

test/integration/tasks.test.js

@@ -1292,4 +1292,87 @@ describe("Tasks", function () {
       expect(res.body.failedTasksIds.length).to.equal(4);
     });
   });
+
+  describe("PATCH /tasks/:id should update the tasks by SuperUser", function () {
+    beforeEach(async function () {
+      const superUserId = await addUser(superUser);
+      superUserJwt = authService.generateAuthToken({ userId: superUserId });
+
+      await firestore.collection("tasks").doc("4kAkRv9TBlOfR6WEUhoQ").set({
+        assignee: "SooJK37gzjIZfFNH0tlL",
+        status: "IN_PROGRESS",
+        percentCompleted: 80,
+        startedOn: 1701388800000,
+        endsOn: 1701561600000,
+      });
+    });
+
+    afterEach(async function () {
+      await firestore.collection("tasks").doc("4kAkRv9TBlOfR6WEUhoQ").delete();
+    });
+
+    it("Should unassign the task with other fields reset exclusively", async function () {
+      const res = await chai
+        .request(app)
+        .patch(`/tasks/4kAkRv9TBlOfR6WEUhoQ`)
+        .set("cookie", `${cookieName}=${superUserJwt}`)
+        .send({
+          assignee: null,
+          status: TASK_STATUS.AVAILABLE,
+          percentCompleted: 0,
+          startedOn: null,
+          endsOn: null,
+        });
+
+      expect(res).to.have.status(204);
+
+      const docSnapshot = await firestore.collection("tasks").doc("4kAkRv9TBlOfR6WEUhoQ").get();
+
+      const updatedData = docSnapshot.data();
+      expect(updatedData.assignee).to.equal(null);
+      expect(updatedData.status).to.equal(TASK_STATUS.AVAILABLE);
+      expect(updatedData.percentCompleted).to.equal(0);
+      expect(updatedData.startedOn).to.equal(null);
+      expect(updatedData.endsOn).to.equal(null);
+    });
+
+    it("Should unassign the task with other fields reset internally", async function () {
+      const res = await chai
+        .request(app)
+        .patch(`/tasks/4kAkRv9TBlOfR6WEUhoQ`)
+        .set("cookie", `${cookieName}=${superUserJwt}`)
+        .send({
+          status: TASK_STATUS.AVAILABLE,
+        });
+
+      expect(res).to.have.status(204);
+
+      const docSnapshot = await firestore.collection("tasks").doc("4kAkRv9TBlOfR6WEUhoQ").get();
+
+      const updatedData = docSnapshot.data();
+      expect(updatedData.assignee).to.equal(null);
+      expect(updatedData.status).to.equal(TASK_STATUS.AVAILABLE);
+      expect(updatedData.percentCompleted).to.equal(0);
+      expect(updatedData.startedOn).to.equal(null);
+      expect(updatedData.endsOn).to.equal(null);
+    });
+
+    it("Should throw bad request if the req body is invalid", async function () {
+      const res = await chai
+        .request(app)
+        .patch(`/tasks/4kAkRv9TBlOfR6WEUhoQ`)
+        .set("cookie", `${cookieName}=${superUserJwt}`)
+        .send({
+          assignee: null,
+          status: TASK_STATUS.AVAILABLE,
+          percentCompleted: 0,
+          startedOn: "null",
+          endsOn: false,
+        });
+
+      expect(res).to.have.status(400);
+      expect(res.body.error).to.equal("Bad Request");
+      expect(res.body.message).to.equal('"endsOn" must be one of [number, null]');
+    });
+  });
 });

test/unit/middlewares/tasks-validator.test.js

@@ -1,5 +1,9 @@
 const Sinon = require("sinon");
-const { getTasksValidator, createTask } = require("../../../middlewares/validators/tasks");
+const {
+  getTasksValidator,
+  createTask,
+  updateTask: updateTaskValidator,
+} = require("../../../middlewares/validators/tasks");
 const { expect } = require("chai");
 const { TASK_STATUS } = require("../../../constants/tasks");
 
@@ -520,4 +524,95 @@ describe("getTasks validator", function () {
     }
     expect(nextMiddlewareSpy.callCount).to.be.equal(0);
   });
+
+  it("should call nextMiddlewareSpy for updateTaskValidator if startedOn is null", async function () {
+    const req = {
+      body: {
+        startedOn: null,
+        endsOn: new Date().getTime(),
+      },
+    };
+    const res = { boom: { badRequest: Sinon.spy() } };
+    const nextMiddlewareSpy = Sinon.spy();
+    await updateTaskValidator(req, res, nextMiddlewareSpy);
+    expect(nextMiddlewareSpy.callCount).to.be.equal(1);
+  });
+
+  it("should call nextMiddlewareSpy for updateTaskValidator if endsOn is null", async function () {
+    const req = {
+      body: {
+        startedOn: new Date().getTime(),
+        endsOn: null,
+      },
+    };
+    const res = { boom: { badRequest: Sinon.spy() } };
+    const nextMiddlewareSpy = Sinon.spy();
+    await updateTaskValidator(req, res, nextMiddlewareSpy);
+    expect(nextMiddlewareSpy.callCount).to.be.equal(1);
+  });
+
+  it("should call nextMiddlewareSpy for updateTaskValidator if both startedOn and endsOn are null", async function () {
+    const req = {
+      body: {
+        startedOn: null,
+        endsOn: null,
+      },
+    };
+    const res = { boom: { badRequest: Sinon.spy() } };
+    const nextMiddlewareSpy = Sinon.spy();
+    await updateTaskValidator(req, res, nextMiddlewareSpy);
+    expect(nextMiddlewareSpy.callCount).to.be.equal(1);
+  });
+
+  it("should call nextMiddlewareSpy for updateTaskValidator if both startedOn and endsOn are valid number", async function () {
+    const req = {
+      body: {
+        startedOn: new Date("2023-11-15").getTime(),
+        endsOn: new Date("2023-11-18").getTime(),
+      },
+    };
+    const res = { boom: { badRequest: Sinon.spy() } };
+    const nextMiddlewareSpy = Sinon.spy();
+    await updateTaskValidator(req, res, nextMiddlewareSpy);
+    expect(nextMiddlewareSpy.callCount).to.be.equal(1);
+  });
+
+  it("should not call nextMiddlewareSpy for updateTaskValidator if startedOn is not null or a number", async function () {
+    const req = {
+      body: {
+        startedOn: "December 6 2023",
+        endsOn: new Date().getTime(),
+      },
+    };
+    const res = { boom: { badRequest: Sinon.spy() } };
+    const nextMiddlewareSpy = Sinon.spy();
+    await updateTaskValidator(req, res, nextMiddlewareSpy);
+    expect(nextMiddlewareSpy.callCount).to.be.equal(0);
+  });
+
+  it("should not call nextMiddlewareSpy for updateTaskValidator if endsOn is not null or a number", async function () {
+    const req = {
+      body: {
+        startedOn: new Date().getTime(),
+        endsOn: true,
+      },
+    };
+    const res = { boom: { badRequest: Sinon.spy() } };
+    const nextMiddlewareSpy = Sinon.spy();
+    await updateTaskValidator(req, res, nextMiddlewareSpy);
+    expect(nextMiddlewareSpy.callCount).to.be.equal(0);
+  });
+
+  it("should not call nextMiddlewareSpy for updateTaskValidator if both startedOn and endsOn is not null or a number", async function () {
+    const req = {
+      body: {
+        startedOn: "December 6 2023",
+        endsOn: true,
+      },
+    };
+    const res = { boom: { badRequest: Sinon.spy() } };
+    const nextMiddlewareSpy = Sinon.spy();
+    await updateTaskValidator(req, res, nextMiddlewareSpy);
+    expect(nextMiddlewareSpy.callCount).to.be.equal(0);
+  });
 });