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!: kill basic manager #19512

Merged
merged 11 commits into from
Feb 22, 2024
Merged

refactor!: kill basic manager #19512

merged 11 commits into from
Feb 22, 2024

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Feb 21, 2024

Description

Closes: #17927

Thanks to dependency injection, the need of the AppModuleBasic and the basic manager is not required anymore.
Additionally, for apps not using depinject, the basic manager was still redundant since we've allowed to create a basic manager from a module manager in previous version.

This PR simplifies the Cosmos SDK by totally removing the basic manager

  • Developers using depinject will only need to remove one line from the app.go
  • Developers not using depinject can remove the basic manager from their app, and call the basic manager instead and update x/genutil wiring

Additionally, this deprecates (but not remove) the AppModuleBasic interface, and adds extension interfaces in types/module. The module manager now takes the role for the Basic Manager and implements all the necessary methods.

Furthermore, this PR removes all AppModuleBasic from all core SDK modules and put those methods directly on AppModule and implement only the relevant extension interfaces.
It updates the documentation to scrap all mention of app module basic and basic manager.
However, app dev can leave their module as-is if they wish to.


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

Copy link
Contributor

coderabbitai bot commented Feb 21, 2024

Important

Auto Review Skipped

More than 25% of the files skipped due to max files limit. Skipping review to prevent low quality review.

63 files out of 170 files are above the max files limit of 100.

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

@@ -110,17 +105,7 @@ func init() {
// AppConfig returns the default app config.
func AppConfig() depinject.Config {
return depinject.Configs(
// appconfig.LoadYAML(AppConfigYAML),
appConfig,
depinject.Supply(
Copy link
Member Author

@julienrbrt julienrbrt Feb 21, 2024

Choose a reason for hiding this comment

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

Now that we include that in app module directly, this is much better. The good defaults are set by depinject but can still be overwritten by optional input in to be provided, without needing to supply a whole app module basic map.

types/module/module.go Dismissed Show dismissed Hide dismissed
Comment on lines +317 to +321
for _, b := range m.Modules {
if mod, ok := b.(HasRegisterInterfaces); ok {
mod.RegisterInterfaces(registry)
}
}

Check warning

Code scanning / CodeQL

Iteration over map Warning

Iteration over map may be a possible source of non-determinism
Comment on lines +327 to +333
for _, b := range m.Modules {
if mod, ok := b.(HasGenesisBasics); ok {
genesisData[mod.Name()] = mod.DefaultGenesis(cdc)
} else if mod, ok := b.(HasName); ok {
genesisData[mod.Name()] = []byte("{}")
}
}

Check warning

Code scanning / CodeQL

Iteration over map Warning

Iteration over map may be a possible source of non-determinism
Comment on lines +340 to +347
for _, b := range m.Modules {
// first check if the module is an adapted Core API Module
if mod, ok := b.(HasGenesisBasics); ok {
if err := mod.ValidateGenesis(cdc, txEncCfg, genesisData[mod.Name()]); err != nil {
return err
}
}
}

Check warning

Code scanning / CodeQL

Iteration over map Warning

Iteration over map may be a possible source of non-determinism
types/module/module.go Dismissed Show dismissed Hide dismissed
types/module/module.go Fixed Show fixed Hide fixed
types/module/module.go Dismissed Show dismissed Hide dismissed
@julienrbrt julienrbrt marked this pull request as ready for review February 21, 2024 12:16
@julienrbrt julienrbrt requested a review from a team as a code owner February 21, 2024 12:16
@julienrbrt
Copy link
Member Author

TODO: update changelog + upgrading.md

@julienrbrt julienrbrt changed the title refactor: kill basic manager refactor!: kill basic manager Feb 21, 2024
Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

utack other than the missing changelog and upgrading

@julienrbrt julienrbrt mentioned this pull request Feb 22, 2024
16 tasks
@julienrbrt julienrbrt added this pull request to the merge queue Feb 22, 2024
Merged via the queue into main with commit b304cf7 Feb 22, 2024
74 of 77 checks passed
@julienrbrt julienrbrt deleted the julien/kill-bm branch February 22, 2024 14:46
@julienrbrt julienrbrt mentioned this pull request Feb 22, 2024
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment