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

fix: keep behavior from v0.47 in PrepareProposal panic recovery #17930

Merged
merged 4 commits into from
Oct 10, 2023

Conversation

facundomedica
Copy link
Member

Description

In v0.47.x when recovering from a panic during PrepareProposal we return a proposal that includes all the transactions that it got from RequestPrepareProposal. This was later modified (without a clear reason afaik, maybe just by mistake).


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
  • run make lint and make test
  • 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)

@facundomedica facundomedica requested a review from a team as a code owner September 29, 2023 14:28
@github-actions
Copy link
Contributor

@facundomedica your pull request is missing a changelog!

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.

@julienrbrt julienrbrt added the backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release label Sep 29, 2023
Copy link
Collaborator

@odeke-em odeke-em left a comment

Choose a reason for hiding this comment

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

Thanks @facundomedica! To lock in this behavior and ensure that it doesn't regress, let's add a regression test in which prepareProposal intentionally panics and then the regression test should confirm that the response has the set Txs as well as the error and the desired panic message. If we had that test in the first place, this would have been tightly flagged.

@facundomedica
Copy link
Member Author

@odeke-em added a test, please check now

Copy link
Collaborator

@odeke-em odeke-em left a comment

Choose a reason for hiding this comment

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

LGTM, thank you @facundomedica. I realize we can't check directly against the message but the regression test suffices to capture that even on intentional panics, we send back the Txs

@facundomedica facundomedica added this pull request to the merge queue Oct 10, 2023
Merged via the queue into main with commit 223e179 Oct 10, 2023
47 of 49 checks passed
@facundomedica facundomedica deleted the facu/fix-prepprop-panic branch October 10, 2023 11:05
mergify bot pushed a commit that referenced this pull request Oct 10, 2023
(cherry picked from commit 223e179)

# Conflicts:
#	baseapp/abci_test.go
julienrbrt added a commit that referenced this pull request Oct 10, 2023
…port #17930) (#18038)

Co-authored-by: Facundo Medica <14063057+facundomedica@users.noreply.github.com>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
@faddat faddat mentioned this pull request Nov 8, 2024
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants