feat: add request.routeOptions object

docs/Reference/Request.md

@@ -27,6 +27,7 @@ Request is a core Fastify object containing the following fields:
 - `protocol` - the protocol of the incoming request (`https` or `http`)
 - `method` - the method of the incoming request
 - `url` - the URL of the incoming request
+- `routeBodyLimit` - either server limit or route limit
 - `routerMethod` - the method defined for the router that is handling the
   request
 - `routerPath` - the path pattern defined for the router that is handling the
@@ -90,6 +91,7 @@ fastify.post('/:params', options, function (request, reply) {
   console.log(request.protocol)
   console.log(request.url)
   console.log(request.routerMethod)
+  console.log(request.routeBodyLimit)
   console.log(request.routerPath)
   request.log.info('some info')
 })

lib/request.js

@@ -165,6 +165,13 @@ Object.defineProperties(Request.prototype, {
       return this[kRouteContext].config.url
     }
   },
+  routeBodyLimit: {
+    get () {
+      const serverLimit = this[kRouteContext]?.server?.initialConfig?.bodyLimit
+      const routeLimit = this[kRouteContext]?._parserOptions?.limit
+      return (routeLimit || serverLimit)
+    }
+  },
   routerMethod: {
     get () {
       return this[kRouteContext].config.method

test/bodyLimit.test.js

@@ -6,7 +6,7 @@ const t = require('tap')
 const test = t.test
 
 test('bodyLimit', t => {
-  t.plan(5)
+  t.plan(10)
 
   try {
     Fastify({ bodyLimit: 1.3 })
@@ -28,6 +28,21 @@ test('bodyLimit', t => {
     reply.send({ error: 'handler should not be called' })
   })
 
+  fastify.post('/route-limit', {
+    bodyLimit: 1000,
+    handler (request, reply) {
+      t.equal(1000, request.routeBodyLimit)
+      reply.send({ error: 'handler should not be called' })
+    }
+  })
+
+  fastify.post('/server-limit', {
+    handler (request, reply) {
+      t.equal(1, request.routeBodyLimit)
+      reply.send({ error: 'handler should not be called' })
+    }
+  })
+
   fastify.listen({ port: 0 }, function (err) {
     t.error(err)
     t.teardown(() => { fastify.close() })
@@ -42,5 +57,51 @@ test('bodyLimit', t => {
       t.error(err)
       t.equal(response.statusCode, 413)
     })
+    sget({
+      method: 'POST',
+      url: 'http://localhost:' + fastify.server.address().port + '/route-limit',
+      headers: { 'Content-Type': 'application/json' },
+      body: [],
+      json: true
+    }, (err, response, body) => {
+      t.error(err)
+      t.equal(response.statusCode, 200)
+    })
+    sget({
+      method: 'POST',
+      url: 'http://localhost:' + fastify.server.address().port + '/server-limit',
+      headers: { 'Content-Type': 'application/json' },
+      body: [],
+      json: true
+    }, (err, response, body) => {
+      t.error(err)
+      t.equal(response.statusCode, 413)
+    })
+  })
+})
+
+test('default request.routeBodyLimit should be 1048576', t => {
+  t.plan(4)
+  const fastify = Fastify()
+  fastify.post('/default-bodylimit', {
+    handler (request, reply) {
+      t.equal(1048576, request.routeBodyLimit)
+      reply.send({ error: 'handler should not be called' })
+    }
+  })
+  fastify.listen({ port: 0 }, function (err) {
+    t.error(err)
+    t.teardown(() => { fastify.close() })
+
+    sget({
+      method: 'POST',
+      url: 'http://localhost:' + fastify.server.address().port + '/default-bodylimit',
+      headers: { 'Content-Type': 'application/json' },
+      body: [],
+      json: true
+    }, (err, response, body) => {
+      t.error(err)
+      t.equal(response.statusCode, 200)
+    })
   })
 })

test/types/request.test-d.ts

@@ -66,6 +66,7 @@ const getHandler: RouteHandler = function (request, _reply) {
   expectType<string>(request.method)
   expectType<string>(request.routerPath)
   expectType<string>(request.routerMethod)
+  expectType<number>(request.routeBodyLimit)
   expectType<boolean>(request.is404)
   expectType<string>(request.hostname)
   expectType<string>(request.ip)

types/request.d.ts

@@ -66,6 +66,7 @@ export interface FastifyRequest<RouteGeneric extends RouteGenericInterface = Rou
   readonly method: string;
   readonly routerPath: string;
   readonly routerMethod: string;
+  readonly routeBodyLimit: number;
   readonly is404: boolean;
   readonly socket: RawRequest['socket'];