fix: support escaping json path

Author: vwong

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

@@ -42,6 +42,49 @@
     },
     "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",
+        "providerState": "",
+        "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[1]",
+      "pathMethod": "post",
+      "pathName": "/login",
+      "value": {
+        "in": "query",
+        "name": "nested",
+        "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'",

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

@@ -8,6 +8,7 @@ paths:
     post:
       parameters:
         - $ref: "#/components/parameters/Request.Param"
+        - $ref: "#/components/parameters/nested.param~1with~0tilde"
       requestBody:
         $ref: "#/components/requestBodies/Request.Body"
       responses:
@@ -22,6 +23,12 @@ components:
       required: true
       schema:
         type: string
+    "nested.param/with~tilde":
+      in: query
+      name: nested
+      required: true
+      schema:
+        type: string
   requestBodies:
     Request.Body:
       content:

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

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

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

@@ -15,6 +15,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.nested."
+    },
+    "specDetails": {
+      "location": "[root].paths./login.post.parameters[1].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/compare/setup.ts

@@ -4,6 +4,7 @@ import addFormats from "ajv-formats";
 import Router, { HTTPMethod } from "find-my-way";
 import { uniqWith } from "lodash-es";
 import { cleanPathParameter } from "./utils/parameters";
+import { dereferenceOas } from "../utils/schema";
 
 export function setupAjv(options: Options): Ajv {
   const ajv = new Ajv(options);
@@ -51,7 +52,7 @@ export function setupRouter(
         [
           ...(operation.parameters || []),
           ...(oas.paths[oasPath].parameters || []),
-        ] as OpenAPIV3.ParameterObject[],
+        ].map((p) => dereferenceOas(p, oas as OpenAPIV3.Document)),
         (a, b) => `${a.name}${a.in}` === `${b.name}${b.in}`,
       );
       if (parameters.length) {

src/utils/schema.ts

@@ -2,13 +2,16 @@ import type { OpenAPIV3 } from "openapi-types";
 import type { SchemaObject } from "ajv";
 import { each, get } from "lodash-es";
 
+const unescape = (subpath: string) =>
+  subpath.replaceAll("~1", "/").replaceAll("~0", "~");
+
 export const splitPath = (path: string) => {
   if (path.startsWith("#/")) {
-    return path.substring(2).split("/");
+    return path.substring(2).split("/").map(unescape);
   }
 
   if (path.startsWith("/")) {
-    return path.substring(1).split("/");
+    return path.substring(1).split("/").map(unescape);
   }
 
   return path;