Skip to content

Update progress prom metric on empty batch as well - #613

Merged
DZakh merged 2 commits into
mainfrom
dz/update-progress-on-empty-batch
Jun 20, 2025
Merged

Update progress prom metric on empty batch as well#613
DZakh merged 2 commits into
mainfrom
dz/update-progress-on-empty-batch

Conversation

@DZakh

@DZakh DZakh commented Jun 20, 2025

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Refactor
    • Improved internal logic for updating processed block and event counts, as well as Prometheus metrics, resulting in more accurate and consolidated progress tracking.
    • Streamlined state updates for processing batches to enhance maintainability and reduce duplication.

@DZakh
DZakh requested a review from JonoPrest June 20, 2025 07:21
@coderabbitai

coderabbitai Bot commented Jun 20, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

The changes refactor and consolidate logic within the global state management code. The checkAndSetSyncedChains function's signature is updated to accept optional processing metrics and now handles updates to chain fetchers and Prometheus metrics. The updateLatestProcessedBlocks function is simplified to delegate its work to the refactored checkAndSetSyncedChains.

Changes

File(s) Change Summary
codegenerator/cli/templates/static/codegen/src/globalState/GlobalState.res Refactored checkAndSetSyncedChains to accept processing metrics; consolidated metric updates; simplified updateLatestProcessedBlocks to delegate to the refactored function; reformatted a buffer size calculation.

Poem

A hop and a skip, code refactored anew,
Chains now sync smarter, with metrics in view.
Prometheus counts tallied, with clarity and care,
Rabbits rejoice—less code to compare!
With logic united, the garden grows bright,
Metrics and chains, all working just right.
🐇✨


📜 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 4f1c18a and 595c4d9.

📒 Files selected for processing (1)
  • codegenerator/cli/templates/static/codegen/src/globalState/GlobalState.res (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build_and_test
🔇 Additional comments (3)
codegenerator/cli/templates/static/codegen/src/globalState/GlobalState.res (3)

75-80: LGTM! Good formatting improvement.

The multi-line formatting makes the conditional logic more readable.


206-264: Excellent refactoring to ensure metrics are updated on empty batches!

This change successfully addresses the PR objective by:

  • Making the function update Prometheus metrics even when processingMetricsByChainId is not provided (empty batch case)
  • Using fallback logic to calculate latestProcessedBlock when no metrics are available
  • Ensuring ProgressBlockNumber and ProgressEventsCount metrics are properly maintained

The parameter reordering (moving chainManager to the first position) also improves the API consistency.


343-356: Great simplification by delegating to checkAndSetSyncedChains!

This refactoring eliminates code duplication and ensures consistent metric updates by leveraging the enhanced checkAndSetSyncedChains function. The consolidated logic is easier to maintain and less prone to bugs.


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.

~nextQueueItemIsKnownNone=false,
~shouldSetPrometheusSynced=true,
chainManager: ChainManager.t,
~processingMetricsByChainId=?,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Why make this optional? Is it called somewhere without this?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Yes, it's called without it when we have an empty batch

@JonoPrest JonoPrest left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🙏🏼

@DZakh
DZakh enabled auto-merge (squash) June 20, 2025 12:19
@DZakh
DZakh merged commit 6139bef into main Jun 20, 2025
@DZakh
DZakh deleted the dz/update-progress-on-empty-batch branch June 20, 2025 12:27
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