From ba52a8a30412e2fd3692e545ede569edba609038 Mon Sep 17 00:00:00 2001 From: yongthyuan <824149100@qq.com> Date: Sat, 7 Nov 2026 17:53:00 +0800 Subject: [PATCH] fix: close the owned stream in functional workflow agents (cherry picked from commit f61d1898842acd5db763ae1a8635f3ca0aca0343) --- .../agent_framework/_workflows/_functional.py | 1 + .../workflow/test_functional_workflow.py | 65 +++++++++++++++++++ 2 files changed, 66 insertions(+) diff --git a/python/packages/core/agent_framework/_workflows/_functional.py b/python/packages/core/agent_framework/_workflows/_functional.py index c628dc54d82..5bf49d7c76c 100644 --- a/python/packages/core/agent_framework/_workflows/_functional.py +++ b/python/packages/core/agent_framework/_workflows/_functional.py @@ -2944,6 +2944,7 @@ async def _generate_updates() -> AsyncIterable[AgentResponseUpdate]: return ResponseStream( _generate_updates(), finalizer=AgentResponse.from_updates, + cleanup_hooks=[workflow_stream.close], ) def _request_info_to_approval_request(self, event: WorkflowEvent[Any]) -> Any: diff --git a/python/packages/core/tests/workflow/test_functional_workflow.py b/python/packages/core/tests/workflow/test_functional_workflow.py index 7050b024b61..2c3271fbf4f 100644 --- a/python/packages/core/tests/workflow/test_functional_workflow.py +++ b/python/packages/core/tests/workflow/test_functional_workflow.py @@ -2561,6 +2561,71 @@ async def wf(x: int) -> str: response = await stream.get_final_response() assert len(response.messages) >= 1 + @pytest.mark.parametrize("consume", ["none", "first", "all"]) + async def test_as_agent_stream_close_releases_workflow(self, consume: str): + @built_workflow + async def wf(x: int) -> str: + return f"result: {x}" + + agent = wf.as_agent() + stream = agent.run(1, stream=True) + if consume == "first": + assert (await anext(stream)).text == "result: 1" + elif consume == "all": + assert (await stream.get_final_response()).text == "result: 1" + + await stream.close() + assert (await agent.run(2)).text == "result: 2" + + # Closing an old stream again must not release a newer run's guard. + next_stream = agent.run(3, stream=True) + try: + await stream.close() + with pytest.raises(RuntimeError, match="already running"): + await agent.run(4) + assert (await next_stream.get_final_response()).text == "result: 3" + finally: + await next_stream.close() + + @pytest.mark.parametrize("cancel", [False, True]) + async def test_as_agent_stream_failure_releases_workflow(self, cancel: bool): + started = asyncio.Event() + stopped = asyncio.Event() + + @built_workflow + async def wf(x: int) -> str: + if x == 1: + try: + started.set() + if cancel: + await asyncio.Event().wait() + raise ValueError("workflow failure") + finally: + stopped.set() + return f"result: {x}" + + agent = wf.as_agent() + stream = agent.run(1, stream=True) + pull = asyncio.create_task(anext(stream)) + try: + await asyncio.wait_for(started.wait(), timeout=5) + if cancel: + pull.cancel() + with pytest.raises(asyncio.CancelledError): + await pull + else: + with pytest.raises(ValueError, match="workflow failure"): + await pull + assert stopped.is_set() + await stream.close() + assert (await agent.run(2)).text == "result: 2" + finally: + if not pull.done(): + pull.cancel() + with suppress(asyncio.CancelledError): + await pull + await stream.close() + async def test_as_agent_has_id_and_description(self): @built_workflow(description="A test workflow") async def wf(x: int) -> int: