fastify 3.17.0 → 3.18.0

package/GOVERNANCE.md

@@ -80,7 +80,7 @@ The consensus to grant a new candidate Collaborator status is reached when:
 - at least one of the Lead Maintainers approve
 - at least two of the Team Members approve
 
-After these conditions are satisfied, the [onboarding process](#onboarding-collaborators) may start.
+After these conditions are satisfied, the [onboarding process](CONTRIBUTING.md#onboarding-collaborators) may start.
 
 
 ## Lead Maintainers nominations

package/docs/Ecosystem.md

@@ -63,6 +63,7 @@ Plugins maintained by the Fastify team are listed under [Core](#core) while plug
 - [`@mgcrea/fastify-session-sodium-crypto`](https://github.com/mgcrea/fastify-session-sodium-crypto) Fast sodium-based crypto for @mgcrea/fastify-session
 - [`@mgcrea/fastify-session`](https://github.com/mgcrea/fastify-session) Session plugin for Fastify that supports both stateless and stateful sessions
 - [`@mgcrea/pino-pretty-compact`](https://github.com/mgcrea/pino-pretty-compact) A custom compact pino-base prettifier
+- [`@trubavuong/fastify-seaweedfs`](https://github.com/trubavuong/fastify-seaweedfs) SeaweedFS for Fastify
 - [`apollo-server-fastify`](https://github.com/apollographql/apollo-server/tree/master/packages/apollo-server-fastify) Run an [Apollo Server](https://github.com/apollographql/apollo-server) to serve GraphQL with Fastify.
 - [`arecibo`](https://github.com/nucleode/arecibo) Fastify ping responder for Kubernetes Liveness and Readiness Probes.
 - [`cls-rtracer`](https://github.com/puzpuzpuz/cls-rtracer) Fastify middleware for CLS-based request ID generation. An out-of-the-box solution for adding request IDs into your logs.

package/docs/Server.md

@@ -288,7 +288,7 @@ const fastify = Fastify({ trustProxy: true })
     }
     ```
 
-For more examples, refer to the [`@fastify/proxy-addr`](https://www.npmjs.com/package/@fastify/proxy-addr) package.
+For more examples, refer to the [`proxy-addr`](https://www.npmjs.com/package/proxy-addr) package.
 
 You may access the `ip`, `ips`, `hostname` and `protocol` values on the [`request`](Request.md) object.
 
@@ -967,6 +967,8 @@ fastify.register(function (instance, options, done) {
 }, { prefix: '/v1' })
 ```
 
+Fastify calls setNotFoundHandler to add a default 404 handler at startup before plugins are registered. If you would like to augment the behavior of the default 404 handler, for example with plugins, you can call setNotFoundHandler with no arguments `fastify.setNotFoundHandler()` within the context of these registered plugins.
+
 <a name="set-error-handler"></a>
 #### setErrorHandler
 
@@ -1026,6 +1028,31 @@ fastify.ready(() => {
 })
 ```
 
+`fastify.printRoutes({ includeMeta: (true | []) })` will display properties from the `route.store` object for each displayed route. This can be an `array` of keys (e.g. `['onRequest', Symbol('key')]`), or `true` to display all properties. A shorthand option, `fastify.printRoutes({ includeHooks: true })` will include all [hooks](https://www.fastify.io/docs/latest/Hooks/).
+
+```js
+  console.log(fastify.printRoutes({ includeHooks: true, includeMeta: ['metaProperty'] }))
+  // └── /
+  //     ├── test (GET)
+  //     │   • (onRequest) ["anonymous()","namedFunction()"]
+  //     │   • (metaProperty) "value"
+  //     │   └── /hello (GET)
+  //     └── hel
+  //         ├── lo/world (GET)
+  //         │   • (onTimeout) ["anonymous()"]
+  //         └── licopter (GET)
+
+  console.log(fastify.printRoutes({ includeHooks: true }))
+  // └── /
+  //     ├── test (GET)
+  //     │   • (onRequest) ["anonymous()","namedFunction()"]  
+  //     │   └── /hello (GET)
+  //     └── hel
+  //         ├── lo/world (GET)
+  //         │   • (onTimeout) ["anonymous()"]
+  //         └── licopter (GET)
+```
+
 <a name="print-plugins"></a>
 #### printPlugins
 
@@ -1042,9 +1069,9 @@ fastify.ready(() => {
   console.error(fastify.printPlugins())
   // will output the following to stderr:
   // └── root
-  //   ├── foo
-  //   │   └── bar
-  //   └── baz
+  //     ├── foo
+  //     │   └── bar
+  //     └── baz
 })
 ```
 

package/docs/TypeScript.md

@@ -265,6 +265,11 @@ In the last example we used interfaces to define the types for the request query
        const { username, password } = request.query
        done(username !== 'admin' ? new Error('Must be admin') : undefined)
      }
+     //  or if using async
+     //  preValidation: async (request, reply) => {
+     //    const { username, password } = request.query
+     //    return username !== "admin" ? new Error("Must be admin") : undefined;
+     //  }
    }, async (request, reply) => {
      const customerHeader = request.headers['h-Custom']
      // do something with request data
@@ -281,13 +286,15 @@ In the last example we used interfaces to define the types for the request query
        querystring: QuerystringSchema,
        headers: HeadersSchema
      },
-     preHandler: (request, reply) => {
+     preHandler: (request, reply, done) => {
        const { username, password } = request.query
        const customerHeader = request.headers['h-Custom']
+       done()
      },
      handler: (request, reply) => {
        const { username, password } = request.query
        const customerHeader = request.headers['h-Custom']
+       reply.status(200).send({username});
      }
    })
 
@@ -331,6 +338,7 @@ const todo = {
 With the provided type `FromSchema` you can build a type from your schema and use it in your handler.
 
 ```typescript
+import { FromSchema } from "json-schema-to-ts";
 fastify.post<{ Body: FromSchema<typeof todo> }>(
   '/todo',
   {

package/fastify.d.ts

@@ -1,7 +1,6 @@
 import * as http from 'http'
 import * as http2 from 'http2'
 import * as https from 'https'
-import * as LightMyRequest from 'light-my-request'
 import { ConstraintStrategy, HTTPVersion } from 'find-my-way'
 
 import { FastifyRequest, RequestGenericInterface } from './types/request'
@@ -159,6 +158,7 @@ export interface ValidationResult {
 }
 
 /* Export all additional types */
+export type { Chain as LightMyRequestChain, InjectOptions, Response as LightMyRequestResponse, CallbackFunc as LightMyRequestCallback } from 'light-my-request'
 export { FastifyRequest, RequestGenericInterface } from './types/request'
 export { FastifyReply } from './types/reply'
 export { FastifyPluginCallback, FastifyPluginAsync, FastifyPluginOptions, FastifyPlugin } from './types/plugin'

package/fastify.js

@@ -4,9 +4,8 @@ const Avvio = require('avvio')
 const http = require('http')
 const querystring = require('querystring')
 let lightMyRequest
-let version
-let versionLoaded = false
 
+const { version } = require('./package.json')
 const {
   kAvvioBoot,
   kChildren,
@@ -35,7 +34,7 @@ const supportedMethods = ['DELETE', 'GET', 'HEAD', 'PATCH', 'POST', 'PUT', 'OPTI
 const decorator = require('./lib/decorate')
 const ContentTypeParser = require('./lib/contentTypeParser')
 const SchemaController = require('./lib/schema-controller')
-const { Hooks, hookRunnerApplication } = require('./lib/hooks')
+const { Hooks, hookRunnerApplication, supportedHooks } = require('./lib/hooks')
 const { createLogger } = require('./lib/logger')
 const pluginUtils = require('./lib/pluginUtils')
 const reqIdGenFactory = require('./lib/reqIdGenFactory')
@@ -58,6 +57,19 @@ const onBadUrlContext = {
   onError: []
 }
 
+function defaultBuildPrettyMeta (route) {
+  // return a shallow copy of route's sanitized context
+
+  const cleanKeys = {}
+  const allowedProps = ['errorHandler', 'logLevel', 'logSerializers']
+
+  allowedProps.concat(supportedHooks).forEach(k => {
+    cleanKeys[k] = route.store[k]
+  })
+
+  return Object.assign({}, cleanKeys)
+}
+
 function defaultErrorHandler (error, request, reply) {
   if (reply.statusCode < 500) {
     reply.log.info(
@@ -158,7 +170,8 @@ function fastify (options) {
       constraints: constraints,
       ignoreTrailingSlash: options.ignoreTrailingSlash || defaultInitOptions.ignoreTrailingSlash,
       maxParamLength: options.maxParamLength || defaultInitOptions.maxParamLength,
-      caseSensitive: options.caseSensitive
+      caseSensitive: options.caseSensitive,
+      buildPrettyMeta: defaultBuildPrettyMeta
     }
   })
 
@@ -278,7 +291,7 @@ function fastify (options) {
     // fake http injection
     inject: inject,
     // pretty print of the registered routes
-    printRoutes: router.printRoutes,
+    printRoutes,
     // custom error handling
     setNotFoundHandler: setNotFoundHandler,
     setErrorHandler: setErrorHandler,
@@ -309,9 +322,6 @@ function fastify (options) {
     },
     version: {
       get () {
-        if (versionLoaded === false) {
-          version = loadVersion()
-        }
         return version
       }
     },
@@ -626,6 +636,12 @@ function fastify (options) {
     this[kErrorHandler] = func.bind(this)
     return this
   }
+
+  function printRoutes (opts = {}) {
+    // includeHooks:true - shortcut to include all supported hooks exported by fastify.Hooks
+    opts.includeMeta = opts.includeHooks ? opts.includeMeta ? supportedHooks.concat(opts.includeMeta) : supportedHooks : opts.includeMeta
+    return router.printRoutes(opts)
+  }
 }
 
 function validateSchemaErrorFormatter (schemaErrorFormatter) {
@@ -655,20 +671,6 @@ function wrapRouting (httpHandler, { rewriteUrl, logger }) {
   }
 }
 
-function loadVersion () {
-  versionLoaded = true
-  const fs = require('fs')
-  const path = require('path')
-  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
-  }
-}
-
 /**
  * These export configurations enable JS and TS developers
  * to consumer fastify in whatever way best suits their needs.

package/lib/hooks.js

@@ -244,5 +244,6 @@ module.exports = {
   onSendHookRunner,
   hookIterator,
   hookRunnerApplication,
-  lifecycleHooks
+  lifecycleHooks,
+  supportedHooks
 }

package/lib/pluginUtils.js

@@ -109,9 +109,7 @@ function registerPluginName (fn) {
 
 function registerPlugin (fn) {
   registerPluginName.call(this, fn)
-  if (this.version !== undefined) {
-    checkVersion.call(this, fn)
-  }
+  checkVersion.call(this, fn)
   checkDecorators.call(this, fn)
   checkDependencies.call(this, fn)
   return shouldSkipOverride(fn)

package/lib/request.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const proxyAddr = require('@fastify/proxy-addr')
+const proxyAddr = require('proxy-addr')
 const semver = require('semver')
 const warning = require('./warnings')
 

package/lib/route.js

@@ -227,7 +227,7 @@ function buildRouting (options) {
       }
       const constraints = opts.constraints || {}
       if (opts.version) {
-        warning.emit('FSTDEP006')
+        warning.emit('FSTDEP008')
         constraints.version = opts.version
       }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fastify",
-  "version": "3.17.0",
+  "version": "3.18.0",
   "description": "Fast and low overhead web framework, for Node.js",
   "main": "fastify.js",
   "type": "commonjs",
@@ -177,7 +177,6 @@
   },
   "dependencies": {
     "@fastify/ajv-compiler": "^1.0.0",
-    "@fastify/proxy-addr": "^3.0.0",
     "abstract-logging": "^2.0.0",
     "avvio": "^7.1.2",
     "fast-json-stringify": "^2.5.2",
@@ -187,6 +186,7 @@
     "flatstr": "^1.0.12",
     "light-my-request": "^4.2.0",
     "pino": "^6.2.1",
+    "proxy-addr": "^2.0.7",
     "readable-stream": "^3.4.0",
     "rfdc": "^1.1.4",
     "secure-json-parse": "^2.0.0",

package/test/pretty-print.test.js

@@ -121,3 +121,92 @@ test('pretty print - nested plugins', t => {
     t.match(tree, 'baz')
   })
 })
+
+test('pretty print - commonPrefix', t => {
+  t.plan(4)
+
+  const fastify = Fastify()
+  fastify.get('/hello', () => {})
+  fastify.put('/hello', () => {})
+  fastify.get('/helicopter', () => {})
+
+  fastify.ready(() => {
+    const radixTree = fastify.printRoutes()
+    const flatTree = fastify.printRoutes({ commonPrefix: false })
+
+    const radixExpected = `└── /
+    ├── hel
+    │   ├── lo (GET)
+    │   └── icopter (GET)
+    └── hello (PUT)
+`
+    const flatExpected = `└── / (-)
+    ├── helicopter (GET)
+    └── hello (GET, PUT)
+`
+    t.equal(typeof radixTree, 'string')
+    t.equal(typeof flatTree, 'string')
+    t.equal(radixTree, radixExpected)
+    t.equal(flatTree, flatExpected)
+  })
+})
+
+test('pretty print - includeMeta, includeHooks', t => {
+  t.plan(6)
+
+  const fastify = Fastify()
+  const onTimeout = () => {}
+  fastify.get('/hello', () => {})
+  fastify.put('/hello', () => {})
+  fastify.get('/helicopter', () => {})
+
+  fastify.addHook('onRequest', () => {})
+  fastify.addHook('onTimeout', onTimeout)
+
+  fastify.ready(() => {
+    const radixTree = fastify.printRoutes({ includeHooks: true, includeMeta: ['errorHandler'] })
+    const flatTree = fastify.printRoutes({ commonPrefix: false, includeHooks: true, includeMeta: ['errorHandler'] })
+    const hooksOnly = fastify.printRoutes({ commonPrefix: false, includeHooks: true })
+
+    const radixExpected = `└── /
+    ├── hel
+    │   ├── lo (GET)
+    │   │   • (onTimeout) ["onTimeout()"]
+    │   │   • (onRequest) ["anonymous()"]
+    │   │   • (errorHandler) "defaultErrorHandler()"
+    │   └── icopter (GET)
+    │       • (onTimeout) ["onTimeout()"]
+    │       • (onRequest) ["anonymous()"]
+    │       • (errorHandler) "defaultErrorHandler()"
+    └── hello (PUT)
+        • (onTimeout) ["onTimeout()"]
+        • (onRequest) ["anonymous()"]
+        • (errorHandler) "defaultErrorHandler()"
+`
+    const flatExpected = `└── / (-)
+    ├── helicopter (GET)
+    │   • (onTimeout) ["onTimeout()"]
+    │   • (onRequest) ["anonymous()"]
+    │   • (errorHandler) "defaultErrorHandler()"
+    └── hello (GET, PUT)
+        • (onTimeout) ["onTimeout()"]
+        • (onRequest) ["anonymous()"]
+        • (errorHandler) "defaultErrorHandler()"
+`
+
+    const hooksOnlyExpected = `└── / (-)
+    ├── helicopter (GET)
+    │   • (onTimeout) ["onTimeout()"]
+    │   • (onRequest) ["anonymous()"]
+    └── hello (GET, PUT)
+        • (onTimeout) ["onTimeout()"]
+        • (onRequest) ["anonymous()"]
+`
+    t.equal(typeof radixTree, 'string')
+    t.equal(typeof flatTree, 'string')
+    t.equal(typeof hooksOnlyExpected, 'string')
+    t.equal(radixTree, radixExpected)
+    t.equal(flatTree, flatExpected)
+    t.equal(hooksOnly, hooksOnlyExpected)
+  })
+})

package/test/types/fastify.test-d.ts

@@ -3,12 +3,15 @@ import fastify, {
   FastifyInstance,
   FastifyPlugin,
   FastifyPluginAsync,
-  FastifyPluginCallback
+  FastifyPluginCallback,
+  LightMyRequestChain,
+  LightMyRequestResponse,
+  LightMyRequestCallback,
+  InjectOptions
 } from '../../fastify'
 import * as http from 'http'
 import * as https from 'https'
 import * as http2 from 'http2'
-import { Chain as LightMyRequestChain } from 'light-my-request'
 import { expectType, expectError, expectAssignable } from 'tsd'
 import { FastifyLoggerInstance } from '../../types/logger'
 import { Socket } from 'net'
@@ -27,6 +30,14 @@ expectType<LightMyRequestChain>(fastify({ http2: true, https: {} }).inject())
 expectError(fastify<http2.Http2Server>({ http2: false })) // http2 option must be true
 expectError(fastify<http2.Http2SecureServer>({ http2: false })) // http2 option must be true
 
+// light-my-request
+expectAssignable<InjectOptions>({ query: '' })
+fastify({ http2: true, https: {} }).inject().then((resp) => {
+  expectAssignable<LightMyRequestResponse>(resp)
+})
+const lightMyRequestCallback: LightMyRequestCallback = (err: Error, response: LightMyRequestResponse) => {}
+fastify({ http2: true, https: {} }).inject({}, lightMyRequestCallback)
+
 // server options
 expectAssignable<FastifyInstance<http2.Http2Server, http2.Http2ServerRequest, http2.Http2ServerResponse>>(fastify({ http2: true }))
 expectAssignable<FastifyInstance>(fastify({ ignoreTrailingSlash: true }))

package/test/versioned-routes.test.js

@@ -632,7 +632,7 @@ test('Should trigger a warning when a versioned route is registered via version
   t.plan(4)
 
   function onWarning (code) {
-    t.equal(code, 'FSTDEP006')
+    t.equal(code, 'FSTDEP008')
   }
   const warning = {
     emit: onWarning

package/test/internals/version.test.js

@@ -1,43 +0,0 @@
-'use strict'
-
-const t = require('tap')
-const test = t.test
-const proxyquire = require('proxyquire')
-
-test('should output an undefined version in case of package.json not available', t => {
-  const Fastify = proxyquire('../..', { fs: { accessSync: () => { throw Error('error') } } })
-  t.plan(1)
-  const srv = Fastify()
-  t.equal(srv.version, undefined)
-})
-
-test('should output an undefined version in case of package.json is not the fastify one', t => {
-  const Fastify = proxyquire('../..', { fs: { accessSync: () => { }, readFileSync: () => JSON.stringify({ name: 'foo', version: '6.6.6' }) } })
-  t.plan(1)
-  const srv = Fastify()
-  t.equal(srv.version, undefined)
-})
-
-test('should skip the version check if the version is undefined', t => {
-  const Fastify = proxyquire('../..', { fs: { accessSync: () => { }, readFileSync: () => JSON.stringify({ name: 'foo', version: '6.6.6' }) } })
-  t.plan(3)
-  const srv = Fastify()
-  t.equal(srv.version, undefined)
-
-  plugin[Symbol.for('skip-override')] = false
-  plugin[Symbol.for('plugin-meta')] = {
-    name: 'plugin',
-    fastify: '>=99.0.0'
-  }
-
-  srv.register(plugin)
-
-  srv.ready((err) => {
-    t.error(err)
-    t.pass('everything right')
-  })
-
-  function plugin (instance, opts, done) {
-    done()
-  }
-})