fastify 4.6.0 → 4.8.0

package/docs/Guides/Ecosystem.md

@@ -80,6 +80,8 @@ section.
   [Next](https://github.com/zeit/next.js/).
 - [`@fastify/oauth2`](https://github.com/fastify/fastify-oauth2) Wrap around
   [`simple-oauth2`](https://github.com/lelylan/simple-oauth2).
+- [`@fastify/one-line-logger`](https://github.com/fastify/one-line-logger) Formats
+  Fastify's logs into a nice one-line message.
 - [`@fastify/postgres`](https://github.com/fastify/fastify-postgres) Fastify
   PostgreSQL connection plugin, with this you can share the same PostgreSQL
   connection pool in every part of your server.
@@ -119,10 +121,10 @@ section.
 - [`@fastify/type-provider-json-schema-to-ts`](https://github.com/fastify/fastify-type-provider-json-schema-to-ts)
   Fastify
   [type provider](https://www.fastify.io/docs/latest/Reference/Type-Providers/)
-  for [json-schema-to-ts](https://github.com/ThomasAribart/json-schema-to-ts). 
+  for [json-schema-to-ts](https://github.com/ThomasAribart/json-schema-to-ts).
 - [`@fastify/type-provider-typebox`](https://github.com/fastify/fastify-type-provider-typebox)
   Fastify
-  [type provider](https://www.fastify.io/docs/latest/Reference/Type-Providers/) 
+  [type provider](https://www.fastify.io/docs/latest/Reference/Type-Providers/)
   for [Typebox](https://github.com/sinclairzx81/typebox).
 - [`@fastify/under-pressure`](https://github.com/fastify/under-pressure) Measure
   process load with automatic handling of _"Service Unavailable"_ plugin for
@@ -167,7 +169,7 @@ section.
   Sentry errors handler that just works! Install, add your DSN and you're good
   to go!
 - [`@mateonunez/fastify-lyra`](https://github.com/mateonunez/fastify-lyra)
-  A plugin to implement [Lyra](https://github.com/nearform/lyra) search engine 
+  A plugin to implement [Lyra](https://github.com/nearform/lyra) search engine
   on Fastify
 - [`@mgcrea/fastify-graceful-exit`](https://github.com/mgcrea/fastify-graceful-exit)
   A plugin to close the server gracefully
@@ -191,7 +193,7 @@ section.
 - [`cls-rtracer`](https://github.com/puzpuzpuz/cls-rtracer) Fastify middleware
   for CLS-based request ID generation. An out-of-the-box solution for adding
   request IDs into your logs.
-- [`electron-server`](https://github.com/anonrig/electron-server) A plugin for 
+- [`electron-server`](https://github.com/anonrig/electron-server) A plugin for
   using Fastify without the need of consuming a port on Electron apps.
 - [`fast-water`](https://github.com/tswayne/fast-water) A Fastify plugin for
   waterline. Decorates Fastify with waterline models.
@@ -446,7 +448,7 @@ section.
   OrientDB connection plugin, with which you can share the OrientDB connection
   across every part of your server.
 - [`fastify-osm`](https://github.com/gzileni/fastify-osm) Fastify
-  OSM plugin to run overpass queries by OpenStreetMap.  
+  OSM plugin to run overpass queries by OpenStreetMap.
 - [`fastify-peekaboo`](https://github.com/simone-sanfratello/fastify-peekaboo)
   Fastify plugin for memoize responses by expressive settings.
 - [`fastify-piscina`](https://github.com/piscinajs/fastify-piscina) A worker
@@ -466,11 +468,14 @@ section.
   Fastify and protobufjs, together at last. Uses protobufjs by default.
 - [`fastify-qrcode`](https://github.com/chonla/fastify-qrcode) This plugin
   utilizes [qrcode](https://github.com/soldair/node-qrcode) to generate QR Code.
-- [`fastify-qs`](https://github.com/webdevium/fastify-qs) A plugin for Fastify
+- [`fastify-qs`](https://github.com/vanodevium/fastify-qs) A plugin for Fastify
   that adds support for parsing URL query parameters with
   [qs](https://github.com/ljharb/qs).
 - [`fastify-racing`](https://github.com/metcoder95/fastify-racing) Fastify's
   plugin that adds support to handle an aborted request asynchronous.
+- [`fastify-ravendb`](https://github.com/nearform/fastify-ravendb) RavenDB
+  connection plugin. It exposes the same `DocumentStore` (or multiple ones)
+  across the whole Fastify application.
 - [`fastify-raw-body`](https://github.com/Eomm/fastify-raw-body) Add the
   `request.rawBody` field.
 - [`fastify-rbac`](https://gitlab.com/m03geek/fastify-rbac) Fastify role-based
@@ -496,7 +501,9 @@ section.
 - [`fastify-rob-config`](https://github.com/jeromemacias/fastify-rob-config)
   Fastify Rob-Config integration.
 - [`fastify-route-group`](https://github.com/TakNePoidet/fastify-route-group)
-  Convenient grouping and inheritance of routes
+  Convenient grouping and inheritance of routes.
+- [`fastify-s3-buckets`](https://github.com/kibertoad/fastify-s3-buckets)
+  Ensure the existence of defined S3 buckets on the application startup.
 - [`fastify-schema-constraint`](https://github.com/Eomm/fastify-schema-constraint)
   Choose the JSON schema to use based on request parameters.
 - [`fastify-schema-to-typescript`](https://github.com/thomasthiebaud/fastify-schema-to-typescript)
@@ -512,11 +519,15 @@ section.
   `fastify-caching`.
 - [`fastify-slonik`](https://github.com/Unbuttun/fastify-slonik) Fastify Slonik
   plugin, with this you can use slonik in every part of your server.
+- [`fastify-slow-down`](https://github.com/nearform/fastify-slow-down) A plugin 
+  to delay the response from the server.
 - [`fastify-socket.io`](https://github.com/alemagio/fastify-socket.io) a
   Socket.io plugin for Fastify.
 - [`fastify-split-validator`](https://github.com/MetCoder95/fastify-split-validator)
   Small plugin to allow you use multiple validators in one route based on each
   HTTP part of the request.
+- [`fastify-sqlite`](https://github.com/Eomm/fastify-sqlite) connects your
+  application to a sqlite3 database.
 - [`fastify-sse`](https://github.com/lolo32/fastify-sse) to provide Server-Sent
   Events with `reply.sse( … )` to Fastify.
 - [`fastify-sse-v2`](https://github.com/nodefactoryio/fastify-sse-v2) to provide
@@ -541,8 +552,8 @@ section.
 - [`fastify-twitch-ebs-tools`](https://github.com/lukemnet/fastify-twitch-ebs-tools)
   Useful functions for Twitch Extension Backend Services (EBS).
 - [`fastify-type-provider-zod`](https://github.com/turkerdev/fastify-type-provider-zod)
-  Fastify 
-  [type provider](https://www.fastify.io/docs/latest/Reference/Type-Providers/) 
+  Fastify
+  [type provider](https://www.fastify.io/docs/latest/Reference/Type-Providers/)
   for [zod](https://github.com/colinhacks/zod).
 - [`fastify-typeorm-plugin`](https://github.com/inthepocket/fastify-typeorm-plugin)
   Fastify plugin to work with TypeORM.

package/docs/Guides/Plugins-Guide.md

@@ -308,6 +308,50 @@ fastify.get('/plugin2', (request, reply) => {
 ```
 Now your hook will run just for the first route!
 
+An alternative approach is to make use of the [onRoute hook](../Reference/Hooks.md#onroute)
+to customize application routes dynamically from inside the plugin. Every time
+a new route is registered, you can read and modify the route options. For example,
+based on a [route config option](../Reference/Routes.md#routes-options):
+
+```js
+fastify.register((instance, opts, done) => {
+  instance.decorate('util', (request, key, value) => { request[key] = value })
+  
+  function handler(request, reply, done) {
+    instance.util(request, 'timestamp', new Date())
+    done()
+  }
+
+  instance.addHook('onRoute', (routeOptions) => {
+    if (routeOptions.config && routeOptions.config.useUtil === true) {
+      // set or add our handler to the route preHandler hook
+      if (!routeOptions.preHandler) {
+        routeOptions.preHandler = [handler]
+        return
+      }
+      if (Array.isArray(routeOptions.preHandler)) {
+        routeOptions.preHandler.push(handler)
+        return
+      }
+      routeOptions.preHandler = [routeOptions.preHandler, handler]
+    }
+  })
+
+  fastify.get('/plugin1', {config: {useUtil: true}}, (request, reply) => {
+    reply.send(request)
+  })
+
+  fastify.get('/plugin2', (request, reply) => {
+    reply.send(request)
+  })
+
+  done()
+})
+```
+
+This variant becomes extremely useful if you plan to distribute your plugin, as
+described in the next section.
+
 As you probably noticed by now, `request` and `reply` are not the standard
 Nodejs *request* and *response* objects, but Fastify's objects.
 

package/docs/Guides/Testing.md

@@ -243,33 +243,66 @@ after initializing routes and plugins with `fastify.ready()`.
 
 Uses **app.js** from the previous example.
 
-**test-listen.js** (testing with
-[`Request`](https://www.npmjs.com/package/request))
+**test-listen.js** (testing with [`undici`](https://www.npmjs.com/package/undici))
 ```js
 const tap = require('tap')
-const request = require('request')
+const { Client } = require('undici')
 const buildFastify = require('./app')
 
-tap.test('GET `/` route', t => {
-  t.plan(5)
+tap.test('should work with undici', async t => {
+  t.plan(2)
 
   const fastify = buildFastify()
 
-  t.teardown(() => fastify.close())
+  await fastify.listen()
 
-  fastify.listen({ port: 0 }, (err) => {
-    t.error(err)
+   const client = new Client(
+    'http://localhost:' + fastify.server.address().port, {
+      keepAliveTimeout: 10,
+      keepAliveMaxTimeout: 10
+    } 
+  )
 
-    request({
-      method: 'GET',
-      url: 'http://localhost:' + fastify.server.address().port
-    }, (err, response, body) => {
-      t.error(err)
-      t.equal(response.statusCode, 200)
-      t.equal(response.headers['content-type'], 'application/json; charset=utf-8')
-      t.same(JSON.parse(body), { hello: 'world' })
-    })
+  t.teardown(() => {
+    fastify.close()
+    client.close()
   })
+
+  const response = await client.request({ method: 'GET', path: '/' })
+
+  t.equal(await response.body.text(), '{"hello":"world"}')
+  t.equal(response.statusCode, 200)
+})
+```
+
+Alternatively, starting with Node.js 18, 
+[`fetch`](https://nodejs.org/docs/latest-v18.x/api/globals.html#fetch) 
+may be used without requiring any extra dependencies:
+
+**test-listen.js**
+```js
+const tap = require('tap')
+const buildFastify = require('./app')
+
+tap.test('should work with fetch', async t => {
+  t.plan(3)
+
+  const fastify = buildFastify()
+
+  t.teardown(() => fastify.close())
+
+  await fastify.listen()
+  
+  const response = await fetch(
+    'http://localhost:' + fastify.server.address().port
+  )
+
+  t.equal(response.status, 200)
+  t.equal(
+    response.headers.get('content-type'),
+    'application/json; charset=utf-8'
+  )
+  t.has(await response.json(), { hello: 'world' })
 })
 ```
 

package/docs/Reference/Errors.md

@@ -83,15 +83,52 @@ Some things to consider in your custom error handler:
 ### Fastify Error Codes
 <a id="fastify-error-codes"></a>
 
-#### FST_ERR_BAD_URL
-<a id="FST_ERR_BAD_URL"></a>
-
-The router received an invalid url.
-
-<a name="FST_ERR_DUPLICATED_ROUTE"></a>
-#### FST_ERR_DUPLICATED_ROUTE
-
-The HTTP method already has a registered controller for that URL
+You can access `errorCodes` for mapping:
+```js
+// ESM
+import { errorCodes } from 'fastify'
+
+// CommonJs
+const errorCodes = require('fastify').errorCodes
+```
+
+For example:
+```js
+const Fastify = require('./fastify')
+
+// Instantiate the framework
+const fastify = Fastify({
+  logger: true
+})
+
+// Declare a route
+fastify.get('/', function (request, reply) {
+  reply.code('bad status code').send({ hello: 'world' })
+})
+
+fastify.setErrorHandler(function (error, request, reply) {
+  if (error instanceof Fastify.errorCodes.FST_ERR_BAD_STATUS_CODE) {
+    // Log error
+    this.log.error(error)
+    // Send error response
+    reply.status(500).send({ ok: false })
+  }
+})
+
+// Run the server!
+fastify.listen({ port: 3000 }, function (err, address) {
+  if (err) {
+    fastify.log.error(err)
+    process.exit(1)
+  }
+  // Server is now listening on ${address}
+})
+```
+
+#### FST_ERR_NOT_FOUND
+<a id="FST_ERR_NOT_FOUND"></a>
+
+404 Not Found.
 
 <a name="FST_ERR_CTP_ALREADY_PRESENT"></a>
 #### FST_ERR_CTP_ALREADY_PRESENT
@@ -99,130 +136,238 @@ The HTTP method already has a registered controller for that URL
 
 The parser for this content type was already registered.
 
-#### FST_ERR_CTP_BODY_TOO_LARGE
-<a id="FST_ERR_CTP_BODY_TOO_LARGE"></a>
-
-The request body is larger than the provided limit.
+#### FST_ERR_CTP_INVALID_TYPE
+<a id="FST_ERR_CTP_INVALID_TYPE"></a>
 
-This setting can be defined in the Fastify server instance:
-[`bodyLimit`](./Server.md#bodylimit)
+The `Content-Type` should be a string.
 
 #### FST_ERR_CTP_EMPTY_TYPE
 <a id="FST_ERR_CTP_EMPTY_TYPE"></a>
 
 The content type cannot be an empty string.
 
-#### FST_ERR_CTP_INVALID_CONTENT_LENGTH
-<a id="FST_ERR_CTP_INVALID_CONTENT_LENGTH"></a>
-
-Request body size did not match Content-Length.
-
 #### FST_ERR_CTP_INVALID_HANDLER
 <a id="FST_ERR_CTP_INVALID_HANDLER"></a>
 
 An invalid handler was passed for the content type.
 
+#### FST_ERR_CTP_INVALID_PARSE_TYPE
+<a id="FST_ERR_CTP_INVALID_PARSE_TYPE"></a>
+
+The provided parse type is not supported. Accepted values are `string` or
+`buffer`.
+
+#### FST_ERR_CTP_BODY_TOO_LARGE
+<a id="FST_ERR_CTP_BODY_TOO_LARGE"></a>
+
+The request body is larger than the provided limit.
+
+This setting can be defined in the Fastify server instance:
+[`bodyLimit`](./Server.md#bodylimit)
+
 #### FST_ERR_CTP_INVALID_MEDIA_TYPE
 <a id="FST_ERR_CTP_INVALID_MEDIA_TYPE"></a>
 
 The received media type is not supported (i.e. there is no suitable
 `Content-Type` parser for it).
 
-#### FST_ERR_CTP_INVALID_PARSE_TYPE
-<a id="FST_ERR_CTP_INVALID_PARSE_TYPE"></a>
+#### FST_ERR_CTP_INVALID_CONTENT_LENGTH
+<a id="FST_ERR_CTP_INVALID_CONTENT_LENGTH"></a>
 
-The provided parse type is not supported. Accepted values are `string` or
-`buffer`.
+Request body size did not match `Content-Length`.
 
-#### FST_ERR_CTP_INVALID_TYPE
-<a id="FST_ERR_CTP_INVALID_TYPE"></a>
+#### FST_ERR_CTP_EMPTY_JSON_BODY
+<a id="FST_ERR_CTP_EMPTY_JSON_BODY"></a>
 
-The `Content-Type` should be a string.
+Body cannot be empty when content-type is set to `application/json`.
 
 #### FST_ERR_DEC_ALREADY_PRESENT
 <a id="FST_ERR_DEC_ALREADY_PRESENT"></a>
 
 A decorator with the same name is already registered.
 
+#### FST_ERR_DEC_DEPENDENCY_INVALID_TYPE
+<a id="FST_ERR_DEC_DEPENDENCY_INVALID_TYPE"></a>
+
+The dependencies of decorator must be of type `Array`.
+
 #### FST_ERR_DEC_MISSING_DEPENDENCY
 <a id="FST_ERR_DEC_MISSING_DEPENDENCY"></a>
 
 The decorator cannot be registered due to a missing dependency.
 
-#### FST_ERR_HOOK_INVALID_HANDLER
-<a id="FST_ERR_HOOK_INVALID_HANDLER"></a>
+#### FST_ERR_DEC_AFTER_START
+<a id="FST_ERR_DEC_AFTER_START"></a>
 
-The hook callback must be a function.
+The decorator cannot be added after start.
 
 #### FST_ERR_HOOK_INVALID_TYPE
 <a id="FST_ERR_HOOK_INVALID_TYPE"></a>
 
 The hook name must be a string.
 
+#### FST_ERR_HOOK_INVALID_HANDLER
+<a id="FST_ERR_HOOK_INVALID_HANDLER"></a>
+
+The hook callback must be a function.
+
+#### FST_ERR_MISSING_MIDDLEWARE
+<a id="FST_ERR_MISSING_MIDDLEWARE"></a>
+
+You must register a plugin for handling middlewares, 
+visit [`Middleware`](./Middleware.md) for more info.
+
+<a name="FST_ERR_HOOK_TIMEOUT"></a>
+#### FST_ERR_HOOK_TIMEOUT
+
+A callback for a hook timed out
+
 #### FST_ERR_LOG_INVALID_DESTINATION
 <a id="FST_ERR_LOG_INVALID_DESTINATION"></a>
 
 The logger accepts either a `'stream'` or a `'file'` as the destination.
 
-#### FST_ERR_PROMISE_NOT_FULFILLED
-<a id="FST_ERR_PROMISE_NOT_FULFILLED"></a>
+#### FST_ERR_REP_INVALID_PAYLOAD_TYPE
+<a id="FST_ERR_REP_INVALID_PAYLOAD_TYPE"></a>
 
-A promise may not be fulfilled with 'undefined' when statusCode is not 204.
+Reply payload can be either a `string` or a `Buffer`.
 
 #### FST_ERR_REP_ALREADY_SENT
 <a id="FST_ERR_REP_ALREADY_SENT"></a>
 
 A response was already sent.
 
-#### FST_ERR_REP_INVALID_PAYLOAD_TYPE
-<a id="FST_ERR_REP_INVALID_PAYLOAD_TYPE"></a>
+#### FST_ERR_REP_SENT_VALUE
+<a id="FST_ERR_REP_SENT_VALUE"></a>
 
-Reply payload can be either a `string` or a `Buffer`.
+The only possible value for `reply.sent` is `true`.
 
-#### FST_ERR_SCH_ALREADY_PRESENT
-<a id="FST_ERR_SCH_ALREADY_PRESENT"></a>
+#### FST_ERR_SEND_INSIDE_ONERR
+<a id="FST_ERR_SEND_INSIDE_ONERR"></a>
 
-A schema with the same `$id` already exists.
+You cannot use `send` inside the `onError` hook.
+
+#### FST_ERR_SEND_UNDEFINED_ERR
+<a id="FST_ERR_SEND_UNDEFINED_ERR"></a>
+
+Undefined error has occurred.
+
+#### FST_ERR_BAD_STATUS_CODE
+<a id="FST_ERR_BAD_STATUS_CODE"></a>
+
+Called `reply` with an invalid status code.
+
+#### FST_ERR_BAD_TRAILER_NAME
+<a id="FST_ERR_BAD_TRAILER_NAME"></a>
+
+Called `reply.trailer` with an invalid header name.
+
+#### FST_ERR_BAD_TRAILER_VALUE
+<a id="FST_ERR_BAD_TRAILER_VALUE"></a>
+
+Called `reply.trailer` with an invalid type. Expected a function.
+
+#### FST_ERR_MISSING_SERIALIZATION_FN
+<a id="FST_ERR_MISSING_SERIALIZATION_FN"></a>
+
+Missing serialization function.
+
+#### FST_ERR_REQ_INVALID_VALIDATION_INVOCATION
+<a id="FST_ERR_REQ_INVALID_VALIDATION_INVOCATION"></a>
+
+Invalid validation invocation. Missing validation function for 
+HTTP part nor schema provided.
 
 #### FST_ERR_SCH_MISSING_ID
 <a id="FST_ERR_SCH_MISSING_ID"></a>
 
 The schema provided does not have `$id` property.
 
-#### FST_ERR_SCH_SERIALIZATION_BUILD
-<a id="FST_ERR_SCH_SERIALIZATION_BUILD"></a>
+#### FST_ERR_SCH_ALREADY_PRESENT
+<a id="FST_ERR_SCH_ALREADY_PRESENT"></a>
 
-The JSON schema provided for serialization of a route response is not valid.
+A schema with the same `$id` already exists.
+
+#### FST_ERR_SCH_DUPLICATE
+<a id="FST_ERR_SCH_DUPLICATE"></a>
+
+Schema with the same `$id` already present!
 
 #### FST_ERR_SCH_VALIDATION_BUILD
 <a id="FST_ERR_SCH_VALIDATION_BUILD"></a>
 
 The JSON schema provided for validation to a route is not valid.
 
-#### FST_ERR_SEND_INSIDE_ONERR
-<a id="FST_ERR_SEND_INSIDE_ONERR"></a>
+#### FST_ERR_SCH_SERIALIZATION_BUILD
+<a id="FST_ERR_SCH_SERIALIZATION_BUILD"></a>
 
-You cannot use `send` inside the `onError` hook.
+The JSON schema provided for serialization of a route response is not valid.
 
-#### FST_ERR_SEND_UNDEFINED_ERR
-<a id="FST_ERR_SEND_UNDEFINED_ERR"></a>
+#### FST_ERR_HTTP2_INVALID_VERSION
+<a id="FST_ERR_HTTP2_INVALID_VERSION"></a>
 
-Undefined error has occurred.
+HTTP2 is available only from node >= 8.8.1.
 
-<a name="FST_ERR_PLUGIN_NOT_VALID"></a>
-#### FST_ERR_PLUGIN_NOT_VALID
+#### FST_ERR_INIT_OPTS_INVALID
+<a id="FST_ERR_INIT_OPTS_INVALID"></a>
 
-Plugin must be a function or a promise.
+Invalid initialization options.
 
-<a name="FST_ERR_PLUGIN_TIMEOUT"></a>
-#### FST_ERR_PLUGIN_TIMEOUT
+#### FST_ERR_FORCE_CLOSE_CONNECTIONS_IDLE_NOT_AVAILABLE
+<a id="FST_ERR_FORCE_CLOSE_CONNECTIONS_IDLE_NOT_AVAILABLE"></a>
 
-Plugin did not start in time. Default timeout (in millis): `10000`
+Cannot set forceCloseConnections to `idle` as your HTTP server 
+does not support `closeIdleConnections` method.
 
-<a name="FST_ERR_HOOK_TIMEOUT"></a>
-#### FST_ERR_HOOK_TIMEOUT
+<a name="FST_ERR_DUPLICATED_ROUTE"></a>
+#### FST_ERR_DUPLICATED_ROUTE
 
-A callback for a hook timed out
+The HTTP method already has a registered controller for that URL
+
+#### FST_ERR_BAD_URL
+<a id="FST_ERR_BAD_URL"></a>
+
+The router received an invalid url.
+
+### FST_ERR_ASYNC_CONSTRAINT
+<a id="FST_ERR_ASYNC_CONSTRAINT"></a>
+
+The router received error when using asynchronous constraints.
+
+#### FST_ERR_DEFAULT_ROUTE_INVALID_TYPE
+<a id="FST_ERR_DEFAULT_ROUTE_INVALID_TYPE"></a>
+
+The `defaultRoute` type should be a function.
+
+#### FST_ERR_INVALID_URL
+<a id="FST_ERR_INVALID_URL"></a>
+
+URL must be a string.
+
+#### FST_ERR_REOPENED_CLOSE_SERVER
+<a id="FST_ERR_REOPENED_CLOSE_SERVER"></a>
+
+Fastify has already been closed and cannot be reopened.
+
+#### FST_ERR_REOPENED_SERVER
+<a id="FST_ERR_REOPENED_SERVER"></a>
+
+Fastify is already listening.
+
+#### FST_ERR_PLUGIN_VERSION_MISMATCH
+<a id="FST_ERR_PLUGIN_VERSION_MISMATCH"></a>
+
+Installed Fastify plugin mismatched expected version.
+
+<a name="FST_ERR_PLUGIN_CALLBACK_NOT_FN"></a>
+#### FST_ERR_PLUGIN_CALLBACK_NOT_FN
+
+Callback for a hook is not a function (mapped directly from `avvio`)
+
+<a name="FST_ERR_PLUGIN_NOT_VALID"></a>
+#### FST_ERR_PLUGIN_NOT_VALID
+
+Plugin must be a function or a promise.
 
 <a name="FST_ERR_ROOT_PLG_BOOTED"></a>
 #### FST_ERR_ROOT_PLG_BOOTED
@@ -234,7 +379,7 @@ Root plugin has already booted (mapped directly from `avvio`)
 
 Impossible to load plugin because the parent (mapped directly from `avvio`)
 
-<a name="FST_ERR_PLUGIN_CALLBACK_NOT_FN"></a>
-#### FST_ERR_PLUGIN_CALLBACK_NOT_FN
+<a name="FST_ERR_PLUGIN_TIMEOUT"></a>
+#### FST_ERR_PLUGIN_TIMEOUT
 
-Callback for a hook is not a function (mapped directly from `avvio`)
+Plugin did not start in time. Default timeout (in millis): `10000`

package/docs/Reference/Hooks.md

@@ -449,6 +449,33 @@ fastify.addHook('onRoute', (routeOptions) => {
 })
 ```
 
+If you want to add more routes within an onRoute hook, you have to tag these
+routes properly. If you don't, the hook will run into an infinite loop. The
+recommended approach is shown below.
+
+```js
+const kRouteAlreadyProcessed = Symbol('route-already-processed')
+
+fastify.addHook('onRoute', function (routeOptions) {
+  const { url, method } = routeOptions
+
+  const isAlreadyProcessed = (routeOptions.custom && routeOptions.custom[kRouteAlreadyProcessed]) || false
+
+  if (!isAlreadyProcessed) {
+    this.route({
+      url,
+      method,
+      custom: {
+        [kRouteAlreadyProcessed]: true
+      },
+      handler: () => {}
+    })
+  }
+})
+```
+
+For more details, see this [issue](https://github.com/fastify/fastify/issues/4319).
+
 ### onRegister
 <a id="on-register"></a>
 

package/docs/Reference/Reply.md

@@ -7,22 +7,22 @@
   - [.statusCode](#statuscode)
   - [.server](#server)
   - [.header(key, value)](#headerkey-value)
-      - [set-cookie](#set-cookie)
   - [.headers(object)](#headersobject)
   - [.getHeader(key)](#getheaderkey)
   - [.getHeaders()](#getheaders)
+    - [set-cookie](#set-cookie)
   - [.removeHeader(key)](#removeheaderkey)
   - [.hasHeader(key)](#hasheaderkey)
   - [.trailer(key, function)](#trailerkey-function)
   - [.hasTrailer(key)](#hastrailerkey)
   - [.removeTrailer(key)](#removetrailerkey)
-  - [.redirect([code,] dest)](#redirectcode--dest)
+  - [.redirect([code ,] dest)](#redirectcode--dest)
   - [.callNotFound()](#callnotfound)
   - [.getResponseTime()](#getresponsetime)
   - [.type(contentType)](#typecontenttype)
-  - [.getSerializationFunction(schema | httpStatus)](#getserializationfunction)
-  - [.compileSerializationSchema(schema, httpStatus)](#compileserializationschema)
-  - [.serializeInput(data, [schema | httpStatus], [httpStatus])](#serializeinput)
+  - [.getSerializationFunction(schema | httpStatus)](#getserializationfunctionschema--httpstatus)
+  - [.compileSerializationSchema(schema, httpStatus)](#compileserializationschemaschema-httpstatus)
+  - [.serializeInput(data, [schema | httpStatus], [httpStatus])](#serializeinputdata-schema--httpstatus-httpstatus)
   - [.serializer(func)](#serializerfunc)
   - [.raw](#raw)
   - [.sent](#sent)