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(server/v2): eager config loading (backport #22267) #22391

Merged
merged 3 commits into from
Oct 29, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Oct 29, 2024

Description

Fixes: #22268

This PR refactors config parsing for server/v2. A long standing point of confusion since the adoption of depinject has been a pattern where dependency injection happens twice during application start up. After some analysis this seemed to only be necessary due to late binding of config, somewhat of an outgrowth of cobras command architecture.

Config parsing has been pulled up as early possible into NewRootCmd. To facilitate this initRootCmd is called twice; once to initialize the CLI skeleton so that flags may be parsed (then combined with viper app.toml parsing), and then a second time immediately after DI occurs. The first invocation requires no DI outputs, the second does. A fully realized configuration blob is available immediately after the first initRootCmd invocation, and is then supplied to DI and ServerComponent constructors.

Another new feature of this design is introspection on the subcommand (e.g. start, export genesis) in order to determine if a client command (i.e. no SimApp needed) or a server command has been invoked. These two cases use different composition roots for injection. As a consequence of this the function closures (which provided late bound config) for newApp appExport are no longer needed; the server can be passed directly to the command handler.

I believe this paves the way for a minimal root command helper so that even more boilerplate may be kept out of simapp/v2 and pushed down into server/v2, which would be a good follow up issue. The code seems much easier to follow now too since there is much less indirection and circular references which were previously resolved by late bound function closures.


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

    • Introduced a structured approach for managing module configurations dynamically, enhancing modularity.
    • Added a new CommandFactory to streamline command creation and configuration handling.
  • Bug Fixes

    • Improved error handling during server initialization and configuration processes.
  • Refactor

    • Updated various command and server initialization methods for better clarity and maintainability.
    • Simplified the logging configuration process by changing the parameter type to server.ConfigMap.
  • Documentation

    • Enhanced comments and clarity in configuration-related functions.
  • Chores

    • Updated code ownership in the .github/CODEOWNERS file.

This is an automatic backport of pull request #22267 done by [Mergify](https://mergify.com).

(cherry picked from commit 31f97e9)

# Conflicts:
#	.github/CODEOWNERS
#	runtime/v2/app.go
#	runtime/v2/builder.go
#	runtime/v2/module.go
#	server/v2/api/grpc/server.go
#	server/v2/api/grpcgateway/server.go
#	server/v2/api/rest/server.go
#	server/v2/api/rest/server_test.go
#	server/v2/api/telemetry/server.go
#	server/v2/commands.go
#	server/v2/logger.go
#	server/v2/server.go
#	server/v2/server_mock_test.go
#	server/v2/server_test.go
#	server/v2/store/server.go
#	server/v2/store/snapshot.go
#	server/v2/util.go
#	simapp/v2/simdv2/cmd/commands.go
Copy link
Contributor Author

mergify bot commented Oct 29, 2024

Cherry-pick of 31f97e9 has failed:

On branch mergify/bp/release/v0.52.x/pr-22267
Your branch is up to date with 'origin/release/v0.52.x'.

You are currently cherry-picking commit 31f97e934.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	new file:   runtime/config.go
	modified:   runtime/module.go
	new file:   runtime/v2/config.go
	modified:   server/v2/cometbft/server.go
	new file:   server/v2/command_factory.go
	modified:   simapp/app_di.go
	modified:   simapp/v2/app_config.go
	modified:   simapp/v2/app_di.go
	modified:   simapp/v2/app_test.go
	new file:   simapp/v2/simdv2/cmd/depinject.go
	modified:   simapp/v2/simdv2/cmd/root_di.go
	modified:   simapp/v2/simdv2/cmd/root_test.go
	modified:   simapp/v2/simdv2/cmd/testnet.go
	modified:   simapp/v2/simdv2/cmd/testnet_test.go
	modified:   simapp/v2/simdv2/main.go
	modified:   x/genutil/client/cli/collect.go
	modified:   x/genutil/v2/cli/commands.go
	modified:   x/genutil/v2/cli/export.go
	modified:   x/genutil/v2/types.go
	modified:   x/upgrade/depinject.go
	modified:   x/validate/depinject.go

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	both modified:   .github/CODEOWNERS
	deleted by us:   runtime/v2/app.go
	deleted by us:   runtime/v2/builder.go
	deleted by us:   runtime/v2/module.go
	deleted by us:   server/v2/api/grpc/server.go
	deleted by us:   server/v2/api/grpcgateway/server.go
	deleted by us:   server/v2/api/rest/server.go
	deleted by us:   server/v2/api/rest/server_test.go
	deleted by us:   server/v2/api/telemetry/server.go
	deleted by us:   server/v2/commands.go
	deleted by us:   server/v2/logger.go
	deleted by us:   server/v2/server.go
	deleted by us:   server/v2/server_mock_test.go
	deleted by us:   server/v2/server_test.go
	deleted by us:   server/v2/store/server.go
	deleted by us:   server/v2/store/snapshot.go
	deleted by us:   server/v2/util.go
	both modified:   simapp/v2/simdv2/cmd/commands.go

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

@mergify mergify bot requested a review from a team as a code owner October 29, 2024 06:15
@mergify mergify bot added the conflicts label Oct 29, 2024
Copy link
Contributor

coderabbitai bot commented Oct 29, 2024

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.

server/v2/commands.go Fixed Show fixed Hide fixed
simapp/v2/simdv2/cmd/commands.go Fixed Show fixed Hide fixed
simapp/v2/simdv2/cmd/testnet.go Fixed Show fixed Hide fixed
simapp/v2/simdv2/cmd/testnet.go Fixed Show fixed Hide fixed
@julienrbrt julienrbrt self-assigned this Oct 29, 2024
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

🚀

@julienrbrt julienrbrt merged commit ea770de into release/v0.52.x Oct 29, 2024
71 of 73 checks passed
@julienrbrt julienrbrt deleted the mergify/bp/release/v0.52.x/pr-22267 branch October 29, 2024 09:50
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.

2 participants