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

chore(simapp/v2): consensus server isn't command dep #23480

Merged
merged 4 commits into from
Jan 23, 2025
Merged

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Jan 22, 2025

Description

Small nit I found upgrading chain-minimal to v2


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

  • Refactor
    • Simplified consensus server initialization process.
    • Removed optional ConsensusServer field from command dependencies.
    • Enhanced reliability of command initialization by ensuring consistent consensus server creation.
    • Updated routing function to accept context directly, streamlining the process.
    • Modified AppManager instantiation to remove generic type parameter.
  • Documentation
    • Improved comments regarding the purpose of GasConfig for clarity.
    • Removed outdated TODO comment related to transaction gas limit validation.
    • Updated module name references to reflect new runtime version.

@julienrbrt julienrbrt requested a review from a team as a code owner January 22, 2025 21:38
Copy link
Contributor

coderabbitai bot commented Jan 22, 2025

📝 Walkthrough

Walkthrough

The pull request modifies the commands.go file in the simapp/v2/simdv2/cmd directory, focusing on simplifying the consensus server initialization process. The key change involves removing the ConsensusServer field from the CommandDependencies struct and directly creating a new consensusServer instance using cometbft.NewWithConfigOptions and cometbft.New. This approach ensures a more straightforward and reliable method of instantiating the consensus server during command initialization, eliminating the previous conditional logic. Additionally, changes were made to the AppManager instantiation in builder.go, and comments were updated in config.go and app_config.go.

Changes

File Change Summary
simapp/v2/simdv2/cmd/commands.go - Removed ConsensusServer field from CommandDependencies struct
- Updated InitRootCmd to directly create consensusServer using cometbft.NewWithConfigOptions and cometbft.New
- Modified registerGRPCGatewayRoutes to accept client.Context directly
runtime/v2/builder.go - Changed AppManager instantiation from generic to non-generic
- No changes to method signatures
server/v2/appmanager/config.go - Removed TODO comment related to ValidateTxGasLimit field
simapp/v2/app_config.go - Updated comments surrounding GasConfig for clarity
- No changes to the structure or functionality of GasConfig

Possibly related PRs

  • refactor(simdv2): allow non-comet server components #22351: The changes in the main PR regarding the InitRootCmd function and the handling of the ConsensusServer field are related to the modifications made in this PR, which also involves changes to command initialization and the introduction of a new consensus component.
  • refactor(runtime/v2): simplify app manager #22300: This PR simplifies the application manager, which is relevant to the changes in the main PR that streamline the initialization process and reduce complexity in managing the consensus server's lifecycle.
  • fix(simapp/v2): register extra gRPC gateway routes #22786: The updates in the main PR to the InitRootCmd function and the registration of gRPC gateway routes are connected to the changes in this PR, which also focuses on enhancing gRPC gateway integration within the command structure.

Suggested labels

C:server/v2 cometbft, C:x/auth

Suggested reviewers

  • sontrinh16
  • kocubinski
  • tac0turtle

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f666277 and 7e1745a.

📒 Files selected for processing (1)
  • simapp/v2/app_config.go (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • simapp/v2/app_config.go
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: tests (00)
  • GitHub Check: test-system-v2
  • GitHub Check: Analyze
  • GitHub Check: golangci-lint
  • GitHub Check: Summary

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>, 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
simapp/v2/simdv2/cmd/commands.go (1)

105-122: LGTM! Clean consensus server initialization.

The direct initialization of the consensus server with cometbft.New is more robust than the previous approach. All necessary parameters are properly provided.

Consider wrapping the error with additional context:

-		return nil, err
+		return nil, fmt.Errorf("failed to create consensus server: %w", err)
📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3860b2b and 6631b91.

📒 Files selected for processing (1)
  • simapp/v2/simdv2/cmd/commands.go (5 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
simapp/v2/simdv2/cmd/commands.go (1)

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

⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: tests (00)
  • GitHub Check: test-sim-nondeterminism
  • GitHub Check: test-simapp-v2
  • GitHub Check: test-integration
  • GitHub Check: test-system-v2
  • GitHub Check: Analyze
  • GitHub Check: build (amd64)
  • GitHub Check: golangci-lint
  • GitHub Check: Summary
🔇 Additional comments (2)
simapp/v2/simdv2/cmd/commands.go (2)

49-49: LGTM! Good cleanup of dependencies.

The removal of the ConsensusServer field from CommandDependencies simplifies the dependency management by eliminating optional initialization. This change aligns well with the PR objective.


Line range hint 82-88: LGTM! Consistent integration across different paths.

The changes maintain proper functionality for both client-only and full app paths while ensuring consistent integration with GRPC services and server commands.

Also applies to: 137-140, 165-165

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6631b91 and 0bc2b53.

📒 Files selected for processing (1)
  • simapp/v2/simdv2/cmd/commands.go (7 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
simapp/v2/simdv2/cmd/commands.go (1)

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

⏰ Context from checks skipped due to timeout of 90000ms (12)
  • GitHub Check: tests (03)
  • GitHub Check: tests (02)
  • GitHub Check: tests (01)
  • GitHub Check: tests (00)
  • GitHub Check: test-simapp-v2
  • GitHub Check: test-system-v2
  • GitHub Check: test-sim-nondeterminism
  • GitHub Check: test-integration
  • GitHub Check: Analyze
  • GitHub Check: build (amd64)
  • GitHub Check: golangci-lint
  • GitHub Check: Summary
🔇 Additional comments (2)
simapp/v2/simdv2/cmd/commands.go (2)

49-49: LGTM: Good refactoring of dependencies!

The addition of ClientContext and removal of ConsensusServer field improves the dependency structure by:

  1. Providing necessary context for consensus server initialization
  2. Removing redundant server instance storage

105-120: LGTM: Well-structured consensus server initialization!

The consensus server initialization is properly implemented with:

  1. Comprehensive error handling
  2. Complete configuration passing
  3. Clear dependency management

simapp/v2/simdv2/cmd/commands.go Show resolved Hide resolved
@github-actions github-actions bot added C:server/v2 Issues related to server/v2 C:server/v2 appmanager labels Jan 23, 2025
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0bc2b53 and f666277.

📒 Files selected for processing (3)
  • runtime/v2/builder.go (1 hunks)
  • server/v2/appmanager/config.go (1 hunks)
  • simapp/v2/app_config.go (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • server/v2/appmanager/config.go
🧰 Additional context used
📓 Path-based instructions (2)
simapp/v2/app_config.go (1)

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

runtime/v2/builder.go (1)

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

🪛 golangci-lint (1.62.2)
simapp/v2/app_config.go

201-201: overriden is a misspelling of overridden

(misspell)

🪛 GitHub Actions: Lint
simapp/v2/app_config.go

[error] 201-201: Misspelling: 'overriden' should be 'overridden'

⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: test-log
  • GitHub Check: test-store
  • GitHub Check: test-orm
  • GitHub Check: test-hubl
  • GitHub Check: test-simapp-v2
  • GitHub Check: test-sim-nondeterminism
  • GitHub Check: test-system-v2
  • GitHub Check: test-integration
  • GitHub Check: Analyze
  • GitHub Check: Summary
🔇 Additional comments (1)
runtime/v2/builder.go (1)

Line range hint 127-134: LGTM: Simplified AppManager instantiation.

The removal of the generic type parameter streamlines the code while maintaining the same functionality.

simapp/v2/app_config.go Outdated Show resolved Hide resolved
@@ -2,7 +2,7 @@ package appmanager

// Config represents the configuration options for the app manager.
type Config struct {
ValidateTxGasLimit uint64 `mapstructure:"validate-tx-gas-limit"` // TODO: check how this works on app mempool
ValidateTxGasLimit uint64 `mapstructure:"validate-tx-gas-limit"`
Copy link
Member

Choose a reason for hiding this comment

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

i believe this can be removed, we should open an issue on it to track it.

Copy link
Member Author

@julienrbrt julienrbrt Jan 23, 2025

Choose a reason for hiding this comment

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

It's being used here actually:

res := a.stf.ValidateTx(ctx, latestState, a.config.ValidateTxGasLimit, tx)

It is part of the stf interface:

res := a.stf.ValidateTx(ctx, latestState, a.config.ValidateTxGasLimit, tx)

@julienrbrt julienrbrt enabled auto-merge January 23, 2025 11:28
@julienrbrt julienrbrt added this pull request to the merge queue Jan 23, 2025
Merged via the queue into main with commit 18a8252 Jan 23, 2025
76 of 77 checks passed
@julienrbrt julienrbrt deleted the julien/chore branch January 23, 2025 11:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:server/v2 appmanager C:server/v2 Issues related to server/v2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants