Skip to content

track latest block immediately on start #216

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
Jun 4, 2025

Conversation

iuwqyir
Copy link
Collaborator

@iuwqyir iuwqyir commented Jun 3, 2025

TL;DR

Refactored the ChainTracker to track the latest block number immediately on start and extract the tracking logic into a separate method.

What changed?

  • Extracted the block number tracking logic into a new trackLatestBlockNumber method
  • Added a call to trackLatestBlockNumber immediately after the ChainTracker starts, before entering the main loop
  • Updated the ticker handler to call the new method instead of containing the logic directly

How to test?

  1. Start the application and verify that the chain tracker begins tracking the latest block number immediately
  2. Check logs to confirm the tracker continues to update at regular intervals
  3. Verify that metrics for ChainHead are being set correctly

Why make this change?

This change improves the ChainTracker by:

  1. Tracking the latest block number immediately on startup instead of waiting for the first ticker event
  2. Improving code organization by extracting the tracking logic into a reusable method
  3. Reducing code duplication between the initial tracking and the periodic updates

Summary by CodeRabbit

  • Refactor
    • Improved internal logic for tracking and updating the latest block number, resulting in more modular and maintainable code. No changes to user-facing functionality.

Copy link

coderabbitai bot commented Jun 3, 2025

"""

Walkthrough

The update refactors the logic for fetching and updating the latest block number in the ChainTracker struct by extracting it into a new private method. The Start method now invokes this helper method both at startup and on each ticker event, with the overall control flow and error handling remaining unchanged.

Changes

File Change Summary
internal/orchestrator/chain_tracker.go Refactored block number update logic into a new private method; updated Start to use this method.

Sequence Diagram(s)

sequenceDiagram
    participant StartMethod as ChainTracker.Start
    participant Tracker as ChainTracker
    participant RPC as RPC Client
    participant Metrics as Metrics

    StartMethod->>Tracker: trackLatestBlockNumber(ctx)
    Tracker->>RPC: Get latest block number
    alt Success
        RPC-->>Tracker: Block number
        Tracker->>Metrics: Update ChainHead metric
    else Error
        Tracker->>Tracker: Log error
    end
    loop On each ticker event
        StartMethod->>Tracker: trackLatestBlockNumber(ctx)
        Tracker->>RPC: Get latest block number
        alt Success
            RPC-->>Tracker: Block number
            Tracker->>Metrics: Update ChainHead metric
        else Error
            Tracker->>Tracker: Log error
        end
    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 18cd55e and ab704ec.

📒 Files selected for processing (1)
  • internal/orchestrator/chain_tracker.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • internal/orchestrator/chain_tracker.go
✨ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

Copy link
Collaborator Author

iuwqyir commented Jun 3, 2025

@iuwqyir iuwqyir marked this pull request as ready for review June 3, 2025 21:50
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

🧹 Nitpick comments (1)
internal/orchestrator/chain_tracker.go (1)

32-32: Test initial block tracking invocation
The new immediate call ct.trackLatestBlockNumber(ctx) ensures the latest block is fetched right after Start(). Consider adding a unit or integration test mocking rpc.IRPCClient to assert that GetLatestBlockNumber is invoked before the first ticker tick.

Can provide a sample test if needed.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f757184 and 18cd55e.

📒 Files selected for processing (1)
  • internal/orchestrator/chain_tracker.go (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
internal/orchestrator/chain_tracker.go (1)
internal/metrics/metrics.go (1)
  • ChainHead (44-47)
🔇 Additional comments (1)
internal/orchestrator/chain_tracker.go (1)

39-41: Reuse tracking logic in ticker loop
Refactoring the ticker case to call trackLatestBlockNumber() instead of inlining the fetch/update logic reduces duplication and improves readability. Nice work!

@iuwqyir iuwqyir force-pushed the 06-04-track_latest_block_immediately_on_start branch from 18cd55e to ab704ec Compare June 4, 2025 12:21
@iuwqyir iuwqyir merged commit 23884ad into main Jun 4, 2025
6 checks passed
@iuwqyir iuwqyir deleted the 06-04-track_latest_block_immediately_on_start branch June 4, 2025 13:33
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