Resolves kogosoftwarellc#875: adds response arg to openapi-response-v…

…alidator errorTransformer callback
webketje · May 26, 2023 · e98077b · e98077b
1 parent 09fed6d
commit e98077b
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 11 deletions.
diff --git a/packages/openapi-response-validator/index.ts b/packages/openapi-response-validator/index.ts
@@ -10,7 +10,7 @@ const LOCAL_DEFINITION_REGEX = /^#\/([^\/]+)\/([^\/]+)$/;
 
 export interface IOpenAPIResponseValidator {
   validateResponse(
-    statusCode: string,
+    statusCode: number|string,
     response: any
   ): void | OpenAPIResponseValidatorValidationError;
 }
@@ -35,7 +35,8 @@ export interface OpenAPIResponseValidatorArgs {
 
   errorTransformer?(
     openAPIResponseValidatorValidationError: OpenAPIResponseValidatorError,
-    ajvError: ErrorObject
+    ajvError: ErrorObject,
+    response: any
   ): any;
 }
 
@@ -52,7 +53,7 @@ export interface OpenAPIResponseValidatorValidationError {
 
 export default class OpenAPIResponseValidator
   implements IOpenAPIResponseValidator {
-  private errorMapper: (ajvError: ErrorObject) => any;
+  private errorMapper: (ajvError: ErrorObject, response:any) => any;
   private validators: {
     [responseCode: string]: ValidateFunction;
   };
@@ -111,8 +112,8 @@ export default class OpenAPIResponseValidator
     this.validators = compileValidators(v, schemas);
   }
 
-  public validateResponse(statusCode, response) {
-    let validator;
+  public validateResponse(statusCode:number|string, response) {
+    let validator:ValidateFunction;
 
     if (statusCode && statusCode in this.validators) {
       validator = this.validators[statusCode];
@@ -143,15 +144,15 @@ export default class OpenAPIResponseValidator
     if (!isValid) {
       return {
         message: 'The response was not valid.',
-        errors: validator.errors.map(this.errorMapper),
+        errors: validator.errors.map((err) => this.errorMapper(err, response)),
       };
     }
 
     return undefined;
   }
 }
 
-function compileValidators(v, schemas) {
+function compileValidators(v:Ajv, schemas:Record<string, unknown>) {
   const validators = {};
 
   Object.keys(schemas).forEach((name) => {
@@ -192,8 +193,8 @@ function getSchemas(responses, definitions, components) {
   return schemas;
 }
 
-function makeErrorMapper(mapper): (ajvError: ErrorObject) => any {
-  return (ajvError) => mapper(toOpenapiValidationError(ajvError), ajvError);
+function makeErrorMapper(mapper) {
+  return (ajvError:ErrorObject, response:any) => mapper(toOpenapiValidationError(ajvError), ajvError, response);
 }
 
 function toOpenapiValidationError(

diff --git a/...ages/openapi-response-validator/test/data-driven/use-errorTransformer-to-format-errors.js b/...ages/openapi-response-validator/test/data-driven/use-errorTransformer-to-format-errors.js
@@ -15,7 +15,7 @@ module.exports = {
 
     definitions: null,
 
-    errorTransformer: function (openapiError, jsonschemaError) {
+    errorTransformer: function (openapiError, jsonschemaError, response) {
       return arguments.length;
     },
   },
@@ -25,6 +25,6 @@ module.exports = {
 
   expectedValidationError: {
     message: 'The response was not valid.',
-    errors: [2],
+    errors: [3],
   },
 };
diff --git a/...ges/openapi-response-validator/test/data-driven/use-errorTransformer-with-response-arg.js b/...ges/openapi-response-validator/test/data-driven/use-errorTransformer-with-response-arg.js
@@ -0,0 +1,30 @@
+module.exports = {
+  constructorArgs: {
+    responses: {
+      200: {
+        schema: {
+          type: 'object',
+          properties: {
+            foo: {
+              type: 'string',
+            },
+          },
+        },
+      },
+    },
+
+    definitions: null,
+
+    errorTransformer: function (openapiError, jsonschemaError, response) {
+      return `Incorrect type "${typeof response.foo}" for "${openapiError.path}": ${openapiError.message}`;
+    },
+  },
+
+  inputStatusCode: 200,
+  inputResponseBody: { foo: 2345 },
+
+  expectedValidationError: {
+    message: 'The response was not valid.',
+    errors: ['Incorrect type "number" for "foo": must be string'],
+  },
+};