doc: add thread safety documentation for Error and Append#143
Open
veeceey wants to merge 2 commits intohashicorp:mainfrom
Open
doc: add thread safety documentation for Error and Append#143veeceey wants to merge 2 commits intohashicorp:mainfrom
veeceey wants to merge 2 commits intohashicorp:mainfrom
Conversation
Document that multierror.Error and the Append function are not safe for concurrent access from multiple goroutines. Add guidance pointing users to the Group type for concurrent error collection, or to use a sync.Mutex for manual synchronization. Closes hashicorp#93
Author
|
checking back on this — is there anything blocking it from getting reviewed? |
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
1 participant
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.
Addresses #93.
multierror.ErrorandAppendare not thread-safe, but this wasn't documented anywhere obvious. Ran into this myself and figured it would save others some debugging time.Changes:
Errortype doc comment inmultierror.goAppendfunction doc comment inappend.goGroup(recommended) and manualsync.MutexapproachesThe
WrappedErrorsmethod already had a concurrency note, so this brings the rest of the public API in line with that.