Skip to content

add possibility to poll without saving #225

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 13, 2025

Conversation

iuwqyir
Copy link
Collaborator

@iuwqyir iuwqyir commented Jun 11, 2025

TL;DR

Refactored the Poller to separate block polling from data storage operations.

What changed?

  • Split the Poll method into two separate methods:
    • PollWithoutSaving: Handles only the polling of blocks without storing data
    • StageResults: Handles the storage of polled block data
  • Moved the worker results handling logic into these new methods
  • Added functionality to track and return the highest block number polled
  • Created a helper method convertPollResultsToBlockData to transform poll results into block data

How to test?

  1. Run the existing test suite to ensure all functionality works as expected
  2. Test the new PollWithoutSaving method by calling it directly and verifying it returns the correct block data without saving
  3. Test the StageResults method by passing block data and verifying it's properly stored
  4. Verify that the Poll method still returns the highest block number correctly

Why make this change?

This refactoring improves the separation of concerns in the Poller, making it more flexible by allowing clients to poll blocks without immediately saving the data. This enables more advanced use cases where data processing might be needed before storage, and makes the code more maintainable by breaking down the monolithic polling function into smaller, more focused components.

Summary by CodeRabbit

  • Refactor
    • Enhanced the polling process to improve data handling and error reporting, resulting in more reliable background operations without affecting user-facing features.

Copy link

coderabbitai bot commented Jun 11, 2025

Walkthrough

The Poll method in the orchestrator's poller was refactored to separate block polling from data staging. New methods were introduced to handle polling without saving, converting poll results, and staging results. The previous monolithic result handling method was removed, and logic was modularized for clearer separation of responsibilities.

Changes

File Change Summary
internal/orchestrator/poller.go Refactored Poll to delegate polling and staging; added PollWithoutSaving, convertPollResultsToBlockData, and StageResults methods; removed handleWorkerResults.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant Poller
    participant Worker
    participant Storage

    Caller->>Poller: Poll(ctx, blockNumbers)
    Poller->>Poller: PollWithoutSaving(ctx, blockNumbers)
    Poller->>Worker: Fetch blocks
    Worker-->>Poller: Block fetch results
    Poller->>Poller: convertPollResultsToBlockData(results)
    Poller->>Poller: StageResults(successfulBlocks, failedResults)
    Poller->>Storage: Insert successful block data
    Poller->>Poller: handleBlockFailures(failedResults)
    Poller-->>Caller: Return latest polled block
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 ca1698e and 4139a04.

📒 Files selected for processing (1)
  • internal/orchestrator/poller.go (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • internal/orchestrator/poller.go
✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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 11, 2025

@iuwqyir iuwqyir force-pushed the 06-11-add_possibility_to_poll_without_saving branch from c3d9b2b to fdf67f3 Compare June 13, 2025 16:31
@iuwqyir iuwqyir force-pushed the 06-11-setup_workmode_determination_and_update branch 2 times, most recently from 5628b1f to 5305187 Compare June 13, 2025 16:36
@iuwqyir iuwqyir force-pushed the 06-11-add_possibility_to_poll_without_saving branch 2 times, most recently from 05ef01c to 4450a45 Compare June 13, 2025 16:41
@iuwqyir iuwqyir force-pushed the 06-11-setup_workmode_determination_and_update branch from 5305187 to 6e15133 Compare June 13, 2025 16:41
@iuwqyir iuwqyir force-pushed the 06-11-add_possibility_to_poll_without_saving branch from 4450a45 to ec67258 Compare June 13, 2025 16:54
@iuwqyir iuwqyir force-pushed the 06-11-setup_workmode_determination_and_update branch from 6e15133 to 3fb9870 Compare June 13, 2025 16:54
@iuwqyir iuwqyir changed the base branch from 06-11-setup_workmode_determination_and_update to graphite-base/225 June 13, 2025 16:55
@iuwqyir iuwqyir force-pushed the 06-11-add_possibility_to_poll_without_saving branch from ec67258 to c35218d Compare June 13, 2025 16:55
@graphite-app graphite-app bot changed the base branch from graphite-base/225 to main June 13, 2025 16:55
@iuwqyir iuwqyir force-pushed the 06-11-add_possibility_to_poll_without_saving branch from c35218d to ca1698e Compare June 13, 2025 16:56
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: 4

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 84624f5 and ca1698e.

📒 Files selected for processing (1)
  • internal/orchestrator/poller.go (2 hunks)
🔇 Additional comments (1)
internal/orchestrator/poller.go (1)

190-193: Update lastPolledBlock only after successful fetch

p.lastPolledBlock is advanced before the worker runs.
If every RPC call in the batch fails, the poller will still skip these blocks forever.
Consider moving the assignment after convertPollResultsToBlockData and only when
len(blockData) > 0.

@iuwqyir iuwqyir force-pushed the 06-11-add_possibility_to_poll_without_saving branch from ca1698e to 4139a04 Compare June 13, 2025 17:08
@iuwqyir iuwqyir merged commit 918459c into main Jun 13, 2025
6 of 8 checks passed
@iuwqyir iuwqyir deleted the 06-11-add_possibility_to_poll_without_saving branch June 13, 2025 17:13
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