fastify 3.25.3 → 3.27.2

package/fastify.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const VERSION = '3.25.3'
+const VERSION = '3.27.2'
 
 const Avvio = require('avvio')
 const http = require('http')
@@ -16,6 +16,7 @@ const {
   kLogSerializers,
   kHooks,
   kSchemaController,
+  kRequestAcceptVersion,
   kReplySerializerDefault,
   kContentTypeParser,
   kReply,
@@ -25,7 +26,9 @@ const {
   kOptions,
   kPluginNameChain,
   kSchemaErrorFormatter,
-  kErrorHandler
+  kErrorHandler,
+  kKeepAliveConnections,
+  kFourOhFourContext
 } = require('./lib/symbols.js')
 
 const { createServer } = require('./lib/server')
@@ -44,6 +47,7 @@ const build404 = require('./lib/fourOhFour')
 const getSecuredInitialConfig = require('./lib/initialConfigValidation')
 const override = require('./lib/pluginOverride')
 const warning = require('./lib/warnings')
+const noopSet = require('./lib/noop-set')
 const { defaultInitOptions } = getSecuredInitialConfig
 
 const {
@@ -55,7 +59,8 @@ const onBadUrlContext = {
   config: {
   },
   onSend: [],
-  onError: []
+  onError: [],
+  [kFourOhFourContext]: null
 }
 
 function defaultBuildPrettyMeta (route) {
@@ -132,6 +137,7 @@ function fastify (options) {
   // Update the options with the fixed values
   options.connectionTimeout = options.connectionTimeout || defaultInitOptions.connectionTimeout
   options.keepAliveTimeout = options.keepAliveTimeout || defaultInitOptions.keepAliveTimeout
+  options.forceCloseConnections = typeof options.forceCloseConnections === 'boolean' ? options.forceCloseConnections : defaultInitOptions.forceCloseConnections
   options.maxRequestsPerSocket = options.maxRequestsPerSocket || defaultInitOptions.maxRequestsPerSocket
   options.requestTimeout = options.requestTimeout || defaultInitOptions.requestTimeout
   options.logger = logger
@@ -145,6 +151,7 @@ function fastify (options) {
   options.exposeHeadRoutes = exposeHeadRoutes
 
   const initialConfig = getSecuredInitialConfig(options)
+  const keepAliveConnections = options.forceCloseConnections === true ? new Set() : noopSet()
 
   let constraints = options.constraints
   if (options.versioning) {
@@ -168,14 +175,15 @@ function fastify (options) {
   // Default router
   const router = buildRouting({
     config: {
-      defaultRoute: defaultRoute,
-      onBadUrl: onBadUrl,
-      constraints: constraints,
+      defaultRoute,
+      onBadUrl,
+      constraints,
       ignoreTrailingSlash: options.ignoreTrailingSlash || defaultInitOptions.ignoreTrailingSlash,
       maxParamLength: options.maxParamLength || defaultInitOptions.maxParamLength,
       caseSensitive: options.caseSensitive,
       buildPrettyMeta: defaultBuildPrettyMeta
-    }
+    },
+    keepAliveConnections
   })
 
   // 404 router, used for handling encapsulated 404 handlers
@@ -199,6 +207,7 @@ function fastify (options) {
       closing: false,
       started: false
     },
+    [kKeepAliveConnections]: keepAliveConnections,
     [kOptions]: options,
     [kChildren]: [],
     [kBodyLimit]: bodyLimit,
@@ -259,16 +268,16 @@ function fastify (options) {
     // expose logger instance
     log: logger,
     // hooks
-    addHook: addHook,
+    addHook,
     // schemas
-    addSchema: addSchema,
+    addSchema,
     getSchema: schemaController.getSchema.bind(schemaController),
     getSchemas: schemaController.getSchemas.bind(schemaController),
-    setValidatorCompiler: setValidatorCompiler,
-    setSerializerCompiler: setSerializerCompiler,
-    setSchemaController: setSchemaController,
-    setReplySerializer: setReplySerializer,
-    setSchemaErrorFormatter: setSchemaErrorFormatter,
+    setValidatorCompiler,
+    setSerializerCompiler,
+    setSchemaController,
+    setReplySerializer,
+    setSchemaErrorFormatter,
     // custom parsers
     addContentTypeParser: ContentTypeParser.helpers.addContentTypeParser,
     hasContentTypeParser: ContentTypeParser.helpers.hasContentTypeParser,
@@ -284,8 +293,8 @@ function fastify (options) {
     close: null,
     printPlugins: null,
     // http server
-    listen: listen,
-    server: server,
+    listen,
+    server,
     // extend fastify objects
     decorate: decorator.add,
     hasDecorator: decorator.exist,
@@ -294,12 +303,12 @@ function fastify (options) {
     hasRequestDecorator: decorator.existRequest,
     hasReplyDecorator: decorator.existReply,
     // fake http injection
-    inject: inject,
+    inject,
     // pretty print of the registered routes
     printRoutes,
     // custom error handling
-    setNotFoundHandler: setNotFoundHandler,
-    setErrorHandler: setErrorHandler,
+    setNotFoundHandler,
+    setErrorHandler,
     // Set fastify initial configuration options read-only object
     initialConfig
   }
@@ -374,6 +383,15 @@ function fastify (options) {
       if (fastify[kState].listening) {
         // No new TCP connections are accepted
         instance.server.close(done)
+
+        for (const conn of fastify[kKeepAliveConnections]) {
+          // We must invoke the destroy method instead of merely unreffing
+          // the sockets. If we only unref, then the callback passed to
+          // `fastify.close` will never be invoked; nor will any of the
+          // registered `onClose` hooks.
+          conn.destroy()
+          fastify[kKeepAliveConnections].delete(conn)
+        }
       } else {
         done(null)
       }
@@ -520,10 +538,8 @@ function fastify (options) {
     }
 
     if (name === 'onClose') {
-      this[kHooks].validate(name, fn)
       this.onClose(fn)
     } else if (name === 'onReady') {
-      this[kHooks].validate(name, fn)
       this[kHooks].add(name, fn)
     } else {
       this.after((err, done) => {
@@ -578,6 +594,10 @@ function fastify (options) {
   // req and res are Node.js core objects
   function defaultRoute (req, res) {
     if (req.headers['accept-version'] !== undefined) {
+      // we remove the accept-version header for performance result
+      // because we do not want to go through the constraint checking
+      // the usage of symbol here to prevent any colision on custom header name
+      req.headers[kRequestAcceptVersion] = req.headers['accept-version']
       req.headers['accept-version'] = undefined
     }
     fourOhFour.router.lookup(req, res)

package/lib/decorate.js

@@ -134,6 +134,6 @@ module.exports = {
   existRequest: checkRequestExistence,
   existReply: checkReplyExistence,
   dependencies: checkDependencies,
-  decorateReply: decorateReply,
-  decorateRequest: decorateRequest
+  decorateReply,
+  decorateRequest
 }

package/lib/errors.js

@@ -106,7 +106,7 @@ const codes = {
    */
   FST_ERR_MISSING_MIDDLEWARE: createError(
     'FST_ERR_MISSING_MIDDLEWARE',
-    'You must register a plugin for handling middlewares, visit fastify.io/docs/latest/Middleware/ for more info.',
+    'You must register a plugin for handling middlewares, visit fastify.io/docs/latest/Reference/Middleware/ for more info.',
     500
   ),
 
@@ -210,6 +210,11 @@ const codes = {
     500,
     TypeError
   ),
+  FST_ERR_INVALID_URL: createError(
+    'FST_ERR_INVALID_URL',
+    "URL must be a string. Received '%s'",
+    400
+  ),
 
   /**
    *  again listen when close server

package/lib/noop-set.js

@@ -0,0 +1,10 @@
+'use strict'
+
+module.exports = function noopSet () {
+  return {
+    [Symbol.iterator]: function * () {},
+    add () {},
+    delete () {},
+    has () { return true }
+  }
+}

package/lib/pluginUtils.js

@@ -14,6 +14,11 @@ function getMeta (fn) {
 }
 
 function getPluginName (func) {
+  const display = getDisplayName(func)
+  if (display) {
+    return display
+  }
+
   // let's see if this is a file, and in that case use that
   // this is common for plugins
   const cache = require.cache

package/lib/reply.js

@@ -365,12 +365,18 @@ function preserializeHookEnd (err, request, reply, payload) {
     return
   }
 
-  if (reply[kReplySerializer] !== null) {
-    payload = reply[kReplySerializer](payload)
-  } else if (reply.context && reply.context[kReplySerializerDefault]) {
-    payload = reply.context[kReplySerializerDefault](payload, reply.raw.statusCode)
-  } else {
-    payload = serialize(reply.context, payload, reply.raw.statusCode)
+  try {
+    if (reply[kReplySerializer] !== null) {
+      payload = reply[kReplySerializer](payload)
+    } else if (reply.context && reply.context[kReplySerializerDefault]) {
+      payload = reply.context[kReplySerializerDefault](payload, reply.raw.statusCode)
+    } else {
+      payload = serialize(reply.context, payload, reply.raw.statusCode)
+    }
+  } catch (e) {
+    wrapSeralizationError(e, reply)
+    onErrorHook(reply, e)
+    return
   }
 
   flatstr(payload)
@@ -378,6 +384,10 @@ function preserializeHookEnd (err, request, reply, payload) {
   onSendHook(reply, payload)
 }
 
+function wrapSeralizationError (error, reply) {
+  error.serialization = reply.context.config
+}
+
 function onSendHook (reply, payload) {
   if (reply.context.onSend !== null) {
     reply[kReplySent] = true
@@ -569,11 +579,11 @@ function handleError (reply, error, cb) {
     const serializerFn = getSchemaSerializer(reply.context, statusCode)
     payload = (serializerFn === false)
       ? serializeError({
-          error: statusCodes[statusCode + ''],
-          code: error.code,
-          message: error.message || '',
-          statusCode: statusCode
-        })
+        error: statusCodes[statusCode + ''],
+        code: error.code,
+        message: error.message || '',
+        statusCode
+      })
       : serializerFn(Object.create(error, {
         error: { value: statusCodes[statusCode + ''] },
         message: { value: error.message || '' },

package/lib/route.js

@@ -8,6 +8,7 @@ const supportedMethods = ['DELETE', 'GET', 'HEAD', 'PATCH', 'POST', 'PUT', 'OPTI
 const { normalizeSchema } = require('./schemas')
 const { parseHeadOnSendHandlers } = require('./headRoute')
 const warning = require('./warnings')
+const { kRequestAcceptVersion } = require('./symbols')
 
 const {
   compileSchemasForValidation,
@@ -17,7 +18,8 @@ const {
 const {
   FST_ERR_SCH_VALIDATION_BUILD,
   FST_ERR_SCH_SERIALIZATION_BUILD,
-  FST_ERR_DEFAULT_ROUTE_INVALID_TYPE
+  FST_ERR_DEFAULT_ROUTE_INVALID_TYPE,
+  FST_ERR_INVALID_URL
 } = require('./errors')
 
 const {
@@ -40,6 +42,7 @@ const {
 } = require('./symbols.js')
 
 function buildRouting (options) {
+  const { keepAliveConnections } = options
   const router = FindMyWay(options.config)
 
   let avvio
@@ -97,6 +100,10 @@ function buildRouting (options) {
 
   // Convert shorthand to extended route declaration
   function prepareRoute (method, url, options, handler) {
+    if (typeof url !== 'string') {
+      throw new FST_ERR_INVALID_URL(typeof url)
+    }
+
     if (!handler && typeof options === 'function') {
       handler = options // for support over direct function calls such as fastify.get() options are reused as the handler
       options = {}
@@ -344,6 +351,23 @@ function buildRouting (options) {
       }
     }
 
+    // When server.forceCloseConnections is true, we will collect any requests
+    // that have indicated they want persistence so that they can be reaped
+    // on server close. Otherwise, the container is a noop container.
+    const connHeader = String.prototype.toLowerCase.call(req.headers.connection || '')
+    if (connHeader === 'keep-alive') {
+      if (keepAliveConnections.has(req.socket) === false) {
+        keepAliveConnections.add(req.socket)
+        req.socket.on('close', removeTrackedSocket.bind({ keepAliveConnections, socket: req.socket }))
+      }
+    }
+
+    // we revert the changes in defaultRoute
+    if (req.headers[kRequestAcceptVersion] !== undefined) {
+      req.headers['accept-version'] = req.headers[kRequestAcceptVersion]
+      req.headers[kRequestAcceptVersion] = undefined
+    }
+
     const id = req.headers[requestIdHeader] || genReqId(req)
 
     const loggerBinding = {
@@ -478,6 +502,15 @@ function preParsingHookRunner (functions, request, reply, cb) {
   next(null, request[kRequestPayloadStream])
 }
 
+/**
+ * Used within the route handler as a `net.Socket.close` event handler.
+ * The purpose is to remove a socket from the tracked sockets collection when
+ * the socket has naturally timed out.
+ */
+function removeTrackedSocket () {
+  this.keepAliveConnections.delete(this.socket)
+}
+
 function noop () { }
 
 module.exports = { buildRouting, validateBodyLimitOption }

package/lib/schema-controller.js

@@ -25,7 +25,7 @@ function buildSchemaController (parentSchemaCtrl, opts) {
 
   const option = {
     bucket: (opts && opts.bucket) || buildSchemas,
-    compilersFactory: compilersFactory
+    compilersFactory
   }
 
   return new SchemaController(undefined, option)

package/lib/server.js

@@ -52,7 +52,7 @@ function createServer (options, httpHandler) {
       }
 
       const cb = typeof args[args.length - 1] === 'function' ? args.pop() : undefined
-      const options = { cb: cb }
+      const options = { cb }
 
       const firstArg = args[0]
       const argsLength = args.length

package/lib/symbols.js

@@ -21,6 +21,7 @@ const keys = {
   kReply: Symbol('fastify.Reply'),
   kRequest: Symbol('fastify.Request'),
   kRequestPayloadStream: Symbol('fastify.RequestPayloadStream'),
+  kRequestAcceptVersion: Symbol('fastify.RequestAcceptVersion'),
   kCanSetNotFoundHandler: Symbol('fastify.canSetNotFoundHandler'),
   kFourOhFour: Symbol('fastify.404'),
   kFourOhFourLevelInstance: Symbol('fastify.404LogLevelInstance'),
@@ -43,7 +44,8 @@ const keys = {
   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'),
-  kErrorHandler: Symbol('fastify.errorHandler')
+  kErrorHandler: Symbol('fastify.errorHandler'),
+  kKeepAliveConnections: Symbol('fastify.keepAliveConnections')
 }
 
 module.exports = keys

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fastify",
-  "version": "3.25.3",
+  "version": "3.27.2",
   "description": "Fast and low overhead web framework, for Node.js",
   "main": "fastify.js",
   "type": "commonjs",
@@ -12,11 +12,11 @@
     "license-checker": "license-checker --production --onlyAllow=\"MIT;ISC;BSD-3-Clause;BSD-2-Clause\"",
     "lint": "npm run lint:standard && npm run lint:typescript",
     "lint:fix": "standard --fix",
-    "lint:standard": "standard --verbose | snazzy",
+    "lint:standard": "standard | snazzy",
     "lint:typescript": "eslint -c types/.eslintrc.json types/**/*.d.ts test/types/**/*.test-d.ts",
     "prepublishOnly": "tap --no-check-coverage test/internals/version.test.js",
     "test": "npm run lint && npm run unit && npm run test:typescript",
-    "test:ci": "npm run lint && npm run unit -- --cov --coverage-report=lcovonly && npm run test:typescript",
+    "test:ci": "npm run unit -- -R terse --cov --coverage-report=lcovonly && npm run test:typescript",
     "test:report": "npm run lint && npm run unit:report && npm run test:typescript",
     "test:typescript": "tsd",
     "unit": "tap -J test/*.test.js test/*/*.test.js",
@@ -124,11 +124,12 @@
     "@fastify/ajv-compiler-8": "npm:@fastify/ajv-compiler@^2.0.0",
     "@fastify/pre-commit": "^2.0.1",
     "@hapi/joi": "^17.1.1",
-    "@sinonjs/fake-timers": "^8.1.0",
+    "@sinonjs/fake-timers": "^9.1.0",
     "@types/node": "^16.0.0",
     "@types/pino": "^6.0.1",
-    "@typescript-eslint/eslint-plugin": "^4.5.0",
-    "@typescript-eslint/parser": "^4.5.0",
+    "@typescript-eslint/eslint-plugin": "^5.0.0",
+    "@typescript-eslint/parser": "^5.0.0",
+    "JSONStream": "^1.3.5",
     "ajv": "^6.0.0",
     "ajv-errors": "^1.0.1",
     "ajv-formats": "^2.1.1",
@@ -139,25 +140,23 @@
     "cors": "^2.8.5",
     "coveralls": "^3.1.0",
     "dns-prefetch-control": "^0.3.0",
-    "eslint": "^7.11.0",
-    "eslint-config-standard": "^16.0.1",
+    "eslint": "^8.0.1",
+    "eslint-config-standard": "^17.0.0-1",
     "eslint-import-resolver-node": "^0.3.2",
-    "eslint-plugin-import": "^2.20.2",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^5.1.0",
-    "eslint-plugin-standard": "^5.0.0",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-n": "^14.0.0",
+    "eslint-plugin-promise": "^6.0.0",
     "fast-json-body": "^1.1.0",
     "fastify-plugin": "^3.0.0",
     "fluent-json-schema": "^3.0.0",
     "form-data": "^4.0.0",
     "frameguard": "^4.0.0",
     "h2url": "^0.2.0",
-    "helmet": "^4.0.0",
+    "helmet": "^5.0.1",
     "hide-powered-by": "^1.1.0",
     "hsts": "^2.2.0",
     "http-errors": "^2.0.0",
     "ienoopen": "^1.1.0",
-    "JSONStream": "^1.3.5",
     "license-checker": "^25.0.1",
     "pem": "^1.14.4",
     "proxyquire": "^2.1.3",
@@ -167,13 +166,13 @@
     "simple-get": "^4.0.0",
     "snazzy": "^9.0.0",
     "split2": "^4.1.0",
-    "standard": "^16.0.1",
+    "standard": "^17.0.0-2",
     "tap": "^15.1.1",
     "tap-mocha-reporter": "^5.0.1",
     "then-sleep": "^1.0.1",
     "tsd": "^0.19.0",
     "typescript": "^4.0.2",
-    "undici": "^3.3.5",
+    "undici": "^3.3.6",
     "x-xss-protection": "^2.0.0",
     "yup": "^0.32.0"
   },
@@ -192,7 +191,7 @@
     "rfdc": "^1.1.4",
     "secure-json-parse": "^2.0.0",
     "semver": "^7.3.2",
-    "tiny-lru": "^7.0.0"
+    "tiny-lru": "^8.0.1"
   },
   "standard": {
     "ignore": [

package/test/404s.test.js

@@ -1221,7 +1221,7 @@ test('preHandler option for setNotFoundHandler', t => {
   })
 
   // https://github.com/fastify/fastify/issues/2229
-  t.test('preHandler hook in setNotFoundHandler should be called when callNotFound', t => {
+  t.test('preHandler hook in setNotFoundHandler should be called when callNotFound', { timeout: 40000 }, t => {
     t.plan(2)
     const fastify = Fastify()
 
@@ -1772,3 +1772,27 @@ test('setNotFoundHandler should be chaining fastify instance', t => {
 
   t.end()
 })
+
+test('Send 404 when frameworkError calls reply.callNotFound', t => {
+  t.test('Dynamic route', t => {
+    t.plan(4)
+    const fastify = Fastify({
+      logger: true,
+      frameworkErrors: (error, req, reply) => {
+        t.equal(error.message, "'%world' is not a valid url component")
+        return reply.callNotFound()
+      }
+    })
+    fastify.get('/hello/:id', () => t.fail('we should not be here'))
+    fastify.inject({
+      url: '/hello/%world',
+      method: 'GET'
+    }, (err, response) => {
+      t.error(err)
+      t.equal(response.statusCode, 404)
+      t.equal(response.payload, '404 Not Found')
+    })
+  })
+
+  t.end()
+})

package/test/async-await.test.js

@@ -407,7 +407,7 @@ test('error is logged because promise was fulfilled with undefined', t => {
   try {
     fastify = Fastify({
       logger: {
-        stream: stream,
+        stream,
         level: 'error'
       }
     })
@@ -447,7 +447,7 @@ test('error is not logged because promise was fulfilled with undefined but statu
   try {
     fastify = Fastify({
       logger: {
-        stream: stream,
+        stream,
         level: 'error'
       }
     })
@@ -488,7 +488,7 @@ test('error is not logged because promise was fulfilled with undefined but respo
   try {
     fastify = Fastify({
       logger: {
-        stream: stream,
+        stream,
         level: 'error'
       }
     })

package/test/bundler/esbuild/bundler-test.js

@@ -0,0 +1,31 @@
+'use strict'
+
+const t = require('tap')
+const test = t.test
+const fastifySuccess = require('./dist/success')
+const fastifyFailPlugin = require('./dist/failPlugin')
+
+test('Bundled package should work', (t) => {
+  t.plan(4)
+  fastifySuccess.ready((err) => {
+    t.error(err)
+    fastifySuccess.inject(
+      {
+        method: 'GET',
+        url: '/'
+      },
+      (error, res) => {
+        t.error(error)
+        t.equal(res.statusCode, 200)
+        t.same(res.json(), { hello: 'world' })
+      }
+    )
+  })
+})
+
+test('Bundled package should not work with bad plugin version', (t) => {
+  t.plan(1)
+  fastifyFailPlugin.ready((err) => {
+    t.match(err.message, /expected '9.x' fastify version/i)
+  })
+})

package/test/bundler/esbuild/package.json

@@ -0,0 +1,10 @@
+{
+  "version": "0.0.1",
+  "scripts": {
+    "bundle": "esbuild success=src/index.js failPlugin=src/fail-plugin-version.js --bundle  --outdir=dist --platform=node",
+    "test": "npm run bundle && node bundler-test.js"
+  },
+  "devDependencies": {
+    "esbuild": "^0.14.11"
+  }
+}

package/test/bundler/esbuild/src/fail-plugin-version.js

@@ -0,0 +1,12 @@
+const fp = require('fastify-plugin')
+const fastify = require('../../../../')()
+
+fastify.get('/', function (request, reply) {
+  reply.send({ hello: 'world' })
+})
+
+fastify.register(fp((instance, opts, done) => {
+  done()
+}, { fastify: '9.x' }))
+
+module.exports = fastify

package/test/bundler/esbuild/src/index.js

@@ -0,0 +1,7 @@
+const fastify = require('../../../../')()
+// Declare a route
+fastify.get('/', function (request, reply) {
+  reply.send({ hello: 'world' })
+})
+
+module.exports = fastify

package/test/bundler/webpack/bundler-test.js

@@ -5,16 +5,27 @@ const test = t.test
 const fastifySuccess = require('./dist/success')
 const fastifyFailPlugin = require('./dist/failPlugin')
 
-test('Bundled package should work', t => {
-  t.plan(1)
+test('Bundled package should work', (t) => {
+  t.plan(4)
   fastifySuccess.ready((err) => {
     t.error(err)
+    fastifySuccess.inject(
+      {
+        method: 'GET',
+        url: '/'
+      },
+      (error, res) => {
+        t.error(error)
+        t.equal(res.statusCode, 200)
+        t.same(res.json(), { hello: 'world' })
+      }
+    )
   })
 })
 
-test('Bundled package should not work with bad plugin version', t => {
+test('Bundled package should not work with bad plugin version', (t) => {
   t.plan(1)
   fastifyFailPlugin.ready((err) => {
-    t.ok(err)
+    t.match(err.message, /expected '9.x' fastify version/i)
   })
 })

package/test/bundler/webpack/src/fail-plugin-version.js

@@ -1,7 +1,5 @@
 const fp = require('fastify-plugin')
-const fastify = require('../../../../')({
-  logger: true
-})
+const fastify = require('../../../../')()
 
 fastify.get('/', function (request, reply) {
   reply.send({ hello: 'world' })

package/test/bundler/webpack/src/index.js

@@ -1,6 +1,4 @@
-const fastify = require('../../../../')({
-  logger: true
-})
+const fastify = require('../../../../')()
 // Declare a route
 fastify.get('/', function (request, reply) {
   reply.send({ hello: 'world' })