fix: handle uri encoding in oas references (#137)

Author: vwong

.changeset/little-webs-stand.md

@@ -0,0 +1,5 @@
+---
+"@pactflow/openapi-pact-comparator": minor
+---
+
+Handle URI encoding in OAS references

src/__tests__/fixtures/oas-references/oas.yaml

@@ -9,6 +9,7 @@ paths:
       parameters:
         - $ref: "#/components/parameters/Request.Param"
         - $ref: "#/components/parameters/nested.param~1with~0tilde"
+        - $ref: "#/components/parameters/nested.param.with%7Bbrackets%7D"
       requestBody:
         $ref: "#/components/requestBodies/Request.Body"
       responses:
@@ -39,6 +40,12 @@ components:
       required: true
       schema:
         type: string
+    "nested.param.with{brackets}":
+      in: query
+      name: bracket
+      required: true
+      schema:
+        type: string
   requestBodies:
     Request.Body:
       required: true

src/__tests__/fixtures/oas-references/opc-results.json

@@ -31,6 +31,22 @@
     },
     "type": "error"
   },
+  {
+    "code": "request.query.incompatible",
+    "message": "Value is incompatible with the parameter defined in the spec file: must be string",
+    "mockDetails": {
+      "interactionDescription": "should fail with missing parameters",
+      "interactionState": "[none]",
+      "location": "[root].interactions[1].request.query.bracket"
+    },
+    "specDetails": {
+      "location": "[root].paths./login.post.parameters[2].schema.type",
+      "pathMethod": "post",
+      "pathName": "/login",
+      "value": "string"
+    },
+    "type": "error"
+  },
   {
     "code": "request.body.incompatible",
     "message": "Request body is incompatible with the request body schema in the spec file: must have required property 'username'",

src/__tests__/fixtures/oas-references/pact.json

@@ -7,7 +7,7 @@
       "request": {
         "method": "POST",
         "path": "/login",
-        "query": "account=foo&nested=bar",
+        "query": "account=foo&nested=bar&bracket=baz",
         "headers": {
           "Content-Type": "application/json"
         },
@@ -49,7 +49,7 @@
       "request": {
         "method": "POST",
         "path": "/login",
-        "query": "account=foo&nested=bar",
+        "query": "account=foo&nested=bar&bracket=baz",
         "headers": {
           "Content-Type": "application/json"
         },
@@ -67,7 +67,7 @@
       "request": {
         "method": "POST",
         "path": "/login",
-        "query": "account=foo&nested=bar",
+        "query": "account=foo&nested=bar&bracket=baz",
         "headers": {
           "Content-Type": "application/json"
         },
@@ -90,7 +90,7 @@
       "request": {
         "method": "POST",
         "path": "/login",
-        "query": "account=foo&nested=bar",
+        "query": "account=foo&nested=bar&bracket=baz",
         "headers": {
           "Content-Type": "application/json"
         },

src/__tests__/fixtures/oas-references/smv-results.json

@@ -83,6 +83,48 @@
     },
     "type": "error"
   },
+  {
+    "code": "request.query.incompatible",
+    "message": "Value is incompatible with the parameter defined in the spec file: must have required property 'value'",
+    "mockDetails": {
+      "interactionDescription": "should fail with missing parameters",
+      "interactionState": "[none]",
+      "location": "[root].interactions[1]",
+      "value": {
+        "description": "should fail with missing parameters",
+        "request": {
+          "method": "POST",
+          "path": "/login",
+          "headers": {
+            "Content-Type": "application/json"
+          },
+          "body": {
+            "username": "bob"
+          }
+        },
+        "response": {
+          "status": 201,
+          "body": {
+            "id": "123"
+          }
+        }
+      }
+    },
+    "specDetails": {
+      "location": "[root].paths./login.post.parameters[2]",
+      "pathMethod": "post",
+      "pathName": "/login",
+      "value": {
+        "in": "query",
+        "name": "bracket",
+        "required": true,
+        "schema": {
+          "type": "string"
+        }
+      }
+    },
+    "type": "error"
+  },
   {
     "code": "request.body.incompatible",
     "message": "Request body is incompatible with the request body schema in the spec file: must have required property 'username'",
@@ -175,6 +217,14 @@
                 "schema": {
                   "type": "string"
                 }
+              },
+              {
+                "in": "query",
+                "name": "bracket",
+                "required": true,
+                "schema": {
+                  "type": "string"
+                }
               }
             ],
             "requestBody": {

src/utils/schema.ts

@@ -3,7 +3,7 @@ import type { SchemaObject } from "ajv";
 import { each, get } from "lodash-es";
 
 const unescape = (subpath: string) =>
-  subpath.replaceAll("~1", "/").replaceAll("~0", "~");
+  decodeURI(subpath.replaceAll("~1", "/").replaceAll("~0", "~"));
 
 export const splitPath = (path: string) => {
   if (path.startsWith("#/")) {