feat: remove warnings about unsupported interactions (#433)

* Revert "feat: add mockDetails to non-http warnings (#428)"

This reverts commit ef22f35.

* Revert "chore: added warning for message comparison and added handling when interactions array in null or undefined (#422)"

This reverts commit 1d35775.

* chore: add changeset

Author: vwong

.changeset/six-towns-film.md

@@ -0,0 +1,5 @@
+---
+"@pactflow/openapi-pact-comparator": minor
+---
+
+Remove warnings about unsupported interaction types

src/__tests__/fixtures/pact-formats/results.json

@@ -1,35 +1 @@
-[
-  {
-    "code": "interaction.type.unsupported",
-    "mockDetails": {
-      "interactionDescription": "should be ignored",
-      "interactionState": "[none]",
-      "location": "[root].interactions[0].type",
-      "value": "Asynchronous/Messages"
-    },
-    "message": "Non-HTTP messages cannot be verified against an HTTP-only OpenAPI Document.",
-    "type": "warning"
-  },
-  {
-    "code": "interaction.type.unsupported",
-    "mockDetails": {
-      "interactionDescription": "should be ignored",
-      "interactionState": "[none]",
-      "location": "[root].interactions[1].type",
-      "value": "Synchronous/Messages"
-    },
-    "message": "Non-HTTP messages cannot be verified against an HTTP-only OpenAPI Document.",
-    "type": "warning"
-  },
-  {
-    "code": "interaction.type.unsupported",
-    "mockDetails": {
-      "interactionDescription": "should be ignored",
-      "interactionState": "[none]",
-      "location": "[root].interactions[2].type",
-      "value": "not-a-real-type"
-    },
-    "message": "Non-HTTP messages cannot be verified against an HTTP-only OpenAPI Document.",
-    "type": "warning"
-  }
-]
+[]

src/__tests__/fixtures/pact-non-http-interactions-v3/oas.yaml

@@ -1,14 +1,4 @@
 [
-  {
-    "code": "interaction.type.unsupported",
-    "mockDetails": {
-      "interactionState": "[none]",
-      "location": "[root].interactions[0].type",
-      "value": "Async/Messages"
-    },
-    "message": "Non-HTTP messages cannot be verified against an HTTP-only OpenAPI Document.",
-    "type": "warning"
-  },
   {
     "code": "request.body.incompatible",
     "message": "Request body is incompatible with the request body schema in the spec file: must be object",

src/__tests__/fixtures/pact-non-http-interactions-v3/pact.json

@@ -63,20 +63,9 @@ export class Comparator {
 
     const parsedPact = parsePact(pact);
 
-    const parsedInteractions = parsedPact.interactions || [];
-
-    for (const [index, interaction] of parsedInteractions.entries()) {
-      if (interaction._nonHTTP) {
-        yield {
-          code: "interaction.type.unsupported",
-          mockDetails: {
-            ...baseMockDetails(interaction),
-            location: `[root].interactions[${index}].type`,
-            value: interaction.type,
-          },
-          message: `Non-HTTP messages cannot be verified against an HTTP-only OpenAPI Document.`,
-          type: "warning",
-        };
+    for (const [index, interaction] of parsedPact.interactions.entries()) {
+      if (interaction._skip) {
+        // non http/synchronous have been zero-ed out
         continue;
       }
 
@@ -183,21 +172,5 @@ export class Comparator {
         this.#config,
       );
     }
-
-    if (parsedPact.messages) {
-      for (const [index, message] of parsedPact.messages.entries()) {
-        yield {
-          code: "interaction.type.unsupported",
-          mockDetails: {
-            interactionDescription: message.description,
-            interactionState: message.providerState || "[none]",
-            location: `[root].messages[${index}]`,
-            value: message,
-          },
-          message: `Non-HTTP messages cannot be verified against an HTTP-only OpenAPI Document.`,
-          type: "warning",
-        };
-      }
-    }
   }
 }

src/__tests__/fixtures/pact-non-http-interactions-v3/results.json

@@ -25,15 +25,15 @@ describe("#parser", () => {
       ],
     } as Pact;
 
-    const { request, response } = parse(json).interactions![0];
+    const { request, response } = parse(json).interactions[0];
     expect(request.headers!["Content-Type"]).toEqual("text/json");
     expect(request.headers!["Accept"]).toEqual(
       "text/plain,application/json,text/json",
     );
     expect(response.headers!["Content-Type"]).toEqual("application/json");
   });
 
-  it("marks out non-HTTP interactions from v4 pact as skip `true`", () => {
+  it("filters out non-HTTP interactions", () => {
     const request = {
       method: "GET",
       path: "/path",
@@ -66,35 +66,11 @@ describe("#parser", () => {
     };
 
     const pact = parse(json as Pact);
-    expect(pact.interactions!.length).toBe(4);
-    expect(pact.interactions![0].description).toBe("no-type");
-    expect(pact.interactions![1].description).toBe("http");
-    expect(pact.interactions![2]._nonHTTP).toBe(true);
-    expect(pact.interactions![3]._nonHTTP).toBe(true);
-  });
-
-  it("if messages are present it parses it to be dealt with later", () => {
-    const request = {
-      method: "GET",
-      path: "/path",
-    };
-    const response = {
-      status: 200,
-    };
-    const json = {
-      interactions: [{ description: "no-type", request, response }],
-      messages: [
-        {
-          content: "some-message-content",
-        },
-      ],
-    };
-
-    const pact = parse(json as Pact);
-    expect(pact.interactions!.length).toBe(1);
-    expect(pact.interactions![0].description).toBe("no-type");
-    expect(pact.messages!.length).toBe(1);
-    expect(pact.messages![0]).toEqual({ content: "some-message-content" });
+    expect(pact.interactions.length).toBe(4);
+    expect(pact.interactions[0].description).toBe("no-type");
+    expect(pact.interactions[1].description).toBe("http");
+    expect(pact.interactions[2]._skip).toBe(true);
+    expect(pact.interactions[3]._skip).toBe(true);
   });
 
   it("should parse V4 body types", () => {
@@ -163,13 +139,13 @@ describe("#parser", () => {
 
     const pact = parse(json as Pact);
 
-    expect(pact.interactions![0].response.body).toEqual({ hello: "world" });
-    expect(pact.interactions![1].response.body).toEqual({ hello: "world" });
-    expect(pact.interactions![2].response.body).toEqual("hello world");
-    expect(pact.interactions![3].request.body).toEqual({ hello: "world" });
-    expect(pact.interactions![4].request.body).toEqual({ hello: "world" });
-    expect(pact.interactions![5].request.body).toEqual("hello world");
-    expect(pact.interactions![6].request.body).toEqual("{ not: json }");
-    expect(pact.interactions![7].request.body).toEqual("abcdef");
+    expect(pact.interactions[0].response.body).toEqual({ hello: "world" });
+    expect(pact.interactions[1].response.body).toEqual({ hello: "world" });
+    expect(pact.interactions[2].response.body).toEqual("hello world");
+    expect(pact.interactions[3].request.body).toEqual({ hello: "world" });
+    expect(pact.interactions[4].request.body).toEqual({ hello: "world" });
+    expect(pact.interactions[5].request.body).toEqual("hello world");
+    expect(pact.interactions[6].request.body).toEqual("{ not: json }");
+    expect(pact.interactions[7].request.body).toEqual("abcdef");
   });
 });