Skip to content

Commit 91929cd

Browse files
fix(client): rejections from unrecognized fields (a2aproject#1354)
# Description Closes a2aproject#1341 ## Issue According to [SPEC 5.7](https://a2a-protocol.org/latest/specification/#57-field-presence-and-optionality), SDK should ignore unrecognized fields ## Solution Introduced `parse_lenient` in `proto_util.py` which is a wrapper for incoming str/bytes/dict and returns correct structure with Parse(ignore_unknown_fields=True) or ParseDict(ignore_unknown_fields=True) ## Tests Introduced 2 new test: for `GetTaskRequest()` and `send_message_streaming` --------- Co-authored-by: mykytanetipa <mykytanetipa@google.com>
1 parent cdb4799 commit 91929cd

6 files changed

Lines changed: 229 additions & 26 deletions

File tree

‎src/a2a/client/transports/jsonrpc.py‎

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636
TaskPushNotificationConfig,
3737
)
3838
from a2a.utils.errors import JSON_RPC_ERROR_CODE_MAP
39+
from a2a.utils.proto_utils import parse_lenient
3940
from a2a.utils.telemetry import SpanKind, trace_class
4041

4142

@@ -82,7 +83,7 @@ async def send_message(
8283
json_rpc_response = JSONRPC20Response(**response_data)
8384
if json_rpc_response.error:
8485
raise self._create_jsonrpc_error(json_rpc_response.error)
85-
response: SendMessageResponse = json_format.ParseDict(
86+
response: SendMessageResponse = parse_lenient(
8687
json_rpc_response.result, SendMessageResponse()
8788
)
8889
return response
@@ -123,7 +124,7 @@ async def get_task(
123124
json_rpc_response = JSONRPC20Response(**response_data)
124125
if json_rpc_response.error:
125126
raise self._create_jsonrpc_error(json_rpc_response.error)
126-
response: Task = json_format.ParseDict(json_rpc_response.result, Task())
127+
response: Task = parse_lenient(json_rpc_response.result, Task())
127128
return response
128129

129130
async def list_tasks(
@@ -144,7 +145,7 @@ async def list_tasks(
144145
json_rpc_response = JSONRPC20Response(**response_data)
145146
if json_rpc_response.error:
146147
raise self._create_jsonrpc_error(json_rpc_response.error)
147-
response: ListTasksResponse = json_format.ParseDict(
148+
response: ListTasksResponse = parse_lenient(
148149
json_rpc_response.result, ListTasksResponse()
149150
)
150151
return response
@@ -167,7 +168,7 @@ async def cancel_task(
167168
json_rpc_response = JSONRPC20Response(**response_data)
168169
if json_rpc_response.error:
169170
raise self._create_jsonrpc_error(json_rpc_response.error)
170-
response: Task = json_format.ParseDict(json_rpc_response.result, Task())
171+
response: Task = parse_lenient(json_rpc_response.result, Task())
171172
return response
172173

173174
async def create_task_push_notification_config(
@@ -188,7 +189,7 @@ async def create_task_push_notification_config(
188189
json_rpc_response = JSONRPC20Response(**response_data)
189190
if json_rpc_response.error:
190191
raise self._create_jsonrpc_error(json_rpc_response.error)
191-
response: TaskPushNotificationConfig = json_format.ParseDict(
192+
response: TaskPushNotificationConfig = parse_lenient(
192193
json_rpc_response.result, TaskPushNotificationConfig()
193194
)
194195
return response
@@ -211,7 +212,7 @@ async def get_task_push_notification_config(
211212
json_rpc_response = JSONRPC20Response(**response_data)
212213
if json_rpc_response.error:
213214
raise self._create_jsonrpc_error(json_rpc_response.error)
214-
response: TaskPushNotificationConfig = json_format.ParseDict(
215+
response: TaskPushNotificationConfig = parse_lenient(
215216
json_rpc_response.result, TaskPushNotificationConfig()
216217
)
217218
return response
@@ -234,11 +235,8 @@ async def list_task_push_notification_configs(
234235
json_rpc_response = JSONRPC20Response(**response_data)
235236
if json_rpc_response.error:
236237
raise self._create_jsonrpc_error(json_rpc_response.error)
237-
response: ListTaskPushNotificationConfigsResponse = (
238-
json_format.ParseDict(
239-
json_rpc_response.result,
240-
ListTaskPushNotificationConfigsResponse(),
241-
)
238+
response: ListTaskPushNotificationConfigsResponse = parse_lenient(
239+
json_rpc_response.result, ListTaskPushNotificationConfigsResponse()
242240
)
243241
return response
244242

@@ -307,7 +305,7 @@ async def get_extended_agent_card(
307305
raise A2AClientError(
308306
f'Invalid response type: {type(json_rpc_response.result)}'
309307
)
310-
response: AgentCard = json_format.ParseDict(
308+
response: AgentCard = parse_lenient(
311309
json_rpc_response.result, AgentCard()
312310
)
313311

@@ -380,7 +378,7 @@ async def _send_stream_request(
380378
json_rpc_response = JSONRPC20Response.from_json(sse_data)
381379
if json_rpc_response.error:
382380
raise self._create_jsonrpc_error(json_rpc_response.error)
383-
response: StreamResponse = json_format.ParseDict(
381+
response: StreamResponse = parse_lenient(
384382
json_rpc_response.result, StreamResponse()
385383
)
386384
yield response

‎src/a2a/client/transports/rest.py‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
import httpx
88

9-
from google.protobuf.json_format import MessageToDict, Parse, ParseDict
9+
from google.protobuf.json_format import MessageToDict
1010

1111
from a2a.client.client import ClientCallContext
1212
from a2a.client.errors import A2AClientError
@@ -35,6 +35,7 @@
3535
TaskPushNotificationConfig,
3636
)
3737
from a2a.utils.errors import A2A_REASON_TO_ERROR, MethodNotFoundError
38+
from a2a.utils.proto_utils import parse_lenient
3839
from a2a.utils.telemetry import SpanKind, trace_class
3940

4041

@@ -119,7 +120,7 @@ async def send_message(
119120
context=context,
120121
json=MessageToDict(request),
121122
)
122-
response: SendMessageResponse = ParseDict(
123+
response: SendMessageResponse = parse_lenient(
123124
response_data, SendMessageResponse()
124125
)
125126
return response
@@ -162,7 +163,7 @@ async def get_task(
162163
context=context,
163164
params=params,
164165
)
165-
response: Task = ParseDict(response_data, Task())
166+
response: Task = parse_lenient(response_data, Task())
166167
return response
167168

168169
async def list_tasks(
@@ -183,7 +184,7 @@ async def list_tasks(
183184
context=context,
184185
params=params,
185186
)
186-
response: ListTasksResponse = ParseDict(
187+
response: ListTasksResponse = parse_lenient(
187188
response_data, ListTasksResponse()
188189
)
189190
return response
@@ -202,7 +203,7 @@ async def cancel_task(
202203
context=context,
203204
json=MessageToDict(request),
204205
)
205-
response: Task = ParseDict(response_data, Task())
206+
response: Task = parse_lenient(response_data, Task())
206207
return response
207208

208209
async def create_task_push_notification_config(
@@ -219,7 +220,7 @@ async def create_task_push_notification_config(
219220
context=context,
220221
json=MessageToDict(request),
221222
)
222-
response: TaskPushNotificationConfig = ParseDict(
223+
response: TaskPushNotificationConfig = parse_lenient(
223224
response_data, TaskPushNotificationConfig()
224225
)
225226
return response
@@ -246,7 +247,7 @@ async def get_task_push_notification_config(
246247
context=context,
247248
params=params,
248249
)
249-
response: TaskPushNotificationConfig = ParseDict(
250+
response: TaskPushNotificationConfig = parse_lenient(
250251
response_data, TaskPushNotificationConfig()
251252
)
252253
return response
@@ -271,7 +272,7 @@ async def list_task_push_notification_configs(
271272
context=context,
272273
params=params,
273274
)
274-
response: ListTaskPushNotificationConfigsResponse = ParseDict(
275+
response: ListTaskPushNotificationConfigsResponse = parse_lenient(
275276
response_data, ListTaskPushNotificationConfigsResponse()
276277
)
277278
return response
@@ -329,7 +330,7 @@ async def get_extended_agent_card(
329330
'GET', '/extendedAgentCard', request.tenant, context=context
330331
)
331332

332-
return ParseDict(response_data, AgentCard())
333+
return parse_lenient(response_data, AgentCard())
333334

334335
async def close(self) -> None:
335336
"""Closes the httpx client unless it is shared."""
@@ -397,7 +398,7 @@ async def _send_stream_request(
397398
json=json,
398399
**http_kwargs,
399400
):
400-
event: StreamResponse = Parse(sse_data, StreamResponse())
401+
event: StreamResponse = parse_lenient(sse_data, StreamResponse())
401402
yield event
402403

403404
async def _send_request(self, request: httpx.Request) -> dict[str, Any]:

‎src/a2a/utils/proto_utils.py‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@
1919

2020
import logging
2121

22-
from typing import TYPE_CHECKING, Any, TypedDict, cast
22+
from typing import TYPE_CHECKING, Any, TypeVar, TypedDict, cast
2323

2424
from google.api.field_behavior_pb2 import FieldBehavior, field_behavior
2525
from google.protobuf.descriptor import FieldDescriptor
26-
from google.protobuf.json_format import ParseDict
26+
from google.protobuf.json_format import Parse, ParseDict
2727
from google.protobuf.message import Message as ProtobufMessage
2828
from google.rpc import error_details_pb2
2929

@@ -53,6 +53,25 @@
5353
# Define Event type locally to avoid circular imports
5454
Event = Message | Task | TaskStatusUpdateEvent | TaskArtifactUpdateEvent
5555

56+
_MessageT = TypeVar('_MessageT', bound=ProtobufMessage)
57+
58+
59+
def parse_lenient(
60+
data: dict[str, Any] | str | bytes, message: _MessageT
61+
) -> _MessageT:
62+
"""Parses ProtoJSON into message, ignoring unrecognized fields.
63+
64+
Args:
65+
data: A decoded JSON object, or raw ProtoJSON text/bytes.
66+
message: The message to parse into. Mutated in place and returned.
67+
68+
Returns:
69+
The parsed message.
70+
"""
71+
if isinstance(data, str | bytes):
72+
return Parse(data, message, ignore_unknown_fields=True)
73+
return ParseDict(data, message, ignore_unknown_fields=True)
74+
5675

5776
def to_stream_response(event: Event) -> StreamResponse:
5877
"""Convert internal Event to StreamResponse proto.

‎tests/client/transports/test_jsonrpc_client.py‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -759,3 +759,72 @@ def test_json_parse_error_is_typed(self, transport) -> None:
759759
)
760760
assert isinstance(exc, JSONParseError)
761761
assert exc.message == 'Invalid JSON payload'
762+
763+
764+
class TestUnrecognizedResponseFields:
765+
"""Spec 5.7: unrecognized response fields are ignored (issue #1341)."""
766+
767+
@pytest.mark.asyncio
768+
async def test_get_task_ignores_unrecognized_fields(
769+
self, transport, mock_httpx_client
770+
):
771+
"""Unknown keys are skipped at every depth; known ones still parse."""
772+
mock_response = MagicMock()
773+
mock_response.json.return_value = {
774+
'jsonrpc': '2.0',
775+
'id': '1',
776+
'result': {
777+
'id': 'task-1',
778+
'contextId': 'ctx-1',
779+
'status': {
780+
'state': 'TASK_STATE_COMPLETED',
781+
'someNestedField': 'y',
782+
},
783+
'someNewField': 'x',
784+
},
785+
}
786+
mock_response.raise_for_status = MagicMock()
787+
mock_httpx_client.send.return_value = mock_response
788+
789+
task = await transport.get_task(GetTaskRequest(id='task-1'))
790+
791+
assert task.id == 'task-1'
792+
assert task.context_id == 'ctx-1'
793+
assert task.status.state == TaskState.TASK_STATE_COMPLETED
794+
795+
@pytest.mark.asyncio
796+
@patch('a2a.client.transports.http_helpers._SSEEventSource')
797+
async def test_send_message_streaming_ignores_unrecognized_fields(
798+
self, mock_sse_source: AsyncMock, transport
799+
):
800+
"""The streamed branch is as lenient as the unary one."""
801+
payload = {
802+
'jsonrpc': '2.0',
803+
'id': '1',
804+
'result': {
805+
'message': {
806+
'messageId': 'r1',
807+
'role': 'ROLE_AGENT',
808+
'parts': [{'text': 'hello'}],
809+
},
810+
'someNewField': 'x',
811+
},
812+
}
813+
mock_response = AsyncMock(spec=httpx.Response)
814+
mock_response.raise_for_status = MagicMock()
815+
mock_response.headers = {'content-type': 'text/event-stream'}
816+
mock_response.aiter_lines.return_value = async_iterable_from_list(
817+
[f'data: {json.dumps(payload)}', '']
818+
)
819+
mock_sse_source.return_value.__aenter__.return_value = mock_response
820+
821+
events = [
822+
event
823+
async for event in transport.send_message_streaming(
824+
create_send_message_request()
825+
)
826+
]
827+
828+
assert len(events) == 1
829+
assert events[0].message.message_id == 'r1'
830+
assert events[0].message.parts[0].text == 'hello'

‎tests/client/transports/test_rest_client.py‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import json
2+
13
from collections.abc import AsyncGenerator
24
from unittest.mock import AsyncMock, MagicMock, patch
35

@@ -748,3 +750,82 @@ async def test_rest_streaming_methods_prepend_tenant( # noqa: PLR0913
748750

749751
# url is 3rd positional argument in aconnect_sse(client, method, url, ...)
750752
assert args[2] == f'http://agent.example.com/api{expected_path}'
753+
754+
755+
class TestRestUnrecognizedResponseFields:
756+
"""Spec 5.7: unrecognized response fields are ignored (issue #1341)."""
757+
758+
@pytest.mark.asyncio
759+
async def test_get_task_ignores_unrecognized_fields(
760+
self, mock_httpx_client: AsyncMock, mock_agent_card: MagicMock
761+
):
762+
"""Unknown keys are skipped at every depth; known ones still parse."""
763+
client = RestTransport(
764+
httpx_client=mock_httpx_client,
765+
agent_card=mock_agent_card,
766+
url='http://agent.example.com/api',
767+
)
768+
mock_httpx_client.build_request = MagicMock(
769+
return_value=AsyncMock(spec=httpx.Request)
770+
)
771+
mock_response = AsyncMock(spec=httpx.Response)
772+
mock_response.raise_for_status = MagicMock()
773+
mock_response.json = MagicMock(
774+
return_value={
775+
'id': 'task-1',
776+
'contextId': 'ctx-1',
777+
'status': {
778+
'state': 'TASK_STATE_COMPLETED',
779+
'someNestedField': 'y',
780+
},
781+
'someNewField': 'x',
782+
}
783+
)
784+
mock_httpx_client.send.return_value = mock_response
785+
786+
task = await client.get_task(GetTaskRequest(id='task-1'))
787+
788+
assert task.id == 'task-1'
789+
assert task.context_id == 'ctx-1'
790+
assert task.status.state == TaskState.TASK_STATE_COMPLETED
791+
792+
@pytest.mark.asyncio
793+
@patch('a2a.client.transports.http_helpers._SSEEventSource')
794+
async def test_send_message_streaming_ignores_unrecognized_fields(
795+
self,
796+
mock_sse_source: AsyncMock,
797+
mock_httpx_client: AsyncMock,
798+
mock_agent_card: MagicMock,
799+
):
800+
"""This branch parses with Parse, not ParseDict, so it needs its own case."""
801+
client = RestTransport(
802+
httpx_client=mock_httpx_client,
803+
agent_card=mock_agent_card,
804+
url='http://agent.example.com/api',
805+
)
806+
payload = {
807+
'message': {
808+
'messageId': 'r1',
809+
'role': 'ROLE_AGENT',
810+
'parts': [{'text': 'hello'}],
811+
},
812+
'someNewField': 'x',
813+
}
814+
mock_response = AsyncMock(spec=httpx.Response)
815+
mock_response.raise_for_status = MagicMock()
816+
mock_response.headers = {'content-type': 'text/event-stream'}
817+
mock_response.aiter_lines.return_value = async_iterable_from_list(
818+
[f'data: {json.dumps(payload)}', '']
819+
)
820+
mock_sse_source.return_value.__aenter__.return_value = mock_response
821+
822+
events = [
823+
event
824+
async for event in client.send_message_streaming(
825+
SendMessageRequest(message=new_text_message(text='Hello'))
826+
)
827+
]
828+
829+
assert len(events) == 1
830+
assert events[0].message.message_id == 'r1'
831+
assert events[0].message.parts[0].text == 'hello'

0 commit comments

Comments
 (0)