Adds tests around the SlackApp class

.gitignore

@@ -35,3 +35,5 @@ jspm_packages
 
 # Optional REPL history
 .node_repl_history
+/coverage
+/.nyc_output

package.json

@@ -4,7 +4,10 @@
   "description": "A module for Slack App integrations",
   "main": "src/index.js",
   "scripts": {
-    "test": "standard"
+    "test": "npm run lint && npm run coverage",
+    "lint": "standard",
+    "unit": "ava",
+    "coverage": "nyc ava"
   },
   "repository": {
     "type": "git",
@@ -30,6 +33,9 @@
     "slack": "^7.5.7"
   },
   "devDependencies": {
+    "ava": "^0.15.2",
+    "nyc": "^7.0.0",
+    "sinon": "^1.17.4",
     "standard": "^7.1.2"
   }
 }

src/conversation_store/index.js

@@ -1,3 +1,5 @@
+'use strict'
+
 const MemoryStore = require('./memory')
 
 module.exports = (opts) => {

src/conversation_store/memory.js

@@ -1,3 +1,5 @@
+'use strict'
+
 /**
  * In memory implementation of a ConversationStore, primarily for testing
  */

src/message.js

@@ -1,3 +1,5 @@
+'use strict'
+
 const request = require('request')
 const slack = require('slack')
 

src/receiver.js

@@ -1,3 +1,5 @@
+'use strict'
+
 const EventEmitter = require('events')
 const bodyParser = require('body-parser')
 const fs = require('fs')

src/slackapp.js

@@ -1,3 +1,5 @@
+'use strict'
+
 const slack = require('slack')
 const conversationStore = require('./conversation_store')
 const Receiver = require('./receiver')
@@ -109,15 +111,21 @@ module.exports = class SlackApp {
 
   use (fn) {
     this._middleware.push(fn)
+
+    return this
   }
 
   /**
    * Handle new events (slack events, commands, actions, webhooks, etc.)
+   * Parameters
+   * - `msg` `Message`
+   * - `done` `function(err, bool)` Callback called once complete, called with error and boolean indicating message was handled [optional]
    *
    * @api private
    */
 
-  _handle (msg) {
+  _handle (msg, done) {
+    done = done || (() => {})
     let self = this
     msg.attachSlackApp(self)
     let idx = 0
@@ -135,7 +143,11 @@ module.exports = class SlackApp {
           if (err) {
             this.onError(err)
           }
-          msg.override(msg)
+          // invoking override w/o context explicitly
+          // don't want to confuse consumers w/ a msg as `this` scope
+          msg.override.call(null, msg)
+
+          done(err || null, true)
         })
         return
       }
@@ -145,12 +157,16 @@ module.exports = class SlackApp {
         // if match is a regex, text the regex against the text of a message (if it is a message)
         let matcher = self._matchers[i]
         if (matcher(msg)) {
-          return
+          return done(null, true)
         }
       }
+
+      done(null, false)
     }
 
     next()
+
+    return this
   }
 
   /**
@@ -176,6 +192,8 @@ module.exports = class SlackApp {
 
   route (fnKey, fn) {
     this._registry[fnKey] = fn
+
+    return this
   }
 
   /**
@@ -209,6 +227,8 @@ module.exports = class SlackApp {
 
   match (fn) {
     this._matchers.push(fn)
+
+    return this
   }
 
   /**
@@ -266,7 +286,7 @@ module.exports = class SlackApp {
         }
       }
     }
-    this.match(fn)
+    return this.match(fn)
   }
 
   /**
@@ -311,7 +331,7 @@ module.exports = class SlackApp {
       }
     }
 
-    this.match(fn)
+    return this.match(fn)
   }
 
   /**
@@ -412,7 +432,7 @@ module.exports = class SlackApp {
       }
     }
 
-    this.match(fn)
+    return this.match(fn)
   }
 
   /**
@@ -469,6 +489,6 @@ module.exports = class SlackApp {
       }
     }
 
-    this.match(fn)
+    return this.match(fn)
   }
 }

test/slackapp.js

@@ -0,0 +1,202 @@
+'use strict'
+
+const test = require('ava').test
+const sinon = require('sinon')
+const SlackApp = require('../src/slackapp')
+
+test('SlackApp()', t => {
+  let options = {
+    app_token: 'token',
+    app_user_id: 'app_user_id',
+    bot_token: 'bot_token',
+    bot_user_id: 'bot_user_id',
+    debug: true,
+    convo_store: () => {},
+    error: () => {}
+  }
+
+  let app = new SlackApp(options)
+
+  t.is(app.app_token, options.app_token)
+  t.is(app.app_user_id, options.app_user_id)
+  t.is(app.bot_token, options.bot_token)
+  t.is(app.bot_user_id, options.bot_user_id)
+  t.is(app.debug, options.debug)
+  t.is(app.convoStore, options.convo_store)
+  t.is(app.onError, options.error)
+  t.is(typeof app.client, 'object')
+  t.is(typeof app.receiver, 'object')
+  t.true(Array.isArray(app._middleware))
+  t.is(app._middleware.length, 0)
+})
+
+test('Slackapp.use()', t => {
+  let mw = () => {}
+  let app = new SlackApp()
+
+  t.is(app._middleware.length, 0)
+
+  app.use(mw)
+
+  t.is(app._middleware.length, 1)
+  t.deepEqual(app._middleware, [mw])
+})
+
+test('Slackapp.attachToExpress()', t => {
+  let app = new SlackApp()
+  let stub = sinon.stub(app.receiver, 'attachToExpress')
+
+  app.attachToExpress({})
+
+  t.true(stub.calledOnce)
+})
+
+test('SlackApp.route()', t => {
+  let app = new SlackApp()
+  let key = 'routeKey'
+  let fn = () => {}
+
+  app.route(key, fn)
+
+  t.deepEqual(app._registry[key], fn)
+})
+
+test('SlackApp.getRoute()', t => {
+  let app = new SlackApp()
+  let key = 'routeKey'
+  let fn = () => {}
+
+  app.route(key, fn)
+
+  t.deepEqual(app.getRoute(key), fn)
+})
+
+test('SlackApp.match()', t => {
+  let app = new SlackApp()
+  let fn = () => {}
+
+  t.is(app._matchers.length, 0)
+
+  app.match(fn)
+
+  t.is(app._matchers.length, 1)
+  t.deepEqual(app._matchers, [fn])
+})
+
+test.cb('SlackApp._handle() 1 mw, no override, no matchers', t => {
+  t.plan(4)
+
+  let app = new SlackApp()
+  let message = {
+    override: false,
+    attachSlackApp: () => {}
+  }
+  let attachSlackAppStub = sinon.stub(message, 'attachSlackApp')
+
+  app.use((msg, next) => {
+    t.deepEqual(msg, message)
+
+    next()
+  })
+
+  app._handle(message, (err, handled) => {
+    t.true(attachSlackAppStub.calledOnce)
+    t.is(err, null)
+    t.false(handled)
+    t.end()
+  })
+})
+
+test('SlackApp._handle() no callback provided', t => {
+  let app = new SlackApp()
+  let message = {
+    override: false,
+    attachSlackApp: () => {}
+  }
+  let attachSlackAppStub = sinon.stub(message, 'attachSlackApp')
+
+  app._handle(message)
+
+  t.true(attachSlackAppStub.calledOnce)
+})
+
+test.cb('SlackApp._handle() 1 mw, no override, 1 matchers', t => {
+  t.plan(4)
+
+  let app = new SlackApp()
+  let message = {
+    override: false,
+    attachSlackApp: () => {}
+  }
+  let attachSlackAppStub = sinon.stub(message, 'attachSlackApp')
+
+  app
+    .use((msg, next) => {
+      t.deepEqual(msg, message)
+
+      next()
+    })
+    .match((msg) => {
+      return true
+    })
+
+  app._handle(message, (err, handled) => {
+    t.true(attachSlackAppStub.calledOnce)
+    t.is(err, null)
+    t.true(handled)
+    t.end()
+  })
+})
+
+test.cb('SlackApp._handle() no mw, with override, no matchers', t => {
+  t.plan(5)
+
+  let app = new SlackApp()
+  let message = {
+    override: (msg) => {
+      t.deepEqual(msg, message)
+    },
+    conversation_id: 'asdf',
+    attachSlackApp: () => {}
+  }
+  let attachSlackAppStub = sinon.stub(message, 'attachSlackApp')
+  let delSpy = sinon.spy(app.convoStore, 'del')
+
+  app._handle(message, (err, handled) => {
+    t.true(attachSlackAppStub.calledOnce)
+    t.is(err, null)
+    t.true(handled)
+    t.true(delSpy.calledWith(message.conversation_id))
+
+    t.end()
+  })
+})
+
+test.cb('SlackApp._handle() with override and del error', t => {
+  t.plan(6)
+
+  let app = new SlackApp()
+  let message = {
+    onError: () => {},
+    override: (msg) => {
+      t.deepEqual(msg, message)
+    },
+    conversation_id: 'asdf',
+    attachSlackApp: () => {}
+  }
+  let attachSlackAppStub = sinon.stub(message, 'attachSlackApp')
+  let onErrorSpy = sinon.stub(app, 'onError')
+  let delStub = sinon.stub(app.convoStore, 'del', (id, cb) => {
+    cb(new Error('kaboom'))
+  })
+
+  app._handle(message, (err, handled) => {
+    t.true(attachSlackAppStub.calledOnce)
+    t.is(err.message, 'kaboom')
+    t.true(handled)
+    t.true(delStub.calledWith(message.conversation_id))
+    t.true(onErrorSpy.calledOnce)
+
+    t.end()
+  })
+})