Avoid leaking watch threads on client shutdown #87
Conversation
This file contains 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
When creating the ZkWatch struct, we keep a reference to the sender of the channel and clone it on `sender()` to pass along to the `ZkIo` struct. When the ZkIo thread finishes, its copy of the sender is dropped but the channel is not closed because the watch has a reference to its own sender, therefore leaking the thread. Instead, we can prevent the watch from ever taking the sender by returning it through the constructor, so that it can be owned by `ZkIo` which will close the channel as expected on shutdown.
bonifaido
approved these changes
Oct 17, 2022
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.
When creating the ZkWatch struct, we keep a reference to the sender of the channel and clone it on
sender()to pass along to theZkIostruct.When the ZkIo thread finishes, its copy of the sender is dropped but the channel is not closed because the watch has a reference to its own sender, therefore leaking the thread.
Instead, we can prevent the watch from ever taking the sender by returning it through the constructor, so that it can be owned by
ZkIowhich will close the channel as expected on shutdown.