feat: get users based on their profile status

Author: lakshayman

controllers/users.js

@@ -90,7 +90,7 @@ const getUserById = async (req, res) => {
 const getUsers = async (req, res) => {
   try {
     // getting user details by id if present.
-    const { q, dev: devParam, query } = req.query;
+    const { q, dev: devParam, query, profileStatus } = req.query;
     const dev = devParam === "true";
     const queryString = (dev ? q : query) || "";
     const transformedQuery = parseSearchQuery(queryString);
@@ -136,6 +136,20 @@ const getUsers = async (req, res) => {
       }
     }
 
+    if (profileStatus) {
+      try {
+        const users = await userQuery.fetchUserForKeyValue("profileStatus", profileStatus);
+        return res.json({
+          message: `Users with profile status ${profileStatus} returned successfully!`,
+          count: users.length,
+          users: users,
+        });
+      } catch (error) {
+        logger.error(`Error while fetching users with profile status ${profileStatus}: ${error}`);
+        return res.boom.serverUnavailable(SOMETHING_WENT_WRONG);
+      }
+    }
+
     if (!transformedQuery?.days && transformedQuery?.filterBy === "unmerged_prs") {
       return res.boom.badRequest(`Days is required for filterBy ${transformedQuery?.filterBy}`);
     }

middlewares/validators/user.js

@@ -197,6 +197,9 @@ async function getUsers(req, res, next) {
       query: joi.string().optional(),
       q: joi.string().optional(),
       profile: joi.string().valid("true").optional(),
+      profileStatus: joi.string().optional().messages({
+        "string.empty": "profileStatus value must not be empty",
+      }),
       filterBy: joi.string().optional(),
       days: joi.string().optional(),
       dev: joi.string().optional(),
@@ -368,6 +371,7 @@ const migrationsValidator = async (req, res, next) => {
     res.boom.badRequest("Invalid Query Parameters Passed");
   }
 };
+
 module.exports = {
   updateUser,
   updateProfileURL,

test/integration/users.test.js

@@ -974,6 +974,47 @@ describe("Users", function () {
           return done();
         });
     });
+
+    it("Should return users filtered by profile status", function (done) {
+      chai
+        .request(app)
+        .get("/users?profileStatus=BLOCKED")
+        .end((err, res) => {
+          if (err) {
+            return done(err);
+          }
+          expect(res).to.have.status(200);
+          expect(res.body).to.be.a("object");
+          expect(res.body.message).to.equal("Users with profile status BLOCKED returned successfully!");
+          expect(res.body.users).to.be.a("array");
+          expect(res.body.count).to.be.a("number");
+
+          res.body.users.forEach((user) => {
+            expect(user.profileStatus).to.equal("BLOCKED");
+          });
+
+          return done();
+        });
+    });
+
+    it("Should return empty array when no users with specified profile status", function (done) {
+      chai
+        .request(app)
+        .get("/users?profileStatus=NON_EXISTENT_STATUS")
+        .end((err, res) => {
+          if (err) {
+            return done(err);
+          }
+          expect(res).to.have.status(200);
+          expect(res.body).to.be.a("object");
+          expect(res.body.message).to.equal("Users with profile status NON_EXISTENT_STATUS returned successfully!");
+          expect(res.body.users).to.be.a("array");
+          expect(res.body.count).to.equal(0);
+          expect(res.body.users).to.have.length(0);
+
+          return done();
+        });
+    });
   });
 
   describe("GET /users/self", function () {

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

@@ -488,6 +488,20 @@ describe("Middleware | Validators | User", function () {
       expect(next.calledOnce).to.be.equal(true);
     });
 
+    it("Allows the request with profileStatus parameter to pass to next", async function () {
+      const req = {
+        query: {
+          profileStatus: "BLOCKED",
+        },
+      };
+
+      const res = {};
+      const next = sinon.spy();
+
+      await getUsers(req, res, next);
+      expect(next.calledOnce).to.be.equal(true);
+    });
+
     it("Stops the request for passing on to next", async function () {
       const req = {
         query: {