Replace unsafe usage of recover() in helper functions #4913
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
|
Now that it's merged, want to see if mgechev/revive#719 can be pulled in easily enough? |
Groxx
approved these changes
Jul 26, 2022
Comment on lines
+34
to
41
| // errPanic MUST be the result from calling recover, which MUST be done in a single level deep | ||
| // deferred function. The usual way of calling this is: | ||
| // - defer func() { log.CapturePanic(recover(), logger, &err) }() | ||
| func CapturePanic(errPanic interface{}, logger Logger, retError *error) { | ||
| if errPanic != nil { | ||
| err, ok := errPanic.(error) | ||
| if !ok { | ||
| err = fmt.Errorf("panic object is not error: %#v", errPanic) |
There was a problem hiding this comment.
I'll lightly vote for a rename, but either's clear enough I think. and there is some benefit in implying something may be panicking error objects and they're handled specially...
eh. your pick.
Suggested change
| // errPanic MUST be the result from calling recover, which MUST be done in a single level deep | |
| // deferred function. The usual way of calling this is: | |
| // - defer func() { log.CapturePanic(recover(), logger, &err) }() | |
| func CapturePanic(errPanic interface{}, logger Logger, retError *error) { | |
| if errPanic != nil { | |
| err, ok := errPanic.(error) | |
| if !ok { | |
| err = fmt.Errorf("panic object is not error: %#v", errPanic) | |
| // "recovered" MUST be the result from calling recover, which MUST be done in a single level deep | |
| // deferred function. The usual way of calling this is: | |
| // - defer func() { log.CapturePanic(recover(), logger, &err) }() | |
| func CapturePanic(recovered interface{}, logger Logger, retError *error) { | |
| if recovered != nil { | |
| err, ok := recovered.(error) | |
| if !ok { | |
| err = fmt.Errorf("panic object is not error: %#v", recovered) |
ZackLK
added a commit
that referenced
this pull request
Aug 22, 2022
We decided that our usage of helper functions when using defer/recover was too brittle, since one too many functions causes recover() not to do the right thing in Go. Switching to this idiom, where the defer caller also calls recover() ensures that we will get the right result from recover(), but also lets us continue to use the helper functions to deduplicate the code that runs after recover().
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.
We decided that our usage of helper functions when using defer/recover was too brittle, since one
too many functions causes recover() not to do the right thing in Go. Switching to this idiom, where
the defer caller also calls recover() ensures that we will get the right result from recover(), but
also lets us continue to use the helper functions to deduplicate the code that runs after recover().