refactor query to make it generic

Author: vinit717

controllers/tasks.js

@@ -11,6 +11,7 @@ const { transformQuery } = require("../utils/tasks");
 const { getPaginatedLink } = require("../utils/helper");
 const { updateUserStatusOnTaskUpdate, updateStatusOnTaskCompletion } = require("../models/userStatus");
 const dataAccess = require("../services/dataAccessLayer");
+const { parseSearchQuery } = require("../utils/tasks");
 /**
  * Creates new task
  *
@@ -130,29 +131,42 @@ const fetchTasks = async (req, res) => {
   try {
     const { dev, status, page, size, prev, next, q: queryString } = req.query;
     const transformedQuery = transformQuery(dev, status, size, page);
-    const searchTerm = queryString || "";
+
     if (dev) {
       const paginatedTasks = await fetchPaginatedTasks({ ...transformedQuery, prev, next });
       return res.json({
         message: "Tasks returned successfully!",
         ...paginatedTasks,
       });
     }
-    if (queryString) {
-      const filterTasks = await tasks.fetchTasks(searchTerm);
+
+    if (queryString !== undefined) {
+      const searchParams = parseSearchQuery(queryString);
+      const filterTasks = await tasks.fetchTasks(searchParams.searchTerm);
       const tasksWithRdsAssigneeInfo = await fetchTasksWithRdsAssigneeInfo(filterTasks);
+      if (tasksWithRdsAssigneeInfo.length === 0) {
+        return res.status(404).json({
+          message: "No tasks found.",
+          tasks: [],
+        });
+      }
       return res.json({
         message: "Filter tasks returned successfully!",
-        tasks: tasksWithRdsAssigneeInfo.length > 0 ? tasksWithRdsAssigneeInfo : [],
+        tasks: tasksWithRdsAssigneeInfo,
       });
     }
 
     const allTasks = await tasks.fetchTasks();
     const tasksWithRdsAssigneeInfo = await fetchTasksWithRdsAssigneeInfo(allTasks);
-
+    if (tasksWithRdsAssigneeInfo.length === 0) {
+      return res.status(404).json({
+        message: "No tasks found",
+        tasks: [],
+      });
+    }
     return res.json({
       message: "Tasks returned successfully!",
-      tasks: tasksWithRdsAssigneeInfo.length > 0 ? tasksWithRdsAssigneeInfo : [],
+      tasks: tasksWithRdsAssigneeInfo,
     });
   } catch (err) {
     logger.error(`Error while fetching tasks ${err}`);

middlewares/validators/tasks.js

@@ -164,7 +164,19 @@ const getTasksValidator = async (req, res, next) => {
         })
       ),
     size: joi.number().integer().positive().min(1).max(100).optional(),
-    q: joi.string().optional(),
+    q: joi
+      .string()
+      .optional()
+      .custom((value, helpers) => {
+        if (value && value.includes(":")) {
+          const [key] = value.split(":");
+          const allowedKeywords = ["searchterm", "assignee", "status"];
+          if (!allowedKeywords.includes(key.toLowerCase())) {
+            return helpers.error("any.invalid");
+          }
+        }
+        return value;
+      }, "Invalid query format"),
   });
 
   try {

test/integration/tasks.test.js

@@ -261,11 +261,8 @@ describe("Tasks", function () {
       expect(previousPageResponse.body).to.have.property("prev");
       expect(previousPageResponse.body.tasks).to.have.length(1);
     });
-  });
-
-  describe("GET /tasks/:id/details", function () {
     it("Should get tasks filtered by search term", function (done) {
-      const searchTerm = "search";
+      const searchTerm = "task";
       chai
         .request(app)
         .get(`/tasks?q=${encodeURIComponent(searchTerm)}`)
@@ -287,6 +284,27 @@ describe("Tasks", function () {
           return done();
         });
     });
+    it("Should get tasks filtered by search term and handle no tasks found", function (done) {
+      const searchTerm = " ";
+      chai
+        .request(app)
+        .get(`/tasks?q=searchTerm:"${encodeURIComponent(searchTerm)}"`)
+        .end((err, res) => {
+          if (err) {
+            return done(err);
+          }
+
+          expect(res).to.have.status(404);
+          expect(res.body).to.be.a("object");
+          expect(res.body.message).to.equal("No tasks found");
+          expect(res.body.tasks).to.be.a("array");
+          expect(res.body.tasks).to.have.lengthOf(0);
+          return done();
+        });
+    });
+  });
+
+  describe("GET /tasks/:id/details", function () {
     it("should return the task task with the Id that we provide in the route params", function (done) {
       chai
         .request(app)

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

@@ -333,19 +333,54 @@ describe("getTasks validator", function () {
     expect(nextMiddlewareSpy.callCount).to.be.equal(1);
   });
 
-  it("should pass the request when correct parameters are passed: page, dev, status, sixe and searchterm", async function () {
+  it("should pass the request when correct parameters are passed: page, dev, status and size", async function () {
     const req = {
       query: {
         dev: "true",
         size: 3,
         page: 0,
         status: TASK_STATUS.ASSIGNED,
-        q: "searchterm",
       },
     };
     const res = {};
     const nextMiddlewareSpy = Sinon.spy();
     await getTasksValidator(req, res, nextMiddlewareSpy);
     expect(nextMiddlewareSpy.callCount).to.be.equal(1);
   });
+  it("should pass the request when a valid query is provided", async function () {
+    const req = {
+      query: {
+        dev: "true",
+        size: 3,
+        page: 0,
+        status: TASK_STATUS.ASSIGNED,
+        q: "searchterm:apple",
+      },
+    };
+    const res = {};
+    const nextMiddlewareSpy = Sinon.spy();
+    await getTasksValidator(req, res, nextMiddlewareSpy);
+    expect(nextMiddlewareSpy.callCount).to.be.equal(1);
+  });
+  it("should fail the request when an invalid query is provided", async function () {
+    const req = {
+      query: {
+        dev: "true",
+        size: 3,
+        page: 0,
+        status: TASK_STATUS.ASSIGNED,
+        q: "invalidkey:value",
+      },
+    };
+    const res = {
+      boom: {
+        badRequest: (message) => {
+          expect(message).to.equal('"q" contains an invalid value');
+        },
+      },
+    };
+    const nextMiddlewareSpy = Sinon.spy();
+    await getTasksValidator(req, res, nextMiddlewareSpy);
+    expect(nextMiddlewareSpy.callCount).to.be.equal(0);
+  });
 });

test/unit/models/tasks.test.js

@@ -92,12 +92,20 @@ describe("tasks", function () {
       });
     });
     it("should fetch tasks filtered by search term", async function () {
-      const searchTerm = "task";
+      const searchTerm = "task-dependency";
       const tasksSnapshot = await tasksModel.get();
       const result = await getBuiltTasks(tasksSnapshot, searchTerm);
+      expect(result).to.have.lengthOf(1);
       result.forEach((task) => {
         expect(task.title.toLowerCase()).to.include(searchTerm.toLowerCase());
       });
+      expect(tasksData[5].title.includes(searchTerm));
+    });
+    it("should return empty array when no search term is found", async function () {
+      const searchTerm = "random";
+      const tasksSnapshot = await tasksModel.get();
+      const result = await getBuiltTasks(tasksSnapshot, searchTerm);
+      expect(result).to.have.lengthOf(0);
     });
   });
 

test/unit/utils/parseSearchQuery.test.js

@@ -0,0 +1,42 @@
+const { expect } = require("chai");
+const { parseSearchQuery } = require("../../../utils/tasks");
+
+describe("parseSearchQuery", function () {
+  it("should parse a valid query string", function () {
+    const queryString = "searchterm:example+assignee:john.doe+status:in_progress";
+    const result = parseSearchQuery(queryString);
+
+    expect(result).to.deep.equal({
+      searchTerm: "example",
+      assignee: "john.doe",
+      status: "in_progress",
+    });
+  });
+
+  it("should handle an empty query string", function () {
+    const queryString = "";
+    const result = parseSearchQuery(queryString);
+
+    expect(result).to.deep.equal({});
+  });
+
+  it("should ignore unknown keys in the query string", function () {
+    const queryString = "searchterm:example+assignee:john.doe+category:work";
+    const result = parseSearchQuery(queryString);
+
+    expect(result).to.deep.equal({
+      searchTerm: "example",
+      assignee: "john.doe",
+    });
+  });
+
+  it("should handle query string with duplicate keys", function () {
+    const queryString = "searchterm:example+searchterm:test+assignee:john.doe";
+    const result = parseSearchQuery(queryString);
+
+    expect(result).to.deep.equal({
+      searchTerm: "test",
+      assignee: "john.doe",
+    });
+  });
+});

utils/tasks.js

@@ -73,9 +73,32 @@ const transformQuery = (dev = false, status = "", size, page) => {
   return { status: transformedStatus, dev: transformedDev, ...query };
 };
 
+const parseSearchQuery = (queryString) => {
+  const searchParams = {};
+  const queryParts = queryString.split("+");
+  queryParts.forEach((part) => {
+    const [key, value] = part.split(":");
+    switch (key.toLowerCase()) {
+      case "searchterm":
+        searchParams.searchTerm = value.toLowerCase();
+        break;
+      case "assignee":
+        searchParams.assignee = value.toLowerCase();
+        break;
+      case "status":
+        searchParams.status = value.toLowerCase();
+        break;
+      default:
+        break;
+    }
+  });
+  return searchParams;
+};
+
 module.exports = {
   fromFirestoreData,
   toFirestoreData,
   buildTasks,
   transformQuery,
+  parseSearchQuery,
 };