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

vwong · vwong · commit f1763789b3d1 · 2025-11-12T15:23:56.000+11:00
This reverts commit ef22f35.
diff --git a/src/__tests__/fixtures/pact-formats/results.json b/src/__tests__/fixtures/pact-formats/results.json
@@ -1,35 +1,17 @@
 [
   {
     "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.",
+    "message": "Non-HTTP Interaction is not supported, OPC can only compare HTTP interactions.",
     "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.",
+    "message": "Non-HTTP Interaction is not supported, OPC can only compare HTTP interactions.",
     "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.",
+    "message": "Non-HTTP Interaction is not supported, OPC can only compare HTTP interactions.",
     "type": "warning"
   }
 ]
diff --git a/src/__tests__/fixtures/pact-non-http-interactions-v3/results.json b/src/__tests__/fixtures/pact-non-http-interactions-v3/results.json
@@ -1,73 +1,7 @@
 [
   {
     "code": "interaction.type.unsupported",
-    "mockDetails": {
-      "interactionDescription": "a product created event",
-      "interactionState": "[none]",
-      "location": "[root].messages[0]",
-      "value": {
-        "_id": "e7918bd59533f7fe75b86192865f89898df6cd3f",
-        "contents": {
-          "event": "CREATED",
-          "id": "5cc989d0-d800-434c-b4bb-b1268499e850",
-          "name": "product name",
-          "type": "product series",
-          "version": "v1"
-        },
-        "description": "a product created event",
-        "matchingRules": {
-          "body": {
-            "$.event": {
-              "combine": "AND",
-              "matchers": [
-                {
-                  "match": "regex",
-                  "regex": "^(CREATED|UPDATED|DELETED)$"
-                }
-              ]
-            },
-            "$.id": {
-              "combine": "AND",
-              "matchers": [
-                {
-                  "match": "type"
-                }
-              ]
-            },
-            "$.name": {
-              "combine": "AND",
-              "matchers": [
-                {
-                  "match": "type"
-                }
-              ]
-            },
-            "$.type": {
-              "combine": "AND",
-              "matchers": [
-                {
-                  "match": "type"
-                }
-              ]
-            },
-            "$.version": {
-              "combine": "AND",
-              "matchers": [
-                {
-                  "match": "regex",
-                  "regex": "v[a-zA-z0-9]+"
-                }
-              ]
-            }
-          }
-        },
-        "metaData": {
-          "contentType": "application/json",
-          "kafka_topic": "products"
-        }
-      }
-    },
-    "message": "Non-HTTP messages cannot be verified against an HTTP-only OpenAPI Document.",
+    "message": "Non-HTTP Interaction is not supported, OPC can only compare HTTP interactions.",
     "type": "warning"
   }
 ]
diff --git a/src/__tests__/fixtures/pact-non-http-interactions/results.json b/src/__tests__/fixtures/pact-non-http-interactions/results.json
@@ -1,12 +1,7 @@
 [
   {
     "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.",
+    "message": "Non-HTTP Interaction is not supported, OPC can only compare HTTP interactions.",
     "type": "warning"
   },
   {
diff --git a/src/compare/index.ts b/src/compare/index.ts
@@ -65,18 +65,15 @@ export class Comparator {
 
     const parsedInteractions = parsedPact.interactions || [];
 
+    const UNSUPPORTED_INTERACTION_WARNING = {
+      code: "interaction.type.unsupported",
+      message: `Non-HTTP Interaction is not supported, OPC can only compare HTTP interactions.`,
+      type: "warning",
+    } as Result;
+
     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",
-        };
+      if (interaction._skip) {
+        yield UNSUPPORTED_INTERACTION_WARNING;
         continue;
       }
 
@@ -185,18 +182,8 @@ export class Comparator {
     }
 
     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",
-        };
+      for (const [_message] of parsedPact.messages.entries()) {
+        yield UNSUPPORTED_INTERACTION_WARNING;
       }
     }
   }
diff --git a/src/documents/pact.test.ts b/src/documents/pact.test.ts
@@ -69,8 +69,8 @@ describe("#parser", () => {
     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);
+    expect(pact.interactions![2]._skip).toBe(true);
+    expect(pact.interactions![3]._skip).toBe(true);
   });
 
   it("if messages are present it parses it to be dealt with later", () => {
diff --git a/src/documents/pact.ts b/src/documents/pact.ts
@@ -4,7 +4,7 @@ import Ajv, { ErrorObject } from "ajv";
 // a full schema can be found at https://github.com/pactflow/pact-schemas
 // but we don't use that here, because we try to be permissive with input
 export const Interaction = Type.Object({
-  _nonHTTP: Type.Optional(Type.Boolean()),
+  _skip: Type.Optional(Type.Boolean()),
   type: Type.Optional(Type.String()),
   description: Type.Optional(Type.String()),
   providerState: Type.Optional(Type.String()),
@@ -43,13 +43,6 @@ export const Interaction = Type.Object({
 
 export type Interaction = Static<typeof Interaction>;
 
-export const Message = Type.Object({
-  description: Type.Optional(Type.String()),
-  providerState: Type.Optional(Type.String()),
-});
-
-export type Message = Static<typeof Message>;
-
 export const Pact = Type.Object({
   metadata: Type.Optional(
     Type.Object({
@@ -67,7 +60,7 @@ export const Pact = Type.Object({
     }),
   ),
   interactions: Type.Optional(Type.Array(Interaction)),
-  messages: Type.Optional(Type.Array(Message)),
+  messages: Type.Optional(Type.Array(Type.Unknown())),
 });
 
 export type Pact = Static<typeof Pact>;
@@ -158,11 +151,6 @@ const interactionV4 = (i: Interaction): Interaction => ({
   },
 });
 
-const interactionNonHTTP = (i: Interaction): Interaction => ({
-  ...i,
-  _nonHTTP: true,
-});
-
 const ajv = new Ajv();
 const validate = ajv.compile(Pact);
 
@@ -190,7 +178,9 @@ export const parse = (pact: Pact): Pact => {
   return {
     metadata,
     interactions: interactions?.map((i: Interaction) =>
-      supportedInteractions(i) ? interactionParser(i) : interactionNonHTTP(i),
+      supportedInteractions(i)
+        ? interactionParser(i)
+        : ({ _skip: true } as Interaction),
     ),
     messages,
   };

Original file line number	Diff line number	Diff line change
`@@ -1,12 +1,7 @@`
`1`	`1`	`[`
`2`	`2`	`{`
`3`	`3`	`"code": "interaction.type.unsupported",`
`4`		`- "mockDetails": {`
`5`		`- "interactionState": "[none]",`
`6`		`- "location": "[root].interactions[0].type",`
`7`		`- "value": "Async/Messages"`
`8`		`- },`
`9`		`- "message": "Non-HTTP messages cannot be verified against an HTTP-only OpenAPI Document.",`
	`4`	`+ "message": "Non-HTTP Interaction is not supported, OPC can only compare HTTP interactions.",`
`10`	`5`	`"type": "warning"`
`11`	`6`	`},`
`12`	`7`	`{`