From 5a34d173960d8dfe0ce609a6cfa3bfaae3e9d29e Mon Sep 17 00:00:00 2001
From: Steven Lambert <steven.lambert@deque.com>
Date: Thu, 10 Jun 2021 14:36:12 -0600
Subject: [PATCH 1/3] fix(publish-metadata): use fail message for rules with
 reviewOnFail:true

---
 lib/core/utils/publish-metadata.js  |  23 +++---
 test/core/utils/publish-metadata.js | 109 ++++++++++++++++++++++++++++
 test/playground.html                |  18 ++++-
 3 files changed, 138 insertions(+), 12 deletions(-)

diff --git a/lib/core/utils/publish-metadata.js b/lib/core/utils/publish-metadata.js
index 14c5c8c99d..ff3b66b3e0 100644
--- a/lib/core/utils/publish-metadata.js
+++ b/lib/core/utils/publish-metadata.js
@@ -22,7 +22,7 @@ function getIncompleteReason(checkData, messages) {
   }
   if (checkData && checkData.missingData) {
     try {
-      var msg = messages.incomplete[checkData.missingData[0].reason];
+      const msg = messages.incomplete[checkData.missingData[0].reason];
       if (!msg) {
         throw new Error();
       }
@@ -46,16 +46,17 @@ function getIncompleteReason(checkData, messages) {
  * Extend checksData with the correct result message
  * @param  {Object} checksData The check result data
  * @param  {Boolean} shouldBeTrue Result of pass/fail check run
+ * @param  {Object} rule The rule metadata
  * @return {Function}
  * @private
  */
-function extender(checksData, shouldBeTrue) {
+function extender(checksData, shouldBeTrue, rule) {
   return check => {
-    var sourceData = checksData[check.id] || {};
-    var messages = sourceData.messages || {};
-    var data = Object.assign({}, sourceData);
+    const sourceData = checksData[check.id] || {};
+    const messages = sourceData.messages || {};
+    const data = Object.assign({}, sourceData);
     delete data.messages;
-    if (check.result === undefined) {
+    if (!rule.reviewOnFail && check.result === undefined) {
       // handle old doT template
       if (
         typeof messages.incomplete === 'object' &&
@@ -89,14 +90,14 @@ function extender(checksData, shouldBeTrue) {
  */
 function publishMetaData(ruleResult) {
   // TODO: es-modules_audit
-  var checksData = axe._audit.data.checks || {};
-  var rulesData = axe._audit.data.rules || {};
-  var rule = findBy(axe._audit.rules, 'id', ruleResult.id) || {};
+  const checksData = axe._audit.data.checks || {};
+  const rulesData = axe._audit.data.rules || {};
+  const rule = findBy(axe._audit.rules, 'id', ruleResult.id) || {};
 
   ruleResult.tags = clone(rule.tags || []);
 
-  var shouldBeTrue = extender(checksData, true);
-  var shouldBeFalse = extender(checksData, false);
+  const shouldBeTrue = extender(checksData, true, rule);
+  const shouldBeFalse = extender(checksData, false, rule);
   ruleResult.nodes.forEach(detail => {
     detail.any.forEach(shouldBeTrue);
     detail.all.forEach(shouldBeTrue);
diff --git a/test/core/utils/publish-metadata.js b/test/core/utils/publish-metadata.js
index 8b5bc8303f..41c265b8b4 100644
--- a/test/core/utils/publish-metadata.js
+++ b/test/core/utils/publish-metadata.js
@@ -1136,4 +1136,113 @@ describe('axe.utils.publishMetaData', function() {
       });
     });
   });
+
+  it('should use fail message for rules with "reviewOnFaill: true"', function() {
+    axe._load({
+      rules: [
+        {
+          id: 'cats',
+          reviewOnFail: true
+        }
+      ],
+      data: {
+        rules: {
+          cats: {
+            help: function() {
+              return 'cats-rule';
+            }
+          }
+        },
+        checks: {
+          'cats-NONE': {
+            messages: {
+              fail: function() {
+                return 'fail-NONE';
+              },
+              pass: function() {
+                return 'pass-NONE';
+              }
+            }
+          },
+          'cats-ANY': {
+            messages: {
+              fail: function() {
+                return 'fail-ANY';
+              },
+              pass: function() {
+                return 'pass-ANY';
+              }
+            }
+          },
+          'cats-ALL': {
+            messages: {
+              fail: function() {
+                return 'fail-ALL';
+              },
+              pass: function() {
+                return 'pass-ALL';
+              }
+            }
+          }
+        }
+      }
+    });
+
+    var result = {
+      id: 'cats',
+      nodes: [
+        {
+          any: [
+            {
+              result: undefined,
+              id: 'cats-ANY'
+            }
+          ],
+          none: [
+            {
+              result: undefined,
+              id: 'cats-NONE'
+            }
+          ],
+          all: [
+            {
+              result: undefined,
+              id: 'cats-ALL'
+            }
+          ]
+        }
+      ]
+    };
+    axe.utils.publishMetaData(result);
+    assert.deepEqual(result, {
+      id: 'cats',
+      help: 'cats-rule',
+      tags: [],
+      nodes: [
+        {
+          any: [
+            {
+              result: undefined,
+              id: 'cats-ANY',
+              message: 'fail-ANY'
+            }
+          ],
+          none: [
+            {
+              result: undefined,
+              id: 'cats-NONE',
+              message: 'fail-NONE'
+            }
+          ],
+          all: [
+            {
+              result: undefined,
+              id: 'cats-ALL',
+              message: 'fail-ALL'
+            }
+          ]
+        }
+      ]
+    });
+  });
 });
diff --git a/test/playground.html b/test/playground.html
index 4de25a4c17..f6a8fd1bbb 100644
--- a/test/playground.html
+++ b/test/playground.html
@@ -3,11 +3,27 @@
   <title>O hai</title>
 
   <div class="foo" id="foo">foo</div>
+  <nav>
+    <a href="foo">Nav 1</a>
+    <a href="foo">Nav 2</a>
+    <a href="foo">Nav 3</a>
+    <a href="foo">Nav 4</a>
+    <a href="foo">Nav 5</a>
+  </nav>
+
+  <table>
+    <tr>
+      <th></th>
+    </tr>
+  </table>
 
   <script src="/axe.js"></script>
   <script>
     window.addEventListener('load', function() {
-      axe.run(document, function(err, res) {
+      axe.run(document, { runOnly: ['empty-table-header'] }, function(
+        err,
+        res
+      ) {
         console.log(res.violations);
         res.incomplete.forEach(function(issue) {
           console.log(issue);

From 3c700c2d89d21a6a55460a8e5c6b33462ab44453 Mon Sep 17 00:00:00 2001
From: Steven Lambert <steven.lambert@deque.com>
Date: Thu, 10 Jun 2021 14:37:08 -0600
Subject: [PATCH 2/3] revert

---
 test/playground.html | 18 +-----------------
 1 file changed, 1 insertion(+), 17 deletions(-)

diff --git a/test/playground.html b/test/playground.html
index f6a8fd1bbb..4de25a4c17 100644
--- a/test/playground.html
+++ b/test/playground.html
@@ -3,27 +3,11 @@
   <title>O hai</title>
 
   <div class="foo" id="foo">foo</div>
-  <nav>
-    <a href="foo">Nav 1</a>
-    <a href="foo">Nav 2</a>
-    <a href="foo">Nav 3</a>
-    <a href="foo">Nav 4</a>
-    <a href="foo">Nav 5</a>
-  </nav>
-
-  <table>
-    <tr>
-      <th></th>
-    </tr>
-  </table>
 
   <script src="/axe.js"></script>
   <script>
     window.addEventListener('load', function() {
-      axe.run(document, { runOnly: ['empty-table-header'] }, function(
-        err,
-        res
-      ) {
+      axe.run(document, function(err, res) {
         console.log(res.violations);
         res.incomplete.forEach(function(issue) {
           console.log(issue);

From b60321539e8d50d65b48e01d493d7c90ac88e5ae Mon Sep 17 00:00:00 2001
From: Steven Lambert <steven.lambert@deque.com>
Date: Thu, 10 Jun 2021 15:27:13 -0600
Subject: [PATCH 3/3] fix tests

---
 test/core/utils/publish-metadata.js | 55 +++++++++++++----------------
 1 file changed, 25 insertions(+), 30 deletions(-)

diff --git a/test/core/utils/publish-metadata.js b/test/core/utils/publish-metadata.js
index 41c265b8b4..0f9cd8110a 100644
--- a/test/core/utils/publish-metadata.js
+++ b/test/core/utils/publish-metadata.js
@@ -1214,35 +1214,30 @@ describe('axe.utils.publishMetaData', function() {
       ]
     };
     axe.utils.publishMetaData(result);
-    assert.deepEqual(result, {
-      id: 'cats',
-      help: 'cats-rule',
-      tags: [],
-      nodes: [
-        {
-          any: [
-            {
-              result: undefined,
-              id: 'cats-ANY',
-              message: 'fail-ANY'
-            }
-          ],
-          none: [
-            {
-              result: undefined,
-              id: 'cats-NONE',
-              message: 'fail-NONE'
-            }
-          ],
-          all: [
-            {
-              result: undefined,
-              id: 'cats-ALL',
-              message: 'fail-ALL'
-            }
-          ]
-        }
-      ]
-    });
+    assert.deepEqual(result.nodes, [
+      {
+        any: [
+          {
+            result: undefined,
+            id: 'cats-ANY',
+            message: 'fail-ANY'
+          }
+        ],
+        none: [
+          {
+            result: undefined,
+            id: 'cats-NONE',
+            message: 'fail-NONE'
+          }
+        ],
+        all: [
+          {
+            result: undefined,
+            id: 'cats-ALL',
+            message: 'fail-ALL'
+          }
+        ]
+      }
+    ]);
   });
 });