fastify 4.5.3 → 4.7.0

package/docs/Reference/Type-Providers.md

@@ -148,21 +148,14 @@ fastify.register(pluginWithTypebox)
 
 It's also important to mention that once the types don't propagate globally,
 _currently_ is not possible to avoid multiple registrations on routes when
-dealing with several scopes, see bellow:
+dealing with several scopes, see below:
 
 ```ts
 import Fastify from 'fastify'
 import { TypeBoxTypeProvider } from '@fastify/type-provider-typebox'
 import { Type } from '@sinclair/typebox'
 
-const server = Fastify({
-    ajv: {
-        customOptions: {
-            strict: 'log',
-            keywords: ['kind', 'modifier'],
-        },
-    },
-}).withTypeProvider<TypeBoxTypeProvider>()
+const server = Fastify().withTypeProvider<TypeBoxTypeProvider>()
 
 server.register(plugin1) // wrong
 server.register(plugin2) // correct
@@ -213,14 +206,7 @@ import Fastify from 'fastify'
 import { TypeBoxTypeProvider } from '@fastify/type-provider-typebox'
 import { registerRoutes } from './routes'
 
-const server = Fastify({
-    ajv: {
-        customOptions: {
-            strict: 'log',
-            keywords: ['kind', 'modifier'],
-        },
-    },
-}).withTypeProvider<TypeBoxTypeProvider>()
+const server = Fastify().withTypeProvider<TypeBoxTypeProvider>()
 
 registerRoutes(server)
 
@@ -232,7 +218,7 @@ server.listen({ port: 3000 })
 import { Type } from '@sinclair/typebox'
 import {
   FastifyInstance,
-  FastifyLoggerInstance,
+  FastifyBaseLogger,
   RawReplyDefaultExpression,
   RawRequestDefaultExpression,
   RawServerDefault
@@ -243,7 +229,7 @@ type FastifyTypebox = FastifyInstance<
   RawServerDefault,
   RawRequestDefaultExpression<RawServerDefault>,
   RawReplyDefaultExpression<RawServerDefault>,
-  FastifyLoggerInstance,
+  FastifyBaseLogger,
   TypeBoxTypeProvider
 >;
 

package/docs/Reference/TypeScript.md

@@ -61,6 +61,11 @@ in a blank http Fastify server.
 *Note: Set `target` property in `tsconfig.json` to `es2017` or greater to avoid
 [FastifyDeprecation](https://github.com/fastify/fastify/issues/3284) warning.*
 
+*Note 2: Avoid using ```"moduleResolution": "NodeNext"``` in tsconfig.json with 
+```"type": "module"``` in package.json. This combination is currently not 
+supported by fastify typing system.
+[ts(2349)](https://github.com/fastify/fastify/issues/4241) warning.*
+
 4. Create an `index.ts` file - this will contain the server code
 5. Add the following code block to your file:
    ```typescript
@@ -254,18 +259,6 @@ can do it as follows:
     )
     ```
 
-     **Note** For Ajv version 7 and above is required to use the `ajvTypeBoxPlugin`:
-
-    ```typescript
-    import Fastify from 'fastify'
-    import { ajvTypeBoxPlugin, TypeBoxTypeProvider } from '@fastify/type-provider-typebox'
-
-    const fastify = Fastify({
-      ajv: {
-        plugins: [ajvTypeBoxPlugin]
-      }
-    }).withTypeProvider<TypeBoxTypeProvider>()
-    ```
 
 #### Schemas in JSON Files
 
@@ -1237,8 +1230,8 @@ const plugin: FastifyPlugin<{
   option2: boolean;
 }> = function (instance, opts, done) { }
 
-fastify().register(plugin, {}) // Error - options object is missing required properties
-fastify().register(plugin, { option1: '', option2: true }) // OK - options object contains required properties
+server().register(plugin, {}) // Error - options object is missing required properties
+server().register(plugin, { option1: '', option2: true }) // OK - options object contains required properties
 ```
 
 See the Learn By Example, [Plugins](#plugins) section for more detailed examples

package/examples/typescript-server.ts

@@ -56,7 +56,7 @@ const opts: RouteShorthandOptions = {
 };
 
 // Add our route handler with correct types
-server.get<{
+server.post<{
   Querystring: PingQuerystring;
   Params: PingParams;
   Headers: PingHeaders;

package/fastify.d.ts

@@ -84,7 +84,7 @@ export type FastifyHttpsOptions<
   Server extends https.Server,
   Logger extends FastifyBaseLogger = FastifyLoggerInstance
 > = FastifyServerOptions<Server, Logger> & {
-  https: https.ServerOptions
+  https: https.ServerOptions | null
 }
 
 type FindMyWayVersion<RawServer extends RawServerBase> = RawServer extends http.Server ? HTTPVersion.V1 : HTTPVersion.V2
@@ -197,7 +197,7 @@ export { FastifyPluginCallback, FastifyPluginAsync, FastifyPluginOptions, Fastif
 export { FastifyListenOptions, FastifyInstance, PrintRoutesOptions } from './types/instance'
 export { FastifyLoggerOptions, FastifyBaseLogger, FastifyLoggerInstance, FastifyLogFn, LogLevel } from './types/logger'
 export { FastifyContext, FastifyContextConfig } from './types/context'
-export { RouteHandler, RouteHandlerMethod, RouteOptions, RouteShorthandMethod, RouteShorthandOptions, RouteShorthandOptionsWithHandler } from './types/route'
+export { RouteHandler, RouteHandlerMethod, RouteOptions, RouteShorthandMethod, RouteShorthandOptions, RouteShorthandOptionsWithHandler, RouteGenericInterface } from './types/route'
 export * from './types/register'
 export { FastifyBodyParser, FastifyContentTypeParser, AddContentTypeParser, hasContentTypeParser, getDefaultJsonParser, ProtoAction, ConstructorAction } from './types/content-type-parser'
 export { FastifyError } from '@fastify/error'

package/fastify.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const VERSION = '4.5.3'
+const VERSION = '4.7.0'
 
 const Avvio = require('avvio')
 const http = require('http')
@@ -267,6 +267,9 @@ function fastify (options) {
       // otherwise we should bind it after the declaration
       return router.route.call(this, { options })
     },
+    hasRoute: function _route (options) {
+      return router.hasRoute.call(this, { options })
+    },
     // expose logger instance
     log: logger,
     // type provider

package/lib/contentTypeParser.js

@@ -1,11 +1,7 @@
 'use strict'
 
 const { AsyncResource } = require('async_hooks')
-let lru = require('tiny-lru')
-// Needed to handle Webpack and faux modules
-// See https://github.com/fastify/fastify/issues/2356
-// and https://github.com/fastify/fastify/discussions/2907.
-lru = typeof lru === 'function' ? lru : lru.default
+const lru = require('tiny-lru').lru
 
 const secureJson = require('secure-json-parse')
 const {
@@ -15,7 +11,8 @@ const {
   kRequestPayloadStream,
   kState,
   kTestInternals,
-  kReplyIsError
+  kReplyIsError,
+  kRouteContext
 } = require('./symbols')
 
 const {
@@ -149,12 +146,16 @@ ContentTypeParser.prototype.run = function (contentType, handler, request, reply
   const resource = new AsyncResource('content-type-parser:run', request)
 
   if (parser === undefined) {
-    reply.send(new FST_ERR_CTP_INVALID_MEDIA_TYPE(contentType || undefined))
+    if (request.is404) {
+      handler(request, reply)
+    } else {
+      reply.send(new FST_ERR_CTP_INVALID_MEDIA_TYPE(contentType || undefined))
+    }
   } else if (parser.asString === true || parser.asBuffer === true) {
     rawBody(
       request,
       reply,
-      reply.context._parserOptions,
+      reply[kRouteContext]._parserOptions,
       parser,
       done
     )
@@ -185,7 +186,7 @@ function rawBody (request, reply, options, parser, done) {
   const limit = options.limit === null ? parser.bodyLimit : options.limit
   const contentLength = request.headers['content-length'] === undefined
     ? NaN
-    : Number.parseInt(request.headers['content-length'], 10)
+    : Number(request.headers['content-length'])
 
   if (contentLength > limit) {
     reply.send(new FST_ERR_CTP_BODY_TOO_LARGE())

package/lib/context.js

@@ -12,10 +12,11 @@ const {
   kContentTypeParser,
   kRouteByFastify,
   kRequestValidateWeakMap,
-  kReplySerializeWeakMap
+  kReplySerializeWeakMap,
+  kPublicRouteContext
 } = require('./symbols.js')
 
-// Objects that holds the context of every request
+// Object that holds the context of every request
 // Every route holds an instance of this object.
 function Context ({
   schema,
@@ -56,7 +57,10 @@ function Context ({
   this[kFourOhFourContext] = null
   this.attachValidation = attachValidation
   this[kReplySerializerDefault] = replySerializer
-  this.schemaErrorFormatter = schemaErrorFormatter || server[kSchemaErrorFormatter] || defaultSchemaErrorFormatter
+  this.schemaErrorFormatter =
+    schemaErrorFormatter ||
+    server[kSchemaErrorFormatter] ||
+    defaultSchemaErrorFormatter
   this[kRouteByFastify] = isFastify
 
   this[kRequestValidateWeakMap] = null
@@ -64,9 +68,29 @@ function Context ({
   this.validatorCompiler = validatorCompiler || null
   this.serializerCompiler = serializerCompiler || null
 
+  // Route + Userland configurations for the route
+  this[kPublicRouteContext] = getPublicRouteContext(this)
+
   this.server = server
 }
 
+function getPublicRouteContext (context) {
+  return Object.create(null, {
+    schema: {
+      enumerable: true,
+      get () {
+        return context.schema
+      }
+    },
+    config: {
+      enumerable: true,
+      get () {
+        return context.config
+      }
+    }
+  })
+}
+
 function defaultSchemaErrorFormatter (errors, dataVar) {
   let text = ''
   const separator = ', '

package/lib/error-handler.js

@@ -3,7 +3,11 @@
 const statusCodes = require('http').STATUS_CODES
 const wrapThenable = require('./wrapThenable')
 const {
-  kReplyHeaders, kReplyNextErrorHandler, kReplyIsRunningOnErrorHook, kReplyHasStatusCode
+  kReplyHeaders,
+  kReplyNextErrorHandler,
+  kReplyIsRunningOnErrorHook,
+  kReplyHasStatusCode,
+  kRouteContext
 } = require('./symbols.js')
 
 const {
@@ -24,7 +28,7 @@ const rootErrorHandler = {
 function handleError (reply, error, cb) {
   reply[kReplyIsRunningOnErrorHook] = false
 
-  const context = reply.context
+  const context = reply[kRouteContext]
   if (reply[kReplyNextErrorHandler] === false) {
     fallbackErrorHandler(error, reply, function (reply, payload) {
       try {
@@ -90,7 +94,7 @@ function fallbackErrorHandler (error, reply, cb) {
   const statusCode = reply.statusCode
   let payload
   try {
-    const serializerFn = getSchemaSerializer(reply.context, statusCode)
+    const serializerFn = getSchemaSerializer(reply[kRouteContext], statusCode)
     payload = (serializerFn === false)
       ? serializeError({
         error: statusCodes[statusCode + ''],

package/lib/error-serializer.js

@@ -23,14 +23,6 @@ class Serializer {
     }
   }
 
-  asAny (i) {
-    return JSON.stringify(i)
-  }
-
-  asNull () {
-    return 'null'
-  }
-
   asInteger (i) {
     if (typeof i === 'bigint') {
       return i.toString()
@@ -47,10 +39,6 @@ class Serializer {
     }
   }
 
-  asIntegerNullable (i) {
-    return i === null ? 'null' : this.asInteger(i)
-  }
-
   asNumber (i) {
     const num = Number(i)
     if (Number.isNaN(num)) {
@@ -62,54 +50,43 @@ class Serializer {
     }
   }
 
-  asNumberNullable (i) {
-    return i === null ? 'null' : this.asNumber(i)
-  }
-
   asBoolean (bool) {
     return bool && 'true' || 'false' // eslint-disable-line
   }
 
-  asBooleanNullable (bool) {
-    return bool === null ? 'null' : this.asBoolean(bool)
-  }
-
   asDateTime (date) {
     if (date === null) return '""'
     if (date instanceof Date) {
       return '"' + date.toISOString() + '"'
     }
+    if (typeof date === 'string') {
+      return '"' + date + '"'
+    }
     throw new Error(`The value "${date}" cannot be converted to a date-time.`)
   }
 
-  asDateTimeNullable (date) {
-    return date === null ? 'null' : this.asDateTime(date)
-  }
-
   asDate (date) {
     if (date === null) return '""'
     if (date instanceof Date) {
       return '"' + new Date(date.getTime() - (date.getTimezoneOffset() * 60000)).toISOString().slice(0, 10) + '"'
     }
+    if (typeof date === 'string') {
+      return '"' + date + '"'
+    }
     throw new Error(`The value "${date}" cannot be converted to a date.`)
   }
 
-  asDateNullable (date) {
-    return date === null ? 'null' : this.asDate(date)
-  }
-
   asTime (date) {
     if (date === null) return '""'
     if (date instanceof Date) {
       return '"' + new Date(date.getTime() - (date.getTimezoneOffset() * 60000)).toISOString().slice(11, 19) + '"'
     }
+    if (typeof date === 'string') {
+      return '"' + date + '"'
+    }
     throw new Error(`The value "${date}" cannot be converted to a time.`)
   }
 
-  asTimeNullable (date) {
-    return date === null ? 'null' : this.asTime(date)
-  }
-
   asString (str) {
     const quotes = '"'
     if (str instanceof Date) {
@@ -129,10 +106,6 @@ class Serializer {
     }
   }
 
-  asStringNullable (str) {
-    return str === null ? 'null' : this.asString(str)
-  }
-
   // magically escape strings for json
   // relying on their charCodeAt
   // everything below 32 needs JSON.stringify()
@@ -200,7 +173,7 @@ class Serializer {
   }
 
         json += "\"statusCode\"" + ':'
-      json += serializer.asNumber.bind(serializer)(obj["statusCode"])
+      json += serializer.asNumber(obj["statusCode"])
       }
     
       if (obj["code"] !== undefined) {
@@ -212,7 +185,7 @@ class Serializer {
   }
 
         json += "\"code\"" + ':'
-      json += serializer.asString.bind(serializer)(obj["code"])
+      json += serializer.asString(obj["code"])
       }
     
       if (obj["error"] !== undefined) {
@@ -224,7 +197,7 @@ class Serializer {
   }
 
         json += "\"error\"" + ':'
-      json += serializer.asString.bind(serializer)(obj["error"])
+      json += serializer.asString(obj["error"])
       }
     
       if (obj["message"] !== undefined) {
@@ -236,7 +209,7 @@ class Serializer {
   }
 
         json += "\"message\"" + ':'
-      json += serializer.asString.bind(serializer)(obj["message"])
+      json += serializer.asString(obj["message"])
       }
     
       json += '}'

package/lib/handleRequest.js

@@ -4,7 +4,8 @@ const { validate: validateSchema } = require('./validation')
 const { hookRunner, hookIterator } = require('./hooks')
 const wrapThenable = require('./wrapThenable')
 const {
-  kReplyIsError
+  kReplyIsError,
+  kRouteContext
 } = require('./symbols')
 
 function handleRequest (err, request, reply) {
@@ -17,15 +18,16 @@ function handleRequest (err, request, reply) {
 
   const method = request.raw.method
   const headers = request.headers
+  const context = request[kRouteContext]
 
-  if (method === 'GET' || method === 'HEAD' || method === 'SEARCH') {
+  if (method === 'GET' || method === 'HEAD') {
     handler(request, reply)
     return
   }
 
   const contentType = headers['content-type']
 
-  if (method === 'POST' || method === 'PUT' || method === 'PATCH' || method === 'TRACE') {
+  if (method === 'POST' || method === 'PUT' || method === 'PATCH' || method === 'TRACE' || method === 'SEARCH') {
     if (contentType === undefined) {
       if (
         headers['transfer-encoding'] === undefined &&
@@ -33,10 +35,10 @@ function handleRequest (err, request, reply) {
       ) { // Request has no body to parse
         handler(request, reply)
       } else {
-        reply.context.contentTypeParser.run('', handler, request, reply)
+        context.contentTypeParser.run('', handler, request, reply)
       }
     } else {
-      reply.context.contentTypeParser.run(contentType, handler, request, reply)
+      context.contentTypeParser.run(contentType, handler, request, reply)
     }
     return
   }
@@ -49,7 +51,7 @@ function handleRequest (err, request, reply) {
         headers['content-length'] !== undefined
       )
     ) {
-      reply.context.contentTypeParser.run(contentType, handler, request, reply)
+      context.contentTypeParser.run(contentType, handler, request, reply)
     } else {
       handler(request, reply)
     }
@@ -62,9 +64,9 @@ function handleRequest (err, request, reply) {
 
 function handler (request, reply) {
   try {
-    if (reply.context.preValidation !== null) {
+    if (request[kRouteContext].preValidation !== null) {
       hookRunner(
-        reply.context.preValidation,
+        request[kRouteContext].preValidation,
         hookIterator,
         request,
         reply,
@@ -87,9 +89,9 @@ function preValidationCallback (err, request, reply) {
     return
   }
 
-  const result = validateSchema(reply.context, request)
+  const result = validateSchema(reply[kRouteContext], request)
   if (result) {
-    if (reply.context.attachValidation === false) {
+    if (reply[kRouteContext].attachValidation === false) {
       reply.send(result)
       return
     }
@@ -98,9 +100,9 @@ function preValidationCallback (err, request, reply) {
   }
 
   // preHandler hook
-  if (reply.context.preHandler !== null) {
+  if (request[kRouteContext].preHandler !== null) {
     hookRunner(
-      reply.context.preHandler,
+      request[kRouteContext].preHandler,
       hookIterator,
       request,
       reply,
@@ -123,7 +125,7 @@ function preHandlerCallback (err, request, reply) {
   let result
 
   try {
-    result = reply.context.handler(request, reply)
+    result = request[kRouteContext].handler(request, reply)
   } catch (err) {
     reply[kReplyIsError] = true
     reply.send(err)