encounter/adk-python
0
0
Fork 0
mirror of https://github.com/encounter/adk-python.git synced 2026-07-09 18:19:28 -07:00
Code Issues Packages Projects Releases Wiki Activity

fix: Fix logging issues with RemoteA2aAgent

Browse Source 
Recent change to the updated A2A Client SDK broke the logging utilities. This updates those logging utilities to work with the new A2A SDK structure.

PiperOrigin-RevId: 806482017
This commit is contained in:
Google Team Member
2025-09-12 17:20:04 -07:00
committed by Copybara-Service
parent bb148002f8
commit 0c1f1fadeb
3 changed files with 78 additions and 208 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/google/adk/a2a/logs/log_utils.py
+30 -54
View File
@@ -20,11 +20,10 @@ import json
import sys
try:
from a2a.client import ClientEvent as A2AClientEvent
from a2a.types import DataPart as A2ADataPart
from a2a.types import Message as A2AMessage
from a2a.types import Part as A2APart
from a2a.types import SendMessageRequest
from a2a.types import SendMessageResponse
from a2a.types import Task as A2ATask
from a2a.types import TextPart as A2ATextPart
except ImportError as e:
@@ -49,6 +48,16 @@ def _is_a2a_task(obj) -> bool:
return type(obj).__name__ == "Task" and hasattr(obj, "status")
def _is_a2a_client_event(obj) -> bool:
"""Check if an object is an A2A Client Event (Task, UpdateEvent) tuple."""
try:
return isinstance(obj, tuple) and _is_a2a_task(obj[0])
except (TypeError, AttributeError):
return (
hasattr(obj, "__getitem__") and len(obj) == 2 and _is_a2a_task(obj[0])
)
def _is_a2a_message(obj) -> bool:
"""Check if an object is an A2A Message, with fallback for isinstance issues."""
try:
@@ -114,7 +123,7 @@ def build_message_part_log(part: A2APart) -> str:
return part_content
def build_a2a_request_log(req: SendMessageRequest) -> str:
def build_a2a_request_log(req: A2AMessage) -> str:
"""Builds a structured log representation of an A2A request.
Args:
@@ -125,100 +134,70 @@ def build_a2a_request_log(req: SendMessageRequest) -> str:
"""
# Message parts logs
message_parts_logs = []
if req.params.message.parts:
for i, part in enumerate(req.params.message.parts):
if req.parts:
for i, part in enumerate(req.parts):
part_log = build_message_part_log(part)
# Replace any internal newlines with indented newlines to maintain formatting
part_log_formatted = part_log.replace("\n", "\n ")
message_parts_logs.append(f"Part {i}: {part_log_formatted}")
# Configuration logs
config_log = "None"
if req.params.configuration:
config_data = {
"accepted_output_modes": req.params.configuration.accepted_output_modes,
"blocking": req.params.configuration.blocking,
"history_length": req.params.configuration.history_length,
"push_notification_config": bool(
req.params.configuration.push_notification_config
),
}
config_log = json.dumps(config_data, indent=2)
# Build message metadata section
message_metadata_section = ""
if req.params.message.metadata:
if req.metadata:
message_metadata_section = f"""
Metadata:
{json.dumps(req.params.message.metadata, indent=2).replace(chr(10), chr(10) + ' ')}"""
{json.dumps(req.metadata, indent=2).replace(chr(10), chr(10) + ' ')}"""
# Build optional sections
optional_sections = []
if req.params.metadata:
if req.metadata:
optional_sections.append(
f"""-----------------------------------------------------------
Metadata:
{json.dumps(req.params.metadata, indent=2)}"""
{json.dumps(req.metadata, indent=2)}"""
)
optional_sections_str = _NEW_LINE.join(optional_sections)
return f"""
A2A Request:
-----------------------------------------------------------
Request ID: {req.id}
Method: {req.method}
JSON-RPC: {req.jsonrpc}
A2A Send Message Request:
-----------------------------------------------------------
Message:
ID: {req.params.message.message_id}
Role: {req.params.message.role}
Task ID: {req.params.message.task_id}
Context ID: {req.params.message.context_id}{message_metadata_section}
ID: {req.message_id}
Role: {req.role}
Task ID: {req.task_id}
Context ID: {req.context_id}{message_metadata_section}
-----------------------------------------------------------
Message Parts:
{_NEW_LINE.join(message_parts_logs) if message_parts_logs else "No parts"}
-----------------------------------------------------------
Configuration:
{config_log}
{optional_sections_str}
-----------------------------------------------------------
"""
def build_a2a_response_log(resp: SendMessageResponse) -> str:
def build_a2a_response_log(resp: A2AClientEvent | A2AMessage) -> str:
"""Builds a structured log representation of an A2A response.
Args:
resp: The A2A SendMessageResponse to log.
resp: The A2A SendMessage Response to log.
Returns:
A formatted string representation of the response.
"""
# Handle error responses
if hasattr(resp.root, "error"):
return f"""
A2A Response:
-----------------------------------------------------------
Type: ERROR
Error Code: {resp.root.error.code}
Error Message: {resp.root.error.message}
Error Data: {json.dumps(resp.root.error.data, indent=2) if resp.root.error.data else "None"}
-----------------------------------------------------------
Response ID: {resp.root.id}
JSON-RPC: {resp.root.jsonrpc}
-----------------------------------------------------------
"""
# Handle success responses
result = resp.root.result
result = resp
result_type = type(result).__name__
if result_type == "tuple":
result_type = "ClientEvent"
# Build result details based on type
result_details = []
if _is_a2a_task(result):
if _is_a2a_client_event(result):
result = result[0]
result_details.extend([
f"Task ID: {result.id}",
f"Context ID: {result.context_id}",
@@ -342,7 +321,4 @@ Status Message:
History:
{history_section}
-----------------------------------------------------------
Response ID: {resp.root.id}
JSON-RPC: {resp.root.jsonrpc}
-----------------------------------------------------------
"""
src/google/adk/agents/remote_a2a_agent.py
+10 -3
View File
@@ -492,9 +492,16 @@ class RemoteA2aAgent(BaseAgent):
event.custom_metadata[A2A_METADATA_PREFIX + "request"] = (
a2a_request.model_dump(exclude_none=True, by_alias=True)
)
event.custom_metadata[A2A_METADATA_PREFIX + "response"] = (
a2a_response.model_dump(exclude_none=True, by_alias=True)
)
# If the response is a ClientEvent, record the task state, otherwise
# record the message object.
if isinstance(a2a_response, tuple):
event.custom_metadata[A2A_METADATA_PREFIX + "response"] = (
a2a_response[0].model_dump(exclude_none=True, by_alias=True)
)
else:
event.custom_metadata[A2A_METADATA_PREFIX + "response"] = (
a2a_response.model_dump(exclude_none=True, by_alias=True)
)
yield event
tests/unittests/a2a/logs/test_log_utils.py
+38 -151
View File
@@ -138,34 +138,20 @@ class TestBuildMessagePartLog:
class TestBuildA2ARequestLog:
"""Test suite for build_a2a_request_log function."""
def test_request_with_parts_and_config(self):
"""Test request logging with message parts and configuration."""
def test_request_with_parts(self):
"""Test request logging of message parts."""
# Create mock request with all components
req = SendMessageRequest(
id="req-123",
method="message/send",
jsonrpc="2.0",
params=MessageSendParams(
message=A2AMessage(
message_id="msg-456",
role="user",
task_id="task-789",
context_id="ctx-101",
parts=[
A2APart(root=A2ATextPart(text="Part 1")),
A2APart(root=A2ATextPart(text="Part 2")),
],
metadata={"msg_key": "msg_value"},
),
configuration=MessageSendConfiguration(
accepted_output_modes=["text", "image"],
blocking=True,
history_length=10,
push_notification_config=None,
),
metadata={"key1": "value1"},
),
req = A2AMessage(
message_id="msg-456",
role="user",
task_id="task-789",
context_id="ctx-101",
parts=[
A2APart(root=A2ATextPart(text="Part 1")),
A2APart(root=A2ATextPart(text="Part 2")),
],
metadata={"msg_key": "msg_value"},
)
with patch(
@@ -176,61 +162,40 @@ class TestBuildA2ARequestLog:
result = build_a2a_request_log(req)
# Verify all components are present
assert "req-123" in result
assert "message/send" in result
assert "2.0" in result
assert "msg-456" in result
assert "user" in result
assert "task-789" in result
assert "ctx-101" in result
assert "Part 0:" in result
assert "Part 1:" in result
assert '"blocking": true' in result
assert '"history_length": 10' in result
assert '"key1": "value1"' in result
def test_request_without_parts(self):
"""Test request logging without message parts."""
req = Mock()
req.id = "req-123"
req.method = "message/send"
req.jsonrpc = "2.0"
req.params.message.message_id = "msg-456"
req.params.message.role = "user"
req.params.message.task_id = "task-789"
req.params.message.context_id = "ctx-101"
req.params.message.parts = None # No parts
req.params.message.metadata = None # No message metadata
req.params.configuration = None # No configuration
req.params.metadata = None # No metadata
req.message_id = "msg-456"
req.role = "user"
req.task_id = "task-789"
req.context_id = "ctx-101"
req.parts = None # No parts
req.metadata = None # No message metadata
result = build_a2a_request_log(req)
assert "No parts" in result
assert "Configuration:\nNone" in result
# When metadata is None, it's not included in the output
assert "Metadata:" not in result
def test_request_with_empty_parts_list(self):
"""Test request logging with empty parts list."""
req = Mock()
req.id = "req-123"
req.method = "sendMessage"
req.jsonrpc = "2.0"
req.params.message.message_id = "msg-456"
req.params.message.role = "user"
req.params.message.task_id = "task-789"
req.params.message.context_id = "ctx-101"
req.params.message.parts = [] # Empty parts list
req.params.message.metadata = None # No message metadata
req.params.configuration = None
req.params.metadata = None
req.message_id = "msg-456"
req.role = "user"
req.task_id = "task-789"
req.context_id = "ctx-101"
req.parts = [] # Empty parts list
req.metadata = None # No message metadata
result = build_a2a_request_log(req)
@@ -240,61 +205,19 @@ class TestBuildA2ARequestLog:
class TestBuildA2AResponseLog:
"""Test suite for build_a2a_response_log function."""
def test_error_response(self):
"""Test error response logging."""
resp = Mock()
resp.root.error.code = 500
resp.root.error.message = "Internal Server Error"
resp.root.error.data = {"details": "Something went wrong"}
resp.root.id = "resp-error"
resp.root.jsonrpc = "2.0"
result = build_a2a_response_log(resp)
assert "Type: ERROR" in result
assert "Error Code: 500" in result
assert "Internal Server Error" in result
assert '"details": "Something went wrong"' in result
assert "resp-error" in result
assert "2.0" in result
def test_error_response_no_data(self):
"""Test error response logging without error data."""
resp = Mock()
resp.root.error.code = 404
resp.root.error.message = "Not Found"
resp.root.error.data = None
resp.root.id = "resp-404"
resp.root.jsonrpc = "2.0"
result = build_a2a_response_log(resp)
assert "Type: ERROR" in result
assert "Error Code: 404" in result
assert "Not Found" in result
assert "Error Data: None" in result
def test_success_response_with_task(self):
def test_success_response_with_client_event(self):
"""Test success response logging with Task result."""
# Use module-level imported types consistently
task_status = TaskStatus(state=TaskState.working)
task = A2ATask(id="task-123", context_id="ctx-456", status=task_status)
resp = Mock()
resp.root.result = task
resp.root.id = "resp-789"
resp.root.jsonrpc = "2.0"
# Remove error attribute to ensure success path
delattr(resp.root, "error")
resp = (task, None)
result = build_a2a_response_log(resp)
assert "Type: SUCCESS" in result
assert "Result Type: Task" in result
assert "Result Type: ClientEvent" in result
assert "Task ID: task-123" in result
assert "Context ID: ctx-456" in result
# Handle both structured format and JSON fallback due to potential isinstance failures
@@ -327,13 +250,7 @@ class TestBuildA2AResponseLog:
artifacts=None,
)
resp = Mock()
resp.root.result = task
resp.root.id = "resp-789"
resp.root.jsonrpc = "2.0"
# Remove error attribute to ensure success path
delattr(resp.root, "error")
resp = (task, None)
result = build_a2a_response_log(resp)
@@ -359,13 +276,7 @@ class TestBuildA2AResponseLog:
parts=[A2APart(root=A2ATextPart(text="Message part 1"))],
)
resp = Mock()
resp.root.result = message
resp.root.id = "resp-101"
resp.root.jsonrpc = "2.0"
# Remove error attribute to ensure success path
delattr(resp.root, "error")
resp = message
result = build_a2a_response_log(resp)
@@ -395,13 +306,7 @@ class TestBuildA2AResponseLog:
message.parts = None # No parts
message.model_dump_json.return_value = '{"message": "empty"}'
resp = Mock()
resp.root.result = message
resp.root.id = "resp-empty"
resp.root.jsonrpc = "2.0"
# Remove error attribute to ensure success path
delattr(resp.root, "error")
resp = message
result = build_a2a_response_log(resp)
@@ -415,13 +320,7 @@ class TestBuildA2AResponseLog:
other_result.__class__.__name__ = "OtherResult"
other_result.model_dump_json.return_value = '{"other": "data"}'
resp = Mock()
resp.root.result = other_result
resp.root.id = "resp-other"
resp.root.jsonrpc = "2.0"
# Remove error attribute to ensure success path
delattr(resp.root, "error")
resp = other_result
result = build_a2a_response_log(resp)
@@ -438,13 +337,7 @@ class TestBuildA2AResponseLog:
# Don't add model_dump_json method
del other_result.model_dump_json
resp = Mock()
resp.root.result = other_result
resp.root.id = "resp-simple"
resp.root.jsonrpc = "2.0"
# Remove error attribute to ensure success path
delattr(resp.root, "error")
resp = other_result
result = build_a2a_response_log(resp)
@@ -473,19 +366,13 @@ class TestBuildA2AResponseLog:
"""Test request logging with message metadata."""
req = Mock()
req.id = "req-with-metadata"
req.method = "sendMessage"
req.jsonrpc = "2.0"
req.params.message.message_id = "msg-with-metadata"
req.params.message.role = "user"
req.params.message.task_id = "task-metadata"
req.params.message.context_id = "ctx-metadata"
req.params.message.parts = []
req.params.message.metadata = {"msg_type": "test", "priority": "high"}
req.params.configuration = None
req.params.metadata = None
req.message_id = "msg-with-metadata"
req.role = "user"
req.task_id = "task-metadata"
req.context_id = "ctx-metadata"
req.parts = []
req.metadata = {"msg_type": "test", "priority": "high"}
result = build_a2a_request_log(req)