client: force-close abandoned client streams via runtime cleanup#235
Open
dmcgowan wants to merge 1 commit intocontainerd:mainfrom
Open
client: force-close abandoned client streams via runtime cleanup#235dmcgowan wants to merge 1 commit intocontainerd:mainfrom
dmcgowan wants to merge 1 commit intocontainerd:mainfrom
Conversation
1a75cfd to
7b24df1
Compare
Attach a runtime.AddCleanup callback to every clientStream returned by NewStream so that callers who drop the stream without consuming it have the underlying *stream force-closed and removed from the connection's stream map. Without this safety net a leaked stream's recv buffer fills and the connection's read loop only recovers via the 1-second ErrStreamFull fallback, leaving streamID slots and goroutines pinned until that timeout fires. The cleanup sets recvErr to errStreamAbandoned (unexported - the cleanup runs after the clientStream is unreachable, so no caller is left to match on it as a sentinel) and the abandon surfaces in the receive loop's "failed to handle message" log via the existing error path. Also adds NewClientWithContext so callers - notably tests - can supply a parent context whose attached logger is used for the client's internal goroutines, and a unit test that drives GC, asserts errStreamAbandoned on the closed stream, verifies the connection is not deadlocked, and captures the abandon log through the supplied context's logger. Bumps the Go minimum to 1.24 for runtime.AddCleanup. Signed-off-by: Derek McGowan <derek@mcg.dev>
7b24df1 to
10ccd75
Compare
austinvazquez
approved these changes
May 6, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Attach a runtime.AddCleanup callback to every clientStream returned by NewStream so that callers who drop the stream without consuming it have the underlying *stream force-closed and removed from the connection's stream map. Without this safety net a leaked stream's recv buffer fills and the connection's read loop only recovers via the 1-second ErrStreamFull fallback, leaving streamID slots and goroutines pinned until that timeout fires.
The cleanup sets recvErr to errStreamAbandoned (unexported - the cleanup runs after the clientStream is unreachable, so no caller is left to match on it as a sentinel) and the abandon surfaces in the receive loop's "failed to handle message" log via the existing error path.
Also adds NewClientWithContext so callers - notably tests - can supply a parent context whose attached logger is used for the client's internal goroutines, and a unit test that drives GC, asserts errStreamAbandoned on the closed stream, verifies the connection is not deadlocked, and captures the abandon log through the supplied context's logger.
Bumps the Go minimum to 1.24 for runtime.AddCleanup.