hubot 3.3.1 → 3.4.0

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,
@@ -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 () {
@@ -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/user_test.js

@@ -14,14 +14,14 @@ describe('User', () =>
     })
 
     it('sets attributes passed in', function () {
-      const user = new User('hubot', {foo: 1, bar: 2})
+      const user = new User('hubot', { foo: 1, bar: 2 })
 
       expect(user.foo).to.equal(1)
       expect(user.bar).to.equal(2)
     })
 
     it('uses name attribute when passed in, not id', function () {
-      const user = new User('hubot', {name: 'tobuh'})
+      const user = new User('hubot', { name: 'tobuh' })
 
       expect(user.name).to.equal('tobuh')
     })

package/ROADMAP.md

@@ -1,37 +0,0 @@
-# Hubot Roadmap
-
-Hubot v3 aims to be a bot framework optimized for developers and developer workflows, with great integration with the most popular chat clients and developer tools, and an active community that is sharing scripts and best practices.
-
-This roadmap represents some of priorities for us over the next couple months. Issues or pull requests will be opened to discuss each of these items as they progress.
-
-## 1. Return to a “maintained” status
-
-- [x] Create a Hubot core team with at least 2 GitHub employees and at least 1 community member. The core team is [@technicalpickles](https://github.com/technicalpickles), [@bkeepers](https://github.com/bkeepers), [@mose](https://github.com/mose), and [@gr2m](https://github.com/gr2m) ([#1323](https://github.com/github/hubot/pull/1323))
-- [ ] Document all maintainer processes (triage, release, etc.)
-- [ ] Create an issue template that addresses common requests
-- [ ] Configure automation ([probot stale](https://github.com/probot/stale), [Greenkeeper](https://greenkeeper.io/), [semantic-release](https://github.com/semantic-release/semantic-release))
-- [ ] Review all [open PRs](https://github.com/github/hubot/pulls) and triage [open issues](https://github.com/github/hubot/issues)
-- [ ] Establish a release process and regular release cadence of the first Tuesday of every month.
-- [ ] Establish a first-responder rotation, which will aim to reduce the average time to first response on all new Issues and PRs to 48 hours.
-
-## 2. Modernize the community
-
-- [ ] Consolidate all officially supported Hubot projects into a single GitHub organization. This will include github/hubot and a handful of supported scripts, but will not include all community scripts in https://github.com/hubot-scripts ([#1327](https://github.com/github/hubot/issues/1327))
-- [ ] Create a community forum to provide a place for people to ask questions, get help, and share best practices. [Discourse](https://www.discourse.org/) is the obvious choice here.
-- [x] Choose a chat platform for maintainers and contributors, and post notices in various existing places (#hubot on freenode, github/hubot on Gitter). Slack is the obvious choice here. [Join us on Slack](https://hubot-slackin.herokuapp.com/).
-- [x] Add a code of conduct based on http://contributor-covenant.org/ and processes to enforce it in all official spaces. ([#1334](https://github.com/github/hubot/pull/1334))
-- [ ] Publish weekly community updates (blog, newsletter, etc) which highlight recent and upcoming changes, give shoutouts to contributors / maintainers, and maybe mention interesting uses of Hubot
-- [x] Create Hubot Evolution—inspired by [Swift Evolution](https://github.com/apple/swift-evolution)—for proposing user-visible enhancements. ([hubotio/evolution#1](https://github.com/hubotio/evolution/pull/1))
-
-## 3. Modernize the project
-
-Each of these proposals will go through the [Hubot Evolution](https://github.com/hubotio/evolution) process.
-
-- Translate from CoffeeScript to JavaScript and update to modern versions of Node.js and NPM (or Yarn)
-- Revisit new bot generator (yeoman has a ton of dependencies, some of which can be error prone on windows)
-- Support for running multiple adapters and archetypes (chat, deployment, CI, github, etc)
-- Merge with [@probot](https://github.com/probot) and build out first class GitHub integration.
-- Introduce "Commands”, an explicit interface for registering commands (like Slack’s slash commands) as an alternative to regular expressions
-- Publish a ChatOps RPC spec and implement support for Hubot acting as both a client and a server.
-- Support rich messages and interactions on platforms that support it
-- Publish a public script directory backed by NPM