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

bump: cometbft to add more invalid block checker #131

Merged
merged 2 commits into from
Dec 13, 2024
Merged

bump: cometbft to add more invalid block checker #131

merged 2 commits into from
Dec 13, 2024

Conversation

beer-1
Copy link
Collaborator

@beer-1 beer-1 commented Dec 11, 2024

Description

Closes: #XXXX


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
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • 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

Summary by CodeRabbit

  • New Features

    • Introduced a new method to retrieve the count of active subscriptions in the FilterAPI.
    • Added a channel to facilitate subscription count requests.
  • Bug Fixes

    • Adjusted the filter timeout duration in the test setup from 3 seconds to 10 seconds.
  • Chores

    • Updated Go toolchain version and various module dependencies for improved compatibility and security.

@beer-1 beer-1 self-assigned this Dec 11, 2024
@beer-1 beer-1 requested a review from a team as a code owner December 11, 2024 03:23
Copy link

coderabbitai bot commented Dec 11, 2024

Walkthrough

The pull request includes updates to the go.mod files for both the main module and the integration-tests module, reflecting changes in Go toolchain versions and various module dependencies. Key updates involve the version increments for several cosmossdk.io packages and other dependencies like github.com/cometbft/cometbft, github.com/cosmos/ibc-go/v8, and github.com/ethereum/go-ethereum. Additionally, the FilterAPI struct in the jsonrpc/namespaces/eth/filters/api.go file has been enhanced with a new method for counting active subscriptions, while the test configuration in api_test.go has adjusted the filter timeout.

Changes

File Change Summary
go.mod Updated Go version to go1.23.0, modified dependencies including cosmossdk.io packages and others.
integration-tests/go.mod Updated Go version to 1.23.0, modified dependencies including github.com/cometbft/cometbft and others.
jsonrpc/namespaces/eth/filters/api.go Added status channel and NumSubscriptions method to FilterAPI for active subscription count.
jsonrpc/namespaces/eth/filters/api_test.go Increased FilterTimeout from 3 seconds to 10 seconds in setupFilterAPI function.

Possibly related PRs

Suggested reviewers

  • djm07073

🐰 In the meadow, changes bloom,
Dependencies updated, making room.
A channel for counts, now we can see,
Active subscriptions, hopping with glee!
With timeouts adjusted, tests run free,
In the world of Go, we're as happy as can be! 🌼


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

CodeRabbit Configuration 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 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 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

@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

🧹 Outside diff range and nitpick comments (1)
jsonrpc/namespaces/eth/filters/api_test.go (1)

56-56: Consider making tests more robust

Instead of using fixed sleep durations, consider implementing a more robust waiting mechanism:

  1. Use polling with timeout for indexer readiness
  2. Add helper functions to wait for specific conditions

Example implementation:

+ func waitForIndexer(t *testing.T, indexer indexer.EVMIndexer, timeout time.Duration) error {
+     start := time.Now()
+     for {
+         if time.Since(start) > timeout {
+             return fmt.Errorf("timeout waiting for indexer")
+         }
+         if indexer.IsReady() {
+             return nil
+         }
+         time.Sleep(100 * time.Millisecond)
+     }
+ }

Then replace the sleep calls with:

- time.Sleep(3 * time.Second)
+ require.NoError(t, waitForIndexer(t, input.indexer, 10*time.Second))
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 05f54b7 and 6569fa1.

⛔ Files ignored due to path filters (2)
  • go.sum is excluded by !**/*.sum
  • integration-tests/go.sum is excluded by !**/*.sum
📒 Files selected for processing (4)
  • go.mod (1 hunks)
  • integration-tests/go.mod (1 hunks)
  • jsonrpc/namespaces/eth/filters/api.go (4 hunks)
  • jsonrpc/namespaces/eth/filters/api_test.go (1 hunks)
🔇 Additional comments (5)
jsonrpc/namespaces/eth/filters/api.go (2)

60-60: LGTM: Well-designed channel for subscription counting.

The addition of status chan chan int and its initialization follows the established pattern for channel-based communication in the FilterAPI struct.

Also applies to: 81-81


170-171: LGTM: Thread-safe subscription count implementation.

The status channel handler correctly returns the subscription count while maintaining thread safety, as the subscriptions map is only accessed from the eventLoop goroutine.

integration-tests/go.mod (1)

274-274: Verify compatibility with updated CometBFT version.

The update to CometBFT (v0.0.0-20241209060054-203460274117) should be tested thoroughly to ensure compatibility with the new invalid block checks.

✅ Verification successful

Let me generate additional scripts to verify the CometBFT changes more thoroughly.


Based on the verification results, I can now provide a final response:

CometBFT update is consistent across the codebase

The verification shows that:

  1. Both main and integration-tests go.mod files use the same CometBFT version (v0.0.0-20241209060054-203460274117)
  2. CometBFT usage is primarily in test files and infrastructure code (ABCI, RPC clients)
  3. No breaking changes in the CometBFT API usage patterns were detected

The update appears to be a coordinated change across the codebase with consistent versioning and no API incompatibilities.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for breaking changes in the CometBFT update

# Check git log for breaking changes
gh api graphql -f query='
{
  repository(owner: "initia-labs", name: "cometbft") {
    object(expression: "v0.0.0-20241209060054-203460274117") {
      ... on Commit {
        history(first: 10) {
          nodes {
            messageHeadline
            message
          }
        }
      }
    }
  }
}'

# Check for API changes in CometBFT usage
rg -A 5 "cometbft" --type go

Length of output: 11835


Script:

#!/bin/bash
# Check for CometBFT version changes in both go.mod files
echo "=== Checking CometBFT versions ==="
echo "Main go.mod:"
rg "github.com/cometbft/cometbft =>" go.mod || echo "No replace directive found"
echo -e "\nIntegration tests go.mod:"
rg "github.com/cometbft/cometbft =>" integration-tests/go.mod || echo "No replace directive found"

# Check for any CometBFT API usage changes
echo -e "\n=== Checking CometBFT API usage ==="
ast-grep --pattern 'import (
  $$$
  "github.com/cometbft/cometbft/$_"
  $$$
)'

# Check for any recent changes in files using CometBFT
echo -e "\n=== Checking recent changes in files using CometBFT ==="
for file in $(rg -l "cometbft" --type go); do
  echo "=== $file ==="
  git diff HEAD^1 -- "$file" 2>/dev/null || echo "No changes"
done

Length of output: 73061

go.mod (1)

291-291: LGTM: Consistent dependency updates.

The dependency updates in both go.mod files are aligned, particularly the CometBFT version which supports the PR objective of enhancing invalid block checks.

jsonrpc/namespaces/eth/filters/api_test.go (1)

56-56: Verify if timeout increase aligns with PR objectives

The increase in FilterTimeout from 3 to 10 seconds appears reasonable given the complex operations in the tests, but please clarify how this change relates to the PR's objective of "adding more invalid block checker".

jsonrpc/namespaces/eth/filters/api.go Outdated Show resolved Hide resolved
Copy link

codecov bot commented Dec 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 56.93%. Comparing base (55ab7cf) to head (d4c3244).
Report is 3 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #131   +/-   ##
=======================================
  Coverage   56.93%   56.93%           
=======================================
  Files         110      110           
  Lines       10063    10063           
=======================================
  Hits         5729     5729           
  Misses       3508     3508           
  Partials      826      826           

@beer-1 beer-1 merged commit db00a17 into main Dec 13, 2024
10 checks passed
@beer-1 beer-1 deleted the bump/deps branch December 13, 2024 02:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant