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

handle reorg channel closing #476

Merged
merged 1 commit into from
Feb 12, 2025
Merged

handle reorg channel closing #476

merged 1 commit into from
Feb 12, 2025

Conversation

fbac
Copy link
Collaborator

@fbac fbac commented Feb 11, 2025

Every time a channel is closed it's signaled, which turns into triggering the reorg handling logic with reorgBlock = 0.

Summary by CodeRabbit

  • Bug Fixes
    • Enhanced the reliability of blockchain event processing by properly detecting when a background event stream stops unexpectedly, ensuring the system halts processing to maintain stable operation.

@fbac fbac requested a review from a team as a code owner February 11, 2025 11:47
Copy link

coderabbitai bot commented Feb 11, 2025

Walkthrough

The changes update the watchContract method within the blockchain RPC log streamer. The method now checks if the reorgChannel is open by capturing its state using a new open variable. If the channel is closed, a debug log entry is generated, and the function returns early, preventing further processing. The default case of the select statement remains unchanged, and no public or exported entities have been altered.

Changes

File Change Summary
pkg/.../rpcLogStreamer.go Modified the watchContract method to check the state of reorgChannel. Introduced an open variable to determine if the channel is closed, logging a debug message and returning early when detected.

Sequence Diagram(s)

sequenceDiagram
    participant WC as watchContract
    participant RC as reorgChannel
    participant L as Logger

    WC->>RC: Attempt to read from channel
    alt Channel is open
        WC->>WC: Process log in the default case
    else Channel is closed
        WC->>L: Log debug: "reorg channel is closed"
        WC->>WC: Return early and stop processing
    end
Loading

📜 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 1261e2c and 621a832.

📒 Files selected for processing (1)
  • pkg/blockchain/rpcLogStreamer.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/blockchain/rpcLogStreamer.go (1)

138-142: LGTM! Proper handling of reorg channel closure.

The changes correctly implement the comma-ok idiom to handle channel closure, preventing potential goroutine leaks and ensuring clean shutdown. The debug logging provides good visibility into the shutdown process.

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

@fbac fbac added the indexer Blockchain indexing label Feb 11, 2025
@fbac fbac merged commit 69568d3 into main Feb 12, 2025
7 checks passed
@fbac fbac deleted the avoid-closing-ch-signal branch February 12, 2025 15:41
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