Add User-Agent Header

Author: Jesus Terrazas

libraries/microsoft-agents-a365-runtime/microsoft_agents_a365/runtime/utility.py

@@ -8,14 +8,18 @@
 """
 
 from __future__ import annotations
+from importlib.metadata import version
 
+import platform
 import uuid
 from typing import Any, Optional
 
 import jwt
 
 
 class Utility:
+    _cached_version = None
+
     """
     Utility class providing common runtime operations for Agent 365.
 
@@ -80,3 +84,19 @@ def resolve_agent_identity(context: Any, auth_token: Optional[str]) -> str:
 
         # Fallback to extracting App ID from the auth token
         return Utility.get_app_id_from_token(auth_token)
+
+    @staticmethod
+    def get_user_agent_header(orchestrator: str = "") -> str:
+        if Utility._cached_version is None:
+            try:
+                Utility._cached_version = version("microsoft-agents-a365-runtime")
+                print("Successfully retrieved version")
+            except Exception:
+                Utility._cached_version = "unknown"
+
+        print(f"Utility._cached_version: {Utility._cached_version}")
+
+        orchestrator_part = f"; {orchestrator}" if orchestrator else ""
+        os_type = platform.system()
+        python_version = platform.python_version()
+        return f"Agent365SDK/{Utility._cached_version} ({os_type}; Python/{python_version}{orchestrator_part})"

tests/runtime/test_utility.py

@@ -8,8 +8,10 @@
 
 import jwt
 import pytest
+from pytest_mock import mocker
 from microsoft_agents_a365.runtime.utility import Utility
 
+import platform
 
 # Fixtures (Mocks and Helpers)
 @pytest.fixture
@@ -124,3 +126,21 @@ def test_resolve_agent_identity_exception_handling(create_test_jwt, mock_context
 
     result = Utility.resolve_agent_identity(context, token)
     assert result == "token-app-id"
+
+def test_get_user_agent_header_default():
+    """Test get_user_agent_header returns expected format with default orchestrator."""
+    # Patch version to a known value
+    Utility._cached_version = "1.2.3"
+    result = Utility.get_user_agent_header()
+    os_type = platform.system()
+    py_version = platform.python_version()
+    assert result.startswith(f"Agent365SDK/1.2.3 ({os_type}; Python/{py_version}")
+    assert ";" not in result.split("Python/")[1]  # No orchestrator
+
+def test_get_user_agent_header_with_orchestrator():
+    """Test get_user_agent_header includes orchestrator when provided."""
+    Utility._cached_version = "2.0.0"
+    orchestrator = "TestOrchestrator"
+    result = Utility.get_user_agent_header(orchestrator)
+    assert f"; {orchestrator}" in result
+    assert result.startswith("Agent365SDK/2.0.0 (")