fastify 3.27.2 → 4.0.0-alpha.1

package/test/nullable-validation.test.js

@@ -61,8 +61,8 @@ test('object or null body', t => {
     method: 'POST',
     url: '/',
     handler: (req, reply) => {
-      t.equal(req.body, null)
-      reply.code(200).send({ requestBody: req.body })
+      t.equal(req.body, undefined)
+      reply.code(200).send({ isUndefinedBody: req.body === undefined })
     },
     schema: {
       body: {
@@ -79,10 +79,8 @@ test('object or null body', t => {
           type: 'object',
           nullable: true,
           properties: {
-            requestBody: {
-              type: 'string',
-              format: 'email',
-              nullable: true
+            isUndefinedBody: {
+              type: 'boolean'
             }
           }
         }
@@ -100,7 +98,7 @@ test('object or null body', t => {
     }, (err, response, body) => {
       t.error(err)
       t.equal(response.statusCode, 200)
-      t.same(JSON.parse(body), { requestBody: null })
+      t.same(JSON.parse(body), { isUndefinedBody: true })
     })
   })
 })
@@ -114,8 +112,8 @@ test('nullable body', t => {
     method: 'POST',
     url: '/',
     handler: (req, reply) => {
-      t.equal(req.body, null)
-      reply.code(200).send({ requestBody: req.body })
+      t.equal(req.body, undefined)
+      reply.code(200).send({ isUndefinedBody: req.body === undefined })
     },
     schema: {
       body: {
@@ -133,10 +131,8 @@ test('nullable body', t => {
           type: 'object',
           nullable: true,
           properties: {
-            requestBody: {
-              type: 'string',
-              format: 'email',
-              nullable: true
+            isUndefinedBody: {
+              type: 'boolean'
             }
           }
         }
@@ -154,7 +150,48 @@ test('nullable body', t => {
     }, (err, response, body) => {
       t.error(err)
       t.equal(response.statusCode, 200)
-      t.same(JSON.parse(body), { requestBody: null })
+      t.same(JSON.parse(body), { isUndefinedBody: true })
+    })
+  })
+})
+
+test('Nullable body with 204', t => {
+  t.plan(5)
+
+  const fastify = Fastify()
+
+  fastify.route({
+    method: 'POST',
+    url: '/',
+    handler: (req, reply) => {
+      t.equal(req.body, undefined)
+      reply.code(204).send()
+    },
+    schema: {
+      body: {
+        type: 'object',
+        nullable: true,
+        properties: {
+          hello: {
+            type: 'string',
+            format: 'email'
+          }
+        }
+      }
+    }
+  })
+
+  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.equal(response.statusCode, 204)
+      t.equal(body.length, 0)
     })
   })
 })

package/test/plugin.test.js

@@ -864,7 +864,7 @@ test('plugin metadata - dependencies (nested)', t => {
 })
 
 test('pluginTimeout', t => {
-  t.plan(2)
+  t.plan(5)
   const fastify = Fastify({
     pluginTimeout: 10
   })
@@ -873,13 +873,35 @@ test('pluginTimeout', t => {
   })
   fastify.ready((err) => {
     t.ok(err)
-    t.equal(err.code, 'ERR_AVVIO_PLUGIN_TIMEOUT')
+    t.equal(err.message,
+      "fastify-plugin: Plugin did not start in time: 'function (app, opts, done) { -- // to no call done on purpose'. You may have forgotten to call 'done' function or to resolve a Promise")
+    t.equal(err.code, 'FST_ERR_PLUGIN_TIMEOUT')
+    t.ok(err.cause)
+    t.equal(err.cause.code, 'AVV_ERR_READY_TIMEOUT')
+  })
+})
+
+test('pluginTimeout - named function', { only: true }, t => {
+  t.plan(5)
+  const fastify = Fastify({
+    pluginTimeout: 10
+  })
+  fastify.register(function nameFunction (app, opts, done) {
+    // to no call done on purpose
+  })
+  fastify.ready((err) => {
+    t.ok(err)
+    t.equal(err.message,
+      "fastify-plugin: Plugin did not start in time: 'nameFunction'. You may have forgotten to call 'done' function or to resolve a Promise")
+    t.equal(err.code, 'FST_ERR_PLUGIN_TIMEOUT')
+    t.ok(err.cause)
+    t.equal(err.cause.code, 'AVV_ERR_READY_TIMEOUT')
   })
 })
 
 test('pluginTimeout default', t => {
-  t.plan(2)
-  const clock = fakeTimer.install()
+  t.plan(5)
+  const clock = fakeTimer.install({ shouldClearNativeTimers: true })
 
   const fastify = Fastify()
   fastify.register(function (app, opts, done) {
@@ -889,7 +911,11 @@ test('pluginTimeout default', t => {
 
   fastify.ready((err) => {
     t.ok(err)
-    t.equal(err.code, 'ERR_AVVIO_PLUGIN_TIMEOUT')
+    t.equal(err.message,
+      "fastify-plugin: Plugin did not start in time: 'function (app, opts, done) { -- // default time elapsed without calling done'. You may have forgotten to call 'done' function or to resolve a Promise")
+    t.equal(err.code, 'FST_ERR_PLUGIN_TIMEOUT')
+    t.ok(err.cause)
+    t.equal(err.cause.code, 'AVV_ERR_READY_TIMEOUT')
   })
 
   t.teardown(clock.uninstall)

package/test/pretty-print.test.js

@@ -7,7 +7,7 @@ const Fastify = require('..')
 test('pretty print - static routes', t => {
   t.plan(2)
 
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   fastify.get('/test', () => {})
   fastify.get('/test/hello', () => {})
   fastify.get('/hello/world', () => {})
@@ -29,7 +29,7 @@ test('pretty print - static routes', t => {
 test('pretty print - parametric routes', t => {
   t.plan(2)
 
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   fastify.get('/test', () => {})
   fastify.get('/test/:hello', () => {})
   fastify.get('/hello/:world', () => {})
@@ -51,7 +51,7 @@ test('pretty print - parametric routes', t => {
 test('pretty print - mixed parametric routes', t => {
   t.plan(2)
 
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   fastify.get('/test', () => {})
   fastify.get('/test/:hello', () => {})
   fastify.post('/test/:hello', () => {})
@@ -75,7 +75,7 @@ test('pretty print - mixed parametric routes', t => {
 test('pretty print - wildcard routes', t => {
   t.plan(2)
 
-  const fastify = Fastify()
+  const fastify = Fastify({ exposeHeadRoutes: false })
   fastify.get('/test', () => {})
   fastify.get('/test/*', () => {})
   fastify.get('/hello/*', () => {})
@@ -137,12 +137,14 @@ test('pretty print - commonPrefix', t => {
     const radixExpected = `└── /
     ├── hel
     │   ├── lo (GET)
+    │   │   lo (HEAD)
     │   └── icopter (GET)
+    │       icopter (HEAD)
     └── hello (PUT)
 `
     const flatExpected = `└── / (-)
-    ├── helicopter (GET)
-    └── hello (GET, PUT)
+    ├── helicopter (GET, HEAD)
+    └── hello (GET, PUT, HEAD)
 `
     t.equal(typeof radixTree, 'string')
     t.equal(typeof flatTree, 'string')
@@ -174,31 +176,41 @@ test('pretty print - includeMeta, includeHooks', t => {
     │   │   • (onTimeout) ["onTimeout()"]
     │   │   • (onRequest) ["anonymous()"]
     │   │   • (errorHandler) "defaultErrorHandler()"
+    │   │   lo (HEAD)
+    │   │   • (onTimeout) ["onTimeout()"]
+    │   │   • (onRequest) ["anonymous()"]
+    │   │   • (onSend) ["headRouteOnSendHandler()"]
+    │   │   • (errorHandler) "defaultErrorHandler()"
     │   └── icopter (GET)
     │       • (onTimeout) ["onTimeout()"]
     │       • (onRequest) ["anonymous()"]
     │       • (errorHandler) "defaultErrorHandler()"
+    │       icopter (HEAD)
+    │       • (onTimeout) ["onTimeout()"]
+    │       • (onRequest) ["anonymous()"]
+    │       • (onSend) ["headRouteOnSendHandler()"]
+    │       • (errorHandler) "defaultErrorHandler()"
     └── hello (PUT)
         • (onTimeout) ["onTimeout()"]
         • (onRequest) ["anonymous()"]
         • (errorHandler) "defaultErrorHandler()"
 `
     const flatExpected = `└── / (-)
-    ├── helicopter (GET)
+    ├── helicopter (GET, HEAD)
     │   • (onTimeout) ["onTimeout()"]
     │   • (onRequest) ["anonymous()"]
     │   • (errorHandler) "defaultErrorHandler()"
-    └── hello (GET, PUT)
+    └── hello (GET, PUT, HEAD)
         • (onTimeout) ["onTimeout()"]
         • (onRequest) ["anonymous()"]
         • (errorHandler) "defaultErrorHandler()"
 `
 
     const hooksOnlyExpected = `└── / (-)
-    ├── helicopter (GET)
+    ├── helicopter (GET, HEAD)
     │   • (onTimeout) ["onTimeout()"]
     │   • (onRequest) ["anonymous()"]
-    └── hello (GET, PUT)
+    └── hello (GET, PUT, HEAD)
         • (onTimeout) ["onTimeout()"]
         • (onRequest) ["anonymous()"]
 `

package/test/reply-error.test.js

@@ -290,7 +290,7 @@ test('Support rejection with values that are not Error instances', t => {
         } else {
           t.equal(err, nonErr)
         }
-        reply.send('error')
+        reply.code(500).send('error')
       })
 
       fastify.inject({
@@ -337,7 +337,7 @@ test('invalid schema - ajv', t => {
   })
 })
 
-test('should set the status code and the headers from the error object (from route handler)', t => {
+test('should set the status code and the headers from the error object (from route handler) (no custom error handler)', t => {
   t.plan(4)
   const fastify = Fastify()
 
@@ -375,7 +375,7 @@ test('should set the status code and the headers from the error object (from cus
 
   fastify.setErrorHandler((err, request, reply) => {
     t.equal(err.message, 'ouch')
-    t.equal(reply.raw.statusCode, 401)
+    t.equal(reply.raw.statusCode, 200)
     const error = new Error('kaboom')
     error.headers = { hello: 'world' }
     error.statusCode = 400
@@ -446,6 +446,74 @@ test('should throw an error if the custom serializer does not serialize the payl
   })
 })
 
+test('should not set headers or status code for custom error handler', t => {
+  t.plan(7)
+
+  const fastify = Fastify()
+  fastify.get('/', function (req, reply) {
+    const err = new Error('kaboom')
+    err.headers = {
+      'fake-random-header': 'abc'
+    }
+    reply.send(err)
+  })
+
+  fastify.setErrorHandler(async (err, req, res) => {
+    t.equal(res.statusCode, 200)
+    t.equal('fake-random-header' in res.headers, false)
+    return res.code(500).send(err.message)
+  })
+
+  fastify.inject({
+    method: 'GET',
+    url: '/'
+  }, (err, res) => {
+    t.error(err)
+    t.equal(res.statusCode, 500)
+    t.equal('fake-random-header' in res.headers, false)
+    t.equal(res.headers['content-length'], ('kaboom'.length).toString())
+    t.same(res.payload, 'kaboom')
+  })
+})
+
+test('error thrown by custom error handler routes to default error handler', t => {
+  t.plan(6)
+
+  const fastify = Fastify()
+
+  const error = new Error('kaboom')
+  error.headers = {
+    'fake-random-header': 'abc'
+  }
+
+  fastify.get('/', function (req, reply) {
+    reply.send(error)
+  })
+
+  const newError = new Error('kabong')
+
+  fastify.setErrorHandler(async (err, req, res) => {
+    t.equal(res.statusCode, 200)
+    t.equal('fake-random-header' in res.headers, false)
+    t.same(err.headers, error.headers)
+
+    return res.send(newError)
+  })
+
+  fastify.inject({
+    method: 'GET',
+    url: '/'
+  }, (err, res) => {
+    t.error(err)
+    t.equal(res.statusCode, 500)
+    t.same(JSON.parse(res.payload), {
+      error: statusCodes['500'],
+      message: newError.message,
+      statusCode: 500
+    })
+  })
+})
+
 // Issue 2078 https://github.com/fastify/fastify/issues/2078
 // Supported error code list: http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
 const invalidErrorCodes = [
@@ -475,6 +543,34 @@ invalidErrorCodes.forEach((invalidCode) => {
   })
 })
 
+test('error handler is triggered when a string is thrown from sync handler', t => {
+  t.plan(3)
+
+  const fastify = Fastify()
+
+  const throwable = 'test'
+  const payload = 'error'
+
+  fastify.get('/', function (req, reply) {
+    // eslint-disable-next-line no-throw-literal
+    throw throwable
+  })
+
+  fastify.setErrorHandler((err, req, res) => {
+    t.equal(err, throwable)
+
+    res.send(payload)
+  })
+
+  fastify.inject({
+    method: 'GET',
+    url: '/'
+  }, (err, res) => {
+    t.error(err)
+    t.equal(res.payload, payload)
+  })
+})
+
 test('status code should be set to 500 and return an error json payload if route handler throws any non Error object expression', async t => {
   t.plan(2)
   const fastify = Fastify()
@@ -508,24 +604,39 @@ test('should preserve the status code set by the user if an expression is thrown
 })
 
 test('should trigger error handlers if a sync route throws any non-error object', async t => {
-  t.plan(3)
+  t.plan(2)
 
   const fastify = Fastify()
 
-  fastify.get('/', () => {
-    /* eslint-disable-next-line */
-    throw { foo: 'bar' }
+  const throwable = 'test'
+  const payload = 'error'
+
+  fastify.get('/', function async (req, reply) {
+    // eslint-disable-next-line no-throw-literal
+    throw throwable
   })
 
-  fastify.setErrorHandler(async (error) => {
-    t.ok(error)
-    return error
+  fastify.setErrorHandler((err, req, res) => {
+    t.equal(err, throwable)
+    res.code(500).send(payload)
+  })
+
+  const reply = await fastify.inject({ method: 'GET', url: '/' })
+  t.equal(reply.statusCode, 500)
+})
+
+test('should trigger error handlers if a sync route throws undefined', async t => {
+  t.plan(1)
+
+  const fastify = Fastify()
+
+  fastify.get('/', function async (req, reply) {
+    // eslint-disable-next-line no-throw-literal
+    throw undefined
   })
 
-  // ----
   const reply = await fastify.inject({ method: 'GET', url: '/' })
   t.equal(reply.statusCode, 500)
-  t.equal(JSON.parse(reply.body).foo, 'bar')
 })
 
 test('setting content-type on reply object should not hang the server case 1', t => {

package/test/request-error.test.js

@@ -43,7 +43,7 @@ test('default 400 on request error with custom error handler', t => {
 
   fastify.setErrorHandler(function (err, request, reply) {
     t.type(request, 'object')
-    t.type(request, fastify[kRequest])
+    t.type(request, fastify[kRequest].parent)
     reply
       .code(err.statusCode)
       .type('application/json; charset=utf-8')
@@ -132,10 +132,7 @@ test('default clientError handler ignores sockets in destroyed state', t => {
 
   const fastify = Fastify({
     bodyLimit: 1,
-    keepAliveTimeout: 100,
-    logger: {
-      level: 'trace'
-    }
+    keepAliveTimeout: 100
   })
   fastify.server.on('clientError', () => {
     // this handler is called after default handler, so we can make sure end was not called

package/test/route-hooks.test.js

@@ -7,11 +7,11 @@ const Fastify = require('../')
 
 process.removeAllListeners('warning')
 
-function endRouteHook (doneOrPayload, done) {
+function endRouteHook (doneOrPayload, done, doneValue) {
   if (typeof doneOrPayload === 'function') {
-    doneOrPayload()
+    doneOrPayload(doneValue)
   } else {
-    done()
+    done(doneValue)
   }
 }
 
@@ -152,9 +152,9 @@ function testBeforeHandlerHook (hook) {
     const fastify = Fastify()
 
     fastify.post('/', {
-      [hook]: (req, reply, done) => {
+      [hook]: (req, reply, doneOrPayload, done) => {
         req.hello = 'earth'
-        done()
+        endRouteHook(doneOrPayload, done)
       }
     }, (req, reply) => {
       reply.send({ hello: req.hello })
@@ -190,8 +190,8 @@ function testBeforeHandlerHook (hook) {
     const fastify = Fastify()
 
     fastify.post('/', {
-      [hook]: (req, reply, done) => {
-        done(new Error('kaboom'))
+      [hook]: (req, reply, doneOrPayload, done) => {
+        endRouteHook(doneOrPayload, done, new Error('kaboom'))
       }
     }, (req, reply) => {
       reply.send(req.body)
@@ -221,7 +221,7 @@ function testBeforeHandlerHook (hook) {
 
     fastify.setErrorHandler(async (error, request, reply) => {
       t.same(error, myError, 'the error object throws by the user')
-      reply.send({ this: 'is', my: 'error' })
+      return reply.code(500).send({ this: 'is', my: 'error' })
     })
 
     fastify.get('/', {
@@ -271,9 +271,9 @@ function testBeforeHandlerHook (hook) {
     const fastify = Fastify()
 
     fastify.post('/', {
-      [hook]: (req, reply, done) => {
+      [hook]: (req, reply, doneOrPayload, done) => {
         reply.code(401)
-        done(new Error('go away'))
+        endRouteHook(doneOrPayload, done, new Error('go away'))
       }
     }, (req, reply) => {
       reply.send(req.body)
@@ -302,10 +302,10 @@ function testBeforeHandlerHook (hook) {
     fastify.decorate('foo', 42)
 
     fastify.post('/', {
-      [hook]: function (req, reply, done) {
+      [hook]: function (req, reply, doneOrPayload, done) {
         t.equal(this.foo, 42)
         this.foo += 1
-        done()
+        endRouteHook(doneOrPayload, done)
       }
     }, function (req, reply) {
       reply.send({ foo: this.foo })
@@ -329,10 +329,10 @@ function testBeforeHandlerHook (hook) {
     fastify.decorate('foo', 42)
 
     fastify.post('/', {
-      [hook]: [function (req, reply, done) {
+      [hook]: [function (req, reply, doneOrPayload, done) {
         t.equal(this.foo, 42)
         this.foo += 1
-        done()
+        endRouteHook(doneOrPayload, done)
       }]
     }, function (req, reply) {
       reply.send({ foo: this.foo })
@@ -423,7 +423,7 @@ test('preParsing option should be called before preValidation hook', t => {
   })
 
   fastify.post('/', {
-    preParsing: (req, reply, done) => {
+    preParsing: (req, reply, payload, done) => {
       req.called = true
       done()
     }
@@ -473,7 +473,7 @@ test('onRequest option should be called before preParsing', t => {
   t.plan(3)
   const fastify = Fastify()
 
-  fastify.addHook('preParsing', (req, reply, done) => {
+  fastify.addHook('preParsing', (req, reply, payload, done) => {
     t.ok(req.called)
     done()
   })
@@ -503,7 +503,7 @@ test('onTimeout on route', t => {
   const fastify = Fastify({ connectionTimeout: 500 })
 
   fastify.get('/timeout', {
-    async  handler (request, reply) { },
+    handler (request, reply) { },
     onTimeout (request, reply, done) {
       t.pass('onTimeout called')
       done()

package/test/route-prefix.test.js

@@ -565,7 +565,8 @@ test('matches only /prefix/  with a / route - prefixTrailingSlash: "slash", igno
 test('calls onRoute only once when prefixing', async t => {
   t.plan(1)
   const fastify = Fastify({
-    ignoreTrailingSlash: false
+    ignoreTrailingSlash: false,
+    exposeHeadRoutes: false
   })
 
   let onRouteCalled = 0