fastify 3.25.0 → 3.26.0

package/docs/Reference/Index.md

@@ -44,7 +44,7 @@ This table of contents is in alphabetical order.
   standard set of errors Fastify generates.
 + [Hooks](./Hooks.md): Details the API by which Fastify plugins can inject
   themselves into Fastify's handling of the request lifecycle.
-+ [HTTP2](/./HTTP2.md): Details Fastify's HTTP2 support.
++ [HTTP2](./HTTP2.md): Details Fastify's HTTP2 support.
 + [Lifecycle](./Lifecycle.md): Explains the Fastify request lifecycle and
   illustrates where [Hooks](./Hooks.md) are available for integrating with it.
 + [Logging](./Logging.md): Details Fastify's included logging and how to

package/docs/Reference/Plugins.md

@@ -12,7 +12,7 @@ feature allows us to achieve plugin *encapsulation* and *inheritance*, in this
 way we create a *direct acyclic graph* (DAG) and we will not have issues caused
 by cross dependencies.
 
-You already see in the [getting started](../Guides/Getting-Started.md#register)
+You already see in the [getting started](../Guides/Getting-Started.md#your-first-plugin)
 section how using this API is pretty straightforward.
 ```
 fastify.register(plugin, [options])
@@ -30,7 +30,7 @@ Fastify specific options is:
 
 + [`logLevel`](./Routes.md#custom-log-level)
 + [`logSerializers`](./Routes.md#custom-log-serializer)
-+ [`prefix`](#route-prefixing-options)
++ [`prefix`](#route-prefixing-option)
 
 **Note: Those options will be ignored when used with fastify-plugin**
 
@@ -181,7 +181,7 @@ callback.
 Example:
 ```js
 module.exports = function (fastify, opts, done) {
-  fastify.decorate('utility', () => {})
+  fastify.decorate('utility', function () {})
 
   fastify.get('/', handler)
 
@@ -191,7 +191,7 @@ module.exports = function (fastify, opts, done) {
 You can also use `register` inside another `register`:
 ```js
 module.exports = function (fastify, opts, done) {
-  fastify.decorate('utility', () => {})
+  fastify.decorate('utility', function () {})
 
   fastify.get('/', handler)
 
@@ -226,7 +226,7 @@ plugin will support.
 const fp = require('fastify-plugin')
 
 module.exports = fp(function (fastify, opts, done) {
-  fastify.decorate('utility', () => {})
+  fastify.decorate('utility', function () {})
   done()
 }, '0.x')
 ```
@@ -239,7 +239,7 @@ changes it will be your responsibility to update the module, while if you use
 `fastify-plugin`, you can be sure about backward compatibility.
 ```js
 function yourPlugin (fastify, opts, done) {
-  fastify.decorate('utility', () => {})
+  fastify.decorate('utility', function () {})
   done()
 }
 yourPlugin[Symbol.for('skip-override')] = true

package/docs/Reference/Reply.md

@@ -67,7 +67,7 @@ object that exposes the following functions and properties:
   from Node core.
 - `.log` - The logger instance of the incoming request.
 - `.request` - The incoming request.
-- `.context` - Access the [Request's context](./Request.md#Request) property.
+- `.context` - Access the [Request's context](./Request.md) property.
 
 ```js
 fastify.get('/', options, function (request, reply) {
@@ -510,7 +510,7 @@ fastify.setNotFoundHandler(function (request, reply) {
 <a id="payload-type"></a>
 
 The type of the sent payload (after serialization and going through any
-[`onSend` hooks](./Hooks.md#the-onsend-hook)) must be one of the following
+[`onSend` hooks](./Hooks.md#onsend)) must be one of the following
 types, otherwise, an error will be thrown:
 
 - `string`

package/docs/Reference/Request.md

@@ -57,6 +57,9 @@ This operation will add to the request headers the new values that can be read
 calling `request.headers.bar`. Moreover, you can still access the standard
 request's headers with the `request.raw.headers` property.
 
+> Note: For performance reason on `not found` route, you may see that we will add
+an extra property `Symbol('fastify.RequestAcceptVersion')` on the headers.
+
 ```js
 fastify.post('/:params', options, function (request, reply) {
   console.log(request.body)

package/docs/Reference/Routes.md

@@ -82,7 +82,7 @@ fastify.route(options)
   called. Note: using an arrow function will break the binding of `this`.
 * `errorHandler(error, request, reply)`: a custom error handler for the scope of
   the request. Overrides the default error global handler, and anything set by
-  [`setErrorHandler`](./Server.md#setErrorHandler), for requests to the route.
+  [`setErrorHandler`](./Server.md#seterrorhandler), for requests to the route.
   To access the default handler, you can access `instance.errorHandler`. Note
   that this will point to fastify's default `errorHandler` only if a plugin
   hasn't overridden it already.
@@ -107,7 +107,7 @@ fastify.route(options)
 * `logSerializers`: set serializers to log for this route.
 * `config`: object used to store custom configuration.
 * `version`: a [semver](https://semver.org/) compatible string that defined the
-  version of the endpoint. [Example](#version).
+  version of the endpoint. [Example](#version-constraints).
 * `prefixTrailingSlash`: string used to determine how to handle passing `/` as a
   route with a prefix.
   * `both` (default): Will register both `/prefix` and `/prefix/`.
@@ -437,7 +437,7 @@ the global Fastify Logger, accessible with `fastify.log`*
 
 In some context, you may need to log a large object but it could be a waste of
 resources for some routes. In this case, you can define some
-[`serializer`](https://github.com/pinojs/pino/blob/master/docs/api.md#bindingsserializers-object)
+[`serializer`](https://github.com/pinojs/pino/blob/master/docs/api.md#serializers-object)
 and attach them in the right context!
 
 ```js

package/docs/Reference/Server.md

@@ -207,7 +207,7 @@ Defines the maximum payload, in bytes, the server is allowed to accept.
 Defines what action the framework must take when parsing a JSON object with
 `__proto__`. This functionality is provided by
 [secure-json-parse](https://github.com/fastify/secure-json-parse). See
-https://hueniverse.com/a-tale-of-prototype-poisoning-2610fa170061 for more
+[Prototype Poisoning](../Guides/Prototype-Poisoning.md) for more
 details about prototype poisoning attacks.
 
 Possible values are `'error'`, `'remove'` and `'ignore'`.
@@ -220,7 +220,7 @@ Possible values are `'error'`, `'remove'` and `'ignore'`.
 Defines what action the framework must take when parsing a JSON object with
 `constructor`. This functionality is provided by
 [secure-json-parse](https://github.com/fastify/secure-json-parse). See
-https://hueniverse.com/a-tale-of-prototype-poisoning-2610fa170061 for more
+[Prototype Poisoning](../Guides/Prototype-Poisoning.md) for more
 details about prototype poisoning attacks.
 
 Possible values are `'error'`, `'remove'` and `'ignore'`.
@@ -1075,7 +1075,7 @@ used by plugins.
 #### inject
 <a id="inject"></a>
 
-Fake HTTP injection (for testing purposes) [here](../Guides/Testing.md#inject).
+Fake HTTP injection (for testing purposes) [here](../Guides/Testing.md#benefits-of-using-fastifyinject).
 
 #### addSchema
 <a id="add-schema"></a>
@@ -1291,8 +1291,8 @@ handler so requests will go through the full [Fastify
 lifecycle](./Lifecycle.md#lifecycle).
 
 You can also register
-[`preValidation`](https://www.fastify.io/docs/latest/Hooks/#route-hooks) and
-[`preHandler`](https://www.fastify.io/docs/latest/Hooks/#route-hooks) hooks for
+[`preValidation`](./Hooks.md#route-hooks) and
+[`preHandler`](./Hooks.md#route-hooks) hooks for
 the 404 handler.
 
 _Note: The `preValidation` hook registered using this method will run for a
@@ -1402,7 +1402,7 @@ fastify.ready(() => {
 the `route.store` object for each displayed route. This can be an `array` of
 keys (e.g. `['onRequest', Symbol('key')]`), or `true` to display all properties.
 A shorthand option, `fastify.printRoutes({ includeHooks: true })` will include
-all [hooks](https://www.fastify.io/docs/latest/Hooks/).
+all [hooks](./Hooks.md).
 
 ```js
   console.log(fastify.printRoutes({ includeHooks: true, includeMeta: ['metaProperty'] }))

package/docs/Reference/TypeScript.md

@@ -51,9 +51,6 @@ in a blank http Fastify server.
   }
   ```
 
-*Note: Set `target` property in `tsconfig.json` to `es2017` or greater to avoid
-[FastifyDeprecation](https://github.com/fastify/fastify/issues/3284) warning.*
-
 3. Initialize a TypeScript configuration file:
   ```bash
   npx tsc --init
@@ -61,6 +58,9 @@ in a blank http Fastify server.
   or use one of the [recommended
   ones](https://github.com/tsconfig/bases#node-10-tsconfigjson).
 
+*Note: Set `target` property in `tsconfig.json` to `es2017` or greater to avoid
+[FastifyDeprecation](https://github.com/fastify/fastify/issues/3284) warning.*
+
 4. Create an `index.ts` file - this will contain the server code
 5. Add the following code block to your file:
    ```typescript
@@ -228,8 +228,8 @@ can do it as follows:
           },
         },
       },
-      (req, rep) => {
-        const { body: user } = req;
+      (request, reply) => {
+        const { body: user } = request;
         /* user has type
         * const user: StaticProperties<{
         *  name: TString;
@@ -237,7 +237,7 @@ can do it as follows:
         * }>
         */
         //...
-        rep.status(200).send(user);
+        reply.status(200).send(user);
       }
     );
     ```
@@ -1384,7 +1384,7 @@ body parsing happens before the `preHandler` hook.
 
 [src](https://github.com/fastify/fastify/blob/main/types/hooks.d.ts#L35)
 
-preParsing` is the second hook to be executed in the request lifecycle. The
+`preParsing` is the second hook to be executed in the request lifecycle. The
 previous hook was `onRequest`, the next hook will be `preValidation`.
 
 Notice: in the `preParsing` hook, request.body will always be null, because the

package/docs/Reference/Validation-and-Serialization.md

@@ -713,7 +713,7 @@ fastify.setSchemaErrorFormatter(function (errors, dataVar) {
 ```
 
 You can also use
-[setErrorHandler](https://www.fastify.io/docs/latest/Server/#seterrorhandler) to
+[setErrorHandler](./Server.md#seterrorhandler) to
 define a custom response for validation errors such as
 
 ```js

package/docs/index.md

@@ -5,7 +5,7 @@ The documentation for Fastify is split into two categories:
 - [Reference documentation](./Reference/Index.md)
 - [Guides](./Guides/Index.md)
 
-The reference documenation utilizes a very formal style in an effort to document
+The reference documentation utilizes a very formal style in an effort to document
 Fastify's API and implementation details thoroughly for the developer who needs
 such. The guides category utilizes an informal, educational, style as a means to
 introduce newcomers to core, and advanced, Fastify concepts.

package/fastify.d.ts

@@ -144,7 +144,7 @@ export type FastifyServerOptions<
   return503OnClosing?: boolean,
   ajv?: {
     customOptions?: AjvOptions,
-    plugins?: Function[]
+    plugins?: (Function | [Function, unknown])[]
   },
   frameworkErrors?: <RequestGeneric extends RequestGenericInterface = RequestGenericInterface>(
     error: FastifyError,

package/fastify.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const VERSION = '3.25.0'
+const VERSION = '3.26.0'
 
 const Avvio = require('avvio')
 const http = require('http')
@@ -16,6 +16,7 @@ const {
   kLogSerializers,
   kHooks,
   kSchemaController,
+  kRequestAcceptVersion,
   kReplySerializerDefault,
   kContentTypeParser,
   kReply,
@@ -520,10 +521,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 +577,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/contentTypeParser.js

@@ -1,5 +1,6 @@
 'use strict'
 
+const { AsyncResource } = require('async_hooks')
 let lru = require('tiny-lru')
 // Needed to handle Webpack and faux modules
 // See https://github.com/fastify/fastify/issues/2356
@@ -137,6 +138,7 @@ ContentTypeParser.prototype.remove = function (contentType) {
 
 ContentTypeParser.prototype.run = function (contentType, handler, request, reply) {
   const parser = this.cache.get(contentType) || this.getParser(contentType)
+  const resource = new AsyncResource('content-type-parser:run', request)
 
   if (parser === undefined) {
     reply.send(new FST_ERR_CTP_INVALID_MEDIA_TYPE(contentType))
@@ -163,12 +165,15 @@ ContentTypeParser.prototype.run = function (contentType, handler, request, reply
   }
 
   function done (error, body) {
-    if (error) {
-      reply.send(error)
-    } else {
-      request.body = body
-      handler(request, reply)
-    }
+    // We cannot use resource.bind() because it is broken in node v12.
+    resource.runInAsyncScope(() => {
+      if (error) {
+        reply.send(error)
+      } else {
+        request.body = body
+        handler(request, reply)
+      }
+    })
   }
 }
 

package/lib/decorate.js

@@ -68,7 +68,7 @@ function decorateFastify (name, fn, dependencies) {
 
 function checkExistence (instance, name) {
   if (name) {
-    return name in instance || hasKey(instance, name)
+    return name in instance || (instance.prototype && name in instance.prototype) || hasKey(instance, name)
   }
 
   return instance in this

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/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,
@@ -344,6 +345,12 @@ function buildRouting (options) {
       }
     }
 
+    // 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 = {

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'),

package/lib/warnings.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const warning = require('fastify-warning')()
+const warning = require('process-warning')()
 
 /**
  * Deprecation codes:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fastify",
-  "version": "3.25.0",
+  "version": "3.26.0",
   "description": "Fast and low overhead web framework, for Node.js",
   "main": "fastify.js",
   "type": "commonjs",
@@ -16,7 +16,7 @@
     "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 -- --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",
@@ -152,10 +152,10 @@
     "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": "^1.7.1",
+    "http-errors": "^2.0.0",
     "ienoopen": "^1.1.0",
     "JSONStream": "^1.3.5",
     "license-checker": "^25.0.1",
@@ -183,8 +183,8 @@
     "avvio": "^7.1.2",
     "fast-json-stringify": "^2.5.2",
     "fastify-error": "^0.3.0",
-    "fastify-warning": "^0.2.0",
-    "find-my-way": "^4.1.0",
+    "process-warning": "^1.0.0",
+    "find-my-way": "^4.5.0",
     "flatstr": "^1.0.12",
     "light-my-request": "^4.2.0",
     "pino": "^6.13.0",

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()
 

package/test/als.test.js

@@ -0,0 +1,74 @@
+'use strict'
+
+const { AsyncLocalStorage } = require('async_hooks')
+const t = require('tap')
+const Fastify = require('..')
+const sget = require('simple-get').concat
+
+if (!AsyncLocalStorage) {
+  t.skip('AsyncLocalStorage not available, skipping test')
+  process.exit(0)
+}
+
+const storage = new AsyncLocalStorage()
+const app = Fastify({ logger: false })
+
+let counter = 0
+app.addHook('onRequest', (req, reply, next) => {
+  const id = counter++
+  storage.run({ id }, next)
+})
+
+app.get('/', function (request, reply) {
+  t.ok(storage.getStore())
+  const id = storage.getStore().id
+  reply.send({ id })
+})
+
+app.post('/', function (request, reply) {
+  t.ok(storage.getStore())
+  const id = storage.getStore().id
+  reply.send({ id })
+})
+
+app.listen(3000, function (err, address) {
+  t.error(err)
+
+  sget({
+    method: 'POST',
+    url: 'http://localhost:' + app.server.address().port,
+    body: {
+      hello: 'world'
+    },
+    json: true
+  }, (err, response, body) => {
+    t.error(err)
+    t.equal(response.statusCode, 200)
+    t.same(body, { id: 0 })
+
+    sget({
+      method: 'POST',
+      url: 'http://localhost:' + app.server.address().port,
+      body: {
+        hello: 'world'
+      },
+      json: true
+    }, (err, response, body) => {
+      t.error(err)
+      t.equal(response.statusCode, 200)
+      t.same(body, { id: 1 })
+
+      sget({
+        method: 'GET',
+        url: 'http://localhost:' + app.server.address().port,
+        json: true
+      }, (err, response, body) => {
+        t.error(err)
+        t.equal(response.statusCode, 200)
+        t.same(body, { id: 2 })
+        app.close()
+        t.end()
+      })
+    })
+  })
+})

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' })