-
Notifications
You must be signed in to change notification settings - Fork 431
fix: add panic recovery to goroutines that execute user code #959
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
Open
blackwell-systems
wants to merge
1
commit into
modelcontextprotocol:main
Choose a base branch
from
blackwell-systems:fix/goroutine-panic-recovery
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| // Copyright 2025 The Go MCP SDK Authors. All rights reserved. | ||
| // Use of this source code is governed by an MIT-style | ||
| // license that can be found in the LICENSE file. | ||
|
|
||
| package mcp | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/google/jsonschema-go/jsonschema" | ||
| ) | ||
|
|
||
| // TestToolHandler_PanicRecovery verifies that a panicking tool handler does | ||
| // not crash the server process. The panic should be recovered and returned | ||
| // as a JSON-RPC internal error to the client. | ||
| func TestToolHandler_PanicRecovery(t *testing.T) { | ||
| ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second) | ||
| defer cancel() | ||
|
|
||
| ct, st := NewInMemoryTransports() | ||
|
|
||
| s := NewServer(testImpl, nil) | ||
| AddTool(s, &Tool{ | ||
| Name: "panic-tool", | ||
| Description: "a tool that panics", | ||
| InputSchema: &jsonschema.Schema{Type: "object"}, | ||
| }, func(_ context.Context, _ *CallToolRequest, _ map[string]any) (*CallToolResult, any, error) { | ||
| panic("deliberate panic in tool handler") | ||
| }) | ||
|
|
||
| ss, err := s.Connect(ctx, st, nil) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| defer ss.Close() | ||
|
|
||
| c := NewClient(testImpl, nil) | ||
| cs, err := c.Connect(ctx, ct, nil) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| defer cs.Close() | ||
|
|
||
| // Call the panicking tool. Without recovery, this crashes the process. | ||
| // With recovery, we get an error response. | ||
| _, err = cs.CallTool(ctx, &CallToolParams{Name: "panic-tool"}) | ||
|
|
||
| // We expect an error (the panic is caught and returned as internal error). | ||
| if err == nil { | ||
| t.Fatal("expected error from panicking tool handler, got success") | ||
| } | ||
| // The important thing is we reached this line: the process didn't crash. | ||
| } | ||
|
|
||
| // TestToolHandler_PanicDoesNotAffectSubsequentCalls verifies that after a | ||
| // panic in one tool handler, the server continues to serve other requests. | ||
| func TestToolHandler_PanicDoesNotAffectSubsequentCalls(t *testing.T) { | ||
| ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second) | ||
| defer cancel() | ||
|
|
||
| ct, st := NewInMemoryTransports() | ||
|
|
||
| s := NewServer(testImpl, nil) | ||
| AddTool(s, &Tool{ | ||
| Name: "panic-tool", | ||
| Description: "a tool that panics", | ||
| InputSchema: &jsonschema.Schema{Type: "object"}, | ||
| }, func(_ context.Context, _ *CallToolRequest, _ map[string]any) (*CallToolResult, any, error) { | ||
| panic("deliberate panic") | ||
| }) | ||
| AddTool(s, &Tool{ | ||
| Name: "safe-tool", | ||
| Description: "a tool that works", | ||
| InputSchema: &jsonschema.Schema{Type: "object"}, | ||
| }, func(_ context.Context, _ *CallToolRequest, _ map[string]any) (*CallToolResult, any, error) { | ||
| return &CallToolResult{Content: []Content{&TextContent{Text: "ok"}}}, nil, nil | ||
| }) | ||
|
|
||
| ss, err := s.Connect(ctx, st, nil) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| defer ss.Close() | ||
|
|
||
| c := NewClient(testImpl, nil) | ||
| cs, err := c.Connect(ctx, ct, nil) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| defer cs.Close() | ||
|
|
||
| // First: call the panicking tool. | ||
| _, _ = cs.CallTool(ctx, &CallToolParams{Name: "panic-tool"}) | ||
|
|
||
| // Second: call the safe tool. This should succeed, proving the server | ||
| // is still alive after the panic. | ||
| result, err := cs.CallTool(ctx, &CallToolParams{Name: "safe-tool"}) | ||
| if err != nil { | ||
| t.Fatalf("safe tool call failed after panic: %v", err) | ||
| } | ||
| if result == nil { | ||
| t.Fatal("expected result from safe tool, got nil") | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is the threat this recover() is intended to address?
A recover() here wouldn't catch panics from user handlers since those execute on the goroutine spawned in handleAsync.