Skip to content

Commit

Permalink
refactor: improve error messages (cosmos#11762)
Browse files Browse the repository at this point in the history
## Description

Closes: #XXXX



---

### 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)
  • Loading branch information
fedekunze authored May 6, 2022
1 parent 9a1945c commit 8f51644
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 7 deletions.
6 changes: 6 additions & 0 deletions errors/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,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
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
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
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

0 comments on commit 8f51644

Please sign in to comment.