Merge ac119e6 into bb744c6

packages/openapi-request-validator/index.ts

@@ -37,6 +37,7 @@ export interface OpenAPIRequestValidatorArgs {
     ajvError: ErrorObject
   ): any;
   ajvOptions?: Options;
+  enableHeadersLowercase?: boolean;
 }
 
 export interface OpenAPIRequestValidatorError {
@@ -61,6 +62,7 @@ export default class OpenAPIRequestValidator
   private validateHeaders: ValidateFunction;
   private validatePath: ValidateFunction;
   private validateQuery: ValidateFunction;
+  private enableHeadersLowercase: boolean = true;
 
   constructor(args: OpenAPIRequestValidatorArgs) {
     const loggingKey = args && args.loggingKey ? args.loggingKey + ': ' : '';
@@ -73,6 +75,10 @@ export default class OpenAPIRequestValidator
       this.logger = args.logger;
     }
 
+    if (args.hasOwnProperty('enableHeadersLowercase')) {
+      this.enableHeadersLowercase = args.enableHeadersLowercase;
+    }
+
     const errorTransformer =
       typeof args.errorTransformer === 'function' && args.errorTransformer;
     const errorMapper = errorTransformer
@@ -90,7 +96,10 @@ export default class OpenAPIRequestValidator
       if (Array.isArray(args.parameters)) {
         const schemas = convertParametersToJSONSchema(args.parameters);
         bodySchema = schemas.body;
-        headersSchema = lowercasedHeaders(schemas.headers);
+        headersSchema = lowercasedHeaders(
+          schemas.headers,
+          this.enableHeadersLowercase
+        );
         formDataSchema = schemas.formData;
         pathSchema = schemas.path;
         querySchema = schemas.query;
@@ -343,8 +352,11 @@ export default class OpenAPIRequestValidator
     }
 
     if (this.validateHeaders) {
-      if (
-        !this.validateHeaders(lowercaseRequestHeaders(request.headers || {}))
+      if (!this.validateHeaders(
+        lowercaseRequestHeaders(
+          request.headers || {}, 
+          this.enableHeadersLowercase)
+        )
       ) {
         errors.push.apply(
           errors,
@@ -485,16 +497,22 @@ function getSchemaForMediaType(
   return match;
 }
 
-function lowercaseRequestHeaders(headers) {
-  const lowerCasedHeaders = {};
-  Object.keys(headers).forEach((header) => {
-    lowerCasedHeaders[header.toLowerCase()] = headers[header];
-  });
-  return lowerCasedHeaders;
+function lowercaseRequestHeaders(headers, enableHeadersLowercase: boolean) {
+  if (enableHeadersLowercase) {
+    const lowerCasedHeaders = {};
+
+    Object.keys(headers).forEach((header) => {
+      lowerCasedHeaders[header.toLowerCase()] = headers[header];
+    });
+
+    return lowerCasedHeaders;
+  } else {
+    return headers;
+  }
 }
 
-function lowercasedHeaders(headersSchema) {
-  if (headersSchema) {
+function lowercasedHeaders(headersSchema, enableHeadersLowercase: boolean) {
+  if (headersSchema && enableHeadersLowercase) {
     const properties = headersSchema.properties;
     Object.keys(properties).forEach((header) => {
       const property = properties[header];

packages/openapi-request-validator/test/data-driven/accept-a-required-header-param-keep-case.js

@@ -0,0 +1,19 @@
+module.exports = {
+  validateArgs: {
+    enableHeadersLowercase: false,
+    parameters: [
+      {
+        in: 'header',
+        name: 'X-foO',
+        type: 'string',
+        required: true,
+      },
+    ],
+    schemas: null,
+  },
+  request: {
+    headers: {
+      'X-foO': 'asdf',
+    },
+  },
+};

packages/openapi-request-validator/test/data-driven/fail-headers-key-keep-case.js

@@ -0,0 +1,26 @@
+module.exports = {
+  validateArgs: {
+    enableHeadersLowercase: false,
+    parameters: [
+      {
+        in: 'header',
+        name: 'Foo-Bar',
+        type: 'string',
+        required: true,
+      },
+    ],
+    schemas: null,
+  },
+  request: {},
+  expectedError: {
+    status: 400,
+    errors: [
+      {
+        path: 'Foo-Bar',
+        errorCode: 'required.openapi.requestValidation',
+        message: "must have required property 'Foo-Bar'",
+        location: 'headers',
+      },
+    ],
+  },
+};

packages/openapi-request-validator/test/data-driven/fail-headers-key-lowercase.js

@@ -0,0 +1,25 @@
+module.exports = {
+  validateArgs: {
+    parameters: [
+      {
+        in: 'header',
+        name: 'Foo-Bar',
+        type: 'string',
+        required: true,
+      },
+    ],
+    schemas: null,
+  },
+  request: {},
+  expectedError: {
+    status: 400,
+    errors: [
+      {
+        path: 'foo-bar',
+        errorCode: 'required.openapi.requestValidation',
+        message: "must have required property 'foo-bar'",
+        location: 'headers',
+      },
+    ],
+  },
+};