fix: update hapi (#173)

BREAKING CHANGE: signaling server api with async await instead of callbacks

Author: vasco-santos

.aegir.js

@@ -4,26 +4,26 @@ const sigServer = require('./src/sig-server')
 let firstRun = true
 let sigS
 
-function boot (done) {
+async function boot (done) {
   const options = {
     port: 15555,
     host: '127.0.0.1',
-    metrics: firstRun
+    metrics: false // firsrun TODO: needs https://github.com/libp2p/js-libp2p-webrtc-star/issues/174
   }
 
   if (firstRun) { firstRun = false }
 
-  sigServer.start(options, (err, server) => {
-    if (err) { throw err }
+  sigS = await sigServer.start(options)
 
-    sigS = server
-    console.log('signalling on:', server.info.uri)
-    done()
-  })
+  console.log('signalling on:', sigS.info.uri)
+
+  done()
 }
 
-function stop (done) {
-  sigS.stop(done)
+async function stop (done) {
+  await sigS.stop()
+
+  done()
 }
 
 module.exports = {

package.json

@@ -54,12 +54,12 @@
     "wrtc": "~0.3.7"
   },
   "dependencies": {
+    "@hapi/hapi": "^18.3.1",
+    "@hapi/inert": "^5.2.0",
     "async": "^2.6.2",
     "class-is": "^1.1.0",
     "debug": "^4.1.1",
     "epimetheus": "^1.0.92",
-    "hapi": "^16.6.2",
-    "inert": "^4.2.1",
     "interface-connection": "~0.3.3",
     "mafmt": "^6.0.7",
     "minimist": "^1.2.0",

src/sig-server/bin.js

@@ -5,24 +5,19 @@
 const signalling = require('./index')
 const argv = require('minimist')(process.argv.slice(2))
 
-let server
-
-signalling.start({
-  port: argv.port || argv.p || process.env.PORT || 9090,
-  host: argv.host || argv.h || process.env.HOST || '0.0.0.0',
-  metrics: !(argv.disableMetrics || process.env.DISABLE_METRICS)
-}, (err, _server) => {
-  if (err) {
-    throw err
-  }
-  server = _server
+;(async () => {
+  const server = await signalling.start({
+    port: argv.port || argv.p || process.env.PORT || 9090,
+    host: argv.host || argv.h || process.env.HOST || '0.0.0.0',
+    // Needs: https://github.com/libp2p/js-libp2p-webrtc-star/issues/174'
+    metrics: false // !(argv.disableMetrics || process.env.DISABLE_METRICS)
+  })
 
   console.log('Listening on:', server.info.uri)
-})
 
-process.on('SIGINT', () => {
-  server.stop(() => {
+  process.on('SIGINT', async () => {
+    await server.stop()
     console.log('Signalling server stopped')
     process.exit()
   })
-})
+})()

src/sig-server/config.js

@@ -10,10 +10,8 @@ module.exports = {
     port: process.env.PORT || 13579,
     host: '0.0.0.0',
     options: {
-      connections: {
-        routes: {
-          cors: true
-        }
+      routes: {
+        cors: true
       }
     }
   },

src/sig-server/index.js

@@ -1,56 +1,48 @@
+/* eslint no-unreachable: "warn" */
+
 'use strict'
 
-const Hapi = require('hapi')
+const Hapi = require('@hapi/hapi')
+const Inert = require('@hapi/inert')
+
 const config = require('./config')
 const log = config.log
 const epimetheus = require('epimetheus')
 const path = require('path')
 
 exports = module.exports
 
-exports.start = (options, callback) => {
-  if (typeof options === 'function') {
-    callback = options
-    options = {}
-  }
-
+exports.start = async (options = {}) => {
   const port = options.port || config.hapi.port
   const host = options.host || config.hapi.host
 
-  const http = new Hapi.Server(config.hapi.options)
-
-  http.connection({
-    port: port,
-    host: host
+  const http = new Hapi.Server({
+    ...config.hapi.options,
+    port,
+    host
   })
 
-  http.register({ register: require('inert') }, (err) => {
-    if (err) {
-      return callback(err)
-    }
+  await http.register(Inert)
+  await http.start()
 
-    http.start((err) => {
-      if (err) {
-        return callback(err)
-      }
+  log('signaling server has started on: ' + http.info.uri)
 
-      log('signaling server has started on: ' + http.info.uri)
+  http.peers = require('./routes-ws')(http, options.metrics).peers
 
-      http.peers = require('./routes-ws')(http, options.metrics).peers
-
-      http.route({
-        method: 'GET',
-        path: '/',
-        handler: (request, reply) => reply.file(path.join(__dirname, 'index.html'), {
-          confine: false
-        })
-      })
-
-      callback(null, http)
+  http.route({
+    method: 'GET',
+    path: '/',
+    handler: (request, reply) => reply.file(path.join(__dirname, 'index.html'), {
+      confine: false
     })
-
-    if (options.metrics) { epimetheus.instrument(http) }
   })
 
+  if (options.metrics) {
+    // TODO: reenable epimetheus when support
+    log('wait for epimetheus support')
+    throw new Error('epimetheus is currently not supported by hapi. Needs: https://github.com/libp2p/js-libp2p-webrtc-star/issues/174')
+    epimetheus.instrument(http)
+  }
+
   return http
 }

test/sig-server.js

@@ -33,62 +33,59 @@ describe('signalling', () => {
   let c3mh = multiaddr(base('QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSoooo3'))
   let c4mh = multiaddr(base('QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSoooo4'))
 
-  it('start and stop signalling server (default port)', (done) => {
-    sigServer.start((err, server) => {
-      expect(err).to.not.exist()
-      expect(server.info.port).to.equal(13579)
-      expect(server.info.protocol).to.equal('http')
-      expect(server.info.address).to.equal('0.0.0.0')
-      server.stop(done)
-    })
+  it('start and stop signalling server (default port)', async () => {
+    const server = await sigServer.start()
+
+    expect(server.info.port).to.equal(13579)
+    expect(server.info.protocol).to.equal('http')
+    expect(server.info.address).to.equal('0.0.0.0')
+
+    await server.stop()
   })
 
-  it('start and stop signalling server (default port) and spam it with invalid requests', (done) => {
-    sigServer.start((err, server) => {
-      expect(err).to.not.exist()
-      expect(server.info.port).to.equal(13579)
-      expect(server.info.protocol).to.equal('http')
-      expect(server.info.address).to.equal('0.0.0.0')
-      const cl = io.connect(server.info.uri)
-      cl.on('connect', () => {
-        cl.emit('ss-handshake', null)
-        cl.emit('ss-handshake', 1)
-        cl.emit('ss-handshake', [1, 2, 3])
-        cl.emit('ss-handshake', {})
-        setTimeout(() => {
-          server.stop(done)
-        }, 1000)
-      })
+  it('start and stop signalling server (default port) and spam it with invalid requests', async () => {
+    const server = await sigServer.start()
+
+    expect(server.info.port).to.equal(13579)
+    expect(server.info.protocol).to.equal('http')
+    expect(server.info.address).to.equal('0.0.0.0')
+
+    const cl = io.connect(server.info.uri)
+    cl.on('connect', async () => {
+      cl.emit('ss-handshake', null)
+      cl.emit('ss-handshake', 1)
+      cl.emit('ss-handshake', [1, 2, 3])
+      cl.emit('ss-handshake', {})
+
+      await server.stop()
     })
   })
 
-  it('start and stop signalling server (custom port)', (done) => {
+  it('start and stop signalling server (custom port)', async () => {
     const options = {
       port: 12345
     }
-    sigServer.start(options, (err, server) => {
-      expect(err).to.not.exist()
-      expect(server.info.port).to.equal(12345)
-      expect(server.info.protocol).to.equal('http')
-      expect(server.info.address).to.equal('0.0.0.0')
-      server.stop(done)
-    })
+
+    const server = await sigServer.start(options)
+
+    expect(server.info.port).to.equal(12345)
+    expect(server.info.protocol).to.equal('http')
+    expect(server.info.address).to.equal('0.0.0.0')
+    await server.stop()
   })
 
-  it('start signalling server for client tests', (done) => {
+  it('start signalling server for client tests', async () => {
     const options = {
       port: 12345
     }
 
-    sigServer.start(options, (err, server) => {
-      expect(err).to.not.exist()
-      expect(server.info.port).to.equal(12345)
-      expect(server.info.protocol).to.equal('http')
-      expect(server.info.address).to.equal('0.0.0.0')
-      sioUrl = server.info.uri
-      sigS = server
-      done()
-    })
+    const server = await sigServer.start(options)
+
+    expect(server.info.port).to.equal(12345)
+    expect(server.info.protocol).to.equal('http')
+    expect(server.info.address).to.equal('0.0.0.0')
+    sioUrl = server.info.uri
+    sigS = server
   })
 
   it('zero peers', () => {
@@ -213,7 +210,7 @@ describe('signalling', () => {
     }
   })
 
-  it('stop signalling server', (done) => {
+  it('stop signalling server', () => {
     parallel([
       (cb) => {
         c1.disconnect()
@@ -223,8 +220,8 @@ describe('signalling', () => {
         c2.disconnect()
         cb()
       }
-    ], () => {
-      sigS.stop(done)
+    ], async () => {
+      await sigS.stop()
     })
   })
 })

test/transport/reconnect.node.js

@@ -27,11 +27,13 @@ module.exports = (create) => {
     const ma2 = multiaddr(base('QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSooo3B'))
     const ma3 = multiaddr(base('QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSooo3C'))
 
-    before((done) => {
-      sigS = sigServer.start({ port: SERVER_PORT }, done)
+    before(async () => {
+      sigS = await sigServer.start({ port: SERVER_PORT })
     })
 
-    after((done) => sigS.stop(done))
+    after(async () => {
+      await sigS.stop()
+    })
 
     it('listen on the first', (done) => {
       ws1 = create()
@@ -57,12 +59,12 @@ module.exports = (create) => {
       })
     })
 
-    it('stops the server', (done) => {
-      sigS.stop(done)
+    it('stops the server', async () => {
+      await sigS.stop()
     })
 
-    it('starts the server again', (done) => {
-      sigS = sigServer.start({ port: SERVER_PORT }, done)
+    it('starts the server again', async () => {
+      sigS = await sigServer.start({ port: SERVER_PORT })
     })
 
     it('wait a bit for clients to reconnect', (done) => {