fastify 3.5.0 → 3.8.0

package/test/emit-warning.test.js

@@ -3,6 +3,7 @@
 const sget = require('simple-get').concat
 const { test } = require('tap')
 const Fastify = require('..')
+const semver = require('semver')
 
 process.removeAllListeners('warning')
 
@@ -129,3 +130,33 @@ test('Should emit a warning when using payload less preParsing hook', t => {
     })
   })
 })
+
+if (semver.gte(process.versions.node, '13.0.0')) {
+  test('Should emit a warning when accessing request.connection instead of request.socket on Node process greater than 13.0.0', t => {
+    t.plan(4)
+
+    process.on('warning', onWarning)
+    function onWarning (warning) {
+      t.strictEqual(warning.name, 'FastifyDeprecation')
+      t.strictEqual(warning.code, 'FSTDEP005')
+      t.strictEqual(warning.message, 'You are accessing the deprecated "request.connection" property. Use "request.socket" instead.')
+
+      // removed listener before light-my-request emit second warning
+      process.removeListener('warning', onWarning)
+    }
+
+    const fastify = Fastify()
+
+    fastify.get('/', (request, reply) => {
+      reply.send(request.connection)
+    })
+
+    fastify.inject({
+      method: 'GET',
+      path: '/'
+    }, (err, res) => {
+      t.error(err)
+      process.removeListener('warning', onWarning)
+    })
+  })
+}

package/test/fastify-instance.test.js

@@ -4,7 +4,8 @@ const t = require('tap')
 const test = t.test
 const Fastify = require('..')
 const {
-  kOptions
+  kOptions,
+  kErrorHandler
 } = require('../lib/symbols')
 
 test('root fastify instance is an object', t => {
@@ -65,3 +66,34 @@ test('fastify instance get invalid ajv options.plugins', t => {
     }
   }))
 })
+
+test('fastify instance should contain default errorHandler', t => {
+  t.plan(3)
+  const fastify = Fastify()
+  t.ok(fastify[kErrorHandler] instanceof Function)
+  t.same(fastify.errorHandler, fastify[kErrorHandler])
+  t.same(Object.getOwnPropertyDescriptor(fastify, 'errorHandler').set, undefined)
+})
+
+test('errorHandler in plugin should be separate from the external one', async t => {
+  t.plan(4)
+  const fastify = Fastify()
+
+  fastify.register((instance, opts, next) => {
+    const inPluginErrHandler = (_, __, reply) => {
+      reply.send({ plugin: 'error-object' })
+    }
+
+    instance.setErrorHandler(inPluginErrHandler)
+
+    t.notSame(instance.errorHandler, fastify.errorHandler)
+    t.equal(instance.errorHandler.name, 'bound inPluginErrHandler')
+
+    next()
+  })
+
+  await fastify.ready()
+
+  t.ok(fastify[kErrorHandler] instanceof Function)
+  t.same(fastify.errorHandler, fastify[kErrorHandler])
+})

package/test/helper.js

@@ -282,7 +282,7 @@ module.exports.payloadMethod = function (method, t, isSetErrorHandler = false) {
 
       // Node errors for OPTIONS requests with a stream body and no Content-Length header
       if (upMethod !== 'OPTIONS') {
-        var chunk = Buffer.alloc(1024 * 1024 + 1, 0)
+        let chunk = Buffer.alloc(1024 * 1024 + 1, 0)
         const largeStream = new stream.Readable({
           read () {
             this.push(chunk)

package/test/hooks.test.js

@@ -197,7 +197,7 @@ test('onRequest hook should support encapsulation / 1', t => {
 test('onRequest hook should support encapsulation / 2', t => {
   t.plan(3)
   const fastify = Fastify()
-  var pluginInstance
+  let pluginInstance
 
   fastify.addHook('onRequest', () => {})
 
@@ -813,7 +813,7 @@ test('onResponse hook should support encapsulation / 1', t => {
 test('onResponse hook should support encapsulation / 2', t => {
   t.plan(3)
   const fastify = Fastify()
-  var pluginInstance
+  let pluginInstance
 
   fastify.addHook('onResponse', () => {})
 
@@ -890,7 +890,7 @@ test('onResponse hook should support encapsulation / 3', t => {
 test('onSend hook should support encapsulation / 1', t => {
   t.plan(3)
   const fastify = Fastify()
-  var pluginInstance
+  let pluginInstance
 
   fastify.addHook('onSend', () => {})
 
@@ -1015,7 +1015,7 @@ test('onSend hook is called after payload is serialized and headers are set', t
   })
 
   fastify.register((instance, opts, done) => {
-    var chunk = 'stream payload'
+    let chunk = 'stream payload'
     const thePayload = new stream.Readable({
       read () {
         this.push(chunk)
@@ -2163,7 +2163,7 @@ test('preValidation hook should support encapsulation / 1', t => {
 test('preValidation hook should support encapsulation / 2', t => {
   t.plan(3)
   const fastify = Fastify()
-  var pluginInstance
+  let pluginInstance
 
   fastify.addHook('preValidation', () => {})
 
@@ -2582,7 +2582,7 @@ test('preParsing hook should support encapsulation / 1', t => {
 test('preParsing hook should support encapsulation / 2', t => {
   t.plan(3)
   const fastify = Fastify()
-  var pluginInstance
+  let pluginInstance
 
   fastify.addHook('preParsing', function a () {})
 

package/test/http2/head.test.js

@@ -6,7 +6,7 @@ const Fastify = require('../..')
 const h2url = require('h2url')
 const msg = { hello: 'world' }
 
-var fastify
+let fastify
 try {
   fastify = Fastify({
     http2: true

package/test/http2/plain.test.js

@@ -6,7 +6,7 @@ const Fastify = require('../..')
 const h2url = require('h2url')
 const msg = { hello: 'world' }
 
-var fastify
+let fastify
 try {
   fastify = Fastify({
     http2: true

package/test/http2/secure-with-fallback.test.js

@@ -9,7 +9,7 @@ const h2url = require('h2url')
 const sget = require('simple-get').concat
 const msg = { hello: 'world' }
 
-var fastify
+let fastify
 try {
   fastify = Fastify({
     http2: true,

package/test/http2/secure.test.js

@@ -8,7 +8,7 @@ const Fastify = require('../..')
 const h2url = require('h2url')
 const msg = { hello: 'world' }
 
-var fastify
+let fastify
 try {
   fastify = Fastify({
     http2: true,

package/test/http2/unknown-http-method.test.js

@@ -6,7 +6,7 @@ const Fastify = require('../..')
 const h2url = require('h2url')
 const msg = { hello: 'world' }
 
-var fastify
+let fastify
 try {
   fastify = Fastify({
     http2: true

package/test/https/https.test.js

@@ -7,8 +7,9 @@ const fs = require('fs')
 const path = require('path')
 const Fastify = require('../..')
 
+let fastify
 try {
-  var fastify = Fastify({
+  fastify = Fastify({
     https: {
       key: fs.readFileSync(path.join(__dirname, 'fastify.key')),
       cert: fs.readFileSync(path.join(__dirname, 'fastify.cert'))

package/test/inject.test.js

@@ -329,7 +329,7 @@ test('inject a multipart request using form-body', t => {
   const fastify = Fastify()
 
   fastify.addContentTypeParser('*', function (req, payload, done) {
-    var body = ''
+    let body = ''
     payload.on('data', d => {
       body += d
     })
@@ -362,7 +362,7 @@ function getStream () {
   }
   util.inherits(Read, Stream.Readable)
   const word = '{"hello":"world"}'
-  var i = 0
+  let i = 0
 
   Read.prototype._read = function (size) {
     this.push(word[i] ? word[i++] : null)

package/test/internals/all.test.js

@@ -28,7 +28,7 @@ test('fastify.all should add all the methods to the same url', t => {
 
     fastify.inject(options, (err, res) => {
       t.error(err)
-      var payload = JSON.parse(res.payload)
+      const payload = JSON.parse(res.payload)
       t.deepEqual(payload, { method: method })
     })
   }

package/test/internals/hookRunner.test.js

@@ -139,7 +139,7 @@ test('hookRunner - In case of error should skip to done (with promises)', t => {
 test('hookRunner - Be able to exit before its natural end', t => {
   t.plan(4)
 
-  var shouldStop = false
+  let shouldStop = false
   hookRunner([fn1, fn2, fn3], iterator, 'a', 'b', done)
 
   function iterator (fn, a, b, next) {

package/test/internals/logger.test.js

@@ -23,7 +23,7 @@ test('The logger should add a unique id for every request', t => {
   fastify.listen(0, err => {
     t.error(err)
     const queue = new Queue()
-    for (var i = 0; i < 10; i++) {
+    for (let i = 0; i < 10; i++) {
       queue.add(checkId)
     }
     queue.add(() => {

package/test/internals/reply.test.js

@@ -79,7 +79,7 @@ test('reply.send throw with circular JSON', t => {
   }
   const reply = new Reply(response, { context: { onSend: [] } })
   t.throws(() => {
-    var obj = {}
+    const obj = {}
     obj.obj = obj
     reply.send(JSON.stringify(obj))
   }, 'Converting circular structure to JSON')
@@ -430,9 +430,9 @@ test('stream with content type should not send application/octet-stream', t => {
   const fs = require('fs')
   const path = require('path')
 
-  var streamPath = path.join(__dirname, '..', '..', 'package.json')
-  var stream = fs.createReadStream(streamPath)
-  var buf = fs.readFileSync(streamPath)
+  const streamPath = path.join(__dirname, '..', '..', 'package.json')
+  const stream = fs.createReadStream(streamPath)
+  const buf = fs.readFileSync(streamPath)
 
   fastify.get('/', function (req, reply) {
     reply.header('Content-Type', 'text/plain').send(stream)
@@ -459,9 +459,9 @@ test('stream using reply.raw.writeHead should return customize headers', t => {
   const fs = require('fs')
   const path = require('path')
 
-  var streamPath = path.join(__dirname, '..', '..', 'package.json')
-  var stream = fs.createReadStream(streamPath)
-  var buf = fs.readFileSync(streamPath)
+  const streamPath = path.join(__dirname, '..', '..', 'package.json')
+  const stream = fs.createReadStream(streamPath)
+  const buf = fs.readFileSync(streamPath)
 
   fastify.get('/', function (req, reply) {
     reply.log.warn = function mockWarn (message) {
@@ -781,6 +781,61 @@ test('undefined payload should be sent as-is', t => {
   })
 })
 
+test('for HEAD method, no body should be sent but content-length should be', t => {
+  t.plan(11)
+
+  const fastify = require('../..')()
+  const contentType = 'application/json; charset=utf-8'
+  const bodySize = JSON.stringify({ foo: 'bar' }).length
+
+  fastify.head('/', {
+    onSend: function (request, reply, payload, next) {
+      t.strictEqual(payload, undefined)
+      next()
+    }
+  }, function (req, reply) {
+    reply.header('content-length', bodySize)
+    reply.header('content-type', contentType)
+    reply.code(200).send()
+  })
+
+  fastify.head('/with/null', {
+    onSend: function (request, reply, payload, next) {
+      t.strictEqual(payload, 'null')
+      next()
+    }
+  }, function (req, reply) {
+    reply.header('content-length', bodySize)
+    reply.header('content-type', contentType)
+    reply.code(200).send(null)
+  })
+
+  fastify.listen(0, err => {
+    t.error(err)
+    fastify.server.unref()
+
+    sget({
+      method: 'HEAD',
+      url: `http://localhost:${fastify.server.address().port}`
+    }, (err, response, body) => {
+      t.error(err)
+      t.strictEqual(response.headers['content-type'], contentType)
+      t.strictEqual(response.headers['content-length'], bodySize.toString())
+      t.strictEqual(body.length, 0)
+    })
+
+    sget({
+      method: 'HEAD',
+      url: `http://localhost:${fastify.server.address().port}/with/null`
+    }, (err, response, body) => {
+      t.error(err)
+      t.strictEqual(response.headers['content-type'], contentType)
+      t.strictEqual(response.headers['content-length'], bodySize.toString())
+      t.strictEqual(body.length, 0)
+    })
+  })
+})
+
 test('reply.send(new NotFound()) should not invoke the 404 handler', t => {
   t.plan(9)
 

package/test/internals/request.test.js

@@ -12,7 +12,7 @@ test('Regular request', t => {
   const req = {
     method: 'GET',
     url: '/',
-    connection: { remoteAddress: 'ip' },
+    socket: { remoteAddress: 'ip' },
     headers
   }
   const request = new Request('id', 'params', req, 'query', 'log')
@@ -29,7 +29,7 @@ test('Regular request', t => {
   t.strictEqual(request.body, null)
   t.strictEqual(request.method, 'GET')
   t.strictEqual(request.url, '/')
-  t.deepEqual(request.connection, req.connection)
+  t.deepEqual(request.socket, req.socket)
 })
 
 test('Regular request - hostname from authority', t => {
@@ -40,7 +40,7 @@ test('Regular request - hostname from authority', t => {
   const req = {
     method: 'GET',
     url: '/',
-    connection: { remoteAddress: 'ip' },
+    socket: { remoteAddress: 'ip' },
     headers
   }
 
@@ -58,7 +58,7 @@ test('Regular request - host header has precedence over authority', t => {
   const req = {
     method: 'GET',
     url: '/',
-    connection: { remoteAddress: 'ip' },
+    socket: { remoteAddress: 'ip' },
     headers
   }
   const request = new Request('id', 'params', req, 'query', 'log')
@@ -75,6 +75,9 @@ test('Request with trust proxy', t => {
   const req = {
     method: 'GET',
     url: '/',
+    // Some dependencies (proxy-addr, forwarded) still depend on the deprecated
+    // .connection property, we use .socket. Include both to satisfy everyone.
+    socket: { remoteAddress: 'ip' },
     connection: { remoteAddress: 'ip' },
     headers
   }
@@ -94,7 +97,7 @@ test('Request with trust proxy', t => {
   t.strictEqual(request.body, null)
   t.strictEqual(request.method, 'GET')
   t.strictEqual(request.url, '/')
-  t.deepEqual(request.connection, req.connection)
+  t.deepEqual(request.socket, req.socket)
 })
 
 test('Request with trust proxy - no x-forwarded-host header', t => {
@@ -154,3 +157,26 @@ test('Request with trust proxy - x-forwarded-host header has precedence over hos
   t.type(request, TpRequest)
   t.strictEqual(request.hostname, 'example.com')
 })
+
+test('Request with trust proxy - handles multiple entries in x-forwarded-host/proto', t => {
+  t.plan(3)
+  const headers = {
+    'x-forwarded-host': 'example2.com, example.com',
+    'x-forwarded-proto': 'http, https'
+  }
+  const req = {
+    method: 'GET',
+    url: '/',
+    // Some dependencies (proxy-addr, forwarded) still depend on the deprecated
+    // .connection property, we use .socket. Include both to satisfy everyone.
+    socket: { remoteAddress: 'ip' },
+    connection: { remoteAddress: 'ip' },
+    headers
+  }
+
+  const TpRequest = Request.buildRequest(Request, true)
+  const request = new TpRequest('id', 'params', req, 'query', 'log')
+  t.type(request, TpRequest)
+  t.strictEqual(request.hostname, 'example.com')
+  t.strictEqual(request.protocol, 'https')
+})

package/test/internals/version.test.js

@@ -0,0 +1,43 @@
+'use strict'
+
+const t = require('tap')
+const test = t.test
+const proxyquire = require('proxyquire')
+
+test('should output an undefined version in case of package.json not available', t => {
+  const Fastify = proxyquire('../..', { fs: { accessSync: () => { throw Error('error') } } })
+  t.plan(1)
+  const srv = Fastify()
+  t.is(srv.version, undefined)
+})
+
+test('should output an undefined version in case of package.json is not the fastify one', t => {
+  const Fastify = proxyquire('../..', { fs: { accessSync: () => { }, readFileSync: () => JSON.stringify({ name: 'foo', version: '6.6.6' }) } })
+  t.plan(1)
+  const srv = Fastify()
+  t.is(srv.version, undefined)
+})
+
+test('should skip the version check if the version is undefined', t => {
+  const Fastify = proxyquire('../..', { fs: { accessSync: () => { }, readFileSync: () => JSON.stringify({ name: 'foo', version: '6.6.6' }) } })
+  t.plan(3)
+  const srv = Fastify()
+  t.is(srv.version, undefined)
+
+  plugin[Symbol.for('skip-override')] = false
+  plugin[Symbol.for('plugin-meta')] = {
+    name: 'plugin',
+    fastify: '>=99.0.0'
+  }
+
+  srv.register(plugin)
+
+  srv.ready((err) => {
+    t.error(err)
+    t.pass('everything right')
+  })
+
+  function plugin (instance, opts, next) {
+    next()
+  }
+})

package/test/listen.test.js

@@ -62,6 +62,18 @@ 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()

package/test/logger.test.js

@@ -32,8 +32,8 @@ tearDown(() => {
 
 test('defaults to info level', t => {
   t.plan(13)
-  var fastify = null
-  var stream = split(JSON.parse)
+  let fastify = null
+  const stream = split(JSON.parse)
   try {
     fastify = Fastify({
       logger: {
@@ -80,8 +80,8 @@ test('defaults to info level', t => {
 
 test('test log stream', t => {
   t.plan(12)
-  var fastify = null
-  var stream = split(JSON.parse)
+  let fastify = null
+  const stream = split(JSON.parse)
   try {
     fastify = Fastify({
       logger: {
@@ -127,8 +127,8 @@ test('test log stream', t => {
 
 test('test error log stream', t => {
   t.plan(11)
-  var fastify = null
-  var stream = split(JSON.parse)
+  let fastify = null
+  const stream = split(JSON.parse)
   try {
     fastify = Fastify({
       logger: {
@@ -248,8 +248,8 @@ test('can use external logger instance with custom serializer', t => {
 
 test('expose the logger', t => {
   t.plan(2)
-  var fastify = null
-  var stream = split(JSON.parse)
+  let fastify = null
+  const stream = split(JSON.parse)
   try {
     fastify = Fastify({
       logger: {
@@ -1190,8 +1190,8 @@ test('Do not wrap IPv4 address', t => {
 
 test('file option', t => {
   t.plan(13)
-  var fastify = null
-  var dest = file()
+  let fastify = null
+  const dest = file()
 
   fastify = Fastify({
     logger: {
@@ -1423,7 +1423,7 @@ test('should redact the authorization header if so specified', t => {
             headers: req.headers,
             hostname: req.hostname,
             remoteAddress: req.ip,
-            remotePort: req.connection.remotePort
+            remotePort: req.socket.remotePort
           }
         }
       }

package/test/nullable-validation.test.js

@@ -2,6 +2,7 @@
 
 const t = require('tap')
 const test = t.test
+const sget = require('simple-get').concat
 const Fastify = require('..')
 
 test('nullable string', t => {
@@ -50,3 +51,110 @@ test('nullable string', t => {
     t.same(res.payload.hello, null)
   })
 })
+
+test('object or null body', t => {
+  t.plan(5)
+
+  const fastify = Fastify()
+
+  fastify.route({
+    method: 'POST',
+    url: '/',
+    handler: (req, reply) => {
+      t.strictEqual(req.body, null)
+      reply.code(200).send({ requestBody: req.body })
+    },
+    schema: {
+      body: {
+        type: ['object', 'null'],
+        properties: {
+          hello: {
+            type: 'string',
+            format: 'email'
+          }
+        }
+      },
+      response: {
+        200: {
+          type: 'object',
+          nullable: true,
+          properties: {
+            requestBody: {
+              type: 'string',
+              format: 'email',
+              nullable: true
+            }
+          }
+        }
+      }
+    }
+  })
+
+  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.strictEqual(response.statusCode, 200)
+      t.deepEqual(JSON.parse(body), { requestBody: null })
+    })
+  })
+})
+
+test('nullable body', t => {
+  t.plan(5)
+
+  const fastify = Fastify()
+
+  fastify.route({
+    method: 'POST',
+    url: '/',
+    handler: (req, reply) => {
+      t.strictEqual(req.body, null)
+      reply.code(200).send({ requestBody: req.body })
+    },
+    schema: {
+      body: {
+        type: 'object',
+        nullable: true,
+        properties: {
+          hello: {
+            type: 'string',
+            format: 'email'
+          }
+        }
+      },
+      response: {
+        200: {
+          type: 'object',
+          nullable: true,
+          properties: {
+            requestBody: {
+              type: 'string',
+              format: 'email',
+              nullable: true
+            }
+          }
+        }
+      }
+    }
+  })
+
+  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.strictEqual(response.statusCode, 200)
+      t.deepEqual(JSON.parse(body), { requestBody: null })
+    })
+  })
+})