feat: disable/ignore request-id header (#4193)

* add option to disable/ignore request-id header fixes #4192 * add more restrictive schema definition * update configValidator generated by running 'node build/build-validation.js' after change on 'build-validation.js' * move logic into reqIdGenFactory * update docs for requestHeaderId Adding documentation for opt-out of 'requestHeaderId'
fastify · Aug 11, 2022 · 4e79725 · 4e79725
1 parent ea8aae9
commit 4e79725
Show file tree

Hide file tree

Showing 11 changed files with 207 additions and 33 deletions.
diff --git a/build/build-validation.js b/build/build-validation.js
@@ -97,7  97,7 @@ const schema = {
     onProtoPoisoning: { type: 'string', default: defaultInitOptions.onProtoPoisoning },
     onConstructorPoisoning: { type: 'string', default: defaultInitOptions.onConstructorPoisoning },
     pluginTimeout: { type: 'integer', default: defaultInitOptions.pluginTimeout },
-    requestIdHeader: { type: 'string', default: defaultInitOptions.requestIdHeader },
     requestIdHeader: { anyOf: [{ enum: [false] }, { type: 'string' }], default: defaultInitOptions.requestIdHeader },
     requestIdLogLabel: { type: 'string', default: defaultInitOptions.requestIdLogLabel },
     http2SessionTimeout: { type: 'integer', default: defaultInitOptions.http2SessionTimeout },
     exposeHeadRoutes: { type: 'boolean', default: defaultInitOptions.exposeHeadRoutes },

diff --git a/docs/Reference/Server.md b/docs/Reference/Server.md
@@ -55,7  55,7 @@ describes the properties available in that options object.
     - [routing](#routing)
     - [route](#route)
     - [close](#close)
-    - [decorate\*](#decorate)
     - [decorate*](#decorate)
     - [register](#register)
     - [addHook](#addhook)
     - [prefix](#prefix)
@@ -488,11  488,18 @@ about safe regexp: [Safe-regex2](https://www.npmjs.com/package/safe-regex2)
 ### `requestIdHeader`
 <a id="factory-request-id-header"></a>
 
-The header name used to know the request-id. See [the
 The header name used to set the request-id. See [the
 request-id](./Logging.md#logging-request-id) section.
 Setting `requestIdHeader` to `false` will always use [genReqId](#genreqid)
 
   Default: `'request-id'`
-
 
 ```js
 const fastify = require('fastify')({
   requestIdHeader: 'x-custom-id', // -> use 'X-Custom-Id' header if available
   //requestIdHeader: false, // -> always use genReqId
 })
 ```
 ### `requestIdLogLabel`
 <a id="factory-request-id-log-label"></a>
 

diff --git a/fastify.d.ts b/fastify.d.ts
@@ -123,7  123,7 @@ export type FastifyServerOptions<
   serializerOpts?: FJSOptions | Record<string, unknown>,
   serverFactory?: FastifyServerFactory<RawServer>,
   caseSensitive?: boolean,
-  requestIdHeader?: string,
   requestIdHeader?: string | false,
   requestIdLogLabel?: string;
   jsonShorthand?: boolean;
   genReqId?: <RequestGeneric extends RequestGenericInterface = RequestGenericInterface, TypeProvider extends FastifyTypeProvider = FastifyTypeProviderDefault>(req: FastifyRequest<RequestGeneric, RawServer, RawRequestDefaultExpression<RawServer>, FastifySchema, TypeProvider>) => string,

diff --git a/fastify.js b/fastify.js
@@ -98,8  98,8 @@ function fastify (options) {
 
   validateBodyLimitOption(options.bodyLimit)
 
-  const requestIdHeader = options.requestIdHeader || defaultInitOptions.requestIdHeader
-  const genReqId = options.genReqId || reqIdGenFactory()
   const requestIdHeader = (options.requestIdHeader === false) ? false : (options.requestIdHeader || defaultInitOptions.requestIdHeader)
   const genReqId = reqIdGenFactory(requestIdHeader, options.genReqId)
   const requestIdLogLabel = options.requestIdLogLabel || 'reqId'
   const bodyLimit = options.bodyLimit || defaultInitOptions.bodyLimit
   const disableRequestLogging = options.disableRequestLogging || false

diff --git a/lib/configValidator.js b/lib/configValidator.js
@@ -3,7  3,7 @@
 "use strict";
 module.exports = validate10;
 module.exports.default = validate10;
-const schema11 = {"type":"object","additionalProperties":false,"properties":{"connectionTimeout":{"type":"integer","default":0},"keepAliveTimeout":{"type":"integer","default":72000},"forceCloseConnections":{"oneOf":[{"type":"string","pattern":"idle"},{"type":"boolean"}]},"maxRequestsPerSocket":{"type":"integer","default":0,"nullable":true},"requestTimeout":{"type":"integer","default":0},"bodyLimit":{"type":"integer","default":1048576},"caseSensitive":{"type":"boolean","default":true},"allowUnsafeRegex":{"type":"boolean","default":false},"http2":{"type":"boolean"},"https":{"if":{"not":{"oneOf":[{"type":"boolean"},{"type":"null"},{"type":"object","additionalProperties":false,"required":["allowHTTP1"],"properties":{"allowHTTP1":{"type":"boolean"}}}]}},"then":{"setDefaultValue":true}},"ignoreTrailingSlash":{"type":"boolean","default":false},"ignoreDuplicateSlashes":{"type":"boolean","default":false},"disableRequestLogging":{"type":"boolean","default":false},"jsonShorthand":{"type":"boolean","default":true},"maxParamLength":{"type":"integer","default":100},"onProtoPoisoning":{"type":"string","default":"error"},"onConstructorPoisoning":{"type":"string","default":"error"},"pluginTimeout":{"type":"integer","default":10000},"requestIdHeader":{"type":"string","default":"request-id"},"requestIdLogLabel":{"type":"string","default":"reqId"},"http2SessionTimeout":{"type":"integer","default":72000},"exposeHeadRoutes":{"type":"boolean","default":true},"versioning":{"type":"object","additionalProperties":true,"required":["storage","deriveVersion"],"properties":{"storage":{},"deriveVersion":{}}},"constraints":{"type":"object","additionalProperties":{"type":"object","required":["name","storage","validate","deriveConstraint"],"additionalProperties":true,"properties":{"name":{"type":"string"},"storage":{},"validate":{},"deriveConstraint":{}}}}}};
 const schema11 = {"type":"object","additionalProperties":false,"properties":{"connectionTimeout":{"type":"integer","default":0},"keepAliveTimeout":{"type":"integer","default":72000},"forceCloseConnections":{"oneOf":[{"type":"string","pattern":"idle"},{"type":"boolean"}]},"maxRequestsPerSocket":{"type":"integer","default":0,"nullable":true},"requestTimeout":{"type":"integer","default":0},"bodyLimit":{"type":"integer","default":1048576},"caseSensitive":{"type":"boolean","default":true},"allowUnsafeRegex":{"type":"boolean","default":false},"http2":{"type":"boolean"},"https":{"if":{"not":{"oneOf":[{"type":"boolean"},{"type":"null"},{"type":"object","additionalProperties":false,"required":["allowHTTP1"],"properties":{"allowHTTP1":{"type":"boolean"}}}]}},"then":{"setDefaultValue":true}},"ignoreTrailingSlash":{"type":"boolean","default":false},"ignoreDuplicateSlashes":{"type":"boolean","default":false},"disableRequestLogging":{"type":"boolean","default":false},"jsonShorthand":{"type":"boolean","default":true},"maxParamLength":{"type":"integer","default":100},"onProtoPoisoning":{"type":"string","default":"error"},"onConstructorPoisoning":{"type":"string","default":"error"},"pluginTimeout":{"type":"integer","default":10000},"requestIdHeader":{"anyOf":[{"enum":[false]},{"type":"string"}],"default":"request-id"},"requestIdLogLabel":{"type":"string","default":"reqId"},"http2SessionTimeout":{"type":"integer","default":72000},"exposeHeadRoutes":{"type":"boolean","default":true},"versioning":{"type":"object","additionalProperties":true,"required":["storage","deriveVersion"],"properties":{"storage":{},"deriveVersion":{}}},"constraints":{"type":"object","additionalProperties":{"type":"object","required":["name","storage","validate","deriveConstraint"],"additionalProperties":true,"properties":{"name":{"type":"string"},"storage":{},"validate":{},"deriveConstraint":{}}}}}};
 const func2 = Object.prototype.hasOwnProperty;
 const pattern0 = new RegExp("idle", "u");
 
@@ -837,6  837,23 @@ var valid0 = _errs55 === errors;
 if(valid0){
 let data19 = data.requestIdHeader;
 const _errs57 = errors;
 const _errs58 = errors;
 let valid6 = false;
 const _errs59 = errors;
 if(!(data19 === false)){
 const err12 = {instancePath:instancePath "/requestIdHeader",schemaPath:"#/properties/requestIdHeader/anyOf/0/enum",keyword:"enum",params:{allowedValues: schema11.properties.requestIdHeader.anyOf[0].enum},message:"must be equal to one of the allowed values"};
 if(vErrors === null){
 vErrors = [err12];
 }
 else {
 vErrors.push(err12);
 }
 errors  ;
 }
 var _valid3 = _errs59 === errors;
 valid6 = valid6 || _valid3;
 if(!valid6){
 const _errs60 = errors;
 if(typeof data19 !== "string"){
 let dataType21 = typeof data19;
 let coerced21 = undefined;
@@ -848,8  865,14 @@ else if(data19 === null){
 coerced21 = "";
 }
 else {
-validate10.errors = [{instancePath:instancePath "/requestIdHeader",schemaPath:"#/properties/requestIdHeader/type",keyword:"type",params:{type: "string"},message:"must be string"}];
-return false;
 const err13 = {instancePath:instancePath "/requestIdHeader",schemaPath:"#/properties/requestIdHeader/anyOf/1/type",keyword:"type",params:{type: "string"},message:"must be string"};
 if(vErrors === null){
 vErrors = [err13];
 }
 else {
 vErrors.push(err13);
 }
 errors  ;
 }
 }
 if(coerced21 !== undefined){
@@ -859,10  882,36 @@ data["requestIdHeader"] = coerced21;
 }
 }
 }
 var _valid3 = _errs60 === errors;
 valid6 = valid6 || _valid3;
 }
 if(!valid6){
 const err14 = {instancePath:instancePath "/requestIdHeader",schemaPath:"#/properties/requestIdHeader/anyOf",keyword:"anyOf",params:{},message:"must match a schema in anyOf"};
 if(vErrors === null){
 vErrors = [err14];
 }
 else {
 vErrors.push(err14);
 }
 errors  ;
 validate10.errors = vErrors;
 return false;
 }
 else {
 errors = _errs58;
 if(vErrors !== null){
 if(_errs58){
 vErrors.length = _errs58;
 }
 else {
 vErrors = null;
 }
 }
 }
 var valid0 = _errs57 === errors;
 if(valid0){
 let data20 = data.requestIdLogLabel;
-const _errs59 = errors;
 const _errs62 = errors;
 if(typeof data20 !== "string"){
 let dataType22 = typeof data20;
 let coerced22 = undefined;
@@ -885,10  934,10 @@ data["requestIdLogLabel"] = coerced22;
 }
 }
 }
-var valid0 = _errs59 === errors;
 var valid0 = _errs62 === errors;
 if(valid0){
 let data21 = data.http2SessionTimeout;
-const _errs61 = errors;
 const _errs64 = errors;
 if(!(((typeof data21 == "number") && (!(data21 % 1) && !isNaN(data21))) && (isFinite(data21)))){
 let dataType23 = typeof data21;
 let coerced23 = undefined;
@@ -909,10  958,10 @@ data["http2SessionTimeout"] = coerced23;
 }
 }
 }
-var valid0 = _errs61 === errors;
 var valid0 = _errs64 === errors;
 if(valid0){
 let data22 = data.exposeHeadRoutes;
-const _errs63 = errors;
 const _errs66 = errors;
 if(typeof data22 !== "boolean"){
 let coerced24 = undefined;
 if(!(coerced24 !== undefined)){
@@ -934,12  983,12 @@ data["exposeHeadRoutes"] = coerced24;
 }
 }
 }
-var valid0 = _errs63 === errors;
 var valid0 = _errs66 === errors;
 if(valid0){
 if(data.versioning !== undefined){
 let data23 = data.versioning;
-const _errs65 = errors;
-if(errors === _errs65){
 const _errs68 = errors;
 if(errors === _errs68){
 if(data23 && typeof data23 == "object" && !Array.isArray(data23)){
 let missing1;
 if(((data23.storage === undefined) && (missing1 = "storage")) || ((data23.deriveVersion === undefined) && (missing1 = "deriveVersion"))){
@@ -952,21  1001,21 @@ validate10.errors = [{instancePath:instancePath "/versioning",schemaPath:"#/prop
 return false;
 }
 }
-var valid0 = _errs65 === errors;
 var valid0 = _errs68 === errors;
 }
 else {
 var valid0 = true;
 }
 if(valid0){
 if(data.constraints !== undefined){
 let data24 = data.constraints;
-const _errs68 = errors;
-if(errors === _errs68){
 const _errs71 = errors;
 if(errors === _errs71){
 if(data24 && typeof data24 == "object" && !Array.isArray(data24)){
 for(const key2 in data24){
 let data25 = data24[key2];
-const _errs71 = errors;
-if(errors === _errs71){
 const _errs74 = errors;
 if(errors === _errs74){
 if(data25 && typeof data25 == "object" && !Array.isArray(data25)){
 let missing2;
 if(((((data25.name === undefined) && (missing2 = "name")) || ((data25.storage === undefined) && (missing2 = "storage"))) || ((data25.validate === undefined) && (missing2 = "validate"))) || ((data25.deriveConstraint === undefined) && (missing2 = "deriveConstraint"))){
@@ -1006,8  1055,8 @@ validate10.errors = [{instancePath:instancePath "/constraints/"   key2.replace(/
 return false;
 }
 }
-var valid6 = _errs71 === errors;
-if(!valid6){
 var valid7 = _errs74 === errors;
 if(!valid7){
 break;
 }
 }
@@ -1017,7  1066,7 @@ validate10.errors = [{instancePath:instancePath "/constraints",schemaPath:"#/pro
 return false;
 }
 }
-var valid0 = _errs68 === errors;
 var valid0 = _errs71 === errors;
 }
 else {
 var valid0 = true;

diff --git a/lib/reqIdGenFactory.js b/lib/reqIdGenFactory.js
@@ -1,15  1,26 @@
 'use strict'
 
-module.exports = function () {
 module.exports = function (requestIdHeader, optGenReqId) {
   // 2,147,483,647 (2^31 − 1) stands for max SMI value (an internal optimization of V8).
   // With this upper bound, if you'll be generating 1k ids/sec, you're going to hit it in ~25 days.
   // This is very likely to happen in real-world applications, hence the limit is enforced.
   // Growing beyond this value will make the id generation slower and cause a deopt.
   // In the worst cases, it will become a float, losing accuracy.
   const maxInt = 2147483647
   let nextReqId = 0
-  return function genReqId (req) {
   function defaultGenReqId (req) {
     nextReqId = (nextReqId   1) & maxInt
     return `req-${nextReqId.toString(36)}`
   }
 
   const genReqId = optGenReqId || defaultGenReqId
 
   if (requestIdHeader) {
     // requestIdHeader = typeof requestIdHeader === 'string' ? requestIdHeader : 'request-id'
     return function (req) {
       return req.headers[requestIdHeader] || genReqId(req)
     }
   }
 
   return genReqId
 }
diff --git a/lib/route.js b/lib/route.js
@@ -46,7  46,6 @@ function buildRouting (options) {
 
   let avvio
   let fourOhFour
-  let requestIdHeader
   let requestIdLogLabel
   let logger
   let hasLogger
@@ -74,7  73,6 @@ function buildRouting (options) {
       validateHTTPVersion = fastifyArgs.validateHTTPVersion
 
       globalExposeHeadRoutes = options.exposeHeadRoutes
-      requestIdHeader = options.requestIdHeader
       requestIdLogLabel = options.requestIdLogLabel
       genReqId = options.genReqId
       disableRequestLogging = options.disableRequestLogging
@@ -397,7  395,7 @@ function buildRouting (options) {
       req.headers[kRequestAcceptVersion] = undefined
     }
 
-    const id = req.headers[requestIdHeader] || genReqId(req)
     const id = genReqId(req)
 
     const loggerBinding = {
       [requestIdLogLabel]: id