add option to disable/ignore request-id header

[philippviereck]

fixes #4192

This way it should not break anything, just allow for requestIdHeader to be ignored by setting it explicitly to false

  const fastify = Fastify({
    requestIdHeader: false,
  })

(I am not sure if I updated all those config validation and typescript files correctly.)

Checklist

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

[Eomm]

Could you update the documentation as well?

then it LGTM 👍🏽

[philippviereck]

@Eomm Yeah, I can probably do that. (update the docs)

So, the current PR implementation does not break anything, and undefined still defaults to 'request-id'.
In my opinion this is unexpected behaviour. I think it should be false by default and you should opt-in rather than opt-out.

Also, setting requestIdHeader to true instead of a string will result, in the same behaviour as false because
false | string is expected, should this be handled specifically or is it the users fault?

PS: here is why:

 const fastify = Fastify({
    requestIdHeader: true,
  })

const requestIdHeader = (options.requestIdHeader === false) ? false : (options.requestIdHeader || defaultInitOptions.requestIdHeader) 
// => requestIdHeader = true

...
const id = requestIdHeader === false ? genReqId(req) : (req.headers[requestIdHeader] || genReqId(req))
// req.headers[true] is undefined, so genReqId(req) will be used

[mcollina]

Good work, could you add this new option to the docs?

[philippviereck]

sorry, didn't mean to do that. I updated the docs

[mcollina]

lgtm

[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.