fastify 4.19.2 → 4.21.0

package/test/internals/hookRunner.test.js

@@ -2,12 +2,14 @@
 
 const t = require('tap')
 const test = t.test
-const { hookRunner, onSendHookRunner } = require('../../lib/hooks')
+const { hookRunnerGenerator, onSendHookRunner } = require('../../lib/hooks')
 
 test('hookRunner - Basic', t => {
   t.plan(9)
 
-  hookRunner([fn1, fn2, fn3], iterator, 'a', 'b', done)
+  const hookRunner = hookRunnerGenerator(iterator)
+
+  hookRunner([fn1, fn2, fn3], 'a', 'b', done)
 
   function iterator (fn, a, b, done) {
     return fn(a, b, done)
@@ -41,7 +43,9 @@ test('hookRunner - Basic', t => {
 test('hookRunner - In case of error should skip to done', t => {
   t.plan(7)
 
-  hookRunner([fn1, fn2, fn3], iterator, 'a', 'b', done)
+  const hookRunner = hookRunnerGenerator(iterator)
+
+  hookRunner([fn1, fn2, fn3], 'a', 'b', done)
 
   function iterator (fn, a, b, done) {
     return fn(a, b, done)
@@ -73,7 +77,9 @@ test('hookRunner - In case of error should skip to done', t => {
 test('hookRunner - Should handle throw', t => {
   t.plan(7)
 
-  hookRunner([fn1, fn2, fn3], iterator, 'a', 'b', done)
+  const hookRunner = hookRunnerGenerator(iterator)
+
+  hookRunner([fn1, fn2, fn3], 'a', 'b', done)
 
   function iterator (fn, a, b, done) {
     return fn(a, b, done)
@@ -105,7 +111,9 @@ test('hookRunner - Should handle throw', t => {
 test('hookRunner - Should handle promises', t => {
   t.plan(9)
 
-  hookRunner([fn1, fn2, fn3], iterator, 'a', 'b', done)
+  const hookRunner = hookRunnerGenerator(iterator)
+
+  hookRunner([fn1, fn2, fn3], 'a', 'b', done)
 
   function iterator (fn, a, b, done) {
     return fn(a, b, done)
@@ -139,7 +147,9 @@ test('hookRunner - Should handle promises', t => {
 test('hookRunner - In case of error should skip to done (with promises)', t => {
   t.plan(7)
 
-  hookRunner([fn1, fn2, fn3], iterator, 'a', 'b', done)
+  const hookRunner = hookRunnerGenerator(iterator)
+
+  hookRunner([fn1, fn2, fn3], 'a', 'b', done)
 
   function iterator (fn, a, b, done) {
     return fn(a, b, done)
@@ -171,8 +181,10 @@ test('hookRunner - In case of error should skip to done (with promises)', t => {
 test('hookRunner - Be able to exit before its natural end', t => {
   t.plan(4)
 
+  const hookRunner = hookRunnerGenerator(iterator)
+
   let shouldStop = false
-  hookRunner([fn1, fn2, fn3], iterator, 'a', 'b', done)
+  hookRunner([fn1, fn2, fn3], 'a', 'b', done)
 
   function iterator (fn, a, b, done) {
     if (shouldStop) {
@@ -208,7 +220,9 @@ test('hookRunner - Promises that resolve to a value do not change the state', t
 
   const originalState = { a: 'a', b: 'b' }
 
-  hookRunner([fn1, fn2, fn3], iterator, originalState, 'b', done)
+  const hookRunner = hookRunnerGenerator(iterator)
+
+  hookRunner([fn1, fn2, fn3], originalState, 'b', done)
 
   function iterator (fn, state, b, done) {
     return fn(state, b, done)

package/test/internals/initialConfig.test.js

@@ -55,7 +55,7 @@ test('without options passed to Fastify, initialConfig should expose default val
 })
 
 test('Fastify.initialConfig should expose all options', t => {
-  t.plan(20)
+  t.plan(21)
 
   const serverFactory = (handler, opts) => {
     const server = http.createServer((req, res) => {
@@ -132,6 +132,7 @@ test('Fastify.initialConfig should expose all options', t => {
   t.equal(fastify.initialConfig.serverFactory, undefined)
   t.equal(fastify.initialConfig.trustProxy, undefined)
   t.equal(fastify.initialConfig.genReqId, undefined)
+  t.equal(fastify.initialConfig.childLoggerFactory, undefined)
   t.equal(fastify.initialConfig.querystringParser, undefined)
   t.equal(fastify.initialConfig.logger, undefined)
   t.equal(fastify.initialConfig.trustProxy, undefined)
@@ -243,7 +244,7 @@ test('Original options must not be altered (test deep cloning)', t => {
 })
 
 test('Should not have issues when passing stream options to Pino.js', t => {
-  t.plan(15)
+  t.plan(17)
 
   const stream = split(JSON.parse)
 
@@ -259,6 +260,10 @@ test('Should not have issues when passing stream options to Pino.js', t => {
 
   try {
     fastify = Fastify(originalOptions)
+    fastify.setChildLoggerFactory(function (logger, bindings, opts) {
+      bindings.someBinding = 'value'
+      return logger.child(bindings, opts)
+    })
 
     t.type(fastify, 'object')
     t.same(fastify.initialConfig, {
@@ -297,6 +302,7 @@ test('Should not have issues when passing stream options to Pino.js', t => {
     stream.once('data', line => {
       const id = line.reqId
       t.ok(line.reqId, 'reqId is defined')
+      t.equal(line.someBinding, 'value', 'child logger binding is set')
       t.ok(line.req, 'req is defined')
       t.equal(line.msg, 'incoming request', 'message is set')
       t.equal(line.req.method, 'GET', 'method is get')
@@ -304,6 +310,7 @@ test('Should not have issues when passing stream options to Pino.js', t => {
       stream.once('data', line => {
         t.equal(line.reqId, id)
         t.ok(line.reqId, 'reqId is defined')
+        t.equal(line.someBinding, 'value', 'child logger binding is set')
         t.ok(line.res, 'res is defined')
         t.equal(line.msg, 'request completed', 'message is set')
         t.equal(line.res.statusCode, 200, 'statusCode is 200')

package/test/internals/reply.test.js

@@ -6,6 +6,7 @@ const sget = require('simple-get').concat
 const http = require('http')
 const NotFound = require('http-errors').NotFound
 const Reply = require('../../lib/reply')
+const Fastify = require('../..')
 const { Readable, Writable } = require('stream')
 const {
   kReplyErrorHandlerCalled,
@@ -19,9 +20,11 @@ const fs = require('fs')
 const path = require('path')
 const warning = require('../../lib/warnings')
 
+const agent = new http.Agent({ keepAlive: false })
+
 const doGet = function (url) {
   return new Promise((resolve, reject) => {
-    sget({ method: 'GET', url, followRedirects: false }, (err, response, body) => {
+    sget({ method: 'GET', url, followRedirects: false, agent }, (err, response, body) => {
       if (err) {
         reject(err)
       } else {
@@ -128,7 +131,8 @@ test('reply.serializer should set a custom serializer', t => {
 
 test('reply.serializer should support running preSerialization hooks', t => {
   t.plan(3)
-  const fastify = require('../..')()
+  const fastify = Fastify()
+  t.teardown(fastify.close.bind(fastify))
 
   fastify.addHook('preSerialization', async (request, reply, payload) => { t.ok('called', 'preSerialization') })
   fastify.route({
@@ -182,7 +186,8 @@ test('reply.serialize should serialize payload with a context default serializer
 
 test('reply.serialize should serialize payload with Fastify instance', t => {
   t.plan(2)
-  const fastify = require('../..')()
+  const fastify = Fastify()
+  t.teardown(fastify.close.bind(fastify))
   fastify.route({
     method: 'GET',
     url: '/',
@@ -213,7 +218,8 @@ test('reply.serialize should serialize payload with Fastify instance', t => {
 })
 
 test('within an instance', t => {
-  const fastify = require('../..')()
+  const fastify = Fastify()
+  t.teardown(fastify.close.bind(fastify))
   const test = t.test
 
   fastify.get('/', function (req, reply) {
@@ -434,7 +440,7 @@ test('within an instance', t => {
 test('buffer without content type should send a application/octet-stream and raw buffer', t => {
   t.plan(4)
 
-  const fastify = require('../..')()
+  const fastify = Fastify()
 
   fastify.get('/', function (req, reply) {
     reply.send(Buffer.alloc(1024))
@@ -457,7 +463,7 @@ test('buffer without content type should send a application/octet-stream and raw
 test('Uint8Array without content type should send a application/octet-stream and raw buffer', t => {
   t.plan(4)
 
-  const fastify = require('../..')()
+  const fastify = Fastify()
 
   fastify.get('/', function (req, reply) {
     reply.send(new Uint8Array(1024).fill(0xff))
@@ -480,7 +486,7 @@ test('Uint8Array without content type should send a application/octet-stream and
 test('Uint16Array without content type should send a application/octet-stream and raw buffer', t => {
   t.plan(4)
 
-  const fastify = require('../..')()
+  const fastify = Fastify()
 
   fastify.get('/', function (req, reply) {
     reply.send(new Uint16Array(50).fill(0xffffffff))
@@ -503,7 +509,7 @@ test('Uint16Array without content type should send a application/octet-stream an
 test('TypedArray with content type should not send application/octet-stream', t => {
   t.plan(4)
 
-  const fastify = require('../..')()
+  const fastify = Fastify()
 
   fastify.get('/', function (req, reply) {
     reply.header('Content-Type', 'text/plain')
@@ -527,7 +533,7 @@ test('TypedArray with content type should not send application/octet-stream', t
 test('buffer with content type should not send application/octet-stream', t => {
   t.plan(4)
 
-  const fastify = require('../..')()
+  const fastify = Fastify()
 
   fastify.get('/', function (req, reply) {
     reply.header('Content-Type', 'text/plain')
@@ -552,7 +558,7 @@ test('buffer with content type should not send application/octet-stream', t => {
 test('stream with content type should not send application/octet-stream', t => {
   t.plan(4)
 
-  const fastify = require('../..')()
+  const fastify = Fastify()
 
   const streamPath = path.join(__dirname, '..', '..', 'package.json')
   const stream = fs.createReadStream(streamPath)
@@ -579,7 +585,7 @@ test('stream with content type should not send application/octet-stream', t => {
 test('stream without content type should not send application/octet-stream', t => {
   t.plan(4)
 
-  const fastify = require('../..')()
+  const fastify = Fastify()
 
   const stream = fs.createReadStream(__filename)
   const buf = fs.readFileSync(__filename)
@@ -605,7 +611,7 @@ test('stream without content type should not send application/octet-stream', t =
 test('stream using reply.raw.writeHead should return customize headers', t => {
   t.plan(6)
 
-  const fastify = require('../..')()
+  const fastify = Fastify()
   const fs = require('fs')
   const path = require('path')
 
@@ -641,7 +647,7 @@ test('stream using reply.raw.writeHead should return customize headers', t => {
 test('plain string without content type should send a text/plain', t => {
   t.plan(4)
 
-  const fastify = require('../..')()
+  const fastify = Fastify()
 
   fastify.get('/', function (req, reply) {
     reply.send('hello world!')
@@ -665,7 +671,7 @@ test('plain string without content type should send a text/plain', t => {
 test('plain string with content type should be sent unmodified', t => {
   t.plan(4)
 
-  const fastify = require('../..')()
+  const fastify = Fastify()
 
   fastify.get('/', function (req, reply) {
     reply.type('text/css').send('hello world!')
@@ -689,7 +695,7 @@ test('plain string with content type should be sent unmodified', t => {
 test('plain string with content type and custom serializer should be serialized', t => {
   t.plan(4)
 
-  const fastify = require('../..')()
+  const fastify = Fastify()
 
   fastify.get('/', function (req, reply) {
     reply
@@ -716,7 +722,7 @@ test('plain string with content type and custom serializer should be serialized'
 test('plain string with content type application/json should NOT be serialized as json', t => {
   t.plan(4)
 
-  const fastify = require('../..')()
+  const fastify = Fastify()
 
   fastify.get('/', function (req, reply) {
     reply.type('application/json').send('{"key": "hello world!"}')
@@ -740,7 +746,7 @@ test('plain string with content type application/json should NOT be serialized a
 test('plain string with custom json content type should NOT be serialized as json', t => {
   t.plan(19)
 
-  const fastify = require('../..')()
+  const fastify = Fastify()
 
   const customSamples = {
     collectionjson: {
@@ -795,7 +801,7 @@ test('plain string with custom json content type should NOT be serialized as jso
 test('non-string with content type application/json SHOULD be serialized as json', t => {
   t.plan(4)
 
-  const fastify = require('../..')()
+  const fastify = Fastify()
 
   fastify.get('/', function (req, reply) {
     reply.type('application/json').send({ key: 'hello world!' })
@@ -819,7 +825,7 @@ test('non-string with content type application/json SHOULD be serialized as json
 test('non-string with custom json\'s content-type SHOULD be serialized as json', t => {
   t.plan(4)
 
-  const fastify = require('../..')()
+  const fastify = Fastify()
 
   fastify.get('/', function (req, reply) {
     reply.type('application/json; version=2; ').send({ key: 'hello world!' })
@@ -843,7 +849,7 @@ test('non-string with custom json\'s content-type SHOULD be serialized as json',
 test('non-string with custom json content type SHOULD be serialized as json', t => {
   t.plan(16)
 
-  const fastify = require('../..')()
+  const fastify = Fastify()
 
   const customSamples = {
     collectionjson: {
@@ -894,7 +900,7 @@ test('non-string with custom json content type SHOULD be serialized as json', t
 test('error object with a content type that is not application/json should work', t => {
   t.plan(6)
 
-  const fastify = require('../..')()
+  const fastify = Fastify()
 
   fastify.get('/text', function (req, reply) {
     reply.type('text/plain')
@@ -928,7 +934,7 @@ test('error object with a content type that is not application/json should work'
 test('undefined payload should be sent as-is', t => {
   t.plan(6)
 
-  const fastify = require('../..')()
+  const fastify = Fastify()
 
   fastify.addHook('onSend', function (request, reply, payload, done) {
     t.equal(payload, undefined)
@@ -958,7 +964,7 @@ test('undefined payload should be sent as-is', t => {
 test('for HEAD method, no body should be sent but content-length should be', t => {
   t.plan(11)
 
-  const fastify = require('../..')()
+  const fastify = Fastify()
   const contentType = 'application/json; charset=utf-8'
   const bodySize = JSON.stringify({ foo: 'bar' }).length
 
@@ -1013,7 +1019,7 @@ test('for HEAD method, no body should be sent but content-length should be', t =
 test('reply.send(new NotFound()) should not invoke the 404 handler', t => {
   t.plan(9)
 
-  const fastify = require('../..')()
+  const fastify = Fastify()
 
   fastify.setNotFoundHandler((req, reply) => {
     t.fail('Should not be called')
@@ -1389,7 +1395,7 @@ test('Content type and charset set previously', t => {
 
 test('.status() is an alias for .code()', t => {
   t.plan(2)
-  const fastify = require('../..')()
+  const fastify = Fastify()
 
   fastify.get('/', function (req, reply) {
     reply.status(418).send()
@@ -1403,7 +1409,7 @@ test('.status() is an alias for .code()', t => {
 
 test('.statusCode is getter and setter', t => {
   t.plan(4)
-  const fastify = require('../..')()
+  const fastify = Fastify()
 
   fastify.get('/', function (req, reply) {
     t.ok(reply.statusCode, 200, 'default status value')
@@ -1455,7 +1461,7 @@ test('reply.header setting multiple cookies as multiple Set-Cookie headers', t =
 
 test('should emit deprecation warning when trying to modify the reply.sent property', t => {
   t.plan(4)
-  const fastify = require('../..')()
+  const fastify = Fastify()
 
   const deprecationCode = 'FSTDEP010'
   warning.emitted.delete(deprecationCode)
@@ -1483,7 +1489,7 @@ test('should emit deprecation warning when trying to modify the reply.sent prope
 
 test('should throw error when passing falsy value to reply.sent', t => {
   t.plan(4)
-  const fastify = require('../..')()
+  const fastify = Fastify()
 
   fastify.get('/', function (req, reply) {
     try {
@@ -1502,8 +1508,8 @@ test('should throw error when passing falsy value to reply.sent', t => {
 })
 
 test('should throw error when attempting to set reply.sent more than once', t => {
-  t.plan(4)
-  const fastify = require('../..')()
+  t.plan(3)
+  const fastify = Fastify()
 
   fastify.get('/', function (req, reply) {
     reply.sent = true
@@ -1512,7 +1518,6 @@ test('should throw error when attempting to set reply.sent more than once', t =>
       t.fail('must throw')
     } catch (err) {
       t.equal(err.code, 'FST_ERR_REP_ALREADY_SENT')
-      t.equal(err.message, 'Reply was already sent.')
     }
     reply.raw.end()
   })
@@ -1525,7 +1530,7 @@ test('should throw error when attempting to set reply.sent more than once', t =>
 
 test('should not throw error when attempting to set reply.sent if the underlining request was sent', t => {
   t.plan(3)
-  const fastify = require('../..')()
+  const fastify = Fastify()
 
   fastify.get('/', function (req, reply) {
     reply.raw.end()
@@ -1549,7 +1554,7 @@ test('reply.getResponseTime() should return 0 before the timer is initialised on
 
 test('reply.getResponseTime() should return a number greater than 0 after the timer is initialised on the reply by setting up response listeners', t => {
   t.plan(1)
-  const fastify = require('../..')()
+  const fastify = Fastify()
   fastify.route({
     method: 'GET',
     url: '/',
@@ -1568,7 +1573,7 @@ test('reply.getResponseTime() should return a number greater than 0 after the ti
 
 test('reply.getResponseTime() should return the time since a request started while inflight', t => {
   t.plan(1)
-  const fastify = require('../..')()
+  const fastify = Fastify()
   fastify.route({
     method: 'GET',
     url: '/',
@@ -1591,7 +1596,7 @@ test('reply.getResponseTime() should return the time since a request started whi
 
 test('reply.getResponseTime() should return the same value after a request is finished', t => {
   t.plan(1)
-  const fastify = require('../..')()
+  const fastify = Fastify()
   fastify.route({
     method: 'GET',
     url: '/',
@@ -1610,7 +1615,7 @@ test('reply.getResponseTime() should return the same value after a request is fi
 
 test('reply should use the custom serializer', t => {
   t.plan(4)
-  const fastify = require('../..')()
+  const fastify = Fastify()
   fastify.setReplySerializer((payload, statusCode) => {
     t.same(payload, { foo: 'bar' })
     t.equal(statusCode, 200)
@@ -1638,7 +1643,7 @@ test('reply should use the custom serializer', t => {
 test('reply should use the right serializer in encapsulated context', t => {
   t.plan(9)
 
-  const fastify = require('../..')()
+  const fastify = Fastify()
   fastify.setReplySerializer((payload) => {
     t.same(payload, { foo: 'bar' })
     payload.foo = 'bar bar'
@@ -1707,7 +1712,7 @@ test('reply should use the right serializer in encapsulated context', t => {
 test('reply should use the right serializer in deep encapsulated context', t => {
   t.plan(8)
 
-  const fastify = require('../..')()
+  const fastify = Fastify()
 
   fastify.route({
     method: 'GET',
@@ -1771,7 +1776,7 @@ test('reply should use the right serializer in deep encapsulated context', t =>
 test('reply should use the route serializer', t => {
   t.plan(3)
 
-  const fastify = require('../..')()
+  const fastify = Fastify()
   fastify.setReplySerializer(() => {
     t.fail('this serializer should not be executed')
   })
@@ -1802,7 +1807,7 @@ test('reply should use the route serializer', t => {
 test('cannot set the replySerializer when the server is running', t => {
   t.plan(2)
 
-  const fastify = require('../..')()
+  const fastify = Fastify()
   t.teardown(fastify.close.bind(fastify))
 
   fastify.listen({ port: 0 }, err => {
@@ -1819,7 +1824,7 @@ test('cannot set the replySerializer when the server is running', t => {
 test('reply should not call the custom serializer for errors and not found', t => {
   t.plan(9)
 
-  const fastify = require('../..')()
+  const fastify = Fastify()
   fastify.setReplySerializer((payload, statusCode) => {
     t.same(payload, { foo: 'bar' })
     t.equal(statusCode, 200)
@@ -1935,7 +1940,7 @@ test('reply.sent should read from response.writableEnded if it is defined', t =>
 })
 
 test('redirect to an invalid URL should not crash the server', async t => {
-  const fastify = require('../..')()
+  const fastify = Fastify()
   fastify.route({
     method: 'GET',
     url: '/redirect',
@@ -1988,7 +1993,7 @@ test('redirect to an invalid URL should not crash the server', async t => {
 })
 
 test('invalid response headers should not crash the server', async t => {
-  const fastify = require('../..')()
+  const fastify = Fastify()
   fastify.route({
     method: 'GET',
     url: '/bad-headers',
@@ -2021,7 +2026,7 @@ test('invalid response headers should not crash the server', async t => {
 })
 
 test('invalid response headers when sending back an error', async t => {
-  const fastify = require('../..')()
+  const fastify = Fastify()
   fastify.route({
     method: 'GET',
     url: '/bad-headers',
@@ -2050,7 +2055,7 @@ test('invalid response headers when sending back an error', async t => {
 })
 
 test('invalid response headers and custom error handler', async t => {
-  const fastify = require('../..')()
+  const fastify = Fastify()
   fastify.route({
     method: 'GET',
     url: '/bad-headers',
@@ -2082,3 +2087,35 @@ test('invalid response headers and custom error handler', async t => {
 
   await fastify.close()
 })
+
+test('reply.send will intercept ERR_HTTP_HEADERS_SENT and log an error message', t => {
+  t.plan(2)
+
+  const response = new Writable()
+  Object.assign(response, {
+    setHeader: () => {},
+    hasHeader: () => false,
+    getHeader: () => undefined,
+    writeHead: () => {
+      const err = new Error('kaboom')
+      err.code = 'ERR_HTTP_HEADERS_SENT'
+      throw err
+    },
+    write: () => {},
+    headersSent: true
+  })
+
+  const log = {
+    warn: (msg) => {
+      t.equal(msg, 'Reply was already sent, did you forget to "return reply" in the "/hello" (GET) route?')
+    }
+  }
+
+  const reply = new Reply(response, { [kRouteContext]: { onSend: null }, raw: { url: '/hello', method: 'GET' } }, log)
+
+  try {
+    reply.send('')
+  } catch (err) {
+    t.equal(err.code, 'ERR_HTTP_HEADERS_SENT')
+  }
+})