-
Notifications
You must be signed in to change notification settings - Fork 669
fix: close connection when dial setup fails to avoid a file descriptor leak #1934
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
knQzx
wants to merge
1
commit into
ClickHouse:main
Choose a base branch
from
knQzx:fix/dial-fd-leak
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.
+53
−5
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,42 @@ | ||
| package clickhouse | ||
|
|
||
| import ( | ||
| "context" | ||
| "net" | ||
| "sync/atomic" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| type closeTrackingConn struct { | ||
| net.Conn | ||
| closed *atomic.Bool | ||
| } | ||
|
|
||
| func (c *closeTrackingConn) Close() error { | ||
| c.closed.Store(true) | ||
|
|
||
| return c.Conn.Close() | ||
| } | ||
|
|
||
| // TestDialClosesConnectionOnSetupFailure ensures dial does not leak the underlying | ||
| // socket (and its file descriptor) when a post-dial setup step fails. The server | ||
| // side of the pipe is closed up front so the handshake fails. | ||
| func TestDialClosesConnectionOnSetupFailure(t *testing.T) { | ||
| client, server := net.Pipe() | ||
| require.NoError(t, server.Close()) | ||
|
|
||
| var closed atomic.Bool | ||
| tracked := &closeTrackingConn{Conn: client, closed: &closed} | ||
|
|
||
| _, err := dial(context.Background(), "127.0.0.1:9000", 1, &Options{ | ||
| DialContext: func(_ context.Context, _ string) (net.Conn, error) { | ||
| return tracked, nil | ||
| }, | ||
| }) | ||
|
|
||
| require.Error(t, err) | ||
| assert.True(t, closed.Load(), "dial must close the connection when a post-dial setup step fails") | ||
| } |
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.
💡 Nit — dial-error return still leaks if a custom DialContext returns both a conn and an error
This return sits above the new
defer, so a user-suppliedopt.DialContextthat returns a non-nilnet.Connalongside a non-nil error still leaks the fd — the exact failure mode this PR closes everywhere else in the function.Stdlib dialers never do this, so it's defensive only, but it's two lines and it makes the guarantee unconditional.