Merge pull request #484 from open-rpc/fix/example-fallback-to-ajv-result

fix: example rule now falls back to ajv to check the result against the schema

Author: shanejonas

src/rules/examples-rule.test.ts

@@ -0,0 +1,165 @@
+
+import ExamplesRule from "./examples-rule";
+
+describe("ExamplesRule", () => {
+  it("should validate example calls with ajv as the fallback", () => {
+    const rule = new ExamplesRule();
+    const openrpcDocument = {
+      openrpc: "1.0.0",
+      info: {
+        title: "my api",
+        version: "0.0.0-development",
+      },
+      servers: [
+        {
+          name: "my api",
+          url: "http://localhost:3333",
+        },
+      ],
+      methods: [
+        {
+          name: "foo",
+          params: [],
+          result: {
+            name: "fooResult",
+            schema: {
+              type: "string",
+            },
+          },
+          examples: [
+            {
+              name: "fooExample",
+              summary: "foo example",
+              description: "this is an example of foo",
+              params: [
+                {
+                  name: "barParam",
+                  value: "bar",
+                },
+                {
+                  name: "barParam2",
+                  value: "bar",
+                }
+              ],
+              result: {
+                name: "fooResult",
+                value: "potato",
+              }
+            }
+          ]
+        },
+      ],
+    } as any;
+    const calls = rule.getCalls(openrpcDocument, openrpcDocument.methods[0]);
+    calls[0].result = "different";
+    const result = rule.validateCall(calls[0]);
+    expect(result.valid).toBe(true);
+  });
+  it("should not validate example calls with ajv as a callback", () => {
+    const rule = new ExamplesRule();
+    const openrpcDocument = {
+      openrpc: "1.0.0",
+      info: {
+        title: "my api",
+        version: "0.0.0-development",
+      },
+      servers: [
+        {
+          name: "my api",
+          url: "http://localhost:3333",
+        },
+      ],
+      methods: [
+        {
+          name: "foo",
+          params: [],
+          result: {
+            name: "fooResult",
+            schema: {
+              type: "string",
+            },
+          },
+          examples: [
+            {
+              name: "fooExample",
+              summary: "foo example",
+              description: "this is an example of foo",
+              params: [
+                {
+                  name: "barParam",
+                  value: "bar",
+                },
+                {
+                  name: "barParam2",
+                  value: "bar",
+                }
+              ],
+              result: {
+                name: "fooResult",
+                value: "potato",
+              }
+            }
+          ]
+        },
+      ],
+    } as any;
+    const calls = rule.getCalls(openrpcDocument, openrpcDocument.methods[0]);
+    calls[0].result = false;
+    const result = rule.validateCall(calls[0]);
+    expect(result.valid).toBe(false);
+  });
+  it("should not validate example calls with ajv as a callback and just give a good error message if the schema doesnt parse", () => {
+    const rule = new ExamplesRule();
+    const openrpcDocument = {
+      openrpc: "1.0.0",
+      info: {
+        title: "my api",
+        version: "0.0.0-development",
+      },
+      servers: [
+        {
+          name: "my api",
+          url: "http://localhost:3333",
+        },
+      ],
+      methods: [
+        {
+          name: "foo",
+          params: [],
+          result: {
+            name: "fooResult",
+            schema: {
+              type: "string",
+              unevaluatedProperties: false,
+            },
+          },
+          examples: [
+            {
+              name: "fooExample",
+              summary: "foo example",
+              description: "this is an example of foo",
+              params: [
+                {
+                  name: "barParam",
+                  value: "bar",
+                },
+                {
+                  name: "barParam2",
+                  value: "bar",
+                }
+              ],
+              result: {
+                name: "fooResult",
+                value: "potato",
+              }
+            }
+          ]
+        },
+      ],
+    } as any;
+    const calls = rule.getCalls(openrpcDocument, openrpcDocument.methods[0]);
+    calls[0].result = false;
+    const result = rule.validateCall(calls[0]);
+    expect(result.valid).toBe(false);
+  });
+});

src/rules/examples-rule.ts

@@ -3,6 +3,7 @@ import { Call, IOptions } from "../coverage";
 import { isEqual } from "lodash";
 import Rule from "./rule";
 import paramsToObj from "../utils/params-to-obj";
+import Ajv from "ajv";
 
 interface RulesOptions {
   skip: string[];
@@ -54,6 +55,20 @@ class ExamplesRule implements Rule {
         call.expectedResult,
         call.result
       );
+      if (!call.valid) {
+        // try to use ajv to check schema instead
+        try {
+          const ajv = new Ajv();
+          const validate = ajv.compile(call.resultSchema);
+          call.valid = validate(call.result);
+          if (!call.valid) {
+            call.reason = `expected ${JSON.stringify(call.expectedResult)} but got ${JSON.stringify(call.result)} and schema validation failed: ${JSON.stringify(validate.errors)}`;
+          }
+          return call;
+        } catch (e: any) {
+          call.valid = false;
+        }
+      }
       if (!call.valid) {
         call.reason = `expected ${JSON.stringify(call.expectedResult)} but got ${JSON.stringify(call.result)}`;
       }