From d3163b896036978c891a3b7ad19720e35bdc2dda Mon Sep 17 00:00:00 2001 From: Aaron Craelius Date: Wed, 16 Mar 2022 09:59:49 -0400 Subject: [PATCH] fix(errors): support wrapped errors with gRPC codes (#11385) ## Description Follows up on #11274 to properly support wrapped errors. --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [ ] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable) --- errors/errors.go | 20 ++++++++++++++++++++ errors/errors_test.go | 7 +++++-- 2 files changed, 25 insertions(+), 2 deletions(-) diff --git a/errors/errors.go b/errors/errors.go index 5d54bedfc9..0dedd42688 100644 --- a/errors/errors.go +++ b/errors/errors.go @@ -244,6 +244,26 @@ func (e *wrappedError) Unwrap() error { return e.parent } +// GRPCStatus gets the gRPC status from the wrapped error or returns an unknown gRPC status. +func (e *wrappedError) GRPCStatus() *grpcstatus.Status { + w := e.Cause() + for { + if hasStatus, ok := w.(interface { + GRPCStatus() *grpcstatus.Status + }); ok { + return hasStatus.GRPCStatus() + } + + x, ok := w.(causer) + if ok { + w = x.Cause() + } + if x == nil { + return grpcstatus.New(grpccodes.Unknown, e.msg) + } + } +} + // Recover captures a panic and stop its propagation. If panic happens it is // transformed into a ErrPanic instance and assigned to given error. Call this // function using defer in order to work as expected. diff --git a/errors/errors_test.go b/errors/errors_test.go index 07868eb76f..acc00fb129 100644 --- a/errors/errors_test.go +++ b/errors/errors_test.go @@ -213,11 +213,14 @@ func (s *errorsTestSuite) TestABCIError() { func (s *errorsTestSuite) TestGRPCStatus() { s.Require().Equal(codes.Unknown, grpcstatus.Code(errInternal)) s.Require().Equal(codes.NotFound, grpcstatus.Code(ErrNotFound)) - s.Require().Equal(codes.Unimplemented, grpcstatus.Code(ErrNotSupported)) - s.Require().Equal(codes.FailedPrecondition, grpcstatus.Code(ErrConflict)) + status, ok := grpcstatus.FromError(ErrNotFound) s.Require().True(ok) s.Require().Equal("codespace testtesttest code 38: not found", status.Message()) + + // test wrapping + s.Require().Equal(codes.Unimplemented, grpcstatus.Code(ErrNotSupported.Wrap("test"))) + s.Require().Equal(codes.FailedPrecondition, grpcstatus.Code(ErrConflict.Wrapf("test %s", "foo"))) } func ExampleWrap() {