clients(lr): allow for custom config

clients/lightrider-entry.js

@@ -21,14 +21,16 @@ const LR_PRESETS = {
 
 /**
  * Run lighthouse for connection and provide similar results as in CLI.
+ *
+ * If configOverride is provided, lrDevice and categoryIDs are ignored.
  * @param {Connection} connection
  * @param {string} url
  * @param {LH.Flags} flags Lighthouse flags, including `output`
- * @param {{lrDevice?: 'desktop'|'mobile', categoryIDs?: Array<string>, logAssets: boolean, keepRawValues: boolean}} lrOpts Options coming from Lightrider
+ * @param {{lrDevice?: 'desktop'|'mobile', categoryIDs?: Array<string>, logAssets: boolean, keepRawValues: boolean, configOverride?: LH.Config.Json}} lrOpts Options coming from Lightrider
  * @return {Promise<string|Array<string>|void>}
  */
 async function runLighthouseInLR(connection, url, flags, lrOpts) {
-  const {lrDevice, categoryIDs, logAssets, keepRawValues} = lrOpts;
+  const {lrDevice, categoryIDs, logAssets, keepRawValues, configOverride} = lrOpts;
 
   // Certain fixes need to kick in under LR, see https://github.com/GoogleChrome/lighthouse/issues/5839
   global.isLightrider = true;
@@ -38,10 +40,15 @@ async function runLighthouseInLR(connection, url, flags, lrOpts) {
   flags.logLevel = flags.logLevel || 'info';
   flags.channel = 'lr';
 
-  const config = lrDevice === 'desktop' ? LR_PRESETS.desktop : LR_PRESETS.mobile;
-  if (categoryIDs) {
-    config.settings = config.settings || {};
-    config.settings.onlyCategories = categoryIDs;
+  let config;
+  if (configOverride) {
+    config = configOverride;
+  } else {
+    config = lrDevice === 'desktop' ? LR_PRESETS.desktop : LR_PRESETS.mobile;
+    if (categoryIDs) {
+      config.settings = config.settings || {};
+      config.settings.onlyCategories = categoryIDs;
+    }
   }
 
   try {

clients/test/lightrider-entry-test.js

@@ -70,5 +70,53 @@ describe('lightrider-entry', () => {
 
       runStub.mockRestore();
     });
+
+    it('uses the desktop config preset when device is desktop', async () => {
+      const runStub = jest.spyOn(Runner, 'run');
+
+      const mockConnection = {};
+      const url = 'https://example.com';
+
+      const lrDevice = 'desktop';
+      await lhBackground.runLighthouseInLR(mockConnection, url, {}, {lrDevice});
+      const config = runStub.mock.calls[0][1].config;
+      assert.equal(config.settings.emulatedFormFactor, 'desktop');
+
+      runStub.mockRestore();
+    });
+
+    it('uses the mobile config preset when device is mobile', async () => {
+      const runStub = jest.spyOn(Runner, 'run');
+
+      const mockConnection = {};
+      const url = 'https://example.com';
+
+      const lrDevice = 'mobile';
+      await lhBackground.runLighthouseInLR(mockConnection, url, {}, {lrDevice});
+      const config = runStub.mock.calls[0][1].config;
+      assert.equal(config.settings.emulatedFormFactor, 'mobile');
+
+      runStub.mockRestore();
+    });
+
+    it('overrides the default config when one is provided', async () => {
+      const runStub = jest.spyOn(Runner, 'run');
+
+      const mockConnection = {};
+      const url = 'https://example.com';
+
+      const configOverride = {
+        default: 'lighthouse:default',
+        settings: {
+          onlyAudits: ['network-requests'],
+        },
+      };
+      await lhBackground.runLighthouseInLR(mockConnection, url, {}, {configOverride});
+      const config = runStub.mock.calls[0][1].config;
+      assert.equal(config.settings.onlyAudits.length, 1);
+      assert.equal(config.settings.onlyAudits[0], 'network-requests');
+
+      runStub.mockRestore();
+    });
   });
 });

lighthouse-core/lib/proto-preprocessor.js

@@ -25,17 +25,6 @@ function processForProto(result, opts = {}) {
   /** @type {LH.Result} */
   const reportJson = JSON.parse(result);
 
-  // Clean up the configSettings
-  // Note: This is not strictly required for conversion if protobuf parsing is set to
-  // 'ignore unknown fields' in the language of conversion.
-  if (reportJson.configSettings) {
-    // The settings that are in both proto and LHR
-    const {emulatedFormFactor, locale, onlyCategories} = reportJson.configSettings;
-
-    // @ts-ignore - intentionally only a subset of settings.
-    reportJson.configSettings = {emulatedFormFactor, locale, onlyCategories};
-  }
-
   // Remove runtimeError if it is NO_ERROR
   if (reportJson.runtimeError && reportJson.runtimeError.code === 'NO_ERROR') {
     delete reportJson.runtimeError;

lighthouse-core/test/report/proto-test.js

@@ -55,21 +55,28 @@ describe('round trip JSON comparison subsets', () => {
   });
 
   it('has the same config values', () => {
-    expect(roundTripJson.configSettings).toMatchObject(sampleJson.configSettings);
+    // Config settings from proto round trip should be a subset of the actual settings.
+    expect(sampleJson.configSettings).toMatchObject(roundTripJson.configSettings);
   });
 });
 
-// Note: In a failing diff, if you see details.summary going from {} to null, it's OK.
-// Jest considers this not a failure, and neither do we, here in the python roundtrip
-// Meanwhile, The PSI roundtrip maintains {} to {}.
 describe('round trip JSON comparison to everything', () => {
   let sampleJson;
 
   beforeEach(() => {
     sampleJson = JSON.parse(preprocessor.processForProto(sample));
+
+    // Proto conversion turns null summaries into an empty object. This is OK,
+    // and is handled in the PSI roundtrip just fine, but messes up the easy
+    // jest sub-object matcher. So, we put null back in its place.
+    for (const audit of Object.values(sampleJson.audits)) {
+      if (audit.details && JSON.stringify(audit.details.summary) === '{}') {
+        audit.details.summary = null;
+      }
+    }
   });
 
   it('has the same JSON overall', () => {
-    expect(roundTripJson).toMatchObject(sampleJson);
+    expect(sampleJson).toMatchObject(roundTripJson);
   });
 });

proto/sample_v2_round_trip.json

@@ -3706,6 +3706,7 @@
         }
     }, 
     "configSettings": {
+        "channel": "cli", 
         "emulatedFormFactor": "mobile", 
         "locale": "en-US", 
         "onlyCategories": null

proto/scripts/json_roundtrip_via_proto.py

@@ -33,7 +33,7 @@ def clean():
 proto_lhr = lhr_pb2.LighthouseResult()
 
 # fill proto lhr with data from JSON
-Parse(json.dumps(data), proto_lhr)
+Parse(json.dumps(data), proto_lhr, ignore_unknown_fields=True)
 
 # convert proto back into json
 round_trip_lhr = json.loads(MessageToJson(proto_lhr, including_default_value_fields=False))