fastify 5.8.5 → 5.10.0

package/test/types/reply.tst.ts

@@ -0,0 +1,297 @@
+import { Buffer } from 'node:buffer'
+import { expect } from 'tstyche'
+import fastify, {
+  FastifyContextConfig,
+  FastifyReply,
+  FastifyRequest,
+  FastifySchema,
+  FastifyTypeProviderDefault,
+  RawRequestDefaultExpression,
+  RouteHandler,
+  RouteHandlerMethod
+} from '../../fastify.js'
+import { FastifyInstance } from '../../types/instance.js'
+import { FastifyBaseLogger } from '../../types/logger.js'
+import { ResolveReplyTypeWithRouteGeneric } from '../../types/reply.js'
+import { FastifyRouteConfig, RouteGenericInterface } from '../../types/route.js'
+import { ContextConfigDefault, RawReplyDefaultExpression, RawServerDefault } from '../../types/utils.js'
+
+type DefaultSerializationFunction = (payload: { [key: string]: unknown }) => string
+type DefaultFastifyReplyWithCode<Code extends number> = FastifyReply<RouteGenericInterface, RawServerDefault, RawRequestDefaultExpression, RawReplyDefaultExpression, ContextConfigDefault, FastifySchema, FastifyTypeProviderDefault, ResolveReplyTypeWithRouteGeneric<RouteGenericInterface['Reply'], Code, FastifySchema, FastifyTypeProviderDefault>>
+
+const getHandler: RouteHandlerMethod = function (_request, reply) {
+  expect(reply.raw).type.toBe<RawReplyDefaultExpression>()
+  expect(reply.log).type.toBe<FastifyBaseLogger>()
+  expect(reply.request).type.toBe<
+    FastifyRequest<RouteGenericInterface, RawServerDefault, RawRequestDefaultExpression>
+  >()
+  expect(reply.code).type.toBe<<Code extends number>(statusCode: Code) => DefaultFastifyReplyWithCode<Code>>()
+  expect(reply.status).type.toBe<<Code extends number>(statusCode: Code) => DefaultFastifyReplyWithCode<Code>>()
+  expect(reply.code(100 as number).send).type.toBe<(...args: [payload?: unknown]) => FastifyReply>()
+  expect(reply.elapsedTime).type.toBe<number>()
+  expect(reply.statusCode).type.toBe<number>()
+  expect(reply.sent).type.toBe<boolean>()
+  expect(reply.writeEarlyHints).type.toBe<
+    (hints: Record<string, string | string[]>, callback?: (() => void) | undefined) => void
+  >()
+  expect(reply.send).type.toBe<((...args: [payload?: unknown]) => FastifyReply)>()
+  expect(reply.header).type.toBeAssignableTo<(key: string, value: any) => FastifyReply>()
+  expect(reply.headers).type.toBeAssignableTo<(values: { [key: string]: any }) => FastifyReply>()
+  expect(reply.getHeader).type.toBeAssignableTo<(key: string) => number | string | string[] | undefined>()
+  expect(reply.getHeaders).type.toBeAssignableTo<() => { [key: string]: number | string | string[] | undefined }>()
+  expect(reply.removeHeader).type.toBeAssignableTo<(key: string) => FastifyReply>()
+  expect(reply.hasHeader).type.toBeAssignableTo<(key: string) => boolean>()
+  expect(reply.redirect).type.toBe<(url: string, statusCode?: number) => FastifyReply>()
+  expect(reply.hijack).type.toBe<() => FastifyReply>()
+  expect(reply.callNotFound).type.toBe<() => void>()
+  expect(reply.type).type.toBe<(contentType: string) => FastifyReply>()
+  expect(reply.serializer).type.toBe<(fn: (payload: any) => string) => FastifyReply>()
+  expect(reply.serialize).type.toBe<(payload: any) => string | ArrayBuffer | Buffer>()
+  expect(reply.then).type.toBe<(fulfilled: () => void, rejected: (err: Error) => void) => void>()
+  expect(reply.trailer).type.toBe<
+    (
+      key: string,
+      fn: ((reply: FastifyReply, payload: string | Buffer | null) => Promise<string>) |
+      ((reply: FastifyReply, payload: string | Buffer | null,
+        done: (err: Error | null, value?: string) => void) => void)
+    ) => FastifyReply
+  >()
+  expect(reply.hasTrailer).type.toBe<(key: string) => boolean>()
+  expect(reply.removeTrailer).type.toBe<(key: string) => FastifyReply>()
+  expect(reply.server).type.toBe<FastifyInstance>()
+  expect(reply.getSerializationFunction).type.toBeAssignableTo<
+    ((httpStatus: string) => DefaultSerializationFunction | undefined)
+  >()
+  expect(reply.getSerializationFunction).type.toBeAssignableTo<
+    ((schema: { [key: string]: unknown }) => DefaultSerializationFunction | undefined)
+  >()
+  expect(reply.compileSerializationSchema).type.toBeAssignableTo<
+    ((schema: { [key: string]: unknown }, httpStatus?: string) => DefaultSerializationFunction)
+  >()
+  expect(reply.serializeInput).type.toBeAssignableTo<
+    ((input: { [key: string]: unknown }, schema: { [key: string]: unknown }, httpStatus?: string) => unknown)
+  >()
+  expect(reply.serializeInput).type.toBeAssignableTo<
+    ((input: { [key: string]: unknown }, httpStatus: string) => unknown)
+  >()
+  expect(reply.routeOptions.config).type.toBe<ContextConfigDefault & FastifyRouteConfig & FastifyContextConfig>()
+  expect(reply.getDecorator<string>('foo')).type.toBe<string>()
+}
+
+interface ReplyPayload {
+  Reply: {
+    test: boolean;
+  };
+}
+
+interface ReplyArrayPayload {
+  Reply: string[]
+}
+
+interface ReplyUnion {
+  Reply: {
+    success: boolean;
+  } | {
+    error: string;
+  }
+}
+
+interface ReplyHttpCodes {
+  Reply: {
+    '1xx': number,
+    200: 'abc',
+    201: boolean,
+    300: { foo: string },
+  }
+}
+
+interface InvalidReplyHttpCodes {
+  Reply: {
+    '1xx': number,
+    200: string,
+    999: boolean,
+  }
+}
+
+interface ReplyVoid {
+  Reply: void;
+}
+
+interface ReplyUndefined {
+  Reply: undefined;
+}
+
+// Issue #5534 scenario: 204 No Content should allow empty send(), 201 Created should require payload
+// Note: `204: undefined` gets converted to `unknown` via UndefinedToUnknown in type-provider.d.ts,
+// meaning send() is optional but send({}) is also allowed. Use `void` instead of `undefined`
+// if you want stricter "no payload allowed" semantics.
+interface ReplyHttpCodesWithNoContent {
+  Reply: {
+    201: { id: string };
+    204: undefined;
+  }
+}
+
+const typedHandler: RouteHandler<ReplyPayload> = async (request, reply) => {
+  // When Reply type is specified, send() requires a payload argument
+  expect(reply.send).type.toBe<((...args: [payload: ReplyPayload['Reply']]) => FastifyReply<ReplyPayload, RawServerDefault, RawRequestDefaultExpression<RawServerDefault>, RawReplyDefaultExpression<RawServerDefault>>)>()
+  expect(reply.code(100).send).type.toBe<((...args: [payload: ReplyPayload['Reply']]) => FastifyReply<ReplyPayload, RawServerDefault, RawRequestDefaultExpression<RawServerDefault>, RawReplyDefaultExpression<RawServerDefault>>)>()
+}
+
+const server = fastify()
+server.get('/get', getHandler)
+server.get('/typed', typedHandler)
+server.get<ReplyPayload>('/get-generic-send', async function handler (request, reply) {
+  reply.send({ test: true })
+})
+// When Reply type is specified, send() requires a payload - calling without arguments should error
+server.get<ReplyPayload>('/get-generic-send-missing-payload', async function handler (request, reply) {
+  reply
+  // @ts-expect-error  Expected 1 arguments, but got 0.
+    .send()
+})
+server.get<ReplyPayload>('/get-generic-return', async function handler (request, reply) {
+  return { test: false }
+})
+server.get<ReplyPayload>('/get-generic-send-error', async function handler (request, reply) {
+  reply.send({
+    // @ts-expect-error  'foo' does not exist in type '{ test: boolean; }'.
+    foo: 'bar'
+  })
+})
+// @ts-expect-error  No overload matches this call.
+server.get<ReplyPayload>('/get-generic-return-error', async function handler (request, reply) {
+  return { foo: 'bar' }
+})
+server.get<ReplyUnion>('/get-generic-union-send', async function handler (request, reply) {
+  if (0 as number === 0) {
+    reply.send({ success: true })
+  } else {
+    reply.send({ error: 'error' })
+  }
+})
+server.get<ReplyUnion>('/get-generic-union-return', async function handler (request, reply) {
+  if (0 as number === 0) {
+    return { success: true }
+  } else {
+    return { error: 'error' }
+  }
+})
+server.get<ReplyUnion>('/get-generic-union-send-error-1', async function handler (request, reply) {
+  reply.send({
+    // @ts-expect-error  'successes' does not exist in type '{ success: boolean; } | { error: string; }'.
+    successes: true
+  })
+})
+server.get<ReplyUnion>('/get-generic-union-send-error-2', async function handler (request, reply) {
+  reply.send({
+    // @ts-expect-error  Type 'number' is not assignable to type 'string'.
+    error: 500
+  })
+})
+// @ts-expect-error  No overload matches this call.
+server.get<ReplyUnion>('/get-generic-union-return-error-1', async function handler (request, reply) {
+  return { successes: true }
+})
+// @ts-expect-error  No overload matches this call.
+server.get<ReplyUnion>('/get-generic-union-return-error-2', async function handler (request, reply) {
+  return { error: 500 }
+})
+server.get<ReplyHttpCodes>('/get-generic-http-codes-send', async function handler (request, reply) {
+  reply.code(200).send('abc')
+  reply.code(201).send(true)
+  reply.code(300).send({ foo: 'bar' })
+  reply.code(101).send(123)
+})
+server.get<ReplyHttpCodes>('/get-generic-http-codes-send-error-1', async function handler (request, reply) {
+  reply.code(200)
+  // @ts-expect-error  Argument of type '"def"' is not assignable to parameter of type '"abc"'.
+    .send('def')
+})
+server.get<ReplyHttpCodes>('/get-generic-http-codes-send-error-2', async function handler (request, reply) {
+  reply.code(201)
+  // @ts-expect-error  Argument of type 'number' is not assignable to parameter of type 'boolean'.
+    .send(0)
+})
+server.get<ReplyHttpCodes>('/get-generic-http-codes-send-error-3', async function handler (request, reply) {
+  reply.code(300).send({
+    // @ts-expect-error  Type 'number' is not assignable to type 'string'.
+    foo: 123
+  })
+})
+server.get<ReplyHttpCodes>('/get-generic-http-codes-send-error-4', async function handler (request, reply) {
+  reply.code(100)
+  // @ts-expect-error  Argument of type 'string' is not assignable to parameter of type 'number'.
+    .send('asdasd')
+})
+server.get<ReplyHttpCodes>('/get-generic-http-codes-send-error-5', async function handler (request, reply) {
+  reply
+  // @ts-expect-error  Argument of type '401' is not assignable to parameter of type '100 | 101 | 102 | ... | 300'.
+    .code(401).send({
+    // @ts-expect-error  Type 'number' is not assignable to type 'string'.
+      foo: 123
+    })
+})
+server.get<ReplyArrayPayload>('/get-generic-array-send', async function handler (request, reply) {
+  reply.code(200).send([''])
+})
+server.get<InvalidReplyHttpCodes>('get-invalid-http-codes-reply-error', async function handler (request, reply) {
+  reply.code(200)
+  // @ts-expect-error  Argument of type 'string' is not assignable to parameter of type '{ '1xx': number; 200: string; 999: boolean; }'.
+    .send('')
+})
+server.get<InvalidReplyHttpCodes>('get-invalid-http-codes-reply-error', async function handler (request, reply) {
+  reply.code(200).send({
+    '1xx': 0,
+    200: '',
+    999: false
+  })
+})
+
+const httpHeaderHandler: RouteHandlerMethod = function (_request, reply) {
+  // accept is a header provided by @types/node
+  reply.getHeader('accept')
+  expect(reply.getHeaders()).type.toHaveProperty('accept')
+  reply.hasHeader('accept')
+  reply.header('accept', 'test')
+  reply.headers({ accept: 'test' })
+  reply.removeHeader('accept')
+
+  // x-fastify-test is not a header provided by @types/node
+  // and should not result in a typing error
+  reply.getHeader('x-fastify-test')
+  expect(reply.getHeaders()).type.toHaveProperty('x-fastify-test')
+  reply.hasHeader('x-fastify-test')
+  reply.header('x-fastify-test', 'test')
+  reply.headers({ 'x-fastify-test': 'test' })
+  reply.removeHeader('x-fastify-test')
+}
+
+// Test: send() without arguments is valid when no Reply type is specified (default unknown)
+server.get('/get-no-type-send-empty', async function handler (request, reply) {
+  reply.send()
+})
+
+// Test: send() without arguments is valid when Reply type is void
+server.get<ReplyVoid>('/get-void-send-empty', async function handler (request, reply) {
+  reply.send()
+})
+
+// Test: send() without arguments is valid when Reply type is undefined
+server.get<ReplyUndefined>('/get-undefined-send-empty', async function handler (request, reply) {
+  reply.send()
+})
+
+// Issue #5534 scenario: HTTP status codes with 204 No Content
+server.get<ReplyHttpCodesWithNoContent>('/get-http-codes-no-content', async function handler (request, reply) {
+  // 204 No Content - send() without payload is valid because Reply is undefined
+  reply.code(204).send()
+  // 201 Created - send() requires payload
+  reply.code(201).send({ id: '123' })
+})
+// 201 Created without payload should error
+server.get<ReplyHttpCodesWithNoContent>('/get-http-codes-201-missing-payload', async function handler (request, reply) {
+  reply.code(201)
+  // @ts-expect-error  Expected 1 arguments, but got 0.
+    .send()
+})

package/test/types/request.tst.ts

@@ -0,0 +1,199 @@
+import { expect } from 'tstyche'
+import fastify, {
+  ContextConfigDefault,
+  FastifyContextConfig,
+  FastifyLogFn,
+  FastifySchema,
+  FastifyTypeProviderDefault,
+  RawReplyDefaultExpression,
+  RawRequestDefaultExpression,
+  RawServerDefault,
+  RequestBodyDefault,
+  RequestGenericInterface,
+  RouteHandler,
+  RouteHandlerMethod,
+  SafePromiseLike
+} from '../../fastify.js'
+import { FastifyInstance } from '../../types/instance.js'
+import { FastifyBaseLogger } from '../../types/logger.js'
+import { FastifyReply } from '../../types/reply.js'
+import { FastifyRequest, RequestRouteOptions, ValidationFunction } from '../../types/request.js'
+import { FastifyRouteConfig, RouteGenericInterface } from '../../types/route.js'
+import { RequestHeadersDefault, RequestParamsDefault, RequestQuerystringDefault } from '../../types/utils.js'
+
+interface RequestBody {
+  content: string;
+}
+
+interface RequestQuerystring {
+  from: string;
+}
+
+interface RequestParams {
+  id: number;
+}
+
+interface RequestHeaders {
+  'x-foobar': string;
+}
+
+interface RequestData extends RequestGenericInterface {
+  Body: RequestBody;
+  Querystring: RequestQuerystring;
+  Params: RequestParams;
+  Headers: RequestHeaders;
+}
+
+type Handler = RouteHandler<RequestData>
+
+type CustomRequest = FastifyRequest<{
+  Body: RequestBody | undefined;
+  Querystring: RequestQuerystring;
+  Params: RequestParams;
+  Headers: RequestHeaders;
+}>
+
+type HTTPRequestPart = 'body' | 'query' | 'querystring' | 'params' | 'headers'
+type ExpectedGetValidationFunction = (input: { [key: string]: unknown }) => boolean
+
+interface CustomLoggerInterface extends FastifyBaseLogger {
+  foo: FastifyLogFn; // custom severity logger method
+}
+
+const getHandler: RouteHandler = function (request, _reply) {
+  expect(request.url).type.toBe<string>()
+  expect(request.originalUrl).type.toBe<string>()
+  expect(request.method).type.toBe<string>()
+  expect(request.routeOptions).type.toBe<Readonly<RequestRouteOptions>>()
+  expect(request.is404).type.toBe<boolean>()
+  expect(request.hostname).type.toBe<string>()
+  expect(request.host).type.toBe<string>()
+  expect(request.port).type.toBe<number | null>()
+  expect(request.ip).type.toBe<string>()
+  expect(request.ips).type.toBe<string[] | undefined>()
+  expect(request.raw).type.toBe<RawRequestDefaultExpression>()
+  expect(request.body).type.toBe<RequestBodyDefault>()
+  expect(request.params).type.toBe<RequestParamsDefault>()
+  expect(request.routeOptions.config).type.toBe<ContextConfigDefault & FastifyRouteConfig & FastifyContextConfig>()
+  expect(request.routeOptions.schema).type.toBe<FastifySchema | undefined>()
+  expect(request.routeOptions.handler).type.toBe<RouteHandlerMethod>()
+  expect(request.routeOptions.url).type.toBe<string | undefined>()
+  expect(request.routeOptions.version).type.toBe<string | undefined>()
+
+  expect(request.headers).type.toBe<RequestHeadersDefault & RawRequestDefaultExpression['headers']>()
+  request.headers = {}
+
+  expect(request.query).type.toBe<RequestQuerystringDefault>()
+  expect(request.id).type.toBe<string>()
+  expect(request.log).type.toBe<FastifyBaseLogger>()
+  expect(request.socket).type.toBe<RawRequestDefaultExpression['socket']>()
+  expect(request.signal).type.toBe<AbortSignal>()
+  expect(request.validationError).type.toBe<Error & { validation: any; validationContext: string } | undefined>()
+  expect(request.server).type.toBe<FastifyInstance>()
+  expect(request.getValidationFunction).type.toBeAssignableTo<
+    (httpPart: HTTPRequestPart) => ExpectedGetValidationFunction | undefined
+  >()
+  expect(request.getValidationFunction).type.toBeAssignableTo<
+    (schema: { [key: string]: unknown }) => ExpectedGetValidationFunction | undefined
+  >()
+  expect(request.getValidationFunction('body')).type.toBe<ValidationFunction | undefined>()
+  expect(request.getValidationFunction({ type: 'object' })).type.toBe<ValidationFunction | undefined>()
+  expect(request.validateInput).type.toBeAssignableTo<
+    (input: { [key: string]: unknown }, schema: { [key: string]: unknown }, httpPart?: HTTPRequestPart) => boolean
+  >()
+  expect(request.validateInput).type.toBeAssignableTo<
+    (input: { [key: string]: unknown }, httpPart?: HTTPRequestPart) => boolean
+  >()
+  expect(request.getDecorator<string>('foo')).type.toBe<string>()
+  expect(request.setDecorator('foo', 'hello')).type.toBe<void>()
+  expect(request.setDecorator<string>('foo', 'hello')).type.toBe<void>()
+  expect(request.setDecorator<string>).type.not.toBeCallableWith('foo', true)
+}
+
+const getHandlerWithCustomLogger: RouteHandlerMethod<
+  RawServerDefault,
+  RawRequestDefaultExpression,
+  RawReplyDefaultExpression,
+  RouteGenericInterface,
+  ContextConfigDefault,
+  FastifySchema,
+  FastifyTypeProviderDefault,
+  CustomLoggerInterface
+> = function (request, _reply) {
+  expect(request.log).type.toBe<CustomLoggerInterface>()
+}
+
+const postHandler: Handler = function (request) {
+  expect(request.body).type.toBe<RequestBody>()
+  expect(request.params).type.toBe<RequestParams>()
+  expect(
+    request.headers
+  ).type.toBe<RequestHeaders & RawRequestDefaultExpression['headers']>()
+  expect(request.query).type.toBe<RequestQuerystring>()
+  expect(request.body.content).type.toBe<string>()
+  expect(request.query.from).type.toBe<string>()
+  expect(request.params.id).type.toBe<number>()
+  expect(request.headers['x-foobar']).type.toBe<string>()
+  expect(request.server).type.toBe<FastifyInstance>()
+  expect(request.routeOptions.config).type.toBe<FastifyContextConfig & FastifyRouteConfig>()
+}
+
+function putHandler (request: CustomRequest, reply: FastifyReply) {
+  expect(request.body).type.toBe<RequestBody | undefined>()
+  expect(request.params).type.toBe<RequestParams>()
+  expect(request.headers).type.toBe<RequestHeaders & RawRequestDefaultExpression['headers']>()
+  expect(request.query).type.toBe<RequestQuerystring>()
+  if (request.body === undefined) {
+    expect(request.body).type.toBe<undefined>()
+  } else {
+    expect(request.body.content).type.toBe<string>()
+  }
+  expect(request.query.from).type.toBe<string>()
+  expect(request.params.id).type.toBe<number>()
+  expect(request.headers['x-foobar']).type.toBe<string>()
+  expect(request.server).type.toBe<FastifyInstance>()
+  expect(request.routeOptions.config).type.toBe<ContextConfigDefault & FastifyRouteConfig & FastifyContextConfig>()
+}
+
+const server = fastify()
+server.get('/get', getHandler)
+server.post('/post', postHandler)
+server.put('/put', putHandler)
+
+const customLogger: CustomLoggerInterface = {
+  level: 'info',
+  silent: () => { },
+  info: () => { },
+  warn: () => { },
+  error: () => { },
+  fatal: () => { },
+  trace: () => { },
+  debug: () => { },
+  foo: () => { }, // custom severity logger method
+  child: () => customLogger
+}
+
+const serverWithCustomLogger = fastify({ loggerInstance: customLogger })
+
+expect(serverWithCustomLogger).type.not.toBeAssignableTo<
+  FastifyInstance<RawServerDefault, RawRequestDefaultExpression, RawReplyDefaultExpression, CustomLoggerInterface>
+  & Promise<
+    FastifyInstance<RawServerDefault, RawRequestDefaultExpression, RawReplyDefaultExpression, CustomLoggerInterface>
+  >
+>()
+
+expect(serverWithCustomLogger).type.toBeAssignableTo<
+  FastifyInstance<RawServerDefault, RawRequestDefaultExpression, RawReplyDefaultExpression, CustomLoggerInterface>
+  & PromiseLike<
+    FastifyInstance<RawServerDefault, RawRequestDefaultExpression, RawReplyDefaultExpression, CustomLoggerInterface>
+  >
+>()
+
+expect(serverWithCustomLogger).type.toBe<
+  FastifyInstance<RawServerDefault, RawRequestDefaultExpression, RawReplyDefaultExpression, CustomLoggerInterface>
+  & SafePromiseLike<
+    FastifyInstance<RawServerDefault, RawRequestDefaultExpression, RawReplyDefaultExpression, CustomLoggerInterface>
+  >
+>()
+
+serverWithCustomLogger.get('/get', getHandlerWithCustomLogger)