fix: log playwright browser download progress on stderr #682
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
If a browser is downloaded during a test run, playwright will log on stdout. This can interfere with the calling code if it's trying to parse the output of the program as, for example, JSON. The fix is to temporarily replace `console.log` with `console.error` as that's what the [logPolitely](https://github.com/microsoft/playwright/blob/718bd9b35fd206245401a9ecb320289f427592d9/packages/playwright-core/src/server/registry/browserFetcher.ts#L120) function uses to give feedback to the user. The intention of the playwright maintainers is [not for this functionality to be used during a test run](microsoft/playwright#32487 (comment)) so it's unlikely to move to stderr otherwise.
|
This can be easily verified by removing your browser cache: $ rm -rf ~/Library/Caches/ms-playwright...and then directing stdout/stderr to files and examining their contents: $ npx pw-test ./mocks/test.mocha.js > stdout.txt 2> stderr.txt |
hugomrdias
approved these changes
Sep 10, 2024
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.
If a browser is downloaded during a test run, playwright will log on stdout.
This can interfere with the calling code if it's trying to parse the output of the program as, for example, JSON.
The fix is to temporarily replace
console.logwithconsole.erroras that's what the logPolitely function uses to give feedback to the user.The intention of the playwright maintainers is not for this functionality to be used during a test run so it's unlikely to move to stderr otherwise.
Type of change
Please delete options that are not relevant.