fastify 4.6.0 → 4.7.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
@@ -471,6 +473,9 @@ section.
   [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/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)

package/docs/Reference/Request.md

@@ -35,6 +35,13 @@ Request is a core Fastify object containing the following fields:
 - `connection` - Deprecated, use `socket` instead. The underlying connection of
   the incoming request.
 - `socket` - the underlying connection of the incoming request
+- `context` - A Fastify internal object. You should not use it directly or
+  modify it. It is useful to access one special key:	
+  - `context.config` - The route [`config`](./Routes.md#routes-config) object.
+- `routeSchema` - the scheme definition set for the router that is
+  handling the request
+- `routeConfig` - The route [`config`](./Routes.md#routes-config) 
+  object.
 - [.getValidationFunction(schema | httpPart)](#getvalidationfunction) - 
   Returns a validation function for the specified schema or http part,
   if any of either are set or cached.
@@ -48,9 +55,6 @@ Request is a core Fastify object containing the following fields:
   schema and returns the serialized payload. If the optional
   `httpPart` is provided, the function will use the serializer
   function given for that HTTP Status Code. Defaults to `null`.
-- `context` - A Fastify internal object. You should not use it directly or
-  modify it. It is useful to access one special key:
-  - `context.config` - The route [`config`](./Routes.md#routes-config) object.
 
 ### Headers
 
@@ -98,6 +102,9 @@ it will return a `validation` function that can be used to
 validate diverse inputs. It returns `undefined` if no
 serialization function was found using either of the provided inputs.
 
+This function has property errors. Errors encountered during the last validation
+are assigned to errors
+
 ```js
 const validate = request
                   .getValidationFunction({
@@ -108,13 +115,15 @@ const validate = request
                       } 
                     } 
                   })
-validate({ foo: 'bar' }) // true
+console.log(validate({ foo: 'bar' })) // true
+console.log(validate.errors) // null
 
 // or
 
 const validate = request
                   .getValidationFunction('body')
-validate({ foo: 0.5 }) // false
+console.log(validate({ foo: 0.5 })) // false
+console.log(validate.errors) // validation errors
 ```
 
 See [.compilaValidationSchema(schema, [httpStatus])](#compilevalidationschema)
@@ -133,6 +142,8 @@ The optional parameter `httpPart`, if provided, is forwarded directly
 the `ValidationCompiler`, so it can be used to compile the validation
 function if a custom `ValidationCompiler` is provided for the route.
 
+This function has property errors. Errors encountered during the last validation
+are assigned to errors
 
 ```js
 const validate = request
@@ -145,6 +156,7 @@ const validate = request
                     } 
                   })
 console.log(validate({ foo: 'bar' })) // true
+console.log(validate.errors) // null
 
 // or
 
@@ -158,6 +170,7 @@ const validate = request
                     } 
                   }, 200)
 console.log(validate({ hello: 'world' })) // false
+console.log(validate.errors) // validation errors
 ```
 
 Note that you should be careful when using this function, as it will cache
@@ -247,4 +260,4 @@ request
 ```
 
 See [.compileValidationSchema(schema, [httpStatus])](#compileValidationSchema)
-for more information on how to compile validation schemas.
+for more information on how to compile validation schemas.

package/docs/Reference/Routes.md

@@ -41,8 +41,8 @@ fastify.route(options)
   need to be in [JSON Schema](https://json-schema.org/) format, check
   [here](./Validation-and-Serialization.md) for more info.
 
-  * `body`: validates the body of the request if it is a POST, PUT, or PATCH
-    method.
+  * `body`: validates the body of the request if it is a POST, PUT, PATCH,
+    TRACE, or SEARCH method.
   * `querystring` or `query`: validates the querystring. This can be a complete
     JSON Schema object, with the property `type` of `object` and `properties`
     object of parameters, or simply the values of what would be contained in the

package/docs/Reference/Type-Providers.md

@@ -148,7 +148,7 @@ fastify.register(pluginWithTypebox)
 
 It's also important to mention that once the types don't propagate globally,
 _currently_ is not possible to avoid multiple registrations on routes when
-dealing with several scopes, see bellow:
+dealing with several scopes, see below:
 
 ```ts
 import Fastify from 'fastify'
@@ -218,7 +218,7 @@ server.listen({ port: 3000 })
 import { Type } from '@sinclair/typebox'
 import {
   FastifyInstance,
-  FastifyLoggerInstance,
+  FastifyBaseLogger,
   RawReplyDefaultExpression,
   RawRequestDefaultExpression,
   RawServerDefault
@@ -229,7 +229,7 @@ type FastifyTypebox = FastifyInstance<
   RawServerDefault,
   RawRequestDefaultExpression<RawServerDefault>,
   RawReplyDefaultExpression<RawServerDefault>,
-  FastifyLoggerInstance,
+  FastifyBaseLogger,
   TypeBoxTypeProvider
 >;
 

package/fastify.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const VERSION = '4.6.0'
+const VERSION = '4.7.0'
 
 const Avvio = require('avvio')
 const http = require('http')

package/lib/contentTypeParser.js

@@ -1,11 +1,7 @@
 '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
-// and https://github.com/fastify/fastify/discussions/2907.
-lru = typeof lru === 'function' ? lru : lru.default
+const lru = require('tiny-lru').lru
 
 const secureJson = require('secure-json-parse')
 const {
@@ -15,7 +11,8 @@ const {
   kRequestPayloadStream,
   kState,
   kTestInternals,
-  kReplyIsError
+  kReplyIsError,
+  kRouteContext
 } = require('./symbols')
 
 const {
@@ -149,12 +146,16 @@ ContentTypeParser.prototype.run = function (contentType, handler, request, reply
   const resource = new AsyncResource('content-type-parser:run', request)
 
   if (parser === undefined) {
-    reply.send(new FST_ERR_CTP_INVALID_MEDIA_TYPE(contentType || undefined))
+    if (request.is404) {
+      handler(request, reply)
+    } else {
+      reply.send(new FST_ERR_CTP_INVALID_MEDIA_TYPE(contentType || undefined))
+    }
   } else if (parser.asString === true || parser.asBuffer === true) {
     rawBody(
       request,
       reply,
-      reply.context._parserOptions,
+      reply[kRouteContext]._parserOptions,
       parser,
       done
     )
@@ -185,7 +186,7 @@ function rawBody (request, reply, options, parser, done) {
   const limit = options.limit === null ? parser.bodyLimit : options.limit
   const contentLength = request.headers['content-length'] === undefined
     ? NaN
-    : Number.parseInt(request.headers['content-length'], 10)
+    : Number(request.headers['content-length'])
 
   if (contentLength > limit) {
     reply.send(new FST_ERR_CTP_BODY_TOO_LARGE())

package/lib/context.js

@@ -12,10 +12,11 @@ const {
   kContentTypeParser,
   kRouteByFastify,
   kRequestValidateWeakMap,
-  kReplySerializeWeakMap
+  kReplySerializeWeakMap,
+  kPublicRouteContext
 } = require('./symbols.js')
 
-// Objects that holds the context of every request
+// Object that holds the context of every request
 // Every route holds an instance of this object.
 function Context ({
   schema,
@@ -56,7 +57,10 @@ function Context ({
   this[kFourOhFourContext] = null
   this.attachValidation = attachValidation
   this[kReplySerializerDefault] = replySerializer
-  this.schemaErrorFormatter = schemaErrorFormatter || server[kSchemaErrorFormatter] || defaultSchemaErrorFormatter
+  this.schemaErrorFormatter =
+    schemaErrorFormatter ||
+    server[kSchemaErrorFormatter] ||
+    defaultSchemaErrorFormatter
   this[kRouteByFastify] = isFastify
 
   this[kRequestValidateWeakMap] = null
@@ -64,9 +68,29 @@ function Context ({
   this.validatorCompiler = validatorCompiler || null
   this.serializerCompiler = serializerCompiler || null
 
+  // Route + Userland configurations for the route
+  this[kPublicRouteContext] = getPublicRouteContext(this)
+
   this.server = server
 }
 
+function getPublicRouteContext (context) {
+  return Object.create(null, {
+    schema: {
+      enumerable: true,
+      get () {
+        return context.schema
+      }
+    },
+    config: {
+      enumerable: true,
+      get () {
+        return context.config
+      }
+    }
+  })
+}
+
 function defaultSchemaErrorFormatter (errors, dataVar) {
   let text = ''
   const separator = ', '

package/lib/error-handler.js

@@ -3,7 +3,11 @@
 const statusCodes = require('http').STATUS_CODES
 const wrapThenable = require('./wrapThenable')
 const {
-  kReplyHeaders, kReplyNextErrorHandler, kReplyIsRunningOnErrorHook, kReplyHasStatusCode
+  kReplyHeaders,
+  kReplyNextErrorHandler,
+  kReplyIsRunningOnErrorHook,
+  kReplyHasStatusCode,
+  kRouteContext
 } = require('./symbols.js')
 
 const {
@@ -24,7 +28,7 @@ const rootErrorHandler = {
 function handleError (reply, error, cb) {
   reply[kReplyIsRunningOnErrorHook] = false
 
-  const context = reply.context
+  const context = reply[kRouteContext]
   if (reply[kReplyNextErrorHandler] === false) {
     fallbackErrorHandler(error, reply, function (reply, payload) {
       try {
@@ -90,7 +94,7 @@ function fallbackErrorHandler (error, reply, cb) {
   const statusCode = reply.statusCode
   let payload
   try {
-    const serializerFn = getSchemaSerializer(reply.context, statusCode)
+    const serializerFn = getSchemaSerializer(reply[kRouteContext], statusCode)
     payload = (serializerFn === false)
       ? serializeError({
         error: statusCodes[statusCode + ''],

package/lib/handleRequest.js

@@ -4,7 +4,8 @@ const { validate: validateSchema } = require('./validation')
 const { hookRunner, hookIterator } = require('./hooks')
 const wrapThenable = require('./wrapThenable')
 const {
-  kReplyIsError
+  kReplyIsError,
+  kRouteContext
 } = require('./symbols')
 
 function handleRequest (err, request, reply) {
@@ -17,15 +18,16 @@ function handleRequest (err, request, reply) {
 
   const method = request.raw.method
   const headers = request.headers
+  const context = request[kRouteContext]
 
-  if (method === 'GET' || method === 'HEAD' || method === 'SEARCH') {
+  if (method === 'GET' || method === 'HEAD') {
     handler(request, reply)
     return
   }
 
   const contentType = headers['content-type']
 
-  if (method === 'POST' || method === 'PUT' || method === 'PATCH' || method === 'TRACE') {
+  if (method === 'POST' || method === 'PUT' || method === 'PATCH' || method === 'TRACE' || method === 'SEARCH') {
     if (contentType === undefined) {
       if (
         headers['transfer-encoding'] === undefined &&
@@ -33,10 +35,10 @@ function handleRequest (err, request, reply) {
       ) { // Request has no body to parse
         handler(request, reply)
       } else {
-        reply.context.contentTypeParser.run('', handler, request, reply)
+        context.contentTypeParser.run('', handler, request, reply)
       }
     } else {
-      reply.context.contentTypeParser.run(contentType, handler, request, reply)
+      context.contentTypeParser.run(contentType, handler, request, reply)
     }
     return
   }
@@ -49,7 +51,7 @@ function handleRequest (err, request, reply) {
         headers['content-length'] !== undefined
       )
     ) {
-      reply.context.contentTypeParser.run(contentType, handler, request, reply)
+      context.contentTypeParser.run(contentType, handler, request, reply)
     } else {
       handler(request, reply)
     }
@@ -62,9 +64,9 @@ function handleRequest (err, request, reply) {
 
 function handler (request, reply) {
   try {
-    if (reply.context.preValidation !== null) {
+    if (request[kRouteContext].preValidation !== null) {
       hookRunner(
-        reply.context.preValidation,
+        request[kRouteContext].preValidation,
         hookIterator,
         request,
         reply,
@@ -87,9 +89,9 @@ function preValidationCallback (err, request, reply) {
     return
   }
 
-  const result = validateSchema(reply.context, request)
+  const result = validateSchema(reply[kRouteContext], request)
   if (result) {
-    if (reply.context.attachValidation === false) {
+    if (reply[kRouteContext].attachValidation === false) {
       reply.send(result)
       return
     }
@@ -98,9 +100,9 @@ function preValidationCallback (err, request, reply) {
   }
 
   // preHandler hook
-  if (reply.context.preHandler !== null) {
+  if (request[kRouteContext].preHandler !== null) {
     hookRunner(
-      reply.context.preHandler,
+      request[kRouteContext].preHandler,
       hookIterator,
       request,
       reply,
@@ -123,7 +125,7 @@ function preHandlerCallback (err, request, reply) {
   let result
 
   try {
-    result = reply.context.handler(request, reply)
+    result = request[kRouteContext].handler(request, reply)
   } catch (err) {
     reply[kReplyIsError] = true
     reply.send(err)