Refactor the JSON output. (#567)

The structure of the Lighthouse JSON output is different and better.

See #567 for details

Author: michaelgerakis

lighthouse-cli/printer.js

@@ -81,7 +81,7 @@ function createOutput(results, outputMode) {
 
   // JSON report.
   if (outputMode === 'json') {
-    return JSON.stringify(results.aggregations, null, 2);
+    return JSON.stringify({audits: results.audits, aggregations: results.aggregations}, null, 2);
   }
 
   // Pretty printed.
@@ -99,6 +99,9 @@ function createOutput(results, outputMode) {
       }
 
       item.subItems.forEach(subitem => {
+        // Get audit object from inside of results.audits under name subitem.
+        // Coming soon events are not located inside of results.audits.
+        subitem = results.audits[subitem] || subitem;
         let lineItem = ` -- ${subitem.description}: ${subitem.score}`;
         if (subitem.displayValue) {
           lineItem += ` (${subitem.displayValue})`;

lighthouse-cli/test/fixtures/sample.json

@@ -171,7 +171,7 @@ class Aggregate {
           return;
         }
 
-        subItems.push(filteredAndRemappedResults[e]);
+        subItems.push(filteredAndRemappedResults[e].name);
 
         // Only add to the score if this aggregation contributes to the
         // overall score.
@@ -199,13 +199,13 @@ class Aggregate {
    * @param {!Array<!AuditResult>} results
    * @return {!AggregationResult}
    */
-  static aggregate(aggregation, results) {
+  static aggregate(aggregation, auditResults) {
     return {
       name: aggregation.name,
       description: aggregation.description,
       scored: aggregation.scored,
       categorizable: aggregation.categorizable,
-      score: Aggregate.compare(results, aggregation.items, aggregation.scored)
+      score: Aggregate.compare(auditResults, aggregation.items, aggregation.scored)
     };
   }
 }

lighthouse-core/aggregator/aggregate.js

@@ -97,7 +97,7 @@ AggregationResultItem.prototype.name;
 /** @type {string} */
 AggregationResultItem.prototype.description;
 
-/** @type {!Array<!AuditResult>} */
+/** @type {!Array<!string>} */
 AggregationResultItem.prototype.subItems;
 
 /**

lighthouse-core/closure/typedefs/Aggregation.js

@@ -171,24 +171,31 @@ class ReportGenerator {
     const inline = (options && options.inline) || false;
 
     // Ensure the formatter for each extendedInfo is registered.
+    Object.keys(results.audits).forEach(audit => {
+      // Use value rather than key for audit.
+      audit = results.audits[audit];
+
+      if (!audit.extendedInfo) {
+        return;
+      }
+      if (!audit.extendedInfo.formatter) {
+        // HTML formatter not provided for this subItem
+        return;
+      }
+      const formatter = Formatter.getByName(audit.extendedInfo.formatter);
+      const helpers = formatter.getHelpers();
+      if (helpers) {
+        Handlebars.registerHelper(helpers);
+      }
+
+      Handlebars.registerPartial(audit.name, formatter.getFormatter('html'));
+    });
+
     results.aggregations.forEach(aggregation => {
       aggregation.score.forEach(score => {
-        score.subItems.forEach(subItem => {
-          if (!subItem.extendedInfo) {
-            return;
-          }
-          if (!subItem.extendedInfo.formatter) {
-            // HTML formatter not provided for this subItem
-            return;
-          }
-          const formatter = Formatter.getByName(subItem.extendedInfo.formatter);
-          const helpers = formatter.getHelpers();
-          if (helpers) {
-            Handlebars.registerHelper(helpers);
-          }
-
-          Handlebars.registerPartial(subItem.name, formatter.getFormatter('html'));
-        });
+        // Map subItem strings to auditResults from results.audits.
+        // Coming soon events are not in auditResults, but rather still in subItems.
+        score.subItems = score.subItems.map(subItem => results.audits[subItem] || subItem);
       });
     });
 

lighthouse-core/report/report-generator.js

@@ -83,10 +83,20 @@ class Runner {
     // Only run aggregations if needed.
     if (config.aggregations) {
       run = run
-          .then(results => Aggregator.aggregate(config.aggregations, results))
-          .then(aggregations => {
+          .then(auditResults => Promise.all([
+            auditResults,
+            Aggregator.aggregate(config.aggregations, auditResults)
+          ]))
+          .then(results => {
+            const audits = results[0];
+            const aggregations = results[1];
+            const formattedAudits = audits.reduce((formatted, audit) => {
+              formatted[audit.name] = audit;
+              return formatted;
+            }, {});
             return {
               url: opts.url,
+              audits: formattedAudits,
               aggregations
             };
           });

lighthouse-core/runner.js

@@ -251,18 +251,10 @@ describe('Aggregate', () => {
       overall: 0.375,
       name: undefined,
       description: undefined,
-      subItems: [{
-        name: 'test',
-        rawValue: false,
-        score: false,
-        displayValue: ''
-      },
-      {
-        name: 'alternate-test',
-        rawValue: 50,
-        score: 50,
-        displayValue: '50'
-      }]
+      subItems: [
+        'test',
+        'alternate-test'
+      ]
     });
   });
 
@@ -297,18 +289,10 @@ describe('Aggregate', () => {
       overall: 0,
       name: undefined,
       description: undefined,
-      subItems: [{
-        name: 'test',
-        rawValue: false,
-        score: false,
-        displayValue: ''
-      },
-      {
-        name: 'alternate-test',
-        rawValue: 50,
-        score: 50,
-        displayValue: '50'
-      }]
+      subItems: [
+        'test',
+        'alternate-test'
+      ]
     });
   });
 

lighthouse-core/test/aggregator/aggregate.js

@@ -220,7 +220,9 @@ describe('Runner', () => {
 
     return Runner.run(fakeDriver, {url, config, flags}).then(results => {
       assert.equal(results.url, url);
+      assert.equal(results.audits['is-on-https'].name, 'is-on-https');
       assert.equal(results.aggregations[0].score[0].overall, 1);
+      assert.equal(results.aggregations[0].score[0].subItems[0], 'is-on-https');
     });
   });
 });