Update raw reporter

Author: WilcoFiers

lib/core/reporters/raw.js

@@ -1,3 +1,5 @@
+import { nodeSerializer } from '../utils';
+
 const rawReporter = (results, options, callback) => {
   if (typeof options === 'function') {
     callback = options;
@@ -13,16 +15,9 @@ const rawReporter = (results, options, callback) => {
     const transformedResult = { ...result };
     const types = ['passes', 'violations', 'incomplete', 'inapplicable'];
     for (const type of types) {
-      // Some tests don't include all of the types, so we have to guard against that here.
-      // TODO: ensure tests always use "proper" results to avoid having these hacks in production code paths.
-      if (transformedResult[type] && Array.isArray(transformedResult[type])) {
-        transformedResult[type] = transformedResult[type].map(
-          ({ node, ...typeResult }) => {
-            node = typeof node?.toJSON === 'function' ? node.toJSON() : node;
-            return { node, ...typeResult };
-          }
-        );
-      }
+      transformedResult[type] = nodeSerializer.mapRawNodeResults(
+        transformedResult[type]
+      );
     }
 
     return transformedResult;

lib/core/utils/merge-results.js

@@ -7,7 +7,7 @@ import findBy from './find-by';
  * @private
  * @param	{Array} resultSet `nodes` array on a `RuleResult`
  * @param {Object} options Propagated from axe.run/etc
- * @param	{Object} frameSpec The spec describing the owning frame (see DqElement.toJSON())
+ * @param	{Object} frameSpec The spec describing the owning frame (see nodeSerializer.toSpec)
  */
 function pushFrame(resultSet, options, frameSpec) {
   resultSet.forEach(res => {
@@ -69,7 +69,7 @@ function normalizeResult(result) {
  * Merges one or more RuleResults (possibly from different frames) into one RuleResult
  * @private
  * @param	{Array} frameResults Array of objects including the RuleResults as `results` and
- * owning frame as either an Element `frameElement` or a spec `frameSpec` (see DqElement.toJSON)
+ * owning frame as either an Element `frameElement` or a spec `frameSpec` (see nodeSerializer.toSpec)
  * @param {Object} options Propagated from axe.run/etc
  * @return {Array} The merged RuleResults; should only have one result per rule
  */

test/core/reporters/raw-env.js

@@ -26,7 +26,8 @@ describe('reporters - raw-env', function () {
             any: [
               {
                 result: true,
-                data: 'minkey'
+                data: 'minkey',
+                relatedNodes: []
               }
             ],
             all: [],
@@ -50,7 +51,8 @@ describe('reporters - raw-env', function () {
               {
                 result: false,
                 data: 'pillock',
-                impact: 'cats'
+                impact: 'cats',
+                relatedNodes: []
               }
             ],
             any: [],
@@ -75,7 +77,8 @@ describe('reporters - raw-env', function () {
               {
                 data: 'foon',
                 impact: 'monkeys',
-                result: true
+                result: true,
+                relatedNodes: []
               }
             ],
             any: [],
@@ -93,10 +96,13 @@ describe('reporters - raw-env', function () {
         passes: [
           {
             result: 'passed',
+            any: [],
+            all: [],
             none: [
               {
                 data: 'clueso',
-                result: true
+                result: true,
+                relatedNodes: []
               }
             ],
             node: createDqElement()
@@ -149,4 +155,18 @@ describe('reporters - raw-env', function () {
       }
     );
   });
+
+  it('uses nodeSerializer', done => {
+    var rawReporter = axe.getReporter('rawEnv');
+    var spy = sinon.spy(axe.utils.nodeSerializer, 'mapRawNodeResults');
+    rawReporter(
+      runResults,
+      {},
+      function () {
+        assert.isTrue(spy.called);
+        done();
+      },
+      done
+    );
+  });
 });

test/core/reporters/raw.js

@@ -26,7 +26,8 @@ describe('reporters - raw', function () {
             any: [
               {
                 result: true,
-                data: 'minkey'
+                data: 'minkey',
+                relatedNodes: []
               }
             ],
             all: [],
@@ -50,7 +51,8 @@ describe('reporters - raw', function () {
               {
                 result: false,
                 data: 'pillock',
-                impact: 'cats'
+                impact: 'cats',
+                relatedNodes: []
               }
             ],
             any: [],
@@ -75,7 +77,8 @@ describe('reporters - raw', function () {
               {
                 data: 'foon',
                 impact: 'monkeys',
-                result: true
+                result: true,
+                relatedNodes: []
               }
             ],
             any: [],
@@ -93,10 +96,13 @@ describe('reporters - raw', function () {
         passes: [
           {
             result: 'passed',
+            any: [],
+            all: [],
             none: [
               {
                 data: 'clueso',
-                result: true
+                result: true,
+                relatedNodes: []
               }
             ],
             node: createDqElement()
@@ -138,4 +144,18 @@ describe('reporters - raw', function () {
       });
     });
   });
+
+  it('uses nodeSerializer', done => {
+    var rawReporter = axe.getReporter('raw');
+    var spy = sinon.spy(axe.utils.nodeSerializer, 'mapRawNodeResults');
+    rawReporter(
+      runResults,
+      {},
+      function () {
+        assert.isTrue(spy.called);
+        done();
+      },
+      done
+    );
+  });
 });