fastify 3.7.0 → 3.8.0

package/test/nullable-validation.test.js

@@ -2,6 +2,7 @@
 
 const t = require('tap')
 const test = t.test
+const sget = require('simple-get').concat
 const Fastify = require('..')
 
 test('nullable string', t => {
@@ -50,3 +51,110 @@ test('nullable string', t => {
     t.same(res.payload.hello, null)
   })
 })
+
+test('object or null body', t => {
+  t.plan(5)
+
+  const fastify = Fastify()
+
+  fastify.route({
+    method: 'POST',
+    url: '/',
+    handler: (req, reply) => {
+      t.strictEqual(req.body, null)
+      reply.code(200).send({ requestBody: req.body })
+    },
+    schema: {
+      body: {
+        type: ['object', 'null'],
+        properties: {
+          hello: {
+            type: 'string',
+            format: 'email'
+          }
+        }
+      },
+      response: {
+        200: {
+          type: 'object',
+          nullable: true,
+          properties: {
+            requestBody: {
+              type: 'string',
+              format: 'email',
+              nullable: true
+            }
+          }
+        }
+      }
+    }
+  })
+
+  fastify.listen(0, (err) => {
+    fastify.server.unref()
+    t.error(err)
+
+    sget({
+      method: 'POST',
+      url: 'http://localhost:' + fastify.server.address().port
+    }, (err, response, body) => {
+      t.error(err)
+      t.strictEqual(response.statusCode, 200)
+      t.deepEqual(JSON.parse(body), { requestBody: null })
+    })
+  })
+})
+
+test('nullable body', t => {
+  t.plan(5)
+
+  const fastify = Fastify()
+
+  fastify.route({
+    method: 'POST',
+    url: '/',
+    handler: (req, reply) => {
+      t.strictEqual(req.body, null)
+      reply.code(200).send({ requestBody: req.body })
+    },
+    schema: {
+      body: {
+        type: 'object',
+        nullable: true,
+        properties: {
+          hello: {
+            type: 'string',
+            format: 'email'
+          }
+        }
+      },
+      response: {
+        200: {
+          type: 'object',
+          nullable: true,
+          properties: {
+            requestBody: {
+              type: 'string',
+              format: 'email',
+              nullable: true
+            }
+          }
+        }
+      }
+    }
+  })
+
+  fastify.listen(0, (err) => {
+    fastify.server.unref()
+    t.error(err)
+
+    sget({
+      method: 'POST',
+      url: 'http://localhost:' + fastify.server.address().port
+    }, (err, response, body) => {
+      t.error(err)
+      t.strictEqual(response.statusCode, 200)
+      t.deepEqual(JSON.parse(body), { requestBody: null })
+    })
+  })
+})

package/test/pretty-print.test.js

@@ -39,10 +39,8 @@ test('pretty print - parametric routes', t => {
 
     const expected = `└── /
     ├── test (GET)
-    │   └── /
-    │       └── :hello (GET)
-    └── hello/
-        └── :world (GET)
+    │   └── /:hello (GET)
+    └── hello/:world (GET)
 `
 
     t.is(typeof tree, 'string')
@@ -62,12 +60,11 @@ test('pretty print - mixed parametric routes', t => {
   fastify.ready(() => {
     const tree = fastify.printRoutes()
 
-    const expected = `└── /
-    └── test (GET)
-        └── /
-            └── :hello (GET)
-                :hello (POST)
-                └── /world (GET)
+    const expected = `└── /test (GET)
+    └── /
+        └── :hello (GET)
+            :hello (POST)
+            └── /world (GET)
 `
 
     t.is(typeof tree, 'string')
@@ -88,10 +85,8 @@ test('pretty print - wildcard routes', t => {
 
     const expected = `└── /
     ├── test (GET)
-    │   └── /
-    │       └── * (GET)
-    └── hello/
-        └── * (GET)
+    │   └── /* (GET)
+    └── hello/* (GET)
 `
 
     t.is(typeof tree, 'string')

package/test/reply-error.test.js

@@ -111,7 +111,7 @@ test('Should reply 400 on client error', t => {
     const client = net.connect(fastify.server.address().port)
     client.end('oooops!')
 
-    var chunks = ''
+    let chunks = ''
     client.on('data', chunk => {
       chunks += chunk
     })
@@ -160,7 +160,7 @@ test('Should set the response from client error handler', t => {
     const client = net.connect(fastify.server.address().port)
     client.end('oooops!')
 
-    var chunks = ''
+    let chunks = ''
     client.on('data', chunk => {
       chunks += chunk
     })

package/test/route-hooks.test.js

@@ -34,7 +34,7 @@ function testExecutionHook (hook) {
       payload: { hello: 'world' }
     }, (err, res) => {
       t.error(err)
-      var payload = JSON.parse(res.payload)
+      const payload = JSON.parse(res.payload)
       t.deepEqual(payload, { hello: 'world' })
     })
   })
@@ -169,7 +169,7 @@ function testBeforeHandlerHook (hook) {
       payload: { hello: 'world' }
     }, (err, res) => {
       t.error(err)
-      var payload = JSON.parse(res.payload)
+      const payload = JSON.parse(res.payload)
       t.deepEqual(payload, { hello: 'earth' })
     })
 
@@ -179,7 +179,7 @@ function testBeforeHandlerHook (hook) {
       payload: { hello: 'world' }
     }, (err, res) => {
       t.error(err)
-      var payload = JSON.parse(res.payload)
+      const payload = JSON.parse(res.payload)
       t.deepEqual(payload, { hello: 'world' })
     })
   })
@@ -202,7 +202,7 @@ function testBeforeHandlerHook (hook) {
       payload: { hello: 'world' }
     }, (err, res) => {
       t.error(err)
-      var payload = JSON.parse(res.payload)
+      const payload = JSON.parse(res.payload)
       t.equal(res.statusCode, 500)
       t.deepEqual(payload, {
         message: 'kaboom',
@@ -284,7 +284,7 @@ function testBeforeHandlerHook (hook) {
       payload: { hello: 'world' }
     }, (err, res) => {
       t.error(err)
-      var payload = JSON.parse(res.payload)
+      const payload = JSON.parse(res.payload)
       t.equal(res.statusCode, 401)
       t.deepEqual(payload, {
         message: 'go away',
@@ -316,7 +316,7 @@ function testBeforeHandlerHook (hook) {
       payload: { hello: 'world' }
     }, (err, res) => {
       t.error(err)
-      var payload = JSON.parse(res.payload)
+      const payload = JSON.parse(res.payload)
       t.deepEqual(payload, { foo: 43 })
     })
   })
@@ -343,7 +343,7 @@ function testBeforeHandlerHook (hook) {
       payload: { hello: 'world' }
     }, (err, res) => {
       t.error(err)
-      var payload = JSON.parse(res.payload)
+      const payload = JSON.parse(res.payload)
       t.deepEqual(payload, { foo: 43 })
     })
   })
@@ -385,7 +385,7 @@ test('preValidation option should be called before preHandler hook', t => {
     payload: { hello: 'world' }
   }, (err, res) => {
     t.error(err)
-    var payload = JSON.parse(res.payload)
+    const payload = JSON.parse(res.payload)
     t.deepEqual(payload, { hello: 'world' })
   })
 })
@@ -436,7 +436,7 @@ test('preParsing option should be called before preValidation hook', t => {
     payload: { hello: 'world' }
   }, (err, res) => {
     t.error(err)
-    var payload = JSON.parse(res.payload)
+    const payload = JSON.parse(res.payload)
     t.deepEqual(payload, { hello: 'world' })
   })
 })
@@ -492,7 +492,7 @@ test('onRequest option should be called before preParsing', t => {
     payload: { hello: 'world' }
   }, (err, res) => {
     t.error(err)
-    var payload = JSON.parse(res.payload)
+    const payload = JSON.parse(res.payload)
     t.deepEqual(payload, { hello: 'world' })
   })
 })

package/test/stream.test.js

@@ -168,8 +168,8 @@ test('Destroying streams prematurely', t => {
   fastify.get('/', function (request, reply) {
     t.pass('Received request')
 
-    var sent = false
-    var reallyLongStream = new stream.Readable({
+    let sent = false
+    const reallyLongStream = new stream.Readable({
       read: function () {
         if (!sent) {
           this.push(Buffer.from('hello\n'))
@@ -185,7 +185,7 @@ test('Destroying streams prematurely', t => {
     t.error(err)
     fastify.server.unref()
 
-    var port = fastify.server.address().port
+    const port = fastify.server.address().port
 
     http.get(`http://localhost:${port}`, function (response) {
       t.strictEqual(response.statusCode, 200)
@@ -230,8 +230,8 @@ test('Destroying streams prematurely should call close method', t => {
   fastify.get('/', function (request, reply) {
     t.pass('Received request')
 
-    var sent = false
-    var reallyLongStream = new stream.Readable({
+    let sent = false
+    const reallyLongStream = new stream.Readable({
       read: function () {
         if (!sent) {
           this.push(Buffer.from('hello\n'))
@@ -248,7 +248,7 @@ test('Destroying streams prematurely should call close method', t => {
     t.error(err)
     fastify.server.unref()
 
-    var port = fastify.server.address().port
+    const port = fastify.server.address().port
 
     http.get(`http://localhost:${port}`, function (response) {
       t.strictEqual(response.statusCode, 200)
@@ -292,8 +292,8 @@ test('Destroying streams prematurely should call abort method', t => {
   fastify.get('/', function (request, reply) {
     t.pass('Received request')
 
-    var sent = false
-    var reallyLongStream = new stream.Readable({
+    let sent = false
+    const reallyLongStream = new stream.Readable({
       read: function () {
         if (!sent) {
           this.push(Buffer.from('hello\n'))
@@ -311,7 +311,7 @@ test('Destroying streams prematurely should call abort method', t => {
     t.error(err)
     fastify.server.unref()
 
-    var port = fastify.server.address().port
+    const port = fastify.server.address().port
 
     http.get(`http://localhost:${port}`, function (response) {
       t.strictEqual(response.statusCode, 200)
@@ -358,7 +358,7 @@ test('return a 404 if the stream emits a 404 error', t => {
   fastify.get('/', function (request, reply) {
     t.pass('Received request')
 
-    var reallyLongStream = new Readable({
+    const reallyLongStream = new Readable({
       read: function () {
         setImmediate(() => {
           this.emit('error', new errors.NotFound())
@@ -373,7 +373,7 @@ test('return a 404 if the stream emits a 404 error', t => {
     t.error(err)
     fastify.server.unref()
 
-    var port = fastify.server.address().port
+    const port = fastify.server.address().port
 
     sget(`http://localhost:${port}`, function (err, response) {
       t.error(err)

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

@@ -2,8 +2,7 @@ import fastify, {
   FastifyInstance,
   FastifyPlugin,
   FastifyPluginAsync,
-  FastifyPluginCallback,
-  FastifyPluginOptions
+  FastifyPluginCallback
 } from '../../fastify'
 import * as http from 'http'
 import * as https from 'https'

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

@@ -20,7 +20,7 @@ class CustomLoggerImpl implements CustomLogger {
   customMethod (msg: string, ...args: unknown[]) { console.log(msg, args) }
 
   // Implementation signature must be compatible with all overloads of FastifyLogFn
-  info (arg1: string | object, arg2?: string | unknown, ...args: unknown[]): void {
+  info (arg1: string | Record<string, unknown>, arg2?: string | unknown, ...args: unknown[]): void {
     console.log(arg1, arg2, ...args)
   }
 

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

@@ -69,6 +69,7 @@ type LowerCaseHTTPMethods = 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete'
     url: '/',
     method: method as HTTPMethods,
     config: { foo: 'bar', bar: 100 },
+    prefixTrailingSlash: 'slash',
     onRequest: (req, res, done) => { // these handlers are tested in `hooks.test-d.ts`
       expectType<BodyInterface>(req.body)
       expectType<QuerystringInterface>(req.query)
@@ -179,3 +180,7 @@ expectType<FastifyInstance>(fastify().route({
   handler: routeHandler,
   schemaErrorFormatter: (errors, dataVar) => new Error('')
 }))
+
+expectError(fastify().route({
+  prefixTrailingSlash: true // Not a valid value
+}))

package/test/versioned-routes.test.js

@@ -6,6 +6,7 @@ const Fastify = require('..')
 const sget = require('simple-get').concat
 const http = require('http')
 const split = require('split2')
+const append = require('vary').append
 
 test('Should register a versioned route', t => {
   t.plan(11)
@@ -476,3 +477,57 @@ test('Should register a versioned route with custome versioning strategy', t =>
     t.strictEqual(res.statusCode, 404)
   })
 })
+
+test('Vary header check (for documentation example)', t => {
+  t.plan(8)
+  const fastify = Fastify()
+  fastify.addHook('onSend', async (req, reply) => {
+    if (req.headers['accept-version']) { // or the custom header you are using
+      let value = reply.getHeader('Vary') || ''
+      const header = Array.isArray(value) ? value.join(', ') : String(value)
+      if ((value = append(header, 'Accept-Version'))) { // or the custom header you are using
+        reply.header('Vary', value)
+      }
+    }
+  })
+
+  fastify.route({
+    method: 'GET',
+    url: '/',
+    handler: (req, reply) => {
+      reply.send({ hello: 'world' })
+    }
+  })
+
+  fastify.route({
+    method: 'GET',
+    url: '/',
+    version: '1.2.0',
+    handler: (req, reply) => {
+      reply.send({ hello: 'world' })
+    }
+  })
+
+  fastify.inject({
+    method: 'GET',
+    url: '/',
+    headers: {
+      'Accept-Version': '1.x'
+    }
+  }, (err, res) => {
+    t.error(err)
+    t.deepEqual(JSON.parse(res.payload), { hello: 'world' })
+    t.strictEqual(res.statusCode, 200)
+    t.strictEqual(res.headers.vary, 'Accept-Version')
+  })
+
+  fastify.inject({
+    method: 'GET',
+    url: '/'
+  }, (err, res) => {
+    t.error(err)
+    t.deepEqual(JSON.parse(res.payload), { hello: 'world' })
+    t.strictEqual(res.statusCode, 200)
+    t.strictEqual(res.headers.vary, undefined)
+  })
+})

package/types/.eslintrc.json

@@ -31,11 +31,14 @@
       "files": ["*.test-d.ts"],
       "rules": {
         "no-unused-vars": "off",
-        "handle-callback-err": "off",
+        "node/handle-callback-err": "off",
         "@typescript-eslint/no-empty-function": "off",
         "@typescript-eslint/explicit-function-return-type": "off",
         "@typescript-eslint/no-unused-vars": "off",
         "@typescript-eslint/no-non-null-assertion": "off"
+      },
+      "globals": {
+        "NodeJS": "readonly"
       }
     }
   ]

package/types/content-type-parser.d.ts

@@ -1,6 +1,3 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
-import { Buffer } from 'buffer'
 import { RawServerBase, RawServerDefault, RawRequestDefaultExpression } from './utils'
 import { FastifyRequest } from './request'
 import { RouteGenericInterface } from './route'
@@ -42,19 +39,7 @@ export interface AddContentTypeParser<
     },
     parser: FastifyContentTypeParser<RawServer, RawRequest>
   ): void;
-}
-
-export interface AddContentTypeParser<
-  RawServer extends RawServerBase = RawServerDefault,
-  RawRequest extends RawRequestDefaultExpression<RawServer> = RawRequestDefaultExpression<RawServer>
-> {
   (contentType: string | string[], parser: FastifyContentTypeParser<RawServer, RawRequest>): void;
-}
-
-export interface AddContentTypeParser<
-  RawServer extends RawServerBase = RawServerDefault,
-  RawRequest extends RawRequestDefaultExpression<RawServer> = RawRequestDefaultExpression<RawServer>
->{
   <parseAs extends string | Buffer>(
     contentType: string | string[],
     opts: {