Merge pull request #328 from Real-Dev-Squad/feat/pagination-PRs-routes

Adds pagination to `pullrequests` routes: `/stale` and `/open`

Author: ankurnarkhede

controllers/pullRequests.js

@@ -37,7 +37,8 @@ const getUserPRs = async (req, res) => {
  */
 const getStalePRs = async (req, res) => {
   try {
-    const { data } = await githubService.fetchStalePRs()
+    const { size, page } = req.query
+    const { data } = await githubService.fetchStalePRs(size, page)
 
     if (data.total_count) {
       const allPRs = githubService.extractPRdetails(data)
@@ -65,7 +66,8 @@ const getStalePRs = async (req, res) => {
  */
 const getOpenPRs = async (req, res) => {
   try {
-    const { data } = await githubService.fetchOpenPRs((req.query.page) || 1)
+    const { size, page } = req.query
+    const { data } = await githubService.fetchOpenPRs(size, page)
 
     if (data.total_count) {
       const allPRs = githubService.extractPRdetails(data)

routes/pullrequests.js

@@ -9,6 +9,17 @@ const pullRequest = require('../controllers/pullRequests')
  *     summary: Latest 10 Pull Requests in Real Dev Squad
  *     tags:
  *       - Pull Requests
+ *     parameters:
+ *        - in: query
+ *          name: size
+ *          schema:
+ *             type: integer
+ *          description: Number of pull requests to be returned
+ *        - in: query
+ *          name: page
+ *          schema:
+ *            type: integer
+ *          description: Page number for pagination
  *     responses:
  *       200:
  *         description: Pull Requests
@@ -40,6 +51,17 @@ router.get('/open', pullRequest.getOpenPRs)
  *     summary: All open Pull Requests in Real Dev Squad
  *     tags:
  *       - Pull Requests
+ *     parameters:
+ *        - in: query
+ *          name: size
+ *          schema:
+ *             type: integer
+ *          description: Number of pull requests to be returned
+ *        - in: query
+ *          name: page
+ *          schema:
+ *            type: integer
+ *          description: Page number for pagination
  *     responses:
  *       200:
  *         description: Pull Requests

services/githubService.js

@@ -99,18 +99,17 @@ const fetchPRsByUser = async (username) => {
 }
 
 /**
- * Fetches the oldest open N requests
- * @todo fetch N from query params
+ * Fetches the oldest open `per_page` requests
  */
-const fetchStalePRs = async () => {
+const fetchStalePRs = async (per_page = 10, page = 1) => {
   try {
     const url = getGithubURL({
       is: 'open'
     }, {
       sort: 'created',
       order: 'asc',
-      per_page: 5,
-      page: 1
+      per_page,
+      page
     })
     return getFetch(url)
   } catch (err) {
@@ -120,18 +119,17 @@ const fetchStalePRs = async () => {
 }
 
 /**
- * Fetches the latest 10 open PRs
- * @todo fetch N from query params
+ * Fetches the latest `per_page` open PRs
  */
-const fetchOpenPRs = async (pageNumber) => {
+const fetchOpenPRs = async (per_page = 10, page = 1) => {
   try {
     const url = getGithubURL({
       is: 'open'
     }, {
       sort: 'created',
       order: 'desc',
-      per_page: 10,
-      page: pageNumber
+      per_page,
+      page
     })
     return getFetch(url)
   } catch (err) {