feat(#4): match routes with a regex

Author: Simon Grondin

lib/index.js

@@ -2,12 +2,16 @@ module.exports = throttlingPlugin
 
 const Bottleneck = require('bottleneck/light')
 const wrapRequest = require('./wrap-request')
-
 const triggersNotificationPaths = require('./triggers-notification-paths')
+const routeMatcher = require('./route-matcher')(triggersNotificationPaths)
+
+// Workaround to allow tests to directly access the triggersNotification function.
+const triggersNotification = throttlingPlugin.triggersNotification =
+  routeMatcher.test.bind(routeMatcher)
 
 function throttlingPlugin (octokit, octokitOptions = {}) {
   const state = Object.assign({
-    triggersNotification: triggersNotificationPaths,
+    triggersNotification,
     minimumAbuseRetryAfter: 5,
     retryAfterBaseValue: 1000,
     globalLimiter: new Bottleneck({

lib/route-matcher.js

@@ -0,0 +1,31 @@
+module.exports = routeMatcher
+
+function routeMatcher (paths) {
+  // EXAMPLE. For the following paths:
+  /* [
+      "/orgs/:org/invitations",
+      "/repos/:owner/:repo/collaborators/:username"
+  ] */
+
+  const regexes = paths.map(p =>
+    p.split('/')
+      .map(c => c.startsWith(':') ? '(?:.+?)' : c)
+      .join('/')
+  )
+  // 'regexes' would contain:
+  /* [
+      '/orgs/(?:.+?)/invitations',
+      '/repos/(?:.+?)/(?:.+?)/collaborators/(?:.+?)'
+  ] */
+
+  const regex = `^(?:${regexes.map(r => `(?:${r})`).join('|')})[^/]*$`
+  // 'regex' would contain:
+  /*
+    ^(?:(?:\/orgs\/(?:.+?)\/invitations)|(?:\/repos\/(?:.+?)\/(?:.+?)\/collaborators\/(?:.+?)))[^\/]*$
+
+    It may look scary, but paste it into https://www.debuggex.com/
+    and it will make a lot more sense!
+  */
+
+  return new RegExp(regex, 'i')
+}

lib/wrap-request.js

@@ -17,7 +17,7 @@ async function doRequest (state, request, options) {
   }
 
   // Guarantee at least 3000ms between requests that trigger notifications
-  if (isWrite && state.triggersNotification.includes(options.url)) {
+  if (isWrite && state.triggersNotification(options.url)) {
     await state.triggersNotificationLimiter.schedule(jobOptions, noop)
   }
 

test/index.js

@@ -121,6 +121,23 @@ describe('Github API best practices', function () {
     expect(octokit.__requestTimings[5] - octokit.__requestTimings[0]).to.be.closeTo(100, 20)
   })
 
+  it('Should match custom routes when checking notification triggers', function () {
+    const plugin = require('../lib')
+
+    expect(plugin.triggersNotification('/abc/def')).to.equal(false)
+    expect(plugin.triggersNotification('/orgs/abc/invitation')).to.equal(false)
+    expect(plugin.triggersNotification('/repos/abc/releases')).to.equal(false)
+    expect(plugin.triggersNotification('/repos/abc/def/pulls/5')).to.equal(false)
+
+    expect(plugin.triggersNotification('/repos/abc/def/pulls')).to.equal(true)
+    expect(plugin.triggersNotification('/repos/abc/def/pulls/5/comments')).to.equal(true)
+    expect(plugin.triggersNotification('/repos/foo/bar/issues')).to.equal(true)
+
+    expect(plugin.triggersNotification('/repos/:owner/:repo/pulls')).to.equal(true)
+    expect(plugin.triggersNotification('/repos/:owner/:repo/pulls/5/comments')).to.equal(true)
+    expect(plugin.triggersNotification('/repos/:foo/:bar/issues')).to.equal(true)
+  })
+
   it('Should optimize throughput rather than maintain ordering', async function () {
     const octokit = new Octokit({
       throttle: {
@@ -131,7 +148,7 @@ describe('Github API best practices', function () {
       }
     })
 
-    const req1 = octokit.request('POST /orgs/:org/invitations', {
+    const req1 = octokit.request('POST /orgs/abc/invitations', {
       request: {
         responses: [{ status: 200, headers: {}, data: {} }]
       }
@@ -151,12 +168,12 @@ describe('Github API best practices', function () {
         responses: [{ status: 200, headers: {}, data: {} }]
       }
     })
-    const req5 = octokit.request('POST /repos/:owner/:repo/commits/:sha/comments', {
+    const req5 = octokit.request('POST /repos/abc/def/commits/12345/comments', {
       request: {
         responses: [{ status: 200, headers: {}, data: {} }]
       }
     })
-    const req6 = octokit.request('PATCH /orgs/:org/invitations', {
+    const req6 = octokit.request('PATCH /orgs/abc/invitations', {
       request: {
         responses: [{ status: 200, headers: {}, data: {} }]
       }
@@ -173,14 +190,14 @@ describe('Github API best practices', function () {
       'END GET /route2',
       'START GET /route4',
       'END GET /route4',
-      'START POST /orgs/:org/invitations',
-      'END POST /orgs/:org/invitations',
+      'START POST /orgs/abc/invitations',
+      'END POST /orgs/abc/invitations',
       'START POST /route3',
       'END POST /route3',
-      'START POST /repos/:owner/:repo/commits/:sha/comments',
-      'END POST /repos/:owner/:repo/commits/:sha/comments',
-      'START PATCH /orgs/:org/invitations',
-      'END PATCH /orgs/:org/invitations',
+      'START POST /repos/abc/def/commits/12345/comments',
+      'END POST /repos/abc/def/commits/12345/comments',
+      'START PATCH /orgs/abc/invitations',
+      'END PATCH /orgs/abc/invitations',
       'START GET /route6',
       'END GET /route6'
     ])