misc(proto): Add proto definition for LHR

.gitignore

@@ -40,3 +40,8 @@ yarn-error.log
 /chrome.zip
 
 plots/out**
+
+*__pycache__
+*_pb2.py
+*.pyc
+proto/*.json

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/*.json proto/*_pb2.py proto/*_pb2.pyc proto/__pycache__ *.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,8 @@
     "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",
+    "compile-proto": "protoc --python_out=./ ./proto/lighthouse-response.proto && python ./proto/proto_lhr_validator.py"
   },
   "devDependencies": {
     "@types/chrome": "^0.0.60",

proto/README.md

@@ -0,0 +1,23 @@
+## How to compile protos + use locally
+
+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. Run `yarn compile-proto` or run the commands seperately:
+    1. Compile proto python definitions
+        ```bash
+            cd ./proto
+            protoc --python_out=./ lighthouse-response.proto
+        ```
+    1. Run python round trip test
+        ```bash
+            python proto_lhr_validator.py
+        ```
+
+## 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`.