refactor: github_api/search (#537)

* refactor: github_api/search

* refactor: github_api/search

* ran lint

Author: shine2lay

__fixtures__/unit/helper.js

@@ -217,6 +217,9 @@ module.exports = {
           get: () => {
             return { data: (options.deepValidation) ? options.deepValidation : {} }
           }
+        },
+        search: {
+          issuesAndPullRequests: jest.fn().mockReturnValue({ data: { items: options.issuesAndPullRequests || [] } })
         }
       },
       probotContext: {

__tests__/unit/github/api.test.js

@@ -22,6 +22,31 @@ describe('listFiles', () => {
     }
   })
 
+  describe('searchIssuesAndPR', () => {
+    test('return correct data if no error', async () => {
+      const issuesAndPR = [
+        'issues 1',
+        'PR 2'
+      ]
+
+      const res = await GithubAPI.searchIssuesAndPR(Helper.mockContext({ issuesAndPullRequests: issuesAndPR }))
+      expect(res).toEqual(issuesAndPR)
+    })
+
+    test('that error are re-thrown', async () => {
+      const context = Helper.mockContext()
+      context.octokit.search.issuesAndPullRequests = jest.fn().mockRejectedValue({ status: 402 })
+
+      try {
+        await GithubAPI.searchIssuesAndPR(context)
+        // Fail test if above expression doesn't throw anything.
+        expect(true).toBe(false)
+      } catch (e) {
+        expect(e.status).toBe(402)
+      }
+    })
+  })
+
   describe('getContent', () => {
     test('return correct data if no error', async () => {
       const content = 'This is the content'

lib/actions/merge.js

@@ -80,13 +80,13 @@ class Merge extends Action {
     let relatedPullRequests = []
     if (context.eventName === 'status') {
       const commitSHA = context.payload.sha
-      const results = await context.octokit.search.issuesAndPullRequests({
+      const results = await this.githubAPI.searchIssuesAndPR(context, {
         q: `repo:${context.repo().owner}/${context.repo().repo} is:open ${commitSHA}`.trim(),
         sort: 'updated',
         order: 'desc',
         per_page: 20
       })
-      relatedPullRequests = results.data.items.filter(item => item.pull_request)
+      relatedPullRequests = results.filter(item => item.pull_request)
     } else if (context.eventName === 'check_suite') {
       relatedPullRequests = this.getPayload(context).pull_requests
     } else {

lib/github/api.js

@@ -312,6 +312,20 @@ class GithubAPI {
       return checkCommonError(err, context, callFn)
     }
   }
+
+  static async searchIssuesAndPR (context, callParam) {
+    const callFn = 'search.issuesAndPullRequests'
+
+    debugLog(context, callFn)
+
+    try {
+      const res = await context.octokit.search.issuesAndPullRequests(callParam)
+
+      return res.data.items
+    } catch (err) {
+      return checkCommonError(err, context, callFn)
+    }
+  }
 }
 
 module.exports = GithubAPI

lib/validators/stale.js

@@ -77,15 +77,13 @@ class Stale extends Validator {
       ignoreQuery += 'no:project '
     }
     const labelQuery = labelMatchQuery.concat(labelIgnoreQuery).join(' ')
-    const results = await context.octokit.search.issuesAndPullRequests({
+    const items = await this.githubAPI.searchIssuesAndPR(context, {
       q: `repo:${context.repo().owner}/${context.repo().repo} is:open updated:<${timestamp}${typeQuery} ${labelQuery} ${ignoreQuery}`.trim(),
       sort: 'updated',
       order: 'desc',
       per_page: MAX_ISSUES
     })
 
-    const items = results.data.items
-
     const scheduleResult = {
       issues: items.filter(item => !item.pull_request),
       pulls: items.filter(item => item.pull_request)