fastify 5.0.0-alpha.2 → 5.0.0-alpha.4

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.*
@@ -618,37 +640,47 @@ You can even have a specific response schema for different content types.
 For example:
 ```js
 const schema = {
-      response: {
-        200: {
-          description: 'Response schema that support different content types'
-          content: {
-            'application/json': {
-              schema: {
-                name: { type: 'string' },
-                image: { type: 'string' },
-                address: { type: 'string' }
-              }
-            },
-            'application/vnd.v1+json': {
-              schema: {
-                type: 'array',
-                items: { $ref: 'test' }
-              }
-            }
+  response: {
+    200: {
+      description: 'Response schema that support different content types'
+      content: {
+        'application/json': {
+          schema: {
+            name: { type: 'string' },
+            image: { type: 'string' },
+            address: { type: 'string' }
           }
         },
-        '3xx': {
-          content: {
-            'application/vnd.v2+json': {
-              schema: {
-                fullName: { type: 'string' },
-                phone: { type: 'string' }
-              }
-            }
+        'application/vnd.v1+json': {
+          schema: {
+            type: 'array',
+            items: { $ref: 'test' }
+          }
+        }
+      }
+    },
+    '3xx': {
+      content: {
+        'application/vnd.v2+json': {
+          schema: {
+            fullName: { type: 'string' },
+            phone: { type: 'string' }
+          }
+        }
+      }
+    },
+    default: {
+      content: {
+        // */* is match-all content-type
+        '*/*': {
+          schema: {
+            desc: { type: 'string' }
           }
         }
       }
     }
+  }
+}
 
 fastify.post('/url', { schema }, handler)
 ```
@@ -673,8 +705,11 @@ fastify.get('/user', {
   schema: {
     response: {
       '2xx': {
-        id: { type: 'number' },
-        name: { type: 'string' }
+        type: 'object',
+        properties: {
+          id: { type: 'number' },
+          name: { type: 'string' }
+        }
       }
     }
   }

package/docs/Reference/Warnings.md

@@ -8,19 +8,6 @@
     - [FSTWRN001](#FSTWRN001)
     - [FSTWRN002](#FSTWRN002)
   - [Fastify Deprecation Codes](#fastify-deprecation-codes)
-    - [FSTDEP005](#FSTDEP005)
-    - [FSTDEP007](#FSTDEP007)
-    - [FSTDEP008](#FSTDEP008)
-    - [FSTDEP009](#FSTDEP009)
-    - [FSTDEP010](#FSTDEP010)
-    - [FSTDEP012](#FSTDEP012)
-    - [FSTDEP013](#FSTDEP013)
-    - [FSTDEP015](#FSTDEP015)
-    - [FSTDEP016](#FSTDEP016)
-    - [FSTDEP017](#FSTDEP017)
-    - [FSTDEP018](#FSTDEP018)
-    - [FSTDEP019](#FSTDEP019)
-    - [FSTDEP021](#FSTDEP021)
 
 
 ## Warnings
@@ -71,16 +58,3 @@ Deprecation codes are further supported by the Node.js CLI options:
 
 | Code | Description | How to solve | Discussion |
 | ---- | ----------- | ------------ | ---------- |
-| <a id="FSTDEP005">FSTDEP005</a> | You are accessing the deprecated `request.connection` property. | Use `request.socket`. | [#2594](https://github.com/fastify/fastify/pull/2594) |
-| <a id="FSTDEP007">FSTDEP007</a> | You are trying to set a HEAD route using `exposeHeadRoute` route flag when a sibling route is already set. | Remove `exposeHeadRoutes` or explicitly set `exposeHeadRoutes` to `false` | [#2700](https://github.com/fastify/fastify/pull/2700) |
-| <a id="FSTDEP008">FSTDEP008</a> | You are using route constraints via the route `{version: "..."}` option.  |  Use `{constraints: {version: "..."}}` option.  | [#2682](https://github.com/fastify/fastify/pull/2682) |
-| <a id="FSTDEP009">FSTDEP009</a> | You are using a custom route versioning strategy via the server `{versioning: "..."}` option. |  Use `{constraints: {version: "..."}}` option.  | [#2682](https://github.com/fastify/fastify/pull/2682) |
-| <a id="FSTDEP010">FSTDEP010</a> | Modifying the `reply.sent` property is deprecated. | Use the `reply.hijack()` method. | [#3140](https://github.com/fastify/fastify/pull/3140) |
-| <a id="FSTDEP012">FSTDEP012</a> | You are trying to access the deprecated `request.context` property. | Use `request.routeOptions.config` or `request.routeOptions.schema`. | [#4216](https://github.com/fastify/fastify/pull/4216) [#5084](https://github.com/fastify/fastify/pull/5084) |
-| <a id="FSTDEP013">FSTDEP013</a> | Direct return of "trailers" function is deprecated. | Use "callback" or "async-await" for return value. | [#4380](https://github.com/fastify/fastify/pull/4380) |
-| <a id="FSTDEP015">FSTDEP015</a> | You are accessing the deprecated `request.routeSchema` property. | Use `request.routeOptions.schema`. | [#4470](https://github.com/fastify/fastify/pull/4470) |
-| <a id="FSTDEP016">FSTDEP016</a> | You are accessing the deprecated `request.routeConfig` property. | Use `request.routeOptions.config`. | [#4470](https://github.com/fastify/fastify/pull/4470) |
-| <a id="FSTDEP017">FSTDEP017</a> | You are accessing the deprecated `request.routerPath` property. | Use `request.routeOptions.url`. | [#4470](https://github.com/fastify/fastify/pull/4470) |
-| <a id="FSTDEP018">FSTDEP018</a> | You are accessing the deprecated `request.routerMethod` property. | Use `request.routeOptions.method`. | [#4470](https://github.com/fastify/fastify/pull/4470) |
-| <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="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) |

package/eslint.config.js

@@ -1,27 +1,11 @@
 'use strict'
 
-const neo = require('neostandard')
-
-module.exports = [
-  {
-    ignores: [
-      'lib/configValidator.js',
-      'lib/error-serializer.js',
-      'test/same-shape.test.js'
-    ]
-  },
-  ...neo({
-    ts: true
-  }),
-  {
-    rules: {
-      '@stylistic/comma-dangle': ['error', {
-        arrays: 'never',
-        objects: 'never',
-        imports: 'never',
-        exports: 'never',
-        functions: 'never'
-      }]
-    }
-  }
-]
+module.exports = require('neostandard')({
+  ignores: [
+    'lib/configValidator.js',
+    'lib/error-serializer.js',
+    'test/same-shape.test.js',
+    'test/types/import.js'
+  ],
+  ts: true
+})

package/fastify.d.ts

@@ -7,23 +7,23 @@ import { Options as AjvOptions, ValidatorFactory } from '@fastify/ajv-compiler'
 import { FastifyError } from '@fastify/error'
 import { Options as FJSOptions, SerializerFactory } from '@fastify/fast-json-stringify-compiler'
 import { ConstraintStrategy, HTTPVersion } from 'find-my-way'
-import { Chain as LightMyRequestChain, InjectOptions, Response as LightMyRequestResponse, CallbackFunc as LightMyRequestCallback } from 'light-my-request'
+import { InjectOptions, CallbackFunc as LightMyRequestCallback, Chain as LightMyRequestChain, Response as LightMyRequestResponse } from 'light-my-request'
 
-import { FastifyBodyParser, FastifyContentTypeParser, AddContentTypeParser, hasContentTypeParser, getDefaultJsonParser, ProtoAction, ConstructorAction } from './types/content-type-parser'
-import { FastifyRequestContext, FastifyContextConfig, FastifyReplyContext } from './types/context'
+import { AddContentTypeParser, ConstructorAction, FastifyBodyParser, FastifyContentTypeParser, getDefaultJsonParser, hasContentTypeParser, ProtoAction } from './types/content-type-parser'
+import { FastifyContextConfig, FastifyReplyContext, FastifyRequestContext } from './types/context'
 import { FastifyErrorCodes } from './types/errors'
-import { DoneFuncWithErrOrRes, HookHandlerDoneFunction, RequestPayload, onCloseAsyncHookHandler, onCloseHookHandler, onErrorAsyncHookHandler, onErrorHookHandler, onReadyAsyncHookHandler, onReadyHookHandler, onListenAsyncHookHandler, onListenHookHandler, onRegisterHookHandler, onRequestAsyncHookHandler, onRequestHookHandler, onResponseAsyncHookHandler, onResponseHookHandler, onRouteHookHandler, onSendAsyncHookHandler, onSendHookHandler, onTimeoutAsyncHookHandler, onTimeoutHookHandler, preHandlerAsyncHookHandler, preHandlerHookHandler, preParsingAsyncHookHandler, preParsingHookHandler, preSerializationAsyncHookHandler, preSerializationHookHandler, preValidationAsyncHookHandler, preValidationHookHandler, onRequestAbortHookHandler, onRequestAbortAsyncHookHandler, preCloseAsyncHookHandler, preCloseHookHandler } from './types/hooks'
-import { FastifyListenOptions, FastifyInstance, PrintRoutesOptions } from './types/instance'
-import { FastifyBaseLogger, FastifyLoggerInstance, FastifyLoggerOptions, PinoLoggerOptions, FastifyLogFn, LogLevel } from './types/logger'
-import { FastifyPluginCallback, FastifyPluginAsync, FastifyPluginOptions, FastifyPlugin } from './types/plugin'
+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 { FastifyPlugin, FastifyPluginAsync, FastifyPluginCallback, FastifyPluginOptions } from './types/plugin'
 import { FastifyRegister, FastifyRegisterOptions, RegisterOptions } from './types/register'
 import { FastifyReply } from './types/reply'
 import { FastifyRequest, RequestGenericInterface } from './types/request'
-import { RouteHandler, RouteHandlerMethod, RouteOptions, RouteShorthandMethod, RouteShorthandOptions, RouteShorthandOptionsWithHandler, RouteGenericInterface } from './types/route'
+import { RouteGenericInterface, RouteHandler, RouteHandlerMethod, RouteOptions, RouteShorthandMethod, RouteShorthandOptions, RouteShorthandOptionsWithHandler } from './types/route'
 import { FastifySchema, FastifySchemaCompiler, FastifySchemaValidationError, SchemaErrorDataVar, SchemaErrorFormatter } from './types/schema'
 import { FastifyServerFactory, FastifyServerFactoryHandler } from './types/serverFactory'
 import { FastifyTypeProvider, FastifyTypeProviderDefault, SafePromiseLike } from './types/type-provider'
-import { HTTPMethods, RawServerBase, RawRequestDefaultExpression, RawReplyDefaultExpression, RawServerDefault, ContextConfigDefault, RequestBodyDefault, RequestQuerystringDefault, RequestParamsDefault, RequestHeadersDefault } from './types/utils'
+import { ContextConfigDefault, HTTPMethods, RawReplyDefaultExpression, RawRequestDefaultExpression, RawServerBase, RawServerDefault, RequestBodyDefault, RequestHeadersDefault, RequestParamsDefault, RequestQuerystringDefault } from './types/utils'
 
 declare module '@fastify/error' {
   interface FastifyError {
@@ -111,22 +111,9 @@ declare namespace fastify {
     requestIdHeader?: string | false,
     requestIdLogLabel?: string;
     useSemicolonDelimiter?: boolean,
-    jsonShorthand?: boolean;
     genReqId?: (req: RawRequestDefaultExpression<RawServer>) => string,
     trustProxy?: boolean | string | string[] | number | TrustProxyFunction,
     querystringParser?: (str: string) => { [key: string]: unknown },
-    /**
-     * @deprecated Prefer using the `constraints.version` property
-     */
-    versioning?: {
-      storage(): {
-        get(version: string): string | null,
-        set(version: string, store: Function): void
-        del(version: string): void,
-        empty(): void
-      },
-      deriveVersion<Context>(req: Object, ctx?: Context): string // not a fan of using Object here. Also what is Context? Can either of these be better defined?
-    },
     constraints?: {
       [name: string]: ConstraintStrategy<FindMyWayVersion<RawServer>, unknown>,
     },
@@ -149,7 +136,7 @@ declare namespace fastify {
     frameworkErrors?: <RequestGeneric extends RequestGenericInterface = RequestGenericInterface, TypeProvider extends FastifyTypeProvider = FastifyTypeProviderDefault, SchemaCompiler extends FastifySchema = FastifySchema>(
       error: FastifyError,
       req: FastifyRequest<RequestGeneric, RawServer, RawRequestDefaultExpression<RawServer>, FastifySchema, TypeProvider>,
-      res: FastifyReply<RawServer, RawRequestDefaultExpression<RawServer>, RawReplyDefaultExpression<RawServer>, RequestGeneric, FastifyContextConfig, SchemaCompiler, TypeProvider>
+      res: FastifyReply<RequestGeneric, RawServer, RawRequestDefaultExpression<RawServer>, RawReplyDefaultExpression<RawServer>, FastifyContextConfig, SchemaCompiler, TypeProvider>
     ) => void,
     rewriteUrl?: (
       // The RawRequestDefaultExpression, RawReplyDefaultExpression, and FastifyTypeProviderDefault parameters

package/fastify.js

@@ -1,10 +1,10 @@
 'use strict'
 
-const VERSION = '5.0.0-alpha.2'
+const VERSION = '5.0.0-alpha.4'
 
 const Avvio = require('avvio')
 const http = require('node:http')
-const diagnostics = require('dc-polyfill')
+const diagnostics = require('node:diagnostics_channel')
 let lightMyRequest
 
 const {
@@ -12,6 +12,7 @@ const {
   kChildren,
   kServerBindings,
   kBodyLimit,
+  kSupportedHTTPMethods,
   kRoutePrefix,
   kLogLevel,
   kLogSerializers,
@@ -37,7 +38,6 @@ const { createServer } = require('./lib/server')
 const Reply = require('./lib/reply')
 const Request = require('./lib/request')
 const Context = require('./lib/context.js')
-const { supportedMethods } = require('./lib/httpMethods')
 const decorator = require('./lib/decorate')
 const ContentTypeParser = require('./lib/contentTypeParser')
 const SchemaController = require('./lib/schema-controller')
@@ -49,7 +49,6 @@ const { buildRouting, validateBodyLimitOption } = require('./lib/route')
 const build404 = require('./lib/fourOhFour')
 const getSecuredInitialConfig = require('./lib/initialConfigValidation')
 const override = require('./lib/pluginOverride')
-const { FSTDEP009 } = require('./lib/warnings')
 const noopSet = require('./lib/noop-set')
 const {
   appendStackTrace,
@@ -68,12 +67,12 @@ const {
   FST_ERR_SCHEMA_CONTROLLER_BUCKET_OPT_NOT_FN,
   FST_ERR_AJV_CUSTOM_OPTIONS_OPT_NOT_OBJ,
   FST_ERR_AJV_CUSTOM_OPTIONS_OPT_NOT_ARR,
-  FST_ERR_VERSION_CONSTRAINT_NOT_STR,
   FST_ERR_INSTANCE_ALREADY_LISTENING,
   FST_ERR_REOPENED_CLOSE_SERVER,
   FST_ERR_ROUTE_REWRITE_NOT_STR,
   FST_ERR_SCHEMA_ERROR_FORMATTER_NOT_FN,
-  FST_ERR_ERROR_HANDLER_NOT_FN
+  FST_ERR_ERROR_HANDLER_NOT_FN,
+  FST_ERR_ROUTE_METHOD_INVALID
 } = errorCodes
 
 const { buildErrorHandler } = require('./lib/error-handler.js')
@@ -154,31 +153,12 @@ function fastify (options) {
   // exposeHeadRoutes have its default set from the validator
   options.exposeHeadRoutes = initialConfig.exposeHeadRoutes
 
-  let constraints = options.constraints
-  if (options.versioning) {
-    FSTDEP009()
-    constraints = {
-      ...constraints,
-      version: {
-        name: 'version',
-        mustMatchWhenDerived: true,
-        storage: options.versioning.storage,
-        deriveConstraint: options.versioning.deriveVersion,
-        validate (value) {
-          if (typeof value !== 'string') {
-            throw new FST_ERR_VERSION_CONSTRAINT_NOT_STR()
-          }
-        }
-      }
-    }
-  }
-
   // Default router
   const router = buildRouting({
     config: {
       defaultRoute,
       onBadUrl,
-      constraints,
+      constraints: options.constraints,
       ignoreTrailingSlash: options.ignoreTrailingSlash || defaultInitOptions.ignoreTrailingSlash,
       ignoreDuplicateSlashes: options.ignoreDuplicateSlashes || defaultInitOptions.ignoreDuplicateSlashes,
       maxParamLength: options.maxParamLength || defaultInitOptions.maxParamLength,
@@ -228,6 +208,22 @@ function fastify (options) {
       readyPromise: null
     },
     [kKeepAliveConnections]: keepAliveConnections,
+    [kSupportedHTTPMethods]: {
+      bodyless: new Set([
+        // Standard
+        'GET',
+        'HEAD',
+        'TRACE'
+      ]),
+      bodywith: new Set([
+        // Standard
+        'DELETE',
+        'OPTIONS',
+        'PATCH',
+        'PUT',
+        'POST'
+      ])
+    },
     [kOptions]: options,
     [kChildren]: [],
     [kServerBindings]: [],
@@ -265,6 +261,9 @@ function fastify (options) {
     head: function _head (url, options, handler) {
       return router.prepareRoute.call(this, { method: 'HEAD', url, options, handler })
     },
+    trace: function _trace (url, options, handler) {
+      return router.prepareRoute.call(this, { method: 'TRACE', url, options, handler })
+    },
     patch: function _patch (url, options, handler) {
       return router.prepareRoute.call(this, { method: 'PATCH', url, options, handler })
     },
@@ -277,41 +276,8 @@ function fastify (options) {
     options: function _options (url, options, handler) {
       return router.prepareRoute.call(this, { method: 'OPTIONS', url, options, handler })
     },
-    propfind: function _propfind (url, options, handler) {
-      return router.prepareRoute.call(this, { method: 'PROPFIND', url, options, handler })
-    },
-    proppatch: function _proppatch (url, options, handler) {
-      return router.prepareRoute.call(this, { method: 'PROPPATCH', url, options, handler })
-    },
-    mkcalendar: function _mkcalendar (url, options, handler) {
-      return router.prepareRoute.call(this, { method: 'MKCALENDAR', url, options, handler })
-    },
-    mkcol: function _mkcol (url, options, handler) {
-      return router.prepareRoute.call(this, { method: 'MKCOL', url, options, handler })
-    },
-    copy: function _copy (url, options, handler) {
-      return router.prepareRoute.call(this, { method: 'COPY', url, options, handler })
-    },
-    move: function _move (url, options, handler) {
-      return router.prepareRoute.call(this, { method: 'MOVE', url, options, handler })
-    },
-    lock: function _lock (url, options, handler) {
-      return router.prepareRoute.call(this, { method: 'LOCK', url, options, handler })
-    },
-    unlock: function _unlock (url, options, handler) {
-      return router.prepareRoute.call(this, { method: 'UNLOCK', url, options, handler })
-    },
-    trace: function _trace (url, options, handler) {
-      return router.prepareRoute.call(this, { method: 'TRACE', url, options, handler })
-    },
-    report: function _mkcalendar (url, options, handler) {
-      return router.prepareRoute.call(this, { method: 'REPORT', url, options, handler })
-    },
-    search: function _search (url, options, handler) {
-      return router.prepareRoute.call(this, { method: 'SEARCH', url, options, handler })
-    },
     all: function _all (url, options, handler) {
-      return router.prepareRoute.call(this, { method: supportedMethods, url, options, handler })
+      return router.prepareRoute.call(this, { method: this.supportedMethods, url, options, handler })
     },
     // extended route
     route: function _route (options) {
@@ -375,6 +341,7 @@ function fastify (options) {
     decorateRequest: decorator.decorateRequest,
     hasRequestDecorator: decorator.existRequest,
     hasReplyDecorator: decorator.existReply,
+    addHttpMethod,
     // fake http injection
     inject,
     // pretty print of the registered routes
@@ -442,6 +409,15 @@ function fastify (options) {
     genReqId: {
       configurable: true,
       get () { return this[kGenReqId] }
+    },
+    supportedMethods: {
+      configurable: false,
+      get () {
+        return [
+          ...this[kSupportedHTTPMethods].bodyless,
+          ...this[kSupportedHTTPMethods].bodywith
+        ]
+      }
     }
   })
 
@@ -485,7 +461,7 @@ function fastify (options) {
           if (forceCloseConnections === 'idle') {
             // Not needed in Node 19
             instance.server.closeIdleConnections()
-          /* istanbul ignore next: Cannot test this without Node.js core support */
+            /* istanbul ignore next: Cannot test this without Node.js core support */
           } else if (serverHasCloseAllConnections && forceCloseConnections) {
             instance.server.closeAllConnections()
           } else if (forceCloseConnections === true) {
@@ -917,6 +893,29 @@ function fastify (options) {
     this[kGenReqId] = reqIdGenFactory(this[kOptions].requestIdHeader, func)
     return this
   }
+
+  function addHttpMethod (method, { hasBody = false } = {}) {
+    if (typeof method !== 'string' || http.METHODS.indexOf(method) === -1) {
+      throw new FST_ERR_ROUTE_METHOD_INVALID()
+    }
+
+    if (hasBody === true) {
+      this[kSupportedHTTPMethods].bodywith.add(method)
+      this[kSupportedHTTPMethods].bodyless.delete(method)
+    } else {
+      this[kSupportedHTTPMethods].bodywith.delete(method)
+      this[kSupportedHTTPMethods].bodyless.add(method)
+    }
+
+    const _method = method.toLowerCase()
+    if (!this.hasDecorator(_method)) {
+      this.decorate(_method, function (url, options, handler) {
+        return router.prepareRoute.call(this, { method, url, options, handler })
+      })
+    }
+
+    return this
+  }
 }
 
 function validateSchemaErrorFormatter (schemaErrorFormatter) {