Skip to content

Commit 501255c

Browse files
authored
fix: release reference count on non-terminal exit to prevent stale registry entries (a2aproject#1079)
Handles cases when producer finishes without reaching terminal task state, it's symmetrical to `ActiveTask.start` where the counter is increased on producer and consumer creation.
1 parent c0d64ef commit 501255c

2 files changed

Lines changed: 69 additions & 59 deletions

File tree

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

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -302,10 +302,6 @@ async def _handle_terminal_state(self, updated_task: Task) -> None:
302302
self.active_task._task_id,
303303
updated_task.status.state,
304304
)
305-
if not self.active_task._is_finished.is_set():
306-
async with self.active_task._lock:
307-
self.active_task._reference_count -= 1
308-
309305
self.active_task._is_finished.set()
310306
self.active_task._request_queue.shutdown(immediate=True)
311307

@@ -578,7 +574,8 @@ async def _run_consumer(self) -> None:
578574
self._is_finished.set()
579575
self._request_queue.shutdown(immediate=True)
580576
await self._event_queue_agent.close(immediate=True)
581-
577+
async with self._lock:
578+
self._reference_count -= 1
582579
logger.debug('Consumer[%s]: Finishing', self._task_id)
583580
await self._maybe_cleanup()
584581

‎tests/integration/test_scenarios.py‎

Lines changed: 67 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,32 @@ def build(self, request: Any) -> ServerCallContext:
101101
)
102102

103103

104+
class InputRequiredAgent(AgentExecutor):
105+
"""Test agent: 'start' -> INPUT_REQUIRED, anything else -> COMPLETED."""
106+
107+
async def execute(
108+
self, context: RequestContext, event_queue: EventQueue
109+
) -> None:
110+
message = context.message
111+
if message and message.parts and message.parts[0].text == 'start':
112+
task = new_task_from_user_message(message)
113+
task.status.state = TaskState.TASK_STATE_INPUT_REQUIRED
114+
await event_queue.enqueue_event(task)
115+
else:
116+
await event_queue.enqueue_event(
117+
TaskStatusUpdateEvent(
118+
task_id=context.task_id,
119+
context_id=context.context_id,
120+
status=TaskStatus(state=TaskState.TASK_STATE_COMPLETED),
121+
)
122+
)
123+
124+
async def cancel(
125+
self, context: RequestContext, event_queue: EventQueue
126+
) -> None:
127+
pass
128+
129+
104130
def agent_card():
105131
return AgentCard(
106132
name='Test Agent',
@@ -464,7 +490,7 @@ async def cancel(
464490
if streaming:
465491
with pytest.raises(
466492
InvalidParamsError,
467-
match='Task .* is already completed',
493+
match='Task .* is in terminal state',
468494
):
469495
await client.subscribe(
470496
SubscribeToTaskRequest(id=task.id)
@@ -1087,32 +1113,7 @@ async def cancel(
10871113
'streaming', [False, True], ids=['blocking', 'streaming']
10881114
)
10891115
async def test_scenario_resumption_from_interrupted(use_legacy, streaming):
1090-
class ResumingAgent(AgentExecutor):
1091-
async def execute(
1092-
self, context: RequestContext, event_queue: EventQueue
1093-
):
1094-
message = context.message
1095-
if message and message.parts and message.parts[0].text == 'start':
1096-
task = new_task_from_user_message(message)
1097-
task.status.state = TaskState.TASK_STATE_INPUT_REQUIRED
1098-
await event_queue.enqueue_event(task)
1099-
elif (
1100-
message
1101-
and message.parts
1102-
and message.parts[0].text == 'here is input'
1103-
):
1104-
task = new_task_from_user_message(message)
1105-
task.status.state = TaskState.TASK_STATE_COMPLETED
1106-
await event_queue.enqueue_event(task)
1107-
else:
1108-
raise ValueError('Unexpected message')
1109-
1110-
async def cancel(
1111-
self, context: RequestContext, event_queue: EventQueue
1112-
):
1113-
pass
1114-
1115-
handler = create_handler(ResumingAgent(), use_legacy)
1116+
handler = create_handler(InputRequiredAgent(), use_legacy)
11161117
client = await create_client(
11171118
handler, agent_card=agent_card(), streaming=streaming
11181119
)
@@ -1133,8 +1134,8 @@ async def cancel(
11331134
assert [get_state(event) for event in events1] == [
11341135
TaskState.TASK_STATE_INPUT_REQUIRED,
11351136
]
1136-
task_id = events1[0].status_update.task_id
1137-
context_id = events1[0].status_update.context_id
1137+
task_id = get_task_id(events1[0])
1138+
context_id = get_task_context_id(events1[0])
11381139

11391140
# Now send another message to resume
11401141
msg2 = Message(
@@ -1157,6 +1158,37 @@ async def cancel(
11571158
]
11581159

11591160

1161+
def test_input_required_followup_across_per_rpc_event_loops():
1162+
handler = create_handler(InputRequiredAgent(), use_legacy=False)
1163+
call_context = ServerCallContext(user=MockUser())
1164+
1165+
msg1 = Message(
1166+
message_id='msg-start', role=Role.ROLE_USER, parts=[Part(text='start')]
1167+
)
1168+
req1 = SendMessageRequest(
1169+
message=msg1,
1170+
configuration=SendMessageConfiguration(return_immediately=False),
1171+
)
1172+
result1 = asyncio.run(handler.on_message_send(req1, call_context))
1173+
assert isinstance(result1, Task)
1174+
assert result1.status.state == TaskState.TASK_STATE_INPUT_REQUIRED
1175+
1176+
msg2 = Message(
1177+
task_id=result1.id,
1178+
context_id=result1.context_id,
1179+
message_id='msg-resume',
1180+
role=Role.ROLE_USER,
1181+
parts=[Part(text='here is input')],
1182+
)
1183+
req2 = SendMessageRequest(
1184+
message=msg2,
1185+
configuration=SendMessageConfiguration(return_immediately=False),
1186+
)
1187+
result2 = asyncio.run(handler.on_message_send(req2, call_context))
1188+
assert isinstance(result2, Task)
1189+
assert result2.status.state == TaskState.TASK_STATE_COMPLETED
1190+
1191+
11601192
# Scenario: Auth required and side channel unblocking
11611193
# Migrated from: test_workflow_auth_required_side_channel in test_handler_comparison
11621194
@pytest.mark.timeout(2.0)
@@ -1811,31 +1843,10 @@ async def cancel(
18111843
async def test_restore_task_input_required_state(
18121844
use_legacy, streaming, subscribe_mode
18131845
):
1814-
class InputAgent(AgentExecutor):
1815-
async def execute(
1816-
self, context: RequestContext, event_queue: EventQueue
1817-
):
1818-
message = context.message
1819-
if message and message.parts and message.parts[0].text == 'start':
1820-
task = new_task_from_user_message(message)
1821-
task.status.state = TaskState.TASK_STATE_INPUT_REQUIRED
1822-
await event_queue.enqueue_event(task)
1823-
elif message and message.parts and message.parts[0].text == 'input':
1824-
await event_queue.enqueue_event(
1825-
TaskStatusUpdateEvent(
1826-
task_id=context.task_id,
1827-
context_id=context.context_id,
1828-
status=TaskStatus(state=TaskState.TASK_STATE_COMPLETED),
1829-
)
1830-
)
1831-
1832-
async def cancel(
1833-
self, context: RequestContext, event_queue: EventQueue
1834-
):
1835-
pass
1836-
18371846
task_store = InMemoryTaskStore()
1838-
handler1 = create_handler(InputAgent(), use_legacy, task_store=task_store)
1847+
handler1 = create_handler(
1848+
InputRequiredAgent(), use_legacy, task_store=task_store
1849+
)
18391850
client1 = await create_client(
18401851
handler1, agent_card=agent_card(), streaming=streaming
18411852
)
@@ -1859,7 +1870,9 @@ async def cancel(
18591870
)
18601871

18611872
# Restore task in a new handler (simulating server restart)
1862-
handler2 = create_handler(InputAgent(), use_legacy, task_store=task_store)
1873+
handler2 = create_handler(
1874+
InputRequiredAgent(), use_legacy, task_store=task_store
1875+
)
18631876
client2 = await create_client(
18641877
handler2, agent_card=agent_card(), streaming=streaming
18651878
)

0 commit comments

Comments
 (0)