fastify 3.27.3 → 4.0.0-alpha.2

package/test/plugin.test.js

@@ -89,7 +89,7 @@ test('fastify.register with fastify-plugin should not encapsulate his code', t =
     t.notOk(fastify.test)
   })
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
     fastify.server.unref()
 
@@ -168,7 +168,7 @@ test('fastify.register with fastify-plugin should provide access to external fas
     t.notOk(fastify.global)
   })
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
     fastify.server.unref()
 
@@ -223,7 +223,7 @@ test('fastify.register with fastify-plugin registers root level plugins', t => {
     reply.send({ test: fastify.test })
   })
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
     fastify.server.unref()
 
@@ -285,7 +285,7 @@ test('check dependencies - should not throw', t => {
     t.notOk(fastify.otherTest)
   })
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
     fastify.server.unref()
 
@@ -337,7 +337,7 @@ test('check dependencies - should throw', t => {
     t.notOk(fastify.test)
   })
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
     fastify.server.unref()
 
@@ -375,7 +375,7 @@ test('set the plugin name based on the plugin displayName symbol', t => {
     done()
   }, { name: 'plugin-B' }))
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
     fastify.close()
   })
@@ -405,7 +405,7 @@ test('plugin name will change when using no encapsulation', t => {
     done()
   }, { name: 'plugin-A' }))
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
     fastify.close()
   })
@@ -417,7 +417,7 @@ test('plugin name is undefined when accessing in no plugin context', t => {
 
   t.equal(fastify.pluginName, undefined)
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
     fastify.close()
   })
@@ -445,7 +445,7 @@ test('set the plugin name based on the plugin function name', t => {
     done()
   })
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
     fastify.close()
   })
@@ -472,7 +472,7 @@ test('approximate a plugin name when no meta data is available', t => {
     done()
   })
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
     fastify.close()
   })
@@ -495,7 +495,7 @@ test('approximate a plugin name also when fastify-plugin has no meta data', t =>
     done()
   }))
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
     fastify.close()
   })
@@ -535,7 +535,7 @@ test('plugin encapsulation', t => {
     t.notOk(fastify.test)
   })
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
     fastify.server.unref()
 
@@ -569,7 +569,7 @@ test('if a plugin raises an error and there is not a callback to handle it, the
     done(new Error('err'))
   })
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.ok(err instanceof Error)
     t.equal(err.message, 'err')
   })
@@ -612,7 +612,7 @@ test('add hooks after route declaration', t => {
     done()
   })
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
 
     sget({
@@ -651,7 +651,7 @@ test('nested plugins', t => {
     done()
   }, { prefix: '/parent' })
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
 
     sget({
@@ -693,7 +693,7 @@ test('nested plugins awaited', t => {
     }, { prefix: '/child2' })
   }, { prefix: '/parent' })
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
 
     sget({
@@ -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/promises.test.js

@@ -60,7 +60,7 @@ fastify.get('/return-reply', opts, function (req, reply) {
   return reply.send({ hello: 'world' })
 })
 
-fastify.listen(0, err => {
+fastify.listen({ port: 0 }, err => {
   t.error(err)
   fastify.server.unref()
 

package/test/proto-poisoning.test.js

@@ -15,7 +15,7 @@ test('proto-poisoning error', t => {
     t.fail('handler should not be called')
   })
 
-  fastify.listen(0, function (err) {
+  fastify.listen({ port: 0 }, function (err) {
     t.error(err)
 
     sget({
@@ -41,7 +41,7 @@ test('proto-poisoning remove', t => {
     reply.send({ ok: true })
   })
 
-  fastify.listen(0, function (err) {
+  fastify.listen({ port: 0 }, function (err) {
     t.error(err)
 
     sget({
@@ -67,7 +67,7 @@ test('proto-poisoning ignore', t => {
     reply.send({ ok: true })
   })
 
-  fastify.listen(0, function (err) {
+  fastify.listen({ port: 0 }, function (err) {
     t.error(err)
 
     sget({
@@ -92,7 +92,7 @@ test('constructor-poisoning error (default in v3)', t => {
     reply.send('ok')
   })
 
-  fastify.listen(0, function (err) {
+  fastify.listen({ port: 0 }, function (err) {
     t.error(err)
 
     sget({
@@ -117,7 +117,7 @@ test('constructor-poisoning error', t => {
     t.fail('handler should not be called')
   })
 
-  fastify.listen(0, function (err) {
+  fastify.listen({ port: 0 }, function (err) {
     t.error(err)
 
     sget({
@@ -143,7 +143,7 @@ test('constructor-poisoning remove', t => {
     reply.send({ ok: true })
   })
 
-  fastify.listen(0, function (err) {
+  fastify.listen({ port: 0 }, function (err) {
     t.error(err)
 
     sget({

package/test/register.test.js

@@ -38,7 +38,7 @@ test('register', t => {
     done()
   })
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
     fastify.server.unref()
 
@@ -71,7 +71,7 @@ test('internal route declaration should pass the error generated by the register
     reply.send({ hello: 'world' })
   })
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     fastify.close()
     t.equal(err.message, 'kaboom')
   })
@@ -93,7 +93,7 @@ test('internal route declaration should pass the error generated by the register
     t.equal(err.message, 'kaboom')
   })
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     fastify.close()
     t.error(err)
   })

package/test/reply-error.test.js

@@ -107,7 +107,7 @@ test('Should reply 400 on client error', t => {
   t.plan(2)
 
   const fastify = Fastify()
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
 
     const client = net.connect(fastify.server.address().port)
@@ -156,7 +156,7 @@ test('Should set the response from client error handler', t => {
     }
   })
 
-  fastify.listen(0, err => {
+  fastify.listen({ port: 0 }, err => {
     t.error(err)
 
     const client = net.connect(fastify.server.address().port)
@@ -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 => {
@@ -560,7 +671,7 @@ test('setting content-type on reply object should not hang the server case 2', a
   })
 
   try {
-    await fastify.listen(0)
+    await fastify.listen({ port: 0 })
     const res = await fastify.inject({
       url: '/',
       method: 'GET'

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')
@@ -105,7 +105,7 @@ test('default clientError handler ignores ECONNRESET', t => {
     })
   })
 
-  fastify.listen(0, function (err) {
+  fastify.listen({ port: 0 }, function (err) {
     t.error(err)
     fastify.server.unref()
 
@@ -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