-
Notifications
You must be signed in to change notification settings - Fork 240
fix(router): connection leak with redis pub/sub #2916
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
ehaynes99
wants to merge
1
commit into
wundergraph:main
Choose a base branch
from
OpenPhone:ehaynes-fix-redis-connection-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.
+81
−9
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,70 @@ | ||
| package redis | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/alicebob/miniredis/v2" | ||
| "github.com/stretchr/testify/require" | ||
| "github.com/wundergraph/cosmo/router/pkg/pubsub/datasource" | ||
| "go.uber.org/zap/zaptest" | ||
| ) | ||
|
|
||
| // noopUpdater satisfies datasource.SubscriptionEventUpdater for tests. | ||
| type noopUpdater struct{} | ||
|
|
||
| func (noopUpdater) Update(events []datasource.StreamEvent) {} | ||
| func (noopUpdater) Complete() {} | ||
| func (noopUpdater) Done() {} | ||
| func (noopUpdater) SetHooks(hooks datasource.Hooks) {} | ||
|
|
||
| func newTestAdapter(t *testing.T) (*ProviderAdapter, *miniredis.Miniredis) { | ||
| t.Helper() | ||
|
|
||
| mr := miniredis.RunT(t) | ||
|
|
||
| adapter := NewProviderAdapter( | ||
| context.Background(), | ||
| zaptest.NewLogger(t), | ||
| []string{fmt.Sprintf("redis://%s", mr.Addr())}, | ||
| false, | ||
| datasource.ProviderOpts{}, | ||
| ) | ||
| require.NoError(t, adapter.Startup(context.Background())) | ||
| t.Cleanup(func() { _ = adapter.Shutdown(context.Background()) }) | ||
|
|
||
| return adapter.(*ProviderAdapter), mr | ||
| } | ||
|
|
||
| // TestProviderAdapter_Subscribe_ReleasesConnectionOnCancel guards against the | ||
| // connection leak where each subscription's dedicated pub/sub connection was | ||
| // never closed (only PUnsubscribe was called, with an already-cancelled | ||
| // context). After every subscription context is cancelled, the pool's total | ||
| // connection count must return to its pre-subscribe baseline. | ||
| func TestProviderAdapter_Subscribe_ReleasesConnectionOnCancel(t *testing.T) { | ||
| p, _ := newTestAdapter(t) | ||
|
|
||
| baseline := p.conn.PoolStats().TotalConns | ||
|
|
||
| const subscriptions = 10 | ||
| for i := 0; i < subscriptions; i++ { | ||
| subCtx, cancel := context.WithCancel(context.Background()) | ||
| err := p.Subscribe(subCtx, &SubscriptionEventConfiguration{ | ||
| Provider: "test-provider", | ||
| Channels: []string{fmt.Sprintf("channel-%d", i)}, | ||
| }, noopUpdater{}) | ||
| require.NoError(t, err) | ||
|
|
||
| // Cancelling the subscription context must tear the subscription down | ||
| // and release its dedicated connection. | ||
| cancel() | ||
| } | ||
|
|
||
| require.Eventually(t, func() bool { | ||
| return p.conn.PoolStats().TotalConns <= baseline | ||
| }, 5*time.Second, 10*time.Millisecond, | ||
| "redis pub/sub connections leaked: have %d, baseline %d", | ||
| p.conn.PoolStats().TotalConns, baseline) | ||
| } | ||
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.
require.Eventuallyfailure message args are evaluated eagerly.p.conn.PoolStats().TotalConnsat Line 69 is evaluated once whenEventuallyis invoked (right after cancelling, before any polling), not at failure time. For a leak-detection test, the printed "have %d" can be misleading during CI debugging. Capture the value inside the condition or via a local closure variable.💚 Proposed fix to report the value observed at failure time
📝 Committable suggestion
🤖 Prompt for AI Agents