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

feat!: return errors in module manager ABCI methods #14847

Merged
merged 11 commits into from
Jan 31, 2023

Conversation

facundomedica
Copy link
Member

@facundomedica facundomedica commented Jan 30, 2023

Description

Closes: #14836


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)

var err error
res, err = app.beginBlocker(app.deliverState.ctx, req)
if err != nil {
panic(err)

Check warning

Code scanning / CodeQL

Panic in BeginBock or EndBlock consensus methods

Possible panics in BeginBock- or EndBlock-related consensus methods could cause a chain halt
var err error
res, err = app.endBlocker(app.deliverState.ctx, req)
if err != nil {
panic(err)

Check warning

Code scanning / CodeQL

Panic in BeginBock or EndBlock consensus methods

Possible panics in BeginBock- or EndBlock-related consensus methods could cause a chain halt
@@ -656,7 +669,7 @@
// only one module will update the validator set
if len(moduleValUpdates) > 0 {
if len(validatorUpdates) > 0 {
panic("validator EndBlock updates already set by a previous module")
return abci.ResponseEndBlock{}, errors.New("validator EndBlock updates already set by a previous module")

Check warning

Code scanning / CodeQL

Panic in BeginBock or EndBlock consensus methods

Possible panics in BeginBock- or EndBlock-related consensus methods could cause a chain halt
@facundomedica facundomedica changed the title feat: return errors in module manager ABCI methods feat!: return errors in module manager ABCI methods Jan 31, 2023
@facundomedica
Copy link
Member Author

Not sure how helpful this is given that it's moving the panics to baseapp

@facundomedica facundomedica marked this pull request as ready for review January 31, 2023 13:59
@facundomedica facundomedica requested a review from a team as a code owner January 31, 2023 13:59
@github-prbot github-prbot requested review from a team, aaronc and julienrbrt and removed request for a team January 31, 2023 14:00
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.

need some changelog, but unfortunate we have to panic elsewhere here. Nothing we can do, but at least if we get the panics in one place it will be cleaner

@@ -559,12 +560,12 @@ func (app *SimApp) setPostHandler() {
func (app *SimApp) Name() string { return app.BaseApp.Name() }

// BeginBlocker application updates every begin block
func (app *SimApp) BeginBlocker(ctx sdk.Context, req abci.RequestBeginBlock) abci.ResponseBeginBlock {
func (app *SimApp) BeginBlocker(ctx sdk.Context, req abci.RequestBeginBlock) (abci.ResponseBeginBlock, error) {
Copy link
Member

Choose a reason for hiding this comment

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

need a changelog and upgrade entry for this

Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

lgtm.

tiny nit: update the code example here

func (app *myApp) BeginBlocker(ctx sdk.Context, req abci.RequestBeginBlock) abci.ResponseBeginBlock {

@facundomedica facundomedica enabled auto-merge (squash) January 31, 2023 19:02
@facundomedica facundomedica merged commit deeb4bd into main Jan 31, 2023
@facundomedica facundomedica deleted the facu/refactor-modulemanager-methods branch January 31, 2023 19:17
tsenart pushed a commit to meka-dev/cosmos-sdk that referenced this pull request Apr 12, 2023
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Manager methods should return errors instead of panicking
4 participants