Merge pull request #1065 from Real-Dev-Squad/bug/handling-no-users-found-case-in-case-of-filter

Author: ankushdharkar

controllers/users.js

@@ -449,12 +449,12 @@ const filterUsers = async (req, res) => {
     if (!Object.keys(req.query).length) {
       return res.boom.badRequest("filter for item not provided");
     }
-    const allUsers = await userQuery.getUsersBasedOnFilter(req.query);
+    const users = await userQuery.getUsersBasedOnFilter(req.query);
 
     return res.json({
-      message: "Users found successfully!",
-      users: allUsers,
-      count: allUsers.length,
+      message: users.length ? "Users found successfully!" : "No users found",
+      users,
+      count: users.length,
     });
   } catch (error) {
     logger.error(`Error while fetching all users: ${error}`);

middlewares/validators/user.js

@@ -172,14 +172,17 @@ async function validateUserQueryParams(req, res, next) {
           joi.array().items(joi.string().valid("IDLE", "OOO", "ACTIVE"))
         )
         .optional(),
+    })
+    .messages({
+      "object.min": "Please provide at least one filter criteria",
     });
 
   try {
     await schema.validateAsync(req.query);
     next();
   } catch (error) {
     logger.error(`Error validating query params : ${error}`);
-    res.boom.badRequest(error.details[0].message);
+    res.boom.badRequest(error);
   }
 }
 

models/users.js

@@ -395,18 +395,24 @@ const getUsersBasedOnFilter = async (query) => {
   let finalItems = [];
 
   if (doesTagQueryExist && doesStateQueryExist) {
-    const stateItemIds = new Set(stateItems.map((item) => item.userId));
-    finalItems = tagItems.filter((item) => stateItemIds.has(item.itemId)).map((item) => item.itemId);
+    if (stateItems.length && tagItems.length) {
+      const stateItemIds = new Set(stateItems.map((item) => item.userId));
+      finalItems = tagItems.filter((item) => stateItemIds.has(item.itemId)).map((item) => item.itemId);
+    }
   } else if (doesStateQueryExist) {
     finalItems = stateItems.map((item) => item.userId);
   } else if (doesTagQueryExist) {
     finalItems = tagItems.map((item) => item.itemId);
   }
 
-  finalItems = [...new Set(finalItems)];
-  const userRefs = finalItems.map((itemId) => userModel.doc(itemId));
-  const userDocs = (await firestore.getAll(...userRefs)).map((doc) => ({ id: doc.id, ...doc.data() }));
-  return userDocs;
+  if (finalItems.length) {
+    finalItems = [...new Set(finalItems)];
+    const userRefs = finalItems.map((itemId) => userModel.doc(itemId));
+    const userDocs = (await firestore.getAll(...userRefs)).map((doc) => ({ id: doc.id, ...doc.data() }));
+    const filteredUserDocs = userDocs.filter((doc) => !doc.roles?.archived);
+    return filteredUserDocs;
+  }
+  return [];
 };
 
 module.exports = {

test/integration/usersFilter.test.js

@@ -121,7 +121,7 @@ describe("Filter Users", function () {
   });
 
   // eslint-disable-next-line mocha/no-skipped-tests
-  describe.skip("GET /users/search", function () {
+  describe("GET /users/search", function () {
     it("Should search users based on state", function (done) {
       chai
         .request(app)
@@ -203,7 +203,7 @@ describe("Filter Users", function () {
           expect(res.body.message).to.equal("Users found successfully!");
           expect(res.body.users).to.be.a("array");
           expect(res.body.users.length).to.equal(2);
-          assertUserIds(res.body.users, [activeUser, oooUser, idleUser]);
+          assertUserIds(res.body.users, [oooUser, idleUser]);
           return done();
         });
     });