hubot 8.1.0 → 9.0.1

package/bin/hubot.js

@@ -153,5 +153,5 @@ function loadExternalScripts () {
 
   robot.adapter.once('connected', loadScripts)
 
-  robot.run()
+  await robot.run()
 })()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hubot",
-  "version": "8.1.0",
+  "version": "9.0.1",
   "author": "hubot",
   "keywords": [
     "github",
@@ -24,17 +24,12 @@
     "pino": "^8.11.0"
   },
   "devDependencies": {
-    "chai": "^4.3.7",
-    "is-circular": "^1.0.2",
-    "mocha": "^10.2.0",
     "semantic-release": "^21.0.1",
-    "sinon": "^15.0.4",
-    "sinon-chai": "^3.7.0",
     "standard": "^17.1.0"
   },
   "engines": {
-    "node": "> 16.20.2",
-    "npm": "> 8.19.4"
+    "node": ">= 18",
+    "npm": ">= 9"
   },
   "main": "./index",
   "bin": {
@@ -43,7 +38,7 @@
   "scripts": {
     "start": "bin/hubot",
     "pretest": "standard",
-    "test": "mocha --exit",
+    "test": "node --test",
     "test:smoke": "node src/**/*.js",
     "test:e2e": "bin/e2e-test.sh"
   },

package/src/adapter.js

@@ -27,7 +27,7 @@ class Adapter extends EventEmitter {
   //
   // Returns results from adapter.
   async emote (envelope, ...strings) {
-    return this.senda(envelope, ...strings)
+    return this.send(envelope, ...strings)
   }
 
   // Public: Raw method for building a reply and sending it back to the chat
@@ -57,13 +57,15 @@ class Adapter extends EventEmitter {
 
   // Public: Raw method for invoking the bot to run. Extend this.
   //
-  // Returns nothing.
-  run () {}
+  // Returns whatever the extended adapter returns.
+  async run () {}
 
   // Public: Raw method for shutting the bot down. Extend this.
   //
   // Returns nothing.
-  close () {}
+  close () {
+    this.removeAllListeners()
+  }
 
   // Public: Dispatch a received message to the robot.
   //
@@ -75,24 +77,27 @@ class Adapter extends EventEmitter {
   // Public: Get an Array of User objects stored in the brain.
   //
   // Returns an Array of User objects.
+  // @deprecated Use @robot.brain
   users () {
-    this.robot.logger.warning('@users() is going to be deprecated in 3.0.0 use @robot.brain.users()')
+    this.robot.logger.warning('@users() is going to be deprecated in 11.0.0 use @robot.brain.users()')
     return this.robot.brain.users()
   }
 
   // Public: Get a User object given a unique identifier.
   //
   // Returns a User instance of the specified user.
+  // @deprecated Use @robot.brain
   userForId (id, options) {
-    this.robot.logger.warning('@userForId() is going to be deprecated in 3.0.0 use @robot.brain.userForId()')
+    this.robot.logger.warning('@userForId() is going to be deprecated in 11.0.0 use @robot.brain.userForId()')
     return this.robot.brain.userForId(id, options)
   }
 
   // Public: Get a User object given a name.
   //
   // Returns a User instance for the user with the specified name.
+  // @deprecated Use @robot.brain
   userForName (name) {
-    this.robot.logger.warning('@userForName() is going to be deprecated in 3.0.0 use @robot.brain.userForName()')
+    this.robot.logger.warning('@userForName() is going to be deprecated in 11.0.0 use @robot.brain.userForName()')
     return this.robot.brain.userForName(name)
   }
 
@@ -101,8 +106,9 @@ class Adapter extends EventEmitter {
   // nicknames, etc.
   //
   // Returns an Array of User instances matching the fuzzy name.
+  // @deprecated Use @robot.brain
   usersForRawFuzzyName (fuzzyName) {
-    this.robot.logger.warning('@userForRawFuzzyName() is going to be deprecated in 3.0.0 use @robot.brain.userForRawFuzzyName()')
+    this.robot.logger.warning('@userForRawFuzzyName() is going to be deprecated in 11.0.0 use @robot.brain.userForRawFuzzyName()')
     return this.robot.brain.usersForRawFuzzyName(fuzzyName)
   }
 
@@ -111,8 +117,9 @@ class Adapter extends EventEmitter {
   // fuzzyName is a raw fuzzy match (see usersForRawFuzzyName).
   //
   // Returns an Array of User instances matching the fuzzy name.
+  // @deprecated Use @robot.brain
   usersForFuzzyName (fuzzyName) {
-    this.robot.logger.warning('@userForFuzzyName() is going to be deprecated in 3.0.0 use @robot.brain.userForFuzzyName()')
+    this.robot.logger.warning('@userForFuzzyName() is going to be deprecated in 11.0.0 use @robot.brain.userForFuzzyName()')
     return this.robot.brain.usersForFuzzyName(fuzzyName)
   }
 
@@ -122,8 +129,9 @@ class Adapter extends EventEmitter {
   // send the request.
   //
   // Returns a ScopedClient instance.
+  // @deprecated Use node.js fetch.
   http (url) {
-    this.robot.logger.warning('@http() is going to be deprecated in 3.0.0 use @robot.http()')
+    this.robot.logger.warning('@http() is going to be deprecated in 11.0.0 use @robot.http()')
     return this.robot.http(url)
   }
 }

package/src/adapters/campfire.js

@@ -82,7 +82,7 @@ class Campfire extends Adapter {
     })
   }
 
-  run () {
+  async run () {
     const self = this
 
     const options = {

package/src/adapters/shell.js

@@ -17,6 +17,7 @@ const historyPath = '.hubot_history'
 const bold = str => `\x1b[1m${str}\x1b[22m`
 
 class Shell extends Adapter {
+  #rl = null
   constructor (robot) {
     super(robot)
     this.name = 'Shell'
@@ -35,27 +36,33 @@ class Shell extends Adapter {
     this.send(envelope, ...strings)
   }
 
-  run () {
+  async run () {
     this.buildCli()
-    loadHistory((error, history) => {
-      if (error) {
-        console.log(error.message)
-      }
+    try {
+      const { readlineInterface, history } = await this.#loadHistory()
       this.cli.history(history)
-      this.cli.interact(`${this.robot.name}> `)
-      return this.emit('connected', this)
-    })
+      this.cli.interact(`${this.robot.name ?? this.robot.alias}> `)
+      this.#rl = readlineInterface
+      this.emit('connected', this)
+    } catch (error) {
+      console.log(error)
+    }
   }
 
-  shutdown () {
-    this.robot.shutdown()
-    return process.exit(0)
+  close () {
+    super.close()
+    // Getting an error message on GitHubt Actions: error: 'this[#rl].close is not a function'
+    if (this.#rl?.close) {
+      this.#rl.close()
+    }
+    this.cli.removeAllListeners()
+    this.cli.close()
   }
 
   buildCli () {
     this.cli = cline()
 
-    this.cli.command('*', input => {
+    this.cli.command('*', async input => {
       let userId = process.env.HUBOT_SHELL_USER_ID || '1'
       if (userId.match(/A\d+z/)) {
         userId = parseInt(userId)
@@ -63,7 +70,7 @@ class Shell extends Adapter {
 
       const userName = process.env.HUBOT_SHELL_USER_NAME || 'Shell'
       const user = this.robot.brain.userForId(userId, { name: userName, room: 'Shell' })
-      this.receive(new TextMessage(user, input, 'messageId'))
+      await this.receive(new TextMessage(user, input, 'messageId'))
     })
 
     this.cli.command('history', () => {
@@ -86,7 +93,7 @@ class Shell extends Adapter {
       history = this.cli.history()
 
       if (history.length <= historySize) {
-        return this.shutdown()
+        return
       }
 
       const startIndex = history.length - historySize
@@ -96,11 +103,35 @@ class Shell extends Adapter {
       }
 
       const outstream = fs.createWriteStream(historyPath, fileOpts)
-      outstream.on('end', this.shutdown.bind(this))
       for (i = 0, len = history.length; i < len; i++) {
         item = history[i]
         outstream.write(item + '\n')
       }
+      outstream.end()
+    })
+  }
+
+  async #loadHistory () {
+    if (!fs.existsSync(historyPath)) {
+      return new Error('No history available')
+    }
+    const instream = fs.createReadStream(historyPath)
+    const outstream = new Stream()
+    outstream.readable = true
+    outstream.writable = true
+    const history = []
+    const readlineInterface = readline.createInterface({ input: instream, output: outstream, terminal: false })
+    return new Promise((resolve, reject) => {
+      readlineInterface.on('line', line => {
+        line = line.trim()
+        if (line.length > 0) {
+          history.push(line)
+        }
+      })
+      readlineInterface.on('close', () => {
+        resolve({ readlineInterface, history })
+      })
+      readlineInterface.on('error', reject)
     })
   }
 }
@@ -108,29 +139,3 @@ class Shell extends Adapter {
 // Prevent output buffer "swallowing" every other character on OSX / Node version > 16.19.0.
 process.stdout._handle.setBlocking(false)
 exports.use = robot => new Shell(robot)
-
-// load history from .hubot_history.
-//
-// callback - A Function that is called with the loaded history items (or an empty array if there is no history)
-function loadHistory (callback) {
-  if (!fs.existsSync(historyPath)) {
-    return callback(new Error('No history available'))
-  }
-
-  const instream = fs.createReadStream(historyPath)
-  const outstream = new Stream()
-  outstream.readable = true
-  outstream.writable = true
-
-  const items = []
-
-  readline.createInterface({ input: instream, output: outstream, terminal: false })
-    .on('line', function (line) {
-      line = line.trim()
-      if (line.length > 0) {
-        items.push(line)
-      }
-    })
-    .on('close', () => callback(null, items))
-    .on('error', callback)
-}

package/src/brain.js

@@ -109,6 +109,7 @@ class Brain extends EventEmitter {
     clearInterval(this.saveInterval)
     this.save()
     this.emit('close')
+    this.removeAllListeners()
   }
 
   // Public: Enable or disable the automatic saving

package/src/datastore.js

@@ -13,52 +13,49 @@ class DataStore {
   // write has completed.
   //
   // Value can be any JSON-serializable type.
-  set (key, value) {
-    return this._set(key, value, 'global')
+  async set (key, value) {
+    return await this._set(key, value, 'global')
   }
 
   // Public: Assuming `key` represents an object in the database,
   // sets its `objectKey` to `value`. If `key` isn't already
   // present, it's instantiated as an empty object.
-  setObject (key, objectKey, value) {
-    return this.get(key).then((object) => {
-      const target = object || {}
-      target[objectKey] = value
-      return this.set(key, target)
-    })
+  async setObject (key, objectKey, value) {
+    const object = await this.get(key)
+    const target = object || {}
+    target[objectKey] = value
+    return await this.set(key, target)
   }
 
   // Public: Adds the supplied value(s) to the end of the existing
   // array in the database marked by `key`. If `key` isn't already
   // present, it's instantiated as an empty array.
-  setArray (key, value) {
-    return this.get(key).then((object) => {
-      const target = object || []
-      // Extend the array if the value is also an array, otherwise
-      // push the single value on the end.
-      if (Array.isArray(value)) {
-        return this.set(key, target.push.apply(target, value))
-      } else {
-        return this.set(key, target.concat(value))
-      }
-    })
+  async setArray (key, value) {
+    const object = await this.get(key)
+    const target = object ?? []
+    // Extend the array if the value is also an array, otherwise
+    // push the single value on the end.
+    if (Array.isArray(value)) {
+      return await this.set(key, target.concat(value))
+    } else {
+      return await this.set(key, target.concat([value]))
+    }
   }
 
   // Public: Get value by key if in the database or return `undefined`
   // if not found. Returns a promise which resolves to the
   // requested value.
-  get (key) {
-    return this._get(key, 'global')
+  async get (key) {
+    return await this._get(key, 'global')
   }
 
   // Public: Digs inside the object at `key` for a key named
   // `objectKey`. If `key` isn't already present, or if it doesn't
   // contain an `objectKey`, returns `undefined`.
-  getObject (key, objectKey) {
-    return this.get(key).then((object) => {
-      const target = object || {}
-      return target[objectKey]
-    })
+  async getObject (key, objectKey) {
+    const object = await this.get(key)
+    const target = object || {}
+    return target[objectKey]
   }
 
   // Private: Implements the underlying `set` logic for the datastore.
@@ -70,7 +67,7 @@ class DataStore {
   // This returns a resolved promise when the `set` operation is
   // successful, and a rejected promise if the operation fails.
   _set (key, value, table) {
-    return Promise.reject(new DataStoreUnavailable('Setter called on the abstract class.'))
+    throw new DataStoreUnavailable('Setter called on the abstract class.')
   }
 
   // Private: Implements the underlying `get` logic for the datastore.
@@ -82,7 +79,7 @@ class DataStore {
   // This returns a resolved promise containing the fetched value on
   // success, and a rejected promise if the operation fails.
   _get (key, table) {
-    return Promise.reject(new DataStoreUnavailable('Getter called on the abstract class.'))
+    throw new DataStoreUnavailable('Getter called on the abstract class.')
   }
 }
 

package/src/datastores/memory.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const DataStore = require('../datastore').DataStore
+const DataStore = require('../datastore.js').DataStore
 
 class InMemoryDataStore extends DataStore {
   constructor (robot) {
@@ -11,11 +11,11 @@ class InMemoryDataStore extends DataStore {
     }
   }
 
-  _get (key, table) {
+  async _get (key, table) {
     return Promise.resolve(this.data[table][key])
   }
 
-  _set (key, value, table) {
+  async _set (key, value, table) {
     return Promise.resolve(this.data[table][key] = value)
   }
 }

package/src/response.js

@@ -65,7 +65,7 @@ class Response {
   //
   // Returns result from middleware.
   async play (...strings) {
-    return await this.#runWithMiddleware('play', ...strings)
+    return await this.#runWithMiddleware('play', {}, ...strings)
   }
 
   // Public: Posts a message in an unlogged room

package/src/robot.js

@@ -50,11 +50,6 @@ class Robot {
       name,
       level: process.env.HUBOT_LOG_LEVEL || 'info'
     })
-    Reflect.defineProperty(this.logger, 'warning', {
-      value: this.logger.warn,
-      enumerable: true,
-      configurable: true
-    })
 
     this.pingIntervalId = null
     this.globalHttpOptions = {}
@@ -72,10 +67,6 @@ class Robot {
     this.on('error', (err, res) => {
       return this.invokeErrorHandlers(err, res)
     })
-    this.onUncaughtException = err => {
-      return this.emit('error', err)
-    }
-    process.on('uncaughtException', this.onUncaughtException)
   }
 
   // Public: Adds a custom Listener with the provided matcher, options, and
@@ -232,9 +223,8 @@ class Robot {
       options = {}
     }
 
-    this.listen(isCatchAllMessage, options, function listenCallback (msg) {
-      msg.message = msg.message.message
-      callback(msg)
+    this.listen(isCatchAllMessage, options, async msg => {
+      await callback(msg.message)
     })
   }
 
@@ -376,7 +366,7 @@ class Robot {
       this.parseHelp(full)
     } catch (error) {
       this.logger.error(`Unable to load ${full}: ${error.stack}`)
-      process.exit(1)
+      throw error
     }
   }
 
@@ -411,7 +401,7 @@ class Robot {
       Object.keys(packages).forEach(key => require(key)(this, packages[key]))
     } catch (error) {
       this.logger.error(`Error loading scripts from npm package - ${error.stack}`)
-      process.exit(1)
+      throw error
     }
   }
 
@@ -459,9 +449,8 @@ class Robot {
       this.server = app.listen(port, address)
       this.router = app
     } catch (error) {
-      const err = error
-      this.logger.error(`Error trying to start HTTP server: ${err}\n${err.stack}`)
-      process.exit(1)
+      this.logger.error(`Error trying to start HTTP server: ${error}\n${error.stack}`)
+      throw error
     }
 
     let herokuUrl = process.env.HEROKU_URL
@@ -520,9 +509,9 @@ class Robot {
           }
         }
       }
-    } catch (err) {
-      this.logger.error(`Cannot load adapter ${adapterPath ?? '[no path set]'} ${this.adapterName} - ${err}`)
-      process.exit(1)
+    } catch (error) {
+      this.logger.error(`Cannot load adapter ${adapterPath ?? '[no path set]'} ${this.adapterName} - ${error}`)
+      throw error
     }
   }
 
@@ -654,11 +643,11 @@ class Robot {
 
   // Public: Kick off the event loop for the adapter
   //
-  // Returns nothing.
-  run () {
+  // Returns whatever the adapter returns.
+  async run () {
     this.emit('running')
 
-    this.adapter.run()
+    return await this.adapter.run()
   }
 
   // Public: Gracefully shutdown the robot process
@@ -668,13 +657,12 @@ class Robot {
     if (this.pingIntervalId != null) {
       clearInterval(this.pingIntervalId)
     }
-    process.removeListener('uncaughtException', this.onUncaughtException)
-    this.adapter.close()
+    this.adapter?.close()
     if (this.server) {
       this.server.close()
     }
-
     this.brain.close()
+    this.events.removeAllListeners()
   }
 
   // Public: The version of Hubot from npm