* refactor: improve error messages (#11762)
## 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)
(cherry picked from commit 8f51644c0e
)
# Conflicts:
# errors/CHANGELOG.md
# errors/abci.go
* updates
* add changelog
Co-authored-by: Federico Kunze Küllmer <31522760+fedekunze@users.noreply.github.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
This commit is contained in:
parent
162fb49bd9
commit
85bf0aaeda
|
@ -42,6 +42,10 @@ Ref: https://keepachangelog.com/en/1.0.0/
|
|||
* [#11796](https://github.com/cosmos/cosmos-sdk/pull/11796) Handle EOF error case in `readLineFromBuf`, which allows successful reading of passphrases from STDIN.
|
||||
* [\#11772](https://github.com/cosmos/cosmos-sdk/pull/11772) Limit types.Dec length to avoid overflow.
|
||||
|
||||
## Improvements
|
||||
|
||||
* [\#11886](https://github.com/cosmos/cosmos-sdk/pull/11886) Improve error messages
|
||||
|
||||
## [v0.45.4](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.45.4) - 2022-04-25
|
||||
|
||||
### Bug Fixes
|
||||
|
|
|
@ -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
|
||||
|
@ -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, ".")
|
||||
|
@ -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
|
||||
|
@ -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)
|
||||
|
|
|
@ -191,7 +191,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
|
||||
|
|
|
@ -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,
|
||||
|
|
Loading…
Reference in New Issue