-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: remove redacted message (#11960)
## Description Closes: #11539 --- ### 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/main/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/main/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/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) (cherry picked from commit bcf2088) # Conflicts: # CHANGELOG.md # errors/abci.go
- Loading branch information
1 parent
cf17549
commit 8ab98df
Showing
3 changed files
with
162 additions
and
76 deletions.
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| package errors | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "reflect" | ||
| ) | ||
|
|
||
| const ( | ||
| // SuccessABCICode declares an ABCI response use 0 to signal that the | ||
| // processing was successful and no error is returned. | ||
| SuccessABCICode uint32 = 0 | ||
|
|
||
| // All unclassified errors that do not provide an ABCI code are clubbed | ||
| // under an internal error code and a generic message instead of | ||
| // detailed error string. | ||
| internalABCICodespace = UndefinedCodespace | ||
| internalABCICode uint32 = 1 | ||
| ) | ||
|
|
||
| // ABCIInfo returns the ABCI error information as consumed by the tendermint | ||
| // client. Returned codespace, code, and log message should be used as a ABCI response. | ||
| // Any error that does not provide ABCICode information is categorized as error | ||
| // with code 1, codespace UndefinedCodespace | ||
| // When not running in a debug mode all messages of errors that do not provide | ||
| // ABCICode information are replaced with generic "internal error". Errors | ||
| // without an ABCICode information as considered internal. | ||
| func ABCIInfo(err error, debug bool) (codespace string, code uint32, log string) { | ||
| if errIsNil(err) { | ||
| return "", SuccessABCICode, "" | ||
| } | ||
|
|
||
| encode := defaultErrEncoder | ||
| if debug { | ||
| encode = debugErrEncoder | ||
| } | ||
|
|
||
| return abciCodespace(err), abciCode(err), encode(err) | ||
| } | ||
|
|
||
| // The debugErrEncoder encodes the error with a stacktrace. | ||
| func debugErrEncoder(err error) string { | ||
| return fmt.Sprintf("%+v", err) | ||
| } | ||
|
|
||
| func defaultErrEncoder(err error) string { | ||
| return err.Error() | ||
| } | ||
|
|
||
| type coder interface { | ||
| ABCICode() uint32 | ||
| } | ||
|
|
||
| // abciCode tests if given error contains an ABCI code and returns the value of | ||
| // it if available. This function is testing for the causer interface as well | ||
| // and unwraps the error. | ||
| func abciCode(err error) uint32 { | ||
| if errIsNil(err) { | ||
| return SuccessABCICode | ||
| } | ||
|
|
||
| for { | ||
| if c, ok := err.(coder); ok { | ||
| return c.ABCICode() | ||
| } | ||
|
|
||
| if c, ok := err.(causer); ok { | ||
| err = c.Cause() | ||
| } else { | ||
| return internalABCICode | ||
| } | ||
| } | ||
| } | ||
|
|
||
| type codespacer interface { | ||
| Codespace() string | ||
| } | ||
|
|
||
| // abciCodespace tests if given error contains a codespace and returns the value of | ||
| // it if available. This function is testing for the causer interface as well | ||
| // and unwraps the error. | ||
| func abciCodespace(err error) string { | ||
| if errIsNil(err) { | ||
| return "" | ||
| } | ||
|
|
||
| for { | ||
| if c, ok := err.(codespacer); ok { | ||
| return c.Codespace() | ||
| } | ||
|
|
||
| if c, ok := err.(causer); ok { | ||
| err = c.Cause() | ||
| } else { | ||
| return internalABCICodespace | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // errIsNil returns true if value represented by the given error is nil. | ||
| // | ||
| // Most of the time a simple == check is enough. There is a very narrowed | ||
| // spectrum of cases (mostly in tests) where a more sophisticated check is | ||
| // required. | ||
| func errIsNil(err error) bool { | ||
| if err == nil { | ||
| return true | ||
| } | ||
| if val := reflect.ValueOf(err); val.Kind() == reflect.Ptr { | ||
| return val.IsNil() | ||
| } | ||
| return false | ||
| } |
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