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: nil pointer panic in FinalizeBlock #23882

Closed
wants to merge 3 commits into from

Conversation

yihuang
Copy link
Collaborator

@yihuang yihuang commented Mar 4, 2025

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 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
    • Introduced a streamlined block finalization process that consolidates state updates.
    • Added execution mode tracking along with a new hook to enhance vote extension persistence.
  • Bug Fixes
    • Improved error handling during block finalization to prevent potential runtime issues.

@yihuang yihuang requested a review from a team as a code owner March 4, 2025 05:53
Copy link
Contributor

coderabbitai bot commented Mar 4, 2025

Warning

Rate limit exceeded

@yihuang has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 17 minutes and 13 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 4d47461 and 2540947.

📒 Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • baseapp/abci.go (1 hunks)
📝 Walkthrough

Walkthrough

The pull request introduces a new FinalizeBlock method in BaseApp that consolidates the logic for writing state changes to the multistore. The separate BeginBlock and EndBlock methods have been removed, with their functionality integrated into FinalizeBlock. Additionally, a new ExecMode enum (with ModeDeliver, ModeFinalize, and ModeVoteExtension values) has been introduced to track the execution mode, and a preFinalizeBlockHook has been added for vote extensions persistence. The changes also include enhanced error handling in FinalizeBlock to prevent nil pointer dereferencing.

Changes

File(s) Change Summary
CHANGELOG.md, BaseApp - Added new FinalizeBlock method to write state changes to the multistore.
- Removed separate BeginBlock and EndBlock logic (now consolidated in FinalizeBlock).
- Introduced new ExecMode enum with values: ModeDeliver, ModeFinalize, and ModeVoteExtension.
- Moved state writing from Commit to FinalizeBlock.
- Added preFinalizeBlockHook for vote extension persistence.
- Updated method signatures for BeginBlock and EndBlock to use pointer types.
baseapp/abci.go - Added additional error handling in the FinalizeBlock method with a deferred function that checks if the response (res) is nil after calling internalFinalizeBlock, preventing potential runtime panics from nil pointer dereferencing.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant BaseApp
    participant Internal as internalFinalizeBlock
    participant Hook as preFinalizeBlockHook
    participant Store as MultiStore

    Client->>BaseApp: FinalizeBlock(req)
    BaseApp->>Internal: internalFinalizeBlock(req)
    Internal-->>BaseApp: res
    BaseApp->>BaseApp: Deferred check (if res is nil)
    alt res is not nil
      BaseApp->>Hook: Invoke preFinalizeBlockHook
      BaseApp->>Store: Write state changes to multistore
    else res is nil
      BaseApp-->>Client: Return early (error handled)
    end
    BaseApp-->>Client: Return response
Loading

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 generate docstrings to generate docstrings for this 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.

baseapp/abci.go Outdated
Comment on lines 903 to 909
// where they adhere to the sdk.Tx interface.
func (app *BaseApp) FinalizeBlock(req *abci.FinalizeBlockRequest) (res *abci.FinalizeBlockResponse, err error) {
defer func() {
if res == nil {
return
}

Copy link
Contributor

Choose a reason for hiding this comment

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

Change potentially affects state.

Call sequence:

(*github.com/cosmos/cosmos-sdk/baseapp.BaseApp).FinalizeBlock (baseapp/abci.go:904)

Comment on lines 903 to +909
// where they adhere to the sdk.Tx interface.
func (app *BaseApp) FinalizeBlock(req *abci.FinalizeBlockRequest) (res *abci.FinalizeBlockResponse, err error) {
defer func() {
// res could be nil if internal finalize block return error.
if res == nil {
return
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Change potentially affects state.

Call sequence:

(*github.com/cosmos/cosmos-sdk/baseapp.BaseApp).FinalizeBlock (baseapp/abci.go:904)

@yihuang
Copy link
Collaborator Author

yihuang commented Mar 4, 2025

duplicated: #23879

@yihuang yihuang closed this Mar 4, 2025
@yihuang yihuang deleted the fix-nil-pointer branch March 4, 2025 09:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant