Skip to content
This repository was archived by the owner on Jan 23, 2026. It is now read-only.

Suppress OSError from sending EOF on UDS#447

Merged
mangelajo merged 2 commits intomainfrom
uds-darwin
May 7, 2025
Merged

Suppress OSError from sending EOF on UDS#447
mangelajo merged 2 commits intomainfrom
uds-darwin

Conversation

@NickCao
Copy link
Copy Markdown
Collaborator

@NickCao NickCao commented May 6, 2025

Fixes jumpstarter-dev/jumpstarter#444

Summary by CodeRabbit

  • Bug Fixes
    • Improved stability when signaling end-of-file over Unix Domain Sockets on Darwin systems, preventing unexpected errors in certain scenarios.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 6, 2025

Walkthrough

The change broadens exception handling in the copy_stream coroutine within the common.py module. Specifically, it now suppresses both AttributeError and OSError when calling dst.send_eof(), addressing a platform-specific error on Darwin systems related to Unix Domain Socket EOF signaling.

Changes

File(s) Change Summary
packages/jumpstarter/jumpstarter/streams/common.py Expanded exception suppression in copy_stream to include OSError during dst.send_eof() call.

Sequence Diagram(s)

sequenceDiagram
    participant Source as src
    participant Destination as dst
    loop Data transfer
        Source->>Destination: send data
    end
    Source->>Destination: send_eof()
    alt send_eof() raises AttributeError or OSError
        Note right of Destination: Exception suppressed
    end
Loading

Assessment against linked issues

Objective Addressed Explanation
Prevent socket disappearance and maintain persistent Unix domain socket connectivity on MacOS for jumpstarter shell (#444)

Poem

A socket on Mac would slip away,
But now we've taught it how to stay.
With errors caught both old and new,
The EOF now safely through.
So streams can flow and shells persist—
A bunny hops, connection kissed! 🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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 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.

@netlify
Copy link
Copy Markdown

netlify Bot commented May 6, 2025

Deploy Preview for jumpstarter-docs ready!

Name Link
🔨 Latest commit 86f0a6e
🔍 Latest deploy log https://app.netlify.com/sites/jumpstarter-docs/deploys/681b11aef74b1a0008ab20a5
😎 Deploy Preview https://deploy-preview-447--jumpstarter-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Copy Markdown
Contributor

@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)
packages/jumpstarter/jumpstarter/streams/common.py (2)

21-27: Consider more specific error handling.

While the current approach works, suppressing all OSError instances is quite broad. It might be better to catch only the specific error (errno 57) to avoid masking other legitimate OSErrors.

        with suppress(
            AttributeError,
            # https://github.com/jumpstarter-dev/jumpstarter/issues/444
            # sending EOF to UDS on Darwin could result in
            # OSError: [Errno 57] Socket is not connected
-           OSError,
+           # Only catch the specific "Socket is not connected" error
+           lambda e: isinstance(e, OSError) and e.errno == 57,
        ):
            await dst.send_eof()

Or alternatively:

        try:
            await dst.send_eof()
-       except (AttributeError, OSError):
+       except AttributeError:
+           pass
+       except OSError as e:
+           # Only suppress the specific Socket is not connected error
+           if e.errno != 57:
+               raise
            pass

21-27: Consider adding debug logging.

Since you're suppressing an exception, it might be helpful to add a debug-level log message to aid troubleshooting. This would make it easier to identify when this specific case is encountered.

        try:
            await dst.send_eof()
        except (AttributeError, OSError) as e:
+           logger.debug("Suppressed error when sending EOF: %s", e)
            pass
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3ab7b16 and 5a91f5b.

📒 Files selected for processing (1)
  • packages/jumpstarter/jumpstarter/streams/common.py (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: e2e
  • GitHub Check: pytest-matrix (3.12)
  • GitHub Check: pytest-matrix (3.11)
  • GitHub Check: pytest-matrix (3.13)
  • GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter-devspace .devfile/Containerfile.client)
  • GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter-utils Dockerfile.utils)
  • GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter-dev .devfile/Containerfile)
  • GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter Dockerfile)
🔇 Additional comments (1)
packages/jumpstarter/jumpstarter/streams/common.py (1)

21-27: Good fix with clear explanation.

The change properly addresses the OSError that occurs when sending EOF to Unix Domain Sockets on Darwin systems. The added comments provide excellent context by referencing the specific issue and explaining the error condition.

@mangelajo
Copy link
Copy Markdown
Member

It works like a charm!, how did you debug this! ? :D

@mangelajo mangelajo enabled auto-merge May 7, 2025 07:54
@mangelajo mangelajo merged commit 1cf0a09 into main May 7, 2025
19 checks passed
@mangelajo mangelajo added the backport release-0.6 Backport PR to release-0.6 branch label May 7, 2025
@jumpstarter-backport-bot
Copy link
Copy Markdown

Successfully created backport PR for release-0.6:

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

backport release-0.6 Backport PR to release-0.6 branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

MacOS JUMPSTARTER_HOST socket disconnects on shell.

2 participants