fastify 3.4.1 → 3.7.0

package/lib/request.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const proxyAddr = require('proxy-addr')
+const semver = require('semver')
 const warning = require('./warnings')
 
 function Request (id, params, req, query, log, context) {
@@ -78,6 +79,17 @@ function buildRequestWithTrustProxy (R, trustProxy) {
         }
         return this.headers.host || this.headers[':authority']
       }
+    },
+    protocol: {
+      get () {
+        if (this.headers['x-forwarded-proto']) {
+          const proto = this.headers['x-forwarded-proto']
+          // we use the last one if the header is set more than once
+          const lastIndex = proto.lastIndexOf(',')
+          return lastIndex === -1 ? proto.trim() : proto.slice(lastIndex + 1).trim()
+        }
+        return this.socket.encrypted ? 'https' : 'http'
+      }
     }
   })
 
@@ -118,12 +130,20 @@ Object.defineProperties(Request.prototype, {
   },
   connection: {
     get () {
+      if (semver.gte(process.versions.node, '13.0.0')) {
+        warning.emit('FSTDEP005')
+      }
       return this.raw.connection
     }
   },
+  socket: {
+    get () {
+      return this.raw.socket
+    }
+  },
   ip: {
     get () {
-      return this.connection.remoteAddress
+      return this.socket.remoteAddress
     }
   },
   hostname: {
@@ -131,6 +151,11 @@ Object.defineProperties(Request.prototype, {
       return this.raw.headers.host || this.raw.headers[':authority']
     }
   },
+  protocol: {
+    get () {
+      return this.socket.encrypted ? 'https' : 'http'
+    }
+  },
   headers: {
     get () {
       return this.raw.headers

package/lib/route.js

@@ -40,7 +40,8 @@ const {
   kRequest,
   kRequestPayloadStream,
   kDisableRequestLogging,
-  kSchemaErrorFormatter
+  kSchemaErrorFormatter,
+  kErrorHandler
 } = require('./symbols.js')
 
 function buildRouting (options) {
@@ -116,7 +117,10 @@ function buildRouting (options) {
   }
 
   // Route management
-  function route (opts) {
+  function route (options) {
+    // Since we are mutating/assigning only top level props, it is fine to have a shallow copy using the spread operator
+    const opts = { ...options }
+
     throwIfAlreadyStarted('Cannot add route when fastify instance is already started!')
 
     if (Array.isArray(opts.method)) {
@@ -210,7 +214,7 @@ function buildRouting (options) {
         this[kRequest],
         this[kContentTypeParser],
         config,
-        opts.errorHandler || this._errorHandler,
+        opts.errorHandler || this[kErrorHandler],
         opts.bodyLimit,
         opts.logLevel,
         opts.logSerializers,

package/lib/symbols.js

@@ -38,7 +38,8 @@ const keys = {
   kDisableRequestLogging: Symbol('fastify.disableRequestLogging'),
   kPluginNameChain: Symbol('fastify.pluginNameChain'),
   // This symbol is only meant to be used for fastify tests and should not be used for any other purpose
-  kTestInternals: Symbol('fastify.testInternals')
+  kTestInternals: Symbol('fastify.testInternals'),
+  kErrorHandler: Symbol('fastify.errorHandler')
 }
 
 module.exports = keys

package/lib/validation.js

@@ -97,6 +97,7 @@ function validate (context, request) {
 
 function wrapValidationError (result, dataVar, schemaErrorFormatter) {
   if (result instanceof Error) {
+    result.validationContext = result.validationContext || dataVar
     return result
   }
 

package/lib/warnings.js

@@ -8,6 +8,7 @@ const warning = require('fastify-warning')()
  *   - FSTDEP002
  *   - FSTDEP003
  *   - FSTDEP004
+ *   - FSTDEP005
  */
 
 warning.create('FastifyDeprecation', 'FSTDEP001', 'You are accessing the Node.js core request object via "request.req", Use "request.raw" instead.')
@@ -18,4 +19,6 @@ warning.create('FastifyDeprecation', 'FSTDEP003', 'You are using the legacy Cont
 
 warning.create('FastifyDeprecation', 'FSTDEP004', 'You are using the legacy preParsing hook signature. Use the one suggested in the documentation instead.')
 
+warning.create('FastifyDeprecation', 'FSTDEP005', 'You are accessing the deprecated "request.connection" property. Use "request.socket" instead.')
+
 module.exports = warning

package/lib/wrapThenable.js

@@ -6,7 +6,7 @@ const {
   kReplySentOverwritten
 } = require('./symbols')
 
-const { FST_ERR_PROMISE_NOT_FULLFILLED } = require('./errors')
+const { FST_ERR_PROMISE_NOT_FULFILLED } = require('./errors')
 
 function wrapThenable (thenable, reply) {
   thenable.then(function (payload) {
@@ -27,7 +27,7 @@ function wrapThenable (thenable, reply) {
         reply.send(err)
       }
     } else if (reply[kReplySent] === false) {
-      reply.log.error({ err: new FST_ERR_PROMISE_NOT_FULLFILLED() }, "Promise may not be fulfilled with 'undefined' when statusCode is not 204")
+      reply.log.error({ err: new FST_ERR_PROMISE_NOT_FULFILLED() }, "Promise may not be fulfilled with 'undefined' when statusCode is not 204")
     }
   }, function (err) {
     if (reply[kReplySentOverwritten] === true) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fastify",
-  "version": "3.4.1",
+  "version": "3.7.0",
   "description": "Fast and low overhead web framework, for Node.js",
   "main": "fastify.js",
   "type": "commonjs",
@@ -114,8 +114,8 @@
   "devDependencies": {
     "@hapi/joi": "^17.1.1",
     "@sinonjs/fake-timers": "^6.0.1",
-    "@types/node": "^14.0.1",
     "@types/pino": "^6.0.1",
+    "@types/node": "^14.10.3",
     "@typescript-eslint/eslint-plugin": "^2.29.0",
     "@typescript-eslint/parser": "^2.29.0",
     "JSONStream": "^1.3.5",
@@ -138,7 +138,7 @@
     "eslint-plugin-standard": "^4.0.1",
     "events.once": "^2.0.2",
     "fast-json-body": "^1.1.0",
-    "fastify-plugin": "^2.1.0",
+    "fastify-plugin": "^3.0.0",
     "fluent-schema": "^1.0.0",
     "form-data": "^3.0.0",
     "frameguard": "^3.1.0",
@@ -152,7 +152,6 @@
     "pre-commit": "^1.2.2",
     "proxyquire": "^2.1.3",
     "pump": "^3.0.0",
-    "semver": "^7.3.2",
     "send": "^0.17.1",
     "serve-static": "^1.14.1",
     "simple-get": "^4.0.0",
@@ -177,12 +176,13 @@
     "fastify-warning": "^0.2.0",
     "find-my-way": "^3.0.0",
     "flatstr": "^1.0.12",
-    "light-my-request": "^4.0.2",
+    "light-my-request": "^4.2.0",
     "pino": "^6.2.1",
     "proxy-addr": "^2.0.5",
     "readable-stream": "^3.4.0",
     "rfdc": "^1.1.4",
     "secure-json-parse": "^2.0.0",
+    "semver": "^7.3.2",
     "tiny-lru": "^7.0.0"
   },
   "standard": {

package/test/custom-parser.test.js

@@ -1214,3 +1214,33 @@ test('route bodyLimit should take precedence over a custom parser bodyLimit', t
     })
   })
 })
+
+test('should be able to use default parser for extra content type', t => {
+  t.plan(4)
+  const fastify = Fastify()
+  t.tearDown(() => fastify.close())
+
+  fastify.post('/', (request, reply) => {
+    reply.send(request.body)
+  })
+
+  fastify.addContentTypeParser('text/json', { parseAs: 'string' }, fastify.getDefaultJsonParser('ignore', 'ignore'))
+
+  fastify.listen(0, err => {
+    t.error(err)
+
+    sget({
+      method: 'POST',
+      url: 'http://localhost:' + fastify.server.address().port,
+      body: '{"hello":"world"}',
+      headers: {
+        'Content-Type': 'text/json'
+      }
+    }, (err, response, body) => {
+      t.error(err)
+      t.strictEqual(response.statusCode, 200)
+      t.strictDeepEqual(JSON.parse(body.toString()), { hello: 'world' })
+      fastify.close()
+    })
+  })
+})

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/esm/index.test.js

@@ -4,8 +4,7 @@ const t = require('tap')
 const semver = require('semver')
 
 if (semver.lt(process.versions.node, '13.3.0')) {
-  t.skip('Skip because Node version <= 13.3.0')
-  t.end()
+  t.skip('Skip esm because Node version <= 13.3.0')
 } else {
   // Node v8 throw a `SyntaxError: Unexpected token import`
   // even if this branch is never touch in the code,
@@ -17,3 +16,17 @@ if (semver.lt(process.versions.node, '13.3.0')) {
     })
   })
 }
+
+if (semver.lt(process.versions.node, '14.13.0')) {
+  t.skip('Skip named exports because Node version < 14.13.0')
+} else {
+  // Node v8 throw a `SyntaxError: Unexpected token import`
+  // even if this branch is never touch in the code,
+  // by using `eval` we can avoid this issue.
+  // eslint-disable-next-line
+  new Function('module', 'return import(module)')('./named-exports.mjs').catch((err) => {
+    process.nextTick(() => {
+      throw err
+    })
+  })
+}

package/test/esm/named-exports.mjs

@@ -0,0 +1,13 @@
+import t from 'tap'
+import { fastify } from '../../fastify.js'
+
+t.test('named exports support', async t => {
+  const app = fastify()
+
+  app.register(import('./plugin.mjs'), { foo: 'bar' })
+  app.register(import('./other.mjs'))
+
+  await app.ready()
+
+  t.strictEqual(app.foo, 'bar')
+})

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/http2/secure.test.js

@@ -25,6 +25,9 @@ try {
 fastify.get('/', function (req, reply) {
   reply.code(200).send(msg)
 })
+fastify.get('/proto', function (req, reply) {
+  reply.code(200).send({ proto: req.protocol })
+})
 
 fastify.listen(0, err => {
   t.error(err)
@@ -40,4 +43,12 @@ fastify.listen(0, err => {
     t.strictEqual(res.headers['content-length'], '' + JSON.stringify(msg).length)
     t.deepEqual(JSON.parse(res.body), msg)
   })
+
+  test('https get request without trust proxy - protocol', async (t) => {
+    t.plan(2)
+
+    const url = `https://localhost:${fastify.server.address().port}/proto`
+    t.deepEqual(JSON.parse((await h2url.concat({ url })).body), { proto: 'https' })
+    t.deepEqual(JSON.parse((await h2url.concat({ url, headers: { 'X-Forwarded-Proto': 'lorem' } })).body), { proto: 'https' })
+  })
 })

package/test/https/https.test.js

@@ -25,6 +25,9 @@ test('https get', t => {
     fastify.get('/', function (req, reply) {
       reply.code(200).send({ hello: 'world' })
     })
+    fastify.get('/proto', function (req, reply) {
+      reply.code(200).send({ proto: req.protocol })
+    })
     t.pass()
   } catch (e) {
     t.fail()
@@ -48,4 +51,27 @@ fastify.listen(0, err => {
       t.deepEqual(JSON.parse(body), { hello: 'world' })
     })
   })
+
+  test('https get request without trust proxy - protocol', t => {
+    t.plan(4)
+    sget({
+      method: 'GET',
+      url: 'https://localhost:' + fastify.server.address().port + '/proto',
+      rejectUnauthorized: false
+    }, (err, response, body) => {
+      t.error(err)
+      t.deepEqual(JSON.parse(body), { proto: 'https' })
+    })
+    sget({
+      method: 'GET',
+      url: 'https://localhost:' + fastify.server.address().port + '/proto',
+      rejectUnauthorized: false,
+      headers: {
+        'x-forwarded-proto': 'lorem'
+      }
+    }, (err, response, body) => {
+      t.error(err)
+      t.deepEqual(JSON.parse(body), { proto: 'https' })
+    })
+  })
 })

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 => {

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

@@ -351,3 +351,19 @@ test('listen logs the port as info', t => {
       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.is(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\\testPipe', 511)
+  t.is(address, '\\\\.\\pipe\\testPipe')
+})

package/test/logger.test.js

@@ -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/plugin.test.js

@@ -817,3 +817,111 @@ test('pluginTimeout default', t => {
 
   t.tearDown(clock.uninstall)
 })
+
+test('plugin metadata - version', t => {
+  t.plan(1)
+  const fastify = Fastify()
+
+  plugin[Symbol.for('skip-override')] = true
+  plugin[Symbol.for('plugin-meta')] = {
+    name: 'plugin',
+    fastify: '2.0.0'
+  }
+
+  fastify.register(plugin)
+
+  fastify.ready(() => {
+    t.pass('everything right')
+  })
+
+  function plugin (instance, opts, next) {
+    next()
+  }
+})
+
+test('plugin metadata - version range', t => {
+  t.plan(1)
+  const fastify = Fastify()
+
+  plugin[Symbol.for('skip-override')] = true
+  plugin[Symbol.for('plugin-meta')] = {
+    name: 'plugin',
+    fastify: '>=2.0.0'
+  }
+
+  fastify.register(plugin)
+
+  fastify.ready(() => {
+    t.pass('everything right')
+  })
+
+  function plugin (instance, opts, next) {
+    next()
+  }
+})
+
+test('plugin metadata - version not matching requirement', t => {
+  t.plan(2)
+  const fastify = Fastify()
+
+  plugin[Symbol.for('skip-override')] = true
+  plugin[Symbol.for('plugin-meta')] = {
+    name: 'plugin',
+    fastify: '99.0.0'
+  }
+
+  fastify.register(plugin)
+
+  fastify.ready((err) => {
+    t.ok(err)
+    t.equal(err.code, 'FST_ERR_PLUGIN_VERSION_MISMATCH')
+  })
+
+  function plugin (instance, opts, next) {
+    next()
+  }
+})
+
+test('plugin metadata - version not matching requirement 2', t => {
+  t.plan(2)
+  const fastify = Fastify()
+
+  plugin[Symbol.for('skip-override')] = true
+  plugin[Symbol.for('plugin-meta')] = {
+    name: 'plugin',
+    fastify: '<=3.0.0'
+  }
+
+  fastify.register(plugin)
+
+  fastify.ready((err) => {
+    t.ok(err)
+    t.equal(err.code, 'FST_ERR_PLUGIN_VERSION_MISMATCH')
+  })
+
+  function plugin (instance, opts, next) {
+    next()
+  }
+})
+
+test('plugin metadata - version not matching requirement 3', t => {
+  t.plan(2)
+  const fastify = Fastify()
+
+  plugin[Symbol.for('skip-override')] = true
+  plugin[Symbol.for('plugin-meta')] = {
+    name: 'plugin',
+    fastify: '>=99.0.0'
+  }
+
+  fastify.register(plugin)
+
+  fastify.ready((err) => {
+    t.ok(err)
+    t.equal(err.code, 'FST_ERR_PLUGIN_VERSION_MISMATCH')
+  })
+
+  function plugin (instance, opts, next) {
+    next()
+  }
+})