faster error messages, optin

package.json

@@ -36,6 +36,7 @@
     "@apidevtools/json-schema-ref-parser": "^9.0.1",
     "ajv": "^6.10.2",
     "better-ajv-errors": "^0.6.7",
+    "chalk": "^4.1.0",
     "expect": "^26.0.0",
     "jest-matcher-utils": "^26.0.0",
     "lodash": "^4.17.15"

src/getErrorMessage.ts

@@ -0,0 +1,32 @@
+import Ajv from "ajv";
+import betterAjvErrors from "better-ajv-errors";
+import chalk from "chalk";
+
+export function getErrorMessage(
+  schema: any,
+  received: any,
+  errors: Ajv.ErrorObject[] | null | undefined,
+  { bailFast }: { bailFast: boolean }
+) {
+  const errs = errors || [];
+  if (!bailFast || errs.length < 20) {
+    return betterAjvErrors(schema, received, errs, {
+      indent: 2,
+    });
+  } else {
+    let messageToPrint = "received\n";
+    errs.forEach((error) => {
+      let line = `${error.dataPath} ${error.message}`;
+
+      if (error.keyword === "additionalProperties") {
+        line += `, but found '${
+          // @ts-ignore
+          error.params.additionalProperty
+        }'`;
+      }
+
+      messageToPrint += chalk.red(`  ${line}\n`);
+    });
+    return messageToPrint;
+  }
+}

src/toMatchApiResponse.ts

@@ -1,9 +1,9 @@
-import betterAjvErrors from "better-ajv-errors";
+import RefParser from "@apidevtools/json-schema-ref-parser";
 import { MatcherState } from "expect";
 import { matcherHint } from "jest-matcher-utils";
-import RefParser from "@apidevtools/json-schema-ref-parser";
 import get from "lodash/get";
 import { ajvCompile } from "./ajvCompile";
+import { getErrorMessage } from "./getErrorMessage";
 
 export type Method =
   | "delete"
@@ -40,7 +40,8 @@ declare global {
       toMatchApiResponse(
         schema: any,
         method: Method,
-        path: string
+        path: string,
+        options?: { bailFast: boolean }
       ): Promise<void>;
     }
   }
@@ -50,7 +51,8 @@ export async function toMatchApiResponse(
   receivedAny: any,
   openapiSpec: any,
   method: Method,
-  path: string
+  path: string,
+  { bailFast = false }: { bailFast?: boolean } = {}
 ) {
   const options = {
     isNot: this.isNot,
@@ -143,9 +145,7 @@ export async function toMatchApiResponse(
       message: () =>
         matcherHint("toMatchOpenapiResponse", undefined, undefined, options) +
         "\n\n" +
-        betterAjvErrors(schema, body, validate.errors, {
-          indent: 2,
-        }),
+        getErrorMessage(schema, body, validate.errors, { bailFast }),
       pass: false,
     };
   }

src/toMatchRef.test.ts

@@ -17,7 +17,8 @@ describe("toMatchRef$", () => {
     // above max
     await expect(2147483647 + 1).not.toMatchRef$(
       testApi,
-      "#/components/schemas/Int32Number"
+      "#/components/schemas/Int32Number",
+      { bailFast: true }
     );
     // below min
     await expect(-2147483648 + -1).not.toMatchRef$(

src/toMatchRef.ts

@@ -1,8 +1,9 @@
-import betterAjvErrors from "better-ajv-errors";
+import RefParser from "@apidevtools/json-schema-ref-parser";
 import { MatcherState } from "expect";
 import { matcherHint } from "jest-matcher-utils";
-import RefParser from "@apidevtools/json-schema-ref-parser";
 import { ajvCompile } from "./ajvCompile";
+import { getErrorMessage } from "./getErrorMessage";
+
 declare global {
   namespace jest {
     // tslint:disable-next-line:interface-name
@@ -12,15 +13,20 @@ declare global {
        * @param schema openapi.json schema, parsed as object
        * @param ref$ the type to match against
        */
-      toMatchRef$(schema: any, ref$: string): Promise<void>;
+      toMatchRef$(
+        schema: any,
+        ref$: string,
+        options?: { bailFast: boolean }
+      ): Promise<void>;
     }
   }
 }
 export async function toMatchRef$(
   this: MatcherState,
   received: any,
   openapiSpec: any,
-  ref$: string
+  ref$: string,
+  { bailFast = false }: { bailFast?: boolean } = {}
 ) {
   const options = {
     isNot: this.isNot,
@@ -46,9 +52,7 @@ export async function toMatchRef$(
       message: () =>
         matcherHint("toMatchRef$", undefined, undefined, options) +
         "\n\n" +
-        betterAjvErrors(desiredSpec, received, validate.errors, {
-          indent: 2,
-        }),
+        getErrorMessage(desiredSpec, received, validate.errors, { bailFast }),
       pass: false,
     };
   }

yarn.lock

@@ -1161,6 +1161,14 @@ chalk@^4.0.0:
     ansi-styles "^4.1.0"
     supports-color "^7.1.0"
 
+chalk@^4.1.0:
+  version "4.1.0"
+  resolved "https://registry.yarnpkg.com/chalk/-/chalk-4.1.0.tgz#4e14870a618d9e2edd97dd8345fd9d9dc315646a"
+  integrity sha512-qwx12AxXe2Q5xQ43Ac//I6v5aXTipYrSESdOgzrN+9XjgEpyjpKuvSGaN4qE93f7TQTlerQQ8S+EQ0EyDoVL1A==
+  dependencies:
+    ansi-styles "^4.1.0"
+    supports-color "^7.1.0"
+
 ci-info@^2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/ci-info/-/ci-info-2.0.0.tgz#67a9e964be31a51e15e5010d58e6f12834002f46"