feat: Use the retry plugin for octokit (#492)

Co-authored-by: Aori Nevo <aorin@amazon.com>
NerdWalletOSS · Sep 9, 2021 · 278709d · 278709d
1 parent 05809b2
commit 278709d
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 3 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -46,6 +46,7 @@
     "lib"
   ],
   "dependencies": {
+    "@octokit/plugin-retry": "^3.0.9",
     "@octokit/rest": "^18.1.0",
     "@types/js-yaml": "^3.12.6",
     "chalk": "^4.1.0",

diff --git a/src/services/github.ts b/src/services/github.ts
@@ -1,12 +1,15 @@
 /* eslint-disable class-methods-use-this */
 import { Octokit } from '@octokit/rest';
+import { retry } from '@octokit/plugin-retry';
 import { RestEndpointMethodTypes } from '@octokit/plugin-rest-endpoint-methods'
 import _ from 'lodash';
 import netrc from 'netrc';
 
 const VALID_SEARCH_TYPES: ReadonlyArray<string> = ['code', 'repositories'] as const;
 
-interface SearchTypeAndQueryParams { 
+const RetryableOctokit = Octokit.plugin(retry);
+
+interface SearchTypeAndQueryParams {
   search_type?: string
   search_query: string
 }
@@ -26,8 +29,12 @@ export default class GithubService {
         set a token on the 'password' field in ~/.netrc for api.github.com`);
       }
 
-      this.octokit = new Octokit({
-        auth: token
+      this.octokit = new RetryableOctokit({
+        auth: token,
+        retry: {
+          // By default the doNotRetry setting includes 403, which means we face secondary rate limits
+          doNotRetry: [400, 401, 404, 422],
+        }
       });
     }
   }