fastify 5.0.0 → 5.2.0

package/test/web-api.test.js

@@ -1,7 +1,6 @@
 'use strict'
 
-const t = require('tap')
-const test = t.test
+const { test } = require('node:test')
 const Fastify = require('../fastify')
 const fs = require('node:fs')
 const { Readable } = require('node:stream')
@@ -24,8 +23,8 @@ test('should response with a ReadableStream', async (t) => {
 
   const expected = await fs.promises.readFile(__filename)
 
-  t.equal(statusCode, 200)
-  t.equal(expected.toString(), body.toString())
+  t.assert.strictEqual(statusCode, 200)
+  t.assert.strictEqual(expected.toString(), body.toString())
 })
 
 test('should response with a Response', async (t) => {
@@ -51,9 +50,9 @@ test('should response with a Response', async (t) => {
 
   const expected = await fs.promises.readFile(__filename)
 
-  t.equal(statusCode, 200)
-  t.equal(expected.toString(), body.toString())
-  t.equal(headers.hello, 'world')
+  t.assert.strictEqual(statusCode, 200)
+  t.assert.strictEqual(expected.toString(), body.toString())
+  t.assert.strictEqual(headers.hello, 'world')
 })
 
 test('should response with a Response 204', async (t) => {
@@ -76,9 +75,9 @@ test('should response with a Response 204', async (t) => {
     body
   } = await fastify.inject({ method: 'GET', path: '/' })
 
-  t.equal(statusCode, 204)
-  t.equal(body, '')
-  t.equal(headers.hello, 'world')
+  t.assert.strictEqual(statusCode, 204)
+  t.assert.strictEqual(body, '')
+  t.assert.strictEqual(headers.hello, 'world')
 })
 
 test('should response with a Response 304', async (t) => {
@@ -101,9 +100,9 @@ test('should response with a Response 304', async (t) => {
     body
   } = await fastify.inject({ method: 'GET', path: '/' })
 
-  t.equal(statusCode, 304)
-  t.equal(body, '')
-  t.equal(headers.hello, 'world')
+  t.assert.strictEqual(statusCode, 304)
+  t.assert.strictEqual(body, '')
+  t.assert.strictEqual(headers.hello, 'world')
 })
 
 test('should response with a Response without body', async (t) => {
@@ -126,9 +125,9 @@ test('should response with a Response without body', async (t) => {
     body
   } = await fastify.inject({ method: 'GET', path: '/' })
 
-  t.equal(statusCode, 200)
-  t.equal(body, '')
-  t.equal(headers.hello, 'world')
+  t.assert.strictEqual(statusCode, 200)
+  t.assert.strictEqual(body, '')
+  t.assert.strictEqual(headers.hello, 'world')
 })
 
 test('able to use in onSend hook - ReadableStream', async (t) => {
@@ -142,7 +141,7 @@ test('able to use in onSend hook - ReadableStream', async (t) => {
   })
 
   fastify.addHook('onSend', (request, reply, payload, done) => {
-    t.equal(Object.prototype.toString.call(payload), '[object ReadableStream]')
+    t.assert.strictEqual(Object.prototype.toString.call(payload), '[object ReadableStream]')
     done(null, new Response(payload, {
       status: 200,
       headers: {
@@ -159,9 +158,9 @@ test('able to use in onSend hook - ReadableStream', async (t) => {
 
   const expected = await fs.promises.readFile(__filename)
 
-  t.equal(statusCode, 200)
-  t.equal(expected.toString(), body.toString())
-  t.equal(headers.hello, 'world')
+  t.assert.strictEqual(statusCode, 200)
+  t.assert.strictEqual(expected.toString(), body.toString())
+  t.assert.strictEqual(headers.hello, 'world')
 })
 
 test('able to use in onSend hook - Response', async (t) => {
@@ -180,7 +179,7 @@ test('able to use in onSend hook - Response', async (t) => {
   })
 
   fastify.addHook('onSend', (request, reply, payload, done) => {
-    t.equal(Object.prototype.toString.call(payload), '[object Response]')
+    t.assert.strictEqual(Object.prototype.toString.call(payload), '[object Response]')
     done(null, new Response(payload.body, {
       status: 200,
       headers: payload.headers
@@ -195,9 +194,9 @@ test('able to use in onSend hook - Response', async (t) => {
 
   const expected = await fs.promises.readFile(__filename)
 
-  t.equal(statusCode, 200)
-  t.equal(expected.toString(), body.toString())
-  t.equal(headers.hello, 'world')
+  t.assert.strictEqual(statusCode, 200)
+  t.assert.strictEqual(expected.toString(), body.toString())
+  t.assert.strictEqual(headers.hello, 'world')
 })
 
 test('Error when Response.bodyUsed', async (t) => {
@@ -216,31 +215,37 @@ test('Error when Response.bodyUsed', async (t) => {
       }
     })
     const file = await response.text()
-    t.equal(expected.toString(), file)
-    t.equal(response.bodyUsed, true)
+    t.assert.strictEqual(expected.toString(), file)
+    t.assert.strictEqual(response.bodyUsed, true)
     return reply.send(response)
   })
 
   const response = await fastify.inject({ method: 'GET', path: '/' })
 
-  t.equal(response.statusCode, 500)
+  t.assert.strictEqual(response.statusCode, 500)
   const body = response.json()
-  t.equal(body.code, 'FST_ERR_REP_RESPONSE_BODY_CONSUMED')
+  t.assert.strictEqual(body.code, 'FST_ERR_REP_RESPONSE_BODY_CONSUMED')
 })
 
 test('allow to pipe with fetch', async (t) => {
   t.plan(2)
+  const abortController = new AbortController()
+  const { signal } = abortController
 
   const fastify = Fastify()
-  t.teardown(fastify.close.bind(fastify))
+  t.after(() => {
+    fastify.close()
+    abortController.abort()
+  })
 
   fastify.get('/', function (request, reply) {
     return fetch(`${fastify.listeningOrigin}/fetch`, {
-      method: 'GET'
+      method: 'GET',
+      signal
     })
   })
 
-  fastify.get('/fetch', function (request, reply) {
+  fastify.get('/fetch', function async (request, reply) {
     reply.code(200).send({ ok: true })
   })
 
@@ -248,19 +253,25 @@ test('allow to pipe with fetch', async (t) => {
 
   const response = await fastify.inject({ method: 'GET', path: '/' })
 
-  t.equal(response.statusCode, 200)
-  t.same(response.json(), { ok: true })
+  t.assert.strictEqual(response.statusCode, 200)
+  t.assert.deepStrictEqual(response.json(), { ok: true })
 })
 
 test('allow to pipe with undici.fetch', async (t) => {
   t.plan(2)
+  const abortController = new AbortController()
+  const { signal } = abortController
 
   const fastify = Fastify()
-  t.teardown(fastify.close.bind(fastify))
+  t.after(() => {
+    fastify.close()
+    abortController.abort()
+  })
 
   fastify.get('/', function (request, reply) {
     return undiciFetch(`${fastify.listeningOrigin}/fetch`, {
-      method: 'GET'
+      method: 'GET',
+      signal
     })
   })
 
@@ -272,6 +283,6 @@ test('allow to pipe with undici.fetch', async (t) => {
 
   const response = await fastify.inject({ method: 'GET', path: '/' })
 
-  t.equal(response.statusCode, 200)
-  t.same(response.json(), { ok: true })
+  t.assert.strictEqual(response.statusCode, 200)
+  t.assert.deepStrictEqual(response.json(), { ok: true })
 })

package/test/{wrapThenable.test.js → wrap-thenable.test.js}

@@ -1,17 +1,18 @@
 'use strict'
 
-const t = require('tap')
-const test = t.test
+const { test } = require('node:test')
 const { kReplyHijacked } = require('../lib/symbols')
 const wrapThenable = require('../lib/wrapThenable')
 const Reply = require('../lib/reply')
 
-test('should resolve immediately when reply[kReplyHijacked] is true', t => {
-  const reply = {}
-  reply[kReplyHijacked] = true
-  const thenable = Promise.resolve()
-  wrapThenable(thenable, reply)
-  t.end()
+test('should resolve immediately when reply[kReplyHijacked] is true', async t => {
+  await new Promise(resolve => {
+    const reply = {}
+    reply[kReplyHijacked] = true
+    const thenable = Promise.resolve()
+    wrapThenable(thenable, reply)
+    resolve()
+  })
 })
 
 test('should reject immediately when reply[kReplyHijacked] is true', t => {
@@ -20,7 +21,7 @@ test('should reject immediately when reply[kReplyHijacked] is true', t => {
   reply[kReplyHijacked] = true
   reply.log = {
     error: ({ err }) => {
-      t.equal(err.message, 'Reply sent already')
+      t.assert.strictEqual(err.message, 'Reply sent already')
     }
   }
 

package/types/hooks.d.ts

@@ -1,4 +1,4 @@
-import { Readable } from 'stream'
+import { Readable } from 'node:stream'
 import { FastifyInstance } from './instance'
 import { RouteOptions, RouteGenericInterface } from './route'
 import { RawServerBase, RawServerDefault, RawRequestDefaultExpression, RawReplyDefaultExpression, ContextConfigDefault } from './utils'
@@ -710,6 +710,7 @@ export interface onRegisterHookHandler<
   Options extends FastifyPluginOptions = FastifyPluginOptions
 > {
   (
+    this: FastifyInstance<RawServer, RawRequest, RawReply, Logger, TypeProvider>,
     instance: FastifyInstance<RawServer, RawRequest, RawReply, Logger, TypeProvider>,
     opts: RegisterOptions & Options
   ): Promise<unknown> | void;

package/types/instance.d.ts

@@ -1,8 +1,8 @@
 import { FastifyError } from '@fastify/error'
 import { ConstraintStrategy, FindResult, HTTPVersion } from 'find-my-way'
-import * as http from 'http'
+import * as http from 'node:http'
 import { InjectOptions, CallbackFunc as LightMyRequestCallback, Chain as LightMyRequestChain, Response as LightMyRequestResponse } from 'light-my-request'
-import { AddressInfo } from 'net'
+import { AddressInfo } from 'node:net'
 import { AddContentTypeParser, ConstructorAction, FastifyBodyParser, ProtoAction, getDefaultJsonParser, hasContentTypeParser, removeAllContentTypeParsers, removeContentTypeParser } from './content-type-parser'
 import { ApplicationHook, HookAsyncLookup, HookLookup, LifecycleHook, 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 } from './hooks'
 import { FastifyBaseLogger, FastifyChildLoggerFactory } from './logger'
@@ -548,6 +548,13 @@ export interface FastifyInstance<
    * Remove all content type parsers, including the default ones
    */
   removeAllContentTypeParsers: removeAllContentTypeParsers
+  /**
+   * Add a non-standard HTTP method
+   *
+   * Methods defined by default include `GET`, `HEAD`, `TRACE`, `DELETE`,
+   * `OPTIONS`, `PATCH`, `PUT` and `POST`
+   */
+  addHttpMethod(method: string, methodOptions?: { hasBody: boolean }): FastifyInstance<RawServer, RawRequest, RawReply, Logger, TypeProvider>;
   /**
    * Fastify default JSON parser
    */

package/types/register.d.ts

@@ -18,16 +18,25 @@ export type FastifyRegisterOptions<Options> = (RegisterOptions & Options) | ((in
  * Function for adding a plugin to fastify. The options are inferred from the passed in FastifyPlugin parameter.
  */
 export interface FastifyRegister<T = void, RawServer extends RawServerBase = RawServerDefault, TypeProviderDefault extends FastifyTypeProvider = FastifyTypeProvider, LoggerDefault extends FastifyBaseLogger = FastifyBaseLogger> {
+  <Server extends RawServerBase = RawServer, TypeProvider extends FastifyTypeProvider = TypeProviderDefault, Logger extends FastifyBaseLogger = LoggerDefault>(
+    plugin: FastifyPluginCallback<FastifyPluginOptions, Server, TypeProvider, Logger>
+  ): T;
   <Options extends FastifyPluginOptions, Server extends RawServerBase = RawServer, TypeProvider extends FastifyTypeProvider = TypeProviderDefault, Logger extends FastifyBaseLogger = LoggerDefault>(
     plugin: FastifyPluginCallback<Options, Server, TypeProvider, Logger>,
-    opts?: FastifyRegisterOptions<Options>
+    opts: FastifyRegisterOptions<Options>
+  ): T;
+  <Server extends RawServerBase = RawServer, TypeProvider extends FastifyTypeProvider = TypeProviderDefault, Logger extends FastifyBaseLogger = LoggerDefault>(
+    plugin: FastifyPluginAsync<FastifyPluginOptions, Server, TypeProvider, Logger>
   ): T;
   <Options extends FastifyPluginOptions, Server extends RawServerBase = RawServer, TypeProvider extends FastifyTypeProvider = TypeProviderDefault, Logger extends FastifyBaseLogger = LoggerDefault>(
     plugin: FastifyPluginAsync<Options, Server, TypeProvider, Logger>,
-    opts?: FastifyRegisterOptions<Options>
+    opts: FastifyRegisterOptions<Options>
+  ): T;
+  <Server extends RawServerBase = RawServer, TypeProvider extends FastifyTypeProvider = TypeProviderDefault, Logger extends FastifyBaseLogger = LoggerDefault>(
+    plugin: FastifyPluginCallback<FastifyPluginOptions, Server, TypeProvider, Logger> | FastifyPluginAsync<FastifyPluginOptions, Server, TypeProvider, Logger> | Promise<{ default: FastifyPluginCallback<FastifyPluginOptions, Server, TypeProvider, Logger> }> | Promise<{ default: FastifyPluginAsync<FastifyPluginOptions, Server, TypeProvider, Logger> }>,
   ): T;
   <Options extends FastifyPluginOptions, Server extends RawServerBase = RawServer, TypeProvider extends FastifyTypeProvider = TypeProviderDefault, Logger extends FastifyBaseLogger = LoggerDefault>(
     plugin: FastifyPluginCallback<Options, Server, TypeProvider, Logger> | FastifyPluginAsync<Options, Server, TypeProvider, Logger> | Promise<{ default: FastifyPluginCallback<Options, Server, TypeProvider, Logger> }> | Promise<{ default: FastifyPluginAsync<Options, Server, TypeProvider, Logger> }>,
-    opts?: FastifyRegisterOptions<Options>
+    opts: FastifyRegisterOptions<Options>
   ): T;
 }

package/types/reply.d.ts

@@ -1,4 +1,4 @@
-import { Buffer } from 'buffer'
+import { Buffer } from 'node:buffer'
 import { FastifyInstance } from './instance'
 import { FastifyBaseLogger } from './logger'
 import { FastifyRequest, RequestRouteOptions } from './request'

package/types/request.d.ts

@@ -5,7 +5,7 @@ import { FastifyBaseLogger } from './logger'
 import { FastifyRouteConfig, RouteGenericInterface, RouteHandlerMethod } from './route'
 import { FastifySchema } from './schema'
 import { FastifyRequestType, FastifyTypeProvider, FastifyTypeProviderDefault, ResolveFastifyRequestType } from './type-provider'
-import { ContextConfigDefault, RawRequestDefaultExpression, RawServerBase, RawServerDefault, RequestBodyDefault, RequestHeadersDefault, RequestParamsDefault, RequestQuerystringDefault } from './utils'
+import { ContextConfigDefault, HTTPMethods, RawRequestDefaultExpression, RawServerBase, RawServerDefault, RequestBodyDefault, RequestHeadersDefault, RequestParamsDefault, RequestQuerystringDefault } from './utils'
 
 type HTTPRequestPart = 'body' | 'query' | 'querystring' | 'params' | 'headers'
 export interface RequestGenericInterface {
@@ -21,7 +21,7 @@ export interface ValidationFunction {
 }
 
 export interface RequestRouteOptions<ContextConfig = ContextConfigDefault, SchemaCompiler = FastifySchema> {
-  method: string;
+  method: HTTPMethods | HTTPMethods[];
   // `url` can be `undefined` for instance when `request.is404` is true
   url: string | undefined;
   bodyLimit: number;
@@ -87,8 +87,4 @@ export interface FastifyRequest<RouteGeneric extends RouteGenericInterface = Rou
   compileValidationSchema(schema: { [key: string]: any }, httpPart?: HTTPRequestPart): ValidationFunction
   validateInput(input: any, schema: { [key: string]: any }, httpPart?: HTTPRequestPart): boolean
   validateInput(input: any, httpPart?: HTTPRequestPart): boolean
-
-  // Prefer `socket` over deprecated `connection` property in node 13.0.0 or higher
-  // @deprecated
-  readonly connection: RawRequest['socket'];
 }

package/types/serverFactory.d.ts

@@ -1,7 +1,7 @@
 import { RawServerBase, RawServerDefault, RawReplyDefaultExpression, RawRequestDefaultExpression } from './utils'
-import * as http from 'http'
-import * as https from 'https'
-import * as http2 from 'http2'
+import * as http from 'node:http'
+import * as https from 'node:https'
+import * as http2 from 'node:http2'
 
 export type FastifyServerFactoryHandler<
   RawServer extends RawServerBase = RawServerDefault,

package/types/utils.d.ts

@@ -1,14 +1,23 @@
-import * as http from 'http'
-import * as http2 from 'http2'
-import * as https from 'https'
+import * as http from 'node:http'
+import * as http2 from 'node:http2'
+import * as https from 'node:https'
+
+type AutocompletePrimitiveBaseType<T> =
+  T extends string ? string :
+    T extends number ? number :
+      T extends boolean ? boolean :
+        never
+
+export type Autocomplete<T> = T | (AutocompletePrimitiveBaseType<T> & Record<never, never>)
 
 /**
  * Standard HTTP method strings
+ * for internal use
  */
 type _HTTPMethods = 'DELETE' | 'GET' | 'HEAD' | 'PATCH' | 'POST' | 'PUT' | 'OPTIONS' |
 'PROPFIND' | 'PROPPATCH' | 'MKCOL' | 'COPY' | 'MOVE' | 'LOCK' | 'UNLOCK' | 'TRACE' | 'SEARCH' | 'REPORT' | 'MKCALENDAR'
 
-export type HTTPMethods = Uppercase<_HTTPMethods> | Lowercase<_HTTPMethods>
+export type HTTPMethods = Autocomplete<_HTTPMethods | Lowercase<_HTTPMethods>>
 
 /**
  * A union type of the Node.js server types from the http, https, and http2 modules.
@@ -56,7 +65,6 @@ type Digit = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9
 type HttpCodes = StringAsNumber<`${CodeClasses}${Digit}${Digit}`>
 type HttpKeys = HttpCodes | `${Digit}xx`
 export type StatusCodeReply = {
-
   [Key in HttpKeys]?: unknown;
 }
 

package/test/types/import.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });