Skip to content

refactor(stdio): improve stdio server message handling #73

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

Merged
merged 1 commit into from
Mar 29, 2025

Conversation

winterfx
Copy link
Contributor

@winterfx winterfx commented Mar 26, 2025

Split stdio server message handling into dedicated functions for better readability:

  • handleNotifications: dedicated goroutine for notification processing
  • processInputStream: main input stream processing loop
  • readNextLine: context-aware line reading with cancellation
  • Listen: high-level coordination of input/output handling

Each function has a single responsibility and clear error handling strategy.

Summary by CodeRabbit

  • New Features

    • Enhanced real-time notifications that provide a smoother and more consistent experience.
    • Upgraded data stream processing for improved stability during session interactions.
  • Refactor

    • Streamlined internal handling of notifications and input, resulting in improved system efficiency and reliability.

- Add context-aware message reading with cancellation support
- Implement graceful EOF handling in input stream processing
- Add comprehensive error handling and logging
- Improve notification handling with dedicated goroutine
Copy link
Contributor

coderabbitai bot commented Mar 26, 2025

Walkthrough

This pull request refactors the notification and input stream handling within the StdioServer in the server package. The inline notification processing is moved to a dedicated method that listens and logs errors asynchronously. Input stream processing is encapsulated in a new method that handles EOF and supports cancellation through context. A helper function is also introduced to read lines in a context-aware manner.

Changes

File Change Summary
server/stdio.go - Added handleNotifications to asynchronously listen for and log notification errors.
- Added processInputStream to encapsulate input reading with proper EOF, error, and context cancellation handling.
- Introduced readNextLine to read lines from an input reader in a context-aware fashion.
- Refactored inline notification logic from the Listen method.

Possibly related PRs

  • Add per-session notifications handling #46: Introduces enhancements for notification handling by implementing per-session notification channels, aligning with the improvements in handling notifications within the StdioServer.
✨ 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.

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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

Copy link
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 (1)
server/stdio.go (1)

122-151: Consider simplifying the duplicate EOF handling

The processInputStream method properly handles EOF as a normal termination condition, but there's redundant EOF handling at lines 136-138 and 144-146. Since line 137 already returns nil when encountering EOF, the second check at lines 144-146 may never be reached.

func (s *StdioServer) processInputStream(ctx context.Context, reader *bufio.Reader, stdout io.Writer) error {
	for {
		if err := ctx.Err(); err != nil {
			return err
		}

		line, err := s.readNextLine(ctx, reader)
		if err != nil {
			if err == io.EOF {
				return nil
			}
			s.errLogger.Printf("Error reading input: %v", err)
			return err
		}

		if err := s.processMessage(ctx, line, stdout); err != nil {
-			if err == io.EOF {
-				return nil
-			}
			s.errLogger.Printf("Error handling message: %v", err)
			return err
		}
	}
}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d3dc35c and 362d9f1.

📒 Files selected for processing (1)
  • server/stdio.go (2 hunks)
🔇 Additional comments (3)
server/stdio.go (3)

106-120: Great implementation of asynchronous notification handling

The handleNotifications method provides a clean separation of concerns by moving notification processing to a dedicated goroutine. It properly handles context cancellation and logs errors without interrupting the notification flow.


153-183: Well-implemented context-aware read operation

The readNextLine method effectively makes blocking I/O operations cancellable via context, which is an excellent practice. The implementation properly manages goroutines and channels, making the code both robust and maintainable.

One minor suggestion: consider adding a comment about potential goroutine leaks if the parent routine doesn't ensure proper closure of the reader when the context is cancelled.


208-209: Clean refactoring of the Listen method

The modifications to the Listen method leverage the newly added functions, making the code more modular and easier to maintain. The asynchronous handling of notifications and the structured processing of input streams significantly improve the code organization.

@ezynda3 ezynda3 merged commit 2ea0c97 into mark3labs:main Mar 29, 2025
2 checks passed
@winterfx winterfx deleted the dev branch March 29, 2025 14:25
@coderabbitai coderabbitai bot mentioned this pull request Jun 11, 2025
16 tasks
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.

3 participants