-
Notifications
You must be signed in to change notification settings - Fork 24
Fix async streaming hangs on dead connections #212
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 13 commits
e0a587a
abb4ba3
816f53c
5dd6ec2
e628977
6d3d2f7
461116b
af263c3
1550484
238e00f
d7714a8
84ecf1d
7b118b5
9bfd893
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -23,6 +23,9 @@ | |||||||||||||||||||||||||||
| import json | ||||||||||||||||||||||||||||
| import logging | ||||||||||||||||||||||||||||
| import os | ||||||||||||||||||||||||||||
| import sys | ||||||||||||||||||||||||||||
| import threading | ||||||||||||||||||||||||||||
| import time | ||||||||||||||||||||||||||||
| import uuid | ||||||||||||||||||||||||||||
| from typing import Any | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
|
|
@@ -51,6 +54,49 @@ | |||||||||||||||||||||||||||
| MAX_API_RETRY = 5 # Maximum number of consecutive API error retries | ||||||||||||||||||||||||||||
| TASK_RETRY_LIMIT = 3 # Maximum retry attempts for a failed task | ||||||||||||||||||||||||||||
| TASK_RETRY_BACKOFF = 10 # Initial backoff in seconds between task retries | ||||||||||||||||||||||||||||
| # Application-level backstop: kill a streaming run if no events yielded for 30 min. | ||||||||||||||||||||||||||||
| # Complements the TCP-level httpx.Timeout(read=300s) in agent.py which catches | ||||||||||||||||||||||||||||
| # dead sockets; this catches subtler hangs where the connection stays open but | ||||||||||||||||||||||||||||
| # the server (or async generator) stops producing events. | ||||||||||||||||||||||||||||
| STREAM_IDLE_TIMEOUT = 1800 | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| # Watchdog: a non-asyncio thread that force-kills the process if the event | ||||||||||||||||||||||||||||
| # loop stops making progress. Covers every hang variant (dead connections, | ||||||||||||||||||||||||||||
| # asyncio cleanup spin, MCP cleanup, etc.) because it runs outside asyncio. | ||||||||||||||||||||||||||||
| WATCHDOG_IDLE_TIMEOUT = int(os.environ.get("WATCHDOG_IDLE_TIMEOUT", "2100")) # 35 min default | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| _watchdog_last_activity = time.monotonic() | ||||||||||||||||||||||||||||
| _watchdog_lock = threading.Lock() | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| def watchdog_ping() -> None: | ||||||||||||||||||||||||||||
| """Call from any coroutine/callback to signal the process is alive.""" | ||||||||||||||||||||||||||||
| global _watchdog_last_activity | ||||||||||||||||||||||||||||
| with _watchdog_lock: | ||||||||||||||||||||||||||||
| _watchdog_last_activity = time.monotonic() | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| def _watchdog_thread(timeout: int) -> None: | ||||||||||||||||||||||||||||
| """Background thread: force-exit if no activity for *timeout* seconds.""" | ||||||||||||||||||||||||||||
| check_interval = min(60, max(1, timeout // 5)) | ||||||||||||||||||||||||||||
| while True: | ||||||||||||||||||||||||||||
| time.sleep(check_interval) | ||||||||||||||||||||||||||||
| with _watchdog_lock: | ||||||||||||||||||||||||||||
| idle = time.monotonic() - _watchdog_last_activity | ||||||||||||||||||||||||||||
| if idle > timeout: | ||||||||||||||||||||||||||||
| logging.error( | ||||||||||||||||||||||||||||
| f"Watchdog: no activity for {idle:.0f}s (limit {timeout}s) — " | ||||||||||||||||||||||||||||
| "force-exiting to prevent hang" | ||||||||||||||||||||||||||||
| ) | ||||||||||||||||||||||||||||
| sys.stderr.flush() | ||||||||||||||||||||||||||||
| sys.stdout.flush() | ||||||||||||||||||||||||||||
| os._exit(2) | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| def start_watchdog(timeout: int = WATCHDOG_IDLE_TIMEOUT) -> None: | ||||||||||||||||||||||||||||
| """Start the watchdog thread (idempotent, daemon thread).""" | ||||||||||||||||||||||||||||
| t = threading.Thread(target=_watchdog_thread, args=(timeout,), daemon=True) | ||||||||||||||||||||||||||||
| t.start() | ||||||||||||||||||||||||||||
|
Comment on lines
+99
to
+107
|
||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| def _resolve_model_config( | ||||||||||||||||||||||||||||
|
|
@@ -367,6 +413,7 @@ async def deploy_task_agents( | |||||||||||||||||||||||||||
| server_prompts=server_prompts, | ||||||||||||||||||||||||||||
| important_guidelines=important_guidelines, | ||||||||||||||||||||||||||||
| ) | ||||||||||||||||||||||||||||
| agent0 = None | ||||||||||||||||||||||||||||
| agent0 = TaskAgent( | ||||||||||||||||||||||||||||
| name=primary_name, | ||||||||||||||||||||||||||||
|
Comment on lines
421
to
428
|
||||||||||||||||||||||||||||
| instructions=prompt_with_handoff_instructions(system_prompt) if handoffs else system_prompt, | ||||||||||||||||||||||||||||
|
|
@@ -389,11 +436,41 @@ async def _run_streamed() -> None: | |||||||||||||||||||||||||||
| max_retry = MAX_API_RETRY | ||||||||||||||||||||||||||||
| rate_limit_backoff = RATE_LIMIT_BACKOFF | ||||||||||||||||||||||||||||
| while rate_limit_backoff: | ||||||||||||||||||||||||||||
| result = None | ||||||||||||||||||||||||||||
| try: | ||||||||||||||||||||||||||||
| result = agent0.run_streamed(prompt, max_turns=max_turns) | ||||||||||||||||||||||||||||
| async for event in result.stream_events(): | ||||||||||||||||||||||||||||
| if event.type == "raw_response_event" and isinstance(event.data, ResponseTextDeltaEvent): | ||||||||||||||||||||||||||||
| await render_model_output(event.data.delta, async_task=async_task, task_id=task_id) | ||||||||||||||||||||||||||||
| stream = None | ||||||||||||||||||||||||||||
| try: | ||||||||||||||||||||||||||||
| stream = result.stream_events() | ||||||||||||||||||||||||||||
| async_iter = stream.__aiter__() | ||||||||||||||||||||||||||||
| while True: | ||||||||||||||||||||||||||||
| try: | ||||||||||||||||||||||||||||
| event = await asyncio.wait_for( | ||||||||||||||||||||||||||||
| async_iter.__anext__(), | ||||||||||||||||||||||||||||
| timeout=STREAM_IDLE_TIMEOUT, | ||||||||||||||||||||||||||||
| ) | ||||||||||||||||||||||||||||
| except StopAsyncIteration: | ||||||||||||||||||||||||||||
| break | ||||||||||||||||||||||||||||
| except asyncio.TimeoutError: | ||||||||||||||||||||||||||||
| logging.error( | ||||||||||||||||||||||||||||
| f"Stream idle for {STREAM_IDLE_TIMEOUT}s — " | ||||||||||||||||||||||||||||
| "connection likely dead, raising APITimeoutError" | ||||||||||||||||||||||||||||
| ) | ||||||||||||||||||||||||||||
| raise APITimeoutError("Stream idle timeout exceeded") | ||||||||||||||||||||||||||||
| if event.type == "raw_response_event" and isinstance(event.data, ResponseTextDeltaEvent): | ||||||||||||||||||||||||||||
| watchdog_ping() | ||||||||||||||||||||||||||||
| await render_model_output(event.data.delta, async_task=async_task, task_id=task_id) | ||||||||||||||||||||||||||||
| finally: | ||||||||||||||||||||||||||||
| if stream is not None: | ||||||||||||||||||||||||||||
| aclose = getattr(stream, "aclose", None) | ||||||||||||||||||||||||||||
| if aclose is not None: | ||||||||||||||||||||||||||||
| await aclose() | ||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
| await aclose() | |
| try: | |
| await aclose() | |
| except Exception: | |
| logging.exception("Failed to close streamed response") |
Copilot
AI
Apr 9, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
After mcp_sessions.cancel(), the code does await mcp_sessions with no timeout. This can hang indefinitely if the session task suppresses cancellation during cleanup (it catches CancelledError inside its cleanup loop). Use a bounded wait (e.g., asyncio.wait_for(..., timeout=MCP_CLEANUP_TIMEOUT)) and log if cancellation doesn’t complete, so shutdown can’t re-hang in the cleanup path.
| await mcp_sessions | |
| except (asyncio.CancelledError, Exception): | |
| pass | |
| await asyncio.wait_for(mcp_sessions, timeout=MCP_CLEANUP_TIMEOUT) | |
| except asyncio.TimeoutError: | |
| logging.warning( | |
| "Timed out waiting for MCP session task cancellation after %s seconds", | |
| MCP_CLEANUP_TIMEOUT, | |
| ) | |
| except asyncio.CancelledError: | |
| pass | |
| except Exception: | |
| logging.exception("Exception while waiting for mcp session task cancellation") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The client read timeout is set to 300s while the runner’s
STREAM_IDLE_TIMEOUTis 1800s. Since these are two independent timeouts affecting streaming behavior, the effective idle-kill behavior can become unclear to maintainers and may not match the intended 30-minute threshold. Consider centralizing/documenting the relationship between these timeouts (or aligning them) so the configured behavior is unambiguous.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These are intentionally different — they guard different failure modes at different layers:
httpx.Timeout(read=300s)— TCP-level. Catches dead connections where the socket itself stops delivering bytes (CLOSE_WAIT). This is the first line of defense.STREAM_IDLE_TIMEOUT(1800s)— Application-level. Catches hangs where the connection is technically alive but no events arrive (e.g. the async generator is stuck, or the server stops sending SSE frames while keeping the connection open).The read timeout fires per individual socket read; the idle timeout fires when no complete event has been yielded for 30 minutes. In practice the httpx timeout catches most dead-connection cases and the idle timeout is a backstop for subtler hangs. I'll add a comment in the code clarifying the relationship.