misc(proto): Add proto definition for LHR #6183
Conversation
…d do a round trip run.
proto/proto_lhr_validator.py
Outdated
|
|
||
| # write round trip json file | ||
| with open(path_dir + '/' + 'lhr_round_trip.json', 'w') as f: | ||
| json.dump(json_lhr, f, indent=4) |
There was a problem hiding this comment.
what is the test going to end up being?
There was a problem hiding this comment.
It was a way for me to rapidly prototype what mods to the sample we needed to make it proto compliant and mess with the JSON easily. This should be converted into a test that makes a round trip diff with the sample json and integrate that into our jest tests IMO I just haven't made that.
… and missing vals. Cleaned up python. Started to make test for json -> proto conversion.
…ric with wrappers, and added tests which PASS!
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Good stuff! Lots of stuff. :)
Some comments below, most pretty minor. I didn't review the proto in depth yet. @brendankenny also should dig into that part in particular.
One larger item:
So in this PR we have a proto-preprocessor in two languages. For purely technical debt, it's definitely extra to maintain two copies. :)
I think we could use the JS one for now. And we could still use it in the roundtrip script if we wanted to... an invocation like:
node -e "const jsonStr = require('./lighthouse-core/lib/proto-preprocessor.js').processForProto('{}'); process.stdout.write(jsonStr); "Or we just string a few npm scripts together since we need this before the make_python_roundtrip script does most of its work. That's probably better. :)
| expect(JSON.parse(output)).toMatchObject(expectation); | ||
| }); | ||
|
|
||
| it('removes empty strings', () => { |
There was a problem hiding this comment.
i think you'll want another test case here? something involving arrays? details?
There was a problem hiding this comment.
Added a little addition with an array containing an object that has an empty string. It doesn't clear empty strings that are in an array by design though.
| @@ -57,15 +57,21 @@ declare global { | |||
| export import CrdpEvents = _CrdpMappings.Events; | |||
| export import CrdpCommands = _CrdpMappings.Commands; | |||
|
|
|||
| /** Simulation settings that control the amount of network & cpu throttling in the run. */ | |||
There was a problem hiding this comment.
thx for adding all these! awesome.
We currently dont have a technique to keep these matching the proto ones, right?
There was a problem hiding this comment.
correct, I think @brendankenny mentions that we don't but should 😢
…o js preprocessor. 1 more test. Comment fixes.
There was a problem hiding this comment.
This was a work in progress PR until it very suddenly wasn't :)
We don't have a workflow set in stone for that, but we've sometimes marked such PRs with a WIP: prefix (which calls it out and prevents merging due to the pr lint), worked on it and called in folks by @name when needed, then, when ready, taking off the "WIP" and announcing ready for review.
PR development can vary quite a bit, but that has served us well in the past to at least give a heads up on the state of things.
Regardless, PR looks good :) I didn't look through the proto definition itself, but I added a few comments on some (fairly trivial) things we should address at some point.
| @@ -0,0 +1,378 @@ | |||
| syntax = "proto3"; | |||
| @@ -0,0 +1,43 @@ | |||
| import os | |||
| "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 json_roundtrip_via_proto.py" |
There was a problem hiding this comment.
Is there a better name than build-proto? Is it actually building the roundtrip json?
| @@ -0,0 +1,72 @@ | |||
| /** | |||
There was a problem hiding this comment.
this shouldn't be under test/report/. Should the contents just be in proto-preprocessor-test.js? Or, if the preprocessor is going to eventually go away, seems like it should just be in proto/test/?
Summary
Added /proto which contains:
yarn compile-protoOpen Items
icuMessagePathscontentnot-applicabletonot_applicablein scoreDisplayMode scoreDisplayMode incompatable with proto enum: not-applicable #6201displayValuealways alist of stringsstring Audit.Result.displayValue should always be a string #6200scoreare set to 0. :/google.protobuf.Valueto be nullablefalseby wrapping withBoolValueor keep asboolwhere they will be dropped from output as a default when set tofalsefalseexplicitly when in the config!