Skip to content

feat: add agent source tracking to user-agent header #508

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

Merged
KAJdev merged 2 commits into from
May 27, 2026
+43 −5
Merged

feat: add agent source tracking to user-agent header #508

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c05c437
feat: add agent source tracking to user-agent header
KAJdev May 26, 2026
09882b1
fix: use explicit env var set/restore in user agent tests
KAJdev May 26, 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
3 changes: 3 additions & 0 deletions runpod/user_agent.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ def construct_user_agent():
if integration_method:
ua_components.append(f"Integration/{integration_method}")

if os.getenv("CLAUDECODE") == "1":
ua_components.append("(via claude-code)")

user_agent = " ".join(ua_components)
return user_agent

Expand Down
45 changes: 40 additions & 5 deletions tests/test_user_agent.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,13 @@ def test_user_agent_without_integration(
self, mock_python_version, mock_machine, mock_release, mock_system
):
"""Test the User-Agent string without specifying an integration method."""
if "RUNPOD_UA_INTEGRATION" in os.environ:
del os.environ["RUNPOD_UA_INTEGRATION"]
saved = {k: os.environ.pop(k) for k in ("RUNPOD_UA_INTEGRATION", "CLAUDECODE") if k in os.environ}

expected_ua = f"RunPod-Python-SDK/{runpod_version} (Windows 10; AMD64) Language/Python 3.8.10" # pylint: disable=line-too-long
self.assertEqual(construct_user_agent(), expected_ua)

os.environ.update(saved)

assert mock_python_version.called
assert mock_machine.called
assert mock_release.called
Expand All @@ -34,22 +35,56 @@ def test_user_agent_without_integration(
@patch("runpod.user_agent.platform.release", return_value="5.4")
@patch("runpod.user_agent.platform.machine", return_value="x86_64")
@patch("runpod.user_agent.platform.python_version", return_value="3.9.5")
@patch.dict(os.environ, {"RUNPOD_UA_INTEGRATION": "SkyPilot"})
def test_user_agent_with_integration(
self, mock_python_version, mock_machine, mock_release, mock_system
):
"""Test the User-Agent string with an integration method specified."""
expected_ua = f"RunPod-Python-SDK/{runpod_version} (Linux 5.4; x86_64) Language/Python 3.9.5 Integration/SkyPilot" # pylint: disable=line-too-long

saved_claude = os.environ.pop("CLAUDECODE", None)
os.environ["RUNPOD_UA_INTEGRATION"] = "SkyPilot"

expected_ua = f"RunPod-Python-SDK/{runpod_version} (Linux 5.4; x86_64) Language/Python 3.9.5 Integration/SkyPilot" # pylint: disable=line-too-long
self.assertEqual(construct_user_agent(), expected_ua)

os.environ.pop("RUNPOD_UA_INTEGRATION")
if saved_claude is not None:
os.environ["CLAUDECODE"] = saved_claude

assert mock_python_version.called
assert mock_machine.called
assert mock_release.called
assert mock_system.called


@patch("runpod.user_agent.platform.system", return_value="Linux")
@patch("runpod.user_agent.platform.release", return_value="5.4")
@patch("runpod.user_agent.platform.machine", return_value="x86_64")
@patch("runpod.user_agent.platform.python_version", return_value="3.9.5")
def test_user_agent_with_claude_code(
self, mock_python_version, mock_machine, mock_release, mock_system
):
"""Test the User-Agent string includes claude-code agent tag."""
os.environ.pop("RUNPOD_UA_INTEGRATION", None)
os.environ["CLAUDECODE"] = "1"

expected_ua = f"RunPod-Python-SDK/{runpod_version} (Linux 5.4; x86_64) Language/Python 3.9.5 (via claude-code)"
self.assertEqual(construct_user_agent(), expected_ua)
os.environ.pop("CLAUDECODE", None)

@patch("runpod.user_agent.platform.system", return_value="Linux")
@patch("runpod.user_agent.platform.release", return_value="5.4")
@patch("runpod.user_agent.platform.machine", return_value="x86_64")
@patch("runpod.user_agent.platform.python_version", return_value="3.9.5")
def test_user_agent_without_claude_code(
self, mock_python_version, mock_machine, mock_release, mock_system
):
"""Test the User-Agent string excludes agent tag when env var is not set."""
saved = {k: os.environ.pop(k) for k in ("RUNPOD_UA_INTEGRATION", "CLAUDECODE") if k in os.environ}

ua = construct_user_agent()
self.assertNotIn("via claude-code", ua)

os.environ.update(saved)


if __name__ == "__main__":
unittest.main()