Skip to content

Allow full control over User-Agent header #2492

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.

Sign up for GitHub

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

Open
teodordelibasic-db wants to merge 2 commits into
base: master
Choose a base branch
from
+8 −18
Open

Allow full control over User-Agent header #2492

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ad25dbf
tonic: skip user-agent if already set
teodordelibasic-db Feb 2, 2026
62de91a
Merge branch 'master' into skip-user-agent-if-set
nathanielford Sep 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 8 additions & 18 deletions tonic/src/transport/channel/service/user_agent.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,20 +63,10 @@ where
}

fn call(&mut self, mut req: Request<ReqBody>) -> Self::Future {
if let Ok(Some(user_agent)) = req
.headers_mut()
.try_insert(USER_AGENT, self.user_agent.clone())
{
// The User-Agent header has already been set on the request. Let's
// append our user agent to the end.
let mut buf = Vec::new();
buf.extend(user_agent.as_bytes());
buf.push(b' ');
buf.extend(self.user_agent.as_bytes());
req.headers_mut().insert(
USER_AGENT,
HeaderValue::from_bytes(&buf).expect("user-agent should be valid"),
);
// Only set user-agent if not already present on the request.
if !req.headers().contains_key(USER_AGENT) {
req.headers_mut()
.insert(USER_AGENT, self.user_agent.clone());
}

self.inner.call(req)
Expand Down Expand Up @@ -150,12 +140,12 @@ mod tests {
}

#[tokio::test]
async fn appends_default_user_agent_to_request_user_agent() {
async fn preserves_request_user_agent_with_default() {
let mut req = Request::default();
req.headers_mut()
.insert(USER_AGENT, HeaderValue::from_static("request-ua/x.y"));

let expected_user_agent = format!("request-ua/x.y {TONIC_USER_AGENT}");
let expected_user_agent = "request-ua/x.y".to_string();
let mut ua = UserAgent::new(
TestSvc {
expected_user_agent,
Expand All @@ -166,12 +156,12 @@ mod tests {
}

#[tokio::test]
async fn appends_custom_user_agent_to_request_user_agent() {
async fn preserves_request_user_agent_with_custom() {
let mut req = Request::default();
req.headers_mut()
.insert(USER_AGENT, HeaderValue::from_static("request-ua/x.y"));

let expected_user_agent = format!("request-ua/x.y Greeter 1.1 {TONIC_USER_AGENT}");
let expected_user_agent = "request-ua/x.y".to_string();
let mut ua = UserAgent::new(
TestSvc {
expected_user_agent,
Expand Down
Loading