tests: add heading key tests

lighthouse-cli/test/smokehouse/lighthouse-runners/cli.js

@@ -79,12 +79,13 @@ async function internalRun(url, tmpPath, configJson, isDebug) {
   }
 
   const command = 'node';
+  const env = {...process.env, NODE_ENV: 'test'};
   localConsole.log(`${log.dim}$ ${command} ${args.join(' ')} ${log.reset}`);
 
   /** @type {{stdout: string, stderr: string, code?: number}} */
   let execResult;
   try {
-    execResult = await execFileAsync(command, args);
+    execResult = await execFileAsync(command, args, {env});
   } catch (e) {
     // exec-thrown errors have stdout, stderr, and exit code from child process.
     execResult = e;

lighthouse-core/audits/audit.js

@@ -5,6 +5,7 @@
  */
 'use strict';
 
+const {isUnderTest} = require('../lib/lh-env.js');
 const statistics = require('../lib/statistics.js');
 const Util = require('../report/html/renderer/util.js');
 
@@ -81,6 +82,29 @@ class Audit {
     return clampTo2Decimals(percentile);
   }
 
+  /**
+   * This catches typos in the `key` property of a heading definition of table/opportunity details.
+   * Throws an error if any of keys referenced by headings don't exist in at least one of the items.
+   *
+   * @param {LH.Audit.Details.Table['headings']|LH.Audit.Details.Opportunity['headings']} headings
+   * @param {LH.Audit.Details.Opportunity['items']|LH.Audit.Details.Table['items']} items
+   */
+  static assertHeadingKeysExist(headings, items) {
+    // If there are no items, there's nothing to check.
+    if (!items.length) return;
+    // Only do this in tests for now.
+    if (!isUnderTest) return;
+
+    for (const heading of headings) {
+      // `null` heading key means it's a column for subrows only
+      if (heading.key === null) continue;
+
+      const key = heading.key;
+      if (items.some(item => key in item)) continue;
+      throw new Error(`"${heading.key}" is missing from items`);
+    }
+  }
+
   /**
    * @param {LH.Audit.Details.Table['headings']} headings
    * @param {LH.Audit.Details.Table['items']} results
@@ -97,6 +121,8 @@ class Audit {
       };
     }
 
+    Audit.assertHeadingKeysExist(headings, results);
+
     return {
       type: 'table',
       headings: headings,
@@ -179,6 +205,8 @@ class Audit {
    * @return {LH.Audit.Details.Opportunity}
    */
   static makeOpportunityDetails(headings, items, overallSavingsMs, overallSavingsBytes) {
+    Audit.assertHeadingKeysExist(headings, items);
+
     return {
       type: 'opportunity',
       headings: items.length === 0 ? [] : headings,

lighthouse-core/audits/byte-efficiency/duplicated-javascript.js

@@ -235,7 +235,7 @@ class DuplicatedJavascript extends ByteEfficiencyAudit {
     const headings = [
       /* eslint-disable max-len */
       {key: 'source', valueType: 'code', subItemsHeading: {key: 'url', valueType: 'url'}, label: str_(i18n.UIStrings.columnSource)},
-      {key: '_', valueType: 'bytes', subItemsHeading: {key: 'sourceTransferBytes'}, granularity: 0.05, label: str_(i18n.UIStrings.columnTransferSize)},
+      {key: null, valueType: 'bytes', subItemsHeading: {key: 'sourceTransferBytes'}, granularity: 0.05, label: str_(i18n.UIStrings.columnTransferSize)},
       {key: 'wastedBytes', valueType: 'bytes', granularity: 0.05, label: str_(i18n.UIStrings.columnWastedBytes)},
       /* eslint-enable max-len */
     ];

lighthouse-core/lib/lh-env.js

@@ -0,0 +1,12 @@
+/**
+ * @license Copyright 2020 The Lighthouse Authors. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ */
+'use strict';
+
+module.exports = {
+  // NODE_ENV is set to test by jest and by smokehouse CLI runner
+  // CI as a catchall for everything we do in Travis/GitHub Actions
+  isUnderTest: !!process.env.CI || process.env.NODE_ENV === 'test',
+};

lighthouse-core/test/audits/byte-efficiency/byte-efficiency-audit-test.js

@@ -45,9 +45,7 @@ describe('Byte efficiency base audit', () => {
   });
 
   const baseHeadings = [
-    {key: 'totalBytes', itemType: 'bytes', displayUnit: 'kb', granularity: 1, text: ''},
     {key: 'wastedBytes', itemType: 'bytes', displayUnit: 'kb', granularity: 1, text: ''},
-    {key: 'wastedMs', itemType: 'text', text: ''},
   ];
 
   describe('#estimateTransferSize', () => {
@@ -197,7 +195,7 @@ describe('Byte efficiency base audit', () => {
     const simulator = await LoadSimulator.request({devtoolsLog, settings}, {computedCache});
     const result = ByteEfficiencyAudit.createAuditProduct(
       {
-        headings: [{key: 'value', text: 'Label'}],
+        headings: [{key: 'wastedBytes', text: 'Label'}],
         items: [
           {url: 'https://www.googletagmanager.com/gtm.js?id=GTM-Q5SW', wastedBytes: 30 * 1024},
         ],