feat: support multi match rules by passing options in Array type

Author: 刘放

.gitignore

@@ -1 +1,3 @@
 node_modules
+.history
+.vscode

github-webhook-handler.d.ts

@@ -13,6 +13,6 @@ interface handler extends EventEmitter {
     (req: IncomingMessage, res: ServerResponse, callback: (err: Error) => void): void;
 }
 
-declare function createHandler(options: CreateHandlerOptions): handler;
+declare function createHandler(options: CreateHandlerOptions|CreateHandlerOptions[]): handler;
 
 export = createHandler;

github-webhook-handler.js

@@ -3,7 +3,18 @@ const EventEmitter = require('events').EventEmitter
     , crypto       = require('crypto')
     , bl           = require('bl')
 
-function create (options) {
+function findHandler (url, arr) {
+  if (!Array.isArray(arr)) 
+    return arr
+  var ret = arr[0]
+  for (var i = 0; i < arr.length; i++) {
+    if (url.split('?')[0] === arr[i].path)
+      ret = arr[i]
+  }
+  return ret
+}
+
+function checkType (options) {
   if (typeof options != 'object')
     throw new TypeError('must provide an options object')
 
@@ -12,14 +23,19 @@ function create (options) {
 
   if (typeof options.secret != 'string')
     throw new TypeError('must provide a \'secret\' option')
+}
 
-  var events
-
-  if (typeof options.events == 'string' && options.events != '*')
-    events = [ options.events ]
+function create (initOptions) {
 
-  else if (Array.isArray(options.events) && options.events.indexOf('*') == -1)
-    events = options.events
+  var options
+  //validate type of options
+  if (Array.isArray(initOptions)) {
+    initOptions.forEach(function(item){
+      checkType(item)
+    })
+  } else {
+    checkType(initOptions)
+  }
 
   // make it an EventEmitter, sort of
   handler.__proto__ = EventEmitter.prototype
@@ -40,6 +56,16 @@ function create (options) {
   }
 
   function handler (req, res, callback) {
+    var events
+
+    options = findHandler(req.url, initOptions)
+
+    if (typeof options.events == 'string' && options.events != '*')
+      events = [ options.events ]
+  
+    else if (Array.isArray(options.events) && options.events.indexOf('*') == -1)
+      events = options.events
+      
     if (req.url.split('?').shift() !== options.path || req.method !== 'POST')
       return callback()
 
@@ -95,6 +121,7 @@ function create (options) {
         , protocol: req.protocol
         , host    : req.headers['host']
         , url     : req.url
+        , path    : options.path
       }
 
       handler.emit(event, emitData)

test.js

@@ -52,6 +52,14 @@ test('handler without full options throws', function (t) {
   t.throws(handler.bind(null, { path: '/' }), /must provide a 'secret' option/, 'throws if no secret option')
 })
 
+test('handler without full options throws in array', function (t) {
+  t.plan(2)
+
+  t.throws(handler.bind(null, [{}]), /must provide a 'path' option/, 'throws if no path option')
+
+  t.throws(handler.bind(null, [{ path: '/' }]), /must provide a 'secret' option/, 'throws if no secret option')
+})
+
 
 test('handler ignores invalid urls', function (t) {
   var options = { path: '/some/url', secret: 'bogus' }
@@ -113,6 +121,30 @@ test('handler accepts valid urls', function (t) {
   setTimeout(t.ok.bind(t, true, 'done'))
 })
 
+test('handler accepts valid urls in Array', function (t) {
+  var options = [{ path: '/some/url', secret: 'bogus' },{ path: '/someOther/url', secret: 'bogus' }]
+    , h       = handler(options)
+
+  t.plan(1)
+
+  h(mkReq('/some/url'), mkRes(), function (err) {
+    t.error(err)
+    t.fail(false, 'should not call')
+  })
+
+  h(mkReq('/someOther/url'), mkRes(), function (err) {
+    t.error(err)
+    t.fail(false, 'should not call')
+  })
+
+  h(mkReq('/some/url?test=param'), mkRes(), function (err) {
+    t.error(err)
+    t.fail(false, 'should not call')
+  })
+
+  setTimeout(t.ok.bind(t, true, 'done'))
+})
+
 
 test('handler can reject events', function (t) {
   var acceptableEvents   = {
@@ -206,7 +238,35 @@ test('handler accepts a signed blob', function (t) {
   req.headers['x-github-event']  = 'push'
 
   h.on('push', function (event) {
-    t.deepEqual(event, { event: 'push', id: 'bogus', payload: obj, url: '/', host: undefined, protocol: undefined })
+    t.deepEqual(event, { event: 'push', id: 'bogus', payload: obj, url: '/', host: undefined, protocol: undefined, path: '/' })
+    t.equal(res.$statusCode, 200, 'correct status code')
+    t.deepEqual(res.$headers, { 'content-type': 'application/json' })
+    t.equal(res.$end, '{"ok":true}', 'got correct content')
+  })
+
+  h(req, res, function (err) {
+    t.error(err)
+    t.fail(true, 'should not get here!')
+  })
+
+  process.nextTick(function () {
+    req.end(json)
+  })
+})
+
+test('handler accepts multi blob in Array', function (t) {
+  t.plan(4)
+
+  var obj  = { some: 'github', object: 'with', properties: true }
+    , json = JSON.stringify(obj)
+    , h    = handler([{ path: '/', secret: 'bogus' },{ path: '/some/url', secret: 'bogus'}])
+    , req  = mkReq('/some/url')
+    , res  = mkRes()
+  req.headers['x-hub-signature'] = signBlob('bogus', json)
+  req.headers['x-github-event']  = 'push'
+
+  h.on('push', function (event) {
+    t.deepEqual(event, { event: 'push', id: 'bogus', payload: obj, url: '/some/url', host: undefined, protocol: undefined, path: '/some/url' })
     t.equal(res.$statusCode, 200, 'correct status code')
     t.deepEqual(res.$headers, { 'content-type': 'application/json' })
     t.equal(res.$end, '{"ok":true}', 'got correct content')
@@ -240,7 +300,7 @@ test('handler accepts a signed blob with alt event', function (t) {
   })
 
   h.on('issue', function (event) {
-    t.deepEqual(event, { event: 'issue', id: 'bogus', payload: obj, url: '/', host: undefined, protocol: undefined })
+    t.deepEqual(event, { event: 'issue', id: 'bogus', payload: obj, url: '/', host: undefined, protocol: undefined, path: '/' })
     t.equal(res.$statusCode, 200, 'correct status code')
     t.deepEqual(res.$headers, { 'content-type': 'application/json' })
     t.equal(res.$end, '{"ok":true}', 'got correct content')