fastify 3.27.2 → 4.0.0-alpha.1

package/test/fastify-instance.test.js

@@ -70,8 +70,8 @@ test('fastify instance get invalid ajv options.plugins', t => {
 test('fastify instance should contain default errorHandler', t => {
   t.plan(3)
   const fastify = Fastify()
-  t.ok(fastify[kErrorHandler] instanceof Function)
-  t.same(fastify.errorHandler, fastify[kErrorHandler])
+  t.ok(fastify[kErrorHandler].func instanceof Function)
+  t.same(fastify.errorHandler, fastify[kErrorHandler].func)
   t.same(Object.getOwnPropertyDescriptor(fastify, 'errorHandler').set, undefined)
 })
 
@@ -94,6 +94,6 @@ test('errorHandler in plugin should be separate from the external one', async t
 
   await fastify.ready()
 
-  t.ok(fastify[kErrorHandler] instanceof Function)
-  t.same(fastify.errorHandler, fastify[kErrorHandler])
+  t.ok(fastify[kErrorHandler].func instanceof Function)
+  t.same(fastify.errorHandler, fastify[kErrorHandler].func)
 })

package/test/fluent-schema.test.js

@@ -34,7 +34,7 @@ test('use fluent-json-schema object', t => {
   }, (err, res) => {
     t.error(err)
     t.equal(res.statusCode, 400)
-    t.same(res.json(), { statusCode: 400, error: 'Bad Request', message: 'params.id should be >= 42' })
+    t.same(res.json(), { statusCode: 400, error: 'Bad Request', message: 'params/id must be >= 42' })
   })
 
   // check header
@@ -47,7 +47,7 @@ test('use fluent-json-schema object', t => {
   }, (err, res) => {
     t.error(err)
     t.equal(res.statusCode, 400)
-    t.same(res.json(), { statusCode: 400, error: 'Bad Request', message: 'headers[\'x-custom\'] should match format "email"' })
+    t.same(res.json(), { statusCode: 400, error: 'Bad Request', message: 'headers/x-custom must match format "email"' })
   })
 
   // check query
@@ -60,7 +60,7 @@ test('use fluent-json-schema object', t => {
   }, (err, res) => {
     t.error(err)
     t.equal(res.statusCode, 400)
-    t.same(res.json(), { statusCode: 400, error: 'Bad Request', message: 'querystring should have required property \'surname\'' })
+    t.same(res.json(), { statusCode: 400, error: 'Bad Request', message: 'querystring must have required property \'surname\'' })
   })
 
   // check body
@@ -73,7 +73,7 @@ test('use fluent-json-schema object', t => {
   }, (err, res) => {
     t.error(err)
     t.equal(res.statusCode, 400)
-    t.same(res.json(), { statusCode: 400, error: 'Bad Request', message: 'body.name should be string' })
+    t.same(res.json(), { statusCode: 400, error: 'Bad Request', message: 'body/name must be string' })
   })
 
   // check response

package/test/get.test.js

@@ -243,7 +243,7 @@ fastify.listen(0, err => {
       t.equal(response.statusCode, 400)
       t.same(JSON.parse(body), {
         error: 'Bad Request',
-        message: 'params.test should be integer',
+        message: 'params/test must be integer',
         statusCode: 400
       })
     })
@@ -280,7 +280,7 @@ fastify.listen(0, err => {
       t.equal(response.statusCode, 400)
       t.same(JSON.parse(body), {
         error: 'Bad Request',
-        message: "headers['x-test'] should be number",
+        message: 'headers/x-test must be number',
         statusCode: 400
       })
     })
@@ -309,7 +309,7 @@ fastify.listen(0, err => {
       t.equal(response.statusCode, 400)
       t.same(JSON.parse(body), {
         error: 'Bad Request',
-        message: 'querystring.hello should be integer',
+        message: 'querystring/hello must be integer',
         statusCode: 400
       })
     })

package/test/helper.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const sget = require('simple-get').concat
+const dns = require('dns').promises
 const stream = require('stream')
 const symbols = require('../lib/symbols')
 
@@ -16,7 +17,7 @@ module.exports.payloadMethod = function (method, t, isSetErrorHandler = false) {
   if (isSetErrorHandler) {
     fastify.setErrorHandler(function (err, request, reply) {
       t.type(request, 'object')
-      t.type(request, fastify[symbols.kRequest])
+      t.type(request, fastify[symbols.kRequest].parent)
       reply
         .code(err.statusCode)
         .type('application/json; charset=utf-8')
@@ -189,7 +190,7 @@ module.exports.payloadMethod = function (method, t, isSetErrorHandler = false) {
       }, (err, response, body) => {
         t.error(err)
         t.equal(response.statusCode, 200)
-        t.equal(JSON.parse(body.toString()), null)
+        t.equal(body.toString(), '')
       })
 
       // Must use inject to make a request without a Content-Length header
@@ -199,7 +200,7 @@ module.exports.payloadMethod = function (method, t, isSetErrorHandler = false) {
       }, (err, res) => {
         t.error(err)
         t.equal(res.statusCode, 200)
-        t.equal(JSON.parse(res.payload), null)
+        t.equal(res.payload.toString(), '')
       })
     })
 
@@ -419,3 +420,17 @@ module.exports.payloadMethod = function (method, t, isSetErrorHandler = false) {
     })
   })
 }
+
+module.exports.getLoopbackHost = async () => {
+  let localhostForURL
+
+  const lookup = await dns.lookup('localhost')
+  const localhost = lookup.address
+  if (lookup.family === 6) {
+    localhostForURL = `[${lookup.address}]`
+  } else {
+    localhostForURL = localhost
+  }
+
+  return [localhost, localhostForURL]
+}

package/test/hooks-async.test.js

@@ -13,7 +13,7 @@ process.removeAllListeners('warning')
 test('async hooks', t => {
   t.plan(21)
 
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   fastify.addHook('onRequest', async function (request, reply) {
     await sleep(1)
     request.test = 'the request is coming'
@@ -132,7 +132,7 @@ test('onRequest hooks should be able to block a request', t => {
   const fastify = Fastify()
 
   fastify.addHook('onRequest', async (req, reply) => {
-    reply.send('hello')
+    await reply.send('hello')
   })
 
   fastify.addHook('onRequest', async (req, reply) => {
@@ -194,37 +194,6 @@ test('preParsing hooks should be able to modify the payload', t => {
   })
 })
 
-test('preParsing hooks can completely ignore the payload - deprecated syntax', t => {
-  t.plan(5)
-  const fastify = Fastify()
-
-  process.on('warning', onWarning)
-  function onWarning (warning) {
-    t.equal(warning.name, 'FastifyDeprecation')
-    t.equal(warning.code, 'FSTDEP004')
-  }
-
-  fastify.addHook('preParsing', async (req, reply) => {
-
-  })
-
-  fastify.post('/', function (request, reply) {
-    reply.send(request.body)
-  })
-
-  fastify.inject({
-    method: 'POST',
-    url: '/',
-    payload: { hello: 'world' }
-  }, (err, res) => {
-    t.error(err)
-    t.equal(res.statusCode, 200)
-    t.same(JSON.parse(res.payload), { hello: 'world' })
-
-    process.removeListener('warning', onWarning)
-  })
-})
-
 test('preParsing hooks should handle errors', t => {
   t.plan(3)
   const fastify = Fastify()
@@ -255,7 +224,7 @@ test('preHandler hooks should be able to block a request', t => {
   const fastify = Fastify()
 
   fastify.addHook('preHandler', async (req, reply) => {
-    reply.send('hello')
+    await reply.send('hello')
   })
 
   fastify.addHook('preHandler', async (req, reply) => {
@@ -289,7 +258,7 @@ test('preValidation hooks should be able to block a request', t => {
   const fastify = Fastify()
 
   fastify.addHook('preValidation', async (req, reply) => {
-    reply.send('hello')
+    await reply.send('hello')
   })
 
   fastify.addHook('preValidation', async (req, reply) => {
@@ -414,7 +383,7 @@ test('preValidation hooks should handle throwing null', t => {
 
   fastify.setErrorHandler(async (error, request, reply) => {
     t.ok(error instanceof Error)
-    reply.send(error)
+    await reply.send(error)
   })
 
   fastify.addHook('preValidation', async () => {
@@ -465,7 +434,7 @@ test('onRequest hooks should be able to block a request (last hook)', t => {
   const fastify = Fastify()
 
   fastify.addHook('onRequest', async (req, reply) => {
-    reply.send('hello')
+    await reply.send('hello')
   })
 
   fastify.addHook('preHandler', async (req, reply) => {
@@ -499,7 +468,7 @@ test('preHandler hooks should be able to block a request (last hook)', t => {
   const fastify = Fastify()
 
   fastify.addHook('preHandler', async (req, reply) => {
-    reply.send('hello')
+    await reply.send('hello')
   })
 
   fastify.addHook('onSend', async (req, reply, payload) => {
@@ -533,8 +502,9 @@ test('onRequest respond with a stream', t => {
       const stream = fs.createReadStream(process.cwd() + '/test/stream.test.js', 'utf8')
       // stream.pipe(res)
       // res.once('finish', resolve)
-      reply.send(stream)
-      reply.raw.once('finish', () => resolve())
+      reply.send(stream).then(() => {
+        reply.raw.once('finish', () => resolve())
+      })
     })
   })
 
@@ -580,14 +550,11 @@ test('preHandler respond with a stream', t => {
   const order = [1, 2]
 
   fastify.addHook('preHandler', async (req, reply) => {
-    return new Promise((resolve, reject) => {
-      const stream = fs.createReadStream(process.cwd() + '/test/stream.test.js', 'utf8')
-      reply.send(stream)
-      reply.raw.once('finish', () => {
-        t.equal(order.shift(), 2)
-        resolve()
-      })
+    const stream = fs.createReadStream(process.cwd() + '/test/stream.test.js', 'utf8')
+    reply.raw.once('finish', () => {
+      t.equal(order.shift(), 2)
     })
+    return reply.send(stream)
   })
 
   fastify.addHook('preHandler', async (req, reply) => {

package/test/hooks.on-ready.test.js

@@ -268,7 +268,7 @@ t.test('onReady can not add decorators or application hooks', t => {
 })
 
 t.test('onReady cannot add lifecycle hooks', t => {
-  t.plan(4)
+  t.plan(5)
   const fastify = Fastify()
 
   fastify.addHook('onReady', function (done) {
@@ -277,7 +277,9 @@ t.test('onReady cannot add lifecycle hooks', t => {
       fastify.addHook('onRequest', (request, reply, done) => {})
     } catch (error) {
       t.ok(error)
-      t.equal(error.message, 'root plugin has already booted')
+      t.equal(error.message, 'Root plugin has already booted')
+      // TODO: look where the error pops up
+      t.equal(error.code, 'AVV_ERR_PLUGIN_NOT_VALID')
       done(error)
     }
   })
@@ -300,7 +302,7 @@ t.test('onReady throw loading error', t => {
 })
 
 t.test('onReady does not call done', t => {
-  t.plan(3)
+  t.plan(6)
   const fastify = Fastify({ pluginTimeout: 500 })
 
   fastify.addHook('onReady', function (done) {
@@ -310,7 +312,10 @@ t.test('onReady does not call done', t => {
 
   fastify.ready(err => {
     t.ok(err)
-    t.equal(err.code, 'ERR_AVVIO_READY_TIMEOUT')
+    t.equal(err.message, "A callback for 'onReady' hook timed out. You may have forgotten to call 'done' function or to resolve a Promise")
+    t.equal(err.code, 'FST_ERR_HOOK_TIMEOUT')
+    t.ok(err.cause)
+    t.equal(err.cause.code, 'AVV_ERR_READY_TIMEOUT')
   })
 })
 

package/test/hooks.test.js

@@ -9,14 +9,22 @@ const fp = require('fastify-plugin')
 const fs = require('fs')
 const split = require('split2')
 const symbols = require('../lib/symbols.js')
-const warning = require('../lib/warnings')
 const payload = { hello: 'world' }
 
 process.removeAllListeners('warning')
 
+function getUrl (app) {
+  const { address, port } = app.server.address()
+  if (address === '::1') {
+    return `http://[${address}]:${port}`
+  } else {
+    return `http://${address}:${port}`
+  }
+}
+
 test('hooks', t => {
   t.plan(43)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
 
   try {
     fastify.addHook('preHandler', function (request, reply, done) {
@@ -46,7 +54,7 @@ test('hooks', t => {
   }
 
   try {
-    fastify.addHook('preParsing', function (request, reply, done) {
+    fastify.addHook('preParsing', function (request, reply, payload, done) {
       request.preParsing = true
       t.equal(request.test, 'the request is coming')
       t.equal(reply.test, 'the reply has come')
@@ -342,7 +350,7 @@ test('preHandler hook should support encapsulation / 5', t => {
 
 test('onRoute hook should be called / 1', t => {
   t.plan(2)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
 
   fastify.register((instance, opts, done) => {
     instance.addHook('onRoute', () => {
@@ -363,7 +371,7 @@ test('onRoute hook should be called / 2', t => {
   t.plan(5)
   let firstHandler = 0
   let secondHandler = 0
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   fastify.addHook('onRoute', (route) => {
     t.pass()
     firstHandler++
@@ -391,7 +399,7 @@ test('onRoute hook should be called / 2', t => {
 
 test('onRoute hook should be called / 3', t => {
   t.plan(5)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
 
   function handler (req, reply) {
     reply.send()
@@ -423,7 +431,7 @@ test('onRoute hook should be called / 3', t => {
 
 test('onRoute hook should be called (encapsulation support) / 4', t => {
   t.plan(4)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
 
   fastify.addHook('onRoute', () => {
     t.pass()
@@ -450,7 +458,7 @@ test('onRoute hook should be called (encapsulation support) / 4', t => {
 
 test('onRoute hook should be called (encapsulation support) / 5', t => {
   t.plan(2)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
 
   fastify.get('/first', function (req, reply) {
     reply.send()
@@ -477,7 +485,7 @@ test('onRoute hook should be called (encapsulation support) / 5', t => {
 
 test('onRoute hook should be called (encapsulation support) / 6', t => {
   t.plan(1)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
 
   fastify.get('/first', function (req, reply) {
     reply.send()
@@ -494,7 +502,7 @@ test('onRoute hook should be called (encapsulation support) / 6', t => {
 
 test('onRoute should keep the context', t => {
   t.plan(4)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   fastify.register((instance, opts, done) => {
     instance.decorate('test', true)
     instance.addHook('onRoute', onRoute)
@@ -519,7 +527,7 @@ test('onRoute should keep the context', t => {
 
 test('onRoute hook should pass correct route', t => {
   t.plan(9)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   fastify.addHook('onRoute', (route) => {
     t.equal(route.method, 'GET')
     t.equal(route.url, '/')
@@ -547,7 +555,7 @@ test('onRoute hook should pass correct route', t => {
 
 test('onRoute hook should pass correct route with custom prefix', t => {
   t.plan(11)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   fastify.addHook('onRoute', function (route) {
     t.equal(route.method, 'GET')
     t.equal(route.url, '/v1/foo')
@@ -577,7 +585,7 @@ test('onRoute hook should pass correct route with custom prefix', t => {
 
 test('onRoute hook should pass correct route with custom options', t => {
   t.plan(6)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   fastify.register((instance, opts, done) => {
     instance.addHook('onRoute', function (route) {
       t.equal(route.method, 'GET')
@@ -605,7 +613,7 @@ test('onRoute hook should pass correct route with custom options', t => {
 
 test('onRoute hook should receive any route option', t => {
   t.plan(5)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   fastify.register((instance, opts, done) => {
     instance.addHook('onRoute', function (route) {
       t.equal(route.method, 'GET')
@@ -626,7 +634,7 @@ test('onRoute hook should receive any route option', t => {
 
 test('onRoute hook should preserve system route configuration', t => {
   t.plan(5)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   fastify.register((instance, opts, done) => {
     instance.addHook('onRoute', function (route) {
       t.equal(route.method, 'GET')
@@ -650,7 +658,7 @@ test('onRoute hook should preserve handler function in options of shorthand rout
 
   const handler = (req, reply) => {}
 
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   fastify.register((instance, opts, done) => {
     instance.addHook('onRoute', function (route) {
       t.equal(route.handler, handler)
@@ -671,7 +679,7 @@ test('onRoute hook should be called once when prefixTrailingSlash', t => {
   let onRouteCalled = 0
   let routePatched = 0
 
-  const fastify = Fastify({ ignoreTrailingSlash: false })
+  const fastify = Fastify({ ignoreTrailingSlash: false, exposeHeadRoutes: false })
 
   // a plugin that patches route options, similar to fastify-compress
   fastify.register(fp(function myPlugin (instance, opts, next) {
@@ -710,16 +718,16 @@ test('onRoute hook should be called once when prefixTrailingSlash', t => {
 test('onRoute hook should able to change the route url', t => {
   t.plan(5)
 
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
 
   fastify.register((instance, opts, done) => {
     instance.addHook('onRoute', (route) => {
-      t.equal(route.url, '/föö')
+      t.equal(route.url, '/foo')
       route.url = encodeURI(route.url)
     })
 
-    instance.get('/föö', (request, reply) => {
-      reply.send('here /föö')
+    instance.get('/foo', (request, reply) => {
+      reply.send('here /foo')
     })
 
     done()
@@ -731,37 +739,43 @@ test('onRoute hook should able to change the route url', t => {
 
     sget({
       method: 'GET',
-      url: 'http://localhost:' + fastify.server.address().port + encodeURI('/föö')
+      url: getUrl(fastify) + encodeURI('/foo')
     }, (err, response, body) => {
       t.error(err)
       t.equal(response.statusCode, 200)
-      t.equal(body.toString(), 'here /föö')
+      t.equal(body.toString(), 'here /foo')
     })
   })
 })
 
-test('onRoute hook that throws should be caught ', t => {
+test('onRoute hook that throws should be caught', t => {
   t.plan(1)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
 
   fastify.register((instance, opts, done) => {
     instance.addHook('onRoute', () => {
       throw new Error('snap')
     })
-    instance.get('/', opts, function (req, reply) {
-      reply.send()
-    })
+
+    try {
+      instance.get('/', opts, function (req, reply) {
+        reply.send()
+      })
+
+      t.fail('onRoute should throw sync if error')
+    } catch (error) {
+      t.ok(error)
+    }
+
     done()
   })
 
-  fastify.ready(err => {
-    t.ok(err)
-  })
+  fastify.ready()
 })
 
 test('onRoute hook with many prefix', t => {
   t.plan(3)
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   const handler = (req, reply) => { reply.send({}) }
 
   const onRouteChecks = [
@@ -1073,6 +1087,7 @@ test('onSend hook is called after payload is serialized and headers are set', t
     })
 
     instance.get('/stream', (request, reply) => {
+      reply.header('content-type', 'application/octet-stream')
       reply.send(thePayload)
     })
 
@@ -2213,7 +2228,7 @@ test('request in onRequest, preParsing, preValidation and onResponse', t => {
   const fastify = Fastify()
 
   fastify.addHook('onRequest', function (request, reply, done) {
-    t.same(request.body, null)
+    t.same(request.body, undefined)
     t.same(request.query, { key: 'value' })
     t.same(request.params, { greeting: 'hello' })
     t.same(request.headers, {
@@ -2227,7 +2242,7 @@ test('request in onRequest, preParsing, preValidation and onResponse', t => {
   })
 
   fastify.addHook('preParsing', function (request, reply, payload, done) {
-    t.same(request.body, null)
+    t.same(request.body, undefined)
     t.same(request.query, { key: 'value' })
     t.same(request.params, { greeting: 'hello' })
     t.same(request.headers, {
@@ -2469,19 +2484,20 @@ test('onError hook with setErrorHandler', t => {
 
     const fastify = Fastify()
 
-    const err = new Error('ouch')
+    const external = new Error('ouch')
+    const internal = new Error('kaboom')
 
     fastify.setErrorHandler((_, req, reply) => {
-      reply.send(err)
+      reply.send(external)
     })
 
     fastify.addHook('onError', (request, reply, error, done) => {
-      t.match(error, err)
+      t.match(error, internal)
       done()
     })
 
     fastify.get('/', (req, reply) => {
-      reply.send(new Error('kaboom'))
+      reply.send(internal)
     })
 
     fastify.inject({
@@ -2497,34 +2513,6 @@ test('onError hook with setErrorHandler', t => {
     })
   })
 
-  t.test('Hide error', t => {
-    t.plan(2)
-
-    const fastify = Fastify()
-
-    fastify.setErrorHandler((_, req, reply) => {
-      reply.send({ hello: 'world' })
-    })
-
-    fastify.addHook('onError', (request, reply, error, done) => {
-      t.fail('Should not be called')
-    })
-
-    fastify.get('/', (req, reply) => {
-      reply.send(new Error('kaboom'))
-    })
-
-    fastify.inject({
-      method: 'GET',
-      url: '/'
-    }, (err, res) => {
-      t.error(err)
-      t.same(
-        JSON.parse(res.payload),
-        { hello: 'world' }
-      )
-    })
-  })
   t.end()
 })
 
@@ -2566,37 +2554,6 @@ test('preParsing hook should run before parsing and be able to modify the payloa
   })
 })
 
-test('preParsing hooks can completely ignore the payload - deprecated syntax', t => {
-  t.plan(5)
-  const fastify = Fastify()
-
-  process.on('warning', onWarning)
-  warning.emitted.delete('FSTDEP004')
-
-  function onWarning (warning) {
-    t.equal(warning.name, 'FastifyDeprecation')
-    t.equal(warning.code, 'FSTDEP004')
-  }
-
-  fastify.addHook('preParsing', (req, reply, done) => {
-    done()
-  })
-
-  fastify.post('/', function (request, reply) {
-    reply.send(request.body)
-  })
-
-  fastify.inject({
-    method: 'POST',
-    url: '/',
-    payload: { hello: 'world' }
-  }, (err, res) => {
-    t.error(err)
-    t.equal(res.statusCode, 200)
-    t.same(JSON.parse(res.payload), { hello: 'world' })
-  })
-})
-
 test('preParsing hooks should run in the order in which they are defined', t => {
   t.plan(5)
   const fastify = Fastify()
@@ -3198,10 +3155,11 @@ test('onTimeout should be triggered', t => {
   })
 
   fastify.get('/', async (req, reply) => {
-    reply.send({ hello: 'world' })
+    await reply.send({ hello: 'world' })
   })
 
   fastify.get('/timeout', async (req, reply) => {
+    return reply
   })
 
   fastify.listen(0, (err, address) => {
@@ -3236,10 +3194,11 @@ test('onTimeout should be triggered and socket _meta is set', t => {
 
   fastify.get('/', async (req, reply) => {
     req.raw.socket._meta = {}
-    reply.send({ hello: 'world' })
+    return reply.send({ hello: 'world' })
   })
 
   fastify.get('/timeout', async (req, reply) => {
+    return reply
   })
 
   fastify.listen(0, (err, address) => {