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(baseapp): set req.Time for ctx header info in ExtendVote #22745

Merged
merged 1 commit into from
Dec 4, 2024

Conversation

damiannolan
Copy link
Contributor

@damiannolan damiannolan commented Dec 4, 2024

Description

Follow up from previous PR #22732.
See comment #22732 (comment)


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, you can find examples of the prefixes below:
  • confirmed ! in 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
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • 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.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • New Features

    • Enhanced error handling and context management for voting processes.
    • Added timestamp information to vote extension methods for improved accuracy.
  • Bug Fixes

    • Improved validation for query handling against invalid height inputs.

These changes aim to enhance the reliability and integrity of the application's state management and voting mechanisms.

Copy link
Contributor

coderabbitai bot commented Dec 4, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request focus on enhancing error handling and control flow within the baseapp/abci.go file. Key modifications include the addition of a Time field in the WithHeaderInfo context for the ExtendVote and VerifyVoteExtension methods, ensuring accurate timestamp information is captured. The CreateQueryContextWithCheckHeader method has been updated to improve error handling for negative heights. Additionally, deferred recovery handlers have been introduced to catch panics in the vote extension methods, thereby improving the application's resilience and reliability.

Changes

File Change Summary
baseapp/abci.go - Updated ExtendVote method to include Time field in WithHeaderInfo.
- Updated VerifyVoteExtension method to include Time field in WithHeaderInfo.
- Enhanced error handling for negative heights in CreateQueryContextWithCheckHeader method.
- Added deferred recovery handlers in ExtendVote and VerifyVoteExtension methods.

Possibly related PRs

Suggested labels

backport/v0.52.x

Suggested reviewers

  • aaronc
  • kocubinski
  • facundomedica
  • testinginprod
  • julienrbrt
  • tac0turtle

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

github-actions bot commented Dec 4, 2024

@damiannolan your pull request is missing a changelog!

@damiannolan damiannolan added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Dec 4, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
baseapp/abci.go (1)

644-644: Consider adding Time to VerifyVoteExtension header info

For consistency, consider also adding the Time field to the header info in the VerifyVoteExtension method, similar to how it's done here in ExtendVote.

 func (app *BaseApp) VerifyVoteExtension(req *abci.VerifyVoteExtensionRequest) (resp *abci.VerifyVoteExtensionResponse, err error) {
   // ...
   ctx = ctx.
     WithConsensusParams(cp).
     WithBlockGasMeter(storetypes.NewInfiniteGasMeter()).
     WithBlockHeight(req.Height).
     WithHeaderHash(req.Hash).
     WithExecMode(sdk.ExecModeVerifyVoteExtension).
     WithHeaderInfo(coreheader.Info{
       ChainID: app.chainID,
       Height:  req.Height,
       Hash:    req.Hash,
+      Time:    req.Time,
     })
   // ...
 }
📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 99dd55b and 22abe7d.

📒 Files selected for processing (1)
  • baseapp/abci.go (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
baseapp/abci.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

🔇 Additional comments (1)
baseapp/abci.go (1)

644-644: LGTM: Time field correctly added to header info

The addition of req.Time to the header info in ExtendVote is consistent with other ABCI methods and ensures accurate timestamp information is available in the vote extension context.

@tac0turtle tac0turtle added this pull request to the merge queue Dec 4, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Dec 4, 2024
@julienrbrt julienrbrt added this pull request to the merge queue Dec 4, 2024
Merged via the queue into main with commit 330954e Dec 4, 2024
81 of 82 checks passed
@julienrbrt julienrbrt deleted the damian/fix-ctx-blocktime-for-extend-vote branch December 4, 2024 10:12
mergify bot pushed a commit that referenced this pull request Dec 4, 2024
julienrbrt pushed a commit that referenced this pull request Dec 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants