core(config): specify lighthouse channel

clients/devtools-entry.js

@@ -36,6 +36,7 @@ function getDefaultConfigForCategories(categoryIDs) {
 function runLighthouseInWorker(port, url, flags, categoryIDs) {
   // Default to 'info' logging level.
   flags.logLevel = flags.logLevel || 'info';
+  flags.channel = 'devtools';
   const config = getDefaultConfigForCategories(categoryIDs);
   const connection = new RawProtocol(port);
 

clients/extension/scripts/extension-entry.js

@@ -82,6 +82,7 @@ async function runLighthouseInExtension(flags, categoryIDs) {
   // Default to 'info' logging level.
   flags.logLevel = flags.logLevel || 'info';
   flags.output = 'html';
+  flags.channel = 'extension';
 
   const connection = new ExtensionProtocol();
   const url = await connection.getCurrentTabURL();

clients/lightrider-entry.js

@@ -36,6 +36,7 @@ async function runLighthouseInLR(connection, url, flags, lrOpts) {
   // disableStorageReset because it causes render server hang
   flags.disableStorageReset = true;
   flags.logLevel = flags.logLevel || 'info';
+  flags.channel = 'lr';
 
   const config = lrDevice === 'desktop' ? LR_PRESETS.desktop : LR_PRESETS.mobile;
   if (categoryIDs) {

clients/test/extension/extension-test.js

@@ -27,6 +27,7 @@ describe('Lighthouse chrome extension', function() {
   let browser;
   let extensionPage;
   let originalManifest;
+  let lhr;
 
   function getAuditElementsIds({category, selector}) {
     return extensionPage.evaluate(
@@ -102,6 +103,8 @@ describe('Lighthouse chrome extension', function() {
       throw new Error(lighthouseResult.exceptionDetails.text);
     }
 
+    lhr = lighthouseResult.result.value.lhr;
+
     extensionPage = (await browser.pages()).find(page =>
       page.url().includes('blob:chrome-extension://')
     );
@@ -176,4 +179,8 @@ describe('Lighthouse chrome extension', function() {
     // this audit has regressed in the extension twice, so make sure it passes
     assert.ok(await extensionPage.$('#is-crawlable.lh-audit--pass'), 'did not pass is-crawlable');
   });
+
+  it('should specify the channel as extension', async () => {
+    assert.equal(lhr.configSettings.channel, 'extension');
+  });
 });

clients/test/lightrider-entry-test.js

@@ -6,7 +6,9 @@
 'use strict';
 
 const assert = require('assert');
+const jest = require('jest-mock');
 const lhBackground = require('../lightrider-entry.js');
+const Runner = require('../../lighthouse-core/runner.js');
 const LHError = require('../../lighthouse-core/lib/lh-error.js');
 
 /* eslint-env mocha */
@@ -56,5 +58,18 @@ describe('lightrider-entry', () => {
       assert.strictEqual(parsedResult.runtimeError.code, LHError.UNKNOWN_ERROR);
       assert.ok(parsedResult.runtimeError.message.includes(errorMsg));
     });
+
+    it('specifies the channel as lr', async () => {
+      const runStub = jest.spyOn(Runner, 'run');
+
+      const mockConnection = {};
+      const url = 'https://example.com';
+
+      await lhBackground.runLighthouseInLR(mockConnection, url, {}, {});
+      const config = runStub.mock.calls[0][1].config;
+      assert.equal(config.settings.channel, 'lr');
+
+      runStub.mockRestore();
+    });
   });
 });

lighthouse-cli/cli-flags.js

@@ -137,6 +137,7 @@ function getFlags(manualArgv) {
       .array('skipAudits')
       .array('output')
       .string('extraHeaders')
+      .string('channel')
       .string('precomputedLanternDataPath')
       .string('lanternDataOutputPath')
 
@@ -146,6 +147,7 @@ function getFlags(manualArgv) {
       .default('port', 0)
       .default('hostname', 'localhost')
       .default('enable-error-reporting', undefined) // Undefined so prompted by default
+      .default('channel', 'cli')
       .check(/** @param {LH.CliFlags} argv */ (argv) => {
         // Lighthouse doesn't need a URL if...
         //   - We're just listing the available options.

lighthouse-cli/test/cli/__snapshots__/index-test.js.snap

@@ -1202,6 +1202,7 @@ Object {
     "additionalTraceCategories": null,
     "auditMode": false,
     "blockedUrlPatterns": null,
+    "channel": "cli",
     "disableDeviceEmulation": false,
     "disableStorageReset": false,
     "emulatedFormFactor": "mobile",
@@ -1331,6 +1332,7 @@ Object {
     "additionalTraceCategories": null,
     "auditMode": true,
     "blockedUrlPatterns": null,
+    "channel": "cli",
     "disableDeviceEmulation": false,
     "disableStorageReset": false,
     "emulatedFormFactor": "mobile",

lighthouse-cli/test/cli/run-test.js

@@ -50,6 +50,8 @@ describe('CLI run', function() {
       assert.deepStrictEqual(results.timing, lhr.timing);
       assert.ok(results.timing.total !== 0);
 
+      assert.equal(results.configSettings.channel, 'cli');
+
       fs.unlinkSync(filename);
     });
   }, 20 * 1000);

lighthouse-core/config/constants.js

@@ -52,6 +52,7 @@ const defaultSettings = {
   disableStorageReset: false,
   disableDeviceEmulation: false,
   emulatedFormFactor: 'mobile',
+  channel: 'node',
 
   // the following settings have no defaults but we still want ensure that `key in settings`
   // in config will work in a typechecked way

lighthouse-core/test/index-test.js

@@ -132,6 +132,29 @@ describe('Module Tests', function() {
     });
   });
 
+  it('should specify the channel as node by default', async function() {
+    const exampleUrl = 'https://www.reddit.com/r/nba';
+    const results = await lighthouse(exampleUrl, {}, {
+      settings: {
+        auditMode: __dirname + '/fixtures/artifacts/perflog/',
+      },
+      audits: [],
+    });
+    assert.equal(results.lhr.configSettings.channel, 'node');
+  });
+
+  it('lets consumers pass in a custom channel', async function() {
+    const exampleUrl = 'https://www.reddit.com/r/nba';
+    const results = await lighthouse(exampleUrl, {}, {
+      settings: {
+        auditMode: __dirname + '/fixtures/artifacts/perflog/',
+        channel: 'custom',
+      },
+      audits: [],
+    });
+    assert.equal(results.lhr.configSettings.channel, 'custom');
+  });
+
   it('should return a list of audits', function() {
     assert.ok(Array.isArray(lighthouse.getAuditList()));
   });

lighthouse-core/test/results/sample_v2.json

@@ -3175,6 +3175,7 @@
     "disableStorageReset": false,
     "disableDeviceEmulation": false,
     "emulatedFormFactor": "mobile",
+    "channel": "cli",
     "locale": "en-US",
     "blockedUrlPatterns": null,
     "additionalTraceCategories": null,

proto/lighthouse-result.proto

@@ -139,6 +139,9 @@ message LighthouseResult {
     // List of the categories that were run, empty if all were run
     // nullable list of strings
     google.protobuf.Value only_categories = 3;
+
+    // How Lighthouse was run, e.g. from the Chrome extension or from the npm module
+    string channel = 4;
   }
 
   // The settings that were used to run this audit

types/externs.d.ts

@@ -123,6 +123,8 @@ declare global {
       skipAudits?: string[] | null;
       /** List of extra HTTP Headers to include. */
       extraHeaders?: Crdp.Network.Headers | null; // See extraHeaders TODO in bin.js
+      /** How Lighthouse was run, e.g. from the Chrome extension or from the npm module */
+      channel?: string
       /** Precomputed lantern estimates to use instead of observed analysis. */
       precomputedLanternData?: PrecomputedLanternData | null;
     }