Skip to content

fix: configure default timeout for blob clients #1191

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 2 commits into from
May 28, 2025

Conversation

Thegaram
Copy link

@Thegaram Thegaram commented May 27, 2025

1. Purpose or design rationale of this PR

Avoid issues where the client hangs indefinitely, blocking follower node sync.

2. PR title

Your PR title must follow conventional commits (as we are doing squash merge for each PR), so it must start with one of the following types:

  • fix: A bug fix

3. Deployment tag versioning

Has the version in params/version.go been updated?

  • This PR doesn't involve a new deployment, git tag, docker image tag, and it doesn't affect traces
  • Yes

4. Breaking change label

Does this PR have the breaking-change label?

  • This PR is not a breaking change
  • Yes

Summary by CodeRabbit

  • New Features

    • Introduced consistent 15-second timeouts for all network requests made by various clients, improving reliability and responsiveness during network issues.
  • Chores

    • Updated patch version number from 49 to 50.

@Thegaram Thegaram requested review from jonastheis and colinlyguo May 27, 2025 16:07
Copy link

coderabbitai bot commented May 27, 2025

Walkthrough

The changes introduce configurable HTTP client timeouts for several client structs by initializing each with a dedicated http.Client instance set to a 15-second timeout. Constructors and relevant methods are updated to use these clients for all HTTP requests. Additionally, the patch version number is incremented.

Changes

Files/Paths Change Summary
params/version.go Incremented VersionPatch constant from 49 to 50.
rollup/da_syncer/blob_client/blob_scan_client.go, rollup/da_syncer/blob_client/beacon_node_client.go, rollup/da_syncer/blob_client/block_native_client.go Added client *http.Client field or constant timeout; updated constructors to initialize HTTP clients with 15s timeout; modified methods to use these clients for HTTP requests.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant ClientConstructor
    participant HTTPClient

    Caller->>ClientConstructor: Instantiate new client (e.g., NewBeaconNodeClient)
    ClientConstructor->>HTTPClient: Create http.Client with 15s timeout
    ClientConstructor-->>Caller: Return client with configured HTTP client

    Caller->>ClientConstructor: Call method (e.g., GetBlobByVersionedHashAndBlockTime)
    ClientConstructor->>HTTPClient: Make HTTP request using internal client
    HTTPClient-->>ClientConstructor: Return HTTP response (with timeout enforced)
    ClientConstructor-->>Caller: Return result
Loading

Suggested reviewers

  • georgehao
  • colinlyguo

Poem

In the warren, code flows swift and neat,
HTTP clients now skip a heartbeat—
Fifteen seconds, not a tick more,
Timeouts set to even the score.
Patch fifty hops in, quick as a wink,
Rabbits rejoice, as code and clocks sync!
🕒🐇


📜 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 96a64a8 and 93c5046.

📒 Files selected for processing (1)
  • rollup/da_syncer/blob_client/beacon_node_client.go (5 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • rollup/da_syncer/blob_client/beacon_node_client.go
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: test
  • GitHub Check: Analyze (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

@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

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 141a8df and 96a64a8.

📒 Files selected for processing (4)
  • params/version.go (1 hunks)
  • rollup/da_syncer/blob_client/beacon_node_client.go (5 hunks)
  • rollup/da_syncer/blob_client/blob_scan_client.go (1 hunks)
  • rollup/da_syncer/blob_client/block_native_client.go (2 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
rollup/da_syncer/blob_client/beacon_node_client.go (2)
rollup/l1/types.go (1)
  • Client (12-23)
rollup/da_syncer/blob_client/blob_scan_client.go (1)
  • BlobScanDefaultTimeout (19-19)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: test
  • GitHub Check: Analyze (go)
🔇 Additional comments (14)
params/version.go (1)

27-27: LGTM: Appropriate patch version increment.

The version bump from 49 to 50 correctly follows semantic versioning for this bug fix that adds timeout configuration to blob clients.

rollup/da_syncer/blob_client/blob_scan_client.go (3)

11-11: LGTM: Necessary import for timeout functionality.

The time import is correctly added to support the timeout constant.


18-20: LGTM: Well-defined timeout constant.

The 15-second timeout is reasonable for preventing indefinite client hangs while allowing sufficient time for normal API responses.


29-29: LGTM: Proper HTTP client initialization with timeout.

The constructor correctly initializes the HTTP client with the defined timeout, replacing reliance on the default client which has no timeout.

rollup/da_syncer/blob_client/block_native_client.go (5)

11-11: LGTM: Necessary import for timeout functionality.

The time import is correctly added to support the timeout constant.


18-20: LGTM: Consistent timeout configuration.

The 15-second timeout matches other blob clients and provides reasonable protection against indefinite hangs.


23-23: LGTM: Proper client field addition.

Adding the HTTP client field to the struct enables timeout configuration for all requests.


29-29: LGTM: Correct client initialization.

The constructor properly initializes the HTTP client with the configured timeout.


44-44: LGTM: Using configured client instead of default.

The method correctly uses the timeout-configured client instead of the default HTTP client, ensuring requests respect the timeout.

rollup/da_syncer/blob_client/beacon_node_client.go (5)

12-12: LGTM: Necessary import for timeout functionality.

The time import is correctly added to support the timeout constant.


18-20: LGTM: Consistent timeout constant definition.

The 15-second timeout constant is properly defined and matches other blob clients.


23-23: LGTM: Proper client field addition.

Adding the HTTP client field enables timeout configuration for all beacon node requests.


43-43: LGTM: Consistent use of configured HTTP client.

All HTTP requests correctly use the timeout-configured client instead of the default client, ensuring proper timeout behavior.

Also applies to: 73-73, 117-117


102-102: LGTM: Proper client field initialization.

The client field is correctly assigned in the struct initialization.

colinlyguo
colinlyguo previously approved these changes May 27, 2025
@Thegaram Thegaram merged commit d8f4932 into develop May 28, 2025
14 checks passed
@Thegaram Thegaram deleted the feat-blob-client-timeout branch May 28, 2025 09:19
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.

3 participants