feat(x/consensus): Add env bundler to x/consensus module

[likhita-809]

Description

ref: #19290

Migrate x/consensus module to use environment bundler

---

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

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

• Refactor
  • Enhanced the initialization process for ConsensusParamsKeeper with improved environment handling.
  • Refined the Keeper structure and dependencies in the consensus module for better clarity and efficiency.
  • Updated the Consensus module to use appmodule.Environment instead of individual services.

[coderabbitai]

Walkthrough

Walkthrough

The changes involve a restructuring of the ConsensusParamsKeeper and Keeper structures' initialization and dependencies across various files. These updates aim to streamline the setup process by integrating runtime.NewEnvironment, removing redundant parameters, and adjusting dependencies for improved coherence. The modifications include eliminating imports for event and storetypes, replacing them with the more consolidated appmodule.Environment. The primary objective is to enhance codebase clarity and simplify the management of consensus parameters and keeper configurations.

Changes

Files	Change Summary
simapp/app.go, testutil/integration/router.go	Updated ConsensusParamsKeeper initialization to use runtime.NewEnvironment and removed runtime.EventService{} from parameters.
x/consensus/depinject.go, x/consensus/keeper/keeper.go, x/consensus/keeper/keeper_test.go	Refactored Keeper struct to include appmodule.Environment. Removed event and storetypes imports, replacing them with appmodule.Environment. Adjusted function signatures and initialization accordingly. Added a dependency on cosmossdk.io/log for logging in tests.

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-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

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

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between c058502 and a8869a3.

Files selected for processing (5)

• simapp/app.go (1 hunks)
• testutil/integration/router.go (1 hunks)
• x/consensus/depinject.go (3 hunks)
• x/consensus/keeper/keeper.go (3 hunks)
• x/consensus/keeper/keeper_test.go (2 hunks)

Additional comments: 8

x/consensus/depinject.go (2)

• 31-33: The integration of appmodule.Environment in ModuleInputs is a positive change, enhancing modularity and simplifying dependency injection. This aligns well with the PR's objectives and follows best practices for dependency management.
• 51-51: The update to keeper.NewKeeper to use appmodule.Environment is correctly implemented. This change simplifies the keeper's initialization and enhances the module's configuration flexibility. Good job adhering to the PR's objectives and improving the codebase's maintainability.

x/consensus/keeper/keeper.go (3)

• 24-24: The addition of the environment field in the Keeper struct is a significant improvement. It centralizes the management of dependencies and configurations, making the code cleaner and more maintainable.
• 32-37: The refactoring of the NewKeeper function to accept appmodule.Environment as a parameter is correctly implemented. This change is consistent with the PR's objectives and enhances the module's flexibility and maintainability by simplifying the keeper's initialization.
• 80-80: The update to use k.environment.EventService.EventManager(ctx) for emitting events is a good practice. It leverages the integrated environment bundler for event management, aligning with the PR's goal of improving modularity and dependency management.

testutil/integration/router.go (1)

• 85-85: The modification to initialize consensusParamsKeeper using runtime.NewEnvironment is correctly implemented. This change enhances the setup of the consensus parameters keeper by utilizing the environment bundler, aligning with the PR's objectives of improving modularity and dependency management.

x/consensus/keeper/keeper_test.go (1)

• 36-38: The update in the test setup to use runtime.NewEnvironment for initializing the keeper object is correctly implemented. This change ensures that the tests reflect the new environment bundler integration, maintaining consistency with the main codebase and adhering to best practices for testability.

simapp/app.go (1)

• 283-283: The change to initialize ConsensusParamsKeeper using runtime.NewEnvironment is a significant shift towards a more integrated environment handling approach within the module. This change aligns with the PR's objective to enhance the module's configuration and dependency management capabilities through the integration of an environment bundler. However, it's crucial to ensure that all downstream dependencies and modules that interact with ConsensusParamsKeeper are compatible with this new initialization pattern to prevent any runtime issues.

[tac0turtle]

missing changelog otherwise lgtm

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between a8869a3 and 0f84168.

Files selected for processing (1)

• CHANGELOG.md (1 hunks)

Additional comments: 1

CHANGELOG.md (1)

• 45-45: The entry in the CHANGELOG is clear, concise, and follows the established format of referencing PR numbers and describing changes. This ensures that users and developers can easily understand the nature of the changes made to the x/consensus module.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between 0f84168 and 1ca7e10.

Files selected for processing (1)

• CHANGELOG.md (1 hunks)

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

• CHANGELOG.md