fastify 3.27.3 → 4.0.0-alpha.2

package/test/schema-serialization.test.js

@@ -163,7 +163,7 @@ test('Use shared schema and $ref with $id in response ($ref to $id)', t => {
     t.equal(res.statusCode, 400)
     t.same(res.json(), {
       error: 'Bad Request',
-      message: "body should have required property 'address'",
+      message: "body must have required property 'address'",
       statusCode: 400
     })
   })
@@ -236,8 +236,7 @@ test('Shared schema should be pass to serializer and validator ($ref to shared s
     $schema: 'http://json-schema.org/draft-07/schema#',
     title: 'List of Asset locations',
     type: 'array',
-    items: { $ref: 'http://example.com/asset.json#' },
-    default: []
+    items: { $ref: 'http://example.com/asset.json#' }
   }
 
   fastify.post('/', {
@@ -273,7 +272,7 @@ test('Shared schema should be pass to serializer and validator ($ref to shared s
       t.equal(res.statusCode, 400)
       t.same(res.json(), {
         error: 'Bad Request',
-        message: 'body[0].location.email should match format "email"',
+        message: 'body/0/location/email must match format "email"',
         statusCode: 400
       })
     })
@@ -282,7 +281,7 @@ test('Shared schema should be pass to serializer and validator ($ref to shared s
 
 test('Custom setSerializerCompiler', t => {
   t.plan(7)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
 
   const outSchema = {
     $id: 'test',
@@ -355,7 +354,6 @@ test('Custom setSerializerCompiler returns bad serialized output', t => {
     t.error(err)
     t.equal(res.statusCode, 500)
     t.strictSame(res.json(), {
-      error: 'Internal Server Error',
       code: 'FST_ERR_REP_INVALID_PAYLOAD_TYPE',
       message: 'Attempted to send payload of invalid type \'object\'. Expected a string or Buffer.',
       statusCode: 500
@@ -410,11 +408,11 @@ test('Custom serializer per route', async t => {
   res = await fastify.inject('/route')
   t.equal(res.json().mean, 'route')
 
-  t.equal(hit, 2, 'the custom and route serializer has been called')
+  t.equal(hit, 4, 'the custom and route serializer has been called')
 })
 
 test('Reply serializer win over serializer ', t => {
-  t.plan(5)
+  t.plan(6)
 
   const fastify = Fastify()
   fastify.setReplySerializer(function (payload, statusCode) {
@@ -453,7 +451,7 @@ test('Reply serializer win over serializer ', t => {
 })
 
 test('Reply serializer win over serializer ', t => {
-  t.plan(5)
+  t.plan(6)
 
   const fastify = Fastify()
   fastify.setReplySerializer(function (payload, statusCode) {
@@ -570,11 +568,13 @@ test('do not crash if status code serializer errors', async t => {
   const fastify = Fastify()
 
   const requiresFoo = {
+    type: 'object',
     properties: { foo: { type: 'string' } },
     required: ['foo']
   }
 
   const someUserErrorType2 = {
+    type: 'object',
     properties: {
       code: { type: 'number' }
     },

package/test/schema-special-usage.test.js

@@ -1,167 +1,18 @@
 'use strict'
 
 const { test } = require('tap')
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const AJV = require('ajv')
 const S = require('fluent-json-schema')
 const Fastify = require('..')
 const ajvMergePatch = require('ajv-merge-patch')
 const ajvErrors = require('ajv-errors')
 
-const buildValidatorAJV8 = require('@fastify/ajv-compiler-8')
-
-test('Ajv8 usage instead of the bundle one', t => {
-  t.plan(2)
-
-  t.test('use new ajv8 option', t => {
-    t.plan(2)
-    const fastify = Fastify({
-      ajv: {
-        customOptions: { strictRequired: true }
-      },
-      schemaController: {
-        compilersFactory: {
-          buildValidator: buildValidatorAJV8()
-        }
-      }
-    })
-
-    fastify.post('/', {
-      schema: {
-        body: {
-          type: 'object',
-          required: ['missing'],
-          properties: {
-            foo: {
-              type: 'string'
-            }
-          }
-        }
-      },
-      handler (req, reply) { reply.send({ ok: 1 }) }
-    })
-
-    fastify.ready(err => {
-      t.ok(err)
-      t.match(err.message, 'strictRequired', 'the new ajv8 option trigger a startup error')
-    })
-  })
-
-  t.test('use new ajv8 option within a response schema', t => {
-    t.plan(2)
-    const fastify = Fastify({
-      schemaController: {
-        compilersFactory: {
-          buildValidator: buildValidatorAJV8()
-        }
-      }
-    })
-
-    fastify.post('/', {
-      schema: {
-        body: {
-          type: 'object',
-          required: ['missing'],
-          properties: {
-            foo: {
-              type: 'string'
-            }
-          }
-        },
-        response: {
-          '2xx': {
-            type: 'object',
-            properties: {
-              ok: {
-                type: 'integer'
-              }
-            }
-          }
-        }
-      },
-      handler (req, reply) { reply.send({ ok: 1 }) }
-    })
-
-    fastify.ready(err => {
-      t.error(err)
-      t.pass('startup successful')
-    })
-  })
-})
-
-test('Ajv8 usage with plugins', t => {
-  t.plan(2)
-
-  t.test('use new ajv8 option', t => {
-    t.plan(3)
-    const fastify = Fastify({
-      ajv: {
-        customOptions: { validateFormats: true },
-        plugins: [require('ajv-formats')]
-      },
-      schemaController: {
-        compilersFactory: {
-          buildValidator: buildValidatorAJV8()
-        }
-      }
-    })
-
-    callIt(fastify, (err, res) => {
-      t.error(err)
-      t.equal(res.statusCode, 400)
-      t.equal(res.json().message, 'body must match format "date"')
-    })
-  })
-
-  t.test('use new ajv8 option - avoid check', t => {
-    t.plan(2)
-    const fastify = Fastify({
-      ajv: {
-        customOptions: { validateFormats: false }
-      },
-      schemaController: {
-        compilersFactory: {
-          buildValidator: buildValidatorAJV8()
-        }
-      }
-    })
-
-    callIt(fastify, (err, res) => {
-      t.error(err)
-      t.equal(res.statusCode, 200)
-    })
-  })
-
-  function callIt (fastify, cb) {
-    fastify.post('/', {
-      schema: {
-        body: {
-          type: 'object',
-          properties: {
-            foo: {
-              type: 'string',
-              format: 'date'
-            }
-          }
-        }
-      },
-      handler (req, reply) { reply.send({ ok: 1 }) }
-    })
-
-    fastify.inject({
-      method: 'POST',
-      url: '/',
-      payload: { foo: '99' }
-    }, cb)
-  }
-})
-
 test('Ajv plugins array parameter', t => {
   t.plan(3)
   const fastify = Fastify({
     ajv: {
       customOptions: {
-        jsonPointers: true,
         allErrors: true
       },
       plugins: [
@@ -509,7 +360,7 @@ test('setSchemaController in a plugin', t => {
   ajvInstance.addSchema(baseSchema)
   ajvInstance.addSchema(refSchema)
 
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   fastify.register(schemaPlugin)
   fastify.get('/', {
     schema: {
@@ -760,7 +611,8 @@ test('multiple refs with the same ids', t => {
 
   fastify.addSchema(baseSchema)
   fastify.addSchema(refSchema)
-  fastify.get('/', {
+
+  fastify.head('/', {
     schema: {
       query: refSchema,
       response: {
@@ -772,7 +624,7 @@ test('multiple refs with the same ids', t => {
     }
   })
 
-  fastify.head('/', {
+  fastify.get('/', {
     schema: {
       query: refSchema,
       response: {

package/test/schema-validation.test.js

@@ -99,7 +99,7 @@ test('Basic validation test', t => {
     url: '/'
   }, (err, res) => {
     t.error(err)
-    t.same(res.json(), { statusCode: 400, error: 'Bad Request', message: "body should have required property 'work'" })
+    t.same(res.json(), { statusCode: 400, error: 'Bad Request', message: "body must have required property 'work'" })
     t.equal(res.statusCode, 400)
   })
 })
@@ -314,7 +314,7 @@ test('Triple $ref with a simple $id', t => {
   }, (err, res) => {
     t.error(err)
     t.equal(res.statusCode, 400)
-    t.same(res.json().message, "body should have required property 'foo'")
+    t.same(res.json().message, "body must have required property 'foo'")
   })
 })
 
@@ -348,6 +348,7 @@ test('Extending schema', t => {
             allOf: [
               { $ref: 'address.id#/definitions/address' },
               {
+                type: 'object',
                 properties: { type: { enum: ['residential', 'business'] } },
                 required: ['type']
               }
@@ -439,7 +440,7 @@ test('Should work with nested ids', t => {
   }, (err, res) => {
     t.error(err)
     t.equal(res.statusCode, 400)
-    t.equal(res.json().message, 'params.id should be number')
+    t.equal(res.json().message, 'params/id must be number')
   })
 })
 
@@ -536,7 +537,7 @@ test('JSON Schema validation keywords', t => {
     t.same(res.json(), {
       statusCode: 400,
       error: 'Bad Request',
-      message: 'params.ip should match format "ipv4"'
+      message: 'params/ip must match format "ipv4"'
     })
   })
 })
@@ -590,7 +591,7 @@ test('Nested id calls', t => {
     t.equal(res.statusCode, 400)
     t.same(res.json(), {
       error: 'Bad Request',
-      message: 'body.host.ip should match format "ipv4"',
+      message: 'body/host/ip must match format "ipv4"',
       statusCode: 400
     })
   })
@@ -692,7 +693,7 @@ test('Use shared schema and $ref with $id ($ref to $id)', t => {
     t.equal(res.statusCode, 400)
     t.same(res.json(), {
       error: 'Bad Request',
-      message: "body should have required property 'address'",
+      message: "body must have required property 'address'",
       statusCode: 400
     })
   })
@@ -712,8 +713,7 @@ test('Use items with $ref', t => {
 
   const body = {
     type: 'array',
-    items: { $ref: 'http://example.com/ref-to-external-validator.json#' },
-    default: []
+    items: { $ref: 'http://example.com/ref-to-external-validator.json#' }
   }
 
   fastify.post('/', {
@@ -809,7 +809,7 @@ test('Use $ref to /definitions', t => {
     t.equal(res.statusCode, 400)
     t.same(res.json(), {
       error: 'Bad Request',
-      message: 'body.test.id should be number',
+      message: 'body/test/id must be number',
       statusCode: 400
     })
   })

package/test/skip-reply-send.test.js

@@ -201,7 +201,7 @@ function testHandlerOrBeforeHandlerHook (test, hookOrHandler) {
 
       nextHooks.forEach(h => app.addHook(h, async (req, reply) => t.fail(`${h} should not be called`)))
 
-      app.listen(0, err => {
+      app.listen({ port: 0 }, err => {
         t.error(err)
         const client = net.createConnection({ port: (app.server.address()).port }, () => {
           client.write('GET / HTTP/1.1\r\n\r\n')
@@ -297,7 +297,7 @@ function testHandlerOrBeforeHandlerHook (test, hookOrHandler) {
       } else {
         app.addHook(hookOrHandler, async (req, reply) => {
           reply.hijack()
-          reply.send('hello from reply.send()')
+          return reply.send('hello from reply.send()')
         })
         app.get('/', (req, reply) => t.fail('Handler should not be called'))
       }

package/test/stream.test.js

@@ -14,7 +14,8 @@ const JSONStream = require('JSONStream')
 const send = require('send')
 const Readable = require('stream').Readable
 const split = require('split2')
-const { kDisableRequestLogging, kReplySent } = require('../lib/symbols.js')
+const semver = require('semver')
+const { kDisableRequestLogging } = require('../lib/symbols.js')
 
 function getUrl (app) {
   const { address, port } = app.server.address()
@@ -26,7 +27,7 @@ function getUrl (app) {
 }
 
 test('should respond with a stream', t => {
-  t.plan(8)
+  t.plan(6)
   const fastify = Fastify()
 
   fastify.get('/', function (req, reply) {
@@ -34,18 +35,13 @@ test('should respond with a stream', t => {
     reply.code(200).send(stream)
   })
 
-  fastify.get('/error', function (req, reply) {
-    const stream = fs.createReadStream('not-existing-file', 'utf8')
-    reply.code(200).send(stream)
-  })
-
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
     fastify.server.unref()
 
     sget(`http://localhost:${fastify.server.address().port}`, function (err, response, data) {
       t.error(err)
-      t.equal(response.headers['content-type'], 'application/octet-stream')
+      t.equal(response.headers['content-type'], undefined)
       t.equal(response.statusCode, 200)
 
       fs.readFile(__filename, (err, expected) => {
@@ -53,6 +49,21 @@ test('should respond with a stream', t => {
         t.equal(expected.toString(), data.toString())
       })
     })
+  })
+})
+
+test('should respond with a stream (error)', t => {
+  t.plan(3)
+  const fastify = Fastify()
+
+  fastify.get('/error', function (req, reply) {
+    const stream = fs.createReadStream('not-existing-file', 'utf8')
+    reply.code(200).send(stream)
+  })
+
+  fastify.listen({ port: 0 }, err => {
+    t.error(err)
+    fastify.server.unref()
 
     sget(`http://localhost:${fastify.server.address().port}/error`, function (err, response) {
       t.error(err)
@@ -105,7 +116,7 @@ test('should trigger the onSend hook only twice if pumping the stream fails, fir
     done()
   })
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
 
     fastify.server.unref()
@@ -268,7 +279,7 @@ test('Destroying streams prematurely', t => {
     reply.send(reallyLongStream)
   })
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
     fastify.server.unref()
 
@@ -331,7 +342,7 @@ test('Destroying streams prematurely should call close method', t => {
     reply.send(reallyLongStream)
   })
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
     fastify.server.unref()
 
@@ -393,7 +404,7 @@ test('Destroying streams prematurely should call close method when destroy is no
     reply.send(reallyLongStream)
   })
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
     fastify.server.unref()
 
@@ -456,7 +467,7 @@ test('Destroying streams prematurely should call abort method', t => {
     reply.send(reallyLongStream)
   })
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
     fastify.server.unref()
 
@@ -506,7 +517,7 @@ test('Destroying streams prematurely, log is disabled', t => {
     reply.send(reallyLongStream)
   })
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
     fastify.server.unref()
 
@@ -536,7 +547,7 @@ test('should respond with a stream1', t => {
     stream.end({ a: 42 })
   })
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
     fastify.server.unref()
 
@@ -568,7 +579,7 @@ test('return a 404 if the stream emits a 404 error', t => {
     reply.send(reallyLongStream)
   })
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
     fastify.server.unref()
 
@@ -582,7 +593,7 @@ test('return a 404 if the stream emits a 404 error', t => {
   })
 })
 
-test('should support send module 200 and 404', { only: true }, t => {
+test('should support send module 200 and 404', { skip: semver.gte(process.versions.node, '17.0.0') }, t => {
   t.plan(8)
   const fastify = Fastify()
 
@@ -596,7 +607,7 @@ test('should support send module 200 and 404', { only: true }, t => {
     reply.code(200).send(stream)
   })
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
     fastify.server.unref()
 
@@ -604,7 +615,7 @@ test('should support send module 200 and 404', { only: true }, t => {
 
     sget(url, function (err, response, data) {
       t.error(err)
-      t.equal(response.headers['content-type'], 'application/octet-stream')
+      t.equal(response.headers['content-type'], 'application/javascript; charset=UTF-8')
       t.equal(response.statusCode, 200)
 
       fs.readFile(__filename, (err, expected) => {
@@ -637,7 +648,7 @@ test('should destroy stream when response is ended', t => {
     reply.raw.end(Buffer.from('hello\n'))
   })
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
     fastify.server.unref()
 
@@ -654,7 +665,7 @@ test('should mark reply as sent before pumping the payload stream into response
   const handleRequest = proxyquire('../lib/handleRequest', {
     './wrapThenable': (thenable, reply) => {
       thenable.then(function (payload) {
-        t.equal(reply[kReplySent], true)
+        t.equal(reply.sent, true)
       })
     }
   })
@@ -671,7 +682,7 @@ test('should mark reply as sent before pumping the payload stream into response
 
   fastify.get('/', async function (req, reply) {
     const stream = fs.createReadStream(__filename, 'utf8')
-    reply.code(200).send(stream)
+    return reply.code(200).send(stream)
   })
 
   fastify.inject({
@@ -683,3 +694,51 @@ test('should mark reply as sent before pumping the payload stream into response
     fastify.close()
   })
 })
+
+test('reply.send handles aborted requests', t => {
+  t.plan(2)
+
+  const spyLogger = {
+    level: 'error',
+    fatal: () => { },
+    error: () => {
+      t.fail('should not log an error')
+    },
+    warn: () => { },
+    info: () => { },
+    debug: () => { },
+    trace: () => { },
+    child: () => { return spyLogger }
+  }
+  const fastify = Fastify({
+    logger: spyLogger
+  })
+
+  fastify.get('/', (req, reply) => {
+    setTimeout(() => {
+      const stream = new Readable({
+        read: function () {
+          this.push(null)
+        }
+      })
+      reply.send(stream)
+    }, 6)
+  })
+
+  fastify.listen({ port: 0 }, err => {
+    t.error(err)
+    fastify.server.unref()
+
+    const port = fastify.server.address().port
+    const http = require('http')
+    const req = http.get(`http://localhost:${port}`)
+      .on('error', (err) => {
+        t.equal(err.code, 'ECONNRESET')
+        fastify.close()
+      })
+
+    setTimeout(() => {
+      req.abort()
+    }, 1)
+  })
+})

package/test/throw.test.js

@@ -17,12 +17,15 @@ test('Fastify should throw on wrong options', t => {
 test('Fastify should throw on multiple assignment to the same route', t => {
   t.plan(1)
   const fastify = Fastify()
-  fastify.get('/', () => {})
+
   fastify.get('/', () => {})
 
-  fastify.ready(err => {
-    t.equal(err.message, "Method 'GET' already declared for route '/' with constraints '{}'")
-  })
+  try {
+    fastify.get('/', () => {})
+    t.fail('Should throw on duplicated route declaration')
+  } catch (error) {
+    t.equal(error.message, "Method 'GET' already declared for route '/'")
+  }
 })
 
 test('Fastify should throw for an invalid schema, printing the error route - headers', t => {
@@ -78,7 +81,7 @@ test('Fastify should throw for an invalid shorthand option type', t => {
     t.fail()
   } catch (e) {
     t.equal(e.code, 'FST_ERR_INIT_OPTS_INVALID')
-    t.match(e.message, /should be boolean/)
+    t.match(e.message, /must be boolean/)
     t.pass()
   }
 })

package/test/trust-proxy.test.js

@@ -63,7 +63,7 @@ test('trust proxy, not add properties to node req', (t) => {
 
   t.teardown(app.close.bind(app))
 
-  app.listen(0, (err) => {
+  app.listen({ port: 0 }, (err) => {
     app.server.unref()
     t.error(err)
     sgetForwardedRequest(app, '1.1.1.1', '/trustproxy')
@@ -84,7 +84,7 @@ test('trust proxy chain', (t) => {
 
   t.teardown(app.close.bind(app))
 
-  app.listen(0, (err) => {
+  app.listen({ port: 0 }, (err) => {
     app.server.unref()
     t.error(err)
     sgetForwardedRequest(app, '192.168.1.1, 1.1.1.1', '/trustproxychain')
@@ -103,7 +103,7 @@ test('trust proxy function', (t) => {
 
   t.teardown(app.close.bind(app))
 
-  app.listen(0, (err) => {
+  app.listen({ port: 0 }, (err) => {
     app.server.unref()
     t.error(err)
     sgetForwardedRequest(app, '1.1.1.1', '/trustproxyfunc')
@@ -122,7 +122,7 @@ test('trust proxy number', (t) => {
 
   t.teardown(app.close.bind(app))
 
-  app.listen(0, (err) => {
+  app.listen({ port: 0 }, (err) => {
     app.server.unref()
     t.error(err)
     sgetForwardedRequest(app, '2.2.2.2, 1.1.1.1', '/trustproxynumber')
@@ -141,7 +141,7 @@ test('trust proxy IP addresses', (t) => {
 
   t.teardown(app.close.bind(app))
 
-  app.listen(0, (err) => {
+  app.listen({ port: 0 }, (err) => {
     app.server.unref()
     t.error(err)
     sgetForwardedRequest(app, '3.3.3.3, 2.2.2.2, 1.1.1.1', '/trustproxyipaddrs')
@@ -168,7 +168,7 @@ test('trust proxy protocol', (t) => {
 
   t.teardown(app.close.bind(app))
 
-  app.listen(0, (err) => {
+  app.listen({ port: 0 }, (err) => {
     app.server.unref()
     t.error(err)
     sgetForwardedRequest(app, '1.1.1.1', '/trustproxyprotocol', 'lorem')