Refactor Shutdown into a separate interface to revert breaking change. #135
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
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.
#132 Added a new
Shutdownmethod that solves a specific problem with short-lived processes.Unfortunately since it added a new method to a public interface it broke backwards compatibility for other users of this library. We retracted the release v0.3.11 in #134.
Technically this library is still "zerover" since it's not yet made it to the 1.0.0 milestone and likely never will, but it is used widely in HashiCorp tools so it's preferable not to break downstream builds!
This PR moves the new
Shutdownmethod into a separate interface that can be optionally implemented by Sinks. I also remove all the no-op implementations for built-in Sinks since they are not longer necessary.@ggambetti would love to know if this will cause any issues for you? I think it should be compatible and tests all pass as before.