User agent #82

JasoonS · 2025-10-27T20:46:07Z

Summary by CodeRabbit

New Features
- Clients can set a custom User-Agent for HTTP requests; the default User-Agent remains unchanged for users who don't configure it.
Chores
- Package version bumped to 0.20.0-rc.5.

coderabbitai · 2025-10-27T20:46:29Z

Walkthrough

Adds a configurable HTTP user-agent to the client API: introduces Client::new_with_agent(cfg, user_agent) and an internal new_internal(cfg, user_agent) that set the reqwest client's user-agent; Client::new(cfg) delegates to the internal constructor using default "hscr/<version>". Bumps crate version to 0.20.0-rc.5.

Changes

Cohort / File(s)	Summary
Client API & constructors `hypersync-client/src/lib.rs`	Adds `pub fn new_with_agent(cfg, user_agent: impl Into<String>) -> Result<Self>` and an internal `new_internal(cfg, user_agent)`; refactors `new(cfg)` to call `new_internal` and sets the reqwest client's `.user_agent(...)` (default `"hscr/<version>"` or provided agent).
Manifest version bump `hypersync-client/Cargo.toml`	Updates `package.version` from `0.20.0-rc.3` to `0.20.0-rc.5`.

Sequence Diagram(s)

sequenceDiagram
    actor Caller
    participant ClientAPI as Client API
    participant Internal as new_internal
    participant Reqwest as reqwest::ClientBuilder

    rect rgba(230,240,255,0.5)
    Caller->>ClientAPI: Client::new(cfg)
    note right of ClientAPI: Delegates with default UA\n"hscr/<version>"
    ClientAPI->>Internal: new_internal(cfg, default_ua)
    end

    alt Custom user-agent
        Caller->>ClientAPI: Client::new_with_agent(cfg, ua)
        ClientAPI->>Internal: new_internal(cfg, ua)
    end

    Internal->>Reqwest: ClientBuilder::new()
    Internal->>Reqwest: .user_agent(ua)
    Reqwest-->>Internal: built Client
    Internal-->>Caller: Client { http_client, ... }

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Check that user_agent is applied to the reqwest client in all construction paths.
Verify the default "hscr/<version>" is correctly derived (build-time or cargo env).
Confirm visibility and docs for the new public method.

Poem

A rabbit taps the keyboard light,
"Set headers true — both day and night."
New agent hops into the stream,
Default or custom, pick your theme.
Version raised, the package sings,
Soft paws push new networking wings.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'User agent' directly corresponds to the main change in the PR, which adds public API for creating a client with a custom user-agent via new_with_agent() method.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch user-agent

📜 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 123ecc5 and f435eb4.

📒 Files selected for processing (1)

hypersync-client/Cargo.toml (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

hypersync-client/Cargo.toml

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

GitHub Check: Publish to crates.io
GitHub Check: test_release
GitHub Check: test_dev

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

hypersync-client/src/lib.rs (1)
79-84: Consider propagating the build error instead of unwrapping.

With the new custom user agent feature, invalid user agent strings (containing characters not allowed in HTTP headers) could now cause a panic at line 84. Since Client::new already returns Result<Self>, consider propagating the error for more graceful handling.

Apply this diff to handle the error:
         let http_client = reqwest::Client::builder()
             .no_gzip()
             .timeout(Duration::from_millis(timeout.get()))
             .user_agent(user_agent)
             .build()
-            .unwrap();
+            .context("build http client")?;

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f91c16a and 6d63e6a.

📒 Files selected for processing (2)

hypersync-client/src/config.rs (1 hunks)
hypersync-client/src/lib.rs (1 hunks)

🧰 Additional context used

🧬 Code graph analysis (1)

hypersync-client/src/lib.rs (1)

hypersync-client/src/config.rs (1)

user_agent (37-39)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

GitHub Check: lint
GitHub Check: test_release
GitHub Check: test_dev

🔇 Additional comments (3)

hypersync-client/src/config.rs (2)

24-27: LGTM! Good encapsulation and serde configuration.

The private field with skip_serializing_if is appropriate for optional configuration. The crate-private accessor provides controlled access while keeping the field encapsulated.

29-40: LGTM! Idiomatic builder pattern and accessor.

The implementation follows Rust best practices:

Builder-style setter with impl Into<String> for flexibility

Crate-private accessor returns borrowed &str to avoid allocations

Clear documentation about intended use for language bindings

hypersync-client/src/lib.rs (1)

73-77: LGTM! Clear default user agent with helpful comment.

The fallback logic is well-implemented with a sensible default format that includes the library version. The comment explaining the "hscr" abbreviation is helpful.

JasoonS · 2025-10-28T11:36:47Z

hypersync-client/src/config.rs

+    /// Custom user agent string for HTTP requests.
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    #[doc(hidden)]
+    pub user_agent: Option<String>,


hidden from documentation, making it "somewhat hidden"

I tried making it not public, but that wasn't really possible due to the structure of how you create the client.

But it'll allow me to override it for the typescript/python and hyperindex. Will still test that out.

I should make an rc release.

I don't really understand...

Do you want to be able to set this externally? Like from the nodejs client for eg?

I think if it's not part of public cfg, rather add it as a parameter on the Client. So for eg, have an internal function like "new_internal" which takes the cfg and the user agent.

Then make "new" call this fn with the defaulted user agent. And have another fn called "new_with_agent" which passes in a custom agent.

Just saw these messages now, to do that we'll need to make another struct.

With this it hides it from any generated docs, and LSP:

Here for example without the config:
I

Drafting up an alternative, but there will still be an option exposed to users to edit the user_agent one way or another...

coderabbitai

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 06586aa and e718098.

📒 Files selected for processing (1)

hypersync-client/Cargo.toml (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

GitHub Check: Publish to crates.io
GitHub Check: lint
GitHub Check: test_release
GitHub Check: test_dev

hypersync-client/Cargo.toml

JasoonS · 2025-10-29T15:17:48Z

Will sort out merge conflicts still when I bump the version at the end 👍

JonoPrest

Can you rebase onto main and add it as an rc.3 rather than your own side release?

Also have a slight opinion on keeping user agent out of the Config struct if its not really meant to be public.

JasoonS · 2025-11-07T13:30:20Z

Also have a slight opinion on keeping user agent out of the Config struct if its not really meant to be public.

It was challenging making it internal, but also easy to modify for the python/node and hyperindex clients.

JasoonS · 2025-11-07T13:38:46Z

hypersync-client/src/config.rs

    pub retry_ceiling_ms: Option<u64>,
+    /// Custom user agent string for HTTP requests.
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    #[doc(hidden)]


@JonoPrest - this at least hides this from any generated docs.

…tion

… of full name

…ional client initialization for this

hypersync-client/Cargo.toml

coderabbitai bot reviewed Oct 27, 2025

View reviewed changes

JasoonS commented Oct 28, 2025

View reviewed changes

coderabbitai bot reviewed Oct 28, 2025

View reviewed changes

hypersync-client/Cargo.toml Outdated Show resolved Hide resolved

JasoonS requested a review from JonoPrest October 29, 2025 15:16

JonoPrest reviewed Oct 29, 2025

View reviewed changes

JasoonS commented Nov 7, 2025

View reviewed changes

JasoonS added 5 commits November 7, 2025 15:40

basic user-agent config

80f604f

make the user_agent non public on the client config, use builder func…

426be94

…tion

Update user agent format in client to use abbreviation "hscr" instead…

1c31249

… of full name

Make the user agent abreviated

e6c2f91

Update version for publish

2f397cc

JasoonS force-pushed the user-agent branch from e718098 to 2f397cc Compare November 7, 2025 13:41

Refactor ClientConfig to remove public user agent field and add addit…

123ecc5

…ional client initialization for this

JasoonS commented Nov 7, 2025

View reviewed changes

hypersync-client/Cargo.toml Outdated Show resolved Hide resolved

Apply suggestions from code review

f435eb4

User agent #82

Are you sure you want to change the base?

User agent #82

Conversation

JasoonS commented Oct 27, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Oct 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Poem

Pre-merge checks and finishing touches

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

JasoonS Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

JasoonS Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

JonoPrest Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

JonoPrest Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

JasoonS Nov 7, 2025

Choose a reason for hiding this comment

Uh oh!

JasoonS Nov 7, 2025

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

JasoonS commented Oct 29, 2025

Uh oh!

JonoPrest left a comment

Choose a reason for hiding this comment

Uh oh!

JasoonS commented Nov 7, 2025

Uh oh!

JasoonS Nov 7, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

JasoonS commented Oct 27, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 27, 2025 •

edited

Loading