fix: use default response to test headers (#86)

Author: vwong

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

@@ -140,7 +140,7 @@
     "code": "response.status.default",
     "message": "Response status code matched default response in spec file: 200",
     "mockDetails": {
-      "interactionDescription": "should error based on default response",
+      "interactionDescription": "should use default response",
       "interactionState": "[none]",
       "location": "[root].interactions[6].response.status",
       "value": 200
@@ -161,7 +161,14 @@
           },
           "content": {
             "application/json": {
-              "schema": {}
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string"
+                  }
+                }
+              }
             }
           }
         }

src/__tests__/fixtures/response-header/oas.yaml

@@ -48,4 +48,8 @@ paths:
                 type: number
           content:
             application/json:
-              schema: {}
+              schema:
+                type: object
+                properties:
+                  name:
+                    type: string

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

@@ -86,7 +86,7 @@
       }
     },
     {
-      "description": "should error based on default response",
+      "description": "should use default response",
       "request": {
         "method": "GET",
         "path": "/default"
@@ -96,6 +96,9 @@
         "headers": {
           "Content-Type": "application/json",
           "specified": "5"
+        },
+        "body": {
+          "name": "name"
         }
       }
     },

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

@@ -130,46 +130,11 @@
     },
     "type": "error"
   },
-  {
-    "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 based on default response",
-      "interactionState": "[none]",
-      "location": "[root].interactions[6].response.headers.content-type",
-      "value": "application/json"
-    },
-    "specDetails": {
-      "location": "[root].paths./default.get",
-      "pathMethod": "get",
-      "pathName": "/default",
-      "value": {
-        "responses": {
-          "default": {
-            "description": "OK",
-            "headers": {
-              "specified": {
-                "schema": {
-                  "type": "number"
-                }
-              }
-            },
-            "content": {
-              "application/json": {
-                "schema": {}
-              }
-            }
-          }
-        }
-      }
-    },
-    "type": "warning"
-  },
   {
     "code": "response.status.default",
     "message": "Response status code matched default response in spec file: 200",
     "mockDetails": {
-      "interactionDescription": "should error based on default response",
+      "interactionDescription": "should use default response",
       "interactionState": "[none]",
       "location": "[root].interactions[6].response.status",
       "value": 200
@@ -190,7 +155,14 @@
           },
           "content": {
             "application/json": {
-              "schema": {}
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string"
+                  }
+                }
+              }
             }
           }
         }

src/compare/responseHeader.ts

@@ -24,29 +24,25 @@ export function* compareResHeader(
 ): Iterable<Result> {
   const { method, oas, operation, path } = route.store;
 
-  const availableResponseContentType =
-    operation.produces ||
-    Object.keys(
-      dereferenceOas(
-        operation.responses[interaction.response.status] || {},
-        oas,
-      )?.content || {},
-    );
-  const responseHeaders = new Headers(
-    interaction.response.headers as Record<string, string>,
-  );
-
-  // no response found
-  // -----------------
   const response =
     operation.responses[interaction.response.status] ||
     operation.responses["default"];
+
+  // no response found
+  // -----------------
   if (!response) {
     return;
   }
 
   // response content-type
   // ---------------------
+  const availableResponseContentType =
+    operation.produces ||
+    Object.keys(dereferenceOas(response || {}, oas)?.content || {});
+  const responseHeaders = new Headers(
+    interaction.response.headers as Record<string, string>,
+  );
+
   const responseContentType =
     responseHeaders.get("content-type")?.split(";")[0] || "";