Skip to content

Do not skip storing messages in indexer #621

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

Merged
merged 1 commit into from
Mar 14, 2025
Merged

Conversation

fbac
Copy link
Collaborator

@fbac fbac commented Mar 12, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Improved error handling during event processing to ensure continuity even if blockchain queries fail, preventing unnecessary interruptions in operations.

@fbac fbac requested a review from a team as a code owner March 12, 2025 10:13
Copy link
Contributor

coderabbitai bot commented Mar 12, 2025

Walkthrough

The changes introduce a new boolean variable skipReorgHandling within the indexLogs function in pkg/indexer/indexer.go. This variable is initialized as false and is set to true when a blockchain block query fails, allowing the function to bypass the reorganization check logic. The reorganization handling code is then conditionally executed based on the state of skipReorgHandling, ensuring that log storage continues even if the reorg check is skipped. No changes were made to public or exported entities.

Changes

File Change Summary
pkg/indexer/indexer.go Introduced skipReorgHandling to control reorg handling. Modified indexLogs to set this flag on block query errors, skipping reorg checks if true.

Sequence Diagram(s)

sequenceDiagram
    participant I as IndexLogs
    participant BC as Blockchain
    participant L as Log Storage

    I->>BC: Query block number
    alt Query successful
        BC-->>I: Return block number
        I->>I: Evaluate reorg condition and handle if needed
    else Query fails
        BC-->>I: Return error
        I->>I: Set skipReorgHandling to true
    end
    I->>L: Proceed with log storage
Loading

Possibly related PRs

Suggested labels

indexer

Suggested reviewers

  • mkysel

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 golangci-lint (1.62.2)

Error: can't load config: the Go language version (go1.23) used to build golangci-lint is lower than the targeted Go version (1.24)
Failed executing command with error: can't load config: the Go language version (go1.23) used to build golangci-lint is lower than the targeted Go version (1.24)


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3cb07a8 and 850549c.

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

289-337: Good enhancement for error resilience

The introduction of the skipReorgHandling flag allows the system to continue processing events even when blockchain block queries fail. This is a well-implemented change that improves system resilience without compromising the core functionality.

I particularly appreciate the clear warning message that explains what's happening when reorg handling is skipped. This will be helpful for troubleshooting.

One consideration: While skipping reorg handling improves availability, it introduces a trade-off with consistency if block queries fail consistently. Consider adding monitoring for persistent block query failures to detect when the system operates in this degraded mode for extended periods.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @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.

@@ -286,50 +286,54 @@ func indexLogs(
// - There's a stored block
// - The event block number is greater than the stored block number
// - The check interval has passed
skipReorgHandling := false
if !reorgInProgress &&
Copy link
Collaborator

Choose a reason for hiding this comment

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

I have never managed to truly convince myself that this if statement is correct. I just glaze over it and say "this is too complicated for me to dig into". Not the best approach, I know. Adding another layer of if statements makes this virtually impossible to reason about. I am hoping that someone other than Borja knows what this does :)

@fbac fbac merged commit 363b0e7 into main Mar 14, 2025
6 of 7 checks passed
@fbac fbac deleted the 03-11-indexer_dont_skip_txs branch March 14, 2025 17:44
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.

2 participants