fastify 5.12.0 → 6.0.0-alpha.1

package/test/internals/logger.test.js

@@ -277,6 +277,19 @@ test('defaultErrorLog should log error for 5xx errors', t => {
   logController.defaultErrorLog(err, request, reply)
 })
 
+test('routeNotFound should not log when logging is disabled', t => {
+  t.plan(1)
+  const logController = new LogController({ disableRequestLogging: request => request.skipLogging })
+  const request = {
+    skipLogging: true,
+    log: {
+      info: () => { t.assert.fail('info should not be called') }
+    }
+  }
+  logController.routeNotFound(request, {})
+  t.assert.ok(true, 'logger was not called')
+})
+
 test('writeHeadError should not log when logging is disabled (boolean)', t => {
   t.plan(1)
   const logController = new LogController({ disableRequestLogging: true })
@@ -369,7 +382,7 @@ test('createLogController should use LogController instance directly', t => {
 
 test('createLogController should create default when no instance provided', t => {
   t.plan(2)
-  const dispatcher = createLogController({ disableRequestLogging: false, requestIdLogLabel: 'reqId' })
+  const dispatcher = createLogController({})
   t.assert.ok(dispatcher instanceof LogController)
   t.assert.strictEqual(dispatcher.requestIdLogLabel, 'reqId')
 })
@@ -377,20 +390,20 @@ test('createLogController should create default when no instance provided', t =>
 test('createLogController should throw on invalid type', t => {
   t.plan(1)
   t.assert.throws(() => {
-    createLogController({ disableRequestLogging: false, logController: 'bad' })
+    createLogController({ logController: 'bad' })
   }, { code: 'FST_ERR_LOG_INVALID_LOG_CONTROLLER' })
 })
 
 test('createLogController should throw when plain object is provided', t => {
   t.plan(1)
   t.assert.throws(() => {
-    createLogController({ disableRequestLogging: false, logController: { incomingRequest: () => { } } })
+    createLogController({ logController: { incomingRequest: () => { } } })
   }, { code: 'FST_ERR_LOG_INVALID_LOG_CONTROLLER' })
 })
 
 test('createLogController should accept null', t => {
   t.plan(1)
-  const logController = createLogController({ disableRequestLogging: false, logController: null })
+  const logController = createLogController({ logController: null })
   t.assert.ok(logController)
 })
 

package/test/internals/reply.test.js

@@ -1700,7 +1700,7 @@ test('cannot set the replySerializer when the server is running', (t, done) => {
       fastify.setReplySerializer(() => { })
       t.assert.fail('this serializer should not be setup')
     } catch (e) {
-      t.assert.strictEqual(e.code, 'FST_ERR_INSTANCE_ALREADY_LISTENING')
+      t.assert.strictEqual(e.code, 'FST_ERR_INSTANCE_ALREADY_STARTED')
     } finally {
       done()
     }

package/test/internals/request.test.js

@@ -40,9 +40,7 @@ test('Regular request', t => {
     server: {
       [kReply]: {},
       [kRequest]: Request,
-      [kOptions]: {
-        requestIdLogLabel: 'reqId'
-      },
+      [kOptions]: {},
       server: {}
     }
   })
@@ -94,9 +92,7 @@ test('Request with undefined config', t => {
     server: {
       [kReply]: {},
       [kRequest]: Request,
-      [kOptions]: {
-        requestIdLogLabel: 'reqId'
-      },
+      [kOptions]: {},
       server: {}
     }
   })
@@ -155,9 +151,7 @@ test('Regular request - hostname from authority', t => {
     server: {
       [kReply]: {},
       [kRequest]: Request,
-      [kOptions]: {
-        requestIdLogLabel: 'reqId'
-      },
+      [kOptions]: {},
       server: {}
     }
   })
@@ -198,9 +192,7 @@ test('Regular request - host header has precedence over authority', t => {
     server: {
       [kReply]: {},
       [kRequest]: Request,
-      [kOptions]: {
-        requestIdLogLabel: 'reqId'
-      },
+      [kOptions]: {},
       server: {}
     }
   })
@@ -240,9 +232,7 @@ test('Request with trust proxy', t => {
     server: {
       [kReply]: {},
       [kRequest]: Request,
-      [kOptions]: {
-        requestIdLogLabel: 'reqId'
-      }
+      [kOptions]: {}
     }
   })
 
@@ -317,9 +307,7 @@ test('Request with trust proxy - no x-forwarded-host header', t => {
     server: {
       [kReply]: {},
       [kRequest]: Request,
-      [kOptions]: {
-        requestIdLogLabel: 'reqId'
-      },
+      [kOptions]: {},
       server: {}
     }
   })
@@ -360,9 +348,7 @@ test('Request with trust proxy - no x-forwarded-host header and fallback to auth
     server: {
       [kReply]: {},
       [kRequest]: Request,
-      [kOptions]: {
-        requestIdLogLabel: 'reqId'
-      },
+      [kOptions]: {},
       server: {}
     }
   })
@@ -463,9 +449,7 @@ test('Request with undefined socket', t => {
     server: {
       [kReply]: {},
       [kRequest]: Request,
-      [kOptions]: {
-        requestIdLogLabel: 'reqId'
-      },
+      [kOptions]: {},
       server: {}
     }
   })

package/test/logger/logging.test.js

@@ -9,7 +9,7 @@ const pino = require('pino')
 const Fastify = require('../../fastify')
 const { LogController } = require('../../lib/log-controller')
 const helper = require('../helper')
-const { once, on } = stream
+const { on } = stream
 const { request } = require('./logger-test-utils')
 const { partialDeepStrictEqual } = require('../helper')
 
@@ -17,7 +17,7 @@ t.test('logging', { timeout: 60000 }, async (t) => {
   let localhost
   let localhostForURL
 
-  t.plan(16)
+  t.plan(11)
 
   t.before(async function () {
     [localhost, localhostForURL] = await helper.getLoopbackHost()
@@ -289,92 +289,6 @@ t.test('logging', { timeout: 60000 }, async (t) => {
     }
   })
 
-  await t.test('should not log incoming request and outgoing response when disabled', async (t) => {
-    t.plan(1)
-    const stream = split(JSON.parse)
-    const fastify = Fastify({ disableRequestLogging: true, logger: { level: 'info', stream } })
-    t.after(() => fastify.close())
-
-    fastify.get('/500', (req, reply) => {
-      reply.code(500).send(Error('500 error'))
-    })
-
-    await fastify.ready()
-
-    await fastify.inject({ method: 'GET', url: '/500' })
-
-    // no more readable data
-    t.assert.strictEqual(stream.readableLength, 0)
-  })
-
-  await t.test('should not log incoming request, outgoing response  and route not found for 404 onBadUrl when disabled', async (t) => {
-    t.plan(1)
-    const stream = split(JSON.parse)
-    const fastify = Fastify({ disableRequestLogging: true, logger: { level: 'info', stream } })
-    t.after(() => fastify.close())
-
-    await fastify.ready()
-
-    await fastify.inject({ method: 'GET', url: '/%c0' })
-
-    // no more readable data
-    t.assert.strictEqual(stream.readableLength, 0)
-  })
-
-  await t.test('should not log incoming request, outgoing response and route not found for 414 onMaxParamLength when disabled', async (t) => {
-    t.plan(1)
-    const stream = split(JSON.parse)
-    const fastify = Fastify({ disableRequestLogging: true, logger: { level: 'info', stream } })
-    t.after(() => fastify.close())
-
-    await fastify.ready()
-
-    await fastify.inject({
-      method: 'GET',
-      url: `/${'1234567890'.repeat(12)}`
-    })
-
-    // no more readable data
-    t.assert.strictEqual(stream.readableLength, 0)
-  })
-
-  await t.test('should log incoming request and outgoing response based on disableRequestLogging function', async (t) => {
-    const lines = [
-      'incoming request',
-      'request completed'
-    ]
-    t.plan(lines.length)
-
-    const stream = split(JSON.parse)
-    const loggerInstance = pino(stream)
-
-    const fastify = Fastify({
-      disableRequestLogging: (request) => {
-        return request.url !== '/not-logged'
-      },
-      loggerInstance
-    })
-    t.after(() => fastify.close())
-
-    fastify.get('/logged', (req, reply) => {
-      return reply.code(200).send({})
-    })
-
-    fastify.get('/not-logged', (req, reply) => {
-      return reply.code(200).send({})
-    })
-
-    await fastify.ready()
-
-    await fastify.inject({ method: 'GET', url: '/not-logged' })
-    await fastify.inject({ method: 'GET', url: '/logged' })
-
-    for await (const [line] of on(stream, 'data')) {
-      t.assert.strictEqual(line.msg, lines.shift())
-      if (lines.length === 0) break
-    }
-  })
-
   await t.test('defaults to info level', async (t) => {
     const lines = [
       { req: { method: 'GET' }, msg: 'incoming request' },
@@ -480,37 +394,4 @@ t.test('logging', { timeout: 60000 }, async (t) => {
       if (lines.length === 0) break
     }
   })
-
-  await t.test('should not log the error if request logging is disabled', async (t) => {
-    t.plan(4)
-
-    const stream = split(JSON.parse)
-    const fastify = Fastify({
-      logger: {
-        stream,
-        level: 'info'
-      },
-      disableRequestLogging: true
-    })
-    t.after(() => fastify.close())
-
-    fastify.get('/error', function (req, reply) {
-      t.assert.ok(req.log)
-      reply.send(new Error('a generic error'))
-    })
-
-    await fastify.ready()
-    await fastify.listen({ port: 0, host: localhost })
-
-    await request(`http://${localhostForURL}:` + fastify.server.address().port + '/error')
-
-    {
-      const [line] = await once(stream, 'data')
-      t.assert.ok(typeof line.msg === 'string')
-      t.assert.ok(line.msg.startsWith('Server listening at'), 'message is set')
-    }
-
-    // no more readable data
-    t.assert.strictEqual(stream.readableLength, 0)
-  })
 })

package/test/logger/request.test.js

@@ -14,7 +14,7 @@ const { partialDeepStrictEqual } = require('../helper')
 t.test('request', { timeout: 60000 }, async (t) => {
   let localhost
 
-  t.plan(7)
+  t.plan(6)
   t.before(async function () {
     [localhost] = await helper.getLoopbackHost()
   })
@@ -180,41 +180,6 @@ t.test('request', { timeout: 60000 }, async (t) => {
     }
   })
 
-  await t.test('The request id log label can be changed', async (t) => {
-    const REQUEST_ID = '42'
-    const matches = [
-      { traceId: REQUEST_ID, msg: 'incoming request' },
-      { traceId: REQUEST_ID, msg: 'some log message' },
-      { traceId: REQUEST_ID, msg: 'request completed' }
-    ]
-    t.plan(matches.length + 2)
-
-    const stream = split(JSON.parse)
-    const fastify = Fastify({
-      logger: { stream, level: 'info' },
-      requestIdHeader: 'my-custom-request-id',
-      requestIdLogLabel: 'traceId'
-    })
-    t.after(() => fastify.close())
-
-    fastify.get('/one', (req, reply) => {
-      t.assert.strictEqual(req.id, REQUEST_ID)
-      req.log.info('some log message')
-      reply.send({ id: req.id })
-    })
-
-    {
-      const response = await fastify.inject({ method: 'GET', url: '/one', headers: { 'my-custom-request-id': REQUEST_ID } })
-      const body = await response.json()
-      t.assert.strictEqual(body.id, REQUEST_ID)
-    }
-
-    for await (const [line] of on(stream, 'data')) {
-      t.assert.ok(partialDeepStrictEqual(line, matches.shift()))
-      if (matches.length === 0) break
-    }
-  })
-
   await t.test('should redact the authorization header if so specified', async (t) => {
     const stream = split(JSON.parse)
     const fastify = Fastify({

package/test/route-prefix.test.js

@@ -459,7 +459,9 @@ test('prefix "/prefix/" does not match "/prefix" with a / route', (t, testDone)
 test('matches both /prefix and /prefix/ with a / route - ignoreTrailingSlash: true', (t, testDone) => {
   t.plan(4)
   const fastify = Fastify({
-    ignoreTrailingSlash: true
+    routerOptions: {
+      ignoreTrailingSlash: true
+    }
   })
 
   fastify.register(function (fastify, opts, done) {
@@ -493,7 +495,9 @@ test('matches both /prefix and /prefix/ with a / route - ignoreTrailingSlash: tr
 test('matches both /prefix and /prefix/ with a / route - ignoreDuplicateSlashes: true', (t, testDone) => {
   t.plan(4)
   const fastify = Fastify({
-    ignoreDuplicateSlashes: true
+    routerOptions: {
+      ignoreDuplicateSlashes: true
+    }
   })
 
   fastify.register(function (fastify, opts, done) {
@@ -527,7 +531,9 @@ test('matches both /prefix and /prefix/ with a / route - ignoreDuplicateSlashes:
 test('matches both /prefix and /prefix/  with a / route - prefixTrailingSlash: "both", ignoreTrailingSlash: false', (t, testDone) => {
   t.plan(4)
   const fastify = Fastify({
-    ignoreTrailingSlash: false
+    routerOptions: {
+      ignoreTrailingSlash: false
+    }
   })
 
   fastify.register(function (fastify, opts, done) {
@@ -566,7 +572,9 @@ test('matches both /prefix and /prefix/  with a / route - prefixTrailingSlash: "
 test('matches both /prefix and /prefix/  with a / route - prefixTrailingSlash: "both", ignoreDuplicateSlashes: false', (t, testDone) => {
   t.plan(4)
   const fastify = Fastify({
-    ignoreDuplicateSlashes: false
+    routerOptions: {
+      ignoreDuplicateSlashes: false
+    }
   })
 
   fastify.register(function (fastify, opts, done) {
@@ -605,8 +613,10 @@ test('matches both /prefix and /prefix/  with a / route - prefixTrailingSlash: "
 test('matches both /prefix and /prefix/ with a / route - ignoreTrailingSlash: true, ignoreDuplicateSlashes: true', (t, testDone) => {
   t.plan(4)
   const fastify = Fastify({
-    ignoreTrailingSlash: true,
-    ignoreDuplicateSlashes: true
+    routerOptions: {
+      ignoreTrailingSlash: true,
+      ignoreDuplicateSlashes: true
+    }
   })
 
   fastify.register(function (fastify, opts, done) {
@@ -640,8 +650,10 @@ test('matches both /prefix and /prefix/ with a / route - ignoreTrailingSlash: tr
 test('matches both /prefix and /prefix/ with a / route - ignoreTrailingSlash: true, ignoreDuplicateSlashes: false', (t, testDone) => {
   t.plan(4)
   const fastify = Fastify({
-    ignoreTrailingSlash: true,
-    ignoreDuplicateSlashes: false
+    routerOptions: {
+      ignoreTrailingSlash: true,
+      ignoreDuplicateSlashes: false
+    }
   })
 
   fastify.register(function (fastify, opts, done) {
@@ -675,7 +687,9 @@ test('matches both /prefix and /prefix/ with a / route - ignoreTrailingSlash: tr
 test('returns 404 status code with /prefix/ and / route - prefixTrailingSlash: "both" (default), ignoreTrailingSlash: true', (t, testDone) => {
   t.plan(2)
   const fastify = Fastify({
-    ignoreTrailingSlash: true
+    routerOptions: {
+      ignoreTrailingSlash: true
+    }
   })
 
   fastify.register(function (fastify, opts, done) {
@@ -707,7 +721,9 @@ test('returns 404 status code with /prefix/ and / route - prefixTrailingSlash: "
 test('matches both /prefix and /prefix/  with a / route - prefixTrailingSlash: "both", ignoreDuplicateSlashes: true', (t, testDone) => {
   t.plan(2)
   const fastify = Fastify({
-    ignoreDuplicateSlashes: true
+    routerOptions: {
+      ignoreDuplicateSlashes: true
+    }
   })
 
   fastify.register(function (fastify, opts, done) {
@@ -735,8 +751,10 @@ test('matches both /prefix and /prefix/  with a / route - prefixTrailingSlash: "
 test('matches both /prefix and /prefix/  with a / route - prefixTrailingSlash: "both", ignoreTrailingSlash: true, ignoreDuplicateSlashes: true', (t, testDone) => {
   t.plan(2)
   const fastify = Fastify({
-    ignoreTrailingSlash: true,
-    ignoreDuplicateSlashes: true
+    routerOptions: {
+      ignoreTrailingSlash: true,
+      ignoreDuplicateSlashes: true
+    }
   })
 
   fastify.register(function (fastify, opts, done) {
@@ -764,8 +782,10 @@ test('matches both /prefix and /prefix/  with a / route - prefixTrailingSlash: "
 test('matches both /prefix and /prefix/  with a / route - prefixTrailingSlash: "both", ignoreDuplicateSlashes: true', (t, testDone) => {
   t.plan(2)
   const fastify = Fastify({
-    ignoreTrailingSlash: true,
-    ignoreDuplicateSlashes: true
+    routerOptions: {
+      ignoreTrailingSlash: true,
+      ignoreDuplicateSlashes: true
+    }
   })
 
   fastify.register(function (fastify, opts, done) {
@@ -793,7 +813,9 @@ test('matches both /prefix and /prefix/  with a / route - prefixTrailingSlash: "
 test('matches only /prefix  with a / route - prefixTrailingSlash: "no-slash", ignoreTrailingSlash: false', (t, testDone) => {
   t.plan(4)
   const fastify = Fastify({
-    ignoreTrailingSlash: false
+    routerOptions: {
+      ignoreTrailingSlash: false
+    }
   })
 
   fastify.register(function (fastify, opts, done) {
@@ -832,7 +854,9 @@ test('matches only /prefix  with a / route - prefixTrailingSlash: "no-slash", ig
 test('matches only /prefix  with a / route - prefixTrailingSlash: "no-slash", ignoreDuplicateSlashes: false', (t, testDone) => {
   t.plan(4)
   const fastify = Fastify({
-    ignoreDuplicateSlashes: false
+    routerOptions: {
+      ignoreDuplicateSlashes: false
+    }
   })
 
   fastify.register(function (fastify, opts, done) {
@@ -871,7 +895,9 @@ test('matches only /prefix  with a / route - prefixTrailingSlash: "no-slash", ig
 test('matches only /prefix/  with a / route - prefixTrailingSlash: "slash", ignoreTrailingSlash: false', (t, testDone) => {
   t.plan(4)
   const fastify = Fastify({
-    ignoreTrailingSlash: false
+    routerOptions: {
+      ignoreTrailingSlash: false
+    }
   })
 
   fastify.register(function (fastify, opts, done) {
@@ -910,7 +936,9 @@ 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,
+    routerOptions: {
+      ignoreTrailingSlash: false
+    },
     exposeHeadRoutes: false
   })
 

package/test/route.1.test.js

@@ -3,7 +3,7 @@
 const { test } = require('node:test')
 const Fastify = require('..')
 const {
-  FST_ERR_INSTANCE_ALREADY_LISTENING,
+  FST_ERR_INSTANCE_ALREADY_STARTED,
   FST_ERR_ROUTE_METHOD_INVALID
 } = require('../lib/errors')
 const { getServerUrl } = require('./helper')
@@ -230,7 +230,7 @@ test('route', async t => {
       handler: function (req, reply) {
         reply.send({ hello: 'world' })
       }
-    }), new FST_ERR_INSTANCE_ALREADY_LISTENING('Cannot add route!'))
+    }), new FST_ERR_INSTANCE_ALREADY_STARTED('Cannot add route!'))
   })
 })