fix(baseapp): return events from preblocker in FinalizeBlockResponse

[facundomedica]

Description

The events emitted during preblocker were being discarded, now we prepend them to the events returned in FinalizeBlockResponse.

---

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 event handling during block finalization by capturing events from the EventManager.
  • Added event emission in the pre-blocker function for improved event tracking.

• Bug Fixes

  • Updated the changelog to document that PreBlocker events are now included in the FinalizeBlockResponse for better visibility.
  • Improved tests to ensure correct event emission and validation in the pre-blocker functionality.

[coderabbitai]

Walkthrough

Walkthrough

The changes enhance the event handling mechanism within the BaseApp class by integrating event emissions during the block finalization process and updating associated tests. Specifically, events from the EventManager are now captured in the internalFinalizeBlock method, and the pre-blocker function has been modified to emit a specific event. This ensures better tracking and verification of event emissions, improving overall functionality and testing accuracy.

Changes

Files	Change Summary
baseapp/abci.go	Added logic to internalFinalizeBlock to append events from EventManager to the events slice.
baseapp/abci_test.go	Updated TestBaseApp_PreBlocker to emit a "preblockertest" event and modified assertions to validate this.
CHANGELOG.md	Added entry for bug fix regarding FinalizeBlockResponse returning PreBlocker events for better visibility.

Sequence Diagram(s)

sequenceDiagram
    participant BaseApp
    participant EventManager
    participant PreBlocker

    BaseApp->>PreBlocker: Call pre-blocker
    PreBlocker-->>BaseApp: Emit "preblockertest" event
    BaseApp->>EventManager: Append events from EventManager
    EventManager-->>BaseApp: Return events
    BaseApp->>BaseApp: Finalize block with events

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

• 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.

[github-actions]

Change potentially affects state.

Call sequence:

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

[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 bc72e34 and c6963cd.

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 (4)

baseapp/abci.go (1)

792-792: LGTM! But verify the function usage in the codebase.

The code changes are approved.

However, ensure that the inclusion of EventManager events does not introduce any unintended side effects in the event handling mechanism.

baseapp/abci_test.go (3)

2301-2303: Confirm Event Emission in PreBlocker Function

The event emission within the pre-blocker function is correctly implemented. This ensures that the event "preblockertest" with an attribute indicating the block height is emitted.

---

2306-2310: Confirm Test Assertions for Emitted Event

The test assertions correctly validate the presence of the emitted event and confirm its type as "preblockertest". This ensures the pre-blocker function's event emission is properly tested.

---

Line range hint 2312-2314:
Confirm Error Handling in PreBlocker Function

The error handling within the pre-blocker function is correctly implemented and tested. This ensures that the function handles errors as expected and the test verifies this behavior.

[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 c6963cd and ae80919.

Files selected for processing (1)

• CHANGELOG.md (1 hunks)

Files skipped from review due to trivial changes (1)

• CHANGELOG.md

[julienrbrt]

🙏🏾