fastify 3.5.0 → 3.8.0

package/docs/Validation-and-Serialization.md

@@ -163,13 +163,19 @@ const bodyJsonSchema = {
 }
 
 const queryStringJsonSchema = {
-  name: { type: 'string' },
-  excitement: { type: 'integer' }
+  type: 'object',
+  properties: {
+    name: { type: 'string' },
+    excitement: { type: 'integer' }
+  }
 }
 
 const paramsJsonSchema = {
-  par1: { type: 'string' },
-  par2: { type: 'number' }
+  type: 'object',
+  properties: {
+    par1: { type: 'string' },
+    par2: { type: 'number' }
+  }
 }
 
 const headersJsonSchema = {
@@ -198,7 +204,7 @@ fastify.post('/the/url', { schema }, handler)
 
 You can provide a list of plugins you want to use with Ajv:
 
-> Refer to [`ajv options`](Server.md#factory-ajv) to check plugins format
+> Refer to [`ajv options`](Server.md#ajv) to check plugins format
 
 ```js
 const fastify = require('fastify')({

package/examples/parser.js

@@ -16,7 +16,7 @@ fastify.addContentTypeParser('application/jsoff', function (request, payload, do
 
 // curl -X POST -d 'hello=world' -H'Content-type: application/x-www-form-urlencoded' http://localhost:3000/
 fastify.addContentTypeParser('application/x-www-form-urlencoded', function (request, payload, done) {
-  var body = ''
+  let body = ''
   payload.on('data', function (data) {
     body += data
   })

package/fastify.d.ts

@@ -119,8 +119,8 @@ export type FastifyServerOptions<
 type TrustProxyFunction = (address: string, hop: number) => boolean
 
 /* Export all additional types */
-export * from './types/request'
-export * from './types/reply'
+export { FastifyRequest, RequestGenericInterface } from './types/request'
+export { FastifyReply } from './types/reply'
 export { FastifyPluginCallback, FastifyPluginAsync, FastifyPluginOptions, FastifyPlugin } from './types/plugin'
 export { FastifyInstance } from './types/instance'
 export { FastifyLoggerOptions, FastifyLoggerInstance, FastifyLogFn, LogLevel } from './types/logger'

package/fastify.js

@@ -5,6 +5,7 @@ const http = require('http')
 const querystring = require('querystring')
 let lightMyRequest
 let version
+let versionLoaded = false
 
 const {
   kAvvioBoot,
@@ -25,7 +26,8 @@ const {
   kState,
   kOptions,
   kPluginNameChain,
-  kSchemaErrorFormatter
+  kSchemaErrorFormatter,
+  kErrorHandler
 } = require('./lib/symbols.js')
 
 const { createServer } = require('./lib/server')
@@ -57,6 +59,21 @@ const onBadUrlContext = {
   onError: []
 }
 
+function defaultErrorHandler (error, request, reply) {
+  if (reply.statusCode < 500) {
+    reply.log.info(
+      { res: reply, err: error },
+      error && error.message
+    )
+  } else {
+    reply.log.error(
+      { req: request, res: reply, err: error },
+      error && error.message
+    )
+  }
+  reply.send(error)
+}
+
 function fastify (options) {
   // Options validations
   options = options || {}
@@ -160,6 +177,7 @@ function fastify (options) {
     [kSchemas]: schemas,
     [kValidatorCompiler]: null,
     [kSchemaErrorFormatter]: options.schemaErrorFormatter,
+    [kErrorHandler]: defaultErrorHandler,
     [kSerializerCompiler]: null,
     [kReplySerializerDefault]: null,
     [kContentTypeParser]: new ContentTypeParser(
@@ -219,6 +237,8 @@ function fastify (options) {
     // custom parsers
     addContentTypeParser: ContentTypeParser.helpers.addContentTypeParser,
     hasContentTypeParser: ContentTypeParser.helpers.hasContentTypeParser,
+    getDefaultJsonParser: ContentTypeParser.defaultParsers.getDefaultJsonParser,
+    defaultTextParser: ContentTypeParser.defaultParsers.defaultTextParser,
     // Fastify architecture methods (initialized by Avvio)
     register: null,
     after: null,
@@ -266,11 +286,16 @@ function fastify (options) {
     },
     version: {
       get () {
-        if (version === undefined) {
+        if (versionLoaded === false) {
           version = loadVersion()
         }
         return version
       }
+    },
+    errorHandler: {
+      get () {
+        return this[kErrorHandler]
+      }
     }
   })
 
@@ -504,8 +529,8 @@ function fastify (options) {
 
   function onBadUrl (path, req, res) {
     if (frameworkErrors) {
-      var id = genReqId(req)
-      var childLogger = logger.child({ reqId: id })
+      const id = genReqId(req)
+      const childLogger = logger.child({ reqId: id })
 
       childLogger.info({ req }, 'incoming request')
 
@@ -558,7 +583,7 @@ function fastify (options) {
   function setErrorHandler (func) {
     throwIfAlreadyStarted('Cannot call "setErrorHandler" when fastify instance is already started!')
 
-    this._errorHandler = func
+    this[kErrorHandler] = func.bind(this)
     return this
   }
 }
@@ -591,10 +616,17 @@ function wrapRouting (httpHandler, { rewriteUrl, logger }) {
 }
 
 function loadVersion () {
+  versionLoaded = true
   const fs = require('fs')
   const path = require('path')
-  const pkg = JSON.parse(fs.readFileSync(path.join(__dirname, 'package.json')))
-  return pkg.version
+  try {
+    const pkgPath = path.join(__dirname, 'package.json')
+    fs.accessSync(pkgPath, fs.constants.R_OK)
+    const pkg = JSON.parse(fs.readFileSync(pkgPath))
+    return pkg.name === 'fastify' ? pkg.version : undefined
+  } catch (e) {
+    return undefined
+  }
 }
 
 /**

package/lib/contentTypeParser.js

@@ -81,9 +81,10 @@ ContentTypeParser.prototype.existingParser = function (contentType) {
 }
 
 ContentTypeParser.prototype.getParser = function (contentType) {
+  /* eslint-disable no-var */
   for (var i = 0; i < this.parserList.length; i++) {
     if (contentType.indexOf(this.parserList[i]) > -1) {
-      var parser = this.customParsers[this.parserList[i]]
+      const parser = this.customParsers[this.parserList[i]]
       this.cache.set(contentType, parser)
       return parser
     }
@@ -93,7 +94,7 @@ ContentTypeParser.prototype.getParser = function (contentType) {
 }
 
 ContentTypeParser.prototype.run = function (contentType, handler, request, reply) {
-  var parser = this.cache.get(contentType) || this.getParser(contentType)
+  const parser = this.cache.get(contentType) || this.getParser(contentType)
 
   if (parser === undefined) {
     reply.send(new FST_ERR_CTP_INVALID_MEDIA_TYPE(contentType))
@@ -106,7 +107,7 @@ ContentTypeParser.prototype.run = function (contentType, handler, request, reply
       done
     )
   } else {
-    var result
+    let result
 
     if (parser.isDeprecatedSignature) {
       result = parser.fn(request[kRequestPayloadStream], done)
@@ -130,9 +131,9 @@ ContentTypeParser.prototype.run = function (contentType, handler, request, reply
 }
 
 function rawBody (request, reply, options, parser, done) {
-  var asString = parser.asString
-  var limit = options.limit === null ? parser.bodyLimit : options.limit
-  var contentLength = request.headers['content-length'] === undefined
+  const asString = parser.asString
+  const limit = options.limit === null ? parser.bodyLimit : options.limit
+  const contentLength = request.headers['content-length'] === undefined
     ? NaN
     : Number.parseInt(request.headers['content-length'], 10)
 
@@ -141,8 +142,8 @@ function rawBody (request, reply, options, parser, done) {
     return
   }
 
-  var receivedLength = 0
-  var body = asString === true ? '' : []
+  let receivedLength = 0
+  let body = asString === true ? '' : []
 
   const payload = request[kRequestPayloadStream] || request.raw
 
@@ -197,7 +198,7 @@ function rawBody (request, reply, options, parser, done) {
       body = Buffer.concat(body)
     }
 
-    var result = parser.fn(request, body, done)
+    const result = parser.fn(request, body, done)
     if (result && typeof result.then === 'function') {
       result.then(body => done(null, body), done)
     }
@@ -211,9 +212,9 @@ function getDefaultJsonParser (onProtoPoisoning, onConstructorPoisoning) {
     if (body === '' || body == null) {
       return done(new FST_ERR_CTP_EMPTY_JSON_BODY(), undefined)
     }
-
+    let json
     try {
-      var json = secureJson.parse(body, { protoAction: onProtoPoisoning, constructorAction: onConstructorPoisoning })
+      json = secureJson.parse(body, { protoAction: onProtoPoisoning, constructorAction: onConstructorPoisoning })
     } catch (err) {
       err.statusCode = 400
       return done(err, undefined)
@@ -279,4 +280,8 @@ module.exports.helpers = {
   addContentTypeParser,
   hasContentTypeParser
 }
+module.exports.defaultParsers = {
+  getDefaultJsonParser,
+  defaultTextParser: defaultPlainTextParser
+}
 module.exports[kTestInternals] = { rawBody }

package/lib/context.js

@@ -17,7 +17,7 @@ function Context (schema, handler, Reply, Request, contentTypeParser, config, er
   this.preHandler = null
   this.onResponse = null
   this.config = config
-  this.errorHandler = errorHandler || defaultErrorHandler
+  this.errorHandler = errorHandler
   this._middie = null
   this._parserOptions = { limit: bodyLimit || null }
   this.logLevel = logLevel
@@ -28,26 +28,12 @@ function Context (schema, handler, Reply, Request, contentTypeParser, config, er
   this.schemaErrorFormatter = schemaErrorFormatter || defaultSchemaErrorFormatter
 }
 
-function defaultErrorHandler (error, request, reply) {
-  if (reply.statusCode >= 500) {
-    reply.log.error(
-      { req: request, res: reply, err: error },
-      error && error.message
-    )
-  } else if (reply.statusCode >= 400) {
-    reply.log.info(
-      { res: reply, err: error },
-      error && error.message
-    )
-  }
-  reply.send(error)
-}
-
 function defaultSchemaErrorFormatter (errors, dataVar) {
-  var text = ''
-  var separator = ', '
+  let text = ''
+  const separator = ', '
+  /* eslint-disable no-var */
   for (var i = 0; i < errors.length; i++) {
-    var e = errors[i]
+    const e = errors[i]
     text += dataVar + (e.dataPath || '') + ' ' + e.message + separator
   }
   return new Error(text.slice(0, -separator.length))

package/lib/decorate.js

@@ -56,7 +56,7 @@ function checkReplyExistence (name) {
 }
 
 function checkDependencies (instance, deps) {
-  for (var i = 0; i < deps.length; i++) {
+  for (let i = 0; i < deps.length; i++) {
     if (!checkExistence(instance, deps[i])) {
       throw new FST_ERR_DEC_MISSING_DEPENDENCY(deps[i])
     }

package/lib/errors.js

@@ -171,8 +171,8 @@ const codes = {
   /**
    * wrapThenable
    */
-  FST_ERR_PROMISE_NOT_FULLFILLED: createError(
-    'FST_ERR_PROMISE_NOT_FULLFILLED',
+  FST_ERR_PROMISE_NOT_FULFILLED: createError(
+    'FST_ERR_PROMISE_NOT_FULFILLED',
     "Promise may not be fulfilled with 'undefined' when statusCode is not 204"
   ),
 

package/lib/fourOhFour.js

@@ -15,7 +15,8 @@ const {
   kBodyLimit,
   kLogLevel,
   kFourOhFourContext,
-  kHooks
+  kHooks,
+  kErrorHandler
 } = require('./symbols.js')
 const { lifecycleHooks } = require('./hooks')
 const fourOhFourContext = {
@@ -28,7 +29,7 @@ const fourOhFourContext = {
 /**
  * Each fastify instance have a:
  * kFourOhFourLevelInstance: point to a fastify instance that has the 404 handler setted
- * kCanSetNotFoundHandler: bool to track if the 404 handler has alredy been set
+ * kCanSetNotFoundHandler: bool to track if the 404 handler has already been set
  * kFourOhFour: the singleton instance of this 404 module
  * kFourOhFourContext: the context in the reply object where the handler will be executed
  */
@@ -124,7 +125,7 @@ function fourOhFour (options) {
       this[kRequest],
       this[kContentTypeParser],
       opts.config || {},
-      this._errorHandler,
+      this[kErrorHandler],
       this[kBodyLimit],
       this[kLogLevel]
     )
@@ -155,13 +156,13 @@ function fourOhFour (options) {
     // we might want to do some hard debugging
     // here, let's print out as much info as
     // we can
-    var id = genReqId(req)
-    var childLogger = logger.child({ reqId: id })
+    const id = genReqId(req)
+    const childLogger = logger.child({ reqId: id })
 
     childLogger.info({ req }, 'incoming request')
 
-    var request = new Request(id, null, req, null, childLogger, fourOhFourContext)
-    var reply = new Reply(res, request, childLogger)
+    const request = new Request(id, null, req, null, childLogger, fourOhFourContext)
+    const reply = new Reply(res, request, childLogger)
 
     request.log.warn('the default handler for 404 did not catch this, this is likely a fastify bug, please report it')
     request.log.warn(router.prettyPrint())

package/lib/handleRequest.js

@@ -11,15 +11,15 @@ function handleRequest (err, request, reply) {
     return
   }
 
-  var method = request.raw.method
-  var headers = request.headers
+  const method = request.raw.method
+  const headers = request.headers
 
   if (method === 'GET' || method === 'HEAD') {
     handler(request, reply)
     return
   }
 
-  var contentType = headers['content-type']
+  const contentType = headers['content-type']
 
   if (method === 'POST' || method === 'PUT' || method === 'PATCH') {
     if (contentType === undefined) {
@@ -84,7 +84,7 @@ function preValidationCallback (err, request, reply) {
     return
   }
 
-  var result = validateSchema(reply.context, request)
+  const result = validateSchema(reply.context, request)
   if (result) {
     if (reply.context.attachValidation === false) {
       reply.code(400).send(result)
@@ -118,7 +118,7 @@ function preHandlerCallback (err, request, reply) {
     return
   }
 
-  var result
+  let result
 
   try {
     result = reply.context.handler(request, reply)

package/lib/hooks.js

@@ -77,8 +77,8 @@ function buildHooks (h) {
 
 function hookRunnerApplication (hookName, boot, server, cb) {
   const hooks = server[kHooks][hookName]
-  var i = 0
-  var c = 0
+  let i = 0
+  let c = 0
 
   next()
 
@@ -151,7 +151,7 @@ function hookRunnerApplication (hookName, boot, server, cb) {
 }
 
 function hookRunner (functions, runner, request, reply, cb) {
-  var i = 0
+  let i = 0
 
   function next (err) {
     if (err || i === functions.length) {
@@ -182,7 +182,7 @@ function hookRunner (functions, runner, request, reply, cb) {
 }
 
 function onSendHookRunner (functions, request, reply, payload, cb) {
-  var i = 0
+  let i = 0
 
   function next (err, newPayload) {
     if (err) {

package/lib/logger.js

@@ -23,9 +23,9 @@ function createPinoLogger (opts, stream) {
     delete opts.file
   }
 
-  var prevLogger = opts.logger
-  var prevGenReqId = opts.genReqId
-  var logger = null
+  const prevLogger = opts.logger
+  const prevGenReqId = opts.genReqId
+  let logger = null
 
   if (prevLogger) {
     opts.logger = undefined
@@ -53,7 +53,7 @@ const serializers = {
       version: req.headers['accept-version'],
       hostname: req.hostname,
       remoteAddress: req.ip,
-      remotePort: req.connection.remotePort
+      remotePort: req.socket.remotePort
     }
   },
   err: pino.stdSerializers.err,
@@ -65,7 +65,7 @@ const serializers = {
 }
 
 function now () {
-  var ts = process.hrtime()
+  const ts = process.hrtime()
   return (ts[0] * 1e3) + (ts[1] / 1e6)
 }
 
@@ -105,9 +105,9 @@ function isValidLogger (logger) {
     return false
   }
 
-  var result = true
+  let result = true
   const methods = ['info', 'error', 'debug', 'fatal', 'warn', 'trace', 'child']
-  for (var i = 0; i < methods.length; i += 1) {
+  for (let i = 0; i < methods.length; i += 1) {
     if (!logger[methods[i]] || typeof logger[methods[i]] !== 'function') {
       result = false
       break

package/lib/pluginUtils.js

@@ -20,7 +20,7 @@ function getPluginName (func) {
   const cache = require.cache
   const keys = Object.keys(cache)
 
-  for (var i = 0; i < keys.length; i++) {
+  for (let i = 0; i < keys.length; i++) {
     if (cache[keys[i]].exports === func) {
       return keys[i]
     }
@@ -107,7 +107,9 @@ function registerPluginName (fn) {
 
 function registerPlugin (fn) {
   registerPluginName.call(this, fn)
-  checkVersion.call(this, fn)
+  if (this.version !== undefined) {
+    checkVersion.call(this, fn)
+  }
   checkDecorators.call(this, fn)
   checkDependencies.call(this, fn)
   return shouldSkipOverride(fn)

package/lib/reply.js

@@ -125,8 +125,8 @@ Reply.prototype.send = function (payload) {
     return this
   }
 
-  var contentType = this.getHeader('content-type')
-  var hasContentType = contentType !== undefined
+  const contentType = this.getHeader('content-type')
+  const hasContentType = contentType !== undefined
 
   if (payload !== null) {
     if (Buffer.isBuffer(payload) || typeof payload.pipe === 'function') {
@@ -184,8 +184,8 @@ Reply.prototype.send = function (payload) {
 
 Reply.prototype.getHeader = function (key) {
   key = key.toLowerCase()
-  var res = this.raw
-  var value = this[kReplyHeaders][key]
+  const res = this.raw
+  let value = this[kReplyHeaders][key]
   if (value === undefined && res.hasHeader(key)) {
     value = res.getHeader(key)
   }
@@ -211,7 +211,7 @@ Reply.prototype.removeHeader = function (key) {
 }
 
 Reply.prototype.header = function (key, value) {
-  var _key = key.toLowerCase()
+  const _key = key.toLowerCase()
 
   // default the value to ''
   value = value === undefined ? '' : value
@@ -233,7 +233,8 @@ Reply.prototype.header = function (key, value) {
 }
 
 Reply.prototype.headers = function (headers) {
-  var keys = Object.keys(headers)
+  const keys = Object.keys(headers)
+  /* eslint-disable no-var */
   for (var i = 0; i < keys.length; i++) {
     this.header(keys[i], headers[keys[i]])
   }
@@ -289,7 +290,7 @@ Reply.prototype.callNotFound = function () {
 }
 
 Reply.prototype.getResponseTime = function () {
-  var responseTime = 0
+  let responseTime = 0
 
   if (this[kReplyStartTime] !== undefined) {
     responseTime = now() - this[kReplyStartTime]
@@ -303,9 +304,9 @@ Reply.prototype.getResponseTime = function () {
 // - https://github.com/fastify/fastify/issues/1864 for the discussions
 // - https://promisesaplus.com/ for the definition of thenable
 // - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/then for the signature
-Reply.prototype.then = function (fullfilled, rejected) {
+Reply.prototype.then = function (fulfilled, rejected) {
   if (this.sent) {
-    fullfilled()
+    fulfilled()
     return
   }
 
@@ -317,7 +318,7 @@ Reply.prototype.then = function (fullfilled, rejected) {
         rejected(err)
       }
     } else {
-      fullfilled()
+      fulfilled()
     }
   })
 }
@@ -377,8 +378,9 @@ function wrapOnSendEnd (err, request, reply, payload) {
 }
 
 function onSendEnd (reply, payload) {
-  var res = reply.raw
-  var statusCode = res.statusCode
+  const res = reply.raw
+  const req = reply.request
+  const statusCode = res.statusCode
 
   if (payload === undefined || payload === null) {
     reply[kReplySent] = true
@@ -386,7 +388,8 @@ function onSendEnd (reply, payload) {
     // according to https://tools.ietf.org/html/rfc7230#section-3.3.2
     // we cannot send a content-length for 304 and 204, and all status code
     // < 200.
-    if (statusCode >= 200 && statusCode !== 204 && statusCode !== 304) {
+    // For HEAD we don't overwrite the `content-length`
+    if (statusCode >= 200 && statusCode !== 204 && statusCode !== 304 && req.method !== 'HEAD') {
       reply[kReplyHeaders]['content-length'] = '0'
     }
 
@@ -428,8 +431,8 @@ function logStreamError (logger, err, res) {
 }
 
 function sendStream (payload, res, reply) {
-  var sourceOpen = true
-  var errorLogged = false
+  let sourceOpen = true
+  let errorLogged = false
 
   eos(payload, { readable: true, writable: false }, function (err) {
     sourceOpen = false
@@ -472,7 +475,7 @@ function sendStream (payload, res, reply) {
   // writeHead, and we need to resort to setHeader, which will trigger
   // a writeHead when there is data to send.
   if (!res.headersSent) {
-    for (var key in reply[kReplyHeaders]) {
+    for (const key in reply[kReplyHeaders]) {
       res.setHeader(key, reply[kReplyHeaders][key])
     }
   } else {
@@ -499,8 +502,8 @@ function onErrorHook (reply, error, cb) {
 
 function handleError (reply, error, cb) {
   reply[kReplyIsRunningOnErrorHook] = false
-  var res = reply.raw
-  var statusCode = res.statusCode
+  const res = reply.raw
+  let statusCode = res.statusCode
   statusCode = (statusCode >= 400) ? statusCode : 500
   // treat undefined and null as same
   if (error != null) {
@@ -516,20 +519,20 @@ function handleError (reply, error, cb) {
 
   res.statusCode = statusCode
 
-  var errorHandler = reply.context.errorHandler
+  const errorHandler = reply.context.errorHandler
   if (errorHandler && reply[kReplyErrorHandlerCalled] === false) {
     reply[kReplySent] = false
     reply[kReplyIsError] = false
     reply[kReplyErrorHandlerCalled] = true
     reply[kReplyHeaders]['content-length'] = undefined
-    var result = errorHandler(error, reply.request, reply)
+    const result = errorHandler(error, reply.request, reply)
     if (result && typeof result.then === 'function') {
       wrapThenable(result, reply)
     }
     return
   }
 
-  var payload = serializeError({
+  const payload = serializeError({
     error: statusCodes[statusCode + ''],
     code: error.code,
     message: error.message || '',
@@ -552,11 +555,11 @@ function handleError (reply, error, cb) {
 function setupResponseListeners (reply) {
   reply[kReplyStartTime] = now()
 
-  var onResFinished = err => {
+  const onResFinished = err => {
     reply.raw.removeListener('finish', onResFinished)
     reply.raw.removeListener('error', onResFinished)
 
-    var ctx = reply.context
+    const ctx = reply.context
 
     if (ctx && ctx.onResponse !== null) {
       hookRunner(
@@ -584,7 +587,7 @@ function onResponseCallback (err, request, reply) {
     return
   }
 
-  var responseTime = reply.getResponseTime()
+  const responseTime = reply.getResponseTime()
 
   if (err != null) {
     reply.log.error({

package/lib/reqIdGenFactory.js

@@ -1,8 +1,8 @@
 'use strict'
 
 module.exports = function () {
-  var maxInt = 2147483647
-  var nextReqId = 0
+  const maxInt = 2147483647
+  let nextReqId = 0
   return function genReqId (req) {
     return (nextReqId = (nextReqId + 1) & maxInt)
   }