Initial merge

Author: gaganmBrowserStack

build/cherry-pick.js

@@ -1,3 +1,5 @@
+#!/usr/bin/env node
+
 const { execSync } = require('child_process');
 const conventionalCommitsParser = require('conventional-commits-parser');
 const chalk = require('chalk');
@@ -129,7 +131,7 @@ commitsToCherryPick.forEach(({ hash, type, scope, subject }) => {
 
   try {
     execSync(`git cherry-pick ${hash} -X theirs`);
-  } catch (e) {
+  } catch {
     console.error(
       chalk.red.bold('\nAborting cherry-pick and reseting to master')
     );

lib/checks/aria/aria-allowed-attr-evaluate.js

@@ -39,7 +39,11 @@ export default function ariaAllowedAttrEvaluate(node, options, virtualNode) {
 
   // Unknown ARIA attributes are tested in aria-valid-attr
   for (const attrName of virtualNode.attrNames) {
-    if (validateAttr(attrName) && !allowed.includes(attrName)) {
+    if (
+      validateAttr(attrName) &&
+      !allowed.includes(attrName) &&
+      !ignoredAttrs(attrName, virtualNode.attr(attrName), virtualNode)
+    ) {
       invalid.push(attrName);
     }
   }
@@ -57,3 +61,23 @@ export default function ariaAllowedAttrEvaluate(node, options, virtualNode) {
   }
   return false;
 }
+
+function ignoredAttrs(attrName, attrValue, vNode) {
+  // allow aria-required=false as screen readers consistently ignore it
+  // @see https://github.com/dequelabs/axe-core/issues/3756
+  if (attrName === 'aria-required' && attrValue === 'false') {
+    return true;
+  }
+
+  // allow aria-multiline=false when contenteditable is set
+  // @see https://github.com/dequelabs/axe-core/issues/4463
+  if (
+    attrName === 'aria-multiline' &&
+    attrValue === 'false' &&
+    vNode.hasAttr('contenteditable')
+  ) {
+    return true;
+  }
+
+  return false;
+}

lib/checks/aria/aria-errormessage.json

@@ -11,9 +11,9 @@
         "hidden": "aria-errormessage value `${data.values}` cannot reference a hidden element"
       },
       "incomplete": {
-        "singular": "ensure aria-errormessage value `${data.values}` references an existing element",
-        "plural": "ensure aria-errormessage values `${data.values}` reference existing elements",
-        "idrefs": "unable to determine if aria-errormessage element exists on the page: ${data.values}"
+        "singular": "Ensure aria-errormessage value `${data.values}` references an existing element",
+        "plural": "Ensure aria-errormessage values `${data.values}` reference existing elements",
+        "idrefs": "Unable to determine if aria-errormessage element exists on the page: ${data.values}"
       }
     }
   }

lib/checks/label/explicit-evaluate.js

@@ -35,7 +35,7 @@ function explicitEvaluate(node, options, virtualNode) {
         return !!explicitLabel;
       }
     });
-  } catch (e) {
+  } catch {
     return undefined;
   }
 }

lib/checks/label/explicit.json

@@ -4,8 +4,8 @@
   "metadata": {
     "impact": "critical",
     "messages": {
-      "pass": "Form element has an explicit <label>",
-      "fail": "Form element does not have an explicit <label>",
+      "pass": "Element has an explicit <label>",
+      "fail": "Element does not have an explicit <label>",
       "incomplete": "Unable to determine if form element has an explicit <label>"
     }
   }

lib/checks/label/help-same-as-label-evaluate.js

@@ -2,8 +2,8 @@ import { labelVirtual, accessibleText, sanitize } from '../../commons/text';
 import { idrefs } from '../../commons/dom';
 
 function helpSameAsLabelEvaluate(node, options, virtualNode) {
-  var labelText = labelVirtual(virtualNode),
-    check = node.getAttribute('title');
+  const labelText = labelVirtual(virtualNode);
+  let check = node.getAttribute('title');
 
   if (!labelText) {
     return false;
@@ -13,7 +13,7 @@ function helpSameAsLabelEvaluate(node, options, virtualNode) {
     check = '';
 
     if (node.getAttribute('aria-describedby')) {
-      var ref = idrefs(node, 'aria-describedby');
+      const ref = idrefs(node, 'aria-describedby');
       check = ref
         .map(thing => {
           return thing ? accessibleText(thing) : '';

lib/checks/label/hidden-explicit-label-evaluate.js

@@ -16,7 +16,7 @@ function hiddenExplicitLabelEvaluate(node, options, virtualNode) {
       let name;
       try {
         name = accessibleTextVirtual(virtualNode).trim();
-      } catch (e) {
+      } catch {
         return undefined;
       }
 

lib/core/base/audit.js

@@ -9,9 +9,10 @@ import {
   preload,
   findBy,
   ruleShouldRun,
-  performanceTimer
+  performanceTimer,
+  serializeError
 } from '../utils';
-import doT from '@deque/dot';
+import { doT } from '../imports';
 import constants from '../constants';
 
 const dotRegex = /\{\{.+?\}\}/g;
@@ -183,15 +184,15 @@ export default class Audit {
    * Initializes the rules and checks
    */
   _init() {
-    var audit = getDefaultConfiguration(this.defaultConfig);
+    const audit = getDefaultConfiguration(this.defaultConfig);
     this.lang = audit.lang || 'en';
     this.reporter = audit.reporter;
     this.commands = {};
     this.rules = [];
     this.checks = {};
     this.brand = 'axe';
     this.application = 'axeAPI';
-    this.tagExclude = ['experimental'];
+    this.tagExclude = ['experimental', 'deprecated'];
     this.noHtml = audit.noHtml;
     this.allowedOrigins = audit.allowedOrigins;
     unpackToObject(audit.rules, this, 'addRule');
@@ -366,16 +367,26 @@ export default class Audit {
    * @param  {Mixed} options  Options object to pass into rules and/or disable rules or checks
    */
   after(results, options) {
-    var rules = this.rules;
+    const rules = this.rules;
     return results.map(ruleResult => {
-      var rule = findBy(rules, 'id', ruleResult.id);
+      if (ruleResult.error) {
+        return ruleResult;
+      }
+      const rule = findBy(rules, 'id', ruleResult.id);
       if (!rule) {
         // If you see this, you're probably running the Mocha tests with the axe extension installed
         throw new Error(
           'Result for unknown rule. You may be running mismatch axe-core versions'
         );
       }
-      return rule.after(ruleResult, options);
+      try {
+        return rule.after(ruleResult, options);
+      } catch (err) {
+        if (options.debug) {
+          throw err;
+        }
+        return createIncompleteErrorResult(rule, err);
+      }
     });
   }
   /**
@@ -393,7 +404,7 @@ export default class Audit {
    * @return {Object}          Validated options object
    */
   normalizeOptions(options) {
-    var audit = this;
+    const audit = this;
     const tags = [];
     const ruleIds = [];
     audit.rules.forEach(rule => {
@@ -498,7 +509,7 @@ export default class Audit {
   }
   _constructHelpUrls(previous = null) {
     // TODO: es-modules-version
-    var version = (axe.version.match(/^[1-9][0-9]*\.[0-9]+/) || ['x.y'])[0];
+    const version = (axe.version.match(/^[1-9][0-9]*\.[0-9]+/) || ['x.y'])[0];
     this.rules.forEach(rule => {
       if (!this.data.rules[rule.id]) {
         this.data.rules[rule.id] = {};
@@ -732,36 +743,37 @@ function getDefferedRule(rule, context, options) {
     rule.run(
       context,
       options,
-      // resolve callback for rule `run`
-      ruleResult => {
-        // resolve
-        resolve(ruleResult);
-      },
-      // reject callback for rule `run`
+      ruleResult => resolve(ruleResult),
       err => {
-        // if debug - construct error details
-        if (!options.debug) {
-          const errResult = Object.assign(new RuleResult(rule), {
-            result: constants.CANTTELL,
-            description: 'An error occured while running this rule',
-            message: err.message,
-            stack: err.stack,
-            error: err,
-            // Add a serialized reference to the node the rule failed on for easier debugging.
-            // See https://github.com/dequelabs/axe-core/issues/1317.
-            errorNode: err.errorNode
-          });
-          // resolve
-          resolve(errResult);
-        } else {
-          // reject
+        if (options.debug) {
           reject(err);
+        } else {
+          resolve(createIncompleteErrorResult(rule, err));
         }
       }
     );
   };
 }
 
+function createIncompleteErrorResult(rule, error) {
+  const { errorNode } = error;
+  const serialError = serializeError(error);
+  const none = [
+    {
+      id: 'error-occurred',
+      result: undefined,
+      data: serialError,
+      relatedNodes: []
+    }
+  ];
+  const node = errorNode || new DqElement(document.documentElement);
+  return Object.assign(new RuleResult(rule), {
+    error: serialError,
+    result: constants.CANTTELL,
+    nodes: [{ any: [], all: [], none, node }]
+  });
+}
+
 /**
  * For all the rules, create the helpUrl and add it to the data for that rule
  */

test/integration/rules/runner.js

@@ -110,34 +110,39 @@
       before(done => {
         fixture.innerHTML = testObj.content;
         waitForFrames(fixture, () => {
-          axe.run(
-            fixture,
-            {
-              /**
-               * The debug flag helps log errors in a fairly detailed fashion,
-               * when tests fail in webdriver
-               */
-              debug: true,
-              performanceTimer: false,
-              runOnly: { type: 'rule', values: [ruleId] }
-            },
-            (err, r) => {
-              // assert that there are no errors - if error exists a stack trace is logged.
-              const errStack = err && err.stack ? err.stack : '';
-              assert.isNull(err, 'Error should be null. ' + errStack);
-              // assert that result is defined
-              assert.isDefined(r, 'Results are defined.');
-              // assert that result has certain keys
-              assert.hasAnyKeys(r, ['incomplete', 'violations', 'passes']);
-              // assert incomplete(s) does not have error
-              r.incomplete.forEach(incomplete => {
-                assert.isUndefined(incomplete.error);
-              });
-              // flatten results
-              results = flattenResult(r);
-              done();
-            }
-          );
+          // The setTimeout is a workaround for a Firefox bug. See:
+          // - https://github.com/dequelabs/axe-core/issues/4556
+          // - https://bugzilla.mozilla.org/show_bug.cgi?id=1912115
+          setTimeout(() => {
+            axe.run(
+              fixture,
+              {
+                /**
+                 * The debug flag helps log errors in a fairly detailed fashion,
+                 * when tests fail in webdriver
+                 */
+                debug: true,
+                performanceTimer: false,
+                runOnly: { type: 'rule', values: [ruleId] }
+              },
+              (err, r) => {
+                // assert that there are no errors - if error exists a stack trace is logged.
+                const errStack = err && err.stack ? err.stack : '';
+                assert.isNull(err, 'Error should be null. ' + errStack);
+                // assert that result is defined
+                assert.isDefined(r, 'Results are defined.');
+                // assert that result has certain keys
+                assert.hasAnyKeys(r, ['incomplete', 'violations', 'passes']);
+                // assert incomplete(s) does not have error
+                r.incomplete.forEach(incomplete => {
+                  assert.isUndefined(incomplete.error);
+                });
+                // flatten results
+                results = flattenResult(r);
+                done();
+              }
+            );
+          }, 0);
         });
       });
       runTest(testObj, 'passes');

test/rule-matches/aria-allowed-attr-matches.js

@@ -1,8 +1,8 @@
 describe('aria-allowed-attr-matches', function () {
   'use strict';
 
-  var queryFixture = axe.testUtils.queryFixture;
-  var rule;
+  const queryFixture = axe.testUtils.queryFixture;
+  let rule;
 
   beforeEach(function () {
     rule = axe.utils.getRule('aria-allowed-attr');
@@ -13,15 +13,15 @@ describe('aria-allowed-attr-matches', function () {
   });
 
   it('should return true on elements that have aria attributes', function () {
-    var vNode = queryFixture(
+    const vNode = queryFixture(
       '<div role="button" id="target" aria-label="Thing 1" aria-mccheddarton="Unsupported thing 2"></div>'
     );
 
     assert.isTrue(rule.matches(null, vNode));
   });
 
   it('should return false on elements that have no aria attributes', function () {
-    var vNode = queryFixture('<div role="button" id="target"></div>');
+    const vNode = queryFixture('<div role="button" id="target"></div>');
 
     assert.isFalse(rule.matches(null, vNode));
   });