fix(proxy): surface codex websocket loop failures in livez (#1727)

## Description

Codex `/v1/responses` WebSocket disconnects can trigger a known
`websockets` callback failure before `connection_made()` initializes
`recv_messages`. When that happens, the proxy process can stay alive
while `/livez` keeps advertising a clean healthy state. This change
contains that known callback failure in the proxy runtime, records loop
callback health, and makes `/livez` report the degraded state instead of
always returning a clean process-alive payload. Closes #1720

## Type of Change

- [x] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [ ] Documentation update
- [ ] Performance improvement
- [ ] Code refactoring (no functional changes)

## Changes Made

- Add a proxy-owned asyncio loop exception handler that recognizes the
known `websockets` `connection_lost` `ClientConnection.recv_messages`
`AttributeError`, records it in bounded runtime health state, and leaves
unrelated loop exceptions delegated to the previous or default handler.
- Extend `/livez` so the route remains cheap and unauthenticated while
reflecting recorded event-loop callback health instead of always
reporting a clean process-alive payload.
- Preserve existing Codex WebSocket relay, fallback, session
deregistration, and termination-cause behavior for normal handler-owned
failures.
- Add focused regression coverage for the known callback failure, the
negative-space delegation path, and the health route response after loop
callback degradation.

## Testing

- [x] Unit tests pass (`uv run pytest tests/test_proxy_healthchecks.py
tests/test_openai_codex_ws_lifecycle.py
tests/test_proxy_loop_exception_health.py -q`)
- [x] Linting passes (`uv run ruff check headroom/proxy/server.py
tests/test_proxy_healthchecks.py tests/test_openai_codex_ws_lifecycle.py
tests/test_proxy_loop_exception_health.py` and `uv run ruff format
--check headroom/proxy/server.py tests/test_proxy_healthchecks.py
tests/test_openai_codex_ws_lifecycle.py
tests/test_proxy_loop_exception_health.py`)
- [ ] Type checking passes (`uv run mypy headroom`)
- [x] New tests added for new functionality when applicable
- [ ] Manual testing performed

### Test Output

```text
uv run pytest tests/test_proxy_healthchecks.py tests/test_openai_codex_ws_lifecycle.py tests/test_proxy_loop_exception_health.py -q

============================= test session starts =============================
platform win32 -- Python 3.12.13, pytest-9.0.3, pluggy-1.6.0
rootdir: D:\Repos\headroom-pr-1720-responses-ws-livez-wedge
configfile: pyproject.toml
plugins: anyio-4.12.1, langsmith-0.9.3, asyncio-1.3.0, cov-7.0.0
asyncio: mode=Mode.AUTO, debug=False, asyncio_default_fixture_loop_scope=None, asyncio_default_test_loop_scope=function
collected 33 items

tests\test_proxy_healthchecks.py ............                            [ 36%]
tests\test_openai_codex_ws_lifecycle.py ...................              [ 93%]
tests\test_proxy_loop_exception_health.py ..                             [100%]

============================== warnings summary ===============================
.venv\Lib\site-packages\fastapi\testclient.py:1
  D:\Repos\headroom-pr-1720-responses-ws-livez-wedge\.venv\Lib\site-packages\fastapi\testclient.py:1: StarletteDeprecationWarning: Using `httpx` with `starlette.testclient` is deprecated; install `httpx2` instead.
    from starlette.testclient import TestClient as TestClient  # noqa

-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html
======================== 33 passed, 1 warning in 9.78s ========================

uv run ruff check headroom/proxy/server.py tests/test_proxy_healthchecks.py tests/test_openai_codex_ws_lifecycle.py tests/test_proxy_loop_exception_health.py

All checks passed!

uv run ruff format --check headroom/proxy/server.py tests/test_proxy_healthchecks.py tests/test_openai_codex_ws_lifecycle.py tests/test_proxy_loop_exception_health.py

4 files already formatted
```

## Real Behavior Proof

- Environment: Python proxy runtime with FastAPI TestClient, no external
OpenAI credentials required.
- Exact command / steps: invoke the installed loop exception handler
with an asyncio context matching `Connection.connection_lost` plus
`AttributeError("'ClientConnection' object has no attribute
'recv_messages'")`, then request `/livez`.
- Observed result: the known `websockets` callback failure is recorded
without delegating to the noisy default handler, `/livez` reports
degraded loop callback health (HTTP 503, `"status": "unhealthy"`,
`"alive": false`), and unrelated callback exceptions still reach the
delegated handler.
- Not tested: the nondeterministic upstream CPython or `websockets`
timing edge against a live network connection; the focused regression
pins the callback shape reported in #1720.

## Review Readiness

- [x] I have performed a self-review
- [x] This PR is ready for human review

## Checklist

- [x] My code follows the project's style guidelines
- [x] I have performed a self-review of my code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [x] I have added tests that prove my fix is effective or that my
feature works
- [x] New and existing unit tests pass locally with my changes
- [x] I have updated the CHANGELOG.md if applicable

## Additional Notes

`CHANGELOG.md` is release-managed from conventional commits, so this PR
does not edit it manually. The scope stays inside the proxy runtime and
Codex WebSocket dispatch path; it does not change compression, CCR,
provider-neutral pipeline behavior, or generic transform modules.
This commit is contained in:
Rod Boev 2026-07-03 16:33:55 -04:00 committed by GitHub
parent 188e382b44
commit ceae879e79
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 192 additions and 4 deletions

View file

@ -34,10 +34,11 @@ import os
import sys
import threading
import time
from collections.abc import Callable
from dataclasses import fields, is_dataclass, replace
from datetime import datetime, timezone
from pathlib import Path
from typing import TYPE_CHECKING, Any, Literal, cast
from typing import TYPE_CHECKING, Any, Literal, TypedDict, cast
if TYPE_CHECKING:
from ..backends.base import Backend
@ -446,6 +447,20 @@ logging.basicConfig(
)
logger = logging.getLogger("headroom.proxy")
LoopExceptionHandler = Callable[[asyncio.AbstractEventLoop, dict[str, Any]], object]
class LoopFailureDetails(TypedDict):
message: Any | None
exception: str | None
class LoopHealthState(TypedDict):
status: str
known_failures: int
last_known_failure: LoopFailureDetails | None
_MULTI_WORKER_CONFIG_ENV = "HEADROOM_PROXY_CONFIG_JSON"
# Env var that opts out of the Rust core deployment smoke test (Hotfix-A0).
@ -1922,6 +1937,20 @@ def _request_is_loopback(request: Request) -> bool:
return is_loopback_host(client_host) and is_loopback_host_header(host_header)
def _is_known_websocket_callback_failure(context: dict[str, Any]) -> bool:
"""Return True iff this exact websockets callback failure shape is observed."""
if (
context.get("message")
!= "Exception in callback Connection.connection_lost(ConnectionResetError())"
):
return False
exception = context.get("exception")
return (
isinstance(exception, AttributeError)
and str(exception) == "'ClientConnection' object has no attribute 'recv_messages'"
)
def create_app(config: ProxyConfig | None = None) -> FastAPI:
"""Create FastAPI application."""
if not FASTAPI_AVAILABLE:
@ -2051,6 +2080,7 @@ def create_app(config: ProxyConfig | None = None) -> FastAPI:
try:
try:
previous_handler = _install_loop_exception_handler()
# Startup
await proxy.startup()
if config.periodic_toin_stats_enabled:
@ -2079,6 +2109,17 @@ def create_app(config: ProxyConfig | None = None) -> FastAPI:
app.state.startup_error = str(exc)
raise
finally:
loop: asyncio.AbstractEventLoop | None
previous: LoopExceptionHandler | None
try:
loop = asyncio.get_running_loop()
previous = previous_handler
except RuntimeError:
loop = None
previous = app.state.previous_loop_exception_handler
if loop is not None:
loop.set_exception_handler(previous)
app.state.ready = False
# Shutdown
if _cc_reconciler is not None:
@ -2104,10 +2145,18 @@ def create_app(config: ProxyConfig | None = None) -> FastAPI:
version=__version__,
lifespan=lifespan,
)
loop_health_state: LoopHealthState = {
"status": "healthy",
"known_failures": 0,
"last_known_failure": None,
}
app.state.proxy = proxy
app.state.started_at = None
app.state.ready = False
app.state.startup_error = None
app.state.loop_callback_health = loop_health_state
app.state.loop_exception_handler = None
app.state.previous_loop_exception_handler = None
# Set by the lifespan startup smoke test (`_check_rust_core`). Default
# "missing" means lifespan hasn't run yet — anything reading /health
# before startup completes (rare; lifespan runs before the first
@ -2240,6 +2289,46 @@ def create_app(config: ProxyConfig | None = None) -> FastAPI:
},
}
def _loop_callback_payload() -> LoopHealthState:
return {
"status": loop_health_state["status"],
"known_failures": loop_health_state["known_failures"],
"last_known_failure": loop_health_state["last_known_failure"],
}
def _install_loop_exception_handler() -> LoopExceptionHandler | None:
try:
loop = asyncio.get_running_loop()
except RuntimeError:
return None
previous_handler = loop.get_exception_handler()
def _loop_exception_handler(
_loop: asyncio.AbstractEventLoop, context: dict[str, Any]
) -> None:
if _is_known_websocket_callback_failure(context):
loop_health_state["status"] = "unhealthy"
loop_health_state["known_failures"] += 1
loop_health_state["last_known_failure"] = {
"message": context.get("message"),
"exception": str(context.get("exception"))
if context.get("exception")
else None,
}
return
delegate_handler = app.state.previous_loop_exception_handler
if delegate_handler is not None:
delegate_handler(_loop, context)
return
_loop.default_exception_handler(context)
loop.set_exception_handler(_loop_exception_handler)
app.state.loop_exception_handler = _loop_exception_handler
app.state.previous_loop_exception_handler = previous_handler
return previous_handler
def _health_payload(*, include_config: bool) -> dict[str, Any]:
checks = _health_checks()
ready = all(check["ready"] for check in checks.values())
@ -2630,15 +2719,18 @@ def create_app(config: ProxyConfig | None = None) -> FastAPI:
# Health & Metrics
@app.get("/livez")
async def livez():
callback_state = _loop_callback_payload()
healthy = callback_state["status"] == "healthy"
return JSONResponse(
status_code=200,
status_code=200 if healthy else 503,
content={
"service": "headroom-proxy",
"status": "healthy",
"alive": True,
"status": "healthy" if healthy else "unhealthy",
"alive": healthy,
"version": __version__,
"timestamp": _iso_utc_now(),
"uptime_seconds": _uptime_seconds(),
"loop_health": callback_state,
},
)

View file

@ -0,0 +1,96 @@
"""Unit: event-loop callback handling for Codex WS disconnect regressions."""
from __future__ import annotations
import asyncio
from unittest.mock import MagicMock
import pytest
from fastapi.testclient import TestClient
from headroom.proxy.server import ProxyConfig, create_app
pytest.importorskip("fastapi")
pytest.importorskip("httpx")
def _known_loop_callback_context() -> dict[str, object]:
return {
"message": "Exception in callback Connection.connection_lost(ConnectionResetError())",
"exception": AttributeError("'ClientConnection' object has no attribute 'recv_messages'"),
}
def _make_client(app):
return TestClient(app, base_url="http://127.0.0.1", client=("127.0.0.1", 12345))
def test_livez_reports_known_websockets_callback_degradation():
config = ProxyConfig(
optimize=False,
cache_enabled=False,
rate_limit_enabled=False,
cost_tracking_enabled=False,
)
app = create_app(config)
with _make_client(app) as client:
before = client.get("/livez")
assert before.status_code == 200
assert before.json()["status"] == "healthy"
assert before.json()["alive"] is True
assert app.state.loop_exception_handler is not None
mock_loop = MagicMock(spec=asyncio.AbstractEventLoop)
app.state.loop_exception_handler(mock_loop, _known_loop_callback_context())
after = client.get("/livez")
assert after.status_code == 503
payload = after.json()
assert payload["status"] == "unhealthy"
assert payload["alive"] is False
loop_health = payload["loop_health"]
assert loop_health["status"] == "unhealthy"
assert loop_health["known_failures"] == 1
assert (
loop_health["last_known_failure"]["exception"]
== "'ClientConnection' object has no attribute 'recv_messages'"
)
def test_unrelated_loop_callback_is_delegated_to_previous_handler():
delegate_calls: list[dict[str, object]] = []
config = ProxyConfig(
optimize=False,
cache_enabled=False,
rate_limit_enabled=False,
cost_tracking_enabled=False,
)
app = create_app(config)
with _make_client(app) as client:
client.get("/livez")
assert app.state.loop_exception_handler is not None
def _previous(_loop: object, context: dict[str, object]) -> None:
delegate_calls.append(dict(context))
app.state.previous_loop_exception_handler = _previous
mock_loop = MagicMock(spec=asyncio.AbstractEventLoop)
app.state.loop_exception_handler(
mock_loop,
{
"message": "random callback failed",
"exception": RuntimeError("not known failure"),
},
)
assert len(delegate_calls) == 1
assert delegate_calls[0]["message"] == "random callback failed"
assert app.state.loop_callback_health["status"] == "healthy"
assert app.state.loop_callback_health["known_failures"] == 0
health = client.get("/livez").json()
assert health["status"] == "healthy"
assert health["alive"] is True