hubot 3.3.2 → 3.5.0

package/src/robot.js

@@ -6,7 +6,7 @@ const path = require('path')
 
 const async = require('async')
 const Log = require('log')
-const HttpClient = require('scoped-http-client')
+const HttpClient = require('./httpclient')
 
 const Brain = require('./brain')
 const Response = require('./response')
@@ -132,7 +132,7 @@ class Robot {
     const name = this.name.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, '\\$&')
 
     if (regexStartsWithAnchor) {
-      this.logger.warning(`Anchors don’t work well with respond, perhaps you want to use 'hear'`)
+      this.logger.warning('Anchors don’t work well with respond, perhaps you want to use \'hear\'')
       this.logger.warning(`The regex in question was ${regex.toString()}`)
     }
 
@@ -204,7 +204,7 @@ class Robot {
   invokeErrorHandlers (error, res) {
     this.logger.error(error.stack)
 
-    this.errorHandlers.map((errorHandler) => {
+    this.errorHandlers.forEach((errorHandler) => {
       try {
         errorHandler(error, res)
       } catch (errorHandlerError) {
@@ -317,13 +317,13 @@ class Robot {
           // stack doesn't get too big
           process.nextTick(() =>
             // Stop processing when message.done == true
-            done(context.response.message.done)
+            done(null, context.response.message.done)
           )
         })
       } catch (err) {
         this.emit('error', err, new this.Response(this, context.response.message, []))
         // Continue to next listener when there is an error
-        done(false)
+        done(null, false)
       }
     },
     // Ignore the result ( == the listener that set message.done = true)
@@ -352,7 +352,7 @@ class Robot {
     const full = path.join(filepath, path.basename(filename, ext))
 
     // see https://github.com/hubotio/hubot/issues/1355
-    if (!require.extensions[ext]) { // eslint-disable-line
+    if (['.js', '.mjs', '.coffee'].indexOf(ext) == -1) { // eslint-disable-line
       return
     }
 
@@ -429,21 +429,24 @@ class Robot {
     const paramLimit = parseInt(process.env.EXPRESS_PARAMETER_LIMIT) || 1000
 
     const express = require('express')
+    const basicAuth = require('express-basic-auth')
     const multipart = require('connect-multiparty')
 
     const app = express()
 
     app.use((req, res, next) => {
-      res.setHeader('X-Powered-By', `hubot/${this.name}`)
+      res.setHeader('X-Powered-By', `hubot/${encodeURI(this.name)}`)
       return next()
     })
 
     if (user && pass) {
-      app.use(express.basicAuth(user, pass))
+      const authUser = {}
+      authUser[user] = pass
+      app.use(basicAuth({ users: authUser }))
     }
     app.use(express.query())
 
-    app.use(express.json())
+    app.use(express.json({ limit }))
     app.use(express.urlencoded({ limit, parameterLimit: paramLimit, extended: true }))
     // replacement for deprecated express.multipart/connect.multipart
     // limit to 100mb, as per the old behavior
@@ -527,7 +530,7 @@ class Robot {
 
     const useStrictHeaderRegex = /^["']use strict['"];?\s+/
     const lines = body.replace(useStrictHeaderRegex, '').split(/(?:\n|\r\n|\r)/)
-      .reduce(toHeaderCommentBlock, {lines: [], isHeader: true}).lines
+      .reduce(toHeaderCommentBlock, { lines: [], isHeader: true }).lines
       .filter(Boolean) // remove empty lines
     let currentSection = null
     let nextSection
@@ -577,11 +580,11 @@ class Robot {
   // envelope - A Object with message, room and user details.
   // strings  - One or more Strings for each message to send.
   //
-  // Returns nothing.
+  // Returns whatever the extending adapter returns.
   send (envelope/* , ...strings */) {
     const strings = [].slice.call(arguments, 1)
 
-    this.adapter.send.apply(this.adapter, [envelope].concat(strings))
+    return this.adapter.send.apply(this.adapter, [envelope].concat(strings))
   }
 
   // Public: A helper reply function which delegates to the adapter's reply
@@ -590,11 +593,11 @@ class Robot {
   // envelope - A Object with message, room and user details.
   // strings  - One or more Strings for each message to send.
   //
-  // Returns nothing.
+  // Returns whatever the extending adapter returns.
   reply (envelope/* , ...strings */) {
     const strings = [].slice.call(arguments, 1)
 
-    this.adapter.reply.apply(this.adapter, [envelope].concat(strings))
+    return this.adapter.reply.apply(this.adapter, [envelope].concat(strings))
   }
 
   // Public: A helper send function to message a room that the robot is in.
@@ -602,12 +605,12 @@ class Robot {
   // room    - String designating the room to message.
   // strings - One or more Strings for each message to send.
   //
-  // Returns nothing.
+  // Returns whatever the extending adapter returns.
   messageRoom (room/* , ...strings */) {
     const strings = [].slice.call(arguments, 1)
     const envelope = { room }
 
-    this.adapter.send.apply(this.adapter, [envelope].concat(strings))
+    return this.adapter.send.apply(this.adapter, [envelope].concat(strings))
   }
 
   // Public: A wrapper around the EventEmitter API to make usage

package/src/user.js

@@ -18,7 +18,7 @@ class User {
     // robot itself on the user object, preventing it from
     // being serialized into the brain.
     if (options.robot) {
-      let robot = options.robot
+      const robot = options.robot
       delete options.robot
       this._getRobot = function () { return robot }
     } else {
@@ -55,7 +55,7 @@ class User {
   }
 
   _getDatastore () {
-    let robot = this._getRobot()
+    const robot = this._getRobot()
     if (robot) {
       return robot.datastore
     }

package/test/adapter_test.js

@@ -12,7 +12,7 @@ const Adapter = require('../src/adapter')
 
 describe('Adapter', function () {
   beforeEach(function () {
-    this.robot = {receive: sinon.spy()}
+    this.robot = { receive: sinon.spy() }
   })
 
   // this one is hard, as it requires files

package/test/brain_test.js

@@ -30,9 +30,9 @@ describe('Brain', function () {
 
     this.brain = new Brain(this.mockRobot)
 
-    this.user1 = this.brain.userForId('1', {name: 'Guy One'})
-    this.user2 = this.brain.userForId('2', {name: 'Guy One Two'})
-    this.user3 = this.brain.userForId('3', {name: 'Girl Three'})
+    this.user1 = this.brain.userForId('1', { name: 'Guy One' })
+    this.user2 = this.brain.userForId('2', { name: 'Guy One Two' })
+    this.user3 = this.brain.userForId('3', { name: 'Girl Three' })
   })
 
   afterEach(function () {
@@ -47,7 +47,7 @@ describe('Brain', function () {
           2: 'old'
         }
 
-        this.brain.mergeData({2: 'new'})
+        this.brain.mergeData({ 2: 'new' })
 
         expect(this.brain.data).to.deep.equal({
           1: 'old',
@@ -62,8 +62,8 @@ describe('Brain', function () {
       })
 
       it('coerces loaded data into User objects', function () {
-        this.brain.mergeData({users: {'4': {'name': 'new', 'id': '4'}}})
-        let user = this.brain.userForId('4')
+        this.brain.mergeData({ users: { 4: { name: 'new', id: '4' } } })
+        const user = this.brain.userForId('4')
         expect(user.constructor.name).to.equal('User')
         expect(user.id).to.equal('4')
         expect(user.name).to.equal('new')
@@ -213,7 +213,7 @@ describe('Brain', function () {
         })
 
         it('passes the provided options to the new User', function () {
-          const newUser = this.brain.userForId('all-new-user', {name: 'All New User', prop: 'mine'})
+          const newUser = this.brain.userForId('all-new-user', { name: 'All New User', prop: 'mine' })
           expect(newUser.name).to.equal('All New User')
           expect(newUser.prop).to.equal('mine')
         })
@@ -322,11 +322,11 @@ describe('Brain', function () {
 
     it('returns User objects, not POJOs', function () {
       expect(this.brain.userForId('1').constructor.name).to.equal('User')
-      for (let user of this.brain.usersForFuzzyName('Guy')) {
+      for (const user of this.brain.usersForFuzzyName('Guy')) {
         expect(user.constructor.name).to.equal('User')
       }
 
-      for (let user of this.brain.usersForRawFuzzyName('Guy One')) {
+      for (const user of this.brain.usersForRawFuzzyName('Guy One')) {
         expect(user.constructor.name).to.equal('User')
       }
 

package/test/datastore_test.js

@@ -26,8 +26,12 @@ describe('Datastore', function () {
 
     this.robot.brain = new Brain(this.robot)
     this.robot.datastore = new InMemoryDataStore(this.robot)
-    this.robot.brain.userForId('1', {name: 'User One'})
-    this.robot.brain.userForId('2', {name: 'User Two'})
+    this.robot.brain.userForId('1', { name: 'User One' })
+    this.robot.brain.userForId('2', { name: 'User Two' })
+  })
+
+  this.afterEach(function () {
+    this.clock.restore()
   })
 
   describe('global scope', function () {
@@ -46,9 +50,9 @@ describe('Datastore', function () {
     })
 
     it('can store arbitrary JavaScript values', function () {
-      let object = {
-        'name': 'test',
-        'data': [1, 2, 3]
+      const object = {
+        name: 'test',
+        data: [1, 2, 3]
       }
       return this.robot.datastore.set('key', object).then(() => {
         return this.robot.datastore.get('key').then((value) => {
@@ -59,9 +63,9 @@ describe('Datastore', function () {
     })
 
     it('can dig inside objects for values', function () {
-      let object = {
-        'a': 'one',
-        'b': 'two'
+      const object = {
+        a: 'one',
+        b: 'two'
       }
       return this.robot.datastore.set('key', object).then(() => {
         return this.robot.datastore.getObject('key', 'a').then((value) => {
@@ -71,9 +75,9 @@ describe('Datastore', function () {
     })
 
     it('can set individual keys inside objects', function () {
-      let object = {
-        'a': 'one',
-        'b': 'two'
+      const object = {
+        a: 'one',
+        b: 'two'
       }
       return this.robot.datastore.set('object', object).then(() => {
         return this.robot.datastore.setObject('object', 'c', 'three').then(() => {
@@ -89,7 +93,7 @@ describe('Datastore', function () {
     it('creates an object from scratch when none exists', function () {
       return this.robot.datastore.setObject('object', 'key', 'value').then(() => {
         return this.robot.datastore.get('object').then((value) => {
-          let expected = {'key': 'value'}
+          const expected = { key: 'value' }
           expect(value).to.deep.equal(expected)
         })
       })
@@ -116,12 +120,12 @@ describe('Datastore', function () {
 
   describe('User scope', function () {
     it('has access to the robot object', function () {
-      let user = this.robot.brain.userForId('1')
+      const user = this.robot.brain.userForId('1')
       expect(user._getRobot()).to.equal(this.robot)
     })
 
     it('can store user data which is separate from global data', function () {
-      let user = this.robot.brain.userForId('1')
+      const user = this.robot.brain.userForId('1')
       return user.set('blah', 'blah').then(() => {
         return user.get('blah').then((userBlah) => {
           return this.robot.datastore.get('blah').then((datastoreBlah) => {
@@ -134,8 +138,8 @@ describe('Datastore', function () {
     })
 
     it('stores user data separate per-user', function () {
-      let userOne = this.robot.brain.userForId('1')
-      let userTwo = this.robot.brain.userForId('2')
+      const userOne = this.robot.brain.userForId('1')
+      const userTwo = this.robot.brain.userForId('2')
       return userOne.set('blah', 'blah').then(() => {
         return userOne.get('blah').then((valueOne) => {
           return userTwo.get('blah').then((valueTwo) => {

package/test/es2015_test.js

@@ -31,7 +31,7 @@ const loadBot = Hubot.loadBot
 describe('hubot/es2015', function () {
   it('exports User class', function () {
     class MyUser extends User {}
-    const user = new MyUser('id123', {foo: 'bar'})
+    const user = new MyUser('id123', { foo: 'bar' })
 
     expect(user).to.be.an.instanceof(User)
     expect(user.id).to.equal('id123')

package/test/fixtures/mock-adapter.js

@@ -7,21 +7,26 @@ class MockAdapter extends Adapter {
     const strings = [].slice.call(arguments, 1)
     this.emit('send', envelope, strings)
   }
+
   reply (envelope/* , ...strings */) {
     const strings = [].slice.call(arguments, 1)
     this.emit('reply', envelope, strings)
   }
+
   topic (envelope/* , ...strings */) {
     const strings = [].slice.call(arguments, 1)
     this.emit('topic', envelope, strings)
   }
+
   play (envelope/* , ...strings */) {
     const strings = [].slice.call(arguments, 1)
     this.emit('play', envelope, strings)
   }
+
   run () {
     this.emit('connected')
   }
+
   close () {
     this.emit('closed')
   }

package/test/listener_test.js

@@ -303,7 +303,7 @@ describe('Listener', function () {
           const testMessage = {}
 
           const testListener = this.createListener(function () {})
-          const testMiddleware = {execute: sinon.spy()}
+          const testMiddleware = { execute: sinon.spy() }
 
           testListener.call(testMessage, result => {
             expect(testMiddleware.execute).to.not.have.been.called
@@ -334,7 +334,7 @@ describe('Listener', function () {
         const listenerCallback = sinon.spy()
         const testListener = new Listener(this.robot, testMatcher, listenerCallback)
         // slightly brittle because we are testing for the default options Object
-        expect(testListener.options).to.deep.equal({id: null})
+        expect(testListener.options).to.deep.equal({ id: null })
         expect(testListener.callback).to.be.equal(listenerCallback)
       })
 

package/test/middleware_test.js

@@ -23,7 +23,7 @@ describe('Middleware', function () {
   describe('Unit Tests', function () {
     beforeEach(function () {
       // Stub out event emitting
-      this.robot = {emit: sinon.spy()}
+      this.robot = { emit: sinon.spy() }
 
       this.middleware = new Middleware(this.robot)
     })
@@ -284,7 +284,7 @@ describe('Middleware', function () {
           }
 
           this.middleware.execute(
-            {response: testResponse},
+            { response: testResponse },
             middlewareFinished,
             middlewareFailed
           )
@@ -351,6 +351,7 @@ describe('Middleware', function () {
         warnOnUnregistered: false
       })
       mockery.registerMock('hubot-mock-adapter', require('./fixtures/mock-adapter'))
+      process.env.EXPRESS_PORT = 0
       this.robot = new Robot(null, 'mock-adapter', true, 'TestHubot')
       this.robot.run
 
@@ -394,8 +395,8 @@ describe('Middleware', function () {
             expect(this.middleware).to.have.been.calledWithMatch(
               sinon.match.has('listener',
                 sinon.match.same(this.testListener)), // context
-              sinon.match.any,                    // next
-              sinon.match.any                    // done
+              sinon.match.any, // next
+              sinon.match.any // done
             )
             testDone()
           })
@@ -406,9 +407,9 @@ describe('Middleware', function () {
             expect(this.middleware).to.have.been.calledWithMatch(
               sinon.match.has('listener',
                 sinon.match.has('options',
-                  sinon.match.has('id'))),        // context
-              sinon.match.any,                    // next
-              sinon.match.any                    // done
+                  sinon.match.has('id'))), // context
+              sinon.match.any, // next
+              sinon.match.any // done
             )
             testDone()
           })
@@ -423,8 +424,8 @@ describe('Middleware', function () {
                 sinon.match.instanceOf(Response).and(
                   sinon.match.has('message',
                     sinon.match.same(this.testMessage)))), // context
-              sinon.match.any,                         // next
-              sinon.match.any                         // done
+              sinon.match.any, // next
+              sinon.match.any // done
             )
             testDone()
           })
@@ -447,8 +448,8 @@ describe('Middleware', function () {
                 sinon.match.instanceOf(Response).and(
                   sinon.match.has('message',
                     sinon.match.same(this.testMessage)))), // context
-              sinon.match.any,                         // next
-              sinon.match.any                         // done
+              sinon.match.any, // next
+              sinon.match.any // done
             )
             testDone()
           })
@@ -466,11 +467,11 @@ describe('Middleware', function () {
       it('is a function with arity one', function (testDone) {
         this.robot.receive(this.testMessage, () => {
           expect(this.middleware).to.have.been.calledWithMatch(
-            sinon.match.any,             // context
+            sinon.match.any, // context
             sinon.match.func.and(
               sinon.match.has('length',
-                sinon.match(1))),        // next
-            sinon.match.any             // done
+                sinon.match(1))), // next
+            sinon.match.any // done
           )
           testDone()
         })
@@ -487,11 +488,11 @@ describe('Middleware', function () {
       it('is a function with arity zero', function (testDone) {
         this.robot.receive(this.testMessage, () => {
           expect(this.middleware).to.have.been.calledWithMatch(
-            sinon.match.any,             // context
-            sinon.match.any,             // next
+            sinon.match.any, // context
+            sinon.match.any, // next
             sinon.match.func.and(
               sinon.match.has('length',
-                sinon.match(0)))        // done
+                sinon.match(0))) // done
           )
           testDone()
         })

package/test/robot_test.js

@@ -20,6 +20,7 @@ const TopicMessage = require('../src/message').TopicMessage
 
 // mock `hubot-mock-adapter` module from fixture
 const mockery = require('mockery')
+const path = require('path')
 
 describe('Robot', function () {
   beforeEach(function () {
@@ -28,14 +29,14 @@ describe('Robot', function () {
       warnOnUnregistered: false
     })
     mockery.registerMock('hubot-mock-adapter', require('./fixtures/mock-adapter'))
+    process.env.EXPRESS_PORT = 0
     this.robot = new Robot(null, 'mock-adapter', true, 'TestHubot')
     this.robot.alias = 'Hubot'
     this.robot.run()
 
     // Re-throw AssertionErrors for clearer test failures
     this.robot.on('error', function (name, err, response) {
-      if ((err != null ? err.constructor : undefined) == null) { }
-      if (err.constructor.name === 'AssertionError') {
+      if (err?.constructor.name === 'AssertionError' || name instanceof chai.AssertionError) {
         process.nextTick(function () {
           throw err
         })
@@ -69,7 +70,7 @@ describe('Robot', function () {
 
       it('passes options through to the ScopedHttpClient', function () {
         const agent = {}
-        const httpClient = this.robot.http('http://localhost', {agent})
+        const httpClient = this.robot.http('http://localhost', { agent })
         expect(httpClient.options.agent).to.equal(agent)
       })
 
@@ -79,7 +80,7 @@ describe('Robot', function () {
 
       it('merges in any global http options', function () {
         const agent = {}
-        this.robot.globalHttpOptions = {agent}
+        this.robot.globalHttpOptions = { agent }
         const httpClient = this.robot.http('http://localhost')
         expect(httpClient.options.agent).to.equal(agent)
       })
@@ -87,10 +88,18 @@ describe('Robot', function () {
       it('local options override global http options', function () {
         const agentA = {}
         const agentB = {}
-        this.robot.globalHttpOptions = {agent: agentA}
-        const httpClient = this.robot.http('http://localhost', {agent: agentB})
+        this.robot.globalHttpOptions = { agent: agentA }
+        const httpClient = this.robot.http('http://localhost', { agent: agentB })
         expect(httpClient.options.agent).to.equal(agentB)
       })
+
+      it('builds the url correctly from a string', function () {
+        const options = this.httpClient.buildOptions('http://localhost:3001')
+        expect(options.host).to.equal('localhost:3001')
+        expect(options.pathname).to.equal('/')
+        expect(options.protocol).to.equal('http:')
+        expect(options.port).to.equal('3001')
+      })
     })
 
     describe('#respondPattern', function () {
@@ -302,7 +311,7 @@ describe('Robot', function () {
         }
 
         const listenerSpy =
-          {call: sinon.spy()}
+          { call: sinon.spy() }
 
         this.robot.listeners = [
           matchingListener,
@@ -365,7 +374,7 @@ describe('Robot', function () {
 
     describe('#loadFile', function () {
       beforeEach(function () {
-        this.sandbox = sinon.sandbox.create()
+        this.sandbox = sinon.createSandbox()
       })
 
       afterEach(function () {
@@ -380,7 +389,7 @@ describe('Robot', function () {
         this.sandbox.stub(this.robot, 'parseHelp')
 
         this.robot.loadFile('./scripts', 'test-script.js')
-        expect(module._load).to.have.been.calledWith('scripts/test-script')
+        expect(module._load).to.have.been.calledWith(path.join('scripts', 'test-script'))
       })
 
       describe('proper script', function () {
@@ -399,7 +408,7 @@ describe('Robot', function () {
 
         it('should parse the script documentation', function () {
           this.robot.loadFile('./scripts', 'test-script.js')
-          expect(this.robot.parseHelp).to.have.been.calledWith('scripts/test-script.js')
+          expect(this.robot.parseHelp).to.have.been.calledWith(path.join('scripts', 'test-script.js'))
         })
       })
 
@@ -412,11 +421,17 @@ describe('Robot', function () {
           this.sandbox.stub(this.robot, 'parseHelp')
         })
 
-        it('logs a warning', function () {
+        it('logs a warning for a .js file', function () {
           sinon.stub(this.robot.logger, 'warning')
           this.robot.loadFile('./scripts', 'test-script.js')
           expect(this.robot.logger.warning).to.have.been.called
         })
+
+        it('logs a warning for a .mjs file', function () {
+          sinon.stub(this.robot.logger, 'warning')
+          this.robot.loadFile('./scripts', 'test-script.mjs')
+          expect(this.robot.logger.warning).to.have.been.called
+        })
       })
 
       describe('unsupported file extension', function () {
@@ -709,7 +724,7 @@ describe('Robot', function () {
       this.robot.catchAll(catchAllCallback)
 
       this.robot.receive(testMessage, function () {
-        expect(listenerCallback).to.have.been.called.once
+        expect(listenerCallback).to.have.been.calledOnce
         expect(catchAllCallback).to.not.have.been.called
         done()
       })
@@ -1013,7 +1028,7 @@ describe('Robot', function () {
       })
 
       it('marks plaintext as plaintext', function (testDone) {
-        let sendSpy = sinon.spy()
+        const sendSpy = sinon.spy()
         this.robot.adapter.send = sendSpy
         this.robot.hear(/^message123$/, response => response.send('foobar, sir, foobar.'))
         this.robot.hear(/^message456$/, response => response.play('good luck with that'))

package/test/shell_test.js

@@ -0,0 +1,72 @@
+'use strict'
+
+/* global describe, beforeEach, it */
+
+const chai = require('chai')
+const sinon = require('sinon')
+chai.use(require('sinon-chai'))
+
+const expect = chai.expect
+
+const Robot = require('../src/robot')
+
+describe('Shell Adapter', function () {
+  beforeEach(function () {
+    this.robot = new Robot(null, 'shell', false, 'TestHubot')
+    this.robot.run()
+  })
+
+  this.afterEach(function () {
+    this.robot.shutdown()
+  })
+
+  describe('Public API', function () {
+    beforeEach(function () {
+      this.adapter = this.robot.adapter
+    })
+
+    it('assigns robot', function () {
+      expect(this.adapter.robot).to.equal(this.robot)
+    })
+
+    it('sends a message', function () {
+      this.adapter.send = sinon.spy()
+      this.adapter.send({ room: 'general' }, 'hello')
+
+      expect(this.adapter.send).to.have.been.calledWith({ room: 'general' }, 'hello')
+    })
+
+    it('emotes a message', function () {
+      this.adapter.send = sinon.spy()
+      this.adapter.emote({ room: 'general' }, 'hello')
+
+      expect(this.adapter.send).to.have.been.calledWith({ room: 'general' }, '* hello')
+    })
+
+    it('replies to a message', function () {
+      this.adapter.send = sinon.spy()
+      this.adapter.reply({ room: 'general', user: { name: 'mocha' } }, 'hello')
+
+      expect(this.adapter.send).to.have.been.calledWith({ room: 'general', user: { name: 'mocha' } }, 'mocha: hello')
+    })
+
+    it('runs the adapter and emits connected', function (done) {
+      const connected = () => {
+        this.adapter.off('connected', connected)
+        done()
+      }
+      this.adapter.on('connected', connected)
+      this.adapter.run()
+    })
+  })
+
+  it('dispatches received messages to the robot', function () {
+    this.robot.receive = sinon.spy()
+    this.adapter = this.robot.adapter
+    this.message = sinon.spy()
+
+    this.adapter.receive(this.message)
+
+    expect(this.robot.receive).to.have.been.calledWith(this.message)
+  })
+})