-
Notifications
You must be signed in to change notification settings - Fork 124
Fix responses goroutine leak #874
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
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
2f94eb8
routing: expose Close on Service to prevent goroutine leaks
ilopezluna 39167cb
main: call svc.Close() on shutdown
ilopezluna f362659
routing: add goleak tests for RouterResult cleanup
ilopezluna eb4ddb6
Address review feedback: make Close idempotent and nil-safe
ilopezluna 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
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,47 @@ | ||
| package routing | ||
|
|
||
| import ( | ||
| "log/slog" | ||
| "testing" | ||
| ) | ||
|
|
||
| // TestNewRouter_WithResponsesAPI_Close verifies that creating a router with | ||
| // IncludeResponsesAPI enabled and then calling Close does not leak | ||
| // goroutines. The goleak detector in TestMain will catch any leak. | ||
| func TestNewRouter_WithResponsesAPI_Close(t *testing.T) { | ||
| log := slog.New(slog.DiscardHandler) | ||
|
sourcery-ai[bot] marked this conversation as resolved.
|
||
|
|
||
| result := NewRouter(RouterConfig{ | ||
| Log: log, | ||
| IncludeResponsesAPI: true, | ||
| // Scheduler, ModelHandler, etc. are nil — the responses handler | ||
| // only needs them when actually serving requests, not for route | ||
| // registration and cleanup. | ||
| }) | ||
|
|
||
| // Verify the mux was created. | ||
| if result.Mux == nil { | ||
| t.Fatal("expected non-nil Mux") | ||
| } | ||
|
|
||
| // Close must stop the responses Store cleanup goroutine. | ||
| result.Close() | ||
| } | ||
|
|
||
| // TestNewRouter_WithoutResponsesAPI_Close verifies that Close is safe | ||
| // to call even when the Responses API is not enabled (no closers). | ||
| func TestNewRouter_WithoutResponsesAPI_Close(t *testing.T) { | ||
| log := slog.New(slog.DiscardHandler) | ||
|
|
||
| result := NewRouter(RouterConfig{ | ||
| Log: log, | ||
| IncludeResponsesAPI: false, | ||
| }) | ||
|
|
||
| if result.Mux == nil { | ||
| t.Fatal("expected non-nil Mux") | ||
| } | ||
|
|
||
| // Should be a no-op, must not panic. | ||
| result.Close() | ||
| } | ||
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,12 @@ | ||
| package routing | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "go.uber.org/goleak" | ||
| ) | ||
|
|
||
| // TestMain runs goleak after the test suite to detect goroutine leaks. | ||
| func TestMain(m *testing.M) { | ||
| goleak.VerifyTestMain(m) | ||
| } |
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.
Uh oh!
There was an error while loading. Please reload this page.