fastify 5.0.0 → 5.2.0

package/docs/Reference/Server.md

@@ -24,6 +24,7 @@ describes the properties available in that options object.
   - [`onProtoPoisoning`](#onprotopoisoning)
   - [`onConstructorPoisoning`](#onconstructorpoisoning)
   - [`logger`](#logger)
+  - [`loggerInstance`](#loggerInstance)
   - [`disableRequestLogging`](#disablerequestlogging)
   - [`serverFactory`](#serverfactory)
   - [`caseSensitive`](#casesensitive)
@@ -105,7 +106,7 @@ describes the properties available in that options object.
 
 An object used to configure the server's listening socket. The options
 are the same as the Node.js core [`createServer`
-method](https://nodejs.org/dist/latest-v14.x/docs/api/http.html#http_http_createserver_options_requestlistener).
+method](https://nodejs.org/docs/latest-v20.x/api/http.html#httpcreateserveroptions-requestlistener).
 
 This option is ignored if options [`http2`](#factory-http2) or
 [`https`](#factory-https) are set.
@@ -116,7 +117,7 @@ This option is ignored if options [`http2`](#factory-http2) or
 + Default: `false`
 
 If `true` Node.js core's
-[HTTP/2](https://nodejs.org/dist/latest-v14.x/docs/api/http2.html) module is
+[HTTP/2](https://nodejs.org/dist/latest-v20.x/docs/api/http2.html) module is
 used for binding the socket.
 
 ### `https`
@@ -126,7 +127,7 @@ used for binding the socket.
 
 An object used to configure the server's listening socket for TLS. The options
 are the same as the Node.js core [`createServer`
-method](https://nodejs.org/dist/latest-v14.x/docs/api/https.html#https_https_createserver_options_requestlistener).
+method](https://nodejs.org/dist/latest-v20.x/docs/api/https.html#https_https_createserver_options_requestlistener).
 When this property is `null`, the socket will not be configured for TLS.
 
 This option also applies when the [`http2`](#factory-http2) option is set.
@@ -152,7 +153,7 @@ Defines the server keep-alive timeout in milliseconds. See documentation for
 [`server.keepAliveTimeout`
 property](https://nodejs.org/api/http.html#http_server_keepalivetimeout) to
 understand the effect of this option. This option only applies when HTTP/1 is in
-use. 
+use.
 
 When `serverFactory` option is specified this option is ignored.
 
@@ -203,7 +204,7 @@ ignored.
 Defines the maximum number of milliseconds for receiving the entire request from
 the client. See [`server.requestTimeout`
 property](https://nodejs.org/dist/latest/docs/api/http.html#http_server_requesttimeout)
-to understand the effect of this option. 
+to understand the effect of this option.
 
 When `serverFactory` option is specified, this option is ignored.
 It must be set to a non-zero value (e.g. 120 seconds) to protect against potential
@@ -329,9 +330,6 @@ The possible values this property may have are:
 + Default: `false`. The logger is disabled. All logging methods will point to a
   null logger [abstract-logging](https://npm.im/abstract-logging) instance.
 
-+ `pinoInstance`: a previously instantiated instance of Pino. The internal
-  logger will point to this instance.
-
 + `object`: a standard Pino [options
   object](https://github.com/pinojs/pino/blob/c77d8ec5ce/docs/API.md#constructor).
   This will be passed directly to the Pino constructor. If the following
@@ -351,9 +349,15 @@ The possible values this property may have are:
         ```
       Any user-supplied serializer will override the default serializer of the
       corresponding property.
-+ `loggerInstance`: a custom logger instance. The logger must conform to the
-  Pino interface by having the following methods: `info`, `error`, `debug`,
-  `fatal`, `warn`, `trace`, `child`. For example:
+
+### `loggerInstance`
+<a id="factory-logger-instance"></a>
+
++ Default: `null`
+
+A custom logger instance. The logger must be a Pino instance or conform to the
+Pino interface by having the following methods: `info`, `error`, `debug`,
+`fatal`, `warn`, `trace`, `child`. For example:
   ```js
   const pino = require('pino')();
 
@@ -387,12 +391,12 @@ attaching custom `onRequest` and `onResponse` hooks.
 
 The other log entries that will be disabled are:
 - an error log written by the default `onResponse` hook on reply callback errors
-- the error and info logs written by the `defaultErrorHandler` 
+- the error and info logs written by the `defaultErrorHandler`
 on error management
-- the info log written by the `fourOhFour` handler when a 
+- the info log written by the `fourOhFour` handler when a
 non existent route is requested
 
-Other log messages emitted by Fastify will stay enabled, 
+Other log messages emitted by Fastify will stay enabled,
 like deprecation warnings and messages
 emitted when requests are received while the server is closing.
 
@@ -456,7 +460,7 @@ Please note that setting this option to `false` goes against
 
 By setting `caseSensitive` to `false`, all paths will be matched as lowercase,
 but the route parameters or wildcards will maintain their original letter
-casing. 
+casing.
 This option does not affect query strings, please refer to
 [`querystringParser`](#querystringparser) to change their handling.
 
@@ -493,7 +497,7 @@ Setting `requestIdHeader` to `true` will set the `requestIdHeader` to
 Setting `requestIdHeader` to a non-empty string will use
 the specified string as the `requestIdHeader`.
 By default `requestIdHeader` is set to `false` and will immediately use [genReqId](#genreqid).
-Setting `requestIdHeader` to an empty String (`""`) will set the 
+Setting `requestIdHeader` to an empty String (`""`) will set the
 requestIdHeader to `false`.
 
 + Default: `false`
@@ -827,7 +831,7 @@ is an instance-wide configuration.
 // @param {object} req The raw Node.js HTTP request, not the `FastifyRequest` object.
 // @this Fastify The root Fastify instance (not an encapsulated instance).
 // @returns {string} The path that the request should be mapped to.
-function rewriteUrl (req) { 
+function rewriteUrl (req) {
   if (req.url === '/hi') {
     this.log.debug({ originalUrl: req.url, url: '/hello' }, 'rewrite url');
     return '/hello'
@@ -948,7 +952,7 @@ Starts the server and internally waits for the `.ready()` event. The signature
 is `.listen([options][, callback])`. Both the `options` object and the
 `callback` parameters extend the [Node.js
 core](https://nodejs.org/api/net.html#serverlistenoptions-callback) options
-object. Thus, all core options are available with the following additional 
+object. Thus, all core options are available with the following additional
 Fastify specific options:
 
 ### `listenTextResolver`
@@ -956,13 +960,13 @@ Fastify specific options:
 
 Set an optional resolver for the text to log after server has been successfully
 started.
-It is possible to override the default `Server listening at [address]` log 
+It is possible to override the default `Server listening at [address]` log
 entry using this option.
 
 ```js
-server.listen({ 
-  port: 9080, 
-  listenTextResolver: (address) => { return `Prometheus metrics server is listening at ${address}` } 
+server.listen({
+  port: 9080,
+  listenTextResolver: (address) => { return `Prometheus metrics server is listening at ${address}` }
 })
 ```
 
@@ -1090,7 +1094,7 @@ Method to add routes to the server, it also has shorthand functions, check
 <a id="hasRoute"></a>
 
 Method to check if a route is already registered to the internal router. It
-expects an object as the payload. `url` and `method` are mandatory fields. It 
+expects an object as the payload. `url` and `method` are mandatory fields. It
 is possible to also specify `constraints`. The method returns `true` if the
 route is registered or `false` if not.
 
@@ -1110,8 +1114,8 @@ if (routeExists === false) {
 <a id="findRoute"></a>
 
 Method to retrieve a route already registered to the internal router. It
-expects an object as the payload. `url` and `method` are mandatory fields. It 
-is possible to also specify `constraints`. 
+expects an object as the payload. `url` and `method` are mandatory fields. It
+is possible to also specify `constraints`.
 The method returns a route object or `null` if the route cannot be found.
 
 ```js
@@ -1351,7 +1355,7 @@ Set the schema error formatter for all routes. See
 Set the schema serializer compiler for all routes. See
 [#schema-serializer](./Validation-and-Serialization.md#schema-serializer).
 
-> **Note** 
+> **Note**
 > [`setReplySerializer`](#set-reply-serializer) has priority if set!
 
 #### validatorCompiler
@@ -1559,7 +1563,7 @@ is set. It can be accessed using `fastify.errorHandler` and it logs the error
 with respect to its `statusCode`.
 
 ```js
-var statusCode = error.statusCode
+const statusCode = error.statusCode
 if (statusCode >= 500) {
   log.error(error)
 } else if (statusCode >= 400) {
@@ -1966,7 +1970,7 @@ The properties that can currently be exposed are:
 - requestIdHeader
 - requestIdLogLabel
 - http2SessionTimeout
-- useSemicolonDelimiter 
+- useSemicolonDelimiter
 
 ```js
 const { readFileSync } = require('node:fs')

package/docs/Reference/TypeScript.md

@@ -182,7 +182,7 @@ route-level `request` object.
    admin"}`
 
 🎉 Good work, now you can define interfaces for each route and have strictly
-typed request and reply instances. Other parts of the Fastify type system rely 
+typed request and reply instances. Other parts of the Fastify type system rely
 on generic properties. Make sure to reference the detailed type system
 documentation below to learn more about what is available.
 
@@ -873,11 +873,11 @@ a more detailed http server walkthrough.
 
 1. Create the following imports from `@types/node` and `fastify`
    ```typescript
-   import fs from 'fs'
-   import path from 'path'
+   import fs from 'node:fs'
+   import path from 'node:path'
    import fastify from 'fastify'
    ```
-2. Perform the following steps before setting up a Fastify HTTPS server 
+2. Perform the following steps before setting up a Fastify HTTPS server
 to create the `key.pem` and `cert.pem` files:
 ```sh
 openssl genrsa -out key.pem
@@ -935,7 +935,7 @@ specified at server instantiation, the custom type becomes available on all
 further instances of the custom type.
 ```typescript
 import fastify from 'fastify'
-import http from 'http'
+import http from 'node:http'
 
 interface customRequest extends http.IncomingMessage {
   mySpecialProp: string
@@ -1123,8 +1123,8 @@ returns `http.IncomingMessage`, otherwise, it returns
 `http2.Http2ServerRequest`.
 
 ```typescript
-import http from 'http'
-import http2 from 'http2'
+import http from 'node:http'
+import http2 from 'node:http2'
 import { RawRequestDefaultExpression } from 'fastify'
 
 RawRequestDefaultExpression<http.Server> // -> http.IncomingMessage
@@ -1183,8 +1183,8 @@ returns `http.ServerResponse`, otherwise, it returns
 `http2.Http2ServerResponse`.
 
 ```typescript
-import http from 'http'
-import http2 from 'http2'
+import http from 'node:http'
+import http2 from 'node:http2'
 import { RawReplyDefaultExpression } from 'fastify'
 
 RawReplyDefaultExpression<http.Server> // -> http.ServerResponse

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

@@ -49,16 +49,16 @@ The shared schemas can be reused through the JSON Schema
 [**`$ref`**](https://tools.ietf.org/html/draft-handrews-json-schema-01#section-8)
 keyword. Here is an overview of _how_ references work:
 
-+ `myField: { $ref: '#foo'}` will search for field with `$id: '#foo'` inside the
++ `myField: { $ref: '#foo' }` will search for field with `$id: '#foo'` inside the
   current schema
-+ `myField: { $ref: '#/definitions/foo'}` will search for field
++ `myField: { $ref: '#/definitions/foo' }` will search for field
   `definitions.foo` inside the current schema
-+ `myField: { $ref: 'http://url.com/sh.json#'}` will search for a shared schema
++ `myField: { $ref: 'http://url.com/sh.json#' }` will search for a shared schema
   added with `$id: 'http://url.com/sh.json'`
-+ `myField: { $ref: 'http://url.com/sh.json#/definitions/foo'}` will search for
++ `myField: { $ref: 'http://url.com/sh.json#/definitions/foo' }` will search for
   a shared schema added with `$id: 'http://url.com/sh.json'` and will use the
   field `definitions.foo`
-+ `myField: { $ref: 'http://url.com/sh.json#foo'}` will search for a shared
++ `myField: { $ref: 'http://url.com/sh.json#foo' }` will search for a shared
   schema added with `$id: 'http://url.com/sh.json'` and it will look inside of
   it for object with `$id: '#foo'`
 

package/examples/typescript-server.ts

@@ -11,7 +11,7 @@
  */
 
 import fastify, { FastifyInstance, RouteShorthandOptions } from '../fastify'
-import { Server, IncomingMessage, ServerResponse } from 'http'
+import { Server, IncomingMessage, ServerResponse } from 'node:http'
 
 // Create an http server. We pass the relevant typings for our http version used.
 // By passing types we get correctly typed access to the underlying http objects in routes.

package/fastify.d.ts

@@ -1,7 +1,7 @@
-import * as http from 'http'
-import * as http2 from 'http2'
-import * as https from 'https'
-import { Socket } from 'net'
+import * as http from 'node:http'
+import * as http2 from 'node:http2'
+import * as https from 'node:https'
+import { Socket } from 'node:net'
 
 import { Options as AjvOptions, ValidatorFactory } from '@fastify/ajv-compiler'
 import { FastifyError } from '@fastify/error'
@@ -14,7 +14,15 @@ import { FastifyContextConfig, FastifyReplyContext, FastifyRequestContext } from
 import { FastifyErrorCodes } from './types/errors'
 import { DoneFuncWithErrOrRes, HookHandlerDoneFunction, onCloseAsyncHookHandler, onCloseHookHandler, onErrorAsyncHookHandler, onErrorHookHandler, onListenAsyncHookHandler, onListenHookHandler, onReadyAsyncHookHandler, onReadyHookHandler, onRegisterHookHandler, onRequestAbortAsyncHookHandler, onRequestAbortHookHandler, onRequestAsyncHookHandler, onRequestHookHandler, onResponseAsyncHookHandler, onResponseHookHandler, onRouteHookHandler, onSendAsyncHookHandler, onSendHookHandler, onTimeoutAsyncHookHandler, onTimeoutHookHandler, preCloseAsyncHookHandler, preCloseHookHandler, preHandlerAsyncHookHandler, preHandlerHookHandler, preParsingAsyncHookHandler, preParsingHookHandler, preSerializationAsyncHookHandler, preSerializationHookHandler, preValidationAsyncHookHandler, preValidationHookHandler, RequestPayload } from './types/hooks'
 import { FastifyInstance, FastifyListenOptions, PrintRoutesOptions } from './types/instance'
-import { FastifyBaseLogger, FastifyLogFn, FastifyLoggerInstance, FastifyLoggerOptions, LogLevel, PinoLoggerOptions } from './types/logger'
+import {
+  FastifyBaseLogger,
+  FastifyChildLoggerFactory,
+  FastifyLogFn,
+  FastifyLoggerInstance,
+  FastifyLoggerOptions,
+  LogLevel,
+  PinoLoggerOptions
+} from './types/logger'
 import { FastifyPlugin, FastifyPluginAsync, FastifyPluginCallback, FastifyPluginOptions } from './types/plugin'
 import { FastifyRegister, FastifyRegisterOptions, RegisterOptions } from './types/register'
 import { FastifyReply } from './types/reply'
@@ -149,6 +157,7 @@ declare namespace fastify {
      * listener to error events emitted by client connections
      */
     clientErrorHandler?: (error: ConnectionError, socket: Socket) => void,
+    childLoggerFactory?: FastifyChildLoggerFactory
   }
 
   /**

package/fastify.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const VERSION = '5.0.0'
+const VERSION = '5.2.0'
 
 const Avvio = require('avvio')
 const http = require('node:http')
@@ -42,7 +42,7 @@ const decorator = require('./lib/decorate')
 const ContentTypeParser = require('./lib/contentTypeParser')
 const SchemaController = require('./lib/schema-controller')
 const { Hooks, hookRunnerApplication, supportedHooks } = require('./lib/hooks')
-const { createLogger, createChildLogger, defaultChildLoggerFactory } = require('./lib/logger')
+const { createChildLogger, defaultChildLoggerFactory, createLogger } = require('./lib/logger-factory')
 const pluginUtils = require('./lib/pluginUtils')
 const { getGenReqId, reqIdGenFactory } = require('./lib/reqIdGenFactory')
 const { buildRouting, validateBodyLimitOption } = require('./lib/route')
@@ -97,10 +97,11 @@ function defaultBuildPrettyMeta (route) {
  */
 function fastify (options) {
   // Options validations
-  options = options || {}
-
-  if (typeof options !== 'object') {
+  if (options && typeof options !== 'object') {
     throw new FST_ERR_OPTIONS_NOT_OBJ()
+  } else {
+    // Shallow copy options object to prevent mutations outside of this function
+    options = Object.assign({}, options)
   }
 
   if (options.querystringParser && typeof options.querystringParser !== 'function') {
@@ -134,6 +135,7 @@ function fastify (options) {
   }
 
   // Instance Fastify components
+
   const { logger, hasLogger } = createLogger(options)
 
   // Update the options with the fixed values
@@ -928,7 +930,7 @@ function validateSchemaErrorFormatter (schemaErrorFormatter) {
 
 /**
  * These export configurations enable JS and TS developers
- * to consumer fastify in whatever way best suits their needs.
+ * to consume fastify in whatever way best suits their needs.
  * Some examples of supported import syntax includes:
  * - `const fastify = require('fastify')`
  * - `const { fastify } = require('fastify')`

package/lib/contentTypeParser.js

@@ -109,16 +109,19 @@ ContentTypeParser.prototype.existingParser = function (contentType) {
 ContentTypeParser.prototype.getParser = function (contentType) {
   let parser = this.customParsers.get(contentType)
   if (parser !== undefined) return parser
-
   parser = this.cache.get(contentType)
   if (parser !== undefined) return parser
 
-  // eslint-disable-next-line no-var
-  for (var i = 0; i !== this.parserList.length; ++i) {
+  const caseInsensitiveContentType = contentType.toLowerCase()
+  for (let i = 0; i !== this.parserList.length; ++i) {
     const parserListItem = this.parserList[i]
     if (
-      contentType.slice(0, parserListItem.length) === parserListItem &&
-      (contentType.length === parserListItem.length || contentType.charCodeAt(parserListItem.length) === 59 /* `;` */ || contentType.charCodeAt(parserListItem.length) === 32 /* ` ` */)
+      caseInsensitiveContentType.slice(0, parserListItem.length) === parserListItem &&
+      (
+        caseInsensitiveContentType.length === parserListItem.length ||
+        caseInsensitiveContentType.charCodeAt(parserListItem.length) === 59 /* `;` */ ||
+        caseInsensitiveContentType.charCodeAt(parserListItem.length) === 32 /* ` ` */
+      )
     ) {
       parser = this.customParsers.get(parserListItem)
       this.cache.set(contentType, parser)
@@ -126,8 +129,7 @@ ContentTypeParser.prototype.getParser = function (contentType) {
     }
   }
 
-  // eslint-disable-next-line no-var
-  for (var j = 0; j !== this.parserRegExpList.length; ++j) {
+  for (let j = 0; j !== this.parserRegExpList.length; ++j) {
     const parserRegExp = this.parserRegExpList[j]
     if (parserRegExp.test(contentType)) {
       parser = this.customParsers.get(parserRegExp.toString())

package/lib/context.js

@@ -85,8 +85,7 @@ function defaultSchemaErrorFormatter (errors, dataVar) {
   let text = ''
   const separator = ', '
 
-  // eslint-disable-next-line no-var
-  for (var i = 0; i !== errors.length; ++i) {
+  for (let i = 0; i !== errors.length; ++i) {
     const e = errors[i]
     text += dataVar + (e.instancePath || '') + ' ' + e.message + separator
   }

package/lib/error-handler.js

@@ -112,16 +112,16 @@ function fallbackErrorHandler (error, reply, cb) {
     const serializerFn = getSchemaSerializer(reply[kRouteContext], statusCode, reply[kReplyHeaders]['content-type'])
     payload = (serializerFn === false)
       ? serializeError({
-        error: statusCodes[statusCode + ''],
-        code: error.code,
-        message: error.message,
-        statusCode
-      })
+          error: statusCodes[statusCode + ''],
+          code: error.code,
+          message: error.message,
+          statusCode
+        })
       : serializerFn(Object.create(error, {
-        error: { value: statusCodes[statusCode + ''] },
-        message: { value: error.message },
-        statusCode: { value: statusCode }
-      }))
+          error: { value: statusCodes[statusCode + ''] },
+          message: { value: error.message },
+          statusCode: { value: statusCode }
+        }))
   } catch (err) {
     if (!reply.log[kDisableRequestLogging]) {
       // error is always FST_ERR_SCH_SERIALIZATION_BUILD because this is called from route/compileSchemasForSerialization

package/lib/errors.js

@@ -189,7 +189,7 @@ const codes = {
 
   FST_ERR_HOOK_TIMEOUT: createError(
     'FST_ERR_HOOK_TIMEOUT',
-    "A callback for '%s' hook timed out. You may have forgotten to call 'done' function or to resolve a Promise"
+    "A callback for '%s' hook%s timed out. You may have forgotten to call 'done' function or to resolve a Promise"
   ),
 
   /**

package/lib/fourOhFour.js

@@ -18,7 +18,7 @@ const { buildErrorHandler } = require('./error-handler.js')
 const {
   FST_ERR_NOT_FOUND
 } = require('./errors')
-const { createChildLogger } = require('./logger')
+const { createChildLogger } = require('./logger-factory')
 const { getGenReqId } = require('./reqIdGenFactory.js')
 
 /**

package/lib/hooks.js

@@ -98,9 +98,12 @@ function hookRunnerApplication (hookName, boot, server, cb) {
   next()
 
   function exit (err) {
+    const hookFnName = hooks[i - 1]?.name
+    const hookFnFragment = hookFnName ? ` "${hookFnName}"` : ''
+
     if (err) {
       if (err.code === 'AVV_ERR_READY_TIMEOUT') {
-        err = appendStackTrace(err, new FST_ERR_HOOK_TIMEOUT(hookName))
+        err = appendStackTrace(err, new FST_ERR_HOOK_TIMEOUT(hookName, hookFnFragment))
       } else {
         err = AVVIO_ERRORS_MAP[err.code] != null
           ? appendStackTrace(err, new AVVIO_ERRORS_MAP[err.code](err.message))