import { FastifyError } from '@fastify/error' import { expectAssignable, expectError, expectType } from 'tsd' import fastify, { ContextConfigDefault, FastifyContextConfig, FastifyInstance, FastifyPluginOptions, FastifyReply, FastifyRequest, FastifySchema, FastifyTypeProviderDefault, RawReplyDefaultExpression, RawRequestDefaultExpression, RawServerDefault, RegisterOptions, RouteOptions, // preClose hook types should be exported correctly https://github.com/fastify/fastify/pull/5335 /* eslint-disable @typescript-eslint/no-unused-vars */ preCloseAsyncHookHandler, preCloseHookHandler } from '../../fastify' import { DoneFuncWithErrOrRes, HookHandlerDoneFunction, RequestPayload, preHandlerAsyncHookHandler } from '../../types/hooks' import { FastifyRouteConfig, RouteGenericInterface } from '../../types/route' const server = fastify() // Test payload generic pass through for preSerialization and onSend type TestPayloadType = { foo: string; bar: number; } // Synchronous Tests server.addHook('onRequest', function (request, reply, done) { expectType(this) expectType(request) expectType(reply) expectAssignable<(err?: FastifyError) => void>(done) expectAssignable<(err?: NodeJS.ErrnoException) => void>(done) expectType(done(new Error())) }) server.addHook('preParsing', function (request, reply, payload, done) { expectType(this) expectType(request) expectType(reply) expectType(payload) expectAssignable<(err?: FastifyError | null, res?: RequestPayload) => void>(done) expectAssignable<(err?: NodeJS.ErrnoException) => void>(done) expectType(done(new Error())) }) server.addHook('preValidation', function (request, reply, done) { expectType(this) expectType(request) expectType(reply) expectAssignable<(err?: FastifyError) => void>(done) expectAssignable<(err?: NodeJS.ErrnoException) => void>(done) expectType(done(new Error())) }) server.addHook('preHandler', function (request, reply, done) { expectType(this) expectType(request) expectType(reply) expectAssignable<(err?: FastifyError) => void>(done) expectAssignable<(err?: NodeJS.ErrnoException) => void>(done) expectType(done(new Error())) }) server.addHook('preSerialization', function (request, reply, payload, done) { expectType(this) expectType(request) expectType(reply) expectType(payload) // we expect this to be unknown when not specified like in the previous test expectType(done(new Error())) expectType(done(null, 'foobar')) expectType(done()) expectError(done(new Error(), 'foobar')) }) server.addHook('onSend', function (request, reply, payload, done) { expectType(this) expectType(request) expectType(reply) expectType(payload) expectType(done(new Error())) expectType(done(null, 'foobar')) expectType(done()) expectError(done(new Error(), 'foobar')) }) server.addHook('onResponse', function (request, reply, done) { expectType(this) expectType(request) expectType(reply) expectAssignable<(err?: FastifyError) => void>(done) expectAssignable<(err?: NodeJS.ErrnoException) => void>(done) expectType(done(new Error())) }) server.addHook('onTimeout', function (request, reply, done) { expectType(this) expectType(request) expectType(reply) expectAssignable<(err?: FastifyError) => void>(done) expectAssignable<(err?: NodeJS.ErrnoException) => void>(done) expectType(done(new Error())) }) server.addHook('onError', function (request, reply, error, done) { expectType(this) expectType(request) expectType(reply) expectType(error) expectType<() => void>(done) expectType(done()) }) server.addHook('onRequestAbort', function (request, done) { expectType(this) expectType(request) expectAssignable<(err?: FastifyError) => void>(done) expectAssignable<(err?: NodeJS.ErrnoException) => void>(done) expectType(done(new Error())) }) server.addHook('onRoute', function (opts) { expectType(this) expectType(opts) }) server.addHook('onRegister', function (instance, opts) { expectType(this) expectType(instance) expectType(opts) }) server.addHook('onReady', function (done) { expectType(this) expectAssignable<(err?: FastifyError) => void>(done) expectAssignable<(err?: NodeJS.ErrnoException) => void>(done) expectType(done(new Error())) }) server.addHook('onListen', function (done) { expectType(this) expectAssignable<(err?: FastifyError) => void>(done) expectAssignable<(err?: NodeJS.ErrnoException) => void>(done) }) server.addHook('onClose', function (instance, done) { expectType(this) expectType(instance) expectAssignable<(err?: FastifyError) => void>(done) expectAssignable<(err?: NodeJS.ErrnoException) => void>(done) expectType(done(new Error())) }) // Asynchronous server.addHook('onRequest', async function (request, reply) { expectType(this) expectType(request) expectType(reply) }) server.addHook('preParsing', async function (request, reply, payload) { expectType(this) expectType(request) expectType(reply) expectType(payload) }) server.addHook('preValidation', async function (request, reply) { expectType(this) expectType(request) expectType(reply) }) server.addHook('preHandler', async function (request, reply) { expectType(this) expectType(request) expectType(reply) }) server.addHook('preSerialization', async function (request, reply, payload) { expectType(this) expectType(request) expectType(reply) expectType(payload) // we expect this to be unknown when not specified like in the previous test }) server.addHook('onSend', async function (request, reply, payload) { expectType(this) expectType(request) expectType(reply) expectType(payload) }) server.addHook('onResponse', async function (request, reply) { expectType(this) expectType(request) expectType(reply) }) server.addHook('onTimeout', async function (request, reply) { expectType(this) expectType(request) expectType(reply) }) server.addHook('onError', async function (request, reply, error) { expectType(this) expectType(request) expectType(reply) expectType(error) }) server.addHook('onRequestAbort', async function (request) { expectType(this) expectType(request) }) server.addHook('onRegister', async (instance, opts) => { expectType(instance) expectType(opts) }) server.addHook('onReady', async function () { expectType(this) }) server.addHook('onListen', async function () { expectType(this) }) server.addHook('onClose', async function (instance) { expectType(this) expectType(instance) }) // Use case to monitor any regression on issue #3620 // ref.: https://github.com/fastify/fastify/issues/3620 const customTypedHook: preHandlerAsyncHookHandler< RawServerDefault, RawRequestDefaultExpression, RawReplyDefaultExpression, RouteGenericInterface, ContextConfigDefault, FastifySchema, FastifyTypeProviderDefault > = async function (request, reply): Promise { expectType(this) expectAssignable(request) expectAssignable(reply) } server.register(async (instance) => { instance.addHook('preHandler', customTypedHook) }) // Test custom Context Config types for hooks type CustomContextConfig = FastifyContextConfig & { foo: string; bar: number; } type CustomContextConfigWithDefault = CustomContextConfig & FastifyRouteConfig server.route({ method: 'GET', url: '/', handler: () => { }, onRequest: (request, reply, done) => { expectType(request.routeOptions.config) expectType(reply.routeOptions.config) }, preParsing: (request, reply, payload, done) => { expectType(request.routeOptions.config) expectType(reply.routeOptions.config) }, preValidation: (request, reply, done) => { expectType(request.routeOptions.config) expectType(reply.routeOptions.config) }, preHandler: (request, reply, done) => { expectType(request.routeOptions.config) expectType(reply.routeOptions.config) }, preSerialization: (request, reply, payload, done) => { expectType(request.routeOptions.config) expectType(reply.routeOptions.config) }, onSend: (request, reply, payload, done) => { expectType(request.routeOptions.config) expectType(reply.routeOptions.config) }, onResponse: (request, reply, done) => { expectType(request.routeOptions.config) expectType(reply.routeOptions.config) }, onTimeout: (request, reply, done) => { expectType(request.routeOptions.config) expectType(reply.routeOptions.config) }, onError: (request, reply, error, done) => { expectType(request.routeOptions.config) expectType(reply.routeOptions.config) } }) server.get('/', { onRequest: async (request, reply) => { expectType(request.routeOptions.config) expectType(reply.routeOptions.config) }, preParsing: async (request, reply) => { expectType(request.routeOptions.config) expectType(reply.routeOptions.config) }, preValidation: async (request, reply) => { expectType(request.routeOptions.config) expectType(reply.routeOptions.config) }, preHandler: async (request, reply) => { expectType(request.routeOptions.config) expectType(reply.routeOptions.config) }, preSerialization: async (request, reply) => { expectType(request.routeOptions.config) expectType(reply.routeOptions.config) }, onSend: async (request, reply) => { expectType(request.routeOptions.config) expectType(reply.routeOptions.config) }, onResponse: async (request, reply) => { expectType(request.routeOptions.config) expectType(reply.routeOptions.config) }, onTimeout: async (request, reply) => { expectType(request.routeOptions.config) expectType(reply.routeOptions.config) }, onError: async (request, reply) => { expectType(request.routeOptions.config) expectType(reply.routeOptions.config) } }, async (request, reply) => { expectType(request.routeOptions.config) expectType(reply.routeOptions.config) }) type CustomContextRequest = FastifyRequest type CustomContextReply = FastifyReply server.route({ method: 'GET', url: '/', handler: () => { }, onRequest: async (request: CustomContextRequest, reply: CustomContextReply) => { expectType(request.routeOptions.config) expectType(reply.routeOptions.config) }, preParsing: async (request: CustomContextRequest, reply: CustomContextReply, payload: RequestPayload) => { expectType(request.routeOptions.config) expectType(reply.routeOptions.config) }, preValidation: async (request: CustomContextRequest, reply: CustomContextReply) => { expectType(request.routeOptions.config) expectType(reply.routeOptions.config) }, preHandler: async (request: CustomContextRequest, reply: CustomContextReply) => { expectType(request.routeOptions.config) expectType(reply.routeOptions.config) }, preSerialization: async (request: CustomContextRequest, reply: CustomContextReply, payload: any) => { expectType(request.routeOptions.config) expectType(reply.routeOptions.config) }, onSend: async (request: CustomContextRequest, reply: CustomContextReply, payload: any) => { expectType(request.routeOptions.config) expectType(reply.routeOptions.config) }, onResponse: async (request: CustomContextRequest, reply: CustomContextReply) => { expectType(request.routeOptions.config) expectType(reply.routeOptions.config) }, onTimeout: async (request: CustomContextRequest, reply: CustomContextReply) => { expectType(request.routeOptions.config) expectType(reply.routeOptions.config) }, onError: async (request: CustomContextRequest, reply: CustomContextReply, error: FastifyError) => { expectType(request.routeOptions.config) expectType(reply.routeOptions.config) } }) server.route({ method: 'GET', url: '/', handler: (request, reply) => { expectType(request) expectType(reply) }, onRequest: (request, reply, done) => { expectType(request) expectType(reply) expectType(done) }, onRequestAbort: (request, done) => { expectType(request) expectType(done) }, preParsing: (request, reply, payload, done) => { expectType(request) expectType(reply) expectType(payload) expectType< ( err?: TError | null | undefined, res?: RequestPayload | undefined ) => void >(done) }, preValidation: (request, reply, done) => { expectType(request) expectType(reply) expectType(done) }, preHandler: (request, reply, done) => { expectType(request) expectType(reply) expectType(done) }, preSerialization: (request, reply, payload, done) => { expectType(request) expectType(reply) expectType(payload) expectType(done) }, onSend: (request, reply, payload, done) => { expectType(request) expectType(reply) expectType(payload) expectType(done) }, onResponse: (request, reply, done) => { expectType(request) expectType(reply) expectType(done) }, onTimeout: (request, reply, done) => { expectType(request) expectType(reply) expectType(done) }, onError: (request, reply, error, done) => { expectType(request) expectType(reply) expectType(error) expectType<() => void>(done) } }) server.get('/', { onRequest: async (request, reply) => { expectType(request) expectType(reply) }, onRequestAbort: async (request, reply) => { expectType(request) }, preParsing: async (request, reply, payload) => { expectType(request) expectType(reply) expectType(payload) }, preValidation: async (request, reply) => { expectType(request) expectType(reply) }, preHandler: async (request, reply) => { expectType(request) expectType(reply) }, preSerialization: async (request, reply, payload) => { expectType(request) expectType(reply) expectType(payload) }, onSend: async (request, reply, payload) => { expectType(request) expectType(reply) expectType(payload) }, onResponse: async (request, reply) => { expectType(request) expectType(reply) }, onTimeout: async (request, reply) => { expectType(request) expectType(reply) }, onError: async (request, reply, error) => { expectType(request) expectType(reply) expectType(error) } }, async (request, reply) => { expectType(request) expectType(reply) }) // TODO: Should throw errors // expectError(server.get('/', { onRequest: async (request, reply, done) => {} }, async (request, reply) => {})) // expectError(server.get('/', { onRequestAbort: async (request, done) => {} }, async (request, reply) => {})) // expectError(server.get('/', { preParsing: async (request, reply, payload, done) => {} }, async (request, reply) => {})) // expectError(server.get('/', { preValidation: async (request, reply, done) => {} }, async (request, reply) => {})) // expectError(server.get('/', { preHandler: async (request, reply, done) => {} }, async (request, reply) => {})) // expectError(server.get('/', { preSerialization: async (request, reply, payload, done) => {} }, async (request, reply) => {})) // expectError(server.get('/', { onSend: async (request, reply, payload, done) => {} }, async (request, reply) => {})) // expectError(server.get('/', { onResponse: async (request, reply, done) => {} }, async (request, reply) => {})) // expectError(server.get('/', { onTimeout: async (request, reply, done) => {} }, async (request, reply) => {})) // expectError(server.get('/', { onError: async (request, reply, error, done) => {} }, async (request, reply) => {})) server.addHook('preClose', function (done) { expectType(this) expectAssignable<(err?: FastifyError) => void>(done) expectAssignable<(err?: NodeJS.ErrnoException) => void>(done) expectType(done(new Error())) }) server.addHook('preClose', async function () { expectType(this) }) expectError(server.addHook('onClose', async function (instance, done) {})) expectError(server.addHook('onError', async function (request, reply, error, done) {})) expectError(server.addHook('onReady', async function (done) {})) expectError(server.addHook('onListen', async function (done) {})) expectError(server.addHook('onRequest', async function (request, reply, done) {})) expectError(server.addHook('onRequestAbort', async function (request, done) {})) expectError(server.addHook('onResponse', async function (request, reply, done) {})) expectError(server.addHook('onSend', async function (request, reply, payload, done) {})) expectError(server.addHook('onTimeout', async function (request, reply, done) {})) expectError(server.addHook('preClose', async function (done) {})) expectError(server.addHook('preHandler', async function (request, reply, done) {})) expectError(server.addHook('preSerialization', async function (request, reply, payload, done) {})) expectError(server.addHook('preValidation', async function (request, reply, done) {}))