cosmos / cosmos-sdk

:chains: A Framework for Building High Value Public Blockchains :sparkles:
https://cosmos.network/
Apache License 2.0
6.07k stars 3.48k forks source link

refactor(server/v2): simplify servers #20796

Closed julienrbrt closed 3 days ago

julienrbrt commented 4 days ago

Description

PR is starting to do too many things. Splitting. Investigating the following 3 in a follow-up


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

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

Summary by CodeRabbit

coderabbitai[bot] commented 4 days ago
Walkthrough ## Walkthrough The changes primarily involve refactoring context key usage in multiple files to simplify and unify the approach. Previously, context keys were structs; now, they are typed variables. The functionality enhances code readability and maintainability. Several command and query-related methods in the `server/v2/cometbft` package were also refactored for consistency. Additionally, various test files were updated to reflect these changes in context key usage. ## Changes | File(s) | Change Summary | | ----------------------------------- | -------------- | | `client/cmd.go`, `core/context/...`, `server/util.go`, `simapp/simd/cmd/testnet_test.go`, `tests/e2e/genutil/export_test.go`, `x/genutil/client/cli/**/*.go`, `x/genutil/client/testutil/helpers.go` | Refactored context key usage by removing empty braces `{}` from context key assignments, and changed context key declarations from structs to variables. | | `server/v2/api/grpc/server.go` | Replaced `serverName` constant with `g.Name()` method. | | `server/v2/cometbft/abci.go` | Removed multiple methods from `Consensus` struct and modified `RegisterExtensions` method to accept variadic parameters. | | `server/v2/cometbft/commands.go` | Modified use of flags and declarations for CometBFT server commands. | | `server/v2/cometbft/config.go` | Added a comment `// TODO REDO/VERIFY THIS`. | | `server/v2/cometbft/flags.go`, `server/v2/cometbft/options.go` | Added constants, supported output formats, and helper functions for flags; introduced `ServerOptions` struct. | | `server/v2/cometbft/server.go` | Various updates and method modifications in `CometBFTServer` struct. | | `server/v2/commands.go` | Refactored command creation logic and handling in the server application. | | `server/v2/config.go` | Removed `ServerContextKey` and `Config` struct; retained `CLIConfig` struct. | | `server/v2/logger.go` | `NewLogger` function now returns `corelog.Logger` instead of `log.Logger`. | | `server/v2/server_test.go` | Simplified context creation in `TestServer` using `context.TODO()`. | | `simapp/v2/simdv2/cmd/commands.go` | Modified `cometbft.New` function call to include `cometbft.DefaultServerOptions[T]()`. | | `simapp/v2/simdv2/cmd/root_di.go` | Removed logic to set default command outputs and modified the update of `clientCtx` within `PersistentPreRunE` function. |

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 as 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. 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. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - 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/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.