fastify 4.0.0-rc.4 → 4.0.0-rc.5

package/build/build-validation.js

@@ -24,7 +24,7 @@ module.exports.defaultInitOptions = ${JSON.stringify(defaultInitOptions)}
 const defaultInitOptions = {
   connectionTimeout: 0, // 0 sec
   keepAliveTimeout: 72000, // 72 seconds
-  forceCloseConnections: false, // keep-alive connections
+  forceCloseConnections: undefined, // keep-alive connections
   maxRequestsPerSocket: 0, // no limit
   requestTimeout: 0, // no limit
   bodyLimit: 1024 * 1024, // 1 MiB
@@ -50,7 +50,17 @@ const schema = {
   properties: {
     connectionTimeout: { type: 'integer', default: defaultInitOptions.connectionTimeout },
     keepAliveTimeout: { type: 'integer', default: defaultInitOptions.keepAliveTimeout },
-    forceCloseConnections: { type: 'boolean', default: defaultInitOptions.forceCloseConnections },
+    forceCloseConnections: {
+      oneOf: [
+        {
+          type: 'string',
+          pattern: 'idle'
+        },
+        {
+          type: 'boolean'
+        }
+      ]
+    },
     maxRequestsPerSocket: { type: 'integer', default: defaultInitOptions.maxRequestsPerSocket, nullable: true },
     requestTimeout: { type: 'integer', default: defaultInitOptions.requestTimeout },
     bodyLimit: { type: 'integer', default: defaultInitOptions.bodyLimit },

package/docs/Guides/Index.md

@@ -10,7 +10,7 @@ This table of contents is in alphabetical order.
 + [Contributing](./Contributing.md): Details how to participate in the
   development of Fastify, and shows how to setup an environment compatible with
   the project's code style.
-+ [`Delay Accepting Requests`](./Delay-Accepting-Requests.md): A practical guide
++ [Delay Accepting Requests](./Delay-Accepting-Requests.md): A practical guide
   on how to delay serving requests to specific routes until some condition is
   met in your application. This guide focuses on solving the problem using
   [`Hooks`](../Reference/Hooks.md), [`Decorators`](../Reference/Decorators.md),

package/docs/Reference/Server.md

@@ -60,6 +60,7 @@ describes the properties available in that options object.
     - [addHook](#addhook)
     - [prefix](#prefix)
     - [pluginName](#pluginname)
+    - [hasPlugin](#hasplugin)
     - [log](#log)
     - [version](#version)
     - [inject](#inject)
@@ -135,15 +136,18 @@ use. Also, when `serverFactory` option is specified, this option is ignored.
 ### `forceCloseConnections`
 <a id="forcecloseconnections"></a>
 
-When set to `true` requests with the header `connection: keep-alive` will be
-tracked by the server. Upon [`close`](#close), the server will iterate the
-current persistent connections and [destroy their
-sockets](https://nodejs.org/dist/latest-v16.x/docs/api/net.html#socketdestroyerror).
-This means the server will shutdown immediately instead of waiting for existing
-persistent connections to timeout first. Important: connections are not
-inspected to determine if requests have been completed.
+When set to `true`, upon [`close`](#close) the server will iterate the
+current persistent connections and [destroy their sockets](https://nodejs.org/dist/latest-v16.x/docs/api/net.html#socketdestroyerror).
 
-+ Default: `false`
+> Important: connections are not inspected to determine if requests have been completed.
+
+Fastify will prefer the HTTP server's [`closeAllConnections`](https://nodejs.org/dist/latest-v18.x/docs/api/http.html#servercloseallconnections) method if supported, otherwise it will use internal connection tracking.
+
+When set to `"idle"`, upon [`close`](#close) the server will iterate the
+current persistent connections which are not sending a request or waiting for a response and destroy their sockets.
+The value is supported only if the HTTP server supports the [`closeIdleConnections`](https://nodejs.org/dist/latest-v18.x/docs/api/http.html#servercloseidleconnections) method, otherwise attempting to set it will throw an exception.
+
++ Default: `"idle"` if the HTTP server allows it, `false` otherwise
 
 ### `maxRequestsPerSocket`
 <a id="factory-max-requests-per-socket"></a>
@@ -1105,6 +1109,26 @@ no new scope is created and therefore we have no place to attach contextual
 data. In that case, the plugin name will represent the boot order of all
 involved plugins in the format of `fastify -> plugin-A -> plugin-B`.
 
+#### hasPlugin
+<a id="hasPlugin"></a>
+
+Method to check if a specific plugin has been registered.
+Relies on the plugin metadata name.
+Returns `true` if the plugin is registered.
+Otherwise, returns `false`.
+
+```js
+const fastify = require('fastify')()
+fastify.register(require('@fastify/cookie'), {
+  secret: 'my-secret',
+  parseOptions: {}
+})
+
+fastify.ready(() => {
+  fastify.hasPlugin('@fastify/cookie') // true
+})
+```
+
 #### log
 <a id="log"></a>
 

package/docs/Reference/TypeScript.md

@@ -56,7 +56,7 @@ in a blank http Fastify server.
   npx tsc --init
   ```
   or use one of the [recommended
-  ones](https://github.com/tsconfig/bases#node-10-tsconfigjson).
+  ones](https://github.com/tsconfig/bases#node-14-tsconfigjson).
 
 *Note: Set `target` property in `tsconfig.json` to `es2017` or greater to avoid
 [FastifyDeprecation](https://github.com/fastify/fastify/issues/3284) warning.*

package/fastify.d.ts

@@ -110,7 +110,7 @@ export type FastifyServerOptions<
   connectionTimeout?: number,
   keepAliveTimeout?: number,
   maxRequestsPerSocket?: number,
-  forceCloseConnections?: boolean,
+  forceCloseConnections?: boolean | 'idle',
   requestTimeout?: number,
   pluginTimeout?: number,
   bodyLimit?: number,

package/fastify.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const VERSION = '4.0.0-rc.4'
+const VERSION = '4.0.0-rc.5'
 
 const Avvio = require('avvio')
 const http = require('http')
@@ -52,6 +52,7 @@ const { defaultInitOptions } = getSecuredInitialConfig
 
 const {
   FST_ERR_BAD_URL,
+  FST_ERR_FORCE_CLOSE_CONNECTIONS_IDLE_NOT_AVAILABLE,
   AVVIO_ERRORS_MAP,
   appendStackTrace
 } = require('./lib/errors')
@@ -123,7 +124,6 @@ function fastify (options) {
   // Update the options with the fixed values
   options.connectionTimeout = options.connectionTimeout || defaultInitOptions.connectionTimeout
   options.keepAliveTimeout = options.keepAliveTimeout || defaultInitOptions.keepAliveTimeout
-  options.forceCloseConnections = typeof options.forceCloseConnections === 'boolean' ? options.forceCloseConnections : defaultInitOptions.forceCloseConnections
   options.maxRequestsPerSocket = options.maxRequestsPerSocket || defaultInitOptions.maxRequestsPerSocket
   options.requestTimeout = options.requestTimeout || defaultInitOptions.requestTimeout
   options.logger = logger
@@ -135,7 +135,6 @@ function fastify (options) {
   options.clientErrorHandler = options.clientErrorHandler || defaultClientErrorHandler
 
   const initialConfig = getSecuredInitialConfig(options)
-  const keepAliveConnections = options.forceCloseConnections === true ? new Set() : noopSet()
 
   // exposeHeadRoutes have its default set from the validator
   options.exposeHeadRoutes = initialConfig.exposeHeadRoutes
@@ -172,8 +171,7 @@ function fastify (options) {
       allowUnsafeRegex: options.allowUnsafeRegex || defaultInitOptions.allowUnsafeRegex,
       buildPrettyMeta: defaultBuildPrettyMeta,
       querystringParser: options.querystringParser
-    },
-    keepAliveConnections
+    }
   })
 
   // 404 router, used for handling encapsulated 404 handlers
@@ -186,6 +184,19 @@ function fastify (options) {
   options.http2SessionTimeout = initialConfig.http2SessionTimeout
   const { server, listen } = createServer(options, httpHandler)
 
+  const serverHasCloseAllConnections = typeof server.closeAllConnections === 'function'
+  const serverHasCloseIdleConnections = typeof server.closeIdleConnections === 'function'
+
+  let forceCloseConnections = options.forceCloseConnections
+  if (forceCloseConnections === 'idle' && !serverHasCloseIdleConnections) {
+    throw new FST_ERR_FORCE_CLOSE_CONNECTIONS_IDLE_NOT_AVAILABLE()
+  } else if (typeof forceCloseConnections !== 'boolean') {
+    /* istanbul ignore next: only one branch can be valid in a given Node.js version */
+    forceCloseConnections = serverHasCloseIdleConnections ? 'idle' : false
+  }
+
+  const keepAliveConnections = !serverHasCloseAllConnections && forceCloseConnections === true ? new Set() : noopSet()
+
   const setupResponseListeners = Reply.setupResponseListeners
   const schemaController = SchemaController.buildSchemaController(null, options.schemaController)
 
@@ -285,6 +296,9 @@ function fastify (options) {
     onClose: null,
     close: null,
     printPlugins: null,
+    hasPlugin: function (name) {
+      return this[kPluginNameChain].includes(name)
+    },
     // http server
     listen,
     server,
@@ -386,13 +400,21 @@ function fastify (options) {
         // No new TCP connections are accepted
         instance.server.close(done)
 
-        for (const conn of fastify[kKeepAliveConnections]) {
-          // We must invoke the destroy method instead of merely unreffing
-          // the sockets. If we only unref, then the callback passed to
-          // `fastify.close` will never be invoked; nor will any of the
-          // registered `onClose` hooks.
-          conn.destroy()
-          fastify[kKeepAliveConnections].delete(conn)
+        /* istanbul ignore next: Cannot test this without Node.js core support */
+        if (forceCloseConnections === 'idle') {
+          instance.server.closeIdleConnections()
+        /* istanbul ignore next: Cannot test this without Node.js core support */
+        } else if (serverHasCloseAllConnections && forceCloseConnections) {
+          instance.server.closeAllConnections()
+        } else {
+          for (const conn of fastify[kKeepAliveConnections]) {
+            // We must invoke the destroy method instead of merely unreffing
+            // the sockets. If we only unref, then the callback passed to
+            // `fastify.close` will never be invoked; nor will any of the
+            // registered `onClose` hooks.
+            conn.destroy()
+            fastify[kKeepAliveConnections].delete(conn)
+          }
         }
       } else {
         done(null)
@@ -411,7 +433,8 @@ function fastify (options) {
     hasLogger,
     setupResponseListeners,
     throwIfAlreadyStarted,
-    validateHTTPVersion: compileValidateHTTPVersion(options)
+    validateHTTPVersion: compileValidateHTTPVersion(options),
+    keepAliveConnections
   })
 
   // Delay configuring clientError handler so that it can access fastify state.