fastify 3.25.3 → 3.27.2

package/test/types/fastify.test-d.ts

@@ -57,6 +57,7 @@ fastify({ http2: true, https: {} }).inject({}, lightMyRequestCallback)
 expectAssignable<FastifyInstance<http2.Http2Server, http2.Http2ServerRequest, http2.Http2ServerResponse>>(fastify({ http2: true }))
 expectAssignable<FastifyInstance>(fastify({ ignoreTrailingSlash: true }))
 expectAssignable<FastifyInstance>(fastify({ connectionTimeout: 1000 }))
+expectAssignable<FastifyInstance>(fastify({ forceCloseConnections: true }))
 expectAssignable<FastifyInstance>(fastify({ keepAliveTimeout: 1000 }))
 expectAssignable<FastifyInstance>(fastify({ pluginTimeout: 1000 }))
 expectAssignable<FastifyInstance>(fastify({ bodyLimit: 100 }))
@@ -178,6 +179,22 @@ expectAssignable<FastifyInstance>(fastify({
     plugins: [() => { }]
   }
 }))
+expectAssignable<FastifyInstance>(fastify({
+  ajv: {
+    customOptions: {
+      nullable: false
+    },
+    plugins: [[() => { }, 'keyword']]
+  }
+}))
+expectAssignable<FastifyInstance>(fastify({
+  ajv: {
+    customOptions: {
+      nullable: false
+    },
+    plugins: [[() => { }, ['keyword1', 'keyword2']]]
+  }
+}))
 expectAssignable<FastifyInstance>(fastify({ frameworkErrors: () => { } }))
 expectAssignable<FastifyInstance>(fastify({
   rewriteUrl: (req) => req.url === '/hi' ? '/hello' : req.url!
@@ -189,6 +206,7 @@ expectAssignable<FastifyInstance>(fastify({
     expectType<Socket>(socket)
   }
 }))
+expectAssignable<FastifyInstance>(fastify({ jsonShorthand: true }))
 
 // Thenable
 expectAssignable<PromiseLike<FastifyInstance>>(fastify({ return503OnClosing: true }))

package/test/types/hooks.test-d.ts

@@ -1,8 +1,17 @@
-import fastify, { RouteOptions, FastifyReply, FastifyRequest } from '../../fastify'
-import { expectType, expectError, expectAssignable } from 'tsd'
-import { FastifyInstance } from '../../types/instance'
 import { FastifyError } from 'fastify-error'
-import { RequestPayload } from '../../types/hooks'
+import { expectAssignable, expectError, expectType } from 'tsd'
+import fastify, {
+  FastifyInstance,
+  FastifyReply,
+  FastifyRequest,
+  RawReplyDefaultExpression,
+  RawRequestDefaultExpression,
+  RawServerBase,
+  RouteOptions,
+  RegisterOptions,
+  FastifyPluginOptions
+} from '../../fastify'
+import { preHandlerAsyncHookHandler, RequestPayload } from '../../types/hooks'
 
 const server = fastify()
 
@@ -106,8 +115,9 @@ server.addHook('onRoute', function (opts) {
   expectType<RouteOptions & { routePath: string; path: string; prefix: string}>(opts)
 })
 
-server.addHook('onRegister', (instance, done) => {
+server.addHook('onRegister', (instance, opts, done) => {
   expectType<FastifyInstance>(instance)
+  expectType<RegisterOptions & FastifyPluginOptions>(opts)
   expectAssignable<(err?: FastifyError) => void>(done)
   expectAssignable<(err?: NodeJS.ErrnoException) => void>(done)
   expectType<void>(done(new Error()))
@@ -187,8 +197,9 @@ server.addHook('onError', async function (request, reply, error) {
   expectType<FastifyError>(error)
 })
 
-server.addHook('onRegister', async (instance) => {
+server.addHook('onRegister', async (instance, opts) => {
   expectType<FastifyInstance>(instance)
+  expectType<RegisterOptions & FastifyPluginOptions>(opts)
 })
 
 server.addHook('onReady', async function () {
@@ -198,3 +209,20 @@ server.addHook('onReady', async function () {
 server.addHook('onClose', async (instance) => {
   expectType<FastifyInstance>(instance)
 })
+
+// Use case to monitor any regression on issue #3620
+// ref.: https://github.com/fastify/fastify/issues/3620
+const customTypedHook: preHandlerAsyncHookHandler<
+RawServerBase,
+RawRequestDefaultExpression,
+RawReplyDefaultExpression,
+Record<string, unknown>
+> = async function (request, reply) {
+  expectType<FastifyInstance>(this)
+  expectAssignable<FastifyRequest>(request)
+  expectAssignable<FastifyReply>(reply)
+}
+
+server.register(async (instance) => {
+  instance.addHook('preHandler', customTypedHook)
+})

package/test/types/instance.test-d.ts

@@ -10,6 +10,7 @@ import { expectAssignable, expectError, expectType } from 'tsd'
 import { FastifyRequest } from '../../types/request'
 import { FastifyReply } from '../../types/reply'
 import { HookHandlerDoneFunction } from '../../types/hooks'
+import { FastifySchemaControllerOptions } from '../../types/schema'
 
 const server = fastify()
 
@@ -53,7 +54,7 @@ function asyncNodeJSErrorHandler (error: NodeJS.ErrnoException) {}
 server.setErrorHandler(asyncNodeJSErrorHandler)
 
 class CustomError extends Error {
-  private __brand: any;
+  private __brand: any
 }
 interface ReplyPayload {
   Reply: {
@@ -112,6 +113,29 @@ server.setNotFoundHandler({ preHandler: notFoundpreHandlerHandler, preValidation
 function invalidErrorHandler (error: number) {}
 expectError(server.setErrorHandler(invalidErrorHandler))
 
+server.setSchemaController({
+  bucket: (parentSchemas: unknown) => {
+    return {
+      addSchema (schema: unknown) {
+        expectType<unknown>(schema)
+        expectType<FastifyInstance>(server.addSchema({ type: 'null' }))
+        return server.addSchema({ type: 'null' })
+      },
+      getSchema (schemaId: string) {
+        expectType<string>(schemaId)
+        return server.getSchema('SchemaId')
+      },
+      getSchemas () {
+        expectType<Record<string, unknown>>(server.getSchemas())
+        return server.getSchemas()
+      }
+    }
+  }
+})
+
+function invalidSchemaController (schemaControllerOptions: FastifySchemaControllerOptions) {}
+expectError(server.setSchemaController(invalidSchemaController))
+
 server.setReplySerializer(function (payload, statusCode) {
   expectType<unknown>(payload)
   expectType<number>(statusCode)
@@ -171,6 +195,7 @@ type InitialConfig = Readonly<{
   keepAliveTimeout?: number,
   bodyLimit?: number,
   caseSensitive?: boolean,
+  forceCloseConnections?: boolean,
   http2?: boolean,
   https?: boolean | Readonly<{ allowHTTP1: boolean }>,
   ignoreTrailingSlash?: boolean,

package/test/validation-error-handling.test.js

@@ -140,7 +140,7 @@ test('error inside custom error handler should have validationContext if specifi
       return function (data) {
         const error = new Error('this failed')
         error.validationContext = 'customContext'
-        return { error: error }
+        return { error }
       }
     }
   }, function (req, reply) {

package/test/versioned-routes.test.js

@@ -296,10 +296,25 @@ test('Shorthand route declaration', t => {
   })
 })
 
-test('The not found handler should not use the Accept-Version header', t => {
-  t.plan(4)
+test('The not found handler should not erase the Accept-Version header', t => {
+  t.plan(13)
   const fastify = Fastify()
 
+  fastify.addHook('onRequest', function (req, reply, done) {
+    t.same(req.headers['accept-version'], '2.x')
+    done()
+  })
+
+  fastify.addHook('preValidation', function (req, reply, done) {
+    t.same(req.headers['accept-version'], '2.x')
+    done()
+  })
+
+  fastify.addHook('preHandler', function (req, reply, done) {
+    t.same(req.headers['accept-version'], '2.x')
+    done()
+  })
+
   fastify.route({
     method: 'GET',
     url: '/',
@@ -310,7 +325,16 @@ test('The not found handler should not use the Accept-Version header', t => {
   })
 
   fastify.setNotFoundHandler(function (req, reply) {
-    t.notOk(req.headers['accept-version'])
+    t.same(req.headers['accept-version'], '2.x')
+    // we check if the symbol is exposed on key or not
+    for (const key in req.headers) {
+      t.same(typeof key, 'string')
+    }
+
+    for (const key of Object.keys(req.headers)) {
+      t.same(typeof key, 'string')
+    }
+
     reply.code(404).send('not found handler')
   })
 
@@ -409,7 +433,7 @@ test('test log stream', t => {
   const stream = split(JSON.parse)
   const fastify = Fastify({
     logger: {
-      stream: stream,
+      stream,
       level: 'info'
     }
   })

package/types/.eslintrc.json

@@ -31,7 +31,7 @@
       "files": ["*.test-d.ts"],
       "rules": {
         "no-unused-vars": "off",
-        "node/handle-callback-err": "off",
+        "n/handle-callback-err": "off",
         "@typescript-eslint/no-empty-function": "off",
         "@typescript-eslint/explicit-function-return-type": "off",
         "@typescript-eslint/no-unused-vars": "off",

package/types/hooks.d.ts

@@ -6,6 +6,8 @@ import { FastifyRequest } from './request'
 import { FastifyReply } from './reply'
 import { FastifyError } from 'fastify-error'
 import { FastifyLoggerInstance } from './logger'
+import { RegisterOptions } from './register'
+import { FastifyPluginOptions } from './plugin'
 
 type HookHandlerDoneFunction = <TError extends Error = FastifyError>(err?: TError) => void
 
@@ -27,7 +29,7 @@ export interface onRequestHookHandler<
   ContextConfig = ContextConfigDefault
 > {
   (
-    this: FastifyInstance<RawServer, RawRequest, RawReply>,
+    this: FastifyInstance,
     request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
     done: HookHandlerDoneFunction
@@ -42,7 +44,7 @@ export interface onRequestAsyncHookHandler<
   ContextConfig = ContextConfigDefault
 > {
   (
-    this: FastifyInstance<RawServer, RawRequest, RawReply>,
+    this: FastifyInstance,
     request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
   ): Promise<unknown>;
@@ -60,7 +62,7 @@ export interface preParsingHookHandler<
   ContextConfig = ContextConfigDefault
 > {
   (
-    this: FastifyInstance<RawServer, RawRequest, RawReply>,
+    this: FastifyInstance,
     request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
     payload: RequestPayload,
@@ -76,7 +78,7 @@ export interface preParsingAsyncHookHandler<
   ContextConfig = ContextConfigDefault
 > {
   (
-    this: FastifyInstance<RawServer, RawRequest, RawReply>,
+    this: FastifyInstance,
     request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
     payload: RequestPayload,
@@ -94,7 +96,7 @@ export interface preValidationHookHandler<
   ContextConfig = ContextConfigDefault
 > {
   (
-    this: FastifyInstance<RawServer, RawRequest, RawReply>,
+    this: FastifyInstance,
     request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
     done: HookHandlerDoneFunction
@@ -109,7 +111,7 @@ export interface preValidationAsyncHookHandler<
   ContextConfig = ContextConfigDefault
 > {
   (
-    this: FastifyInstance<RawServer, RawRequest, RawReply>,
+    this: FastifyInstance,
     request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
   ): Promise<unknown>;
@@ -126,7 +128,7 @@ export interface preHandlerHookHandler<
   ContextConfig = ContextConfigDefault
 > {
   (
-    this: FastifyInstance<RawServer, RawRequest, RawReply>,
+    this: FastifyInstance,
     request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
     done: HookHandlerDoneFunction
@@ -141,7 +143,7 @@ export interface preHandlerAsyncHookHandler<
   ContextConfig = ContextConfigDefault
 > {
   (
-    this: FastifyInstance<RawServer, RawRequest, RawReply>,
+    this: FastifyInstance,
     request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
   ): Promise<unknown>;
@@ -167,7 +169,7 @@ export interface preSerializationHookHandler<
   ContextConfig = ContextConfigDefault
 > {
   (
-    this: FastifyInstance<RawServer, RawRequest, RawReply>,
+    this: FastifyInstance,
     request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
     payload: PreSerializationPayload,
@@ -184,7 +186,7 @@ export interface preSerializationAsyncHookHandler<
   ContextConfig = ContextConfigDefault
 > {
   (
-    this: FastifyInstance<RawServer, RawRequest, RawReply>,
+    this: FastifyInstance,
     request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
     payload: PreSerializationPayload
@@ -204,7 +206,7 @@ export interface onSendHookHandler<
   ContextConfig = ContextConfigDefault
 > {
   (
-    this: FastifyInstance<RawServer, RawRequest, RawReply>,
+    this: FastifyInstance,
     request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
     payload: OnSendPayload,
@@ -221,7 +223,7 @@ export interface onSendAsyncHookHandler<
   ContextConfig = ContextConfigDefault
 > {
   (
-    this: FastifyInstance<RawServer, RawRequest, RawReply>,
+    this: FastifyInstance,
     request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
     payload: OnSendPayload,
@@ -240,7 +242,7 @@ export interface onResponseHookHandler<
   ContextConfig = ContextConfigDefault
 > {
   (
-    this: FastifyInstance<RawServer, RawRequest, RawReply>,
+    this: FastifyInstance,
     request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
     done: HookHandlerDoneFunction
@@ -255,7 +257,7 @@ export interface onResponseAsyncHookHandler<
   ContextConfig = ContextConfigDefault
 > {
   (
-    this: FastifyInstance<RawServer, RawRequest, RawReply>,
+    this: FastifyInstance,
     request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>
   ): Promise<unknown>;
@@ -273,7 +275,7 @@ export interface onTimeoutHookHandler<
   ContextConfig = ContextConfigDefault
 > {
   (
-    this: FastifyInstance<RawServer, RawRequest, RawReply>,
+    this: FastifyInstance,
     request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
     done: HookHandlerDoneFunction
@@ -288,7 +290,7 @@ export interface onTimeoutAsyncHookHandler<
   ContextConfig = ContextConfigDefault
 > {
   (
-    this: FastifyInstance<RawServer, RawRequest, RawReply>,
+    this: FastifyInstance,
     request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>
   ): Promise<unknown>;
@@ -309,7 +311,7 @@ export interface onErrorHookHandler<
   TError extends Error = FastifyError
 > {
   (
-    this: FastifyInstance<RawServer, RawRequest, RawReply>,
+    this: FastifyInstance,
     request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
     error: TError,
@@ -326,7 +328,7 @@ export interface onErrorAsyncHookHandler<
   TError extends Error = FastifyError
 > {
   (
-    this: FastifyInstance<RawServer, RawRequest, RawReply>,
+    this: FastifyInstance,
     request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
     reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
     error: TError
@@ -346,7 +348,7 @@ export interface onRouteHookHandler<
   ContextConfig = ContextConfigDefault
 > {
   (
-    this: FastifyInstance<RawServer, RawRequest, RawReply>,
+    this: FastifyInstance,
     opts: RouteOptions<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig> & { routePath: string; path: string; prefix: string }
   ): Promise<unknown> | void;
 }
@@ -360,10 +362,12 @@ export interface onRegisterHookHandler<
   RawServer extends RawServerBase = RawServerDefault,
   RawRequest extends RawRequestDefaultExpression<RawServer> = RawRequestDefaultExpression<RawServer>,
   RawReply extends RawReplyDefaultExpression<RawServer> = RawReplyDefaultExpression<RawServer>,
-  Logger = FastifyLoggerInstance
+  Logger = FastifyLoggerInstance,
+  Options extends FastifyPluginOptions = FastifyPluginOptions
 > {
   (
     instance: FastifyInstance<RawServer, RawRequest, RawReply, Logger>,
+    opts: RegisterOptions & Options,
     done: HookHandlerDoneFunction
   ): Promise<unknown> | void; // documentation is missing the `done` method
 }

package/types/instance.d.ts

@@ -1,6 +1,12 @@
 import { Chain as LightMyRequestChain, InjectOptions, Response as LightMyRequestResponse, CallbackFunc as LightMyRequestCallback } from 'light-my-request'
 import { RouteOptions, RouteShorthandMethod, RouteGenericInterface, DefaultRoute } from './route'
-import { FastifySchema, FastifySchemaCompiler, FastifySchemaValidationError, FastifySerializerCompiler } from './schema'
+import {
+  FastifySchema,
+  FastifySchemaCompiler,
+  FastifySchemaValidationError,
+  FastifySerializerCompiler,
+  FastifySchemaControllerOptions
+} from './schema'
 import { RawServerBase, RawRequestDefaultExpression, RawServerDefault, RawReplyDefaultExpression, ContextConfigDefault } from './utils'
 import { FastifyLoggerInstance } from './logger'
 import { FastifyRegister } from './register'
@@ -380,6 +386,11 @@ export interface FastifyInstance<
    */
   setSerializerCompiler<T = FastifySchema>(schemaCompiler: FastifySerializerCompiler<T>): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
 
+  /**
+   * Set the schema controller for all routes.
+   */
+  setSchemaController(schemaControllerOpts: FastifySchemaControllerOptions): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
+
   /**
   * Set the reply serializer for all routes.
   */
@@ -427,6 +438,7 @@ export interface FastifyInstance<
   initialConfig: Readonly<{
     connectionTimeout?: number,
     keepAliveTimeout?: number,
+    forceCloseConnections?: boolean,
     bodyLimit?: number,
     caseSensitive?: boolean,
     http2?: boolean,

package/types/register.d.ts

@@ -2,7 +2,7 @@ import { FastifyPluginOptions, FastifyPluginCallback, FastifyPluginAsync } from
 import { LogLevel } from './logger'
 import { FastifyInstance } from './instance'
 
-interface RegisterOptions {
+export interface RegisterOptions {
   prefix?: string;
   logLevel?: LogLevel;
   logSerializers?: Record<string, (value: any) => string>;

package/types/schema.d.ts

@@ -1,3 +1,5 @@
+import { ValidatorCompiler } from '@fastify/ajv-compiler'
+import { FastifyInstance, FastifyServerOptions } from '../fastify'
 /**
  * Schemas in Fastify follow the JSON-Schema standard. For this reason
  * we have opted to not ship strict schema based types. Instead we provide
@@ -36,3 +38,15 @@ export interface FastifyValidationResult {
 export type FastifySchemaCompiler<T> = (routeSchema: FastifyRouteSchemaDef<T>) => FastifyValidationResult
 
 export type FastifySerializerCompiler<T> = (routeSchema: FastifyRouteSchemaDef<T>) => (data: any) => string
+
+export interface FastifySchemaControllerOptions{
+  bucket?: (parentSchemas?: unknown) => {
+    addSchema(schema: unknown): FastifyInstance;
+    getSchema(schemaId: string): unknown;
+    getSchemas(): Record<string, unknown>;
+  };
+  compilersFactory?: {
+    buildValidator?: ValidatorCompiler;
+    buildSerializer?: (externalSchemas: unknown, serializerOptsServerOption: FastifyServerOptions['serializerOpts']) => FastifySerializerCompiler<unknown>;
+  };
+}