misc(proto): Add proto definition for LHR

.gitignore

@@ -40,3 +40,9 @@ yarn-error.log
 /chrome.zip
 
 plots/out**
+
+*__pycache__
+*.pyc
+proto/scripts/*_pb2.*
+proto/scripts/*_pb.*
+proto/scripts/*_processed.json

lighthouse-core/lib/proto-preprocessor.js

@@ -0,0 +1,75 @@
+/**
+ * @license Copyright 2018 Google Inc. 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.
+ */
+// @ts-nocheck
+'use strict';
+
+/**
+ * Helper functions to transform an LHR into a proto-ready LHR
+ */
+
+/**
+  * @param {string} result
+  */
+function processForProto(result) {
+  const reportJson = JSON.parse(result);
+
+  // clean up that requires audits to exist
+  if ('audits' in reportJson) {
+    // clean up audits
+    Object.keys(reportJson.audits).forEach(audit => {
+      // clean up score display modes
+      if ('scoreDisplayMode' in reportJson.audits[audit]) {
+        if (reportJson.audits[audit].scoreDisplayMode === 'not-applicable') {
+          reportJson.audits[audit].scoreDisplayMode = 'not_applicable';
+        }
+      }
+      // delete raw values
+      if ('rawValue' in reportJson.audits[audit]) {
+        delete reportJson.audits[audit].rawValue;
+      }
+      // clean up display values
+      if ('displayValue' in reportJson.audits[audit]) {
+        if (Array.isArray(reportJson.audits[audit]['displayValue'])) {
+          const values = [];
+          reportJson.audits[audit]['displayValue'].forEach(item => {
+            values.push(item);
+          });
+          reportJson.audits[audit]['displayValue'] = values.join(' | ');
+        }
+      }
+    });
+  }
+
+  // delete i18n icuMsg paths
+  if ('i18n' in reportJson && 'icuMessagePaths' in reportJson.i18n) {
+    delete reportJson.i18n.icuMessagePaths;
+  }
+
+  // remove empty strings
+  (function removeStrings(obj) {
+    if (obj && typeof obj === 'object' && !Array.isArray(obj)) {
+      Object.keys(obj).forEach(key => {
+        if (typeof obj[key] === 'string' && obj[key] === '') {
+          delete obj[key];
+        } else if (typeof obj[key] === 'object' || Array.isArray(obj[key])) {
+          removeStrings(obj[key]);
+        }
+      });
+    } else if (Array.isArray(obj)) {
+      obj.forEach(item => {
+        if (typeof item === 'object' || Array.isArray(item)) {
+          removeStrings(item);
+        }
+      });
+    }
+  })(reportJson);
+
+  return JSON.stringify(reportJson);
+}
+
+module.exports = {
+  processForProto,
+};

lighthouse-core/test/lib/proto-preprocessor-test.js

@@ -0,0 +1,85 @@
+/**
+ * @license Copyright 2017 Google Inc. 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';
+
+const processForProto = require('../../lib/proto-preprocessor').processForProto;
+
+/* eslint-env jest */
+describe('processing for proto', () => {
+  it('cleans up audits', () => {
+    const input = {
+      'audits': {
+        'critical-request-chains': {
+          'scoreDisplayMode': 'not-applicable',
+          'rawValue': 14.3,
+          'displayValue': ['hello %d', 123],
+        },
+      },
+    };
+    const expectation = {
+      'audits': {
+        'critical-request-chains': {
+          'scoreDisplayMode': 'not_applicable',
+          'displayValue': 'hello %d | 123',
+        },
+      },
+    };
+    const output = processForProto(JSON.stringify(input));
+
+    expect(JSON.parse(output)).toMatchObject(expectation);
+  });
+
+
+  it('removes i18n icuMessagePaths', () => {
+    const input = {
+      'i18n': {
+        'icuMessagePaths': {
+          'content': 'paths',
+        },
+      },
+    };
+    const expectation = {
+      'i18n': {},
+    };
+    const output = processForProto(JSON.stringify(input));
+
+    expect(JSON.parse(output)).toMatchObject(expectation);
+  });
+
+  it('removes empty strings', () => {
+    const input = {
+      'audits': {
+        'critical-request-chains': {
+          'details': {
+            'chains': {
+              '1': '',
+            },
+          },
+        },
+      },
+      'i18n': {
+        'icuMessagePaths': {
+          'content': 'paths',
+        },
+        '2': '',
+      },
+    };
+    const expectation = {
+      'audits': {
+        'critical-request-chains': {
+          'details': {
+            'chains': {},
+          },
+        },
+      },
+      'i18n': {
+      },
+    };
+    const output = processForProto(JSON.stringify(input));
+
+    expect(JSON.parse(output)).toMatchObject(expectation);
+  });
+});

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

@@ -0,0 +1,72 @@
+/**
+ * @license Copyright 2017 Google Inc. 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';
+
+const path = require('path');
+const fs = require('fs');
+
+const sample = fs.readFileSync(path.resolve(__dirname, '../results/sample_v2.json'));
+const roundTripJson = require('../../../proto/sample_v2_round_trip');
+const preprocessor = require('../../lib/proto-preprocessor.js');
+
+/* eslint-env jest */
+
+describe('round trip JSON comparison subsets', () => {
+  let sampleJson;
+
+  beforeEach(() => {
+    sampleJson = JSON.parse(preprocessor.processForProto(sample));
+  });
+
+  it('has the same audit results sans details', () => {
+    Object.keys(sampleJson.audits).forEach(audit => {
+      delete sampleJson.audits[audit].details;
+    });
+
+    expect(roundTripJson.audits).toMatchObject(sampleJson.audits);
+  });
+
+  it('has the same audit results & details if applicable', () => {
+    Object.keys(sampleJson.audits).forEach(auditId => {
+      expect(roundTripJson.audits[auditId]).toMatchObject(sampleJson.audits[auditId]);
+
+      if ('details' in sampleJson.audits[auditId]) {
+        expect(roundTripJson.audits[auditId].details)
+          .toMatchObject(sampleJson.audits[auditId].details);
+      }
+    });
+  });
+
+  it('has the same i18n rendererFormattedStrings', () => {
+    expect(roundTripJson.i18n).toMatchObject(sampleJson.i18n);
+  });
+
+  it('has the same top level values', () => {
+    Object.keys(sampleJson).forEach(audit => {
+      if (typeof sampleJson[audit] === 'object' && !Array.isArray(sampleJson[audit])) {
+        delete sampleJson[audit];
+      }
+    });
+
+    expect(roundTripJson).toMatchObject(sampleJson);
+  });
+
+  it('has the same config values', () => {
+    expect(roundTripJson.configSettings).toMatchObject(sampleJson.configSettings);
+  });
+});
+
+describe('round trip JSON comparison to everything', () => {
+  let sampleJson;
+
+  beforeEach(() => {
+    sampleJson = JSON.parse(preprocessor.processForProto(sample));
+  });
+
+  it('has the same JSON overall', () => {
+    expect(roundTripJson).toMatchObject(sampleJson);
+  });
+});

lighthouse-extension/app/src/lightrider-entry.js

@@ -9,6 +9,7 @@ const lighthouse = require('../../../lighthouse-core/index');
 
 const assetSaver = require('../../../lighthouse-core/lib/asset-saver.js');
 const LHError = require('../../../lighthouse-core/lib/lh-error.js');
+const preprocessor = require('../../../lighthouse-core/lib/proto-preprocessor.js');
 
 /** @type {Record<'mobile'|'desktop', LH.Config.Json>} */
 const LR_PRESETS = {
@@ -46,6 +47,14 @@ async function runLighthouseInLR(connection, url, flags, {lrDevice, categoryIDs,
     if (logAssets) {
       await assetSaver.logAssets(results.artifacts, results.lhr.audits);
     }
+
+    // pre process the LHR for proto
+    if (flags.output === 'json') {
+      if (typeof results.report === 'string') {
+        return preprocessor.processForProto(results.report);
+      }
+    }
+
     return results.report;
   } catch (err) {
     // If an error ruined the entire lighthouse run, attempt to return a meaningful error.

package.json

@@ -21,7 +21,7 @@
     "build-all:task:windows": "yarn build-extension && yarn build-viewer",
     "build-extension": "cd ./lighthouse-extension && yarn build",
     "build-viewer": "cd ./lighthouse-viewer && yarn build",
-    "clean": "rimraf *.report.html *.report.dom.html *.report.json *.devtoolslog.json *.trace.json || true",
+    "clean": "rimraf proto/*_processed.json proto/*_pb2.* proto/*_pb.* proto/__pycache__ proto/*.pyc *.report.html *.report.dom.html *.report.json *.devtoolslog.json *.trace.json || true",
     "lint": "[ \"$CI\" = true ] && eslint --quiet -f codeframe . || eslint .",
     "smoke": "node lighthouse-cli/test/smokehouse/run-smoke.js",
     "debug": "node --inspect-brk ./lighthouse-cli/index.js",
@@ -63,7 +63,10 @@
     "diff:sample-json": "yarn i18n:checks && bash lighthouse-core/scripts/assert-golden-lhr-unchanged.sh",
     "ultradumbBenchmark": "./lighthouse-core/scripts/benchmark.js",
     "mixed-content": "./lighthouse-cli/index.js --chrome-flags='--headless' --preset=mixed-content",
-    "minify-latest-run": "./lighthouse-core/scripts/lantern/minify-trace.js ./latest-run/defaultPass.trace.json ./latest-run/defaultPass.trace.min.json && ./lighthouse-core/scripts/lantern/minify-devtoolslog.js ./latest-run/defaultPass.devtoolslog.json ./latest-run/defaultPass.devtoolslog.min.json"
+    "minify-latest-run": "./lighthouse-core/scripts/lantern/minify-trace.js ./latest-run/defaultPass.trace.json ./latest-run/defaultPass.trace.min.json && ./lighthouse-core/scripts/lantern/minify-devtoolslog.js ./latest-run/defaultPass.devtoolslog.json ./latest-run/defaultPass.devtoolslog.min.json",
+    "update:proto": "yarn compile-proto && yarn build-proto",
+    "compile-proto": "protoc --python_out=./ ./proto/lighthouse-result.proto && mv ./proto/*_pb2.py ./proto/scripts",
+    "build-proto": "cd proto/scripts && PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION=cpp PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION_VERSION=2 python make_python_roundtrip.py"
   },
   "devDependencies": {
     "@types/chrome": "^0.0.60",

proto/README.md

@@ -0,0 +1,18 @@
+## How to compile protos + use locally
+
+1. Install the proto compiler
+    1. Manual install
+        1. Get the latest proto [release](https://github.com/protocolbuffers/protobuf/releases) (select one with python included if you want to run this validator)
+        1. Install the [C++ Protocol Buffer Runtime](https://github.com/protocolbuffers/protobuf/blob/master/src/README.md)
+    1. Brew install
+        1. `brew install protobuf`
+1. Run `yarn compile-proto` then `yarn build-proto`
+
+## Proto Resources
+- [Protobuf Github Repo](https://github.com/protocolbuffers/protobuf) 
+- [Protobuf Docs](https://developers.google.com/protocol-buffers/docs/overview)
+
+## Hacking Hints
+- Clean out compiled proto and json with `yarn clean`
+- Round trips might jumble the order of your JSON keys and lists!
+- Is your `six` installation troubling your `pip install protobuf`? Mine did.  Try `pip install --ignore-installed six`.