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.

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

refactor: simply errors #15067

Merged
merged 4 commits into from
Feb 20, 2023
Merged

refactor: simply errors #15067

merged 4 commits into from
Feb 20, 2023

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Feb 19, 2023

Description

As Facu rightfully pointed, the SDK uses 5 packages for errors:

  • errors (stdlib)
  • cosmossdk.io/errors
  • github.com/cosmos/cosmos-sdk/types/errors
  • github.com/pkg/errors
  • github.com/cockroachdb/errors

This PR attempts to simplify this by:


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 in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • 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 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)

@julienrbrt julienrbrt requested a review from a team as a code owner February 19, 2023 21:35
@github-actions github-actions bot added C:CLI C:Hubl Tool: Hubl C:x/genutil genutil module issues labels Feb 19, 2023
@@ -67,12 +67,12 @@ func (s *errorsTestSuite) TestErrorIs() {
},
"successful comparison to a wrapped error": {
a: ErrUnauthorized,
b: errorsmod.Wrap(ErrUnauthorized, "gone"),
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was broken, as there were no import for errorsmod.
Checking if CI checks the errors package properly.

@github-actions github-actions bot added Type: CI C:Confix Issues and PR related to Confix C:Cosmovisor Issues and PR related to Cosmovisor C:Rosetta Issues and PR related to Rosetta C:Store C:x/circuit C:x/evidence C:x/feegrant C:x/nft C:x/upgrade labels Feb 19, 2023
Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

left one comment, its a bit hidden how errors and pkg/errors .new work. Its quite annoying. If we are fine with not having stack traces on every error this is chill

client/cmd.go Outdated Show resolved Hide resolved
@julienrbrt julienrbrt enabled auto-merge (squash) February 20, 2023 10:51
@julienrbrt julienrbrt merged commit 067ee92 into main Feb 20, 2023
@julienrbrt julienrbrt deleted the julien/errors branch February 20, 2023 12:03
@alexanderbez
Copy link
Contributor

Thanks @julienrbrt 🙏

larry0x pushed a commit to larry0x/cosmos-sdk that referenced this pull request May 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:CLI C:Confix Issues and PR related to Confix C:Cosmovisor Issues and PR related to Cosmovisor C:Hubl Tool: Hubl C:Rosetta Issues and PR related to Rosetta C:Store C:x/circuit C:x/evidence C:x/feegrant C:x/genutil genutil module issues C:x/nft C:x/upgrade Type: CI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants