fix: wait for cipher refresher goroutine to exit on Close#4036
Open
larry-dalmeida wants to merge 2 commits into
Open
fix: wait for cipher refresher goroutine to exit on Close#4036larry-dalmeida wants to merge 2 commits into
larry-dalmeida wants to merge 2 commits into
Conversation
Registry.Close() called v.Close() but returned immediately, leaving the runCipherRefresher goroutine running until it observed the closed channel on its next select iteration. Under noleak this caused a spurious test failure in the secrets package. Initialize closedHook inside runCipherRefresher (only when a goroutine is actually started) and drain it in Registry.Close() so shutdown blocks until the goroutine has exited. Signed-off-by: Larry D Almeida <hello@larrydalmeida.com>
runCipherRefresher now always initializes closedHook itself, so pre-setting it in the test struct literal is dead code. Signed-off-by: Larry D Almeida <hello@larrydalmeida.com>
Member
|
👍 |
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
2 participants
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.
Related Issue
Fixes a goroutine leak found while working on #4034.
Problem
Registry.Close()calledv.Close()on each encrypter but returned immediately, leaving therunCipherRefreshergoroutine running until it observed the closed channel on its next select iteration. Undernoleakthis caused a test failure in thesecretspackage.Fix
Initialize
closedHookinsiderunCipherRefresher(only when a goroutine is actually started) and drain it inRegistry.Close()so shutdown blocks until the goroutine has exited. Thenilguard on the drain ensures encrypters created without a refresh interval (no goroutine started) are unaffected.No behavior change in production -
Close()is only called at shutdown.