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

Configure indexer reorg check interval #472

Merged
merged 2 commits into from
Feb 10, 2025
Merged

Configure indexer reorg check interval #472

merged 2 commits into from
Feb 10, 2025

Conversation

fbac
Copy link
Collaborator

@fbac fbac commented Feb 10, 2025

Summary by CodeRabbit

  • Chores
    • Adjusted the system’s blockchain reorganization checks for improved reliability and performance by updating the reorg check interval.
    • Updated the block range configuration to streamline data retrieval during reorganization events, allowing checks every 60 blocks.

@fbac fbac added the indexer Blockchain indexing label Feb 10, 2025
@fbac fbac requested a review from a team as a code owner February 10, 2025 18:04
Copy link

coderabbitai bot commented Feb 10, 2025

Walkthrough

The changes adjust the interval and range parameters used for blockchain reorganization checks. In the indexer.go file, a new constant reorgCheckInterval is introduced and set to 60, replacing the previous hardcoded value of 10. In reorgHandler.go, the BLOCK_RANGE_SIZE constant is updated from 1000 to 600 with revised comments. These updates modify how frequently reorgs are checked and how block ranges are handled, affecting the control flow in the reorganization process.

Changes

Files Change Summary
pkg/indexer/indexer.go Replaced the hardcoded reorg check interval with a new constant (reorgCheckInterval = 60) in indexLogs. Removed the previous variable declaration.
pkg/indexer/reorgHandler.go Updated BLOCK_RANGE_SIZE from 1000 to 600 and modified accompanying comments to reflect adjustments in reorg check pagination.
pkg/indexer/reorgHandler_test.go Modified test case Test_blockRange to change from value from 1001 to 601 and adjusted expected wantEndBlock accordingly.

Sequence Diagram(s)

sequenceDiagram
    participant I as Indexer (indexLogs)
    participant RH as ReorgHandler
    participant DB as Database
    I->>I: Initiate reorg check (every 60 blocks)
    I->>RH: Trigger reorg handling
    RH->>DB: Retrieve block page (range of 600 blocks)
    DB-->>RH: Return block data
    RH-->>I: Process reorg status
Loading

Suggested reviewers

  • mkysel
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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.

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: 0

🧹 Nitpick comments (1)
pkg/indexer/reorgHandler_test.go (1)

10-34: Consider adding test cases for better coverage.

While the current test cases are valid, consider adding the following scenarios to improve coverage:

  • Values above 601 (e.g., 700, 1200) to verify behavior beyond the BLOCK_RANGE_SIZE
  • Values at multiples of 600 (e.g., 1200) to verify behavior at range boundaries

Here's a suggested addition to the test cases:

 	tests := []struct {
 		name           string
 		from           uint64
 		wantStartBlock uint64
 		wantEndBlock   uint64
 	}{
+		{
+			name:           "block range above boundary",
+			from:           700,
+			wantStartBlock: 100,
+			wantEndBlock:   700,
+		},
+		{
+			name:           "block range at multiple boundary",
+			from:           1200,
+			wantStartBlock: 600,
+			wantEndBlock:   1200,
+		},
 		{
 			name:           "block range with subtraction",
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 229eae2 and d720350.

📒 Files selected for processing (1)
  • pkg/indexer/reorgHandler_test.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Test (Node)
🔇 Additional comments (1)
pkg/indexer/reorgHandler_test.go (1)

18-20: LGTM! Test case updated correctly.

The test case values have been properly aligned with the new BLOCK_RANGE_SIZE of 600.

@fbac fbac merged commit e38254d into main Feb 10, 2025
7 checks passed
@fbac fbac deleted the indexer-configuration branch February 10, 2025 21:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
indexer Blockchain indexing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants