fix(baseapp)!: Halt at height now does not produce the halt height block

[facundomedica]

Description

In the issue linked, it is described how the behavior changed from previous versions to v0.50.x, in which we now produce the halt height block and then halt. This PR reverts this change to avoid producing the halt height block, meaning that if the halt-height is 100, the block 99 will be committed while block 100 not.

Closes: #21226

---

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 halting conditions for the application to include equality checks for block height and timestamp.
  • Clarified behavior of the halt height feature to prevent commitment of blocks at the halt height.

• Bug Fixes

  • Updated test cases to ensure accurate evaluation of new halting conditions, improving the reliability of the application’s lifecycle management.

• Documentation

  • Improved clarity on the halt height feature and overall system behavior in the CHANGELOG.

[coderabbitai]

Walkthrough

Walkthrough

The changes enhance the FinalizeBlock function in the BaseApp class by modifying the halt conditions from a strict greater-than to a greater-than-or-equal-to comparison for both height and time. This adjustment allows the application to stop precisely at specified limits. Test cases in abci_test.go were also updated to validate the new logic and scenarios surrounding halting conditions. Additionally, the CHANGELOG.md now clarifies the behavior of the halt height feature.

Changes

Files	Change Summary
baseapp/abci.go, baseapp/abci_test.go	Updated halt conditions in FinalizeBlock to use greater-than-or-equal-to comparisons and modified test cases to reflect these changes.
CHANGELOG.md	Enhanced documentation regarding the halt height feature, clarifying that blocks at the halt height will not be committed.

Assessment against linked issues

Objective	Addressed	Explanation
Halt behavior at specified height and time (#[21226])	✅
Correct handling of halt-height in v0.50 (#[21226])	✅
Resolve off-by-one error in halt conditions (#[21226])	✅

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

[facundomedica]

Tagging @julienrbrt and @tac0turtle as this is a change in behavior that is breaking. Is it ok to backport?

[coderabbitai]

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)

baseapp/abci_test.go (1)

2260-2264: LGTM! Consider improving test case names for clarity.

The changes in the test cases accurately reflect the updated halting behavior. However, consider using more descriptive names for the test cases to improve readability and understanding of the specific scenarios being tested.

- {"halt-height-edge", 11, 0, 10, 0, false},
- {"halt-height-equal", 10, 0, 10, 0, true},
- {"halt-height", 10, 0, 10, 0, true},
- {"halt-time-edge", 0, 11, 1, 10, false},
- {"halt-time-equal", 0, 10, 1, 10, true},
+ {"halt-before-height", 11, 0, 10, 0, false},
+ {"halt-at-height", 10, 0, 10, 0, true},
+ {"halt-at-height-same", 10, 0, 10, 0, true},
+ {"halt-before-time", 0, 11, 1, 10, false},
+ {"halt-at-time", 0, 10, 1, 10, true},

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 367d94a and 934905b.

Files selected for processing (2)

• baseapp/abci.go (1 hunks)
• baseapp/abci_test.go (1 hunks)

Additional context used

Path-based instructions (2)

baseapp/abci.go (1)

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

baseapp/abci_test.go (2)

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

---

Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

Additional comments not posted (1)

baseapp/abci.go (1)

917-920: LGTM! Ensure conformity with the Uber Golang style guide.

The changes in the checkHalt function correctly switch the comparison logic from > to >=, aligning with the PR objectives to halt at the specified height. Ensure that the code follows the Uber Golang style guide, particularly regarding line length and indentation.

[julienrbrt]

Tagging @julienrbrt and @tac0turtle as this is a change in behavior that is breaking. Is it ok to backport?

According to OP, this confuse validators, and would be even more confusing if only v0.50 had this behavior (as we would revert on v0.52).
I think this is fine to backport, recovery is pretty easy anyway.
We should add descriptive changelog however.

[coderabbitai]

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)

CHANGELOG.md (1)

69-69: Clarify halt height behavior description.

The description is mostly clear, but it could be slightly rephrased for better readability. Consider specifying that "block 9 will be the last committed block."

- Halt height will not commit the block indicated, meaning that if halt-height is set to 10, only blocks until 9 (included) will be committed.
+ Halt height will not commit the block indicated; if halt-height is set to 10, only blocks up to and including block 9 will be committed.

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 934905b and c17e3ab.

Files selected for processing (1)

• CHANGELOG.md (1 hunks)

Additional context used

Path-based instructions (1)

CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

[julienrbrt]

Can we say this was the behavior in previous sdk versions, and is kept identical for better UX?

[tac0turtle]

which pr changed it?

[facundomedica]

It was changed here #16639 @tac0turtle

[julienrbrt]

ACK, still would like an even more extensive changelog (as it is still a behavior change)

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c17e3ab and 7479e6a.

Files selected for processing (1)

• CHANGELOG.md (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• CHANGELOG.md