feat: add request throttling to octokit

ts-backend/package.json

@@ -52,6 +52,7 @@
     "@octokit/graphql-schema": "^14.50.0",
     "@octokit/plugin-paginate-graphql": "^4.0.0",
     "@octokit/plugin-retry": "^6.0.1",
+    "@octokit/plugin-throttling": "^8.1.3",
     "@octokit/rest": "^20.0.2",
     "dotenv": "^16.4.1",
     "fs-extra": "^11.2.0",

ts-backend/src/lib/octokit.ts

@@ -1,5 +1,6 @@
 import { paginateGraphql } from "@octokit/plugin-paginate-graphql";
 import { retry } from "@octokit/plugin-retry";
+import { throttling } from "@octokit/plugin-throttling";
 import { Octokit } from "@octokit/rest";
 
 /**
@@ -9,9 +10,28 @@ import { Octokit } from "@octokit/rest";
  */
 export const personalOctokit = (token: string) => {
   // Not sure if plugin order matters
-  const ModifiedOctokit = Octokit.plugin(paginateGraphql, retry);
+  const ModifiedOctokit = Octokit.plugin(paginateGraphql, retry, throttling);
   return new ModifiedOctokit({
     auth: token,
+    throttle: {
+      onRateLimit: (retryAfter, options, octokit, retryCount) => {
+        octokit.log.warn(
+          `Request quota exhausted for request ${options.method} ${options.url} - retrying in ${retryAfter} seconds`
+        );
+
+        if (retryCount < 1) {
+          // only retries once
+          octokit.log.info(`Retry attempt ${retryCount + 1}, retrying...`);
+          return true;
+        }
+      },
+      onSecondaryRateLimit: (retryAfter, options, octokit) => {
+        // does not retry, only logs a warning
+        octokit.log.warn(
+          `SecondaryRateLimit detected for request ${options.method} ${options.url}`
+        );
+      },
+    },
   });
 };