Update error usage patterns to go1.13+ #7529
Merged
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
farazdagi
added
OK to merge
Ready For Review
| } | ||
| sTime, err := mathutil.Add64(genesisTimeSec, timeSinceGenesis) | ||
| if err != nil { | ||
| return time.Unix(0, 0), fmt.Errorf("slot (%d) is in the far distant future: %v", slot, err) | ||
| return time.Unix(0, 0), fmt.Errorf("slot (%d) is in the far distant future: %w", slot, err) |
There was a problem hiding this comment.
Shouldn't we use errors.Wrapf?
There was a problem hiding this comment.
- The only difference is that stack traces are included with
errors.Wrapf. - Original code didn't use the
errors.Wrapf(), so I am not sure whether it should be used or not. The scope of this PR was just to make sure if we are including original error, include it with%wi.e. wrap using new verb available in Golang 1.13
prestonvanloon
approved these changes
Oct 14, 2020
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.
What type of PR is this?
What does this PR do? Why is it needed?
errors.Is(err, errType)instead oferr == errTypewhen comparing non-nil errors to some type (as former is able to unwrap wrapped errors and compare correctly).fmt.Errorf("sth wrong: %v", err), it is better to wrap the error using new verb%w(just%v -> %wis enough i.e.fmt.Errorf("sth wrong: %w", err)), as that way client code can get access to the original error (unwrap) if necessary.Which issues(s) does this PR fix?
N/A
Other notes for review
github.com/pkg/errorsto wrap errors, there are relatively few places withfmt.Errorf(). Existing code, which relies on that custom package, is not touched. For future code, however, if stack trace is not required it is probably worth considering usingfmt.Errorf("custom msg: %w", err)to wrap errors.