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

refactor(simapp): simplify simapp di #21718

Merged
merged 1 commit into from
Sep 13, 2024
Merged

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Sep 13, 2024

Description

Small proposal to simplify simapp di.
We can only keep the keeper we need in the app struct.
The rest doesn't need to be exposed.


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

    • Streamlined application architecture by reducing the number of keeper dependencies, enhancing performance and maintainability.
  • Refactor

    • Removed several keeper declarations to simplify the application structure and reduce complexity.

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Sep 13, 2024
Copy link
Contributor

coderabbitai bot commented Sep 13, 2024

Walkthrough

Walkthrough

The changes involve significant modifications to the simapp/app_di.go and simapp/v2/app_di.go files, primarily focusing on the removal of multiple keeper declarations and their references within the NewSimApp function. This refactoring reduces the number of dependencies in the application structure, streamlining the overall architecture while retaining essential keepers for core functionality.

Changes

Files Change Summary
simapp/app_di.go Removed multiple keeper declarations, including authzkeeper, bankv2keeper, epochskeeper, etc., and their references in NewSimApp.
simapp/v2/app_di.go Reduced keeper dependencies in SimApp struct by removing several keeper types, updating NewSimApp accordingly.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SimApp
    participant Keeper

    User->>SimApp: Initialize Application
    SimApp->>Keeper: Setup Required Keepers
    Keeper-->>SimApp: Return Initialized Keepers
    SimApp-->>User: Application Ready
Loading

Tip

OpenAI O1 model for chat
  • We have deployed OpenAI's latest O1 model for chat.
  • OpenAI claims that this model has superior reasoning capabilities than their GPT-4o model.
  • Please share any feedback with us in the discussions post.

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7d6ff0d and 1f38669.

Files selected for processing (2)
  • simapp/app_di.go (1 hunks)
  • simapp/v2/app_di.go (1 hunks)
Additional context used
Path-based instructions (2)
simapp/v2/app_di.go (1)

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

simapp/app_di.go (1)

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

Additional comments not posted (3)
simapp/v2/app_di.go (1)

39-40: Refactoring aligns with the objective of simplifying dependency injection.

The comment accurately reflects the refactoring changes made to the SimApp struct. Removing unnecessary keeper fields and retaining only the required ones helps streamline the app architecture and reduce complexity. This change should improve maintainability and make the code easier to reason about.

simapp/app_di.go (2)

65-76: LGTM!

The refactoring of the SimApp struct by removing several keeper declarations helps simplify the dependency management while retaining the essential keepers for core functionality. The code segment adheres to the Uber Golang style guide.


65-76: This code segment has already been reviewed in the previous comment.


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

Copy link
Member

@kocubinski kocubinski left a comment

Choose a reason for hiding this comment

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

I like it, makes sense to keep one keeper like you have done as an example of how to retrieve others.

@julienrbrt julienrbrt added this pull request to the merge queue Sep 13, 2024
@julienrbrt julienrbrt removed this pull request from the merge queue due to a manual request Sep 13, 2024
@julienrbrt julienrbrt changed the title [proposal] refactor(simapp): simplify simapp di refactor(simapp): simplify simapp di Sep 13, 2024
@julienrbrt julienrbrt added this pull request to the merge queue Sep 13, 2024
Merged via the queue into main with commit 7ee7c20 Sep 13, 2024
73 of 75 checks passed
@julienrbrt julienrbrt deleted the julien/simplify-simapp branch September 13, 2024 18:38
mergify bot pushed a commit that referenced this pull request Sep 13, 2024
(cherry picked from commit 7ee7c20)

# Conflicts:
#	simapp/v2/app_di.go
julienrbrt added a commit that referenced this pull request Sep 13, 2024
Co-authored-by: Julien Robert <julien@rbrt.fr>
alpe added a commit that referenced this pull request Sep 16, 2024
* main:
  test: fix sims (#21735)
  build: bump proto-builder (#21730)
  refactor(schema)!: rename IntegerStringKind and DecimalStringKind (#21694)
  feat(types/collections): add `LegacyDec` collection value (#21693)
  refactor(server): alias AppOptions to coreserver.DynamicConfig (#21711)
  refactor(simapp): simplify simapp di (#21718)
  feat: replace the cosmos-db usecases in the tests with `core/testing` (#21525)
  feat(runtime/v2): store loader on simappv2 (#21704)
  docs(x/auth): vesting (#21715)
  build(deps): Bump google.golang.org/grpc from 1.66.1 to 1.66.2 (#21670)
  refactor(systemtest): Add cli.RunAndWait for common operations (#21689)
  fix(runtime/v2): provide default factory options if unset in app builder (#21690)
  chore: remove duplicate proto files for the same proto file (#21648)
  feat(x/genutil): add better error messages for genesis validation (#21701)
  build(deps): Bump cosmossdk.io/core from 1.0.0-alpha.1 to 1.0.0-alpha.2 (#21698)
  test: migrate e2e/bank to system tests (#21607)
  chore: fix the gci lint issue in testutil (#21695)
  docs(x/authz): update grant docs (#21677)
@coderabbitai coderabbitai bot mentioned this pull request Sep 16, 2024
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants