fix: infinite recursion + change behaviour to match SMV

Author: vwong

src/__tests__/fixtures/example-petstore-1/results.json

@@ -98,6 +98,45 @@
     },
     "type": "error"
   },
+  {
+    "code": "request.accept.unknown",
+    "message": "Request Accept header is defined but the spec does not specify any mime-types to produce",
+    "mockDetails": {
+      "interactionDescription": "a request to create a pet with invalid body",
+      "interactionState": "[none]",
+      "location": "[root].interactions[1].request.headers.accept",
+      "value": "application/json"
+    },
+    "specDetails": {
+      "location": "[root].paths./pet.post",
+      "pathMethod": "post",
+      "pathName": "/pet",
+      "value": {
+        "tags": [
+          "pet"
+        ],
+        "summary": "Add a new pet to the store",
+        "operationId": "addPet",
+        "responses": {
+          "405": {
+            "description": "Invalid input"
+          }
+        },
+        "security": [
+          {
+            "petstore_auth": [
+              "write:pets",
+              "read:pets"
+            ]
+          }
+        ],
+        "requestBody": {
+          "$ref": "#/components/requestBodies/Pet"
+        }
+      }
+    },
+    "type": "warning"
+  },
   {
     "code": "response.content-type.unknown",
     "message": "Response Content-Type header is defined but the spec does not specify any mime-types to produce",

src/__tests__/fixtures/example-petstore-2/results.json

@@ -98,6 +98,45 @@
     },
     "type": "error"
   },
+  {
+    "code": "request.accept.unknown",
+    "message": "Request Accept header is defined but the spec does not specify any mime-types to produce",
+    "mockDetails": {
+      "interactionDescription": "a request to create a pet with invalid body",
+      "interactionState": "[none]",
+      "location": "[root].interactions[1].request.headers.accept",
+      "value": "application/json"
+    },
+    "specDetails": {
+      "location": "[root].paths./pet.post",
+      "pathMethod": "post",
+      "pathName": "/pet",
+      "value": {
+        "tags": [
+          "pet"
+        ],
+        "summary": "Add a new pet to the store",
+        "operationId": "addPet",
+        "responses": {
+          "405": {
+            "description": "Invalid input"
+          }
+        },
+        "security": [
+          {
+            "petstore_auth": [
+              "write:pets",
+              "read:pets"
+            ]
+          }
+        ],
+        "requestBody": {
+          "$ref": "#/components/requestBodies/Pet"
+        }
+      }
+    },
+    "type": "warning"
+  },
   {
     "code": "response.content-type.unknown",
     "message": "Response Content-Type header is defined but the spec does not specify any mime-types to produce",

src/__tests__/fixtures/response-body-swagger2/results.json

@@ -18,7 +18,7 @@
   },
   {
     "code": "response.body.incompatible",
-    "message": "Response body is incompatible with the response body schema in the spec file: must have required property 'age'",
+    "message": "Response body is incompatible with the response body schema in the spec file: must NOT have additional properties - detail",
     "mockDetails": {
       "interactionDescription": "should error with invalid response",
       "interactionState": "[none]",
@@ -29,13 +29,10 @@
       }
     },
     "specDetails": {
-      "location": "[root].paths./animal.get.responses.200.content.application/json.schema.definitions.Animal.required",
+      "location": "[root].paths./animal.get.responses.200.content.application/json.schema.definitions.Animal.additionalProperties",
       "pathMethod": "get",
       "pathName": "/animal",
-      "value": [
-        "name",
-        "age"
-      ]
+      "value": false
     },
     "type": "error"
   }

src/__tests__/fixtures/response-body/baseline.json

@@ -40,7 +40,7 @@
     "code": "response.body.unknown",
     "message": "No matching schema found for response body",
     "mockDetails": {
-      "interactionDescription": "should error with unknown respos body",
+      "interactionDescription": "should error with unknown response body",
       "interactionState": "[none]",
       "location": "[root].interactions[6].response.body",
       "value": {
@@ -62,7 +62,7 @@
     "code": "response.content-type.unknown",
     "message": "Response Content-Type header is defined but the spec does not specify any mime-types to produce",
     "mockDetails": {
-      "interactionDescription": "should error with unknown respos body",
+      "interactionDescription": "should error with unknown response body",
       "interactionState": "[none]",
       "location": "[root].interactions[6].response.headers.Content-Type",
       "value": "application/json"

src/__tests__/fixtures/response-body/pact.json

@@ -125,7 +125,7 @@
       }
     },
     {
-      "description": "should error with unknown respos body",
+      "description": "should error with unknown response body",
       "request": {
         "method": "GET",
         "path": "/no-response-schema"

src/__tests__/fixtures/response-body/results.json

@@ -40,7 +40,7 @@
     "code": "response.content-type.unknown",
     "message": "Response Content-Type header is defined but the spec does not specify any mime-types to produce",
     "mockDetails": {
-      "interactionDescription": "should error with unknown respos body",
+      "interactionDescription": "should error with unknown response body",
       "interactionState": "[none]",
       "location": "[root].interactions[6].response.headers.content-type",
       "value": "application/json"
@@ -64,7 +64,7 @@
     "code": "response.body.unknown",
     "message": "No matching schema found for response body",
     "mockDetails": {
-      "interactionDescription": "should error with unknown respos body",
+      "interactionDescription": "should error with unknown response body",
       "interactionState": "[none]",
       "location": "[root].interactions[6].response.body",
       "value": {

src/compare/requestHeader.ts

@@ -32,6 +32,17 @@ export function* compareReqHeader(
     Object.keys(
       dereferenceOas(operation.requestBody || {}, oas)?.content || {},
     );
+  const allAvailableResponseContentTypes =
+    operation.produces ||
+    Object.entries(operation.responses).reduce(
+      (acc: string[], [_status, response]) => {
+        return [
+          ...acc,
+          ...Object.keys(dereferenceOas(response || {}, oas)?.content || {}),
+        ];
+      },
+      [],
+    );
   const availableResponseContentType =
     operation.produces ||
     Object.keys(
@@ -49,11 +60,7 @@ export function* compareReqHeader(
   const requestAccept: string =
     requestHeaders.get("accept")?.split(";")[0] || "";
 
-  if (
-    requestAccept &&
-    !availableResponseContentType.length &&
-    isValidRequest(interaction)
-  ) {
+  if (requestAccept && !allAvailableResponseContentTypes.length) {
     yield {
       code: "request.accept.unknown",
       message:

src/utils/schema.ts

@@ -43,16 +43,24 @@ export const traverse = (
 const _traverseWithDereferencing = (
   schema: SchemaObject,
   oas: OpenAPIV3.Document,
+  visited: string[],
   visitor: (schema: SchemaObject) => void,
 ) => {
   if (typeof schema === "boolean" || schema === undefined) {
     return;
   }
 
+  if (visited.includes(schema.$ref)) {
+    return;
+  }
+
+  if (schema.$ref) {
+    visited.push(schema.$ref);
+  }
   const dereferencedSchema = dereferenceOas(schema, oas);
 
   const traverseSubSchema = (item: SchemaObject) =>
-    _traverseWithDereferencing(item, oas, visitor);
+    _traverseWithDereferencing(item, oas, visited, visitor);
 
   each(dereferencedSchema.allOf, traverseSubSchema);
   each(dereferencedSchema.oneOf, traverseSubSchema);
@@ -69,5 +77,5 @@ export const traverseWithDereferencing = (
   schema: SchemaObject,
   visitor: (schema: SchemaObject) => void,
 ) => {
-  _traverseWithDereferencing(schema, schema as OpenAPIV3.Document, visitor);
+  _traverseWithDereferencing(schema, schema as OpenAPIV3.Document, [], visitor);
 };