Use error instead of *Error in Group
#58
Open
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
|
|
Changes the return value of Group.Wait to error instead of *Error. The *Error concrete type can lead to unintuitive, subtle bugs around nil checks (see: https://golang.org/doc/faq#nil_error). Returning the error interface instead eliminates these. Addresses hashicorp#57.
ccampo133
force-pushed
the
return_error_from_wait
branch
from
f5409ce
to
7d7a61a
Compare
|
That would be a breaking change, so unlikely to be accepted. The only solution at this point would be a linter detecting a call to |
dolmen
reviewed
Mar 24, 2024
| @@ -6,7 +6,7 @@ import "sync" | |||
| // coalesced. | |||
| type Group struct { | |||
| mutex sync.Mutex | |||
| err *Error | |||
| err error | |||
There was a problem hiding this comment.
This change is not necessary.
Instead Wait should return g.err.ErrorOrNil().
| @@ -30,7 +30,7 @@ func (g *Group) Go(f func() error) { | |||
|
|
|||
| // Wait blocks until all function calls from the Go method have returned, then | |||
| // returns the multierror. | |||
| func (g *Group) Wait() *Error { | |||
| func (g *Group) Wait() error { | |||
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.
Changes the type of
Group.errtoerrorinstead of*Error, and also changes the return value ofGroup.Waittoerrorinstead of*Error. The*Errorconcrete type can lead to unintuitive, subtle bugs around nil checks (see: https://golang.org/doc/faq#nil_error). Returning the error interface instead eliminates this possibility. Note that because this changes a public API signature, it should be considered a breaking change.Fixes #57