Skip to content

Commit f666ba3

Browse files
fix(server): forward CancelTaskRequest.metadata to AgentExecutor.cancel (a2aproject#1416)
CancelTaskRequest carries a metadata field and all three client transports already send it, but it was dropped on the server before reaching AgentExecutor.cancel. RestDispatcher.on_cancel_task ignored the request body altogether, and both DefaultRequestHandlerV2 (through ActiveTask.cancel) and LegacyRequestHandler built RequestContext without passing the cancel request. This parses the optional body on POST /tasks/{id}:cancel (keeping empty bodies valid and path id authoritative), updates FastAPI OpenAPI schema accordingly, and passes CancelTaskRequest into RequestContext so context.metadata is available in AgentExecutor.cancel just like in execute. Fixes a2aproject#1415 Co-authored-by: Mateusz Iwaniuk <45974414+Iwaniukooo11@users.noreply.github.com>
1 parent 814628e commit f666ba3

15 files changed

Lines changed: 318 additions & 24 deletions

‎src/a2a/server/agent_execution/active_task.py‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@
7171
)
7272
from a2a.server.tasks import PushNotificationEvent
7373
from a2a.types.a2a_pb2 import (
74+
CancelTaskRequest,
7475
Message,
7576
Task,
7677
TaskArtifactUpdateEvent,
@@ -877,7 +878,11 @@ async def subscribe( # noqa: PLR0915
877878
await self._maybe_cleanup()
878879
self.schedule_idle_release()
879880

880-
async def cancel(self, call_context: ServerCallContext) -> Task:
881+
async def cancel(
882+
self,
883+
call_context: ServerCallContext,
884+
request: CancelTaskRequest | None = None,
885+
) -> Task:
881886
"""Cancels the running active task.
882887
883888
The returned task carries a terminal state, which is written to the
@@ -899,6 +904,7 @@ async def cancel(self, call_context: ServerCallContext) -> Task:
899904
task = await self._task_manager.get_task()
900905
request_context = RequestContext(
901906
call_context=call_context,
907+
request=request,
902908
task_id=self._task_id,
903909
context_id=task.context_id if task else None,
904910
task=task,

‎src/a2a/server/agent_execution/context.py‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
UUIDGenerator,
1111
)
1212
from a2a.types.a2a_pb2 import (
13+
CancelTaskRequest,
1314
Message,
1415
SendMessageConfiguration,
1516
SendMessageRequest,
@@ -29,19 +30,19 @@ class RequestContext:
2930
def __init__( # noqa: PLR0913
3031
self,
3132
call_context: ServerCallContext,
32-
request: SendMessageRequest | None = None,
33+
request: SendMessageRequest | CancelTaskRequest | None = None,
3334
task_id: str | None = None,
3435
context_id: str | None = None,
3536
task: Task | None = None,
3637
related_tasks: list[Task] | None = None,
3738
task_id_generator: IDGenerator | None = None,
3839
context_id_generator: IDGenerator | None = None,
39-
):
40+
) -> None:
4041
"""Initializes the RequestContext.
4142
4243
Args:
4344
call_context: The server call context associated with this request.
44-
request: The incoming `SendMessageRequest` request payload.
45+
request: The incoming `SendMessageRequest` or `CancelTaskRequest` payload.
4546
task_id: The ID of the task explicitly provided in the request or path.
4647
context_id: The ID of the context explicitly provided in the request or path.
4748
task: The existing `Task` object retrieved from the store, if any.
@@ -52,7 +53,10 @@ def __init__( # noqa: PLR0913
5253
if related_tasks is None:
5354
related_tasks = []
5455
self._call_context = call_context
55-
self._params = request
56+
self._request: SendMessageRequest | CancelTaskRequest | None = request
57+
self._params: SendMessageRequest | None = (
58+
None if isinstance(request, CancelTaskRequest) else request
59+
)
5660
self._task_id = task_id
5761
self._context_id = context_id
5862
self._current_task = task
@@ -149,10 +153,10 @@ def call_context(self) -> ServerCallContext:
149153
@property
150154
def metadata(self) -> dict[str, Any]:
151155
"""Metadata associated with the request, if available."""
152-
if self._params:
156+
if self._request:
153157
# MessageToDict recurses into nested Struct/ListValue fields;
154158
# dict would leak raw protobuf objects to callers.
155-
return json_format.MessageToDict(self._params.metadata)
159+
return json_format.MessageToDict(self._request.metadata)
156160
return {}
157161

158162
@property

‎src/a2a/server/request_handlers/default_request_handler.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ async def on_cancel_task(
244244
await self.agent_executor.cancel(
245245
RequestContext(
246246
call_context=context,
247-
request=None,
247+
request=params,
248248
task_id=task.id,
249249
context_id=task.context_id,
250250
task=task,

‎src/a2a/server/request_handlers/default_request_handler_v2.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -295,21 +295,21 @@ async def on_cancel_task( # noqa: D102
295295

296296
# This replica holds the task, running or waiting for input.
297297
if await self._active_task_registry.get(task_id) is not None:
298-
return await self._cancel_local(task_id, context)
298+
return await self._cancel_local(params, context)
299299

300300
# Running on another replica (or nowhere): record CANCELED in shared
301301
# state; the owner sees the version bump on its next save and aborts.
302302
return await self._cancel_remote(task_id, task, version, context)
303303

304304
async def _cancel_local(
305-
self, task_id: str, context: ServerCallContext
305+
self, params: CancelTaskRequest, context: ServerCallContext
306306
) -> Task:
307307
try:
308308
active_task = await self._active_task_registry.get_or_create(
309-
task_id, call_context=context, create_task_if_missing=False
309+
params.id, call_context=context, create_task_if_missing=False
310310
)
311311
try:
312-
result = await active_task.cancel(context)
312+
result = await active_task.cancel(context, request=params)
313313
finally:
314314
# get_or_create stopped the timer; a failed cancel leaves the task parked.
315315
active_task.schedule_idle_release()

‎src/a2a/server/routes/_proto_schema.py‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,18 @@
66
from google.protobuf.descriptor import Descriptor, FieldDescriptor
77
from google.protobuf.message import Message
88

9-
from a2a.types.a2a_pb2 import SendMessageRequest, TaskPushNotificationConfig
9+
from a2a.types.a2a_pb2 import (
10+
CancelTaskRequest,
11+
SendMessageRequest,
12+
TaskPushNotificationConfig,
13+
)
1014
from a2a.utils.proto_utils import _field_is_repeated
1115

1216

1317
REST_BODY_TYPES: dict[tuple[str, str], type[Message]] = {
1418
('/message:send', 'POST'): SendMessageRequest,
1519
('/message:stream', 'POST'): SendMessageRequest,
20+
('/tasks/{id}:cancel', 'POST'): CancelTaskRequest,
1621
('/tasks/{id}/pushNotificationConfigs', 'POST'): TaskPushNotificationConfig,
1722
}
1823

‎src/a2a/server/routes/fastapi_routes.py‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,13 +54,18 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
5454
}
5555

5656

57+
_OPTIONAL_REST_BODIES: frozenset[tuple[str, str]] = frozenset(
58+
{('/tasks/{id}:cancel', 'POST')}
59+
)
60+
61+
5762
def _request_body_extra(
58-
ref: dict[str, Any], description: str
63+
ref: dict[str, Any], description: str, *, required: bool = True
5964
) -> dict[str, Any]:
6065
return {
6166
'requestBody': {
6267
'description': description,
63-
'required': True,
68+
'required': required,
6469
'content': {'application/json': {'schema': ref}},
6570
},
6671
}
@@ -151,6 +156,7 @@ def add_a2a_routes_to_fastapi(
151156
key: _request_body_extra(
152157
message_schema(cls.DESCRIPTOR, components),
153158
f'A2A {cls.__name__}',
159+
required=key not in _OPTIONAL_REST_BODIES,
154160
)
155161
for key, cls in REST_BODY_TYPES.items()
156162
}

‎src/a2a/server/routes/rest_dispatcher.py‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -218,10 +218,12 @@ async def on_cancel_task(self, request: Request) -> Response:
218218

219219
@validate_version(constants.PROTOCOL_VERSION_1_0)
220220
async def _handler(context: ServerCallContext) -> a2a_pb2.Task:
221-
task_id = request.path_params['id']
222-
task = await self.request_handler.on_cancel_task(
223-
CancelTaskRequest(id=task_id), context
224-
)
221+
params = CancelTaskRequest()
222+
body = await request.body()
223+
if body.strip():
224+
proto_utils.parse_lenient(body, params)
225+
params.id = request.path_params['id']
226+
task = await self.request_handler.on_cancel_task(params, context)
225227
if task:
226228
return task
227229
raise TaskNotFoundError

‎tests/integration/test_end_to_end.py‎

Lines changed: 64 additions & 2 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 typing import NamedTuple
35

@@ -156,8 +158,19 @@ async def execute(self, context: RequestContext, event_queue: EventQueue):
156158
message=task_updater.new_agent_message([Part(text='done')]),
157159
)
158160

159-
async def cancel(self, context: RequestContext, event_queue: EventQueue):
160-
raise NotImplementedError('Cancellation is not supported')
161+
async def cancel(
162+
self, context: RequestContext, event_queue: EventQueue
163+
) -> None:
164+
assert context.task_id is not None
165+
assert context.context_id is not None
166+
task_updater = TaskUpdater(
167+
event_queue, context.task_id, context.context_id
168+
)
169+
await task_updater.cancel(
170+
message=task_updater.new_agent_message(
171+
[Part(text=json.dumps(context.metadata, sort_keys=True))]
172+
)
173+
)
161174

162175

163176
@pytest.fixture
@@ -831,3 +844,52 @@ async def test_end_to_end_extensions_propagation(transport_setups, streaming):
831844
response.message, Role.ROLE_AGENT, 'extensions echoed'
832845
)
833846
assert set(response.message.extensions) == set(SUPPORTED_EXTENSION_URIS)
847+
848+
849+
@pytest.mark.asyncio
850+
@pytest.mark.parametrize(
851+
'cancel_metadata',
852+
[
853+
pytest.param(
854+
{'reason': 'user_aborted', 'nested': {'retryable': False}},
855+
id='with_metadata',
856+
),
857+
pytest.param({}, id='without_metadata'),
858+
],
859+
)
860+
async def test_end_to_end_cancel_task_metadata_propagation(
861+
transport_setups: ClientSetup,
862+
cancel_metadata: dict[str, object],
863+
) -> None:
864+
"""Test CancelTaskRequest.metadata reaches AgentExecutor.cancel on all bindings."""
865+
client = transport_setups.client
866+
client._config.streaming = False
867+
868+
events = [
869+
event
870+
async for event in client.send_message(
871+
request=SendMessageRequest(
872+
message=Message(
873+
role=Role.ROLE_USER,
874+
message_id='msg-cancel-metadata',
875+
parts=[Part(text='Need input')],
876+
)
877+
)
878+
)
879+
]
880+
assert len(events) == 1
881+
parked_task = events[0].task
882+
assert parked_task.status.state == TaskState.TASK_STATE_INPUT_REQUIRED
883+
884+
cancel_req = (
885+
CancelTaskRequest(id=parked_task.id, metadata=cancel_metadata)
886+
if cancel_metadata
887+
else CancelTaskRequest(id=parked_task.id)
888+
)
889+
cancelled_task = await client.cancel_task(request=cancel_req)
890+
891+
assert cancelled_task.id == parked_task.id
892+
assert cancelled_task.status.state == TaskState.TASK_STATE_CANCELED
893+
assert json.loads(cancelled_task.status.message.parts[0].text) == (
894+
cancel_metadata
895+
)

‎tests/server/agent_execution/test_active_task.py‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
from a2a.server.tasks.push_notification_sender import PushNotificationSender
1616
from a2a.server.tasks.task_manager import TaskManager
1717
from a2a.types.a2a_pb2 import (
18+
CancelTaskRequest,
1819
Message,
1920
Task,
2021
TaskState,
@@ -131,6 +132,63 @@ async def execute_mock(req, q):
131132
agent_executor.cancel.assert_called_once()
132133
stop_event.set()
133134

135+
@pytest.mark.asyncio
136+
async def test_active_task_cancel_forwards_request_metadata(
137+
self,
138+
active_task: ActiveTask,
139+
agent_executor: Mock,
140+
request_context: Mock,
141+
task_manager: Mock,
142+
) -> None:
143+
"""Test ActiveTask.cancel passes CancelTaskRequest metadata to AgentExecutor.cancel."""
144+
started = asyncio.Event()
145+
stop_event = asyncio.Event()
146+
147+
async def execute_mock(
148+
_ctx: RequestContext, _queue: EventQueue
149+
) -> None:
150+
started.set()
151+
await stop_event.wait()
152+
153+
agent_executor.execute = AsyncMock(side_effect=execute_mock)
154+
agent_executor.cancel = AsyncMock()
155+
task_manager.get_task.side_effect = [
156+
Task(
157+
id='test-task-id',
158+
context_id='ctx-1',
159+
status=TaskStatus(state=TaskState.TASK_STATE_WORKING),
160+
)
161+
] * 5 + [
162+
Task(
163+
id='test-task-id',
164+
context_id='ctx-1',
165+
status=TaskStatus(state=TaskState.TASK_STATE_CANCELED),
166+
)
167+
] * 5
168+
169+
await active_task.enqueue_request(request_context)
170+
await active_task.start(
171+
call_context=ServerCallContext(), create_task_if_missing=True
172+
)
173+
await asyncio.wait_for(started.wait(), timeout=5)
174+
175+
cancel_req = CancelTaskRequest(
176+
id='test-task-id',
177+
metadata={'reason': 'user_aborted', 'actor': 'alice'},
178+
)
179+
await active_task.cancel(ServerCallContext(), request=cancel_req)
180+
181+
agent_executor.cancel.assert_awaited_once()
182+
cancel_ctx: RequestContext = agent_executor.cancel.call_args.args[0]
183+
assert cancel_ctx.metadata == {
184+
'reason': 'user_aborted',
185+
'actor': 'alice',
186+
}
187+
assert cancel_ctx.message is None
188+
assert cancel_ctx.task_id == 'test-task-id'
189+
assert cancel_ctx.context_id == 'ctx-1'
190+
stop_event.set()
191+
134192
@pytest.mark.asyncio
135193
async def test_active_task_cancel_producer_cancelled_on_cancellederror(
136194
self,

‎tests/server/agent_execution/test_context.py‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
from a2a.server.context import ServerCallContext
1010
from a2a.server.id_generator import IDGenerator
1111
from a2a.types.a2a_pb2 import (
12+
CancelTaskRequest,
1213
Message,
1314
SendMessageRequest,
1415
Task,
@@ -346,3 +347,49 @@ def test_extension_handling(self) -> None:
346347
context = RequestContext(call_context=call_context)
347348

348349
assert context.requested_extensions == {'foo', 'bar'}
350+
351+
def test_init_with_cancel_task_request_metadata(
352+
self, mock_task: Mock
353+
) -> None:
354+
"""Test RequestContext exposes metadata from CancelTaskRequest safely."""
355+
cancel_request = CancelTaskRequest(
356+
id=mock_task.id,
357+
metadata={
358+
'reason': 'user_aborted',
359+
'nested': {'attempt': 2, 'flags': ['urgent', 'manual']},
360+
},
361+
)
362+
context = RequestContext(
363+
call_context=ServerCallContext(),
364+
request=cancel_request,
365+
task_id=mock_task.id,
366+
context_id=mock_task.context_id,
367+
task=mock_task,
368+
)
369+
370+
assert context.metadata == {
371+
'reason': 'user_aborted',
372+
'nested': {'attempt': 2.0, 'flags': ['urgent', 'manual']},
373+
}
374+
assert context.message is None
375+
assert context.configuration is None
376+
assert context.get_user_input() == ''
377+
assert context.task_id == mock_task.id
378+
assert context.context_id == mock_task.context_id
379+
assert context.current_task == mock_task
380+
381+
def test_init_with_cancel_task_request_without_metadata(
382+
self, mock_task: Mock
383+
) -> None:
384+
"""Test RequestContext returns empty metadata when CancelTaskRequest has none."""
385+
cancel_request = CancelTaskRequest(id=mock_task.id)
386+
context = RequestContext(
387+
call_context=ServerCallContext(),
388+
request=cancel_request,
389+
task_id=mock_task.id,
390+
context_id=mock_task.context_id,
391+
task=mock_task,
392+
)
393+
394+
assert context.metadata == {}
395+
assert context.message is None

0 commit comments

Comments
 (0)