feat: add option to not print iframe error to console

lib/axe-injector.js

@@ -1,8 +1,13 @@
 class AxeInjector {
-  constructor({ driver, config, axeSource = null }) {
+  constructor({ driver, config, axeSource = null, options = {} }) {
     this.driver = driver;
     this.axeSource = axeSource || require('axe-core').source;
     this.config = config ? JSON.stringify(config) : '';
+    this.options = options;
+
+    // default stdout to true so it retains the original behavior
+    this.options.stdout =
+      typeof this.options.stdout !== 'undefined' ? this.options.stdout : true;
 
     this.didLogError = false;
     this.errorHandler = this.errorHandler.bind(this);
@@ -16,8 +21,15 @@ class AxeInjector {
     }
 
     this.didLogError = true;
-    // eslint-disable-next-line no-console
-    console.error('Failed to inject axe-core into one of the iframes!');
+    const msg = 'Failed to inject axe-core into one of the iframes!';
+
+    if (this.options.stdout) {
+      // eslint-disable-next-line no-console
+      console.error(msg);
+      return;
+    }
+
+    throw new Error(msg);
   }
 
   // Get axe-core source (and configuration)
@@ -73,9 +85,13 @@ class AxeInjector {
   inject(callback) {
     this.injectIntoAllFrames()
       .then(() => callback())
-      // For now, we intentionally ignore errors here, as
-      // allowing them to bubble up would be a breaking change.
-      .catch(() => callback());
+      .catch(e => {
+        if (this.options.stdout) {
+          return callback();
+        }
+
+        callback(e);
+      });
   }
 }
 

lib/index.js

@@ -6,7 +6,7 @@ var normalizeContext = require('./normalize-context');
  * Constructor for chainable WebDriver API
  * @param {WebDriver} driver WebDriver instance to analyze
  */
-function AxeBuilder(driver, source) {
+function AxeBuilder(driver, source, builderOptions = {}) {
   if (!(this instanceof AxeBuilder)) {
     return new AxeBuilder(driver, source);
   }
@@ -17,6 +17,7 @@ function AxeBuilder(driver, source) {
   this._excludes = [];
   this._options = null;
   this._config = null;
+  this._builderOptions = builderOptions;
 }
 
 /**
@@ -141,7 +142,12 @@ AxeBuilder.prototype.analyze = function(callback) {
   }
 
   return new Promise((resolve, reject) => {
-    var injector = new AxeInjector({ driver, axeSource: source, config });
+    var injector = new AxeInjector({
+      driver,
+      axeSource: source,
+      config,
+      options: this._builderOptions
+    });
     injector.inject(() => {
       driver
         .executeAsyncScript(

test/unit/axe-injector.js

@@ -72,6 +72,15 @@ describe('AxeInjector', () => {
 
       spy.restore();
     });
+
+    it('throws the error if stdout is set to false', () => {
+      const injector = new AxeInjector({
+        driver: new MockWebDriver(),
+        options: { stdout: false }
+      });
+
+      assert.throws(injector.errorHandler);
+    });
   });
 
   describe('script', () => {
@@ -215,5 +224,23 @@ describe('AxeInjector', () => {
 
       injector.inject(done);
     });
+
+    it('passes the error if stdout is set to false', done => {
+      const injector = new AxeInjector({
+        driver: new MockWebDriver(),
+        options: { stdout: false }
+      });
+      const stub = sinon.stub(injector, 'injectIntoAllFrames');
+
+      stub.rejects(new Error('oh no!'));
+
+      injector.inject(err => {
+        if (err) {
+          return done();
+        }
+
+        done('injector did not pass error to callback');
+      });
+    });
   });
 });