Merge pull request #285 from crs-k/pagination

feature: pagination to handle repos with >100 branches

__mocks__/@actions/github.ts

@@ -1,3 +1,5 @@
+import {PaginateInterface} from '@octokit/plugin-paginate-rest'
+
 export const context = {
   repo: {
     owner: 'owner',
@@ -44,6 +46,8 @@ let createComment = jest.fn().mockReturnValue({
   data: {id: 1, owner: 'owner', repo: 'repo'}
 })
 
+let iterator = jest.fn().mockReturnValue(listBranches)
+
 const github = {
   rest: {
     git: {deleteRef},
@@ -58,6 +62,9 @@ const github = {
       listBranches,
       getCommit
     }
+  },
+  paginate: {
+    iterator
   }
 }
 

__tests__/functions/get-branches.test.ts

@@ -9,16 +9,10 @@ import {getBranches} from '../../src/functions/get-branches'
 import {github} from '../../src/functions/get-context'
 
 describe('Get Branches Function', () => {
-  test('getBranches endpoint is called', async () => {
+  test('github.paginate.iterator endpoint is called', async () => {
     await getBranches()
 
-    expect(github.rest.repos.listBranches).toHaveBeenCalledWith({
-      owner: 'owner',
-      repo: 'repo',
-      protected: false,
-      per_page: 100,
-      page: 1
-    })
+    expect(github.paginate.iterator).toHaveBeenCalled()
   })
 
   test('Action fails elegantly', async () => {
@@ -30,7 +24,7 @@ describe('Get Branches Function', () => {
 
     await getBranches()
     expect(core.setFailed).toHaveBeenCalledWith(
-      `Failed to retrieve branches for repo. Error: Response cannot be empty.`
+      `Failed to retrieve branches for repo. Error: o[Symbol.iterator] is not a function`
     )
     expect(core.setFailed).toHaveBeenCalledWith(`Failed to retrieve branches for repo.`)
   })

__tests__/functions/get-issues.test.ts

@@ -8,7 +8,7 @@ const assert = require('assert')
 import {getIssues} from '../../src/functions/get-issues'
 import {github} from '../../src/functions/get-context'
 
-describe('Get Commits Function', () => {
+describe('Get Issues Function', () => {
   beforeEach(() => {
     jest.clearAllMocks()
   })

__tests__/functions/get-time.test.ts

@@ -1,6 +1,6 @@
 import * as timeFuncs from '../../src/functions/get-time'
 
-describe('Time Functions', () => {
+describe('Get Time Functions', () => {
   let startDate = new Date('2022-01-24T01:45:30.000Z')
   let endDate = new Date('2022-01-22T01:45:30.000Z')
 

__tests__/functions/update-issue.test.ts

@@ -14,7 +14,7 @@ let branchName = 'test'
 let commitAge = 100
 let lastCommitter = 'crs-k'
 
-describe('Get Commits Function', () => {
+describe('Update Issue Function', () => {
   test('updateIssue endpoint is called with tag committer enabled', async () => {
     Object.defineProperty(context, 'commentUpdates', {value: true})
     Object.defineProperty(context, 'tagLastCommitter', {value: true})

package.json

@@ -23,24 +23,25 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@actions/core": "^1.6.0",
-    "@actions/github": "^5.0.0",
-    "@octokit/types": "^6.34.0",
-    "@types/semver": "^7.3.9",
-    "assert": "^2.0.0",
+    "@actions/core": "1.6.0",
+    "@actions/github": "5.0.0",
+    "@octokit/plugin-paginate-rest": "2.17.0",
+    "@octokit/types": "6.34.0",
+    "@types/semver": "7.3.9",
+    "assert": "2.0.0",
     "node-fetch": ">=3.1.1"
   },
   "devDependencies": {
-    "@types/jest": "^27.4.0",
-    "@types/node": "^17.0.18",
-    "@typescript-eslint/parser": "^5.12.0",
-    "@vercel/ncc": "^0.33.3",
-    "eslint": "^8.9.0",
-    "eslint-plugin-github": "^4.3.5",
-    "eslint-plugin-jest": "^26.1.1",
-    "js-yaml": "^4.1.0",
+    "@types/jest": "27.4.0",
+    "@types/node": "17.0.18",
+    "@typescript-eslint/parser": "5.12.0",
+    "@vercel/ncc": "0.33.3",
+    "eslint": "8.9.0",
+    "eslint-plugin-github": "4.3.5",
+    "eslint-plugin-jest": "26.1.1",
+    "js-yaml": "4.1.0",
     "prettier": "2.5.1",
-    "ts-jest": "^27.1.3",
-    "typescript": "^4.5.5"
+    "ts-jest": "27.1.3",
+    "typescript": "4.5.5"
   }
 }

src/functions/get-branches.ts

@@ -9,20 +9,25 @@ type ListBranchesResponseDataType = GetResponseTypeFromEndpointMethod<
 >
 
 export async function getBranches(): Promise<ListBranchesResponseDataType> {
-  let branches: ListBranchesResponseDataType
+  let branches = {} as ListBranchesResponseDataType
 
   try {
-    // Get info from the most recent release
-    const response = await github.rest.repos.listBranches({
+    const parameters = {
       owner,
       repo,
       protected: false,
-      per_page: 100,
-      page: 1
-    })
-    branches = response
+      per_page: 100
+    }
 
-    assert.ok(response, 'Response cannot be empty.')
+    for await (const response of github.paginate.iterator(
+      github.rest.repos.listBranches,
+      parameters
+    )) {
+      // do whatever you want with each response, break out of the loop, etc.
+      branches = response
+      core.info(`${branches.data.length} branches found`)
+      assert.ok(response, 'Response cannot be empty.')
+    }
   } catch (err) {
     if (err instanceof Error) {
       core.setFailed(`Failed to retrieve branches for ${repo}. Error: ${err.message}`)