feat: support GH_TOKEN auth; support rate limit retries

Author: dominykas

README.md

@@ -2,6 +2,10 @@
 
 List the Node.js versions supported by the package/repository
 
+## Setup
+
+No setup is required, however if you do not have a `GH_TOKEN` environment limit, you will likely hit a request rate limit on Github API, which may result in very long wait times for retries.
+
 ## Usage (command line)
 
 ```

lib/loader/octokit-wrapper.js

@@ -1,17 +1,35 @@
 'use strict';
 
 const { Octokit } = require('@octokit/rest');
+const { throttling } = require('@octokit/plugin-throttling');
 
 const Constants = require('../constants');
+const Logger = require('../logger');
+
+
+const internals = {
+    Octokit: Octokit.plugin(throttling)
+};
+
 
 exports.create = () => {
 
-    const octokit = new Octokit({
-        userAgent: Constants.userAgent
-    });
+    const octokit = new internals.Octokit({
+        auth: process.env.GH_TOKEN,
+        userAgent: Constants.userAgent,
+        throttle: {
+            onRateLimit: (retryAfter, options) => {
+
+                Logger.warn(['loader'], 'Request quota exceeded for request %s %s. Will retry in %d seconds. Have you set a GH_TOKEN in env?', options.method, options.url, retryAfter);
 
-    // @todo: onRateLimit
-    // @todo: auth
+                return true;
+            },
+            onAbuseLimit: (retryAfter, options) => {
+
+                return false;
+            }
+        }
+    });
 
     return octokit;
 };

package.json

@@ -36,6 +36,7 @@
   },
   "dependencies": {
     "@npmcli/arborist": "0.0.0-pre.21",
+    "@octokit/plugin-throttling": "^3.2.2",
     "@octokit/rest": "^18.0.0",
     "@pkgjs/nv": "0.0.3",
     "debug": "^4.1.1",

test/index.js

@@ -533,10 +533,9 @@ describe('detect-node-support', () => {
                         content: Fs.readFileSync(Path.join(__dirname, '..', 'package.json')).toString('base64')
                     })
                     .get('/repos/pkgjs/detect-node-support/contents/.travis.yml')
-                    .reply(500);
+                    .reply(500, 'Simulated server error');
 
-                const err = await expect(NodeSupport.detect({ repository: 'git+https://github.com/pkgjs/detect-node-support.git' })).to.reject();
-                expect(err.name).to.equal('HttpError');
+                await expect(NodeSupport.detect({ repository: 'git+https://github.com/pkgjs/detect-node-support.git' })).to.reject('Simulated server error');
             });
 
             it('throws when repository does not have a package.json', async () => {
@@ -585,6 +584,62 @@ describe('detect-node-support', () => {
                 await expect(NodeSupport.detect({ repository: 'git+https://github.example.com/pkgjs/detect-node-support.git' }))
                     .to.reject('Only github.com paths supported, feel free to PR at https://github.com/pkgjs/detect-node-support');
             });
+
+            it('retries when rate limited', async () => {
+
+                fixture.stubs.listRemote
+                    .returns('9cef39d21ad229dea4b10295f55b0d9a83800b23\tHEAD\n');
+
+                Nock('https://api.github.com')
+                    .get('/repos/pkgjs/detect-node-support/contents/package.json')
+                    .reply(200, {
+                        content: Fs.readFileSync(Path.join(__dirname, '..', 'package.json')).toString('base64')
+                    })
+                    .get('/repos/pkgjs/detect-node-support/contents/.travis.yml')
+                    .reply(403, null, {
+                        'x-ratelimit-limit': '60',
+                        'x-ratelimit-remaining': '0',
+                        'x-ratelimit-reset': `${Math.round(Date.now() / 1000) + 1}`
+                    })
+                    .get('/repos/pkgjs/detect-node-support/contents/.travis.yml')
+                    .reply(200, {
+                        content: Fs.readFileSync(Path.join(__dirname, '..', '.travis.yml')).toString('base64')
+                    });
+
+                const result = await NodeSupport.detect({ repository: 'git+https://github.com/pkgjs/detect-node-support.git' });
+
+                expect(result).to.equal({
+                    name: 'detect-node-support',
+                    version: '0.0.0-development',
+                    commit: '9cef39d21ad229dea4b10295f55b0d9a83800b23',
+                    timestamp: 1580673602000,
+                    travis: {
+                        raw: ['10', '12', '14'],
+                        resolved: {
+                            '10': '10.20.1',
+                            '12': '12.17.0',
+                            '14': '14.3.0'
+                        }
+                    },
+                    engines: '>=10'
+                });
+            });
+
+            it('aborts on abuse limit', async () => {
+
+                fixture.stubs.listRemote
+                    .returns('9cef39d21ad229dea4b10295f55b0d9a83800b23\tHEAD\n');
+
+                Nock('https://api.github.com')
+                    .get('/repos/pkgjs/detect-node-support/contents/package.json')
+                    .reply(200, {
+                        content: Fs.readFileSync(Path.join(__dirname, '..', 'package.json')).toString('base64')
+                    })
+                    .get('/repos/pkgjs/detect-node-support/contents/.travis.yml')
+                    .reply(403, 'Abuse detected');
+
+                await expect(NodeSupport.detect({ repository: 'git+https://github.com/pkgjs/detect-node-support.git' })).to.reject(/Abuse detected/);
+            });
         });
 
         describe('packageName', () => {