fix: require latest Bottleneck to avoid memory leak when creating many instances

Author: gr2m

.travis.yml

@@ -13,9 +13,12 @@ jobs:
     - stage: test
       node_js: 8
     - node_js: 10
-    - node_js: lts/*
+      env: Node 10 & coverage upload
       after_script:
         - npm run coverage:upload
+    - node_js: lts/*
+      env: memory-test
+      script: npm run test:memory
     - stage: release
       env: semantic-release
       node_js: lts/*
@@ -30,8 +33,6 @@ jobs:
         - node scripts/generate-routes
         # commit changes and push back to branch on GitHub. If there are no changes then exit without error
         - 'git commit -a -m "build: routes" --author="Octokit Bot <[email protected]>" && git push "https://${GH_TOKEN}@github.com/$TRAVIS_REPO_SLUG" ${TRAVIS_BRANCH} || true'
-  allow_failures:
-
 
 stages:
   - test

package-lock.json

@@ -11,7 +11,8 @@
     "coverage": "nyc report --reporter=html && open coverage/index.html",
     "coverage:upload": "nyc report --reporter=text-lcov | coveralls",
     "pretest": "standard",
-    "test": "nyc mocha test/"
+    "test": "nyc mocha test/integration/",
+    "test:memory": "node test/memory-leakage-test"
   },
   "repository": {
     "type": "git",
@@ -35,14 +36,15 @@
     ]
   },
   "dependencies": {
-    "bottleneck": "^2.15.0"
+    "bottleneck": "^2.15.3"
   },
   "devDependencies": {
     "@octokit/request": "2.2.1",
     "@octokit/rest": "^16.3.0",
     "@octokit/routes": "18.1.2",
     "chai": "^4.2.0",
     "coveralls": "^3.0.2",
+    "leakage": "^0.4.0",
     "mocha": "^5.2.0",
     "nyc": "^13.1.0",
     "semantic-release": "^15.13.1",

package.json

@@ -156,7 +156,7 @@ describe('Github API best practices', function () {
   })
 
   it('Should match custom routes when checking notification triggers', function () {
-    const plugin = require('../lib')
+    const plugin = require('../../lib')
 
     expect(plugin.triggersNotification('/abc/def')).to.equal(false)
     expect(plugin.triggersNotification('/orgs/abc/invitation')).to.equal(false)

test/events.js renamed to test/integration/events.js

@@ -1,6 +1,6 @@
 const Octokit = require('@octokit/rest')
 const HttpError = require('@octokit/request/lib/http-error')
-const throttlingPlugin = require('..')
+const throttlingPlugin = require('../..')
 
 module.exports = Octokit
   .plugin((octokit) => {

test/index.js renamed to test/integration/index.js

@@ -0,0 +1,14 @@
+const { iterate } = require('leakage')
+const Octokit = require('@octokit/rest')
+  .plugin(require('..'))
+
+const result = iterate(() => {
+  Octokit({
+    throttle: {
+      onAbuseLimit: () => {},
+      onRateLimit: () => {}
+    }
+  })
+})
+
+result.printSummary()