Skip to content
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

rpc: tighter shutdown synchronization in client subscription #22597

Merged
merged 7 commits into from
Mar 30, 2021

Conversation

fjl
Copy link
Contributor

@fjl fjl commented Mar 29, 2021

This fixes a rare issue where the client subscription forwarding loop
would attempt send on the subscription's channel after Unsubscribe has
returned, leading to a panic if the subscription channel was already
closed by the user. Example:

sub, _ := client.Subscribe(..., channel, ...)
sub.Unsubscribe()
close(channel)

The race occurred because Unsubscribe called quitWithServer to tell the
forwarding loop to stop sending on sub.channel, but did not wait for the
loop to actually come down. This is fixed by adding an additional channel
to track the shutdown, on which Unsubscribe now waits.

Fixes #22322

fjl added 4 commits March 29, 2021 18:31
This fixes a rare issue where the client subscription forwarding loop
would attempt send on the subscription's channel after Unsubscribe has
returned, leading to a panic if the subscription channel was already
closed by the user. Example:

    sub, _ := client.Subscribe(..., channel, ...)
    sub.Unsubscribe()
    close(channel)

The race occurred because Unsubscribe called quitWithServer to tell the
forwarding loop to stop sending, but did not wait for the loop to
actually stop. This is fixed by adding an additional channel to track
the shutdown, on which Unsubscribe now waits.
Not sure why this was there, but it's useless: when forward exits,
the list is no longer referenced and doesn't need to be cleared.
@fjl fjl requested a review from holiman as a code owner March 29, 2021 16:41
@fjl fjl added this to the 1.10.2 milestone Mar 29, 2021
@samsondav
Copy link

Amazing, thank you!

atif-konasl pushed a commit to frozeman/pandora-execution-engine that referenced this pull request Oct 15, 2021
…m#22597)

This fixes a rare issue where the client subscription forwarding loop
would attempt send on the subscription's channel after Unsubscribe has
returned, leading to a panic if the subscription channel was already
closed by the user. Example:

    sub, _ := client.Subscribe(..., channel, ...)
    sub.Unsubscribe()
    close(channel)

The race occurred because Unsubscribe called quitWithServer to tell the
forwarding loop to stop sending on sub.channel, but did not wait for the
loop to actually come down. This is fixed by adding an additional channel
to track the shutdown, on which Unsubscribe now waits.

Fixes ethereum#22322
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rare occurences of panic: send on closed channel in rpc/subscription.go
3 participants