use octokit throttling plugin instead of retry plugin (#192)

Author: harjotgill

dist/index.js

@@ -29,7 +29,7 @@
     "@actions/github": "^5.1.1",
     "@dqbd/tiktoken": "^1.0.6",
     "@octokit/action": "^5.0.2",
-    "@octokit/plugin-retry": "^4.1.3",
+    "@octokit/plugin-throttling": "^5.0.1",
     "minimatch": "^9.0.0",
     "node-fetch": "^3.3.1",
     "p-limit": "^4.0.0"

package-lock.json

@@ -1,19 +1,7 @@
 /* eslint-disable @typescript-eslint/explicit-function-return-type */
 import * as core from '@actions/core'
 import * as github from '@actions/github'
-import {Octokit} from '@octokit/action'
-import {retry} from '@octokit/plugin-retry'
-
-const token = core.getInput('token') || process.env.GITHUB_TOKEN
-
-const RetryOctokit = Octokit.plugin(retry)
-const octokit = new RetryOctokit({
-  auth: `token ${token}`,
-  request: {
-    retries: 10,
-    retryAfter: 30
-  }
-})
+import {octokit} from './octokit.js'
 
 const context = github.context
 const repo = context.repo
@@ -167,40 +155,38 @@ ${tag}`
       `Submitting review for PR #${pull_number}, total comments: ${this.reviewCommentsBuffer.length}`
     )
     try {
-      let batchNumber = 1
-      while (this.reviewCommentsBuffer.length > 0) {
-        const commentsBatch = this.reviewCommentsBuffer.splice(0, 30)
-        core.info(
-          `Posting batch #${batchNumber} with ${commentsBatch.length} comments`
-        )
-
-        await octokit.pulls.createReview({
-          owner: repo.owner,
-          repo: repo.repo,
-          pull_number,
-          commit_id,
-          event: 'COMMENT',
-          comments: commentsBatch.map(comment => {
-            const commentData: any = {
-              path: comment.path,
-              body: comment.message,
-              line: comment.end_line,
-              start_side: 'RIGHT'
-            }
-
-            if (comment.start_line !== comment.end_line) {
-              commentData.start_line = comment.start_line
-            }
-
-            return commentData
+      let commentCounter = 0
+      for (const comment of this.reviewCommentsBuffer) {
+        core.info(`Posting comment: ${comment.message}`)
+
+        if (comment.start_line !== comment.end_line) {
+          await octokit.pulls.createReviewComment({
+            owner: repo.owner,
+            repo: repo.repo,
+            pull_number,
+            commit_id,
+            body: comment.message,
+            path: comment.path,
+            line: comment.end_line,
+            start_side: 'RIGHT',
+            start_line: comment.start_line
+          })
+        } else {
+          await octokit.pulls.createReviewComment({
+            owner: repo.owner,
+            repo: repo.repo,
+            pull_number,
+            commit_id,
+            body: comment.message,
+            path: comment.path,
+            line: comment.end_line
           })
-        })
-
-        if (this.reviewCommentsBuffer.length > 0) {
-          core.info(`Waiting 10 seconds before posting next batch`)
-          await new Promise(resolve => setTimeout(resolve, 10000))
         }
-        batchNumber++
+
+        commentCounter++
+        core.info(
+          `Comment ${commentCounter}/${this.reviewCommentsBuffer.length} posted`
+        )
       }
     } catch (e) {
       core.warning(`Failed to submit review: ${e}`)

package.json

@@ -0,0 +1,32 @@
+import * as core from '@actions/core'
+import {Octokit} from '@octokit/action'
+import {throttling} from '@octokit/plugin-throttling'
+
+const token = core.getInput('token') || process.env.GITHUB_TOKEN
+
+const ThrottlingOctokit = Octokit.plugin(throttling)
+export const octokit = new ThrottlingOctokit({
+  auth: `token ${token}`,
+  throttle: {
+    onRateLimit: (
+      retryAfter: number,
+      options: any,
+      o: Octokit,
+      retryCount: number
+    ) => {
+      core.warning(
+        `Request quota exhausted for request ${options.method} ${options.url}
+Retry after: ${retryAfter} seconds
+Retry count: ${retryCount}
+`
+      )
+      return true
+    },
+    onSecondaryRateLimit: (retryAfter: number, options: any, o: Octokit) => {
+      core.warning(
+        `SecondaryRateLimit detected for request ${options.method} ${options.url}`
+      )
+      return true
+    }
+  }
+})

src/commenter.ts

@@ -1,7 +1,5 @@
 import * as core from '@actions/core'
 import * as github from '@actions/github'
-import {Octokit} from '@octokit/action'
-import {retry} from '@octokit/plugin-retry'
 import {Bot} from './bot.js'
 import {
   Commenter,
@@ -10,22 +8,10 @@ import {
   EXTRA_CONTENT_TAG,
   SUMMARIZE_TAG
 } from './commenter.js'
+import {octokit} from './octokit.js'
 import {Inputs, Options, Prompts} from './options.js'
 import * as tokenizer from './tokenizer.js'
 
-const token = core.getInput('token')
-  ? core.getInput('token')
-  : process.env.GITHUB_TOKEN
-
-const RetryOctokit = Octokit.plugin(retry)
-const octokit = new RetryOctokit({
-  auth: `token ${token}`,
-  request: {
-    retries: 10,
-    retryAfter: 30
-  }
-})
-
 const context = github.context
 const repo = context.repo
 const ASK_BOT = '@openai'

src/octokit.ts

@@ -1,7 +1,5 @@
 import * as core from '@actions/core'
 import * as github from '@actions/github'
-import {Octokit} from '@octokit/action'
-import {retry} from '@octokit/plugin-retry'
 import pLimit from 'p-limit'
 import {Bot} from './bot.js'
 import {
@@ -10,22 +8,10 @@ import {
   EXTRA_CONTENT_TAG,
   SUMMARIZE_TAG
 } from './commenter.js'
+import {octokit} from './octokit.js'
 import {Inputs, Options, Prompts} from './options.js'
 import * as tokenizer from './tokenizer.js'
 
-const token = core.getInput('token')
-  ? core.getInput('token')
-  : process.env.GITHUB_TOKEN
-
-const RetryOctokit = Octokit.plugin(retry)
-const octokit = new RetryOctokit({
-  auth: `token ${token}`,
-  request: {
-    retries: 10,
-    retryAfter: 30
-  }
-})
-
 const context = github.context
 const repo = context.repo