fix(baseapp): preblock events are not emmitted correctly

[facundomedica]

Description

Follow up to #21159

---

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

• Enhancements
  • Improved event management during the pre-block phase, allowing for more effective handling of events in the blockchain application.
• Modifications
  • Adjusted context handling in the PreBlock method, which may influence event management during pre-block operations across modules.

[coderabbitai]

Walkthrough

Walkthrough

The recent changes involve modifications to the preBlock function in the BaseApp class and the PreBlock method within the Manager struct. The BaseApp now incorporates an event manager into its context for enhanced event handling during block finalization, while the PreBlock method has removed the initialization of a new event manager, altering the context management for pre-block operations.

Changes

Files	Change Summary
baseapp/baseapp.go	Updated the preBlock function to include an event manager in the context via WithEventManager(sdk.NewEventManager()), enhancing event management during block finalization.
types/module/module.go	Removed initialization of a new event manager from the context in the PreBlock method, affecting event management during pre-block operations across modules.

Sequence Diagram(s)

sequenceDiagram
    participant BaseApp
    participant EventManager
    participant Manager

    BaseApp->>EventManager: Initialize with sdk.NewEventManager()
    BaseApp->>Manager: Call preBlock
    Manager->>BaseApp: Execute pre-block logic
    BaseApp->>EventManager: Handle events during pre-block

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.

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]

@facundomedica your pull request is missing a changelog!

[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 355f4d7 and 4cac114.

Files selected for processing (2)

• baseapp/baseapp.go (1 hunks)
• types/module/module.go (1 hunks)

Additional context used

Path-based instructions (2)

types/module/module.go (1)

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

baseapp/baseapp.go (1)

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

Additional comments not posted (2)

types/module/module.go (1)

Line range hint 713-722: Verify context's event manager.

The PreBlock function no longer initializes a new event manager. Ensure that the context already has an event manager or that this change is intentional and does not break event handling.

Run the following script to verify the context's event manager initialization:

Verification successful

---

Context's Event Manager Initialization Verified

The context is being initialized with an event manager in other parts of the codebase, ensuring that the PreBlock function operates with a context that already has an event manager. The removal of event manager initialization in PreBlock is intentional and should not disrupt event handling.

• Verified in types/module/module.go and baseapp/msg_service_router.go.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the context already has an event manager.

# Test: Search for the context initialization. Expect: Context should have an event manager.
rg --type go -A 5 $'ctx.WithEventManager'

Length of output: 1295

baseapp/baseapp.go (1)

Line range hint 714-722: LGTM!

The function now includes an event manager in the context, which likely improves event handling during block finalization.

The code changes are approved.

[julienrbrt]

ACK.

[julienrbrt]

Let's create a changelog in the v0.50 backport.