Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

refactor: improve error messages (backport #11762) #11886

Merged
merged 1 commit into from
May 6, 2022
Merged

refactor: improve error messages (backport #11762) #11886

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions errors/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,12 @@ Ref: https://keepachangelog.com/en/1.0.0/

# Changelog

## [Unreleased]

### Improvements

* [\#11762](https://github.com/cosmos/cosmos-sdk/pull/11762) Improve error messages

## v1.0.0

### Features
Expand Down
2 changes: 1 addition & 1 deletion errors/abci.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ func errIsNil(err error) bool {
return false
}

var errPanicWithMsg = Wrapf(ErrPanic, "panic message redacted to hide potentially sensitive system info")
var errPanicWithMsg = Wrapf(ErrPanic, "error message redacted to hide potential sensitive info. Use the '--trace' flag if you are running a node to see the full stack trace error")

// Redact replaces an error that is not initialized as an ABCI Error with a
// generic internal error instance. If the error is an ABCI Error, that error is
Expand Down
2 changes: 1 addition & 1 deletion errors/abci_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ func (s *abciTestSuite) TestABCIInfoSerializeErr() {
},
"redact in default encoder": {
src: myPanic,
exp: "panic message redacted to hide potentially sensitive system info: panic",
exp: "error message redacted to hide potential sensitive info. Use the '--trace' flag if you are running a node to see the full stack trace error: panic",
},
"do not redact in debug encoder": {
src: myPanic,
Expand Down
10 changes: 5 additions & 5 deletions types/decimal.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ func NewDecFromIntWithPrec(i Int, prec int64) Dec {
// CONTRACT - This function does not mutate the input str.
func NewDecFromStr(str string) (Dec, error) {
if len(str) == 0 {
return Dec{}, ErrEmptyDecimalStr
return Dec{}, fmt.Errorf("%s: %w", str, ErrEmptyDecimalStr)
}

// first extract any negative symbol
Expand All @@ -154,7 +154,7 @@ func NewDecFromStr(str string) (Dec, error) {
}

if len(str) == 0 {
return Dec{}, ErrEmptyDecimalStr
return Dec{}, fmt.Errorf("%s: %w", str, ErrEmptyDecimalStr)
}

strs := strings.Split(str, ".")
Expand All @@ -172,7 +172,7 @@ func NewDecFromStr(str string) (Dec, error) {
}

if lenDecs > Precision {
return Dec{}, fmt.Errorf("invalid precision; max: %d, got: %d", Precision, lenDecs)
return Dec{}, fmt.Errorf("value '%s' exceeds max precision by %d decimal places: max precision %d", str, Precision-lenDecs, Precision)
}

// add some extra zero's to correct to the Precision factor
Expand All @@ -182,10 +182,10 @@ func NewDecFromStr(str string) (Dec, error) {

combined, ok := new(big.Int).SetString(combinedStr, 10) // base 10
if !ok {
return Dec{}, fmt.Errorf("failed to set decimal string: %s", combinedStr)
return Dec{}, fmt.Errorf("failed to set decimal string with base 10: %s", combinedStr)
}
if combined.BitLen() > maxDecBitLen {
return Dec{}, fmt.Errorf("decimal out of range; bitLen: got %d, max %d", combined.BitLen(), maxDecBitLen)
return Dec{}, fmt.Errorf("decimal '%s' out of range; bitLen: got %d, max %d", str, combined.BitLen(), maxDecBitLen)
}
if neg {
combined = new(big.Int).Neg(combined)
Expand Down