fastify 4.22.2 → 4.23.0

package/README.md

@@ -230,39 +230,32 @@ The overhead that each framework has on your application depends on your
 application, you should __always__ benchmark if performance matters to you.
 
 ## Documentation
-* <a href="./docs/Guides/Getting-Started.md"><code><b>Getting
-  Started</b></code></a>
-* <a href="./docs/Guides/Index.md"><code><b>Guides</b></code></a>
-* <a href="./docs/Reference/Server.md"><code><b>Server</b></code></a>
-* <a href="./docs/Reference/Routes.md"><code><b>Routes</b></code></a>
-* <a
-  href="./docs/Reference/Encapsulation.md"><code><b>Encapsulation</b></code></a>
-* <a href="./docs/Reference/Logging.md"><code><b>Logging</b></code></a>
-* <a href="./docs/Reference/Middleware.md"><code><b>Middleware</b></code></a>
-* <a href="./docs/Reference/Hooks.md"><code><b>Hooks</b></code></a>
-* <a href="./docs/Reference/Decorators.md"><code><b>Decorators</b></code></a>
-* <a href="./docs/Reference/Validation-and-Serialization.md"><code><b>Validation
-  and Serialization</b></code></a>
-* <a href="./docs/Guides/Fluent-Schema.md"><code><b>Fluent Schema</b></code></a>
-* <a href="./docs/Reference/Lifecycle.md"><code><b>Lifecycle</b></code></a>
-* <a href="./docs/Reference/Reply.md"><code><b>Reply</b></code></a>
-* <a href="./docs/Reference/Request.md"><code><b>Request</b></code></a>
-* <a href="./docs/Reference/Errors.md"><code><b>Errors</b></code></a>
-* <a href="./docs/Reference/ContentTypeParser.md"><code><b>Content Type
-  Parser</b></code></a>
-* <a href="./docs/Reference/Plugins.md"><code><b>Plugins</b></code></a>
-* <a href="./docs/Guides/Testing.md"><code><b>Testing</b></code></a>
-* <a href="./docs/Guides/Benchmarking.md"><code><b>Benchmarking</b></code></a>
-* <a href="./docs/Guides/Write-Plugin.md"><code><b>How to write a good
-  plugin</b></code></a>
-* <a href="./docs/Guides/Plugins-Guide.md"><code><b>Plugins Guide</b></code></a>
-* <a href="./docs/Reference/HTTP2.md"><code><b>HTTP2</b></code></a>
-* <a href="./docs/Reference/LTS.md"><code><b>Long Term Support</b></code></a>
-* <a href="./docs/Reference/TypeScript.md"><code><b>TypeScript and types
-  support</b></code></a>
-* <a href="./docs/Guides/Serverless.md"><code><b>Serverless</b></code></a>
-* <a
-  href="./docs/Guides/Recommendations.md"><code><b>Recommendations</b></code></a>
+* [__`Getting Started`__](./docs/Guides/Getting-Started.md)
+* [__`Guides`__](./docs/Guides/Index.md)
+* [__`Server`__](./docs/Reference/Server.md)
+* [__`Routes`__](./docs/Reference/Routes.md)
+* [__`Encapsulation`__](./docs/Reference/Encapsulation.md)
+* [__`Logging`__](./docs/Reference/Logging.md)
+* [__`Middleware`__](./docs/Reference/Middleware.md)
+* [__`Hooks`__](./docs/Reference/Hooks.md)
+* [__`Decorators`__](./docs/Reference/Decorators.md)
+* [__`Validation and Serialization`__](./docs/Reference/Validation-and-Serialization.md)
+* [__`Fluent Schema`__](./docs/Guides/Fluent-Schema.md)
+* [__`Lifecycle`__](./docs/Reference/Lifecycle.md)
+* [__`Reply`__](./docs/Reference/Reply.md)
+* [__`Request`__](./docs/Reference/Request.md)
+* [__`Errors`__](./docs/Reference/Errors.md)
+* [__`Content Type Parser`__](./docs/Reference/ContentTypeParser.md)
+* [__`Plugins`__](./docs/Reference/Plugins.md)
+* [__`Testing`__](./docs/Guides/Testing.md)
+* [__`Benchmarking`__](./docs/Guides/Benchmarking.md)
+* [__`How to write a good plugin`__](./docs/Guides/Write-Plugin.md)
+* [__`Plugins Guide`__](./docs/Guides/Plugins-Guide.md)
+* [__`HTTP2`__](./docs/Reference/HTTP2.md)
+* [__`Long Term Support`__](./docs/Reference/LTS.md)
+* [__`TypeScript and types support`__](./docs/Reference/TypeScript.md)
+* [__`Serverless`__](./docs/Guides/Serverless.md)
+* [__`Recommendations`__](./docs/Guides/Recommendations.md)
 
 中文文档[地址](https://github.com/fastify/docs-chinese/blob/HEAD/README.md)
 
@@ -325,6 +318,8 @@ listed in alphabetical order.
   <https://twitter.com/manueomm>, <https://www.npmjs.com/~eomm>
 * [__James Sumners__](https://github.com/jsumners),
   <https://twitter.com/jsumners79>, <https://www.npmjs.com/~jsumners>
+* [__Aras Abbasi__](https://github.com/uzlopak),
+  <https://www.npmjs.com/~uzlopak>
 
 ### Fastify Plugins team
 * [__Matteo Collina__](https://github.com/mcollina),
@@ -347,6 +342,8 @@ listed in alphabetical order.
   <https://twitter.com/manueomm>, <https://www.npmjs.com/~eomm>
 * [__Simone Busoli__](https://github.com/simoneb),
   <https://twitter.com/simonebu>, <https://www.npmjs.com/~simoneb>
+* [__Gürgün Dayıoğlu__](https://github.com/gurgunday),
+  <https://www.npmjs.com/~gurgunday>
 
 ### Great Contributors
 Great contributors on a specific area in the Fastify ecosystem will be invited

package/build/build-error-serializer.js

@@ -2,8 +2,8 @@
 'use strict'
 
 const FJS = require('fast-json-stringify')
-const path = require('path')
-const fs = require('fs')
+const path = require('node:path')
+const fs = require('node:fs')
 
 const code = FJS({
   type: 'object',

package/build/build-validation.js

@@ -2,8 +2,8 @@
 
 const AjvStandaloneCompiler = require('@fastify/ajv-compiler/standalone')
 const { _ } = require('ajv')
-const fs = require('fs')
-const path = require('path')
+const fs = require('node:fs')
+const path = require('node:path')
 
 const factory = AjvStandaloneCompiler({
   readMode: false,

package/build/sync-version.js

@@ -1,7 +1,7 @@
 'use strict'
 
-const fs = require('fs')
-const path = require('path')
+const fs = require('node:fs')
+const path = require('node:path')
 
 // package.json:version -> fastify.js:VERSION
 const { version } = JSON.parse(fs.readFileSync(path.join(__dirname, '..', 'package.json')).toString('utf8'))

package/docs/Guides/Database.md

@@ -275,7 +275,7 @@ CREATE TABLE IF NOT EXISTS users (
 ```javascript
 const pg = require('pg')
 const Postgrator = require('postgrator')
-const path = require('path')
+const path = require('node:path')
 
 async function migrate() {
   const client = new pg.Client({

package/docs/Guides/Delay-Accepting-Requests.md

@@ -135,7 +135,7 @@ follows:
 
 ```js
 const { fetch } = require('undici')
-const { setTimeout } = require('timers/promises')
+const { setTimeout } = require('node:timers/promises')
 
 const MAGIC_KEY = '12345'
 
@@ -249,7 +249,7 @@ server.listen({ port: '1234' })
 
 ```js
 const { fetch } = require('undici')
-const { setTimeout } = require('timers/promises')
+const { setTimeout } = require('node:timers/promises')
 
 const MAGIC_KEY = '12345'
 

package/docs/Guides/Ecosystem.md

@@ -122,7 +122,7 @@ section.
   serving Swagger/OpenAPI documentation for Fastify, supporting dynamic
   generation.
 - [`@fastify/throttle`](https://github.com/fastify/fastify-throttle) Plugin for
-- throttling the download speed of a request.
+  throttling the download speed of a request.
 - [`@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/)
@@ -671,7 +671,9 @@ middlewares into Fastify plugins
   and lightweight Sequelize plugin for Fastify.
 - [`typeorm-fastify-plugin`](https://github.com/jclemens24/fastify-typeorm) A simple
   and updated Typeorm plugin for use with Fastify.
+
 #### [Community Tools](#community-tools)
+
 - [`@fastify-userland/workflows`](https://github.com/fastify-userland/workflows)
   Reusable workflows for use in the Fastify plugin
 - [`fast-maker`](https://github.com/imjuni/fast-maker) route configuration

package/docs/Guides/Getting-Started.md

@@ -14,11 +14,12 @@ Let's start!
 <a id="install"></a>
 
 Install with npm:
-```
+```sh
 npm i fastify
 ```
+
 Install with yarn:
-```
+```sh
 yarn add fastify
 ```
 
@@ -208,7 +209,7 @@ Let's rewrite the above example with a database connection.
 
 First, install `fastify-plugin` and `@fastify/mongodb`:
 
-```
+```sh
 npm i fastify-plugin @fastify/mongodb
 ```
 
@@ -550,7 +551,7 @@ Fastify also has CLI integration thanks to
 
 First, install `fastify-cli`:
 
-```
+```sh
 npm i fastify-cli
 ```
 

package/docs/Guides/Migration-Guide-V4.md

@@ -184,25 +184,28 @@ strict mode: use allowUnionTypes to allow union type keyword at "#/properties/im
 ```
 
 As such, schemas like below will need to be changed from:
-```
-type: 'object',
-properties: {
-  api_key: { type: 'string' },
-  image: { type: ['object', 'array'] }
-  }
+```js
+{
+  type: 'object',
+  properties: {
+    api_key: { type: 'string' },
+    image: { type: ['object', 'array'] }
+  } 
 }
 ```
 
 Into:
-```
-type: 'object',
-properties: {
-  api_key: { type: 'string' },
-  image: {
-    anyOf: [
-      { type: 'array' },
-      { type: 'object' }
-    ]
+```js
+{
+  type: 'object',
+  properties: {
+    api_key: { type: 'string' },
+    image: {
+      anyOf: [
+        { type: 'array' },
+        { type: 'object' }
+      ]
+    }
   }
 }
 ```

package/docs/Reference/ContentTypeParser.md

@@ -97,7 +97,6 @@ if (!fastify.hasContentTypeParser('application/jsoff')){
 }
 ```
 
-=======
 #### removeContentTypeParser
 
 With `removeContentTypeParser` a single or an array of content types can be

package/docs/Reference/HTTP2.md

@@ -15,8 +15,8 @@ HTTP2 is supported in all modern browsers __only over a secure connection__:
 ```js
 'use strict'
 
-const fs = require('fs')
-const path = require('path')
+const fs = require('node:fs')
+const path = require('node:path')
 const fastify = require('fastify')({
   http2: true,
   https: {
@@ -42,8 +42,8 @@ box:
 ```js
 'use strict'
 
-const fs = require('fs')
-const path = require('path')
+const fs = require('node:fs')
+const path = require('node:path')
 const fastify = require('fastify')({
   http2: true,
   https: {

package/docs/Reference/Hooks.md

@@ -24,6 +24,7 @@ are Request/Reply hooks and application hooks:
   - [Respond to a request from a hook](#respond-to-a-request-from-a-hook)
 - [Application Hooks](#application-hooks)
   - [onReady](#onready)
+  - [onListen](#onlisten)
   - [onClose](#onclose)
   - [preClose](#preclose)
   - [onRoute](#onroute)
@@ -388,6 +389,7 @@ fastify.addHook('preHandler', async (request, reply) => {
 You can hook into the application-lifecycle as well.
 
 - [onReady](#onready)
+- [onListen](#onlisten)
 - [onClose](#onclose)
 - [preClose](#preclose)
 - [onRoute](#onroute)
@@ -416,6 +418,33 @@ fastify.addHook('onReady', async function () {
 })
 ```
 
+### onListen
+
+Triggered when the server starts listening for requests. The hooks run one 
+after another. If a hook function causes an error, it is logged and 
+ignored, allowing the queue of hooks to continue. Hook functions accept one
+argument: a callback, `done`, to be invoked after the hook function is
+complete. Hook functions are invoked with `this` bound to the associated
+Fastify instance.
+
+This is an alternative to `fastify.server.on('listening', () => {})`.
+
+```js
+// callback style
+fastify.addHook('onListen', function (done) {
+  // Some code
+  const err = null;
+  done(err)
+})
+
+// or async/await style
+fastify.addHook('onListen', async function () {
+  // Some async code
+})
+```
+
+> **Note**  
+> This hook will not run when the server is started using `fastify.inject()` or `fastify.ready()`
 ### onClose
 <a id="on-close"></a>
 
@@ -811,7 +840,7 @@ tools first" fashion.
 
 ```js
 const tracer = /* retrieved from elsewhere in the package */
-const dc = require('diagnostics_channel')
+const dc = require('node:diagnostics_channel')
 const channel = dc.channel('fastify.initialization')
 const spans = new WeakMap()
 

package/docs/Reference/Middleware.md

@@ -54,7 +54,7 @@ the first parameter to `use` and you are done!
 `/user/:id/comments`) and wildcards are not supported in multiple paths.*
 
 ```js
-const path = require('path')
+const path = require('node:path')
 const serveStatic = require('serve-static')
 
 // Single path

package/docs/Reference/Principles.md

@@ -65,7 +65,7 @@ Testing Fastify applications should be a first-class concern.
 
 ## Do not monkeypatch core
 
-Moonkeypatch Node.js APIs or installing globals that alter the behavior of the
+Monkeypatch Node.js APIs or installing globals that alter the behavior of the
 runtime makes building modular applications harder, and limit the use cases of Fastify.
 Other frameworks do this and we do not.
 

package/docs/Reference/Reply.md

@@ -242,7 +242,7 @@ reply.trailer('server-timing', function() {
   return 'db;dur=53, app;dur=47.2'
 })
 
-const { createHash } = require('crypto')
+const { createHash } = require('node:crypto')
 // trailer function also receive two argument
 // @param {object} reply fastify reply
 // @param {string|Buffer|null} payload payload that already sent, note that it will be null when stream is sent
@@ -668,7 +668,7 @@ fastify.get('/json', options, function (request, reply) {
 `'application/octet-stream'`.
 ```js
 fastify.get('/streams', function (request, reply) {
-  const fs = require('fs')
+  const fs = require('node:fs')
   const stream = fs.createReadStream('some-file', 'utf8')
   reply.header('Content-Type', 'application/octet-stream')
   reply.send(stream)
@@ -677,7 +677,7 @@ fastify.get('/streams', function (request, reply) {
 When using async-await you will need to return or await the reply object:
 ```js
 fastify.get('/streams', async function (request, reply) {
-  const fs = require('fs')
+  const fs = require('node:fs')
   const stream = fs.createReadStream('some-file', 'utf8')
   reply.header('Content-Type', 'application/octet-stream')
   return reply.send(stream)
@@ -690,7 +690,7 @@ fastify.get('/streams', async function (request, reply) {
 If you are sending a buffer and you have not set a `'Content-Type'` header,
 *send* will set it to `'application/octet-stream'`.
 ```js
-const fs = require('fs')
+const fs = require('node:fs')
 fastify.get('/streams', function (request, reply) {
   fs.readFile('some-file', (err, fileBuffer) => {
     reply.send(err || fileBuffer)
@@ -700,7 +700,7 @@ fastify.get('/streams', function (request, reply) {
 
 When using async-await you will need to return or await the reply object:
 ```js
-const fs = require('fs')
+const fs = require('node:fs')
 fastify.get('/streams', async function (request, reply) {
   fs.readFile('some-file', (err, fileBuffer) => {
     reply.send(err || fileBuffer)
@@ -715,7 +715,7 @@ fastify.get('/streams', async function (request, reply) {
 `send` manages TypedArray and sets the `'Content-Type'=application/octet-stream'`
 header if not already set.
 ```js
-const fs = require('fs')
+const fs = require('node:fs')
 fastify.get('/streams', function (request, reply) {
   const typedArray = new Uint16Array(10)
   reply.send(typedArray)
@@ -842,7 +842,7 @@ Fastify natively handles promises and supports async-await.
 
 *Note that in the following examples we are not using reply.send.*
 ```js
-const { promisify } = require('util')
+const { promisify } = require('node:util')
 const delay = promisify(setTimeout)
 
 fastify.get('/promises', options, function (request, reply) {

package/docs/Reference/Request.md

@@ -29,10 +29,10 @@ Request is a core Fastify object containing the following fields:
 - `url` - the URL of the incoming request
 - `originalUrl` - similar to `url`, this allows you to access the 
   original `url` in case of internal re-routing 
-- `routerMethod` - the method defined for the router that is handling the
-  request
-- `routerPath` - the path pattern defined for the router that is handling the
-  request
+- `routerMethod` - Deprecated, use `request.routeOptions.method` instead. The
+  method defined for the router that is handling the request
+- `routerPath` - Deprecated, use `request.routeOptions.config.url` instead. The
+  path pattern defined for the router that is handling the request
 - `is404` - true if request is being handled by 404 handler, false if it is not
 - `connection` - Deprecated, use `socket` instead. The underlying connection of
   the incoming request.
@@ -40,17 +40,21 @@ Request is a core Fastify object containing the following fields:
 - `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) 
+- `routeSchema` - Deprecated, use `request.routeOptions.schema` instead. The
+  scheme definition set for the router that is handling the request
+- `routeConfig` - Deprecated, use `request.routeOptions.config` instead. The
+  route [`config`](./Routes.md#routes-config) 
   object.
 - `routeOptions` - The route [`option`](./Routes.md#routes-options) object
   - `bodyLimit` - either server limit or route limit
+  - `config` - the [`config`](./Routes.md#routes-config) object for this route
   - `method` - the http method for the route
   - `url` - the path of the URL to match this route
+  - `handler` - the handler for this route
   - `attachValidation` - attach `validationError` to request 
     (if there is a schema defined)
   - `logLevel` - log level defined for this route
+  - `schema` - the JSON schemas definition for this route
   - `version` -  a semver compatible string that defines the version of the endpoint
   - `exposeHeadRoute` - creates a sibling HEAD route for any GET routes
   - `prefixTrailingSlash` - string used to determine how to handle passing / 

package/docs/Reference/Server.md

@@ -635,7 +635,7 @@ You can also use Fastify's default parser but change some handling behavior,
 like the example below for case insensitive keys and values:
 
 ```js
-const querystring = require('querystring')
+const querystring = require('node:querystring')
 const fastify = require('fastify')({
   querystringParser: str => querystring.parse(str.toLowerCase())
 })
@@ -1892,7 +1892,7 @@ The properties that can currently be exposed are:
 - http2SessionTimeout
 
 ```js
-const { readFileSync } = require('fs')
+const { readFileSync } = require('node:fs')
 const Fastify = require('fastify')
 
 const fastify = Fastify({

package/examples/asyncawait.js

@@ -32,5 +32,7 @@ fastify
   })
 
 fastify.listen({ port: 3000 }, err => {
-  if (err) throw err
+  if (err) {
+    throw err
+  }
 })

package/examples/benchmark/parser.js

@@ -5,7 +5,7 @@ const fastify = require('../../fastify')({
 })
 
 const jsonParser = require('fast-json-body')
-const querystring = require('querystring')
+const querystring = require('node:querystring')
 
 // Handled by fastify
 // curl -X POST -d '{"hello":"world"}' -H'Content-type: application/json' http://localhost:3000/

package/examples/hooks.js

@@ -68,6 +68,9 @@ fastify
   .addHook('onRoute', function (routeOptions) {
     console.log('onRoute')
   })
+  .addHook('onListen', async function () {
+    console.log('onListen')
+  })
   .addHook('onClose', function (instance, done) {
     console.log('onClose')
     done()

package/examples/http2.js

@@ -1,7 +1,7 @@
 'use strict'
 
-const fs = require('fs')
-const path = require('path')
+const fs = require('node:fs')
+const path = require('node:path')
 const fastify = require('../fastify')({
   http2: true,
   https: {
@@ -33,5 +33,7 @@ fastify
   })
 
 fastify.listen({ port: 3000 }, err => {
-  if (err) throw err
+  if (err) {
+    throw err
+  }
 })

package/examples/https.js

@@ -1,7 +1,7 @@
 'use strict'
 
-const fs = require('fs')
-const path = require('path')
+const fs = require('node:fs')
+const path = require('node:path')
 const fastify = require('../fastify')({
   https: {
     key: fs.readFileSync(path.join(__dirname, '../test/https/fastify.key')),
@@ -32,5 +32,7 @@ fastify
   })
 
 fastify.listen({ port: 3000 }, err => {
-  if (err) throw err
+  if (err) {
+    throw err
+  }
 })

package/examples/parser.js

@@ -2,7 +2,7 @@
 
 const fastify = require('../fastify')({ logger: true })
 const jsonParser = require('fast-json-body')
-const querystring = require('querystring')
+const querystring = require('node:querystring')
 
 // Handled by fastify
 // curl -X POST -d '{"hello":"world"}' -H'Content-type: application/json' http://localhost:3000/
@@ -47,5 +47,7 @@ fastify
   })
 
 fastify.listen({ port: 3000 }, err => {
-  if (err) throw err
+  if (err) {
+    throw err
+  }
 })

package/examples/shared-schema.js

@@ -32,5 +32,7 @@ fastify
   })
 
 fastify.listen({ port: 3000 }, err => {
-  if (err) throw err
+  if (err) {
+    throw err
+  }
 })

package/examples/simple-stream.js

@@ -4,7 +4,7 @@ const fastify = require('../fastify')({
   logger: false
 })
 
-const Readable = require('stream').Readable
+const Readable = require('node:stream').Readable
 
 fastify
   .get('/', function (req, reply) {
@@ -13,6 +13,8 @@ fastify
   })
 
 fastify.listen({ port: 3000 }, (err, address) => {
-  if (err) throw err
+  if (err) {
+    throw err
+  }
   fastify.log.info(`server listening on ${address}`)
 })

package/examples/simple.js

@@ -26,5 +26,7 @@ fastify
   })
 
 fastify.listen({ port: 3000 }, (err, address) => {
-  if (err) throw err
+  if (err) {
+    throw err
+  }
 })

package/examples/typescript-server.ts

@@ -75,4 +75,5 @@ server.listen({ port: 8080 }, (err, address) => {
     console.error(err);
     process.exit(1);
   }
+   console.log(`server listening on ${address}`)
 });

package/examples/use-plugin.js

@@ -15,7 +15,9 @@ const opts = {
   }
 }
 fastify.register(require('./plugin'), opts, function (err) {
-  if (err) throw err
+  if (err) {
+    throw err
+  }
 })
 
 fastify.listen({ port: 3000 }, function (err) {