resolve co-pilot suggestions

Author: joeyguerra

bin/Hubot.mjs

@@ -11,7 +11,7 @@ const switches = [
   ['-f', '--file HUBOT_FILE', 'Path to adapter file, e.g. "./adapters/CustomAdapter.mjs"'],
   ['-c', '--create HUBOT_CREATE', 'Create a deployable hubot'],
   ['-d', '--disable-httpd HUBOT_HTTPD', 'Disable the HTTP server'],
-  ['-s', '--httpdserver HUBOT_HTTPD_SERVER', 'Specify a custom HTTP server module'],
+  ['-s', '--httpdserver HUBOT_HTTPD_SERVER', 'An async factory function that receives this robot (via options) and returns or creates an HttpServerPort instance. Defaults to a factory that instantiates HttpServerPort'],
   ['-h', '--help', 'Display the help information'],
   ['-l', '--alias HUBOT_ALIAS', "Enable replacing the robot's name with alias"],
   ['-n', '--name HUBOT_NAME', 'The name of the robot in chat'],

src/ports/ExpressHttpServerPort.mjs

@@ -3,8 +3,8 @@ import express from 'express'
 import basicAuth from 'express-basic-auth'
 
 class ExpressHttpServerPort extends HttpServerPort {
-    constructor(robot) {
-        super(robot)
+    get address() {
+        return this.robot.server.address()
     }
     async start(port) {
         const user = process.env.EXPRESS_USER
@@ -16,7 +16,7 @@ class ExpressHttpServerPort extends HttpServerPort {
         const app = express()
 
         app.use((req, res, next) => {
-            res.setHeader('X-Powered-By', `hubot/${encodeURI(this.name)}`)
+            res.setHeader('X-Powered-By', `hubot/${encodeURI(this.robot.name)}`)
             return next()
         })
 
@@ -44,10 +44,25 @@ class ExpressHttpServerPort extends HttpServerPort {
             }
         })
     }
+
+    async stop() {
+        if (!this.robot || !this.robot.server) {
+            return
+        }
+        return new Promise((resolve, reject) => {
+            this.robot.server.close(err => {
+                if (err) {
+                    return reject(err)
+                }
+                resolve()
+            })
+        })
+    }
 }
 
 export default async (robot) => {
     const server = new ExpressHttpServerPort(robot)
     const port = process.env.EXPRESS_PORT || process.env.PORT || 8080
-    return await server.start(port)
+    await server.start(port)
+    return server
 }

src/ports/HttpServerPort.mjs

@@ -1,15 +1,9 @@
-function randomPort() {
-    return Math.floor(Math.random() * (65535 - 1024)) + 1024
-}
 class HttpServerPort {
     constructor(robot) {
         this.robot = robot
     }
     async stop() {}
     async start(port) {
-        if (port === 0) {
-            port = randomPort()
-        }
         this.port = port
         this.robot.server = {}
         this.robot.router = this

test/Robot_test.mjs

@@ -7,7 +7,6 @@ import http from 'node:http'
 import { Robot, CatchAllMessage, EnterMessage, LeaveMessage, TextMessage, TopicMessage, User, Response } from '../index.mjs'
 import mockAdapter from './fixtures/MockAdapter.mjs'
 import { HttpServerPort } from '../src/ports/HttpServerPort.mjs'
-import { ExpressHttpServerPort } from '../src/ports/ExpressHttpServerPort.mjs'
 
 describe('Robot', () => {
   describe('#http', () => {
@@ -1047,7 +1046,30 @@ describe('Robot', () => {
 
   describe('Non-express HTTP server', async () => {
     it('should work with a non-express http server', async () => {
-
+      class HttpServer extends HttpServerPort {
+        async start(port) {
+          return new Promise((resolve, reject) => {
+              try {
+                this.robot.server = http.createServer((req, res) => {
+                  res.writeHead(200, { 'Content-Type': 'text/plain' })
+                  res.end('Hello World\n')
+                })
+                this.robot.router = this
+                this.robot.server = this.robot.server.listen(port, '127.0.0.1', () => {
+                    this.robot.emit('listening', this.robot.server)
+                    resolve(this.robot.server)
+                })
+              } catch (err) {
+                  reject(err)
+              }
+          })
+        }
+      }
+      const httpDServerFactory = async (robot) => {
+        const server = new HttpServer(robot)
+        await server.start(process.env.PORT || 0)
+        return server
+      }
       const robot = new Robot(mockAdapter, httpDServerFactory, 'TestHubot')
       await robot.loadAdapter()
       await robot.run()

test/contracts/HttpServer_test.mjs

@@ -6,7 +6,7 @@ test('HttpServerPort API', async t => {
     await t.test('start and stop', async () => {
         const server = new HttpServerPort({})
         await server.start(0)
-        assert.ok(server.address().port > 0, 'Server should be listening on a port')
+        assert.equal(server.address().port, 0)
         await server.stop()
     })