Skip to content

Commit de3b1d7

Browse files
fix: discard previous stream event aliases on model timeout (#5216)
1 parent fc4d832 commit de3b1d7

2 files changed

Lines changed: 74 additions & 1 deletion

File tree

‎src/agents/run_internal/model_retry.py‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -707,6 +707,7 @@ async def stream_response_with_retry(
707707

708708
while True:
709709
emitted_retry_unsafe_event = False
710+
event: TResponseStreamEvent | None = None
710711
stream: AsyncIterator[TResponseStreamEvent] | None = None
711712
stream_owner: asyncio.Task[None] | None = None
712713
deadline = asyncio.get_running_loop().time() + timeout if timeout is not None else None
@@ -817,11 +818,13 @@ async def stream_response_with_retry(
817818
except BaseException as error:
818819
if isinstance(error, ModelTimeoutError):
819820
# The timed owner has already been cancelled and drained. Do not retain its
820-
# task or result queues in the public timeout traceback frame.
821+
# task, result queues, or previous event in the public timeout traceback frame.
821822
stream = None
822823
stream_owner = None
823824
stream_requests = None
824825
stream_results = None
826+
event = None
827+
result_value = None
825828
if stream_owner is None:
826829
await _close_async_iterator_quietly(stream)
827830
if isinstance(error, asyncio.CancelledError | GeneratorExit):

‎tests/models/test_model_retry.py‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,10 @@
88
import httpx2
99
import pytest
1010
from openai import APIConnectionError, APIStatusError, BadRequestError
11+
from openai.types.responses import ResponseFunctionCallArgumentsDeltaEvent, ResponseTextDeltaEvent
1112
from pydantic import ValidationError
1213

14+
from agents import Agent, RunConfig, Runner
1315
from agents.exceptions import ModelTimeoutError
1416
from agents.items import ModelResponse, TResponseStreamEvent
1517
from agents.model_settings import ModelSettings
@@ -32,6 +34,7 @@
3234
retry_policy_retries_safe_transport_errors,
3335
)
3436
from agents.run_internal.model_retry import get_response_with_retry, stream_response_with_retry
37+
from agents.testing import ModelCall, ModelStep, ScriptedModel
3538
from agents.usage import Usage
3639
from tests.test_responses import get_text_message
3740

@@ -278,6 +281,73 @@ async def iterator() -> AsyncIterator[TResponseStreamEvent]:
278281
traceback = traceback.tb_next
279282

280283

284+
@pytest.mark.asyncio
285+
@pytest.mark.parametrize("payload_kind", ["text", "tool_arguments"])
286+
async def test_stream_timeout_discards_previous_event_from_retry_traceback(
287+
payload_kind: str,
288+
) -> None:
289+
sensitive_payload = "synthetic-sensitive-stream-payload"
290+
event: TResponseStreamEvent
291+
if payload_kind == "text":
292+
event = ResponseTextDeltaEvent(
293+
type="response.output_text.delta",
294+
delta=sensitive_payload,
295+
content_index=0,
296+
output_index=0,
297+
item_id="synthetic-item",
298+
sequence_number=0,
299+
logprobs=[],
300+
)
301+
else:
302+
event = ResponseFunctionCallArgumentsDeltaEvent(
303+
type="response.function_call_arguments.delta",
304+
delta=sensitive_payload,
305+
output_index=0,
306+
item_id="synthetic-item",
307+
sequence_number=0,
308+
)
309+
closed = asyncio.Event()
310+
311+
async def stream_events(_call: ModelCall) -> AsyncIterator[TResponseStreamEvent]:
312+
try:
313+
yield event
314+
await asyncio.Event().wait()
315+
finally:
316+
closed.set()
317+
318+
model = ScriptedModel([ModelStep.stream(stream_events)])
319+
result = Runner.run_streamed(
320+
Agent(name="test", model=model, model_settings=ModelSettings(timeout=0.05)),
321+
"synthetic-input",
322+
run_config=RunConfig(trace_include_sensitive_data=False),
323+
)
324+
delivered = []
325+
with pytest.raises(ModelTimeoutError) as exc_info:
326+
async for stream_event in result.stream_events():
327+
if stream_event.type == "raw_response_event":
328+
delivered.append(stream_event.data)
329+
330+
assert delivered == [event]
331+
assert event.delta == sensitive_payload
332+
assert closed.is_set()
333+
assert exc_info.value.timeout_seconds == 0.05
334+
assert exc_info.value.__cause__ is None
335+
assert exc_info.value.__context__ is None
336+
retry_frames = []
337+
traceback = exc_info.value.__traceback__
338+
while traceback is not None:
339+
if traceback.tb_frame.f_code is stream_response_with_retry.__code__:
340+
retry_frames.append(traceback.tb_frame)
341+
traceback = traceback.tb_next
342+
assert retry_frames
343+
for frame in retry_frames:
344+
# Only the retry wrapper's aliases are covered, not caller-owned run state.
345+
assert frame.f_locals.get("event") is None
346+
assert frame.f_locals.get("result_value") is None
347+
assert frame.f_locals.get("stream_owner") is None
348+
assert frame.f_locals.get("stream_results") is None
349+
350+
281351
@pytest.mark.asyncio
282352
async def test_model_timeout_cancels_blocked_cleanup_after_deadline() -> None:
283353
cleanup_started = asyncio.Event()

0 commit comments

Comments
 (0)