Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: "write /dev/stdout: broken pipe" error during execution #613

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

nicob3y
Copy link

@nicob3y nicob3y commented Feb 13, 2025

I have encountered this error many times during my tests.

Summary by CodeRabbit

  • Refactor
    • Enhanced the application's background process management to ensure more reliable and robust operations.

Copy link

coderabbitai bot commented Feb 13, 2025

📝 Walkthrough

Walkthrough

The changes refactor the cleanup logic within the _stream_from_subprocess context manager in the Airbyte executor. The updated implementation uses a try block to handle process termination and exit code checking, followed by a finally block to ensure that the stdout stream is always closed. The existing comments regarding broken pipe errors remain unchanged. There were no modifications to exported or public entities.

Changes

File Summary
airbyte/_executors/base.py Refactored cleanup logic in _stream_from_subprocess to wrap termination and exit code checking in a try block, with a finally block closing stdout.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant StreamManager as _stream_from_subprocess
    participant Subprocess

    Caller ->> StreamManager: Initiate subprocess streaming
    StreamManager ->> Subprocess: Start subprocess and stream output
    alt Process termination (try block)
        StreamManager ->> Subprocess: Attempt termination & exit code check
    end
    StreamManager ->> Subprocess: Finally close stdout
    StreamManager -->> Caller: Return stream data or error signal
Loading

Would you like to adjust or add more details to the sequence diagram, wdyt?

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
airbyte/_executors/base.py (2)

120-148: Great improvements to the process cleanup! 🎉

The new implementation is much more robust, with graceful shutdown, proper exit code handling, and guaranteed resource cleanup. This should effectively address the "broken pipe" errors.

A small suggestion: would you consider making the termination timeout configurable, perhaps as a parameter with a default value of 10 seconds? wdyt?

 @contextmanager
 def _stream_from_subprocess(
     args: list[str],
     *,
     stdin: IO[str] | AirbyteMessageIterator | None = None,
     log_file: IO[str] | None = None,
+    termination_timeout: float = 10.0,
 ) -> Generator[Iterable[str], None, None]:
     # ... existing code ...
     try:
         # Wait for a short period to allow process to terminate gracefully
-        process.wait(timeout=10)
+        process.wait(timeout=termination_timeout)

132-144: Consider enhancing the error message for better debugging.

The error message could be more descriptive about what happened during termination. Maybe we could include whether it was a graceful shutdown or force kill? wdyt?

             # If the exit code is not 0 or -15 (SIGTERM), raise an exception
             if exit_code not in {0, -15}:
                 raise exc.AirbyteSubprocessFailedError(
                     run_args=args,
                     exit_code=exit_code,
+                    message=f"Process failed with exit code {exit_code}. Process was {'force killed' if process._was_killed else 'terminated gracefully'}.",
                     original_exception=(
                         exception_holder.exception
                         if not isinstance(exception_holder.exception, BrokenPipeError)
                         else None
                     ),
                 )
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d064d42 and 1c1cd2a.

📒 Files selected for processing (1)
  • airbyte/_executors/base.py (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Pytest (No Creds)
  • GitHub Check: Pytest (Fast)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant