hubot 9.1.0 → 10.0.0

package/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2011-2017 GitHub Inc.
+Copyright (c) 2011-2023 GitHub Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

package/README.md

@@ -1,3 +1,5 @@
+![Pipeline Status](https://github.com/hubotio/hubot/actions/workflows/pipeline.yml/badge.svg)
+
 ![Build Status: MacOS](https://github.com/hubotio/hubot/actions/workflows/nodejs-macos.yml/badge.svg)
 ![Build Status: Ubuntu](https://github.com/hubotio/hubot/actions/workflows/nodejs-ubuntu.yml/badge.svg)
 ![Build Status: Window](https://github.com/hubotio/hubot/actions/workflows/nodejs-windows.yml/badge.svg)
@@ -5,11 +7,11 @@
 # Hubot
 
 Hubot is a framework to build chat bots, modeled after GitHub's Campfire bot of the same name, hubot.
-He's pretty cool. He's [extendable with scripts](http://hubot.github.com/docs/#scripts) and can work
-on [many different chat services](https://hubot.github.com/docs/adapters/).
+He's pretty cool. He's [extendable with scripts](https://hubotio.github.io/hubot/docs#scripts) and can work
+on [many different chat services](https://hubotio.github.io/hubot/adapters.html).
 
 This repository provides a library that's distributed by `npm` that you
-use for building your own bots.  See the [documentation](http://hubot.github.com/docs)
+use for building your own bots.  See the [documentation](https://hubotio.github.io/hubot/docs.html)
 for details on getting up and running with your very own robot friend.
 
 In most cases, you'll probably never have to hack on this repo directly if you
@@ -17,10 +19,13 @@ are building your own bot. But if you do, check out [CONTRIBUTING.md](CONTRIBUTI
 
 # Create your own Hubot instance
 
+This will create a directory called `myhubot` in the current working directory.
+
 ```sh
-mkdir myhubot
-cd myhubot
 npx hubot --create myhubot --adapter @hubot-friends/hubot-slack
+npx hubot --create myhubot --adapter @hubot-friends/hubot-discord
+npx hubot --create myhubot --adapter @hubot-friends/hubot-ms-teams
+npx hubot --create myhubot --adapter @hubot-friends/hubot-irc
 ```
 
 Review `scripts/example.mjs`. Create more scripts in the `scripts` folder.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hubot",
-  "version": "9.1.0",
+  "version": "10.0.0",
   "author": "hubot",
   "keywords": [
     "github",
@@ -15,7 +15,6 @@
     "url": "https://github.com/hubotio/hubot.git"
   },
   "dependencies": {
-    "cline": "^0.8.2",
     "coffeescript": "^2.7.0",
     "connect-multiparty": "^2.2.0",
     "express": "^4.18.2",
@@ -40,7 +39,9 @@
     "pretest": "standard",
     "test": "node --test",
     "test:smoke": "node src/**/*.js",
-    "test:e2e": "bin/e2e-test.sh"
+    "test:e2e": "bin/e2e-test.sh",
+    "build:local": "npx @hubot-friends/sfab --folder ./docs --destination ./_site --verbose --serve /hubot/ --watch-path ./docs --scripts ./sfab-hooks",
+    "build": "npx @hubot-friends/sfab --folder ./docs --destination ./_site --verbose --scripts ./sfab-hooks"
   },
   "release": {
     "branches": [

package/sfab-hooks/SfabHook.mjs

@@ -0,0 +1,11 @@
+export default () => {
+  return {
+    model (file, model) {
+      return {
+        base: {
+          href: '/hubot/'
+        }
+      }
+    }
+  }
+}

package/src/adapters/shell.js

@@ -1,19 +1,26 @@
 'use strict'
 
 const fs = require('fs')
-const readline = require('readline')
-const Stream = require('stream')
-const cline = require('cline')
-
+const readline = require('node:readline')
 const Adapter = require('../adapter')
-
-const _require = require('../message')
-
-const TextMessage = _require.TextMessage
+const { TextMessage } = require('../message')
 
 const historySize = process.env.HUBOT_SHELL_HISTSIZE != null ? parseInt(process.env.HUBOT_SHELL_HISTSIZE) : 1024
-
 const historyPath = '.hubot_history'
+
+const completer = line => {
+  const completions = '\\q exit \\? help \\c clear'.split(' ')
+  const hits = completions.filter((c) => c.startsWith(line))
+  // Show all completions if none found
+  return [hits.length ? hits : completions, line]
+}
+const showHelp = () => {
+  console.log('usage:')
+  console.log('\\q, exit - close shell and exit')
+  console.log('\\?, help - show this help')
+  console.log('\\c, clear - clear screen')
+}
+
 const bold = str => `\x1b[1m${str}\x1b[22m`
 
 class Shell extends Adapter {
@@ -37,32 +44,45 @@ class Shell extends Adapter {
   }
 
   async run () {
-    this.buildCli()
-    try {
-      const { readlineInterface, history } = await this.#loadHistory()
-      this.cli.history(history)
-      this.cli.interact(`${this.robot.name ?? this.robot.alias}> `)
-      this.#rl = readlineInterface
-      this.emit('connected', this)
-    } catch (error) {
-      console.log(error)
+    if (!fs.existsSync(historyPath)) {
+      fs.writeFileSync(historyPath, '')
     }
-  }
-
-  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()
+    const stats = fs.statSync(historyPath)
+    if (stats.size > historySize) {
+      fs.unlinkSync(historyPath)
     }
-    this.cli.removeAllListeners()
-    this.cli.close()
-  }
-
-  buildCli () {
-    this.cli = cline()
-
-    this.cli.command('*', async input => {
+    this.#rl = readline.createInterface({
+      input: process.stdin,
+      output: process.stdout,
+      prompt: `${this.robot.name ?? this.robot.alias}> `,
+      completer
+    })
+    this.#rl.on('line', async (line) => {
+      const input = line.trim()
+      switch (input) {
+        case '\\q':
+        case 'exit':
+          this.#rl.close()
+          break
+        case '\\?':
+        case 'help':
+          showHelp()
+          break
+        case '\\c':
+        case 'clear':
+          this.#rl.write(null, { ctrl: true, name: 'l' })
+          this.#rl.prompt()
+          break
+      }
+      const history = fs.readFileSync(historyPath, 'utf-8').split('\n').reverse()
+      this.#rl.history = history
+      this.#rl.on('line', line => {
+        const input = line.trim()
+        if (input.length === 0) return
+        fs.appendFile(historyPath, `${input}\n`, err => {
+          if (err) console.error(err)
+        })
+      })
       let userId = process.env.HUBOT_SHELL_USER_ID || '1'
       if (userId.match(/A\d+z/)) {
         userId = parseInt(userId)
@@ -71,68 +91,25 @@ class Shell extends Adapter {
       const userName = process.env.HUBOT_SHELL_USER_NAME || 'Shell'
       const user = this.robot.brain.userForId(userId, { name: userName, room: 'Shell' })
       await this.receive(new TextMessage(user, input, 'messageId'))
+      this.#rl.prompt()
+    }).on('close', () => {
+      process.exit(0)
     })
-
-    this.cli.command('history', () => {
-      Array.from(this.cli.history()).map(item => console.log(item))
-    })
-
-    this.cli.on('history', item => {
-      if (item.length > 0 && item !== 'exit' && item !== 'history') {
-        fs.appendFile(historyPath, `${item}\n`, error => {
-          if (error) {
-            this.robot.emit('error', error)
-          }
-        })
-      }
-    })
-
-    this.cli.on('close', () => {
-      let history, i, item, len
-
-      history = this.cli.history()
-
-      if (history.length <= historySize) {
-        return
-      }
-
-      const startIndex = history.length - historySize
-      history = history.reverse().splice(startIndex, historySize)
-      const fileOpts = {
-        mode: 0x180
-      }
-
-      const outstream = fs.createWriteStream(historyPath, fileOpts)
-      for (i = 0, len = history.length; i < len; i++) {
-        item = history[i]
-        outstream.write(item + '\n')
-      }
-      outstream.end()
-    })
+    try {
+      this.#rl.prompt()
+      this.emit('connected', this)
+    } catch (error) {
+      console.log(error)
+    }
   }
 
-  async #loadHistory () {
-    if (!fs.existsSync(historyPath)) {
-      return new Error('No history available')
+  close () {
+    super.close()
+    if (this.#rl?.close) {
+      this.#rl.close()
     }
-    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)
-    })
+    this.cli.removeAllListeners()
+    this.cli.close()
   }
 }
 

package/src/robot.js

@@ -37,6 +37,7 @@ class Robot {
     this.brain = new Brain(this)
     this.alias = alias
     this.adapter = null
+    this.shouldEnableHttpd = httpd ?? true
     this.datastore = null
     this.Response = Response
     this.commands = []
@@ -55,18 +56,13 @@ class Robot {
     this.globalHttpOptions = {}
 
     this.parseVersion()
-    if (httpd) {
-      this.setupExpress()
-    } else {
-      this.setupNullRouter()
-    }
-
     this.adapterName = adapter ?? 'shell'
     this.errorHandlers = []
 
     this.on('error', (err, res) => {
       return this.invokeErrorHandlers(err, res)
     })
+    this.on('listening', this.herokuKeepalive.bind(this))
   }
 
   // Public: Adds a custom Listener with the provided matcher, options, and
@@ -407,8 +403,8 @@ class Robot {
 
   // Setup the Express server's defaults.
   //
-  // Returns nothing.
-  setupExpress () {
+  // Returns Server.
+  async setupExpress () {
     const user = process.env.EXPRESS_USER
     const pass = process.env.EXPRESS_PASSWORD
     const stat = process.env.EXPRESS_STATIC
@@ -444,27 +440,18 @@ class Robot {
     if (stat) {
       app.use(express.static(stat))
     }
-
-    try {
-      this.server = app.listen(port, address)
-      this.router = app
-    } catch (error) {
-      this.logger.error(`Error trying to start HTTP server: ${error}\n${error.stack}`)
-      throw error
-    }
-
-    let herokuUrl = process.env.HEROKU_URL
-
-    if (herokuUrl) {
-      if (!/\/$/.test(herokuUrl)) {
-        herokuUrl += '/'
-      }
-      this.pingIntervalId = setInterval(() => {
-        HttpClient.create(`${herokuUrl}hubot/ping`).post()((_err, res, body) => {
-          this.logger.info('keep alive ping!')
+    const p = new Promise((resolve, reject) => {
+      try {
+        this.server = app.listen(port, address, () => {
+          this.router = app
+          this.emit('listening', this.server)
+          resolve(this.server)
         })
-      }, 5 * 60 * 1000)
-    }
+      } catch (err) {
+        reject(err)
+      }
+    })
+    return p
   }
 
   // Setup an empty router object
@@ -645,6 +632,11 @@ class Robot {
   //
   // Returns whatever the adapter returns.
   async run () {
+    if (this.shouldEnableHttpd) {
+      await this.setupExpress()
+    } else {
+      this.setupNullRouter()
+    }
     this.emit('running')
 
     return await this.adapter.run()
@@ -712,6 +704,20 @@ class Robot {
 
     return HttpClient.create(url, httpOptions).header('User-Agent', `Hubot/${this.version}`)
   }
+
+  herokuKeepalive (server) {
+    let herokuUrl = process.env.HEROKU_URL
+    if (herokuUrl) {
+      if (!/\/$/.test(herokuUrl)) {
+        herokuUrl += '/'
+      }
+      this.pingIntervalId = setInterval(() => {
+        HttpClient.create(`${herokuUrl}hubot/ping`).post()((_err, res, body) => {
+          this.logger.info('keep alive ping!')
+        })
+      }, 5 * 60 * 1000)
+    }
+  }
 }
 
 module.exports = Robot