Refactor UpgradeError to use bullt in errors functions #5704
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
chatton
requested review from
colin-axner,
AdityaSripal and
damiannolan
as code owners
chatton
commented
Jan 24, 2024
| return errors.Is(u.err, err) | ||
| // Is returns true if the of the provided error is an upgrade error. | ||
| func (*UpgradeError) Is(err error) bool { | ||
| _, ok := err.(*UpgradeError) |
There was a problem hiding this comment.
I think this is the simplest approach, by implementing it this way, when we call errors.Is with an UpgradeError as an argument, it will handle the traversal of the error stack and eventually hit this.
There was a problem hiding this comment.
yes! This is also what stdlib suggests https://pkg.go.dev/errors#Is
chatton
commented
Jan 24, 2024
| func (u *UpgradeError) Unwrap() error { | ||
| return u.err |
There was a problem hiding this comment.
when we call errors.Is, it will call Unwrap to traverse the stack.
damiannolan
approved these changes
Jan 24, 2024
DimitrisJim
approved these changes
Jan 24, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5704 +/- ##
==========================================
- Coverage 81.25% 81.24% -0.01%
==========================================
Files 199 199
Lines 15230 15224 -6
==========================================
- Hits 12375 12369 -6
Misses 2389 2389
Partials 466 466
|
colin-axner
approved these changes
Jan 24, 2024
There was a problem hiding this comment.
Excellent! Thank you @chatton looking into this! The changes look super clean to me :)
mergify bot
pushed a commit
that referenced
this pull request
Jan 24, 2024
(cherry picked from commit 97ea045)
DimitrisJim
pushed a commit
that referenced
this pull request
Jan 24, 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.
Description
This PR does a refactor to utilize the
errors.Isanderrors.Unwrapfunctions.@DimitrisJim pointed out we were using the
UnrwapandCauseincorrectly. The implementations have been updated to reflect their intended use case.Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/) or specification (x/<module>/spec/).godoccomments.Files changedin the Github PR explorer.Codecov Reportin the comment section below once CI passes.