extension: refactor option/flag passing (breaking change) #5769
Conversation
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
|
let's defer this a tad. |
brendankenny
approved these changes
Aug 6, 2018
|
|
||
| const results = await background.runLighthouseForConnection(connection, url, options, | ||
| categoryIDs); | ||
| // TODO(paulirish): update LR to provide flags and map outputFormat -> output |
There was a problem hiding this comment.
seems like this TODO shouldn't be in this file? (work here is already done)
| @@ -73,19 +73,17 @@ async function runLighthouseInExtension(options, categoryIDs) { | |||
| * Run lighthouse for connection and provide similar results as in CLI. | |||
| * @param {Connection} connection | |||
| * @param {string} url | |||
| * @param {{flags: LH.Flags} & {outputFormat: string, logAssets: boolean}} options Lighthouse options. | |||
| * @param {LH.Flags & {logAssets: boolean}} flags Lighthouse flags plus logAssets | |||
There was a problem hiding this comment.
logAssets could also be a fifth parameter to the function, or we could wait for some future refactor of saveArtifacts/saveAssets/logAssets (or this could @return {Promise<LH.RunnerResult|void>} and the caller could pull the artifacts off there)
|
tsc also flags as needing to be updated to just using |
paulirish
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
disclaimer: This is a breaking change for our integrations with them so all the clients must also update for this to work.
So I'm okay with delaying this PR for a bit.
This simplifies how we were juggling "options" coming in from extension/devtools/LR. Basically we were passing around an
optionsobject in the 2 -background files and all we cared about was itsflagsproperty. And in the case of LR, 2 other props came in onoptionsand eventually are delivered intoRunner.run, despite our typing.reviewers:
runner.js only has a rename. boring.
the background files have all the good stuff.