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

test(systemtest): fix cometbft client #22835

Merged
merged 1 commit into from
Dec 11, 2024
Merged

test(systemtest): fix cometbft client #22835

merged 1 commit into from
Dec 11, 2024

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Dec 11, 2024

Description

Follow-up of #22834

ref: #22753


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

  • Bug Fixes

    • Improved error handling in the commit process for better reliability.
  • Tests

    • Enhanced test logic to accommodate different system versions.
    • Renamed test function for clarity.
    • Updated test setup to ensure reliability by resetting the chain and awaiting the next block.

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Dec 11, 2024
Copy link
Contributor

coderabbitai bot commented Dec 11, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request involve modifications to the Commit method in the store/v2/root/store.go file, transitioning from an asynchronous execution model using the errgroup package to a synchronous one. This adjustment simplifies the control flow by executing WriteChangeset and Commit sequentially, with immediate error checks. Additionally, updates to the test suite in tests/systemtests/cometbft_client_test.go include conditional logic based on system version, a function renaming for clarity, and improved setup for the ABCI query tests.

Changes

File Change Summary
store/v2/root/store.go Removed errgroup usage; modified Commit method to execute WriteChangeset and Commit sequentially with immediate error checks.
tests/systemtests/cometbft_client_test.go Added version check in TestQueryStatus, renamed TestValidatorSetByHeight_GRPCRestGateway to TestValidatorSetByHeight_GRPCGateway, and improved setup in TestABCIQuery.

Possibly related PRs

Suggested labels

C:server/v2 cometbft

Suggested reviewers

  • kocubinski
  • tac0turtle
  • hieuvubk

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. (Experiment)
  • @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

🧹 Outside diff range and nitpick comments (1)
store/v2/root/store.go (1)

307-313: LGTM! Sequential execution improves reliability.

The change from concurrent to sequential execution of WriteChangeset and Commit operations:

  • Simplifies error handling
  • Eliminates potential race conditions
  • Makes the code more maintainable and easier to debug

Consider adding metrics or logging to track the performance impact of this change, especially for large changesets.

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a38a6a2 and 7ef29ef.

📒 Files selected for processing (2)
  • store/v2/root/store.go (1 hunks)
  • tests/systemtests/cometbft_client_test.go (3 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
store/v2/root/store.go (1)

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

tests/systemtests/cometbft_client_test.go (3)

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


Pattern tests/**/*: "Assess the integration and e2e test code assessing sufficient code coverage for the changes associated in the pull request"


Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

🔇 Additional comments (3)
tests/systemtests/cometbft_client_test.go (3)

265-267: LGTM! Improved test stability.

The addition of chain reset and block await ensures a clean and stable state before running ABCI query tests, which improves test reliability.


30-35: LGTM! Version-specific query handling looks correct.

The conditional logic appropriately handles both v2 ("comet") and legacy status queries.

Let's verify the version-specific query paths:

✅ Verification successful

Version-specific query handling is consistently implemented across the codebase

The verification shows that IsV2() is used consistently throughout the codebase to handle version-specific differences:

  • Query paths are properly prefixed with "comet" in v2 mode (e.g., in cometbft_client_test.go and staking_test.go)
  • Other v2-specific adjustments are also handled appropriately:
    • Server configuration parameters in testnet_init.go
    • Store and snapshot management in snapshots_test.go
    • Group query paths in group_test.go
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for other version-specific query handlers
rg -A 3 "IsV2\(\)" 

Length of output: 4044


231-231: Verify the impact of removing 'Rest' from the test name.

The function rename from TestValidatorSetByHeight_GRPCRestGateway to TestValidatorSetByHeight_GRPCGateway suggests an architectural change.

Let's check for similar patterns and related changes:

✅ Verification successful

The test rename aligns with the codebase's consistent naming pattern

The removal of 'Rest' from the test name is consistent with the codebase's architecture, where all gRPC-gateway related components use GRPCGateway without the Rest prefix. This is evidenced by:

  • All other test functions in the codebase use GRPCGateway naming (e.g., TestLatestValidatorSet_GRPCGateway, TestSimulateTx_GRPCGateway)
  • Module interfaces and implementations consistently use GRPCGateway in their naming (e.g., HasGRPCGateway, RegisterGRPCGatewayRoutes)
  • Server and API components follow the same convention with GRPCGatewayRouter
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other REST-related test names and usages
rg "GRPCRestGateway" 

# Search for related architectural changes
rg "GRPC.*Gateway"

Length of output: 13316

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release C:Store
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants