feat: add request.routeOptions object

[debadutta98]

Hi,

This PR Closes #4375

Work

• Add request.routeOptions.bodyLimit to request (update request.js)
• Add some test cases of current changes to bodyLimit.test.js
• Update type declaration request.d.ts

Checklist

• run npm run test and npm run benchmark
• tests and/or benchmarks are included
• documentation is changed or added
• commit message and code follows the Developer's Certification of Origin
  and the Code of conduct

[mcollina]

lgtm

[climba03003]

I do not block if it landed.
Still, I think mapping the options to property one by one is not a good idea.

Details on #4375 (comment)

[debadutta98]

Hi @Eomm @climba03003 ,

I just changed request.routeBodyLimit to request.routeOptions.bodyLimit according to that doc and test cases are also
please confirm if it needs further improvement

[jsumners]

This does not fully consider, nor implement, the ideas presented in the issue discussion.

[mcollina]

lgtm

[debadutta98]

Hi guys,

Just validate my solution to match your expectations

• Add some new property request.routeOptions and they are only readable (if you want to include more property please let me know)
• As introduced some changes to lib/request.js that way I write some test cases on request-error.test.js and modify the types of routeOptions on types/request.d.ts
• Update doc on doc/References/Request.md

Thank you!

[Eomm]

AWESOME!

[Uzlopak]

Can we modify the test in request-error.js to this please?
Just in case we have in future some routeOption being an Object or Array, we could overlook, that Object.freeze does not cover them properly.

test('request.routeOptions should be immutable', t => {
  t.plan(14)
  const fastify = Fastify()
  const handler = function (req, res) {
    t.equal('POST', req.routeOptions.method)
    t.equal('/', req.routeOptions.url)
    t.throws(() => { req.routeOptions = null }, new TypeError('Cannot set property routeOptions of #<Request> which has only a getter'))
    t.throws(() => { req.routeOptions.method = 'INVALID' }, new TypeError('Cannot assign to read only property \'method\' of object \'#<Object>\''))
    t.throws(() => { req.routeOptions.url = '//' }, new TypeError('Cannot assign to read only property \'url\' of object \'#<Object>\''))
    t.throws(() => { req.routeOptions.bodyLimit = 0xDEADBEEF }, new TypeError('Cannot assign to read only property \'bodyLimit\' of object \'#<Object>\''))
    t.throws(() => { req.routeOptions.attachValidation = true }, new TypeError('Cannot assign to read only property \'attachValidation\' of object \'#<Object>\''))
    t.throws(() => { req.routeOptions.logLevel = 'invalid' }, new TypeError('Cannot assign to read only property \'logLevel\' of object \'#<Object>\''))
    t.throws(() => { req.routeOptions.version = '95.0.1' }, new TypeError('Cannot assign to read only property \'version\' of object \'#<Object>\''))
    t.throws(() => { req.routeOptions.prefixTrailingSlash = true }, new TypeError('Cannot assign to read only property \'prefixTrailingSlash\' of object \'#<Object>\''))
    t.throws(() => { req.routeOptions.newAttribute = {} }, new TypeError('Cannot add property newAttribute, object is not extensible'))

    for (const key of Object.keys(req.routeOptions)) {
      if (typeof req.routeOptions[key] === 'object' && req.routeOptions[key] !== null) {
        t.fail('Object.freeze must run recursively on nested structures to ensure that routeOptions is immutable.')
      }
    }

    res.send({ })
  }
  fastify.post('/', {
    bodyLimit: 1000,
    handler
  })
  fastify.listen({ port: 0 }, function (err) {
    t.error(err)
    t.teardown(() => { fastify.close() })

    sget({
      method: 'POST',
      url: 'http://localhost:' + fastify.server.address().port,
      headers: { 'Content-Type': 'application/json' },
      body: [],
      json: true
    }, (err, response, body) => {
      t.error(err)
      t.equal(response.statusCode, 200)
    })
  })
})

[debadutta98]

Can we modify the test in request-error.js to this please? Just in case we have in future some routeOption being an Object or Array, we could overlook, that Object.freeze does not cover them properly.

Thank you!!

Your solution has been implemented

[climba03003]

Object.freeze does not cover them properly.

Probably the one would be constraints.

[github-actions]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.