fastify 3.27.3 → 4.0.0-alpha.2

package/test/listen.deprecated.test.js

@@ -0,0 +1,202 @@
+'use strict'
+
+// Tests for deprecated `.listen` signature. This file should be
+// removed when the deprecation is complete.
+
+const { test, before } = require('tap')
+const dns = require('dns').promises
+const Fastify = require('..')
+
+let localhost
+let localhostForURL
+
+process.removeAllListeners('warning')
+
+before(async function (t) {
+  const lookup = await dns.lookup('localhost')
+  localhost = lookup.address
+  if (lookup.family === 6) {
+    localhostForURL = `[${lookup.address}]`
+  } else {
+    localhostForURL = localhost
+  }
+})
+
+test('listen accepts a port and a callback', t => {
+  t.plan(2)
+  const fastify = Fastify()
+  t.teardown(fastify.close.bind(fastify))
+  fastify.listen(0, (err) => {
+    t.equal(fastify.server.address().address, localhost)
+    t.error(err)
+  })
+})
+
+test('listen accepts a port and a callback with (err, address)', t => {
+  t.plan(2)
+  const fastify = Fastify()
+  t.teardown(fastify.close.bind(fastify))
+  fastify.listen(0, (err, address) => {
+    t.equal(address, `http://${localhostForURL}:${fastify.server.address().port}`)
+    t.error(err)
+  })
+})
+
+test('listen accepts a port, address, and callback', t => {
+  t.plan(1)
+  const fastify = Fastify()
+  t.teardown(fastify.close.bind(fastify))
+  fastify.listen(0, localhost, (err) => {
+    t.error(err)
+  })
+})
+
+test('listen accepts options, backlog and a callback', t => {
+  t.plan(1)
+  const fastify = Fastify()
+  t.teardown(fastify.close.bind(fastify))
+  fastify.listen({
+    port: 0,
+    host: 'localhost'
+  }, 511, (err) => {
+    t.error(err)
+  })
+})
+
+test('listen accepts options (no port), backlog and a callback', t => {
+  t.plan(1)
+  const fastify = Fastify()
+  t.teardown(fastify.close.bind(fastify))
+  fastify.listen({
+    host: 'localhost'
+  }, 511, (err) => {
+    t.error(err)
+  })
+})
+
+test('listen accepts options (no host), backlog and a callback', t => {
+  t.plan(1)
+  const fastify = Fastify()
+  t.teardown(fastify.close.bind(fastify))
+  fastify.listen({
+    port: 0
+  }, 511, (err) => {
+    t.error(err)
+  })
+})
+
+test('listen accepts options (no port, no host), backlog and a callback', t => {
+  t.plan(1)
+  const fastify = Fastify()
+  t.teardown(fastify.close.bind(fastify))
+  fastify.listen({
+    ipv6Only: false
+  }, 511, (err) => {
+    t.error(err)
+  })
+})
+
+test('listen accepts a port, address and a callback with (err, address)', t => {
+  t.plan(2)
+  const fastify = Fastify()
+  t.teardown(fastify.close.bind(fastify))
+  fastify.listen(0, localhost, (err, address) => {
+    t.equal(address, `http://${localhostForURL}:${fastify.server.address().port}`)
+    t.error(err)
+  })
+})
+
+test('listen accepts a port, address, backlog and callback', t => {
+  t.plan(1)
+  const fastify = Fastify()
+  t.teardown(fastify.close.bind(fastify))
+  fastify.listen(0, localhost, 511, (err) => {
+    t.error(err)
+  })
+})
+
+test('listen accepts a port, address, backlog and callback with (err, address)', t => {
+  t.plan(2)
+  const fastify = Fastify()
+  t.teardown(fastify.close.bind(fastify))
+  fastify.listen(0, localhost, 511, (err, address) => {
+    t.equal(address, `http://${localhostForURL}:${fastify.server.address().port}`)
+    t.error(err)
+  })
+})
+
+test('listen without callback (port zero)', t => {
+  t.plan(1)
+  const fastify = Fastify()
+  t.teardown(fastify.close.bind(fastify))
+  fastify.listen(0)
+    .then(() => {
+      t.equal(fastify.server.address().address, localhost)
+    })
+})
+
+test('listen without callback (port not given)', t => {
+  t.plan(1)
+  const fastify = Fastify()
+  t.teardown(fastify.close.bind(fastify))
+  fastify.listen()
+    .then(() => {
+      t.equal(fastify.server.address().address, localhost)
+    })
+})
+
+test('listen null without callback with (address)', t => {
+  t.plan(1)
+  const fastify = Fastify()
+  t.teardown(fastify.close.bind(fastify))
+  fastify.listen(null)
+    .then(address => {
+      t.equal(address, `http://${localhostForURL}:${fastify.server.address().port}`)
+    })
+})
+
+test('listen without port without callback with (address)', t => {
+  t.plan(1)
+  const fastify = Fastify()
+  t.teardown(fastify.close.bind(fastify))
+  fastify.listen()
+    .then(address => {
+      t.equal(address, `http://${localhostForURL}:${fastify.server.address().port}`)
+    })
+})
+
+test('listen with undefined without callback with (address)', t => {
+  t.plan(1)
+  const fastify = Fastify()
+  t.teardown(fastify.close.bind(fastify))
+  fastify.listen(undefined)
+    .then(address => {
+      t.equal(address, `http://${localhostForURL}:${fastify.server.address().port}`)
+    })
+})
+
+test('listen when firstArg is string(pipe) and without backlog', async t => {
+  t.plan(1)
+  const fastify = Fastify()
+  t.teardown(fastify.close.bind(fastify))
+  const address = await fastify.listen('\\\\.\\pipe\\testPipe')
+  t.equal(address, '\\\\.\\pipe\\testPipe')
+})
+
+test('listen when firstArg is string(pipe) and with backlog', async t => {
+  t.plan(1)
+  const fastify = Fastify()
+  t.teardown(fastify.close.bind(fastify))
+  const address = await fastify.listen('\\\\.\\pipe\\testPipe2', 511)
+  t.equal(address, '\\\\.\\pipe\\testPipe2')
+})
+
+test('listen when firstArg is { path: string(pipe) } and with backlog and callback', t => {
+  t.plan(2)
+  const fastify = Fastify()
+  t.teardown(fastify.close.bind(fastify))
+  fastify.listen({ path: '\\\\.\\pipe\\testPipe3' }, 511, (err, address) => {
+    t.error(err)
+    t.equal(address, '\\\\.\\pipe\\testPipe3')
+  })
+})

package/test/listen.test.js

@@ -4,8 +4,10 @@ const os = require('os')
 const path = require('path')
 const fs = require('fs')
 const { test, before } = require('tap')
-const Fastify = require('..')
 const dns = require('dns').promises
+const dnsCb = require('dns')
+const sget = require('simple-get').concat
+const Fastify = require('..')
 
 let localhost
 let localhostForURL
@@ -20,46 +22,38 @@ before(async function () {
   }
 })
 
-test('listen accepts a callback', t => {
-  t.plan(2)
-  const fastify = Fastify()
-  t.teardown(fastify.close.bind(fastify))
-  fastify.listen((err) => {
-    t.equal(fastify.server.address().address, localhost)
-    t.error(err)
+test('listen works without arguments', async t => {
+  process.on('warning', () => {
+    t.fail('should not be deprecated')
   })
-})
 
-test('listen accepts a port and a callback', t => {
-  t.plan(2)
   const fastify = Fastify()
   t.teardown(fastify.close.bind(fastify))
-  fastify.listen(0, (err) => {
-    t.equal(fastify.server.address().address, localhost)
-    t.error(err)
-  })
+  await fastify.listen()
+  const address = fastify.server.address()
+  t.equal(address.address, localhost)
+  t.ok(address.port > 0)
 })
 
-test('listen accepts a port and a callback with (err, address)', t => {
-  t.plan(2)
-  const fastify = Fastify()
-  t.teardown(fastify.close.bind(fastify))
-  fastify.listen(0, (err, address) => {
-    t.equal(address, `http://${localhostForURL}:${fastify.server.address().port}`)
-    t.error(err)
+test('listen accepts a callback', t => {
+  process.on('warning', () => {
+    t.fail('should not be deprecated')
   })
-})
 
-test('listen accepts a port, address, and callback', t => {
-  t.plan(1)
+  t.plan(2)
   const fastify = Fastify()
   t.teardown(fastify.close.bind(fastify))
-  fastify.listen(0, localhost, (err) => {
+  fastify.listen({ port: 0 }, (err) => {
+    t.equal(fastify.server.address().address, localhost)
     t.error(err)
   })
 })
 
 test('listen accepts options and a callback', t => {
+  process.on('warning', () => {
+    t.fail('should not be deprecated')
+  })
+
   t.plan(1)
   const fastify = Fastify()
   t.teardown(fastify.close.bind(fastify))
@@ -76,54 +70,13 @@ test('listen accepts options and a callback', t => {
   })
 })
 
-test('listen accepts options, backlog and a callback', t => {
-  t.plan(1)
-  const fastify = Fastify()
-  t.teardown(fastify.close.bind(fastify))
-  fastify.listen({
-    port: 0,
-    host: 'localhost'
-  }, 511, (err) => {
-    t.error(err)
-  })
-})
-
-test('listen accepts a port, address and a callback with (err, address)', t => {
-  t.plan(2)
-  const fastify = Fastify()
-  t.teardown(fastify.close.bind(fastify))
-  fastify.listen(0, localhost, (err, address) => {
-    t.equal(address, `http://${localhostForURL}:${fastify.server.address().port}`)
-    t.error(err)
-  })
-})
-
-test('listen accepts a port, address, backlog and callback', t => {
-  t.plan(1)
-  const fastify = Fastify()
-  t.teardown(fastify.close.bind(fastify))
-  fastify.listen(0, localhost, 511, (err) => {
-    t.error(err)
-  })
-})
-
-test('listen accepts a port, address, backlog and callback with (err, address)', t => {
-  t.plan(2)
-  const fastify = Fastify()
-  t.teardown(fastify.close.bind(fastify))
-  fastify.listen(0, localhost, 511, (err, address) => {
-    t.equal(address, `http://${localhostForURL}:${fastify.server.address().port}`)
-    t.error(err)
-  })
-})
-
 test('listen after Promise.resolve()', t => {
   t.plan(2)
   const f = Fastify()
   t.teardown(f.close.bind(f))
   Promise.resolve()
     .then(() => {
-      f.listen(0, (err, address) => {
+      f.listen({ port: 0 }, (err, address) => {
         f.server.unref()
         t.equal(address, `http://${localhostForURL}:${f.server.address().port}`)
         t.error(err)
@@ -153,9 +106,9 @@ test('double listen errors', t => {
   t.plan(3)
   const fastify = Fastify()
   t.teardown(fastify.close.bind(fastify))
-  fastify.listen(0, (err) => {
+  fastify.listen({ port: 0 }, (err) => {
     t.error(err)
-    fastify.listen(fastify.server.address().port, (err, address) => {
+    fastify.listen({ port: fastify.server.address().port }, (err, address) => {
       t.equal(address, null)
       t.ok(err)
     })
@@ -166,10 +119,10 @@ test('double listen errors callback with (err, address)', t => {
   t.plan(4)
   const fastify = Fastify()
   t.teardown(fastify.close.bind(fastify))
-  fastify.listen(0, (err1, address1) => {
+  fastify.listen({ port: 0 }, (err1, address1) => {
     t.equal(address1, `http://${localhostForURL}:${fastify.server.address().port}`)
     t.error(err1)
-    fastify.listen(fastify.server.address().port, (err2, address2) => {
+    fastify.listen({ port: fastify.server.address().port }, (err2, address2) => {
       t.equal(address2, null)
       t.ok(err2)
     })
@@ -180,12 +133,12 @@ test('listen twice on the same port', t => {
   t.plan(4)
   const fastify = Fastify()
   t.teardown(fastify.close.bind(fastify))
-  fastify.listen(0, (err1, address1) => {
+  fastify.listen({ port: 0 }, (err1, address1) => {
     t.equal(address1, `http://${localhostForURL}:${fastify.server.address().port}`)
     t.error(err1)
     const s2 = Fastify()
     t.teardown(s2.close.bind(s2))
-    s2.listen(fastify.server.address().port, (err2, address2) => {
+    s2.listen({ port: fastify.server.address().port }, (err2, address2) => {
       t.equal(address2, null)
       t.ok(err2)
     })
@@ -196,13 +149,13 @@ test('listen twice on the same port callback with (err, address)', t => {
   t.plan(4)
   const fastify = Fastify()
   t.teardown(fastify.close.bind(fastify))
-  fastify.listen(0, (err1, address1) => {
+  fastify.listen({ port: 0 }, (err1, address1) => {
     const _port = fastify.server.address().port
     t.equal(address1, `http://${localhostForURL}:${_port}`)
     t.error(err1)
     const s2 = Fastify()
     t.teardown(s2.close.bind(s2))
-    s2.listen(_port, (err2, address2) => {
+    s2.listen({ port: _port }, (err2, address2) => {
       t.equal(address2, null)
       t.ok(err2)
     })
@@ -221,7 +174,7 @@ if (os.platform() !== 'win32') {
       fs.unlinkSync(sockFile)
     } catch (e) { }
 
-    fastify.listen(sockFile, (err, address) => {
+    fastify.listen({ path: sockFile }, (err, address) => {
       t.error(err)
       t.equal(sockFile, fastify.server.address())
       t.equal(address, sockFile)
@@ -229,61 +182,11 @@ if (os.platform() !== 'win32') {
   })
 }
 
-test('listen without callback (port zero)', t => {
-  t.plan(1)
-  const fastify = Fastify()
-  t.teardown(fastify.close.bind(fastify))
-  fastify.listen(0)
-    .then(() => {
-      t.equal(fastify.server.address().address, localhost)
-    })
-})
-
-test('listen without callback (port not given)', t => {
-  t.plan(1)
-  const fastify = Fastify()
-  t.teardown(fastify.close.bind(fastify))
-  fastify.listen()
-    .then(() => {
-      t.equal(fastify.server.address().address, localhost)
-    })
-})
-
-test('listen null without callback with (address)', t => {
-  t.plan(1)
-  const fastify = Fastify()
-  t.teardown(fastify.close.bind(fastify))
-  fastify.listen(null)
-    .then(address => {
-      t.equal(address, `http://${localhostForURL}:${fastify.server.address().port}`)
-    })
-})
-
-test('listen without port without callback with (address)', t => {
-  t.plan(1)
-  const fastify = Fastify()
-  t.teardown(fastify.close.bind(fastify))
-  fastify.listen()
-    .then(address => {
-      t.equal(address, `http://${localhostForURL}:${fastify.server.address().port}`)
-    })
-})
-
-test('listen with undefined without callback with (address)', t => {
-  t.plan(1)
-  const fastify = Fastify()
-  t.teardown(fastify.close.bind(fastify))
-  fastify.listen(undefined)
-    .then(address => {
-      t.equal(address, `http://${localhostForURL}:${fastify.server.address().port}`)
-    })
-})
-
 test('listen without callback with (address)', t => {
   t.plan(1)
   const fastify = Fastify()
   t.teardown(fastify.close.bind(fastify))
-  fastify.listen(0)
+  fastify.listen({ port: 0 })
     .then(address => {
       t.equal(address, `http://${localhostForURL}:${fastify.server.address().port}`)
     })
@@ -293,9 +196,9 @@ test('double listen without callback rejects', t => {
   t.plan(1)
   const fastify = Fastify()
   t.teardown(fastify.close.bind(fastify))
-  fastify.listen(0)
+  fastify.listen({ port: 0 })
     .then(() => {
-      fastify.listen(0)
+      fastify.listen({ port: 0 })
         .catch(err => {
           t.ok(err)
         })
@@ -307,10 +210,10 @@ test('double listen without callback with (address)', t => {
   t.plan(2)
   const fastify = Fastify()
   t.teardown(fastify.close.bind(fastify))
-  fastify.listen(0)
+  fastify.listen({ port: 0 })
     .then(address => {
       t.equal(address, `http://${localhostForURL}:${fastify.server.address().port}`)
-      fastify.listen(0)
+      fastify.listen({ port: 0 })
         .catch(err => {
           t.ok(err)
         })
@@ -323,11 +226,11 @@ test('listen twice on the same port without callback rejects', t => {
   const fastify = Fastify()
   t.teardown(fastify.close.bind(fastify))
 
-  fastify.listen(0)
+  fastify.listen({ port: 0 })
     .then(() => {
       const s2 = Fastify()
       t.teardown(s2.close.bind(s2))
-      s2.listen(fastify.server.address().port)
+      s2.listen({ port: fastify.server.address().port })
         .catch(err => {
           t.ok(err)
         })
@@ -339,12 +242,12 @@ test('listen twice on the same port without callback rejects with (address)', t
   t.plan(2)
   const fastify = Fastify()
   t.teardown(fastify.close.bind(fastify))
-  fastify.listen(0)
+  fastify.listen({ port: 0 })
     .then(address => {
       const s2 = Fastify()
       t.teardown(s2.close.bind(s2))
       t.equal(address, `http://${localhostForURL}:${fastify.server.address().port}`)
-      s2.listen(fastify.server.address().port)
+      s2.listen({ port: fastify.server.address().port })
         .catch(err => {
           t.ok(err)
         })
@@ -355,7 +258,7 @@ test('listen twice on the same port without callback rejects with (address)', t
 test('listen on invalid port without callback rejects', t => {
   const fastify = Fastify()
   t.teardown(fastify.close.bind(fastify))
-  return fastify.listen(-1)
+  return fastify.listen({ port: -1 })
     .catch(err => {
       t.ok(err)
       return true
@@ -372,24 +275,89 @@ test('listen logs the port as info', t => {
     msgs.push(msg)
   }
 
-  fastify.listen(0)
+  fastify.listen({ port: 0 })
     .then(() => {
       t.ok(/http:\/\//.test(msgs[0]))
     })
 })
 
-test('listen when firstArg is string(pipe) and without backlog', async t => {
-  t.plan(1)
-  const fastify = Fastify()
-  t.teardown(fastify.close.bind(fastify))
-  const address = await fastify.listen('\\\\.\\pipe\\testPipe')
-  t.equal(address, '\\\\.\\pipe\\testPipe')
+test('listen on localhost binds IPv4 and IPv6 - promise interface', async t => {
+  const lookups = await dns.lookup('localhost', { all: true })
+  t.plan(2 * lookups.length)
+
+  const app = Fastify()
+  app.get('/', async () => 'hello localhost')
+  t.teardown(app.close.bind(app))
+  await app.listen({ port: 0, host: 'localhost' })
+
+  for (const lookup of lookups) {
+    await new Promise((resolve, reject) => {
+      sget({
+        method: 'GET',
+        url: getUrl(app, lookup)
+      }, (err, response, body) => {
+        if (err) { return reject(err) }
+        t.equal(response.statusCode, 200)
+        t.same(body.toString(), 'hello localhost')
+        resolve()
+      })
+    })
+  }
 })
 
-test('listen when firstArg is string(pipe) and with backlog', async t => {
-  t.plan(1)
-  const fastify = Fastify()
-  t.teardown(fastify.close.bind(fastify))
-  const address = await fastify.listen('\\\\.\\pipe\\testPipe', 511)
-  t.equal(address, '\\\\.\\pipe\\testPipe')
+test('listen on localhost binds to all interfaces (both IPv4 and IPv6 if present) - callback interface', t => {
+  dnsCb.lookup('localhost', { all: true }, (err, lookups) => {
+    t.plan(2 + (3 * lookups.length))
+    t.error(err)
+
+    const app = Fastify()
+    app.get('/', async () => 'hello localhost')
+    app.listen({ port: 0, host: 'localhost' }, (err) => {
+      t.error(err)
+      t.teardown(app.close.bind(app))
+
+      for (const lookup of lookups) {
+        sget({
+          method: 'GET',
+          url: getUrl(app, lookup)
+        }, (err, response, body) => {
+          t.error(err)
+          t.equal(response.statusCode, 200)
+          t.same(body.toString(), 'hello localhost')
+        })
+      }
+    })
+  })
+})
+
+test('addresses getter', async t => {
+  t.plan(4)
+  const app = Fastify()
+  app.get('/', async () => 'hello localhost')
+
+  t.same(app.addresses(), [], 'before ready')
+  await app.ready()
+
+  t.same(app.addresses(), [], 'after ready')
+  await app.listen({ port: 0, host: 'localhost' })
+  const { port } = app.server.address()
+  const localAddresses = await dns.lookup('localhost', { all: true })
+  for (const address of localAddresses) {
+    address.port = port
+    address.family = 'IPv' + address.family
+  }
+  localAddresses.sort((a, b) => a.address.localeCompare(b.address))
+  t.same(app.addresses().sort((a, b) => a.address.localeCompare(b.address)), localAddresses, 'after listen')
+
+  await app.close()
+  t.same(app.addresses(), [], 'after close')
 })
+
+function getUrl (fastify, lookup) {
+  const { port } = fastify.server.address()
+  if (lookup.family === 6) {
+    return `http://[${lookup.address}]:${port}/`
+  } else {
+    return `http://${lookup.address}:${port}/`
+  }
+}