Merge pull request #946 from khalatevarun/feat/filter-users

Feat: sorting and filtering users

Author: ankushdharkar

controllers/pullRequests.js

@@ -1,5 +1,6 @@
 const githubService = require("../services/githubService");
 const { SOMETHING_WENT_WRONG } = require("../constants/errorMessages");
+const { ORDER_TYPE } = require("../utils/pullRequests");
 
 /**
  * Collects all pull requests and sends only required data for each pull request
@@ -38,8 +39,9 @@ const getUserPRs = async (req, res) => {
  */
 const getStalePRs = async (req, res) => {
   try {
+    const order = ORDER_TYPE.ASC;
     const { size, page } = req.query;
-    const { data } = await githubService.fetchStalePRs(size, page);
+    const { data } = await githubService.fetchOpenPRs({ perPage: size, page, resultOptions: { order } });
 
     if (data.total_count) {
       const allPRs = githubService.extractPRdetails(data);
@@ -67,8 +69,9 @@ const getStalePRs = async (req, res) => {
  */
 const getOpenPRs = async (req, res) => {
   try {
+    const order = ORDER_TYPE.DESC;
     const { size, page } = req.query;
-    const { data } = await githubService.fetchOpenPRs(size, page);
+    const { data } = await githubService.fetchOpenPRs({ perPage: size, page, resultOptions: { order } });
 
     if (data.total_count) {
       const allPRs = githubService.extractPRdetails(data);

controllers/users.js

@@ -8,8 +8,10 @@ const { logType } = require("../constants/logs");
 const { fetch } = require("../utils/fetch");
 const logger = require("../utils/logger");
 const obfuscate = require("../utils/obfuscate");
-const { getPaginationLink } = require("../utils/users");
+const { getPaginationLink, getFilteredUsers } = require("../utils/users");
+const { getQualifiers } = require("../utils/helper");
 const { SOMETHING_WENT_WRONG, INTERNAL_SERVER_ERROR } = require("../constants/errorMessages");
+const { getFilteredPRsOrIssues } = require("../utils/pullRequests");
 
 const verifyUser = async (req, res) => {
   const userId = req.userData.id;
@@ -65,7 +67,23 @@ const getUserById = async (req, res) => {
 
 const getUsers = async (req, res) => {
   try {
-    const { allUsers, nextId, prevId } = await userQuery.fetchUsers(req.query);
+    const query = req.query?.query ?? "";
+    const qualifiers = getQualifiers(query);
+
+    if (qualifiers?.filterBy) {
+      const allPRs = await getFilteredPRsOrIssues(qualifiers);
+
+      const { allUsers } = await userQuery.fetchAllUsers();
+
+      const filteredUsers = getFilteredUsers(allPRs, allUsers);
+
+      return res.json({
+        message: "Users returned successfully!",
+        users: filteredUsers,
+      });
+    }
+
+    const { allUsers, nextId, prevId } = await userQuery.fetchPaginatedUsers(req.query);
 
     return res.json({
       message: "Users returned successfully!",

middlewares/validators/user.js

@@ -137,6 +137,7 @@ async function getUsers(req, res, next) {
         .messages({
           "string.empty": "prev value cannot be empty",
         }),
+      query: joi.string().optional(),
     });
   try {
     await schema.validateAsync(req.query);

models/users.js

@@ -129,7 +129,7 @@ const getSuggestedUsers = async (skill) => {
  * @param query { search, next, prev, size, page }: Filter for users
  * @return {Promise<userModel|Array>}
  */
-const fetchUsers = async (query) => {
+const fetchPaginatedUsers = async (query) => {
   try {
     // INFO: default user size set to 100
     // INFO: https://github.com/Real-Dev-Squad/website-backend/pull/873#discussion_r1064229932
@@ -178,6 +178,33 @@ const fetchUsers = async (query) => {
   }
 };
 
+const fetchAllUsers = async () => {
+  try {
+    const dbQuery = userModel;
+
+    const snapshot = await dbQuery.get();
+
+    const allUsers = [];
+
+    snapshot.forEach((doc) => {
+      allUsers.push({
+        id: doc.id,
+        ...doc.data(),
+        phone: undefined,
+        email: undefined,
+        tokens: undefined,
+        chaincode: undefined,
+      });
+    });
+    return {
+      allUsers,
+    };
+  } catch (err) {
+    logger.error("Error retrieving user data", err);
+    throw err;
+  }
+};
+
 /**
  * Fetches the user data from the the provided username or userId
  *
@@ -355,7 +382,7 @@ const getUsersBasedOnFilter = async (query) => {
 
 module.exports = {
   addOrUpdate,
-  fetchUsers,
+  fetchPaginatedUsers,
   fetchUser,
   setIncompleteUserDetails,
   initializeUser,
@@ -365,5 +392,6 @@ module.exports = {
   getJoinData,
   getSuggestedUsers,
   fetchUserSkills,
+  fetchAllUsers,
   getUsersBasedOnFilter,
 };

services/githubService.js

@@ -56,7 +56,6 @@ const getGithubURL = (searchParams, resultsOptions = {}) => {
 
   const defaultParams = {
     org: config.get("githubApi.org"),
-    type: "pr",
   };
 
   const finalSearchParams = Object.assign({}, defaultParams, searchParams);
@@ -102,6 +101,7 @@ const fetchPRsByUser = async (username) => {
     const { user } = await fetchUser({ username });
     const url = getGithubURL({
       author: user.github_id,
+      type: "pr",
     });
     return getFetch(url);
   } catch (err) {
@@ -111,55 +111,115 @@ const fetchPRsByUser = async (username) => {
 };
 
 /**
- * Fetches the oldest open `per_page` requests
+ * Fetches the latest `per_page` open PRs
+ *
+ * Order by default is desc, which will fetch latest open PRs,
+ * to fetch stale PRs just change pass order as asc
+ *
  */
-const fetchStalePRs = async (perPage = 10, page = 1) => {
+const fetchOpenPRs = async (params = {}) => {
+  const { perPage = 100, page = 1, searchParams = {}, resultOptions = {} } = params;
+
   try {
     const url = getGithubURL(
       {
+        type: "pr",
         is: "open",
+        ...searchParams,
       },
       {
         sort: "created",
-        order: "asc",
+        ...resultOptions,
         per_page: perPage,
         page,
       }
     );
     return getFetch(url);
   } catch (err) {
-    logger.error(`Error while fetching pull requests: ${err}`);
+    logger.error(`Error while fetching open pull requests: ${err}`);
     throw err;
   }
 };
 
-/**
- * Fetches the latest `per_page` open PRs
- */
-const fetchOpenPRs = async (perPage = 10, page = 1) => {
+const fetchMergedPRs = async (params = {}) => {
+  const { perPage = 100, page = 1, searchParams = {}, resultOptions = {} } = params;
+
   try {
     const url = getGithubURL(
       {
+        type: "pr",
+        is: "merged",
+        ...searchParams,
+      },
+      {
+        sort: "updated",
+        ...resultOptions,
+        per_page: perPage,
+        page,
+      }
+    );
+
+    return getFetch(url);
+  } catch (err) {
+    logger.error(`Error while fetching closed pull requests: ${err}`);
+    throw err;
+  }
+};
+
+const fetchOpenIssues = async (params = {}) => {
+  const { perPage = 100, page = 1, searchParams = {}, resultOptions = {} } = params;
+
+  try {
+    const url = getGithubURL(
+      {
+        type: "issue",
         is: "open",
+        ...searchParams,
       },
       {
         sort: "created",
-        order: "desc",
+        ...resultOptions,
         per_page: perPage,
         page,
       }
     );
     return getFetch(url);
   } catch (err) {
-    logger.error(`Error while fetching pull requests: ${err}`);
+    logger.error(`Error while fetching open issues: ${err}`);
+    throw err;
+  }
+};
+
+const fetchClosedIssues = async (params = {}) => {
+  const { perPage = 100, page = 1, searchParams = {}, resultOptions = {} } = params;
+
+  try {
+    const url = getGithubURL(
+      {
+        type: "issue",
+        is: "closed",
+        ...searchParams,
+      },
+      {
+        sort: "updated",
+        ...resultOptions,
+        per_page: perPage,
+        page,
+      }
+    );
+    return getFetch(url);
+  } catch (err) {
+    logger.error(`Error while fetching closed issues: ${err}`);
     throw err;
   }
 };
 
 module.exports = {
   fetchPRsByUser,
   fetchOpenPRs,
-  fetchStalePRs,
+  fetchMergedPRs,
   getFetch,
   extractPRdetails,
+  fetchOpenIssues,
+  fetchClosedIssues,
 };