Skip to content

Conversation

@mashiike
Copy link
Contributor

@mashiike mashiike commented Mar 26, 2025

This PR adds a Stderr() method to StdioMCPClient, allowing the parent process to read from the standard error output (stderr) of the spawned subprocess.

In many cases, the subprocess writes logs or error messages to stderr. By exposing stderr via the Stderr() method, the parent process can now handle this output — for example, for log collection, monitoring, or display purposes.

The Stderr() method returns an io.Reader that allows access to the subprocess’s stderr stream.

Summary by CodeRabbit

  • New Features
    • Enhanced logging: The application now captures structured diagnostic messages and error logs from background processes, providing clear, real-time feedback during startup and runtime. Users will see more transparent status updates—including informative launch messages—that improve monitoring and troubleshooting.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 26, 2025

Walkthrough

The pull request introduces comprehensive support for handling standard error output. In the production code (client/stdio.go), a new stderr field and associated methods are added to capture and manage subprocess error streams, with corresponding updates to initialization and cleanup operations. The test code (client/stdio_test.go) now captures JSON log records from the standard error via a goroutine, using synchronization mechanisms to ensure safe concurrent access, and includes a new test case validating a launch message. Additionally, structured JSON logging is added in the mock server (testdata/mockstdio_server.go) to emit an informational log.

Changes

Files Change Summary
client/stdio.go Added a stderr field (io.ReadCloser) to StdioMCPClient; updated NewStdioMCPClient to create the stderr pipe with error handling; modified the Close method to also close the stderr pipe; added a new Stderr() method returning an io.Reader for accessing standard error output.
client/stdio_test.go, testdata/mockstdio_server.go In tests, implemented a log capturing mechanism using a slice, mutex, and wait group to safely collect JSON log records from the client's stderr, with a new "CheckLogs" test case validating a specific launch message; in the mock server, introduced structured logging using log/slog with a JSON handler that logs an informational launch message to stderr.

📜 Recent 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 c314786.

📒 Files selected for processing (3)
  • client/stdio.go (3 hunks)
  • client/stdio_test.go (3 hunks)
  • testdata/mockstdio_server.go (2 hunks)
🔇 Additional comments (9)
testdata/mockstdio_server.go (1)

29-30: LGTM! Clean implementation of structured logging.

The implementation correctly sets up a JSON logger that writes to stderr and logs a well-formatted launch message. This works well with the new Stderr() method introduced in the StdioMCPClient.

client/stdio.go (5)

26-26: LGTM! Good addition of stderr field.

Adding the stderr field to the StdioMCPClient struct is a clean approach to capture the subprocess's standard error output.


62-65: LGTM! Proper error handling for stderr pipe.

The implementation correctly creates a pipe for stderr and includes appropriate error handling, following the same pattern used for stdin and stdout.


70-70: LGTM! Proper initialization.

The stderr field is correctly initialized in the client struct.


98-100: LGTM! Proper resource cleanup.

The implementation correctly closes the stderr pipe during cleanup, with proper error handling.


104-108: LGTM! Well-documented public method.

The Stderr() method is well-documented and follows the interface design pattern, returning an io.Reader which is the appropriate interface for reading operations.

client/stdio_test.go (3)

44-60: LGTM! Well-implemented concurrent log capture.

The implementation properly sets up a goroutine to continuously read JSON log records from stderr, with appropriate synchronization using a mutex to protect access to the shared logRecords slice. The use of a wait group ensures proper cleanup.


261-263: LGTM! Clean resource management.

Properly closes the client and waits for the log reading goroutine to finish, ensuring all resources are cleaned up correctly and all logs are processed before verification.


264-280: LGTM! Good test coverage for the new feature.

The test case correctly verifies that:

  1. Exactly one log record is captured
  2. The log record has a message key
  3. The message content matches the expected value

This provides good validation of the end-to-end functionality of the new Stderr() method.

✨ 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.

@ezynda3 ezynda3 merged commit 051cda5 into mark3labs:main Mar 29, 2025
2 checks passed
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.

2 participants