fix(throttling): use Octokit's plugin-throttling instead of a custom throttling implementation

Author: oscard0m

lib/definitions/rate-limit.js

@@ -1,35 +1,14 @@
-const {memoize, get} = require('lodash');
 const {Octokit} = require('@octokit/rest');
 const pRetry = require('p-retry');
-const Bottleneck = require('bottleneck');
 const urljoin = require('url-join');
 const HttpProxyAgent = require('http-proxy-agent');
 const HttpsProxyAgent = require('https-proxy-agent');
-
-const {RETRY_CONF, RATE_LIMITS, GLOBAL_RATE_LIMIT} = require('./definitions/rate-limit');
-
-/**
- * Http error status for which to not retry.
- */
-const SKIP_RETRY_CODES = new Set([400, 401, 403]);
-
-/**
- * Create or retrieve the throttler function for a given rate limit group.
- *
- * @param {Array} rate The rate limit group.
- * @param {String} limit The rate limits per API endpoints.
- * @param {Bottleneck} globalThrottler The global throttler.
- *
- * @return {Bottleneck} The throller function for the given rate limit group.
- */
-const getThrottler = memoize((rate, globalThrottler) =>
-  new Bottleneck({minTime: get(RATE_LIMITS, rate)}).chain(globalThrottler)
-);
+const { throttling } = require("@octokit/plugin-throttling");
 
 module.exports = ({githubToken, githubUrl, githubApiPathPrefix, proxy}) => {
   const baseUrl = githubUrl && urljoin(githubUrl, githubApiPathPrefix);
-  const globalThrottler = new Bottleneck({minTime: GLOBAL_RATE_LIMIT});
-  const github = new Octokit({
+  const OctokitWithThrottling = Octokit.plugin(throttling);
+  const github = new OctokitWithThrottling({
     auth: `token ${githubToken}`,
     baseUrl,
     request: {
@@ -39,24 +18,14 @@ module.exports = ({githubToken, githubUrl, githubApiPathPrefix, proxy}) => {
           : new HttpsProxyAgent(proxy)
         : undefined,
     },
-  });
-
-  github.hook.wrap('request', (request, options) => {
-    const access = options.method === 'GET' ? 'read' : 'write';
-    const rateCategory = options.url.startsWith('/search') ? 'search' : 'core';
-    const limitKey = [rateCategory, RATE_LIMITS[rateCategory][access] && access].filter(Boolean).join('.');
-
-    return pRetry(async () => {
-      try {
-        return await getThrottler(limitKey, globalThrottler).wrap(request)(options);
-      } catch (error) {
-        if (SKIP_RETRY_CODES.has(error.status)) {
-          throw new pRetry.AbortError(error);
-        }
-
-        throw error;
-      }
-    }, RETRY_CONF);
+    throttle: {
+      onSecondaryRateLimit: (retryAfter, options, octokit) => {
+        octokit.log.error("onSecondaryLimit", retryAfter, options);
+      },
+      onRateLimit: (retryAfter, options, octokit) => {
+        octokit.log.error("onRateLimit", retryAfter, options);
+      },
+    },
   });
 
   return github;

lib/get-client.js

@@ -16,6 +16,7 @@
     "Gregor Martynus (https://twitter.com/gr2m)"
   ],
   "dependencies": {
+    "@octokit/plugin-throttling": "^3.6.2",
     "@octokit/rest": "^19.0.0",
     "@semantic-release/error": "^3.0.0",
     "aggregate-error": "^3.0.0",