fix: Use '@octokit/plugin-throttling' to avoid rate limits

Author: smockle

.github/actions/file/package-lock.json

@@ -14,10 +14,11 @@
   "type": "module",
   "dependencies": {
     "@actions/core": "^1.11.1",
-    "@octokit/core": "^7.0.3"
+    "@octokit/core": "^7.0.3",
+    "@octokit/plugin-throttling": "^11.0.1"
   },
   "devDependencies": {
     "@types/node": "^24.3.0",
     "typescript": "^5.8.3"
   }
-}
+}

.github/actions/file/package.json

@@ -1,10 +1,12 @@
 import type { Finding } from "./types.d.js";
 import process from "node:process";
 import core from "@actions/core";
-import { Octokit } from '@octokit/core';
+import { Octokit } from "@octokit/core";
+import { throttling } from "@octokit/plugin-throttling";
 import { toFindingsMap } from "./toFindingsMap.js"
 import { closeIssueForFinding } from "./closeIssueForFinding.js";
 import { openIssueForFinding } from "./openIssueForFinding.js";
+const OctokitWithThrottling = Octokit.plugin(throttling);
 
 export default async function () {
   core.info("Started 'file' action");
@@ -19,7 +21,25 @@ export default async function () {
   const findingsMap = toFindingsMap(findings);
   const cachedFindingsMap = toFindingsMap(cachedFindings);
 
-  const octokit = new Octokit({ auth: token });
+  const octokit = new OctokitWithThrottling({
+    auth: token,
+    throttle: {
+      onRateLimit: (retryAfter, options, octokit, retryCount) => {
+        octokit.log.warn(`Request quota exhausted for request ${options.method} ${options.url}`);
+        if (retryCount < 3) {
+          octokit.log.info(`Retrying after ${retryAfter} seconds!`);
+          return true;
+        }
+      },
+      onSecondaryRateLimit: (retryAfter, options, octokit, retryCount) => {
+        octokit.log.warn(`Secondary rate limit hit for request ${options.method} ${options.url}`);
+        if (retryCount < 3) {
+          octokit.log.info(`Retrying after ${retryAfter} seconds!`);
+          return true;
+        }
+      },
+    }
+  });
   const closedIssueUrls = [];
   const openedIssueUrls = [];
   const repeatIssueUrls = [];

.github/actions/file/src/index.ts

@@ -14,10 +14,11 @@
   "type": "module",
   "dependencies": {
     "@actions/core": "^1.11.1",
-    "@octokit/core": "^7.0.3"
+    "@octokit/core": "^7.0.3",
+    "@octokit/plugin-throttling": "^11.0.1"
   },
   "devDependencies": {
     "@types/node": "^24.3.0",
     "typescript": "^5.8.3"
   }
-}
+}

.github/actions/fix/package-lock.json

@@ -1,7 +1,9 @@
 import process from "node:process";
 import core from "@actions/core";
-import { Octokit } from '@octokit/core';
+import { Octokit } from "@octokit/core";
+import { throttling } from "@octokit/plugin-throttling";
 import { fixIssue } from "./fixIssue.js";
+const OctokitWithThrottling = Octokit.plugin(throttling);
 
 export default async function () {
   core.info("Started 'fix' action");
@@ -11,7 +13,25 @@ export default async function () {
   core.debug(`Input: 'issue_urls: ${JSON.stringify(issueUrls)}'`);
   core.debug(`Input: 'repository: ${repoWithOwner}'`);
 
-  const octokit = new Octokit({ auth: token });
+  const octokit = new OctokitWithThrottling({
+    auth: token,
+    throttle: {
+      onRateLimit: (retryAfter, options, octokit, retryCount) => {
+        octokit.log.warn(`Request quota exhausted for request ${options.method} ${options.url}`);
+        if (retryCount < 3) {
+          octokit.log.info(`Retrying after ${retryAfter} seconds!`);
+          return true;
+        }
+      },
+      onSecondaryRateLimit: (retryAfter, options, octokit, retryCount) => {
+        octokit.log.warn(`Secondary rate limit hit for request ${options.method} ${options.url}`);
+        if (retryCount < 3) {
+          octokit.log.info(`Retrying after ${retryAfter} seconds!`);
+          return true;
+        }
+      },
+    }
+  });
   for (const issueUrl of issueUrls) {
     try {
       await fixIssue(octokit, repoWithOwner, issueUrl);

.github/actions/fix/package.json

@@ -18,8 +18,9 @@
   "devDependencies": {
     "@actions/core": "^1.11.1",
     "@octokit/core": "^7.0.3",
+    "@octokit/plugin-throttling": "^11.0.1",
     "@octokit/types": "^14.1.0",
     "@types/node": "^24.3.0",
     "vitest": "^3.2.4"
   }
-}
+}

.github/actions/fix/src/index.ts

@@ -3,6 +3,8 @@ import type { Finding } from "./types.d.js";
 import fs from "node:fs";
 import { describe, it, expect, beforeAll } from "vitest";
 import { Octokit } from "@octokit/core";
+import { throttling } from "@octokit/plugin-throttling";
+const OctokitWithThrottling = Octokit.plugin(throttling);
 
 describe("site-with-errors", () => {
   let findings: Finding[];
@@ -99,7 +101,25 @@ describe("site-with-errors", () => {
     let pullRequests: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}"]["response"]["data"][];
 
     beforeAll(async () => {
-      octokit = new Octokit({ auth: process.env.GITHUB_TOKEN });
+      octokit = new OctokitWithThrottling({
+        auth: process.env.GITHUB_TOKEN,
+        throttle: {
+          onRateLimit: (retryAfter, options, octokit, retryCount) => {
+            octokit.log.warn(`Request quota exhausted for request ${options.method} ${options.url}`);
+            if (retryCount < 3) {
+              octokit.log.info(`Retrying after ${retryAfter} seconds!`);
+              return true;
+            }
+          },
+          onSecondaryRateLimit: (retryAfter, options, octokit, retryCount) => {
+            octokit.log.warn(`Secondary rate limit hit for request ${options.method} ${options.url}`);
+            if (retryCount < 3) {
+              octokit.log.info(`Retrying after ${retryAfter} seconds!`);
+              return true;
+            }
+          },
+        }
+      });
       // Fetch issues referenced in the findings file
       issues = await Promise.all(findings.map(async ({ issueUrl }) => {
         expect(issueUrl).toBeDefined();