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(appconfig)!: simplify app config #19040

Merged
merged 8 commits into from
Jan 13, 2024

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Jan 12, 2024

Description

  • Removes grpc query for app config to limit dependency in depinject (removes it from runtime)
  • Move module depinject config in depinject.go file for clarity (and for later if we need a go build tag for tiny go)
  • Move depinject/appmodule -> depinject/appconfig for avoiding name clashing between core/appmodule and depinject/appconfig
  • Investigate if we can move appv1beta1 to depinject directly (requires changes in proto building)

Notes, the deletion of protos should be reverted but it was easier to see the api break and remove it.


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

x/bank/depinject.go Dismissed Show dismissed Hide dismissed
depinject/appconfig/module.go Dismissed Show dismissed Hide dismissed
@julienrbrt julienrbrt marked this pull request as ready for review January 12, 2024 17:14
@julienrbrt julienrbrt requested a review from a team as a code owner January 12, 2024 17:14
Copy link
Contributor

coderabbitai bot commented Jan 12, 2024

Warning

Rate Limit Exceeded

@julienrbrt has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 5 minutes and 21 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 24dc4fd and 05976ac.

Walkthrough

The updates reflect a significant reorganization of the Cosmos SDK's dependency injection system, involving renaming, moving functions, and updating documentation. Key functions like Invoke, Provide, and Register have been relocated from cosmossdk.io/core to cosmossdk.io/depinject/appconfig. Modules across the codebase must now update their imports and usage patterns to align with these changes. Additionally, there's an emphasis on enhancing clarity and accuracy in documentation and error messages.

Changes

File Pattern Change Summary
UPGRADING.md, core/appmodule/README.md Updated documentation and comments, reorganized dependency injection functions, required migration steps to v0.51, and updated references to depinject appmodule.
depinject/README.md, depinject/appconfig/README.md Formatting and typo fixes, updated references from appmodule to appconfig.
depinject/appconfig/.../config_test.go Updated function calls from appmodule.Register to appconfig.RegisterModule with various test modules.
depinject/appconfig/module.go, depinject/internal/appconfig/registry.go Renamed package, added new Register variable, improved function clarity, and fixed a typo in an error message.
docs/.../adr-057-app-wiring.md, docs/build/building-modules/11-structure.md Documentation updates for module registration and dependency injection, added depinject.go to module directory structure.
orm/orm.go, runtime/..., simapp/... Updated import paths and function names for dependency injection, removed obsolete imports and functions.
x/.../depinject.go, x/.../module.go Introduced and updated functionality for dependency injection in various modules such as accounts, auth, vesting, bank, etc., including removal of unused imports, methods, and functions.
x/authz/module/..., x/.../module.go Package name changes from authz to module, and associated updates, including removal of unused imports, methods, and functions.

Note: The ellipsis (...) in the File Pattern column indicates a continuation of the file path that is contextually similar across multiple entries.

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:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your comments unless it is explicitly tagged.

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

@@ -112,13 +112,18 @@ clientCtx = clientCtx.

Refer to SimApp `root_v2.go` and `root.go` for an example with an app v2 and a legacy app.

#### Dependency Injection

<!-- explain app_config.go changes -->
Copy link
Contributor

Choose a reason for hiding this comment

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

It appears that there is a placeholder comment <!-- explain app_config.go changes --> which should be replaced with the actual explanation of changes made to app_config.go.


There is a placeholder comment that needs to be replaced with actual content explaining the changes to app_config.go. This is important for developers to understand the specific alterations and how to adjust their code.


The placeholder comment <!-- explain app_config.go changes --> indicates that a section of the documentation is missing. This should be completed to provide necessary information about the changes to app_config.go.

Comment on lines +115 to +118
#### Dependency Injection

<!-- explain app_config.go changes -->

Copy link
Contributor

Choose a reason for hiding this comment

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

The section under Dependency Injection is incomplete and requires an explanation of the changes made to app_config.go. This should be addressed to provide clarity to developers on how to adapt their applications.

Copy link
Contributor

@alexanderbez alexanderbez 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 the notion of separating out depinject logic from module.go to depinject.go. Nice!

Copy link
Member Author

Choose a reason for hiding this comment

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

Note, we probably should bring this back as deprecated for api mod.

I'd like to be able to delete it, but instead we may have to tweak the proto build to skip this file.

Do not merge. I'll finish that once I'm back

Copy link
Member Author

@julienrbrt julienrbrt Jan 13, 2024

Choose a reason for hiding this comment

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

Brought it back, but as mentioned in the PR description, removing cosmossdk.io/api from depinject doesn't work too well if we don't want to break api. I need to add some custom (hacky) logic to the proto-gen file and make some hacky things in https://github.com/cosmos/cosmos-sdk/blob/main/depinject/internal/appconfig/buf.gen.yaml.

Given that core imports grpc anyway (HasServices), I think it's not too bad to import /api (ref #19011) cc @tac0turtle

@julienrbrt julienrbrt added this pull request to the merge queue Jan 13, 2024
Merged via the queue into main with commit 7d9dc39 Jan 13, 2024
75 of 78 checks passed
@julienrbrt julienrbrt deleted the julien/depinject-runtime-appconfig branch January 13, 2024 20:44
@levisyin levisyin mentioned this pull request Jan 15, 2024
12 tasks
relyt29 pushed a commit to relyt29/cosmos-sdk that referenced this pull request Jan 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants