node-fastify 5.8.3

package/test/diagnostics-channel/error-status.test.js

@@ -0,0 +1,123 @@
+'use strict'
+
+const { test } = require('node:test')
+const Fastify = require('../..')
+const statusCodes = require('node:http').STATUS_CODES
+const diagnostics = require('node:diagnostics_channel')
+
+test('diagnostics channel error event should report correct status code', async (t) => {
+  t.plan(3)
+  const fastify = Fastify()
+  t.after(() => fastify.close())
+
+  let diagnosticsStatusCode
+
+  const channel = diagnostics.channel('tracing:fastify.request.handler:error')
+  const handler = (msg) => {
+    diagnosticsStatusCode = msg.reply.statusCode
+  }
+  channel.subscribe(handler)
+  t.after(() => channel.unsubscribe(handler))
+
+  fastify.get('/', async () => {
+    const err = new Error('test error')
+    err.statusCode = 503
+    throw err
+  })
+
+  const res = await fastify.inject('/')
+
+  t.assert.strictEqual(res.statusCode, 503)
+  t.assert.strictEqual(diagnosticsStatusCode, 503, 'diagnostics channel should report correct status code')
+  t.assert.strictEqual(diagnosticsStatusCode, res.statusCode, 'diagnostics status should match response status')
+})
+
+test('diagnostics channel error event should report 500 for errors without status', async (t) => {
+  t.plan(3)
+  const fastify = Fastify()
+  t.after(() => fastify.close())
+
+  let diagnosticsStatusCode
+
+  const channel = diagnostics.channel('tracing:fastify.request.handler:error')
+  const handler = (msg) => {
+    diagnosticsStatusCode = msg.reply.statusCode
+  }
+  channel.subscribe(handler)
+  t.after(() => channel.unsubscribe(handler))
+
+  fastify.get('/', async () => {
+    throw new Error('plain error without status')
+  })
+
+  const res = await fastify.inject('/')
+
+  t.assert.strictEqual(res.statusCode, 500)
+  t.assert.strictEqual(diagnosticsStatusCode, 500, 'diagnostics channel should report 500 for plain errors')
+  t.assert.strictEqual(diagnosticsStatusCode, res.statusCode, 'diagnostics status should match response status')
+})
+
+test('diagnostics channel error event should report correct status with custom error handler', async (t) => {
+  t.plan(3)
+  const fastify = Fastify()
+  t.after(() => fastify.close())
+
+  let diagnosticsStatusCode
+
+  const channel = diagnostics.channel('tracing:fastify.request.handler:error')
+  const handler = (msg) => {
+    diagnosticsStatusCode = msg.reply.statusCode
+  }
+  channel.subscribe(handler)
+  t.after(() => channel.unsubscribe(handler))
+
+  fastify.setErrorHandler((error, request, reply) => {
+    reply.status(503).send({ error: error.message })
+  })
+
+  fastify.get('/', async () => {
+    throw new Error('handler error')
+  })
+
+  const res = await fastify.inject('/')
+
+  // Note: The diagnostics channel fires before the custom error handler runs,
+  // so it reports 500 (default) rather than 503 (set by custom handler).
+  // This is expected behavior - the error channel reports the initial error state.
+  t.assert.strictEqual(res.statusCode, 503)
+  t.assert.strictEqual(diagnosticsStatusCode, 500, 'diagnostics channel reports status before custom handler')
+  t.assert.notStrictEqual(diagnosticsStatusCode, res.statusCode, 'custom handler can change status after diagnostics')
+})
+
+test('Error.status property support', (t, done) => {
+  t.plan(4)
+  const fastify = Fastify()
+  t.after(() => fastify.close())
+  const err = new Error('winter is coming')
+  err.status = 418
+
+  diagnostics.subscribe('tracing:fastify.request.handler:error', (msg) => {
+    t.assert.strictEqual(msg.error.message, 'winter is coming')
+  })
+
+  fastify.get('/', () => {
+    return Promise.reject(err)
+  })
+
+  fastify.inject({
+    method: 'GET',
+    url: '/'
+  }, (error, res) => {
+    t.assert.ifError(error)
+    t.assert.strictEqual(res.statusCode, 418)
+    t.assert.deepStrictEqual(
+      {
+        error: statusCodes['418'],
+        message: err.message,
+        statusCode: 418
+      },
+      JSON.parse(res.payload)
+    )
+    done()
+  })
+})

package/test/diagnostics-channel/init.test.js

@@ -0,0 +1,50 @@
+'use strict'
+
+const { test } = require('node:test')
+const proxyquire = require('proxyquire')
+
+test('diagnostics_channel when present and subscribers', t => {
+  t.plan(3)
+
+  let fastifyInHook
+
+  const diagnostics = {
+    channel (name) {
+      t.assert.strictEqual(name, 'fastify.initialization')
+      return {
+        hasSubscribers: true,
+        publish (event) {
+          t.assert.ok(event.fastify)
+          fastifyInHook = event.fastify
+        }
+      }
+    },
+    '@noCallThru': true
+  }
+
+  const fastify = proxyquire('../../fastify', {
+    'node:diagnostics_channel': diagnostics
+  })()
+  t.assert.strictEqual(fastifyInHook, fastify)
+})
+
+test('diagnostics_channel when present and no subscribers', t => {
+  t.plan(1)
+
+  const diagnostics = {
+    channel (name) {
+      t.assert.strictEqual(name, 'fastify.initialization')
+      return {
+        hasSubscribers: false,
+        publish () {
+          t.assert.fail('publish should not be called')
+        }
+      }
+    },
+    '@noCallThru': true
+  }
+
+  proxyquire('../../fastify', {
+    'node:diagnostics_channel': diagnostics
+  })()
+})

package/test/diagnostics-channel/sync-delay-request.test.js

@@ -0,0 +1,49 @@
+'use strict'
+
+const { test } = require('node:test')
+const diagnostics = require('node:diagnostics_channel')
+const Fastify = require('../..')
+const Request = require('../../lib/request')
+const Reply = require('../../lib/reply')
+
+test('diagnostics channel sync events fire in expected order', async t => {
+  t.plan(10)
+  let callOrder = 0
+  let firstEncounteredMessage
+
+  diagnostics.subscribe('tracing:fastify.request.handler:start', (msg) => {
+    t.assert.strictEqual(callOrder++, 0)
+    firstEncounteredMessage = msg
+    t.assert.ok(msg.request instanceof Request)
+    t.assert.ok(msg.reply instanceof Reply)
+  })
+
+  diagnostics.subscribe('tracing:fastify.request.handler:end', (msg) => {
+    t.assert.ok(msg.request instanceof Request)
+    t.assert.ok(msg.reply instanceof Reply)
+    t.assert.strictEqual(callOrder++, 1)
+    t.assert.strictEqual(msg, firstEncounteredMessage)
+  })
+
+  diagnostics.subscribe('tracing:fastify.request.handler:error', (msg) => {
+    t.assert.fail('should not trigger error channel')
+  })
+
+  const fastify = Fastify()
+  fastify.route({
+    method: 'GET',
+    url: '/',
+    handler: function (req, reply) {
+      setImmediate(() => reply.send({ hello: 'world' }))
+    }
+  })
+
+  t.after(() => { fastify.close() })
+
+  const fastifyServer = await fastify.listen({ port: 0 })
+
+  const result = await fetch(fastifyServer + '/')
+  t.assert.ok(result.ok)
+  t.assert.strictEqual(result.status, 200)
+  t.assert.deepStrictEqual(await result.json(), { hello: 'world' })
+})

package/test/diagnostics-channel/sync-request-reply.test.js

@@ -0,0 +1,51 @@
+'use strict'
+
+const { test } = require('node:test')
+const diagnostics = require('node:diagnostics_channel')
+const Fastify = require('../..')
+const Request = require('../../lib/request')
+const Reply = require('../../lib/reply')
+
+test('diagnostics channel sync events fire in expected order', async t => {
+  t.plan(10)
+  let callOrder = 0
+  let firstEncounteredMessage
+
+  diagnostics.subscribe('tracing:fastify.request.handler:start', (msg) => {
+    t.assert.strictEqual(callOrder++, 0)
+    firstEncounteredMessage = msg
+    t.assert.ok(msg.request instanceof Request)
+    t.assert.ok(msg.reply instanceof Reply)
+  })
+
+  diagnostics.subscribe('tracing:fastify.request.handler:end', (msg) => {
+    t.assert.ok(msg.request instanceof Request)
+    t.assert.ok(msg.reply instanceof Reply)
+    t.assert.strictEqual(callOrder++, 1)
+    t.assert.strictEqual(msg, firstEncounteredMessage)
+  })
+
+  diagnostics.subscribe('tracing:fastify.request.handler:error', (msg) => {
+    t.assert.fail('should not trigger error channel')
+  })
+
+  const fastify = Fastify()
+  fastify.route({
+    method: 'GET',
+    url: '/',
+    handler: function (req, reply) {
+      reply.send({ hello: 'world' })
+    }
+  })
+
+  const fastifyServer = await fastify.listen({ port: 0 })
+  t.after(() => { fastify.close() })
+
+  const response = await fetch(fastifyServer, {
+    method: 'GET'
+  })
+  t.assert.ok(response.ok)
+  t.assert.strictEqual(response.status, 200)
+  const body = await response.text()
+  t.assert.deepStrictEqual(JSON.parse(body), { hello: 'world' })
+})

package/test/diagnostics-channel/sync-request.test.js

@@ -0,0 +1,54 @@
+'use strict'
+
+const { test } = require('node:test')
+const diagnostics = require('node:diagnostics_channel')
+const Fastify = require('../..')
+const Request = require('../../lib/request')
+const Reply = require('../../lib/reply')
+
+test('diagnostics channel sync events fire in expected order', async t => {
+  t.plan(13)
+  let callOrder = 0
+  let firstEncounteredMessage
+
+  diagnostics.subscribe('tracing:fastify.request.handler:start', (msg) => {
+    t.assert.strictEqual(callOrder++, 0)
+    firstEncounteredMessage = msg
+    t.assert.ok(msg.request instanceof Request)
+    t.assert.ok(msg.reply instanceof Reply)
+    t.assert.ok(msg.route)
+    t.assert.strictEqual(msg.route.url, '/:id')
+    t.assert.strictEqual(msg.route.method, 'GET')
+  })
+
+  diagnostics.subscribe('tracing:fastify.request.handler:end', (msg) => {
+    t.assert.ok(msg.request instanceof Request)
+    t.assert.ok(msg.reply instanceof Reply)
+    t.assert.strictEqual(callOrder++, 1)
+    t.assert.strictEqual(msg, firstEncounteredMessage)
+  })
+
+  diagnostics.subscribe('tracing:fastify.request.handler:error', (msg) => {
+    t.assert.fail('should not trigger error channel')
+  })
+
+  const fastify = Fastify()
+  fastify.route({
+    method: 'GET',
+    url: '/:id',
+    handler: function (req, reply) {
+      return { hello: 'world' }
+    }
+  })
+
+  const fastifyServer = await fastify.listen({ port: 0 })
+  t.after(() => { fastify.close() })
+
+  const response = await fetch(fastifyServer + '/7', {
+    method: 'GET'
+  })
+  t.assert.ok(response.ok)
+  t.assert.strictEqual(response.status, 200)
+  const body = await response.text()
+  t.assert.deepStrictEqual(JSON.parse(body), { hello: 'world' })
+})

package/test/encapsulated-child-logger-factory.test.js

@@ -0,0 +1,69 @@
+'use strict'
+
+const { test } = require('node:test')
+const Fastify = require('..')
+const fp = require('fastify-plugin')
+
+test('encapsulates an child logger factory', async t => {
+  t.plan(4)
+
+  const fastify = Fastify()
+  fastify.register(async function (fastify) {
+    fastify.setChildLoggerFactory(function pluginFactory (logger, bindings, opts) {
+      const child = logger.child(bindings, opts)
+      child.customLog = function (message) {
+        t.assert.strictEqual(message, 'custom')
+      }
+      return child
+    })
+    fastify.get('/encapsulated', async (req) => {
+      req.log.customLog('custom')
+    })
+  })
+
+  fastify.setChildLoggerFactory(function globalFactory (logger, bindings, opts) {
+    const child = logger.child(bindings, opts)
+    child.globalLog = function (message) {
+      t.assert.strictEqual(message, 'global')
+    }
+    return child
+  })
+  fastify.get('/not-encapsulated', async (req) => {
+    req.log.globalLog('global')
+  })
+
+  const res1 = await fastify.inject('/encapsulated')
+  t.assert.strictEqual(res1.statusCode, 200)
+
+  const res2 = await fastify.inject('/not-encapsulated')
+  t.assert.strictEqual(res2.statusCode, 200)
+})
+
+test('child logger factory set on root scope when using fastify-plugin', async t => {
+  t.plan(4)
+
+  const fastify = Fastify()
+  fastify.register(fp(async function (fastify) {
+    // Using fastify-plugin, the factory should be set on the root scope
+    fastify.setChildLoggerFactory(function pluginFactory (logger, bindings, opts) {
+      const child = logger.child(bindings, opts)
+      child.customLog = function (message) {
+        t.assert.strictEqual(message, 'custom')
+      }
+      return child
+    })
+    fastify.get('/not-encapsulated-1', async (req) => {
+      req.log.customLog('custom')
+    })
+  }))
+
+  fastify.get('/not-encapsulated-2', async (req) => {
+    req.log.customLog('custom')
+  })
+
+  const res1 = await fastify.inject('/not-encapsulated-1')
+  t.assert.strictEqual(res1.statusCode, 200)
+
+  const res2 = await fastify.inject('/not-encapsulated-2')
+  t.assert.strictEqual(res2.statusCode, 200)
+})

package/test/encapsulated-error-handler.test.js

@@ -0,0 +1,237 @@
+'use strict'
+
+const { test } = require('node:test')
+const Fastify = require('..')
+
+// Because of how error handlers wrap things, following the control flow can be tricky
+// In this test file numbered comments indicate the order statements are expected to execute
+
+test('encapsulates an asynchronous error handler', async t => {
+  t.plan(3)
+
+  const fastify = Fastify()
+  fastify.register(async function (fastify) {
+    fastify.setErrorHandler(async function a (err) {
+      // 3. the inner error handler catches the error, and throws a new error
+      t.assert.strictEqual(err.message, 'from_endpoint')
+      throw new Error('from_inner')
+    })
+    fastify.get('/encapsulated', async () => {
+      // 2. the endpoint throws an error
+      throw new Error('from_endpoint')
+    })
+  })
+
+  fastify.setErrorHandler(async function b (err) {
+    // 4. the outer error handler catches the error thrown by the inner error handler
+    t.assert.strictEqual(err.message, 'from_inner')
+    // 5. the outer error handler throws a new error
+    throw new Error('from_outer')
+  })
+
+  // 1. the endpoint is called
+  const res = await fastify.inject('/encapsulated')
+  // 6. the default error handler returns the error from the outer error handler
+  t.assert.strictEqual(res.json().message, 'from_outer')
+})
+
+// See discussion in https://github.com/fastify/fastify/pull/5222#discussion_r1432573655
+test('encapsulates a synchronous error handler', async t => {
+  t.plan(3)
+
+  const fastify = Fastify()
+  fastify.register(async function (fastify) {
+    fastify.setErrorHandler(function a (err) {
+      // 3. the inner error handler catches the error, and throws a new error
+      t.assert.strictEqual(err.message, 'from_endpoint')
+      throw new Error('from_inner')
+    })
+    fastify.get('/encapsulated', async () => {
+      // 2. the endpoint throws an error
+      throw new Error('from_endpoint')
+    })
+  })
+
+  fastify.setErrorHandler(async function b (err) {
+    // 4. the outer error handler catches the error thrown by the inner error handler
+    t.assert.strictEqual(err.message, 'from_inner')
+    // 5. the outer error handler throws a new error
+    throw new Error('from_outer')
+  })
+
+  // 1. the endpoint is called
+  const res = await fastify.inject('/encapsulated')
+  // 6. the default error handler returns the error from the outer error handler
+  t.assert.strictEqual(res.json().message, 'from_outer')
+})
+
+test('onError hook nested', async t => {
+  t.plan(4)
+
+  const fastify = Fastify()
+  fastify.register(async function (fastify) {
+    fastify.setErrorHandler(async function a (err) {
+      // 4. the inner error handler catches the error, and throws a new error
+      t.assert.strictEqual(err.message, 'from_endpoint')
+      throw new Error('from_inner')
+    })
+    fastify.get('/encapsulated', async () => {
+      // 2. the endpoint throws an error
+      throw new Error('from_endpoint')
+    })
+  })
+
+  fastify.setErrorHandler(async function b (err) {
+    // 5. the outer error handler catches the error thrown by the inner error handler
+    t.assert.strictEqual(err.message, 'from_inner')
+    // 6. the outer error handler throws a new error
+    throw new Error('from_outer')
+  })
+
+  fastify.addHook('onError', async function (request, reply, err) {
+    // 3. the hook receives the error
+    t.assert.strictEqual(err.message, 'from_endpoint')
+  })
+
+  // 1. the endpoint is called
+  const res = await fastify.inject('/encapsulated')
+  // 7. the default error handler returns the error from the outer error handler
+  t.assert.strictEqual(res.json().message, 'from_outer')
+})
+
+// See https://github.com/fastify/fastify/issues/5220
+test('encapuslates an error handler, for errors thrown in hooks', async t => {
+  t.plan(3)
+
+  const fastify = Fastify()
+  fastify.register(async function (fastify) {
+    fastify.setErrorHandler(function a (err) {
+      // 3. the inner error handler catches the error, and throws a new error
+      t.assert.strictEqual(err.message, 'from_hook')
+      throw new Error('from_inner')
+    })
+    fastify.addHook('onRequest', async () => {
+      // 2. the hook throws an error
+      throw new Error('from_hook')
+    })
+    fastify.get('/encapsulated', async () => {})
+  })
+
+  fastify.setErrorHandler(function b (err) {
+    // 4. the outer error handler catches the error thrown by the inner error handler
+    t.assert.strictEqual(err.message, 'from_inner')
+    // 5. the outer error handler throws a new error
+    throw new Error('from_outer')
+  })
+
+  // 1. the endpoint is called
+  const res = await fastify.inject('/encapsulated')
+  // 6. the default error handler returns the error from the outer error handler
+  t.assert.strictEqual(res.json().message, 'from_outer')
+})
+
+// See https://github.com/fastify/fastify/issues/5220
+test('encapuslates many synchronous error handlers that rethrow errors', async t => {
+  const DEPTH = 100
+  t.plan(DEPTH + 2)
+
+  /**
+   * This creates a very nested set of error handlers, that looks like:
+   * plugin
+   * - error handler
+   * - plugin
+   *   - error handler
+   *   - plugin
+   *     ... {to DEPTH levels}
+   *       - plugin
+   *           - error handler
+   *           - GET /encapsulated
+   */
+  const createNestedRoutes = (fastify, depth) => {
+    if (depth < 0) {
+      throw new Error('Expected depth >= 0')
+    } else if (depth === 0) {
+      fastify.setErrorHandler(function a (err) {
+        // 3. innermost error handler catches the error, and throws a new error
+        t.assert.strictEqual(err.message, 'from_route')
+        throw new Error(`from_handler_${depth}`)
+      })
+      fastify.get('/encapsulated', async () => {
+        // 2. the endpoint throws an error
+        throw new Error('from_route')
+      })
+    } else {
+      fastify.setErrorHandler(function d (err) {
+        // 4 to {DEPTH+4}. error handlers each catch errors, and then throws a new error
+        t.assert.strictEqual(err.message, `from_handler_${depth - 1}`)
+        throw new Error(`from_handler_${depth}`)
+      })
+
+      fastify.register(async function (fastify) {
+        createNestedRoutes(fastify, depth - 1)
+      })
+    }
+  }
+
+  const fastify = Fastify()
+  createNestedRoutes(fastify, DEPTH)
+
+  // 1. the endpoint is called
+  const res = await fastify.inject('/encapsulated')
+  // {DEPTH+5}. the default error handler returns the error from the outermost error handler
+  t.assert.strictEqual(res.json().message, `from_handler_${DEPTH}`)
+})
+
+// See https://github.com/fastify/fastify/issues/5220
+// This was not failing previously, but we want to make sure the behavior continues to work in the same way across async and sync handlers
+// Plus, the current setup is somewhat fragile to tweaks to wrapThenable as that's what retries (by calling res.send(err) again)
+test('encapuslates many asynchronous error handlers that rethrow errors', async t => {
+  const DEPTH = 100
+  t.plan(DEPTH + 2)
+
+  /**
+   * This creates a very nested set of error handlers, that looks like:
+   * plugin
+   * - error handler
+   * - plugin
+   *   - error handler
+   *   - plugin
+   *     ... {to DEPTH levels}
+   *       - plugin
+   *           - error handler
+   *           - GET /encapsulated
+   */
+  const createNestedRoutes = (fastify, depth) => {
+    if (depth < 0) {
+      throw new Error('Expected depth >= 0')
+    } else if (depth === 0) {
+      fastify.setErrorHandler(async function a (err) {
+        // 3. innermost error handler catches the error, and throws a new error
+        t.assert.strictEqual(err.message, 'from_route')
+        throw new Error(`from_handler_${depth}`)
+      })
+      fastify.get('/encapsulated', async () => {
+        // 2. the endpoint throws an error
+        throw new Error('from_route')
+      })
+    } else {
+      fastify.setErrorHandler(async function m (err) {
+        // 4 to {DEPTH+4}. error handlers each catch errors, and then throws a new error
+        t.assert.strictEqual(err.message, `from_handler_${depth - 1}`)
+        throw new Error(`from_handler_${depth}`)
+      })
+
+      fastify.register(async function (fastify) {
+        createNestedRoutes(fastify, depth - 1)
+      })
+    }
+  }
+
+  const fastify = Fastify()
+  createNestedRoutes(fastify, DEPTH)
+
+  // 1. the endpoint is called
+  const res = await fastify.inject('/encapsulated')
+  // {DEPTH+5}. the default error handler returns the error from the outermost error handler
+  t.assert.strictEqual(res.json().message, `from_handler_${DEPTH}`)
+})

package/test/esm/errorCodes.test.mjs

@@ -0,0 +1,10 @@
+import { errorCodes } from '../../fastify.js'
+import { test } from 'node:test'
+
+test('errorCodes in ESM', async t => {
+  // test a custom fastify error using errorCodes with ESM
+  const customError = errorCodes.FST_ERR_VALIDATION('custom error message')
+  t.assert.ok(typeof customError !== 'undefined')
+  t.assert.ok(customError instanceof errorCodes.FST_ERR_VALIDATION)
+  t.assert.strictEqual(customError.message, 'custom error message')
+})

package/test/esm/esm.test.mjs

@@ -0,0 +1,13 @@
+import { test } from 'node:test'
+import Fastify from '../../fastify.js'
+
+test('esm support', async t => {
+  const fastify = Fastify()
+
+  fastify.register(import('./plugin.mjs'), { foo: 'bar' })
+  fastify.register(import('./other.mjs'))
+
+  await fastify.ready()
+
+  t.assert.strictEqual(fastify.foo, 'bar')
+})

package/test/esm/index.test.js

@@ -0,0 +1,8 @@
+'use strict'
+
+import('./named-exports.mjs')
+  .catch(err => {
+    process.nextTick(() => {
+      throw err
+    })
+  })

package/test/esm/named-exports.mjs

@@ -0,0 +1,14 @@
+import { test } from 'node:test'
+import { fastify } from '../../fastify.js'
+
+// This test is executed in index.test.js
+test('named exports support', async t => {
+  const app = fastify()
+
+  app.register(import('./plugin.mjs'), { foo: 'bar' })
+  app.register(import('./other.mjs'))
+
+  await app.ready()
+
+  t.assert.strictEqual(app.foo, 'bar')
+})