fastify 5.9.0 → 5.10.0

package/test/trust-proxy.test.js

@@ -6,10 +6,10 @@ const helper = require('./helper')
 const Request = require('../lib/request')
 const buildRequest = Request.buildRequest
 
-const fetchForwardedRequest = async (fastifyServer, forHeader, path, protoHeader) => {
+const fetchForwardedRequest = async (fastifyServer, forHeader, path, protoHeader, hostHeader = 'fastify.test') => {
   const headers = {
     'X-Forwarded-For': forHeader,
-    'X-Forwarded-Host': 'fastify.test'
+    'X-Forwarded-Host': hostHeader
   }
   if (protoHeader) {
     headers['X-Forwarded-Proto'] = protoHeader
@@ -28,8 +28,10 @@ const testRequestValues = (t, req, options) => {
   if (options.host) {
     t.assert.ok(req.host, 'host is defined')
     t.assert.strictEqual(req.host, options.host, 'gets host from x-forwarded-host')
-    t.assert.ok(req.hostname)
-    t.assert.strictEqual(req.hostname, options.host, 'gets hostname from x-forwarded-host')
+  }
+  if (options.hostname) {
+    t.assert.ok(req.hostname, 'hostname is defined')
+    t.assert.strictEqual(req.hostname, options.hostname, 'gets hostname from x-forwarded-host')
   }
   if (options.ips) {
     t.assert.deepStrictEqual(req.ips, options.ips, 'gets ips from x-forwarded-for')
@@ -38,9 +40,8 @@ const testRequestValues = (t, req, options) => {
     t.assert.ok(req.protocol, 'protocol is defined')
     t.assert.strictEqual(req.protocol, options.protocol, 'gets protocol from x-forwarded-proto')
   }
-  if (options.port) {
-    t.assert.ok(req.port, 'port is defined')
-    t.assert.strictEqual(req.port, options.port, 'port is taken from x-forwarded-for or host')
+  if ('port' in options) {
+    t.assert.strictEqual(req.port, options.port, 'port is parsed from x-forwarded-host')
   }
 }
 
@@ -50,117 +51,135 @@ before(async function () {
 })
 
 test('trust proxy, not add properties to node req', async t => {
-  t.plan(13)
+  t.plan(11)
   const app = fastify({
     trustProxy: true
   })
   t.after(() => app.close())
 
   app.get('/trustproxy', function (req, reply) {
-    testRequestValues(t, req, { ip: '1.1.1.1', host: 'fastify.test', port: app.server.address().port })
+    testRequestValues(t, req, { ip: '1.1.1.1', host: 'fastify.test:1234', hostname: 'fastify.test', port: 1234 })
     reply.code(200).send({ ip: req.ip, host: req.host })
   })
 
   app.get('/trustproxychain', function (req, reply) {
-    testRequestValues(t, req, { ip: '2.2.2.2', ips: [localhost, '1.1.1.1', '2.2.2.2'], port: app.server.address().port })
+    // x-forwarded-host carries no port, so req.port is null
+    testRequestValues(t, req, { ip: '2.2.2.2', ips: [localhost, '1.1.1.1', '2.2.2.2'], port: null })
     reply.code(200).send({ ip: req.ip, host: req.host })
   })
 
   const fastifyServer = await app.listen({ port: 0 })
 
-  await fetchForwardedRequest(fastifyServer, '1.1.1.1', '/trustproxy', undefined)
+  await fetchForwardedRequest(fastifyServer, '1.1.1.1', '/trustproxy', undefined, 'fastify.test:1234')
   await fetchForwardedRequest(fastifyServer, '2.2.2.2, 1.1.1.1', '/trustproxychain', undefined)
 })
 
 test('trust proxy chain', async t => {
-  t.plan(8)
+  t.plan(7)
   const app = fastify({
     trustProxy: [localhost, '192.168.1.1']
   })
   t.after(() => app.close())
 
   app.get('/trustproxychain', function (req, reply) {
-    testRequestValues(t, req, { ip: '1.1.1.1', host: 'fastify.test', port: app.server.address().port })
+    testRequestValues(t, req, { ip: '1.1.1.1', host: 'fastify.test:1234', hostname: 'fastify.test', port: 1234 })
     reply.code(200).send({ ip: req.ip, host: req.host })
   })
 
   const fastifyServer = await app.listen({ port: 0 })
-  await fetchForwardedRequest(fastifyServer, '192.168.1.1, 1.1.1.1', '/trustproxychain', undefined)
+  await fetchForwardedRequest(fastifyServer, '192.168.1.1, 1.1.1.1', '/trustproxychain', undefined, 'fastify.test:1234')
 })
 
 test('trust proxy function', async t => {
-  t.plan(8)
+  t.plan(7)
   const app = fastify({
     trustProxy: (address) => address === localhost
   })
   t.after(() => app.close())
 
   app.get('/trustproxyfunc', function (req, reply) {
-    testRequestValues(t, req, { ip: '1.1.1.1', host: 'fastify.test', port: app.server.address().port })
+    testRequestValues(t, req, { ip: '1.1.1.1', host: 'fastify.test:1234', hostname: 'fastify.test', port: 1234 })
     reply.code(200).send({ ip: req.ip, host: req.host })
   })
 
   const fastifyServer = await app.listen({ port: 0 })
-  await fetchForwardedRequest(fastifyServer, '1.1.1.1', '/trustproxyfunc', undefined)
+  await fetchForwardedRequest(fastifyServer, '1.1.1.1', '/trustproxyfunc', undefined, 'fastify.test:1234')
 })
 
 test('trust proxy number', async t => {
-  t.plan(9)
+  t.plan(8)
   const app = fastify({
     trustProxy: 1
   })
   t.after(() => app.close())
 
   app.get('/trustproxynumber', function (req, reply) {
-    testRequestValues(t, req, { ip: '1.1.1.1', ips: [localhost, '1.1.1.1'], host: 'fastify.test', port: app.server.address().port })
+    testRequestValues(t, req, { ip: '1.1.1.1', ips: [localhost, '1.1.1.1'], host: 'fastify.test:1234', hostname: 'fastify.test', port: 1234 })
     reply.code(200).send({ ip: req.ip, host: req.host })
   })
 
   const fastifyServer = await app.listen({ port: 0 })
-  await fetchForwardedRequest(fastifyServer, '2.2.2.2, 1.1.1.1', '/trustproxynumber', undefined)
+  await fetchForwardedRequest(fastifyServer, '2.2.2.2, 1.1.1.1', '/trustproxynumber', undefined, 'fastify.test:1234')
 })
 
 test('trust proxy IP addresses', async t => {
-  t.plan(9)
+  t.plan(8)
   const app = fastify({
     trustProxy: `${localhost}, 2.2.2.2`
   })
   t.after(() => app.close())
 
   app.get('/trustproxyipaddrs', function (req, reply) {
-    testRequestValues(t, req, { ip: '1.1.1.1', ips: [localhost, '1.1.1.1'], host: 'fastify.test', port: app.server.address().port })
+    testRequestValues(t, req, { ip: '1.1.1.1', ips: [localhost, '1.1.1.1'], host: 'fastify.test:1234', hostname: 'fastify.test', port: 1234 })
     reply.code(200).send({ ip: req.ip, host: req.host })
   })
 
   const fastifyServer = await app.listen({ port: 0 })
-  await fetchForwardedRequest(fastifyServer, '3.3.3.3, 2.2.2.2, 1.1.1.1', '/trustproxyipaddrs', undefined)
+  await fetchForwardedRequest(fastifyServer, '3.3.3.3, 2.2.2.2, 1.1.1.1', '/trustproxyipaddrs', undefined, 'fastify.test:1234')
 })
 
 test('trust proxy protocol', async t => {
-  t.plan(30)
+  t.plan(27)
   const app = fastify({
     trustProxy: true
   })
   t.after(() => app.close())
 
   app.get('/trustproxyprotocol', function (req, reply) {
-    testRequestValues(t, req, { ip: '1.1.1.1', protocol: 'lorem', host: 'fastify.test', port: app.server.address().port })
+    testRequestValues(t, req, { ip: '1.1.1.1', protocol: 'lorem', host: 'fastify.test:1234', hostname: 'fastify.test', port: 1234 })
     reply.code(200).send({ ip: req.ip, host: req.host })
   })
   app.get('/trustproxynoprotocol', function (req, reply) {
-    testRequestValues(t, req, { ip: '1.1.1.1', protocol: 'http', host: 'fastify.test', port: app.server.address().port })
+    testRequestValues(t, req, { ip: '1.1.1.1', protocol: 'http', host: 'fastify.test:1234', hostname: 'fastify.test', port: 1234 })
     reply.code(200).send({ ip: req.ip, host: req.host })
   })
   app.get('/trustproxyprotocols', function (req, reply) {
-    testRequestValues(t, req, { ip: '1.1.1.1', protocol: 'dolor', host: 'fastify.test', port: app.server.address().port })
+    testRequestValues(t, req, { ip: '1.1.1.1', protocol: 'dolor', host: 'fastify.test:1234', hostname: 'fastify.test', port: 1234 })
     reply.code(200).send({ ip: req.ip, host: req.host })
   })
 
   const fastifyServer = await app.listen({ port: 0 })
 
-  await fetchForwardedRequest(fastifyServer, '1.1.1.1', '/trustproxyprotocol', 'lorem')
-  await fetchForwardedRequest(fastifyServer, '1.1.1.1', '/trustproxynoprotocol', undefined)
-  await fetchForwardedRequest(fastifyServer, '1.1.1.1', '/trustproxyprotocols', 'ipsum, dolor')
+  await fetchForwardedRequest(fastifyServer, '1.1.1.1', '/trustproxyprotocol', 'lorem', 'fastify.test:1234')
+  await fetchForwardedRequest(fastifyServer, '1.1.1.1', '/trustproxynoprotocol', undefined, 'fastify.test:1234')
+  await fetchForwardedRequest(fastifyServer, '1.1.1.1', '/trustproxyprotocols', 'ipsum, dolor', 'fastify.test:1234')
+})
+
+test('trust proxy port is null when x-forwarded-host has no port', async t => {
+  t.plan(5)
+  const app = fastify({
+    trustProxy: true
+  })
+  t.after(() => app.close())
+
+  app.get('/trustproxynoport', function (req, reply) {
+    // req.port is derived from req.host; a forwarded host without a port yields null
+    testRequestValues(t, req, { host: 'fastify.test', hostname: 'fastify.test', port: null })
+    reply.code(200).send({ host: req.host, port: req.port })
+  })
+
+  const fastifyServer = await app.listen({ port: 0 })
+  await fetchForwardedRequest(fastifyServer, '1.1.1.1', '/trustproxynoport', undefined)
 })
 
 test('trust proxy ignores forwarded headers from untrusted connections', async t => {

package/types/errors.d.ts

@@ -40,6 +40,7 @@ export type FastifyErrorCodes = Record<
   'FST_ERR_LOG_INVALID_LOGGER_INSTANCE' |
   'FST_ERR_LOG_INVALID_LOGGER_CONFIG' |
   'FST_ERR_LOG_LOGGER_AND_LOGGER_INSTANCE_PROVIDED' |
+  'FST_ERR_LOG_INVALID_LOG_CONTROLLER' |
   'FST_ERR_REP_INVALID_PAYLOAD_TYPE' |
   'FST_ERR_REP_RESPONSE_BODY_CONSUMED' |
   'FST_ERR_REP_READABLE_STREAM_LOCKED' |

package/types/instance.d.ts

@@ -595,12 +595,14 @@ export interface FastifyInstance<
     https?: boolean | Readonly<{ allowHTTP1: boolean }>,
     ignoreTrailingSlash?: boolean,
     ignoreDuplicateSlashes?: boolean,
+    /** @deprecated Use the `logController` option with `disableRequestLogging` or `isLogDisabled` override instead. Will be removed in `fastify@6`. */
     disableRequestLogging?: boolean | ((req: FastifyRequest) => boolean),
     maxParamLength?: number,
     onProtoPoisoning?: ProtoAction,
     onConstructorPoisoning?: ConstructorAction,
     pluginTimeout?: number,
     requestIdHeader?: string | false,
+    /** @deprecated Use the `logController` option with `requestIdLogLabel` instead. Will be removed in `fastify@6`. */
     requestIdLogLabel?: string,
     http2SessionTimeout?: number,
     useSemicolonDelimiter?: boolean,

package/types/logger.d.ts

@@ -82,6 +82,28 @@ export interface FastifyLoggerOptions<
   stream?: FastifyLoggerStreamDestination;
 }
 
+export interface LogControllerOptions {
+  disableRequestLogging?: boolean | ((req: FastifyRequest) => boolean)
+  requestIdLogLabel?: string
+}
+
+export declare class LogController {
+  disableRequestLogging: boolean | ((req: FastifyRequest) => boolean)
+  requestIdLogLabel: string
+
+  constructor (options?: LogControllerOptions)
+
+  isLogDisabled (request: FastifyRequest): boolean
+  incomingRequest (request: FastifyRequest, reply: FastifyReply, metadata?: Record<string, unknown>): void
+  requestCompleted (error: Error | null, request: FastifyRequest, reply: FastifyReply, metadata?: Record<string, unknown>): void
+  defaultErrorLog (error: Error, request: FastifyRequest, reply: FastifyReply, metadata?: Record<string, unknown>): void
+  streamError (error: Error, request: FastifyRequest, reply: FastifyReply, metadata?: Record<string, unknown>): void
+  routeNotFound (request: FastifyRequest, reply: FastifyReply, metadata?: Record<string, unknown>): void
+  writeHeadError (error: Error, request: FastifyRequest, reply: FastifyReply, metadata?: Record<string, unknown>): void
+  serializerError (error: Error, request: FastifyRequest, reply: FastifyReply, metadata: { statusCode: number }): void
+  serviceUnavailable (logger: FastifyBaseLogger, server: FastifyInstance): void
+}
+
 export interface FastifyChildLoggerFactory<
   RawServer extends RawServerBase = RawServerDefault,
   RawRequest extends RawRequestDefaultExpression<RawServer> = RawRequestDefaultExpression<RawServer>,