Skip to content

Commit 377306e

Browse files
BlueRaddishcopybara-github
authored andcommitted
fix: merge tracking headers regardless of casing
Merge #7471 Mixed-case User-Agent or X-Goog-Api-Client keys in caller-supplied headers are now folded into the lowercase tracking header keys rather than left as separate dictionary entries alongside them. PiperOrigin-RevId: 999776874
1 parent eff016d commit 377306e

4 files changed

Lines changed: 160 additions & 18 deletions

File tree

‎src/google/adk/tools/mcp_tool/mcp_session_manager.py‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1010,15 +1010,18 @@ def _merge_headers(
10101010
hasattr(self._connection_params, 'headers')
10111011
and self._connection_params.headers
10121012
):
1013-
base_headers = self._connection_params.headers.copy()
1013+
base_headers = {
1014+
key.lower() if key.lower() in _TRACKING_HEADER_NAMES else key: value
1015+
for key, value in self._connection_params.headers.items()
1016+
}
10141017

10151018
if additional_headers:
1016-
base_headers.update(additional_headers)
1019+
base_headers.update({
1020+
key.lower() if key.lower() in _TRACKING_HEADER_NAMES else key: value
1021+
for key, value in additional_headers.items()
1022+
})
10171023

1018-
return merge_tracking_headers({
1019-
key.lower() if key.lower() in _TRACKING_HEADER_NAMES else key: value
1020-
for key, value in base_headers.items()
1021-
})
1024+
return merge_tracking_headers(base_headers)
10221025

10231026
def _is_session_disconnected(self, session: ClientSession) -> bool:
10241027
"""Checks if a session is disconnected or closed.

‎src/google/adk/utils/_google_client_headers.py‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -62,19 +62,20 @@ def merge_tracking_headers(
6262
Returns:
6363
A dictionary of HTTP headers with tracking headers merged.
6464
"""
65-
new_headers = (headers or {}).copy()
66-
for key, tracking_header_value in get_tracking_headers(
67-
framework_label=framework_label
68-
).items():
69-
custom_value = new_headers.get(key, None)
70-
if not custom_value:
71-
new_headers[key] = tracking_header_value
72-
continue
73-
65+
tracking_headers = get_tracking_headers(framework_label=framework_label)
66+
new_headers = {
67+
key: value
68+
for key, value in (headers or {}).items()
69+
if key.lower() not in tracking_headers
70+
}
71+
for key, tracking_header_value in tracking_headers.items():
7472
# Merge tracking headers with existing headers and avoid duplicates.
7573
value_parts = tracking_header_value.split(" ")
76-
for custom_value_part in custom_value.split(" "):
77-
if custom_value_part not in value_parts:
78-
value_parts.append(custom_value_part)
74+
for header_key, custom_value in (headers or {}).items():
75+
if header_key.lower() != key or not custom_value:
76+
continue
77+
for custom_value_part in custom_value.split(" "):
78+
if custom_value_part not in value_parts:
79+
value_parts.append(custom_value_part)
7980
new_headers[key] = " ".join(value_parts)
8081
return new_headers

‎tests/unittests/tools/mcp_tool/test_mcp_session_manager.py‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -446,6 +446,85 @@ def test_merge_headers_keeps_custom_user_agent(self):
446446
assert merged["user-agent"].startswith("google-adk/")
447447
assert merged["user-agent"].endswith(" my-app/1.0")
448448

449+
@pytest.mark.parametrize(
450+
"base_headers, additional",
451+
[
452+
(
453+
{
454+
"user-agent": "base-client/1",
455+
"x-goog-api-client": "base-sdk/1",
456+
"X-Custom": "base",
457+
},
458+
{
459+
"user-agent": "extra-client/1",
460+
"x-goog-api-client": "extra-sdk/1",
461+
"X-Custom": "extra",
462+
},
463+
),
464+
(
465+
{
466+
"User-Agent": "base-client/1",
467+
"X-Goog-Api-Client": "base-sdk/1",
468+
"X-Custom": "base",
469+
},
470+
{
471+
"user-agent": "extra-client/1",
472+
"x-goog-api-client": "extra-sdk/1",
473+
"X-Custom": "extra",
474+
},
475+
),
476+
(
477+
{
478+
"user-agent": "base-client/1",
479+
"x-goog-api-client": "base-sdk/1",
480+
"X-Custom": "base",
481+
},
482+
{
483+
"User-Agent": "extra-client/1",
484+
"X-Goog-Api-Client": "extra-sdk/1",
485+
"X-Custom": "extra",
486+
},
487+
),
488+
(
489+
{
490+
"User-Agent": "base-client/1",
491+
"user-agent": "base-client/2",
492+
"X-Goog-Api-Client": "base-sdk/1",
493+
"x-goog-api-client": "base-sdk/2",
494+
"X-Custom": "base",
495+
},
496+
{
497+
"User-Agent": "extra-client/1",
498+
"X-Goog-Api-Client": "extra-sdk/1",
499+
"X-Custom": "extra",
500+
},
501+
),
502+
],
503+
)
504+
def test_merge_headers_additional_overrides_base_tracking_headers(
505+
self, base_headers, additional
506+
):
507+
"""Additional tracking headers replace base ones regardless of casing."""
508+
original_base = base_headers.copy()
509+
original_additional = additional.copy()
510+
manager = MCPSessionManager(
511+
SseConnectionParams(url="https://example.com/mcp", headers=base_headers)
512+
)
513+
514+
merged = manager._merge_headers(additional)
515+
516+
assert merged == merge_tracking_headers({
517+
"user-agent": "extra-client/1",
518+
"x-goog-api-client": "extra-sdk/1",
519+
"X-Custom": "extra",
520+
})
521+
assert "base-client/" not in merged["user-agent"]
522+
assert merged["user-agent"].endswith(" extra-client/1")
523+
assert "base-sdk/" not in merged["x-goog-api-client"]
524+
assert merged["x-goog-api-client"].endswith(" extra-sdk/1")
525+
assert base_headers == original_base
526+
assert additional == original_additional
527+
449528
def test_is_session_disconnected(self):
450529
"""Test session disconnection detection."""
451530
manager = MCPSessionManager(self.mock_stdio_connection_params)

‎tests/unittests/utils/test_google_client_headers.py‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616

1717
from google.adk import version
1818
from google.adk.utils import _google_client_headers
19+
import httpx
1920
import pytest
2021

2122
_EXPECTED_BASE_HEADER = (
@@ -79,6 +80,64 @@ def test_merge_tracking_headers(input_headers, expected_headers):
7980
assert headers == expected_headers
8081

8182

83+
@pytest.mark.parametrize(
84+
"user_agent_key, api_client_key",
85+
[
86+
("User-Agent", "X-Goog-Api-Client"),
87+
("USER-AGENT", "X-GOOG-API-CLIENT"),
88+
],
89+
)
90+
def test_merge_tracking_headers_merges_case_insensitively(
91+
user_agent_key, api_client_key
92+
):
93+
"""Each tracking header reaches the transport once with custom tokens kept."""
94+
input_headers = {
95+
user_agent_key: "custom-client/1",
96+
api_client_key: "custom-sdk/1",
97+
"X-Custom": "value",
98+
}
99+
100+
headers = _google_client_headers.merge_tracking_headers(input_headers)
101+
request = httpx.Request("GET", "https://example.test", headers=headers)
102+
103+
assert request.headers.get_list("user-agent") == [
104+
f"{_EXPECTED_BASE_HEADER} custom-client/1"
105+
]
106+
assert request.headers.get_list("x-goog-api-client") == [
107+
f"{_EXPECTED_BASE_HEADER} custom-sdk/1"
108+
]
109+
assert headers["X-Custom"] == "value"
110+
assert input_headers == {
111+
user_agent_key: "custom-client/1",
112+
api_client_key: "custom-sdk/1",
113+
"X-Custom": "value",
114+
}
115+
116+
117+
def test_merge_tracking_headers_preserves_all_case_aliases():
118+
"""Case aliases merge into one header field without losing custom tokens."""
119+
input_headers = {
120+
"User-Agent": f"first-client/1 shared/1 {_EXPECTED_BASE_HEADER}",
121+
"user-agent": "second-client/1 shared/1",
122+
"X-Goog-Api-Client": "first-sdk/1 shared/1",
123+
"x-goog-api-client": "second-sdk/1 shared/1",
124+
"X-Custom": "value",
125+
}
126+
original_headers = input_headers.copy()
127+
128+
headers = _google_client_headers.merge_tracking_headers(input_headers)
129+
request = httpx.Request("GET", "https://example.test", headers=headers)
130+
131+
assert request.headers.get_list("user-agent") == [
132+
f"{_EXPECTED_BASE_HEADER} first-client/1 shared/1 second-client/1"
133+
]
134+
assert request.headers.get_list("x-goog-api-client") == [
135+
f"{_EXPECTED_BASE_HEADER} first-sdk/1 shared/1 second-sdk/1"
136+
]
137+
assert headers["X-Custom"] == "value"
138+
assert input_headers == original_headers
139+
140+
82141
def test_get_tracking_http_options():
83142
"""get_tracking_http_options returns HttpOptions carrying tracking headers."""
84143
http_options = _google_client_headers.get_tracking_http_options()

0 commit comments

Comments
 (0)