Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Feedback from Paul. Removed python preprocessor. Added typechecking t…
…o js preprocessor. 1 more test. Comment fixes.
- Loading branch information
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,53 +3,64 @@ | |
| * 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 fs = require('fs'); | ||
|
|
||
| /** | ||
| * @fileoverview Helper functions to transform an LHR into a proto-ready LHR. | ||
| * | ||
| * FIXME: This file is 100% technical debt. Our eventual goal is for the | ||
| * roundtrip JSON to match the Golden LHR 1:1. | ||
| */ | ||
|
|
||
| /** | ||
| * @param {string} result | ||
| */ | ||
| function processForProto(result) { | ||
| /** @type {LH.Result} */ | ||
| const reportJson = JSON.parse(result); | ||
|
|
||
| // Clean up actions that require 'audits' to exist | ||
| if ('audits' in reportJson) { | ||
| Object.keys(reportJson.audits).forEach(auditName => { | ||
| const audit = reportJson.audits[auditName]; | ||
|
|
||
| // Rewrite the 'not-applicable' scoreDisplayMode to 'not_applicable'. #6201 | ||
| if ('scoreDisplayMode' in audit) { | ||
| if (audit.scoreDisplayMode === 'not-applicable') { | ||
| // @ts-ignore Breaking the LH.Result type | ||
| audit.scoreDisplayMode = 'not_applicable'; | ||
| } | ||
| } | ||
| // Drop raw values. #6199 | ||
| if ('rawValue' in audit) { | ||
| delete audit.rawValue; | ||
| } | ||
| // Normalize displayValue to always be a string, not an array. #6200 | ||
|
|
||
| if (Array.isArray(audit.displayValue)) { | ||
| /** @type {Array<any>}*/ | ||
| const values = []; | ||
| audit.displayValue.forEach(item => { | ||
| values.push(item); | ||
| }); | ||
| audit.displayValue = values.join(' | '); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| // Drop the i18n icuMessagePaths. Painful in proto, and low priority to expose currently. | ||
| if ('i18n' in reportJson && 'icuMessagePaths' in reportJson.i18n) { | ||
| delete reportJson.i18n.icuMessagePaths; | ||
| } | ||
|
|
||
| // Remove any found empty strings, as they are dropped after round-tripping anyway | ||
| /** | ||
| * @param {any} obj | ||
| */ | ||
| function removeStrings(obj) { | ||
| if (obj && typeof obj === 'object' && !Array.isArray(obj)) { | ||
| Object.keys(obj).forEach(key => { | ||
| if (typeof obj[key] === 'string' && obj[key] === '') { | ||
|
|
@@ -65,11 +76,33 @@ function processForProto(result) { | |
| } | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| removeStrings(reportJson); | ||
|
|
||
| return JSON.stringify(reportJson); | ||
| } | ||
|
|
||
| // @ts-ignore claims always false, but this checks if cli or module | ||
| if (require.main === module) { | ||
| // read in the argv for the input & output | ||
| const args = process.argv.slice(2); | ||
| let input; | ||
| let output; | ||
|
|
||
| if (args.length) { | ||
| input = args.find(flag => flag.startsWith('--in')); | ||
| output = args.find(flag => flag.startsWith('--out')); | ||
| } | ||
|
|
||
| if (input && output) { | ||
| // process the file | ||
| const report = processForProto(fs.readFileSync(input.replace('--in=', ''), 'utf-8')); | ||
This comment has been minimized.
Sorry, something went wrong.
This comment has been minimized.
Sorry, something went wrong. 
exterkamp
Author
Member
|
||
| // write to output from argv | ||
| fs.writeFileSync(output.replace('--out=', ''), report, 'utf-8'); | ||
| } | ||
| } else { | ||
| module.exports = { | ||
| processForProto, | ||
| }; | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| import os | ||
| import sys | ||
| import json | ||
| import subprocess | ||
| import lighthouse_result_pb2 as lhr_pb2 | ||
| from google.protobuf.json_format import Parse, MessageToJson | ||
|
|
||
| path = os.path.realpath(__file__) | ||
| path_dir = os.path.dirname(path) | ||
|
|
||
| path_sample_preprocessed = path_dir + '/sample_v2_processed.json' | ||
| path_sample = path_dir + '/../../lighthouse-core/test/results/sample_v2.json' | ||
| path_round_trip = path_dir + '/../sample_v2_round_trip.json' | ||
|
|
||
| def clean(): | ||
| try: | ||
| os.remove(path_sample_preprocessed) | ||
| except OSError: | ||
| pass | ||
|
|
||
| # clean workspace | ||
| clean() | ||
|
|
||
| # preprocess the sample json | ||
| cmd = ["node", "./../../lighthouse-core/lib/proto-preprocessor.js", "--in=./../../lighthouse-core/test/results/sample_v2.json", "--out=./sample_v2_processed.json"] | ||
| process = subprocess.call(cmd, stdout=subprocess.PIPE) | ||
|
|
||
| # open json | ||
| with open(path_sample_preprocessed, 'r') as f: | ||
| data = json.load(f) | ||
|
|
||
| # make empty proto lhr | ||
| proto_lhr = lhr_pb2.LighthouseResult() | ||
|
|
||
| # fill proto lhr with data from JSON | ||
| Parse(json.dumps(data), proto_lhr) | ||
|
|
||
| # convert proto back into json | ||
| round_trip_lhr = json.loads(MessageToJson(proto_lhr, including_default_value_fields=False)) | ||
|
|
||
| # write the json to disk | ||
| with open(path_round_trip, 'w') as f: | ||
| json.dump(round_trip_lhr, f, indent=4, sort_keys=True) |
IMO you should move these .replace() up to L94/etc