Merge pull request #115 from Real-Dev-Squad/refactor-pullrequests-functions

refactored functions for pullrequests routes

Author: ankurnarkhede

controllers/pullRequestsController.js

@@ -7,29 +7,12 @@ const githubService = require('../services/githubService')
  * @param res {Object} - Express response object
  */
 
-const getPRdetails = async (req, res) => {
+const getUserPRs = async (req, res) => {
   try {
     const { data } = await githubService.fetchPRsByUser(req.params.username)
 
     if (data.total_count) {
-      const allPRs = []
-      data.items.forEach(({ title, html_url: url, state, created_at: createdAt, updated_at: updatedAt, repository_url: repositoryUrl, draft, labels, assignees }) => {
-        const allAssignees = assignees.map(object => object.login)
-        const allLabels = labels.map(object => object.name)
-        const repositoryUrlSplit = repositoryUrl.split('/')
-        const repository = repositoryUrlSplit[repositoryUrlSplit.length - 1]
-        allPRs.push({
-          title,
-          state,
-          createdAt,
-          updatedAt,
-          repository,
-          url,
-          readyForReview: state === 'closed' ? false : !draft,
-          labels: allLabels,
-          assignees: allAssignees
-        })
-      })
+      const allPRs = githubService.extractPRdetails(data)
       return res.json({
         message: 'Pull requests returned successfully!',
         pullRequests: allPRs
@@ -57,31 +40,7 @@ const getStalePRs = async (req, res) => {
     const { data } = await githubService.fetchStalePRs()
 
     if (data.total_count) {
-      const allPRs = []
-      data.items.forEach(({
-        title,
-        html_url: url,
-        state,
-        created_at: createdAt,
-        updated_at: updatedAt,
-        draft,
-        labels,
-        user,
-        assignees
-      }) => {
-        const allAssignees = assignees.map(object => object.login)
-        const allLabels = labels.map(object => object.name)
-        allPRs.push({
-          title,
-          state,
-          createdAt,
-          updatedAt,
-          url,
-          username: user.login,
-          labels: allLabels,
-          assignees: allAssignees
-        })
-      })
+      const allPRs = githubService.extractPRdetails(data)
       return res.json({
         message: 'Stale PRs',
         pullRequests: allPRs
@@ -109,31 +68,7 @@ const getOpenPRs = async (req, res) => {
     const { data } = await githubService.fetchOpenPRs((req.query.page) || 1)
 
     if (data.total_count) {
-      const allPRs = []
-      data.items.forEach(({
-        title,
-        html_url: url,
-        state,
-        created_at: createdAt,
-        updated_at: updatedAt,
-        draft,
-        labels,
-        user,
-        assignees
-      }) => {
-        const allAssignees = assignees.map(object => object.login)
-        const allLabels = labels.map(object => object.name)
-        allPRs.push({
-          title,
-          state,
-          createdAt,
-          updatedAt,
-          url,
-          username: user.login,
-          labels: allLabels,
-          assignees: allAssignees
-        })
-      })
+      const allPRs = githubService.extractPRdetails(data)
       return res.json({
         message: 'Open PRs',
         pullRequests: allPRs
@@ -150,7 +85,7 @@ const getOpenPRs = async (req, res) => {
 }
 
 module.exports = {
-  getPRdetails,
+  getUserPRs,
   getStalePRs,
   getOpenPRs
 }

routes/pullrequests.js

@@ -93,7 +93,6 @@ router.get('/stale', pullRequestController.getStalePRs)
  *             schema:
  *               $ref: '#/components/schemas/errors/badImplementation'
  */
-
-router.get('/user/:username', pullRequestController.getPRdetails)
+router.get('/user/:username', pullRequestController.getUserPRs)
 
 module.exports = router

services/githubService.js

@@ -1,13 +1,39 @@
 const { fetch } = require('../utils/fetch')
 const { fetchUser } = require('../models/users')
 
+/**
+ * Extracts only the necessary details required from the object returned by Github API
+ * @param data {Object} - Object returned by Github API
+ */
+
+const extractPRdetails = (data) => {
+  const allPRs = []
+  data.items.forEach(({ title, html_url: url, state, created_at: createdAt, updated_at: updatedAt, repository_url: repositoryUrl, labels, assignees }) => {
+    const allAssignees = assignees.map(object => object.login)
+    const allLabels = labels.map(object => object.name)
+    const repositoryUrlSplit = repositoryUrl.split('/')
+    const repository = repositoryUrlSplit[repositoryUrlSplit.length - 1]
+    allPRs.push({
+      title,
+      state,
+      createdAt,
+      updatedAt,
+      repository,
+      url,
+      labels: allLabels,
+      assignees: allAssignees
+    })
+  })
+  return allPRs
+}
+
 /**
  * Creates the custom API URL with the required params in the format
  * expected by Github
  * https://docs.github.com/en/free-pro-team@latest/rest/reference/search
  * @access private
- * @param {Object} searchParams - List of params to create github API URL
- * @param {Object} resultsOptions - Ordering and pagination of results
+ * @param searchParams {Object} - List of params to create github API URL
+ * @param resultsOptions {Object} - Ordering and pagination of results
  */
 const getGithubURL = (searchParams, resultsOptions = {}) => {
   const baseURL = config.get('githubApi.baseUrl')
@@ -43,7 +69,7 @@ const getGithubURL = (searchParams, resultsOptions = {}) => {
 
 /** Create the fetch object to call on github url
  * @access private
- * @param {string} url - URL on github to call
+ * @param url {string} - URL on github to call
  */
 function getFetch (url) {
   return fetch(url, 'get', null, null, null, {
@@ -62,13 +88,10 @@ function getFetch (url) {
 const fetchPRsByUser = async (username) => {
   try {
     const { user } = await fetchUser({ username })
-    const url = `${config.get('githubApi.baseUrl')}/search/issues?q=org:${config.get('githubApi.org')}+author:${user.github_id}+type:pr`
-    return fetch(url, 'get', null, null, null, {
-      auth: {
-        username: config.get('githubOauth.clientId'),
-        password: config.get('githubOauth.clientSecret')
-      }
+    const url = getGithubURL({
+      author: user.github_id
     })
+    return getFetch(url)
   } catch (err) {
     logger.error(`Error while fetching pull requests: ${err}`)
     throw err
@@ -120,5 +143,6 @@ const fetchOpenPRs = async (pageNumber) => {
 module.exports = {
   fetchPRsByUser,
   fetchOpenPRs,
-  fetchStalePRs
+  fetchStalePRs,
+  extractPRdetails
 }