mcp-go
mcp-go copied to clipboard
fix(client): prevent panics
The type assertation should be checked to prevent panicing allowing the caller to handle gracefully.
Summary by CodeRabbit
-
Bug Fixes
- Improved error handling to prevent crashes when accessing the standard error stream if unavailable.
-
Tests
- Updated tests to safely handle cases where the standard error stream may not be accessible.
Walkthrough
The changes update the GetStderr function in the client package to safely handle cases where the client's transport is not of type *transport.Stdio. The function now returns a tuple consisting of an io.Reader and a boolean indicating availability, instead of panicking on a failed type assertion. Corresponding tests have been updated to check the boolean result before proceeding with operations on the stderr stream.
Changes
| Files/Paths | Change Summary |
|---|---|
| client/stdio.go | Modified GetStderr to return (io.Reader, bool) and handle non-Stdio transports safely. |
| client/stdio_test.go | Updated tests to check the boolean from GetStderr before using the stderr reader. |
Possibly related PRs
- mark3labs/mcp-go#72: Introduced the
Stderr()method forStdioMCPClient, which is directly utilized and extended by the changes in this PR.
📜 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 781b7327ad04888293d38d0bf0a9cd0588d3af79 and 14e99ea86f17b89d72dce8665d6649cacb1113fc.
📒 Files selected for processing (2)
client/stdio.go(1 hunks)client/stdio_test.go(1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (2)
client/stdio_test.go (1)
client/stdio.go (1)
GetStderr(34-43)
client/stdio.go (2)
client/client.go (1)
Client(16-25)client/transport/stdio.go (1)
Stdio(20-34)
🔇 Additional comments (2)
client/stdio.go (1)
34-43: Improved error handling by returning a boolean flag instead of panickingThis change properly handles the case when a client's transport is not a Stdio transport. Instead of potentially panicking on a failed type assertion, the function now returns a boolean flag to indicate whether the operation was successful. This is a good practice in Go and aligns with the language's error handling patterns.
-func GetStderr(c *Client) io.Reader { +func GetStderr(c *Client) (io.Reader, bool) { t := c.GetTransport() - - return t.(*transport.Stdio).Stderr() + + stdio, ok := t.(*transport.Stdio) + if !ok { + return nil, false + } + + return stdio.Stderr(), true }client/stdio_test.go (1)
50-56: Test updated to handle new GetStderr return signatureThe test code has been correctly updated to handle the new function signature of
GetStderrthat now returns a boolean flag. The code now properly checks if the stderr reader is available before attempting to use it, which prevents potential panics during testing.
✨ 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.
🪧 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
@coderabbitaiin 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
@coderabbitaiin 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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR.@coderabbitai generate sequence diagramto generate a sequence diagram of the changes in this PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.