fastify 3.26.0 → 4.0.0-alpha.1

package/test/logger.test.js

@@ -1,6 +1,7 @@
 'use strict'
 
-const { test, teardown } = require('tap')
+const { test, teardown, before } = require('tap')
+const helper = require('./helper')
 const http = require('http')
 const stream = require('stream')
 const split = require('split2')
@@ -10,9 +11,12 @@ const path = require('path')
 const os = require('os')
 const fs = require('fs')
 const sget = require('simple-get').concat
+const dns = require('dns')
 
 const files = []
 let count = 0
+let localhost
+let localhostForURL
 
 function file () {
   const file = path.join(os.tmpdir(), `sonic-boom-${process.pid}-${process.hrtime().toString()}-${count++}`)
@@ -20,6 +24,10 @@ function file () {
   return file
 }
 
+before(async function () {
+  [localhost, localhostForURL] = await helper.getLoopbackHost()
+})
+
 teardown(() => {
   files.forEach((file) => {
     try {
@@ -31,13 +39,12 @@ teardown(() => {
 })
 
 test('defaults to info level', t => {
-  t.plan(13)
   let fastify = null
   const stream = split(JSON.parse)
   try {
     fastify = Fastify({
       logger: {
-        stream: stream
+        stream
       }
     })
   } catch (e) {
@@ -49,9 +56,28 @@ test('defaults to info level', t => {
     reply.send({ hello: 'world' })
   })
 
-  stream.once('data', listenAtLogLine => {
-    t.ok(listenAtLogLine, 'listen at log message is ok')
+  fastify.listen(0, err => {
+    t.error(err)
+    fastify.server.unref()
+
+    dns.lookup('localhost', { all: true }, function (err, addresses) {
+      t.error(err)
+      let toSkip = addresses.length
+
+      function skip (data) {
+        if (--toSkip === 0) {
+          stream.removeListener('data', skip)
+          check()
+        }
+      }
+
+      stream.on('data', skip)
 
+      http.get(`http://${localhostForURL}:` + fastify.server.address().port)
+    })
+  })
+
+  function check () {
     stream.once('data', line => {
       const id = line.reqId
       t.ok(line.reqId, 'reqId is defined')
@@ -66,16 +92,10 @@ test('defaults to info level', t => {
         t.equal(line.msg, 'request completed', 'message is set')
         t.equal(line.res.statusCode, 200, 'statusCode is 200')
         t.ok(line.responseTime, 'responseTime is defined')
+        t.end()
       })
     })
-  })
-
-  fastify.listen(0, err => {
-    t.error(err)
-    fastify.server.unref()
-
-    http.get('http://localhost:' + fastify.server.address().port)
-  })
+  }
 })
 
 test('test log stream', t => {
@@ -85,7 +105,7 @@ test('test log stream', t => {
   try {
     fastify = Fastify({
       logger: {
-        stream: stream,
+        stream,
         level: 'info'
       }
     })
@@ -98,11 +118,11 @@ test('test log stream', t => {
     reply.send({ hello: 'world' })
   })
 
-  fastify.listen(0, err => {
+  fastify.listen(0, localhost, err => {
     t.error(err)
     fastify.server.unref()
 
-    http.get('http://localhost:' + fastify.server.address().port)
+    http.get(`http://${localhostForURL}:` + fastify.server.address().port)
     stream.once('data', listenAtLogLine => {
       t.ok(listenAtLogLine, 'listen at log message is ok')
 
@@ -132,7 +152,7 @@ test('test error log stream', t => {
   try {
     fastify = Fastify({
       logger: {
-        stream: stream,
+        stream,
         level: 'info'
       }
     })
@@ -145,11 +165,11 @@ test('test error log stream', t => {
     reply.send(new Error('kaboom'))
   })
 
-  fastify.listen(0, err => {
+  fastify.listen(0, localhost, err => {
     t.error(err)
     fastify.server.unref()
 
-    http.get('http://localhost:' + fastify.server.address().port + '/error')
+    http.get(`http://${localhostForURL}:` + fastify.server.address().port + '/error')
     stream.once('data', listenAtLogLine => {
       t.ok(listenAtLogLine, 'listen at log message is ok')
 
@@ -182,7 +202,7 @@ test('can use external logger instance', t => {
 
   const logger = require('pino')(splitStream)
 
-  const localFastify = Fastify({ logger: logger })
+  const localFastify = Fastify({ logger })
 
   localFastify.get('/foo', function (req, reply) {
     t.ok(req.log)
@@ -190,9 +210,9 @@ test('can use external logger instance', t => {
     reply.send({ hello: 'world' })
   })
 
-  localFastify.listen(0, err => {
+  localFastify.listen(0, localhost, err => {
     t.error(err)
-    http.get('http://localhost:' + localFastify.server.address().port + '/foo', (res) => {
+    http.get(`http://${localhostForURL}:` + localFastify.server.address().port + '/foo', (res) => {
       res.resume()
       res.on('end', () => {
         localFastify.server.close()
@@ -226,7 +246,7 @@ test('can use external logger instance with custom serializer', t => {
   }, splitStream)
 
   const localFastify = Fastify({
-    logger: logger
+    logger
   })
 
   localFastify.get('/foo', function (req, reply) {
@@ -235,9 +255,9 @@ test('can use external logger instance with custom serializer', t => {
     reply.send({ hello: 'world' })
   })
 
-  localFastify.listen(0, err => {
+  localFastify.listen(0, localhost, err => {
     t.error(err)
-    http.get('http://localhost:' + localFastify.server.address().port + '/foo', (res) => {
+    http.get(`http://${localhostForURL}:` + localFastify.server.address().port + '/foo', (res) => {
       res.resume()
       res.on('end', () => {
         localFastify.server.close()
@@ -253,7 +273,7 @@ test('expose the logger', t => {
   try {
     fastify = Fastify({
       logger: {
-        stream: stream,
+        stream,
         level: 'info'
       }
     })
@@ -271,7 +291,7 @@ test('The request id header key can be customized', t => {
 
   const stream = split(JSON.parse)
   const fastify = Fastify({
-    logger: { stream: stream, level: 'info' },
+    logger: { stream, level: 'info' },
     requestIdHeader: 'my-custom-request-id'
   })
   t.teardown(() => fastify.close())
@@ -316,7 +336,7 @@ test('The request id header key can be customized along with a custom id generat
 
   const stream = split(JSON.parse)
   const fastify = Fastify({
-    logger: { stream: stream, level: 'info' },
+    logger: { stream, level: 'info' },
     requestIdHeader: 'my-custom-request-id',
     genReqId (req) {
       return 'foo'
@@ -379,7 +399,7 @@ test('The request id log label can be changed', t => {
 
   const stream = split(JSON.parse)
   const fastify = Fastify({
-    logger: { stream: stream, level: 'info' },
+    logger: { stream, level: 'info' },
     requestIdHeader: 'my-custom-request-id',
     requestIdLogLabel: 'traceId'
   })
@@ -422,7 +442,7 @@ test('The logger should accept custom serializer', t => {
   const stream = split(JSON.parse)
   const fastify = Fastify({
     logger: {
-      stream: stream,
+      stream,
       level: 'info',
       serializers: {
         req: function (req) {
@@ -439,11 +459,11 @@ test('The logger should accept custom serializer', t => {
     reply.send(new Error('kaboom'))
   })
 
-  fastify.listen(0, err => {
+  fastify.listen(0, localhost, err => {
     t.error(err)
     fastify.server.unref()
 
-    http.get('http://localhost:' + fastify.server.address().port + '/custom')
+    http.get(`http://${localhostForURL}:` + fastify.server.address().port + '/custom')
     stream.once('data', listenAtLogLine => {
       t.ok(listenAtLogLine, 'listen at log message is ok')
 
@@ -1151,7 +1171,7 @@ test('should serialize request and response', t => {
       const stream = split(JSON.parse)
       const fastify = Fastify({
         logger: {
-          stream: stream,
+          stream,
           level: 'info'
         }
       })
@@ -1173,7 +1193,7 @@ test('Do not wrap IPv4 address', t => {
   const stream = split(JSON.parse)
   const fastify = Fastify({
     logger: {
-      stream: stream,
+      stream,
       level: 'info'
     }
   })
@@ -1204,11 +1224,11 @@ test('file option', t => {
     reply.send({ hello: 'world' })
   })
 
-  fastify.listen(0, err => {
+  fastify.listen(0, localhost, err => {
     t.error(err)
     fastify.server.unref()
 
-    http.get('http://localhost:' + fastify.server.address().port, () => {
+    http.get(`http://${localhostForURL}:` + fastify.server.address().port, () => {
       const stream = fs.createReadStream(dest).pipe(split(JSON.parse))
 
       stream.once('data', listenAtLogLine => {
@@ -1241,7 +1261,7 @@ test('should log the error if no error handler is defined', t => {
   const stream = split(JSON.parse)
   const fastify = Fastify({
     logger: {
-      stream: stream,
+      stream,
       level: 'info'
     }
   })
@@ -1249,10 +1269,10 @@ test('should log the error if no error handler is defined', t => {
     t.ok(req.log)
     reply.send(new Error('a generic error'))
   })
-  fastify.listen(0, err => {
+  fastify.listen(0, localhost, err => {
     t.error(err)
     fastify.server.unref()
-    http.get('http://localhost:' + fastify.server.address().port + '/error')
+    http.get(`http://${localhostForURL}:` + fastify.server.address().port + '/error')
     stream.once('data', listenAtLogLine => {
       t.ok(listenAtLogLine, 'listen at log message is ok')
       stream.once('data', line => {
@@ -1275,7 +1295,7 @@ test('should log as info if error status code >= 400 and < 500 if no error handl
   const stream = split(JSON.parse)
   const fastify = Fastify({
     logger: {
-      stream: stream,
+      stream,
       level: 'info'
     }
   })
@@ -1287,10 +1307,10 @@ test('should log as info if error status code >= 400 and < 500 if no error handl
     t.ok(req.log)
     reply.send(Object.assign(new Error('a 503 error'), { statusCode: 503 }))
   })
-  fastify.listen(0, err => {
+  fastify.listen(0, localhost, err => {
     t.error(err)
     fastify.server.unref()
-    http.get('http://localhost:' + fastify.server.address().port + '/400')
+    http.get(`http://${localhostForURL}:` + fastify.server.address().port + '/400')
     stream.once('data', listenAtLogLine => {
       t.ok(listenAtLogLine, 'listen at log message is ok')
       stream.once('data', line => {
@@ -1313,7 +1333,7 @@ test('should log as error if error status code >= 500 if no error handler is def
   const stream = split(JSON.parse)
   const fastify = Fastify({
     logger: {
-      stream: stream,
+      stream,
       level: 'info'
     }
   })
@@ -1321,10 +1341,10 @@ test('should log as error if error status code >= 500 if no error handler is def
     t.ok(req.log)
     reply.send(Object.assign(new Error('a 503 error'), { statusCode: 503 }))
   })
-  fastify.listen(0, err => {
+  fastify.listen(0, localhost, err => {
     t.error(err)
     fastify.server.unref()
-    http.get('http://localhost:' + fastify.server.address().port + '/503')
+    http.get(`http://${localhostForURL}:` + fastify.server.address().port + '/503')
     stream.once('data', listenAtLogLine => {
       t.ok(listenAtLogLine, 'listen at log message is ok')
       stream.once('data', line => {
@@ -1342,12 +1362,12 @@ test('should log as error if error status code >= 500 if no error handler is def
   })
 })
 
-test('should not log the error if error handler is defined', t => {
-  t.plan(7)
+test('should not log the error if error handler is defined and it does not error', t => {
+  t.plan(8)
   const stream = split(JSON.parse)
   const fastify = Fastify({
     logger: {
-      stream: stream,
+      stream,
       level: 'info'
     }
   })
@@ -1356,12 +1376,13 @@ test('should not log the error if error handler is defined', t => {
     reply.send(new Error('something happened'))
   })
   fastify.setErrorHandler((err, req, reply) => {
-    reply.send(err)
+    t.ok(err)
+    reply.send('something bad happened')
   })
-  fastify.listen(0, err => {
+  fastify.listen(0, localhost, err => {
     t.error(err)
     fastify.server.unref()
-    http.get('http://localhost:' + fastify.server.address().port + '/error')
+    http.get(`http://${localhostForURL}:` + fastify.server.address().port + '/error')
     stream.once('data', listenAtLogLine => {
       t.ok(listenAtLogLine, 'listen at log message is ok')
       stream.once('data', line => {
@@ -1369,7 +1390,7 @@ test('should not log the error if error handler is defined', t => {
         stream.once('data', line => {
           t.equal(line.level, 30, 'level is correct')
           t.equal(line.msg, 'request completed', 'message is set')
-          t.same(line.res, { statusCode: 500 }, 'status code is set')
+          t.same(line.res, { statusCode: 200 }, 'status code is set')
         })
       })
     })
@@ -1381,7 +1402,7 @@ test('should not rely on raw request to log errors', t => {
   const stream = split(JSON.parse)
   const fastify = Fastify({
     logger: {
-      stream: stream,
+      stream,
       level: 'info'
     }
   })
@@ -1389,10 +1410,10 @@ test('should not rely on raw request to log errors', t => {
     t.ok(req.log)
     reply.status(415).send(new Error('something happened'))
   })
-  fastify.listen(0, err => {
+  fastify.listen(0, localhost, err => {
     t.error(err)
     fastify.server.unref()
-    http.get('http://localhost:' + fastify.server.address().port + '/error')
+    http.get(`http://${localhostForURL}:` + fastify.server.address().port + '/error')
     stream.once('data', listenAtLogLine => {
       t.ok(listenAtLogLine, 'listen at log message is ok')
       stream.once('data', line => {
@@ -1412,7 +1433,7 @@ test('should redact the authorization header if so specified', t => {
   const stream = split(JSON.parse)
   const fastify = Fastify({
     logger: {
-      stream: stream,
+      stream,
       redact: ['req.headers.authorization'],
       level: 'info',
       serializers: {
@@ -1439,12 +1460,12 @@ test('should redact the authorization header if so specified', t => {
       t.equal(line.req.headers.authorization, '[Redacted]', 'authorization is redacted')
     })
   })
-  fastify.listen(0, err => {
+  fastify.listen(0, localhost, err => {
     t.error(err)
     fastify.server.unref()
     sget({
       method: 'GET',
-      url: 'http://localhost:' + fastify.server.address().port,
+      url: `http://${localhostForURL}:` + fastify.server.address().port,
       headers: {
         authorization: 'Bearer abcde'
       }
@@ -1481,6 +1502,25 @@ test('should not log incoming request and outgoing response when disabled', t =>
   })
 })
 
+test('should not log incoming request and outgoing response for 404 onBadUrl when disabled', t => {
+  t.plan(1)
+  const lines = []
+  const dest = new stream.Writable({
+    write: function (chunk, enc, cb) {
+      lines.push(JSON.parse(chunk))
+      cb()
+    }
+  })
+  const fastify = Fastify({ disableRequestLogging: true, logger: { level: 'info', stream: dest } })
+
+  fastify.inject({
+    url: '/%c0',
+    method: 'GET'
+  }, (e, res) => {
+    t.same(lines.length, 0)
+  })
+})
+
 test('should pass when using unWritable props in the logger option', t => {
   t.plan(1)
   Fastify({

package/test/maxRequestsPerSocket.test.js

@@ -21,12 +21,12 @@ test('maxRequestsPerSocket on node version >= 16.10.0', { skip }, t => {
     t.error(err)
 
     const port = fastify.server.address().port
-    const client = net.createConnection({ port: port }, () => {
+    const client = net.createConnection({ port }, () => {
       client.write('GET / HTTP/1.1\r\n\r\n')
 
       client.once('data', data => {
         t.match(data.toString(), /Connection:\s*keep-alive/i)
-        t.match(data.toString(), /Keep-Alive:\s*timeout=5/i)
+        t.match(data.toString(), /Keep-Alive:\s*timeout=\d+/i)
         t.match(data.toString(), /200 OK/i)
 
         client.write('GET / HTTP/1.1\r\n\r\n')
@@ -40,6 +40,7 @@ test('maxRequestsPerSocket on node version >= 16.10.0', { skip }, t => {
           client.once('data', data => {
             t.match(data.toString(), /Connection:\s*close/i)
             t.match(data.toString(), /503 Service Unavailable/i)
+            client.end()
           })
         })
       })
@@ -61,27 +62,28 @@ test('maxRequestsPerSocket zero should behave same as null', { skip }, t => {
     t.error(err)
 
     const port = fastify.server.address().port
-    const client = net.createConnection({ port: port }, () => {
+    const client = net.createConnection({ port }, () => {
       client.write('GET / HTTP/1.1\r\n\r\n')
 
       client.once('data', data => {
         t.match(data.toString(), /Connection:\s*keep-alive/i)
-        t.match(data.toString(), /Keep-Alive:\s*timeout=5/i)
+        t.match(data.toString(), /Keep-Alive:\s*timeout=\d+/i)
         t.match(data.toString(), /200 OK/i)
 
         client.write('GET / HTTP/1.1\r\n\r\n')
 
         client.once('data', data => {
           t.match(data.toString(), /Connection:\s*keep-alive/i)
-          t.match(data.toString(), /Keep-Alive:\s*timeout=5/i)
+          t.match(data.toString(), /Keep-Alive:\s*timeout=\d+/i)
           t.match(data.toString(), /200 OK/i)
 
           client.write('GET / HTTP/1.1\r\n\r\n')
 
           client.once('data', data => {
             t.match(data.toString(), /Connection:\s*keep-alive/i)
-            t.match(data.toString(), /Keep-Alive:\s*timeout=5/i)
+            t.match(data.toString(), /Keep-Alive:\s*timeout=\d+/i)
             t.match(data.toString(), /200 OK/i)
+            client.end()
           })
         })
       })

package/test/middleware.test.js

@@ -3,22 +3,9 @@
 const { test } = require('tap')
 const Fastify = require('..')
 const {
-  FST_ERR_DEC_ALREADY_PRESENT,
-  FST_ERR_MISSING_MIDDLEWARE
+  FST_ERR_DEC_ALREADY_PRESENT
 } = require('../lib/errors')
 
-test('Should throw if the basic use API has not been overridden', t => {
-  t.plan(1)
-  const fastify = Fastify()
-
-  try {
-    fastify.use()
-    t.fail('Should throw')
-  } catch (err) {
-    t.ok(err instanceof FST_ERR_MISSING_MIDDLEWARE)
-  }
-})
-
 test('Should be able to override the default use API', t => {
   t.plan(1)
   const fastify = Fastify()
@@ -38,7 +25,7 @@ test('Cannot decorate use twice', t => {
 })
 
 test('Encapsulation works', t => {
-  t.plan(2)
+  t.plan(1)
   const fastify = Fastify()
 
   fastify.register((instance, opts, done) => {
@@ -47,15 +34,5 @@ test('Encapsulation works', t => {
     done()
   })
 
-  fastify.register((instance, opts, done) => {
-    try {
-      instance.use()
-      t.fail('Should throw')
-    } catch (err) {
-      t.ok(err instanceof FST_ERR_MISSING_MIDDLEWARE)
-    }
-    done()
-  })
-
   fastify.ready()
 })

package/test/noop-set.test.js

@@ -0,0 +1,19 @@
+'use strict'
+
+const tap = require('tap')
+const noopSet = require('../lib/noop-set')
+
+tap.test('does a lot of nothing', async t => {
+  const aSet = noopSet()
+  t.type(aSet, 'object')
+
+  const item = {}
+  aSet.add(item)
+  aSet.add({ another: 'item' })
+  aSet.delete(item)
+  t.equal(aSet.has(item), true)
+
+  for (const i of aSet) {
+    t.fail('should not have any items', i)
+  }
+})

package/test/nullable-validation.test.js

@@ -61,8 +61,8 @@ test('object or null body', t => {
     method: 'POST',
     url: '/',
     handler: (req, reply) => {
-      t.equal(req.body, null)
-      reply.code(200).send({ requestBody: req.body })
+      t.equal(req.body, undefined)
+      reply.code(200).send({ isUndefinedBody: req.body === undefined })
     },
     schema: {
       body: {
@@ -79,10 +79,8 @@ test('object or null body', t => {
           type: 'object',
           nullable: true,
           properties: {
-            requestBody: {
-              type: 'string',
-              format: 'email',
-              nullable: true
+            isUndefinedBody: {
+              type: 'boolean'
             }
           }
         }
@@ -100,7 +98,7 @@ test('object or null body', t => {
     }, (err, response, body) => {
       t.error(err)
       t.equal(response.statusCode, 200)
-      t.same(JSON.parse(body), { requestBody: null })
+      t.same(JSON.parse(body), { isUndefinedBody: true })
     })
   })
 })
@@ -114,8 +112,8 @@ test('nullable body', t => {
     method: 'POST',
     url: '/',
     handler: (req, reply) => {
-      t.equal(req.body, null)
-      reply.code(200).send({ requestBody: req.body })
+      t.equal(req.body, undefined)
+      reply.code(200).send({ isUndefinedBody: req.body === undefined })
     },
     schema: {
       body: {
@@ -133,10 +131,8 @@ test('nullable body', t => {
           type: 'object',
           nullable: true,
           properties: {
-            requestBody: {
-              type: 'string',
-              format: 'email',
-              nullable: true
+            isUndefinedBody: {
+              type: 'boolean'
             }
           }
         }
@@ -154,7 +150,48 @@ test('nullable body', t => {
     }, (err, response, body) => {
       t.error(err)
       t.equal(response.statusCode, 200)
-      t.same(JSON.parse(body), { requestBody: null })
+      t.same(JSON.parse(body), { isUndefinedBody: true })
+    })
+  })
+})
+
+test('Nullable body with 204', t => {
+  t.plan(5)
+
+  const fastify = Fastify()
+
+  fastify.route({
+    method: 'POST',
+    url: '/',
+    handler: (req, reply) => {
+      t.equal(req.body, undefined)
+      reply.code(204).send()
+    },
+    schema: {
+      body: {
+        type: 'object',
+        nullable: true,
+        properties: {
+          hello: {
+            type: 'string',
+            format: 'email'
+          }
+        }
+      }
+    }
+  })
+
+  fastify.listen(0, (err) => {
+    fastify.server.unref()
+    t.error(err)
+
+    sget({
+      method: 'POST',
+      url: 'http://localhost:' + fastify.server.address().port
+    }, (err, response, body) => {
+      t.error(err)
+      t.equal(response.statusCode, 204)
+      t.equal(body.length, 0)
     })
   })
 })