fix: gracefully handle BrokenPipeError when writing to closed pipes - #797
Open
sentry[bot] wants to merge 1 commit into
Open
sentry[bot] wants to merge 1 commit into
sentry[bot] wants to merge 1 commit into
Conversation
❌ 1 Tests Failed:
View the full list of 1 ❄️ flaky test(s)
To view more test analytics, go to the Test Analytics Dashboard |
This branch has not been deployed
This file contains hidden or 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
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.
This PR addresses an issue where the CLI would crash with a
BrokenPipeErrorwhen its output (specifically error messages fromclick.echo()) was piped to another command that closed its input pipe prematurely (e.g.,codecov do-upload --report-type test_results 2>&1 | head -n 0).The root cause was that the CLI did not explicitly handle
BrokenPipeErrorwhen writing tostdoutorstderrin such scenarios, leading to an unhandled exception.The solution implements two complementary approaches:
SIGPIPEhandling: On POSIX systems, aSIGPIPEhandler is installed (signal.signal(signal.SIGPIPE, signal.SIG_DFL)). This allows the operating system to terminate the process cleanly when a pipe's reading end is closed, preventing Python from raising aBrokenPipeErrorin many cases.BrokenPipeErrorexception handling: The maincli()call incodecov_cli/main.pyis wrapped in atry/except BrokenPipeErrorblock. This catches anyBrokenPipeErrorthat might still occur (e.g., on Windows or in specific edge cases), silently flushes any remaining output, and exits with a non-zero status code (1) to indicate an issue, without crashing the application.This ensures a more robust and user-friendly experience when interacting with the CLI in piped environments.
Fixes CLI-HC
@sentry <feedback>: Autofix iterates on these changes@sentry stop iterating: Autofix stops iterating on this runThis PR was automatically generated by Sentry. You can adjust this setting at any time.