Interfaces: Update all component interfaces to implement io.Closer #3542
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
Previously, component interfaces did not mandate the implementation of the io.Closer interface and instead components could optionally implement `Close() error` or not. This meant that consumers had to manually type check if a component implemented `io.Closer` or not when attempting to close a component. This lead to situations whereby components either didn't implement the func signature correctly, like in the case of the [mongodb state store](https://github.com/dapr/components-contrib/pull/3537/files), or components had leakage where resources were not being closed properly as there was no close shutdown method. All components now implement the `io.Closer` interface. The configuration components have been updated to correctly respect contexts, and correctly wait for resources to be released on Close. Signed-off-by: joshvanl <[email protected]>
Signed-off-by: joshvanl <[email protected]>
Signed-off-by: joshvanl <[email protected]>
Signed-off-by: joshvanl <[email protected]>
Signed-off-by: joshvanl <[email protected]>
Signed-off-by: joshvanl <[email protected]>
Signed-off-by: joshvanl <[email protected]>
Signed-off-by: joshvanl <[email protected]>
Signed-off-by: joshvanl <[email protected]>
Signed-off-by: joshvanl <[email protected]>
JoshVanL
force-pushed
the
interfaces-io-closer
branch
from
db085e3
to
555ce7f
Compare
Signed-off-by: joshvanl <[email protected]>
Signed-off-by: joshvanl <[email protected]>
Signed-off-by: joshvanl <[email protected]>
Signed-off-by: joshvanl <[email protected]>
yaron2
approved these changes
Sep 19, 2024
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.
Previously, component interfaces did not mandate the implementation of the io.Closer interface and instead components could optionally implement
Close() erroror not. This meant that consumers had to manually type check if a component implementedio.Closeror not when attempting to close a component.This lead to situations whereby components either didn't implement the func signature correctly, like in the case of the mongodb state store, or components had leakage where resources were not being closed properly as there was no close shutdown method.
All components now implement the
io.Closerinterface.The configuration components have been updated to correctly respect contexts, and correctly wait for resources to be released on Close.