chore: update @octokit/rest from v16 to v17 (#371)

* chore: replace deprecated .hasLastPage() with pagination

This is a prerequisite for updating @octokit/rest.

* chore: update @octokit/rest from v16 to v17

Author: Trott

lib/push-jenkins-update.js

@@ -77,20 +77,16 @@ function findPrInRef (gitRef) {
   return parseInt(gitRef.split('/')[2], 10)
 }
 
-async function findLatestCommitInPr (options, pageNumber = 1) {
-  const res = await githubClient.pulls.listCommits({
+async function findLatestCommitInPr (options) {
+  const { Octokit } = require('@octokit/rest')
+  const githubClient = new Octokit({})
+  const paginateOptions = githubClient.pulls.listCommits.endpoint.merge({
     owner: options.owner,
     repo: options.repo,
-    pull_number: options.pr,
-    page: pageNumber,
-    per_page: 100
+    pull_number: options.pr
   })
+  const commitMetas = await githubClient.paginate(paginateOptions)
 
-  const commitMetas = res.data || []
-  const lastPageURL = githubClient.hasLastPage(res)
-  if (lastPageURL) {
-    return findLatestCommitInPr(options, pageNumberFromURL(lastPageURL))
-  }
   const lastCommitMeta = commitMetas.pop()
   const lastCommit = {
     sha: lastCommitMeta.sha,
@@ -123,10 +119,6 @@ function validate (payload) {
   return ['identifier', 'status', 'message', 'commit', 'url'].every(isString)
 }
 
-function pageNumberFromURL (githubUrl) {
-  return new URL(githubUrl).searchParams.get('page')
-}
-
 exports.validate = validate
 exports.pushStarted = pushStarted
 exports.pushEnded = pushEnded

package-lock.json

@@ -13,7 +13,7 @@
   "private": true,
   "license": "MIT",
   "dependencies": {
-    "@octokit/rest": "^16.43.2",
+    "@octokit/rest": "^17.11.2",
     "aigle": "^1.14.1",
     "async": "3.2.4",
     "basic-auth": "^2.0.1",

package.json

@@ -4,32 +4,41 @@ const { findLatestCommitInPr } = require('../../lib/push-jenkins-update')
 
 const nock = require('nock')
 const readFixture = require('../read-fixture')
-const { ignoreQueryParams } = require('../common')
 
 tap.test('findLatestCommitInPr: paginates results when more than 100 commits in a PR', async (t) => {
-  const commitsFixturePage1 = readFixture('pull-requests-commits-page-1.json')
-  const commitsFixturePage104 = readFixture('pull-requests-commits-page-104.json')
+  const commitsFixturePage1 = readFixture('pull-request-commits-page-1.json')
+  const commitsFixturePage2 = readFixture('pull-request-commits-page-2.json')
+  const commitsFixturePage3 = readFixture('pull-request-commits-page-3.json')
+  const commitsFixturePage4 = readFixture('pull-request-commits-page-4.json')
   const owner = 'nodejs'
   const repo = 'node'
   const pr = 9745
 
-  const headers = {
-    Link: '<https://api.github.com/repos/nodejs/node/pulls/9745/commits?page=104>; rel="last"'
-  }
   const firstPageScope = nock('https://api.github.com')
-    .filteringPath(ignoreQueryParams)
     .get(`/repos/${owner}/${repo}/pulls/${pr}/commits`)
-    .reply(200, commitsFixturePage1, headers)
+    .reply(200, commitsFixturePage1, { link: '<https://api.github.com/repositories/27193779/pulls/9745/commits?page=2>; rel="next", <https://api.github.com/repositories/27193779/pulls/9745/commits?page=4>; rel="last"' })
 
-  const lastPageScope = nock('https://api.github.com')
-    .get(`/repos/${owner}/${repo}/pulls/${pr}/commits`)
-    .query({ page: 104, per_page: 100 })
-    .reply(200, commitsFixturePage104)
+  const secondPageScope = nock('https://api.github.com')
+    .get(`/repositories/27193779/pulls/${pr}/commits`)
+    .query({ page: 2 })
+    .reply(200, commitsFixturePage2, { link: '<https://api.github.com/repositories/27193779/pulls/9745/commits?page=1>; rel="prev", <https://api.github.com/repositories/27193779/pulls/9745/commits?page=3>; rel="next", <https://api.github.com/repositories/27193779/pulls/9745/commits?page=4>; rel="last", <https://api.github.com/repositories/27193779/pulls/9745/commits?page=1>; rel="first"' })
+
+  const thirdPageScope = nock('https://api.github.com')
+    .get(`/repositories/27193779/pulls/${pr}/commits`)
+    .query({ page: 3 })
+    .reply(200, commitsFixturePage3, { link: '<https://api.github.com/repositories/27193779/pulls/9745/commits?page=2>; rel="prev", <https://api.github.com/repositories/27193779/pulls/9745/commits?page=4>; rel="next", <https://api.github.com/repositories/27193779/pulls/9745/commits?page=4>; rel="last", <https://api.github.com/repositories/27193779/pulls/9745/commits?page=1>; rel="first"' })
+
+  const fourthPageScope = nock('https://api.github.com')
+    .get(`/repositories/27193779/pulls/${pr}/commits`)
+    .query({ page: 4 })
+    .reply(200, commitsFixturePage4, { link: '<https://api.github.com/repositories/27193779/pulls/9745/commits?page=3>; rel="prev", <https://api.github.com/repositories/27193779/pulls/9745/commits?page=1>; rel="first"' })
 
   t.plan(1)
 
   const commit = await findLatestCommitInPr({ owner, repo, pr })
   t.equal(commit.sha, 'c1aa949064892dbe693750686c06f4ad5673e577')
   firstPageScope.done()
-  lastPageScope.done()
+  secondPageScope.done()
+  thirdPageScope.done()
+  fourthPageScope.done()
 })