fastify 4.28.1 → 4.29.1

package/SPONSORS.md

@@ -14,6 +14,8 @@ _Be the first!_
 ## Tier 3
 
 - [Mercedes-Benz Group](https://github.com/mercedes-benz)
+- [Val Town, Inc.](https://opencollective.com/valtown)
+- [Handsontable - JavaScript Data Grid](https://handsontable.com/docs/react-data-grid/?utm_source=Fastify_GH&utm_medium=sponsorship&utm_campaign=library_sponsorship_2024)
 
 ## Tier 2
 

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

@@ -6,6 +6,34 @@ Before migrating to v4, please ensure that you have fixed all deprecation
 warnings from v3. All v3 deprecations have been removed and they will no longer
 work after upgrading.
 
+## Codemods
+### Fastify v4 Codemods
+
+To help with the upgrade, we’ve worked with the team at 
+[Codemod](https://github.com/codemod-com/codemod) to
+publish codemods that will automatically update your code to many of 
+the new APIs and patterns in Fastify v4.
+
+Run the following 
+[migration recipe](https://go.codemod.com/fastify-4-migration-recipe) to 
+automatically update your code to Fastify v4:
+
+```
+npx codemod@latest fastify/4/migration-recipe
+```
+
+This will run the following codemods:
+
+- [`fastify/4/remove-app-use`](https://go.codemod.com/fastify-4-remove-app-use)
+- [`fastify/4/reply-raw-access`](https://go.codemod.com/fastify-4-reply-raw-access)
+- [`fastify/4/wrap-routes-plugin`](https://go.codemod.com/fastify-4-wrap-routes-plugin)
+- [`fastify/4/await-register-calls`](https://go.codemod.com/fastify-4-await-register-calls)
+
+Each of these codemods automates the changes listed in the v4 migration guide.
+For a complete list of available Fastify codemods and further details, 
+see [Codemod Registry](https://go.codemod.com/fastify).
+
+
 ## Breaking Changes
 
 ### Error handling composition ([#3261](https://github.com/fastify/fastify/pull/3261))
@@ -55,11 +83,23 @@ If you need to use middleware, use
 continue to be maintained.
 However, it is strongly recommended that you migrate to Fastify's [hooks](../Reference/Hooks.md).
 
+> **Note**: Codemod remove `app.use()` with:
+>
+> ```bash
+> npx codemod@latest fastify/4/remove-app-use
+> ```
+
 ### `reply.res` moved to `reply.raw`
 
 If you previously used the `reply.res` attribute to access the underlying Request
 object you will now need to use `reply.raw`.
 
+> **Note**: Codemod `reply.res` to `reply.raw` with:
+>
+> ```bash
+> npx codemod@latest fastify/4/reply-raw-access
+> ```
+
 ### Need to `return reply` to signal a "fork" of the promise chain
 
 In some situations, like when a response is sent asynchronously or when you are
@@ -105,6 +145,11 @@ As a result, if you specify an `onRoute` hook in a plugin you should now either:
     done();
   });
   ```
+> **Note**: Codemod synchronous route definitions with:
+>
+> ```bash
+> npx codemod@latest fastify/4/wrap-routes-plugin
+> ```
 
 * use `await register(...)`
 
@@ -130,6 +175,13 @@ As a result, if you specify an `onRoute` hook in a plugin you should now either:
   });
   ```
 
+> **Note**: Codemod 'await register(...)' with:
+>
+> ```bash
+> npx codemod@latest fastify/4/await-register-calls
+> ```
+
+
 ### Optional URL parameters
 
 If you've already used any implicitly optional parameters, you'll get a 404

package/docs/Reference/Routes.md

@@ -43,7 +43,8 @@ fastify.route(options)
   [here](./Validation-and-Serialization.md) for more info.
 
   * `body`: validates the body of the request if it is a POST, PUT, PATCH,
-    TRACE, SEARCH, PROPFIND, PROPPATCH or LOCK method.
+    TRACE, SEARCH, PROPFIND, PROPPATCH, COPY, MOVE, MKCOL, REPORT, MKCALENDAR
+    or LOCK 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/Server.md

@@ -272,6 +272,8 @@ fastify.get('///foo//bar//', function (req, reply) {
 ### `maxParamLength`
 <a id="factory-max-param-length"></a>
 
++ Default: `100`
+
 You can set a custom length for parameters in parametric (standard, regex, and
 multi) routes by using `maxParamLength` option; the default value is 100
 characters. If the maximum length limit is reached, the not found route will

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

@@ -235,6 +235,28 @@ const schema = {
 fastify.post('/the/url', { schema }, handler)
 ```
 
+For `body` schema, it is further possible to differentiate the schema per content
+type by nesting the schemas inside `content` property. The schema validation
+will be applied based on the `Content-Type` header in the request.
+
+```js
+fastify.post('/the/url', {
+  schema: {
+    body: {
+      content: {
+        'application/json': {
+          schema: { type: 'object' }
+        },
+        'text/plain': {
+          schema: { type: 'string' }
+        }
+        // Other content types will not be validated
+      }
+    }
+  }
+}, handler)
+```
+
 *Note that Ajv will try to [coerce](https://ajv.js.org/coercion.html) the values
 to the types specified in your schema `type` keywords, both to pass the
 validation and to use the correctly typed data afterwards.*

package/docs/Reference/Warnings.md

@@ -25,6 +25,7 @@
     - [FSTDEP019](#FSTDEP019)
     - [FSTDEP020](#FSTDEP020)
     - [FSTDEP021](#FSTDEP021)
+    - [FSTDEP022](#FSTDEP022)
 
 
 ## Warnings
@@ -92,3 +93,4 @@ Deprecation codes are further supported by the Node.js CLI options:
 | <a id="FSTDEP019">FSTDEP019</a> | You are accessing the deprecated `reply.context` property. | Use `reply.routeOptions.config` or `reply.routeOptions.schema`. | [#5032](https://github.com/fastify/fastify/pull/5032) [#5084](https://github.com/fastify/fastify/pull/5084) |
 | <a id="FSTDEP020">FSTDEP020</a> | You are using the deprecated `reply.getReponseTime()` method. | Use the `reply.elapsedTime` property instead. | [#5263](https://github.com/fastify/fastify/pull/5263) |
 | <a id="FSTDEP021">FSTDEP021</a> | The `reply.redirect()` method has a new signature: `reply.redirect(url: string, code?: number)`. It will be enforced in `fastify@v5`'. | [#5483](https://github.com/fastify/fastify/pull/5483) |
+| <a id="FSTDEP022">FSTDEP022</a> | You are using the deprecated json shorthand schema on route %s. Specify full object schema instead. It will be removed in `fastify@v5` | [#5483](https://github.com/fastify/fastify/pull/0000) |

package/fastify.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const VERSION = '4.28.1'
+const VERSION = '4.29.1'
 
 const Avvio = require('avvio')
 const http = require('node:http')
@@ -671,7 +671,7 @@ function fastify (options) {
     }
 
     if (name === 'onClose') {
-      this.onClose(fn)
+      this.onClose(fn.bind(this))
     } else if (name === 'onReady' || name === 'onListen' || name === 'onRoute') {
       this[kHooks].add(name, fn)
     } else {

package/lib/handleRequest.js

@@ -28,7 +28,8 @@ function handleRequest (err, request, reply) {
   const contentType = headers['content-type']
 
   if (method === 'POST' || method === 'PUT' || method === 'PATCH' || method === 'TRACE' || method === 'SEARCH' ||
-    method === 'PROPFIND' || method === 'PROPPATCH' || method === 'LOCK' || method === 'REPORT' || method === 'MKCALENDAR') {
+    method === 'PROPFIND' || method === 'PROPPATCH' || method === 'LOCK' || method === 'COPY' || method === 'MOVE' ||
+    method === 'MKCOL' || method === 'REPORT' || method === 'MKCALENDAR') {
     if (contentType === undefined) {
       if (
         headers['transfer-encoding'] === undefined &&

package/lib/reply.js

@@ -602,14 +602,30 @@ function onSendEnd (reply, payload) {
     reply.header('Trailer', header.trim())
   }
 
-  // since Response contain status code, we need to update before
-  // any action that used statusCode
-  const isResponse = toString.call(payload) === '[object Response]'
-  if (isResponse) {
+  // since Response contain status code, headers and body,
+  // we need to update the status, add the headers and use it's body as payload
+  // before continuing
+  if (toString.call(payload) === '[object Response]') {
     // https://developer.mozilla.org/en-US/docs/Web/API/Response/status
     if (typeof payload.status === 'number') {
       reply.code(payload.status)
     }
+
+    // https://developer.mozilla.org/en-US/docs/Web/API/Response/headers
+    if (typeof payload.headers === 'object' && typeof payload.headers.forEach === 'function') {
+      for (const [headerName, headerValue] of payload.headers) {
+        reply.header(headerName, headerValue)
+      }
+    }
+
+    // https://developer.mozilla.org/en-US/docs/Web/API/Response/body
+    if (payload.body !== null) {
+      if (payload.bodyUsed) {
+        throw new FST_ERR_REP_RESPONSE_BODY_CONSUMED()
+      }
+    }
+    // Keep going, body is either null or ReadableStream
+    payload = payload.body
   }
   const statusCode = res.statusCode
 
@@ -656,26 +672,6 @@ function onSendEnd (reply, payload) {
     return
   }
 
-  // Response
-  if (isResponse) {
-    // https://developer.mozilla.org/en-US/docs/Web/API/Response/headers
-    if (typeof payload.headers === 'object' && typeof payload.headers.forEach === 'function') {
-      for (const [headerName, headerValue] of payload.headers) {
-        reply.header(headerName, headerValue)
-      }
-    }
-
-    // https://developer.mozilla.org/en-US/docs/Web/API/Response/body
-    if (payload.body != null) {
-      if (payload.bodyUsed) {
-        throw new FST_ERR_REP_RESPONSE_BODY_CONSUMED()
-      }
-      // Response.body always a ReadableStream
-      sendWebStream(payload.body, res, reply)
-    }
-    return
-  }
-
   if (typeof payload !== 'string' && !Buffer.isBuffer(payload)) {
     throw new FST_ERR_REP_INVALID_PAYLOAD_TYPE(typeof payload)
   }
@@ -726,7 +722,7 @@ function sendStream (payload, res, reply) {
       if (res.headersSent || reply.request.raw.aborted === true) {
         if (!errorLogged) {
           errorLogged = true
-          logStreamError(reply.log, err, res)
+          logStreamError(reply.log, err, reply)
         }
         res.destroy()
       } else {

package/lib/route.js

@@ -366,7 +366,7 @@ function buildRouting (options) {
         // any route insertion error created by fastify can be safely ignore
         // because it only duplicate route for head
         if (!context[kRouteByFastify]) {
-          const isDuplicatedRoute = error.message.includes(`Method '${opts.method}' already declared for route '${opts.url}'`)
+          const isDuplicatedRoute = error.message.includes(`Method '${opts.method}' already declared for route`)
           if (isDuplicatedRoute) {
             throw new FST_ERR_DUPLICATED_ROUTE(opts.method, opts.url)
           }
@@ -407,7 +407,7 @@ function buildRouting (options) {
           fourOhFour.setContext(this, context)
 
           if (opts.schema) {
-            context.schema = normalizeSchema(context.schema, this.initialConfig)
+            context.schema = normalizeSchema(opts, context.schema, this.initialConfig)
 
             const schemaController = this[kSchemaController]
             if (!opts.validatorCompiler && (opts.schema.body || opts.schema.headers || opts.schema.querystring || opts.schema.params)) {

package/lib/schemas.js

@@ -4,6 +4,9 @@ const fastClone = require('rfdc')({ circles: false, proto: true })
 const { kSchemaVisited, kSchemaResponse } = require('./symbols')
 const kFluentSchema = Symbol.for('fluent-schema-object')
 
+const {
+  FSTDEP022
+} = require('./warnings')
 const {
   FST_ERR_SCH_MISSING_ID,
   FST_ERR_SCH_ALREADY_PRESENT,
@@ -54,7 +57,7 @@ function isCustomSchemaPrototype (schema) {
   return typeof schema === 'object' && Object.getPrototypeOf(schema) !== Object.prototype
 }
 
-function normalizeSchema (routeSchemas, serverOptions) {
+function normalizeSchema (opts, routeSchemas, serverOptions) {
   if (routeSchemas[kSchemaVisited]) {
     return routeSchemas
   }
@@ -73,7 +76,20 @@ function normalizeSchema (routeSchemas, serverOptions) {
   for (const key of SCHEMAS_SOURCE) {
     const schema = routeSchemas[key]
     if (schema && !isCustomSchemaPrototype(schema)) {
-      routeSchemas[key] = getSchemaAnyway(schema, serverOptions.jsonShorthand)
+      if (key === 'body' && schema.content) {
+        const contentProperty = schema.content
+        const keys = Object.keys(contentProperty)
+        for (let i = 0; i < keys.length; i++) {
+          const contentType = keys[i]
+          const contentSchema = contentProperty[contentType].schema
+          if (!contentSchema) {
+            throw new FST_ERR_SCH_CONTENT_MISSING_SCHEMA(contentType)
+          }
+          routeSchemas.body.content[contentType].schema = getSchemaAnyway(opts.url, contentSchema, serverOptions.jsonShorthand)
+        }
+        continue
+      }
+      routeSchemas[key] = getSchemaAnyway(opts.url, schema, serverOptions.jsonShorthand)
     }
   }
 
@@ -95,7 +111,7 @@ function normalizeSchema (routeSchemas, serverOptions) {
             if (keys.length === 1) { break }
             throw new FST_ERR_SCH_CONTENT_MISSING_SCHEMA(mediaName)
           }
-          routeSchemas.response[code].content[mediaName].schema = getSchemaAnyway(contentProperty[mediaName].schema, serverOptions.jsonShorthand)
+          routeSchemas.response[code].content[mediaName].schema = getSchemaAnyway(opts.url, contentProperty[mediaName].schema, serverOptions.jsonShorthand)
           if (i === keys.length - 1) {
             hasContentMultipleContentTypes = true
           }
@@ -103,7 +119,7 @@ function normalizeSchema (routeSchemas, serverOptions) {
       }
 
       if (!hasContentMultipleContentTypes) {
-        routeSchemas.response[code] = getSchemaAnyway(routeSchemas.response[code], serverOptions.jsonShorthand)
+        routeSchemas.response[code] = getSchemaAnyway(opts.url, routeSchemas.response[code], serverOptions.jsonShorthand)
       }
     }
   }
@@ -129,9 +145,10 @@ function generateFluentSchema (schema) {
   }
 }
 
-function getSchemaAnyway (schema, jsonShorthand) {
+function getSchemaAnyway (url, schema, jsonShorthand) {
   if (!jsonShorthand || schema.$ref || schema.oneOf || schema.allOf || schema.anyOf || schema.$merge || schema.$patch) return schema
   if (!schema.type && !schema.properties) {
+    FSTDEP022(url)
     return {
       type: 'object',
       properties: schema

package/lib/server.js

@@ -72,7 +72,8 @@ function createServer (options, httpHandler) {
     } else {
       host = listenOptions.host
     }
-    if (Object.prototype.hasOwnProperty.call(listenOptions, 'host') === false) {
+    if (Object.prototype.hasOwnProperty.call(listenOptions, 'host') === false ||
+      listenOptions.host == null) {
       listenOptions.host = host
     }
     if (host === 'localhost') {

package/lib/validation.js

@@ -87,7 +87,17 @@ function compileSchemasForValidation (context, compile, isCustom) {
   }
 
   if (schema.body) {
-    context[bodySchema] = compile({ schema: schema.body, method, url, httpPart: 'body' })
+    const contentProperty = schema.body.content
+    if (contentProperty) {
+      const contentTypeSchemas = {}
+      for (const contentType of Object.keys(contentProperty)) {
+        const contentSchema = contentProperty[contentType].schema
+        contentTypeSchemas[contentType] = compile({ schema: contentSchema, method, url, httpPart: 'body', contentType })
+      }
+      context[bodySchema] = contentTypeSchemas
+    } else {
+      context[bodySchema] = compile({ schema: schema.body, method, url, httpPart: 'body' })
+    }
   } else if (Object.prototype.hasOwnProperty.call(schema, 'body')) {
     FSTWRN001('body', method, url)
   }
@@ -140,7 +150,18 @@ function validate (context, request, execution) {
   }
 
   if (runExecution || !execution.skipBody) {
-    const body = validateParam(context[bodySchema], request, 'body')
+    let validatorFunction = null
+    if (typeof context[bodySchema] === 'function') {
+      validatorFunction = context[bodySchema]
+    } else if (context[bodySchema]) {
+      // TODO: add request.contentType and reuse it here
+      const contentType = getEssenceMediaType(request.headers['content-type'])
+      const contentSchema = context[bodySchema][contentType]
+      if (contentSchema) {
+        validatorFunction = contentSchema
+      }
+    }
+    const body = validateParam(validatorFunction, request, 'body')
     if (body) {
       if (typeof body.then !== 'function') {
         return wrapValidationError(body, 'body', context.schemaErrorFormatter)
@@ -233,6 +254,16 @@ function wrapValidationError (result, dataVar, schemaErrorFormatter) {
   return error
 }
 
+/**
+ * simple function to retrieve the essence media type
+ * @param {string} header
+ * @returns {string} Mimetype string.
+ */
+function getEssenceMediaType (header) {
+  if (!header) return ''
+  return header.split(/[ ;]/, 1)[0].trim().toLowerCase()
+}
+
 module.exports = {
   symbols: { bodySchema, querystringSchema, responseSchema, paramsSchema, headersSchema },
   compileSchemasForValidation,

package/lib/warnings.js

@@ -87,6 +87,11 @@ const FSTDEP021 = createDeprecation({
   message: 'The `reply.redirect()` method has a new signature: `reply.redirect(url: string, code?: number)`. It will be enforced in `fastify@v5`'
 })
 
+const FSTDEP022 = createDeprecation({
+  code: 'FSTDEP021',
+  message: 'You are using the deprecated json shorthand schema on route %s. Specify full object schema instead. It will be removed in `fastify@v5`'
+})
+
 const FSTWRN001 = createWarning({
   name: 'FastifyWarning',
   code: 'FSTWRN001',
@@ -119,6 +124,7 @@ module.exports = {
   FSTDEP019,
   FSTDEP020,
   FSTDEP021,
+  FSTDEP022,
   FSTWRN001,
   FSTWRN002
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fastify",
-  "version": "4.28.1",
+  "version": "4.29.1",
   "description": "Fast and low overhead web framework, for Node.js",
   "main": "fastify.js",
   "type": "commonjs",

package/test/close.test.js

@@ -10,11 +10,14 @@ const split = require('split2')
 const { sleep } = require('./helper')
 
 test('close callback', t => {
-  t.plan(4)
+  t.plan(7)
   const fastify = Fastify()
   fastify.addHook('onClose', onClose)
   function onClose (instance, done) {
+    t.type(fastify, this)
     t.type(fastify, instance)
+    t.equal(fastify, this)
+    t.equal(fastify, instance)
     done()
   }
 

package/test/copy.test.js

@@ -12,7 +12,10 @@ test('can be created - copy', t => {
       method: 'COPY',
       url: '*',
       handler: function (req, reply) {
-        reply.code(204).send()
+        reply.code(204)
+          .header('location', req.headers.destination)
+          .header('body', req.body.toString())
+          .send()
       }
     })
     t.pass()
@@ -26,15 +29,19 @@ fastify.listen({ port: 0 }, err => {
   t.teardown(() => { fastify.close() })
 
   test('request - copy', t => {
-    t.plan(2)
+    t.plan(4)
     sget({
       url: `http://localhost:${fastify.server.address().port}/test.txt`,
       method: 'COPY',
       headers: {
-        Destination: '/test2.txt'
-      }
-    }, (err, response, body) => {
+        destination: '/test2.txt',
+        'Content-Type': 'text/plain'
+      },
+      body: '/test3.txt'
+    }, (err, response) => {
       t.error(err)
+      t.equal(response.headers.location, '/test2.txt')
+      t.equal(response.headers.body, '/test3.txt')
       t.equal(response.statusCode, 204)
     })
   })

package/test/internals/validation.test.js

@@ -63,7 +63,7 @@ test('build schema - output schema', t => {
   t.equal(typeof opts[symbols.responseSchema]['201'], 'function')
 })
 
-test('build schema - payload schema', t => {
+test('build schema - body schema', t => {
   t.plan(1)
   const opts = {
     schema: {
@@ -79,6 +79,32 @@ test('build schema - payload schema', t => {
   t.equal(typeof opts[symbols.bodySchema], 'function')
 })
 
+test('build schema - body with multiple content type schemas', t => {
+  t.plan(2)
+  const opts = {
+    schema: {
+      body: {
+        content: {
+          'application/json': {
+            schema: {
+              type: 'object',
+              properties: {
+                hello: { type: 'string' }
+              }
+            }
+          },
+          'text/plain': {
+            schema: { type: 'string' }
+          }
+        }
+      }
+    }
+  }
+  validation.compileSchemasForValidation(opts, ({ schema, method, url, httpPart }) => ajv.compile(schema))
+  t.type(opts[symbols.bodySchema]['application/json'], 'function')
+  t.type(opts[symbols.bodySchema]['text/plain'], 'function')
+})
+
 test('build schema - avoid repeated normalize schema', t => {
   t.plan(3)
   const serverConfig = {
@@ -94,10 +120,10 @@ test('build schema - avoid repeated normalize schema', t => {
       }
     }
   }
-  opts.schema = normalizeSchema(opts.schema, serverConfig)
+  opts.schema = normalizeSchema({}, opts.schema, serverConfig)
   t.not(kSchemaVisited, undefined)
   t.equal(opts.schema[kSchemaVisited], true)
-  t.equal(opts.schema, normalizeSchema(opts.schema, serverConfig))
+  t.equal(opts.schema, normalizeSchema({}, opts.schema, serverConfig))
 })
 
 test('build schema - query schema', t => {
@@ -115,7 +141,7 @@ test('build schema - query schema', t => {
       }
     }
   }
-  opts.schema = normalizeSchema(opts.schema, serverConfig)
+  opts.schema = normalizeSchema({}, opts.schema, serverConfig)
   validation.compileSchemasForValidation(opts, ({ schema, method, url, httpPart }) => ajv.compile(schema))
   t.type(opts[symbols.querystringSchema].schema.type, 'string')
   t.equal(typeof opts[symbols.querystringSchema], 'function')
@@ -133,7 +159,7 @@ test('build schema - query schema abbreviated', t => {
       }
     }
   }
-  opts.schema = normalizeSchema(opts.schema, serverConfig)
+  opts.schema = normalizeSchema({}, opts.schema, serverConfig)
   validation.compileSchemasForValidation(opts, ({ schema, method, url, httpPart }) => ajv.compile(schema))
   t.type(opts[symbols.querystringSchema].schema.type, 'string')
   t.equal(typeof opts[symbols.querystringSchema], 'function')
@@ -168,7 +194,7 @@ test('build schema - querystring schema abbreviated', t => {
       }
     }
   }
-  opts.schema = normalizeSchema(opts.schema, serverConfig)
+  opts.schema = normalizeSchema({}, opts.schema, serverConfig)
   validation.compileSchemasForValidation(opts, ({ schema, method, url, httpPart }) => ajv.compile(schema))
   t.type(opts[symbols.querystringSchema].schema.type, 'string')
   t.equal(typeof opts[symbols.querystringSchema], 'function')
@@ -196,7 +222,7 @@ test('build schema - must throw if querystring and query schema exist', t => {
         }
       }
     }
-    opts.schema = normalizeSchema(opts.schema, serverConfig)
+    opts.schema = normalizeSchema({}, opts.schema, serverConfig)
   } catch (err) {
     t.equal(err.code, 'FST_ERR_SCH_DUPLICATE')
     t.equal(err.message, 'Schema with \'querystring\' already present!')
@@ -354,7 +380,7 @@ test('build schema - mixed schema types are individually skipped or normalized',
   }]
 
   testCases.forEach((testCase) => {
-    const result = normalizeSchema(testCase.schema, { jsonShorthand: true })
+    const result = normalizeSchema({}, testCase.schema, { jsonShorthand: true })
     testCase.assertions(result)
   })
 })