refactor: extract 'LeakCheckConfiguration' #37
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
This struct stores the slice of 'RoutinesSafeToIgnore' that are used as filters in `interestingGoroutines`. All package public functions for checking now immediately delegate to the `DefaultCheckConfiguration` which has the previous hard-coded list of values. This provides an extension point where a consumer of the library can extend the routines which are safe to ignore (i.e. explicitly allow a certain goroutine to leak) by either copying the DefaultCheckConfiguration and adding their own values (ideal), or by simply mutating the default value (less ideal).
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.
👋 Hello—thank you for making this package, I was just about to start copying stuff out of net/http until I found it!
One thing which would be convenient for me is the ability to specify a certain goroutine is "not interesting"—e.g. sometimes my code might be using some other package which starts some internal goroutine which by design runs forever. It would be nice if I could basically add it to the ignore list in the context of that particular test.
This PR attempts to achieve that by factoring out the slice of 'known disinteresting' values to a configuration struct, which can then be customised arbitrarily. The existing surface of the library doesn't change, as the package level functions now delegate to a package global default configuration.