Renamed the "fastFail" option to "continueOnError"

JamesMessinger · JamesMessinger · commit 806b870a9fe9 · 2020-04-20T05:25:12.000-05:00
diff --git a/docs/options.md b/docs/options.md
@@ -27,7 +27,7 @@ $RefParser.dereference("my-schema.yaml", {
       withCredentials: true,        // Include auth credentials when resolving HTTP references
     }
   },
-  failFast: true,                   // Abort upon first exception
+  continueOnError: true,            // Don't throw on the first error
   dereference: {
     circular: false                 // Don't allow circular $refs
   }
diff --git a/lib/index.d.ts b/lib/index.d.ts
@@ -211,10 +211,11 @@ declare namespace $RefParser {
     }
 
     /**
-     * Determines how lenient the processing should be.
-     * If this option is enable, the processing will be performed in a bail mode - will abort upon the first exception.
+     * By default, JSON Schema $Ref Parser throws the first error it encounters. Setting `continueOnError` to `true`
+     * causes it to keep processing as much as possible and then throw a single error that contains all errors
+     * that were encountered.
      */
-    failFast?: boolean;
+    continueOnError?: boolean;
 
     /**
      * The `dereference` options control how JSON Schema `$Ref` Parser will dereference `$ref` pointers within the JSON schema.
diff --git a/lib/index.js b/lib/index.js
@@ -122,7 +122,7 @@ $RefParser.prototype.parse = async function parse (path, schema, options, callba
       me.schema = result;
       return maybe(args.callback, Promise.resolve(me.schema));
     }
-    else if (!args.options.failFast) {
+    else if (args.options.continueOnError) {
       me.schema = null; // it's already set to null at line 79, but let's set it again for the sake of readability
       return maybe(args.callback, Promise.resolve(me.schema));
     }
@@ -131,7 +131,7 @@ $RefParser.prototype.parse = async function parse (path, schema, options, callba
     }
   }
   catch (err) {
-    if (args.options.failFast || !isHandledError(err)) {
+    if (!args.options.continueOnError || !isHandledError(err)) {
       return maybe(args.callback, Promise.reject(err));
     }
 
diff --git a/lib/options.js b/lib/options.js
@@ -56,10 +56,11 @@ $RefParserOptions.defaults = {
   },
 
   /**
-   * Determines how lenient the processing should be.
-   * If this option is enable, the processing will be performed in a bail mode - will abort upon the first exception.
+   * By default, JSON Schema $Ref Parser throws the first error it encounters. Setting `continueOnError` to `true`
+   * causes it to keep processing as much as possible and then throw a single error that contains all errors
+   * that were encountered.
   */
-  failFast: true,
+  continueOnError: false,
 
   /**
    * Determines the types of JSON references that are allowed.
diff --git a/lib/parse.js b/lib/parse.js
@@ -76,7 +76,7 @@ function readFile (file, options, $refs) {
       .then(resolve, onError);
 
     function onError (err) {
-      if (!err && !options.failFast) {
+      if (!err && options.continueOnError) {
         // No resolver could be matched
         reject(new UnmatchedResolverError(file.url));
       }
@@ -124,7 +124,7 @@ function parseFile (file, options, $refs) {
       .then(onParsed, onError);
 
     function onParsed (parser) {
-      if ((!options.failFast || !parser.plugin.allowEmpty) && isEmpty(parser.result)) {
+      if ((options.continueOnError || !parser.plugin.allowEmpty) && isEmpty(parser.result)) {
         reject(ono.syntax(`Error parsing "${file.url}" as ${parser.plugin.name}. \nParsed value is empty`));
       }
       else {
@@ -133,7 +133,7 @@ function parseFile (file, options, $refs) {
     }
 
     function onError (err) {
-      if (!err && !options.failFast) {
+      if (!err && options.continueOnError) {
         // No resolver could be matched
         reject(new UnmatchedParserError(file.url));
       }
diff --git a/lib/ref.js b/lib/ref.js
@@ -113,7 +113,7 @@ $Ref.prototype.resolve = function (path, options, friendlyPath, pathFromRoot) {
     return pointer.resolve(this.value, options);
   }
   catch (err) {
-    if (!options || options.failFast || !isHandledError(err)) {
+    if (!options || !options.continueOnError || !isHandledError(err)) {
       throw err;
     }
 
diff --git a/lib/resolve-external.js b/lib/resolve-external.js
@@ -112,7 +112,7 @@ async function resolve$Ref ($ref, path, $refs, options) {
     return Promise.all(promises);
   }
   catch (err) {
-    if (options.failFast || !isHandledError(err)) {
+    if (!options.continueOnError || !isHandledError(err)) {
       throw err;
     }
 
diff --git a/test/specs/invalid-pointers/invalid-pointers.js b/test/specs/invalid-pointers/invalid-pointers.js
@@ -21,10 +21,10 @@ describe("Schema with invalid pointers", () => {
     }
   });
 
-  it("should throw a grouped error for an invalid pointer if failFast is false", async () => {
+  it("should throw a grouped error for an invalid pointer if continueOnError is true", async () => {
     const parser = new $RefParser();
     try {
-      await parser.dereference(path.rel("specs/invalid-pointers/invalid.json"), { failFast: false });
+      await parser.dereference(path.rel("specs/invalid-pointers/invalid.json"), { continueOnError: true });
       helper.shouldNotGetCalled();
     }
     catch (err) {
diff --git a/test/specs/invalid/invalid.spec.js b/test/specs/invalid/invalid.spec.js
@@ -73,11 +73,11 @@ describe("Invalid syntax", () => {
       }
     });
 
-    describe("when failFast is false", () => {
+    describe("when continueOnError is true", () => {
       it("should throw a grouped error for an invalid file path", async () => {
         const parser = new $RefParser();
         try {
-          await parser.dereference("this file does not exist", { failFast: false });
+          await parser.dereference("this file does not exist", { continueOnError: true });
           helper.shouldNotGetCalled();
         }
         catch (err) {
@@ -100,7 +100,7 @@ describe("Invalid syntax", () => {
       it("should throw a grouped error for an invalid YAML file", async () => {
         const parser = new $RefParser();
         try {
-          await parser.dereference(path.rel("specs/invalid/invalid.yaml"), { failFast: false });
+          await parser.dereference(path.rel("specs/invalid/invalid.yaml"), { continueOnError: true });
           helper.shouldNotGetCalled();
         }
         catch (err) {
@@ -122,7 +122,7 @@ describe("Invalid syntax", () => {
       it("should throw a grouped error for an invalid JSON file", async () => {
         const parser = new $RefParser();
         try {
-          await parser.dereference(path.rel("specs/invalid/invalid.json"), { failFast: false });
+          await parser.dereference(path.rel("specs/invalid/invalid.json"), { continueOnError: true });
           helper.shouldNotGetCalled();
         }
         catch (err) {
@@ -144,7 +144,7 @@ describe("Invalid syntax", () => {
       it("should throw a grouped error for an invalid JSON file with YAML disabled", async () => {
         const parser = new $RefParser();
         try {
-          await parser.dereference(path.rel("specs/invalid/invalid.json"), { failFast: false, parse: { yaml: false }});
+          await parser.dereference(path.rel("specs/invalid/invalid.json"), { continueOnError: true, parse: { yaml: false }});
           helper.shouldNotGetCalled();
         }
         catch (err) {
@@ -165,7 +165,7 @@ describe("Invalid syntax", () => {
 
       it("should not throw an error for an invalid YAML file with JSON and YAML disabled", async () => {
         const parser = new $RefParser();
-        const result = await parser.dereference(path.rel("specs/invalid/invalid.yaml"), { failFast: false, parse: { yaml: false, json: false }});
+        const result = await parser.dereference(path.rel("specs/invalid/invalid.yaml"), { continueOnError: true, parse: { yaml: false, json: false }});
         expect(result).to.be.null;
       });
     });
@@ -222,11 +222,11 @@ describe("Invalid syntax", () => {
       });
     });
 
-    describe("when failFast is false", () => {
+    describe("when continueOnError is true", () => {
       it("should throw a grouped error for an invalid file path", async () => {
         try {
           const parser = new $RefParser();
-          await parser.dereference({ foo: { $ref: "this file does not exist" }}, { failFast: false });
+          await parser.dereference({ foo: { $ref: "this file does not exist" }}, { continueOnError: true });
           helper.shouldNotGetCalled();
         }
         catch (err) {
@@ -247,7 +247,7 @@ describe("Invalid syntax", () => {
       it("should throw a grouped error for an invalid YAML file", async () => {
         try {
           const parser = new $RefParser();
-          await parser.dereference({ foo: { $ref: path.rel("specs/invalid/invalid.yaml") }}, { failFast: false });
+          await parser.dereference({ foo: { $ref: path.rel("specs/invalid/invalid.yaml") }}, { continueOnError: true });
           helper.shouldNotGetCalled();
         }
         catch (err) {
@@ -268,7 +268,7 @@ describe("Invalid syntax", () => {
       it("should throw a grouped error for an invalid JSON file", async () => {
         try {
           const parser = new $RefParser();
-          await parser.dereference({ foo: { $ref: path.rel("specs/invalid/invalid.json") }}, { failFast: false });
+          await parser.dereference({ foo: { $ref: path.rel("specs/invalid/invalid.json") }}, { continueOnError: true });
           helper.shouldNotGetCalled();
         }
         catch (err) {
@@ -289,7 +289,7 @@ describe("Invalid syntax", () => {
       it("should throw a grouped error for an invalid JSON file with YAML disabled", async () => {
         try {
           const parser = new $RefParser();
-          await parser.dereference({ foo: { $ref: path.rel("specs/invalid/invalid.json") }}, { failFast: false, parse: { yaml: false }});
+          await parser.dereference({ foo: { $ref: path.rel("specs/invalid/invalid.json") }}, { continueOnError: true, parse: { yaml: false }});
           helper.shouldNotGetCalled();
         }
         catch (err) {
@@ -309,7 +309,7 @@ describe("Invalid syntax", () => {
 
       it("should not throw an error for an invalid YAML file with JSON and YAML disabled", async () => {
         const parser = new $RefParser();
-        const result = await parser.dereference({ foo: { $ref: path.rel("specs/invalid/invalid.yaml") }}, { failFast: false, parse: { yaml: false, json: false }});
+        const result = await parser.dereference({ foo: { $ref: path.rel("specs/invalid/invalid.yaml") }}, { continueOnError: true, parse: { yaml: false, json: false }});
         expect(result).to.deep.equal({ foo: ":\n" });
       });
     });
diff --git a/test/specs/missing-pointers/missing-pointers.spec.js b/test/specs/missing-pointers/missing-pointers.spec.js
@@ -21,10 +21,10 @@ describe("Schema with missing pointers", () => {
     }
   });
 
-  it("should throw a grouped error for missing pointer if failFast is false", async () => {
+  it("should throw a grouped error for missing pointer if continueOnError is true", async () => {
     const parser = new $RefParser();
     try {
-      await parser.dereference({ foo: { $ref: "#/baz" }}, { failFast: false });
+      await parser.dereference({ foo: { $ref: "#/baz" }}, { continueOnError: true });
       helper.shouldNotGetCalled();
     }
     catch (err) {
diff --git a/test/specs/parsers/parsers.spec.js b/test/specs/parsers/parsers.spec.js
@@ -216,7 +216,7 @@ describe("References to non-JSON files", () => {
           text: false,
           binary: false,
         },
-        failFast: false,
+        continueOnError: true,
       });
       helper.shouldNotGetCalled();
     }
diff --git a/test/specs/resolvers/resolvers.spec.js b/test/specs/resolvers/resolvers.spec.js
@@ -145,7 +145,7 @@ describe("options.resolve", () => {
           file: false,
           http: false,
         },
-        failFast: false,
+        continueOnError: true,
       });
       helper.shouldNotGetCalled();
     }

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ $RefParser.dereference("my-schema.yaml", {`
`27`	`27`	`withCredentials: true, // Include auth credentials when resolving HTTP references`
`28`	`28`	`}`
`29`	`29`	`},`
`30`		`- failFast: true, // Abort upon first exception`
	`30`	`+ continueOnError: true, // Don't throw on the first error`
`31`	`31`	`dereference: {`
`32`	`32`	`circular: false // Don't allow circular $refs`
`33`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -122,7 +122,7 @@ $RefParser.prototype.parse = async function parse (path, schema, options, callba`
`122`	`122`	`me.schema = result;`
`123`	`123`	`return maybe(args.callback, Promise.resolve(me.schema));`
`124`	`124`	`}`
`125`		`- else if (!args.options.failFast) {`
	`125`	`+ else if (args.options.continueOnError) {`
`126`	`126`	`me.schema = null; // it's already set to null at line 79, but let's set it again for the sake of readability`
`127`	`127`	`return maybe(args.callback, Promise.resolve(me.schema));`
`128`	`128`	`}`
`@@ -131,7 +131,7 @@ $RefParser.prototype.parse = async function parse (path, schema, options, callba`
`131`	`131`	`}`
`132`	`132`	`}`
`133`	`133`	`catch (err) {`
`134`		`- if (args.options.failFast \|\| !isHandledError(err)) {`
	`134`	`+ if (!args.options.continueOnError \|\| !isHandledError(err)) {`
`135`	`135`	`return maybe(args.callback, Promise.reject(err));`
`136`	`136`	`}`
`137`	`137`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ function readFile (file, options, $refs) {`
`76`	`76`	`.then(resolve, onError);`
`77`	`77`
`78`	`78`	`function onError (err) {`
`79`		`- if (!err && !options.failFast) {`
	`79`	`+ if (!err && options.continueOnError) {`
`80`	`80`	`// No resolver could be matched`
`81`	`81`	`reject(new UnmatchedResolverError(file.url));`
`82`	`82`	`}`
`@@ -124,7 +124,7 @@ function parseFile (file, options, $refs) {`
`124`	`124`	`.then(onParsed, onError);`
`125`	`125`
`126`	`126`	`function onParsed (parser) {`
`127`		`- if ((!options.failFast \|\| !parser.plugin.allowEmpty) && isEmpty(parser.result)) {`
	`127`	`+ if ((options.continueOnError \|\| !parser.plugin.allowEmpty) && isEmpty(parser.result)) {`
`128`	`128`	reject(ono.syntax(`Error parsing "${file.url}" as ${parser.plugin.name}. \nParsed value is empty`));
`129`	`129`	`}`
`130`	`130`	`else {`
`@@ -133,7 +133,7 @@ function parseFile (file, options, $refs) {`
`133`	`133`	`}`
`134`	`134`
`135`	`135`	`function onError (err) {`
`136`		`- if (!err && !options.failFast) {`
	`136`	`+ if (!err && options.continueOnError) {`
`137`	`137`	`// No resolver could be matched`
`138`	`138`	`reject(new UnmatchedParserError(file.url));`
`139`	`139`	`}`
Original file line number	Diff line number	Diff line change
`@@ -113,7 +113,7 @@ $Ref.prototype.resolve = function (path, options, friendlyPath, pathFromRoot) {`
`113`	`113`	`return pointer.resolve(this.value, options);`
`114`	`114`	`}`
`115`	`115`	`catch (err) {`
`116`		`- if (!options \|\| options.failFast \|\| !isHandledError(err)) {`
	`116`	`+ if (!options \|\| !options.continueOnError \|\| !isHandledError(err)) {`
`117`	`117`	`throw err;`
`118`	`118`	`}`
`119`	`119`
Original file line number	Diff line number	Diff line change
`@@ -112,7 +112,7 @@ async function resolve$Ref ($ref, path, $refs, options) {`
`112`	`112`	`return Promise.all(promises);`
`113`	`113`	`}`
`114`	`114`	`catch (err) {`
`115`		`- if (options.failFast \|\| !isHandledError(err)) {`
	`115`	`+ if (!options.continueOnError \|\| !isHandledError(err)) {`
`116`	`116`	`throw err;`
`117`	`117`	`}`
`118`	`118`
Original file line number	Diff line number	Diff line change
`@@ -21,10 +21,10 @@ describe("Schema with invalid pointers", () => {`
`21`	`21`	`}`
`22`	`22`	`});`
`23`	`23`
`24`		`- it("should throw a grouped error for an invalid pointer if failFast is false", async () => {`
	`24`	`+ it("should throw a grouped error for an invalid pointer if continueOnError is true", async () => {`
`25`	`25`	`const parser = new $RefParser();`
`26`	`26`	`try {`
`27`		`- await parser.dereference(path.rel("specs/invalid-pointers/invalid.json"), { failFast: false });`
	`27`	`+ await parser.dereference(path.rel("specs/invalid-pointers/invalid.json"), { continueOnError: true });`
`28`	`28`	`helper.shouldNotGetCalled();`
`29`	`29`	`}`
`30`	`30`	`catch (err) {`
Original file line number	Diff line number	Diff line change
`@@ -216,7 +216,7 @@ describe("References to non-JSON files", () => {`
`216`	`216`	`text: false,`
`217`	`217`	`binary: false,`
`218`	`218`	`},`
`219`		`- failFast: false,`
	`219`	`+ continueOnError: true,`
`220`	`220`	`});`
`221`	`221`	`helper.shouldNotGetCalled();`
`222`	`222`	`}`
Original file line number	Diff line number	Diff line change
`@@ -145,7 +145,7 @@ describe("options.resolve", () => {`
`145`	`145`	`file: false,`
`146`	`146`	`http: false,`
`147`	`147`	`},`
`148`		`- failFast: false,`
	`148`	`+ continueOnError: true,`
`149`	`149`	`});`
`150`	`150`	`helper.shouldNotGetCalled();`
`151`	`151`	`}`