headroom/tests/test_mid_turn_steering.py
wzy-del c365c7ff81
fix(proxy): only queue mid-turn messages for opt-in clients with explicit session header (#1951)
## Description

Mid-turn steering wrongly queues **concurrent independent streams**.
When two streaming `/v1/messages` requests share the same model + system
prompt and arrive concurrently (no `x-headroom-session-id` header), the
proxy misclassifies the second as a "mid-turn message", returns `202
{"event":"headroom_queued"}`, and never forwards it upstream. A standard
Anthropic SDK client that made a *streaming* call receives a non-SSE 202
→ empty event stream → `AssertionError` (`assert
self.__final_message_snapshot is not None` in
`anthropic/lib/streaming/_messages.py`), and fails after retries.

**Root cause.** Without an `x-headroom-session-id` header,
`_get_session_key()` falls back to `md5(model + system[:500])` (mirrors
`prefix_tracker.compute_session_id`). That key is intentionally coarse
and cannot distinguish genuinely concurrent, independent streams that
share a model + system prompt (e.g. a main conversation plus its
background / parallel requests), so the second stream hits `session_key
in self._active_streams` and gets queued.

A queued message is only ever drained back to the client via the custom
`headroom_pending_messages` SSE event, which a standard Anthropic SDK
does not understand — so mid-turn steering is effectively a private
protocol for clients that **opt in** via `x-headroom-session-id`. A
client that never sends the header can never participate in the queue;
for it, the 202 is simply a broken streaming response.

Note: "send a unique header per request" is **not** a workaround — the
same header also drives `prefix_tracker.compute_session_id()`, so
unique-per-stream ids break prompt caching while a shared id keeps
colliding.

Closes #1949

## 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 `StreamingMixin._should_queue_mid_turn()` helper that gates
mid-turn queuing behind an explicit `x-headroom-session-id` header.
- Header-less concurrent streams are now forwarded upstream normally;
only opt-in (header-bearing) callers can be queued.
- Prefix-tracker / cache-alignment behavior is untouched — the header
still drives `compute_session_id()` exactly as before.

## Testing

- [x] Unit tests pass (`pytest`)
- [x] Linting passes (`ruff check .`)
- [ ] Type checking passes (`mypy headroom`)
- [x] New tests added for new functionality
- [ ] Manual testing performed

### Test Output

```text
$ pytest tests/test_mid_turn_steering.py
6 passed
```

New test `test_should_queue_only_with_explicit_session_header`: a
header-less concurrent stream must not queue; an explicit-header opt-in
must. All existing `test_mid_turn_steering.py` cases pass an explicit
header and are unaffected.

## Real Behavior Proof

- Environment: macOS, `headroom-ai` 0.30.0 (installed via `uv tool`),
proxy running `headroom proxy --port 8799 --no-http2 --mode cache`,
upstream = an Anthropic-compatible gateway. Client = Hermes Agent
(Anthropic SDK, streaming) driving a main conversation plus concurrent
background/parallel requests that share the same model + system prompt.
- Exact command / steps:
1. Reproduce on stock 0.30.0: concurrent streaming requests without
`x-headroom-session-id` → second stream returns `202
{"event":"headroom_queued"}` → client raises `AssertionError` in
`anthropic/lib/streaming/_messages.py`.
2. Correlate logs: count of `AssertionError` in the client error log vs
count of `202` in the proxy access log for the window — **48 == 48**,
timestamps line up 1:1.
3. Apply this patch to the running package, restart the proxy, re-run
the same concurrent workload.
- Observed result: after the fix, **0 × 202 / all requests 200**, no new
`AssertionError`, and `cache_hit_pct` stayed ~99% (prefix caching
intact). Header-bearing opt-in clients still queue mid-turn as before.
- Not tested: behavior under a client that deliberately sends a
*changing* `x-headroom-session-id` per request (out of scope —
documented as a caching anti-pattern, not a supported mode).

## 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
- [x] 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
- [ ] I have updated the CHANGELOG.md if applicable

## Additional Notes

- Docs / CHANGELOG unchanged: this is a proxy-internal correctness fix
with no user-facing config surface.
- The fix is deliberately minimal and conservative — it only narrows
*when* queuing engages (explicit opt-in header), leaving the
prefix-tracker, cache-alignment, and body-rewrite paths byte-for-byte
identical.

---------

Co-authored-by: JerrettDavis <mxjerrett@gmail.com>
2026-07-13 00:52:41 -04:00

203 lines
8.2 KiB
Python

import asyncio
from unittest.mock import AsyncMock, MagicMock
import httpx
import pytest
from headroom.proxy.server import HeadroomProxy
class TestMidTurnSteering:
def test_mid_turn_queue_exists_on_streaming_mixin(self):
"""StreamingMixin has _mid_turn_queues class attribute after the fix."""
from headroom.proxy.handlers.streaming import StreamingMixin
assert hasattr(StreamingMixin, "_mid_turn_queues")
assert hasattr(StreamingMixin, "_active_streams")
def test_mid_turn_message_queued_when_stream_active(self):
"""When a session has an active stream, mid-turn messages are queued."""
from headroom.proxy.handlers.streaming import StreamingMixin
mixin = StreamingMixin()
session_key = "test-session-123"
mixin._active_streams.add(session_key)
body = {"messages": [{"role": "user", "content": "follow-up"}]}
result = mixin._queue_mid_turn_message(session_key, body)
assert result["status"] == 202
assert result["event"] == "headroom_queued"
assert not mixin._mid_turn_queues[session_key].empty()
queued = mixin._mid_turn_queues[session_key].get_nowait()
assert queued == body
# Cleanup
mixin._active_streams.discard(session_key)
del mixin._mid_turn_queues[session_key]
def test_no_queue_when_no_prior_stream(self):
"""When no stream is active, _mid_turn_queues stays empty for the session."""
from headroom.proxy.handlers.streaming import StreamingMixin
mixin = StreamingMixin()
session_key = "inactive-session"
assert session_key not in mixin._active_streams
assert session_key not in mixin._mid_turn_queues
def test_should_queue_only_with_explicit_session_header(self):
"""Regression: mid-turn queuing must require an explicit session header.
Without ``x-headroom-session-id`` the session key is a coarse
``md5(model + system[:500])`` shared by concurrent independent streams
(e.g. a main conversation plus background/parallel requests). Queuing
those wrongly returns a 202 to a streaming caller, whose SDK stream
parser then fails on an empty (non-SSE) stream. Only opt-in callers
that send the header may be queued.
"""
from headroom.proxy.handlers.streaming import StreamingMixin
mixin = StreamingMixin()
session_key = "shared-md5-key"
# An earlier stream on this (fallback) session key is in flight.
mixin._active_streams.add(session_key)
try:
# No explicit header (header-less concurrent stream): must NOT queue,
# even though the key collides in _active_streams.
assert mixin._should_queue_mid_turn(session_key, None) is False
assert mixin._should_queue_mid_turn(session_key, "") is False
# Explicit header present: opt-in client, queuing is allowed.
assert mixin._should_queue_mid_turn(session_key, session_key) is True
# Explicit header but no active stream: nothing to queue behind.
assert mixin._should_queue_mid_turn("other-key", "other-key") is False
finally:
mixin._active_streams.discard(session_key)
def _create_mock_proxy(self):
proxy = object.__new__(HeadroomProxy)
proxy.http_client = MagicMock(spec=httpx.AsyncClient)
proxy._config = MagicMock()
proxy._config.memory_enabled = False
proxy._config.ccr_inject_tool = False
proxy._config.retry_max_attempts = 1
proxy._config.retry_base_delay_ms = 0
proxy._config.retry_max_delay_ms = 0
proxy.config = proxy._config
proxy.memory_handler = None
proxy._parse_sse_usage_from_buffer = MagicMock(return_value=None)
proxy._finalize_stream_response = AsyncMock(return_value=None)
return proxy
@staticmethod
def _create_mock_upstream_response(
chunks: list[bytes], *, terminal_exception: BaseException | None = None
):
mock_response = AsyncMock()
mock_response.headers = httpx.Headers({"content-type": "text/event-stream"})
mock_response.status_code = 200
async def aiter_bytes():
for chunk in chunks:
yield chunk
if terminal_exception is not None:
raise terminal_exception
mock_response.aiter_bytes = aiter_bytes
mock_response.aclose = AsyncMock()
return mock_response
@pytest.mark.asyncio
async def test_mid_turn_stream_cancellation_clears_active_session_and_queue(self):
proxy = self._create_mock_proxy()
session_key = "cancelled-session"
mock_response = self._create_mock_upstream_response(
[
b'event: message_start\ndata: {"type":"message_start"}\n\n',
],
terminal_exception=asyncio.CancelledError(),
)
proxy.http_client.build_request = MagicMock(return_value=MagicMock())
proxy.http_client.send = AsyncMock(return_value=mock_response)
result = await proxy._stream_response(
url="https://api.anthropic.com/v1/messages",
headers={"x-api-key": "sk-test", "x-headroom-session-id": session_key},
body={
"model": "claude-sonnet-4-20250514",
"max_tokens": 100,
"stream": True,
"messages": [{"role": "user", "content": "hi"}],
},
provider="anthropic",
model="claude-sonnet-4-20250514",
request_id="test-cancelled",
original_tokens=10,
optimized_tokens=10,
tokens_saved=0,
transforms_applied=[],
tags={},
optimization_latency=0.0,
session_key=session_key,
)
proxy._queue_mid_turn_message(
session_key,
{"messages": [{"role": "user", "content": "follow-up"}]},
)
try:
with pytest.raises(asyncio.CancelledError):
async for _chunk in result.body_iterator:
pass
assert session_key not in proxy._active_streams
assert session_key not in proxy._mid_turn_queues
mock_response.aclose.assert_awaited_once()
finally:
proxy._active_streams.discard(session_key)
proxy._mid_turn_queues.pop(session_key, None)
@pytest.mark.asyncio
async def test_mid_turn_stream_exception_clears_active_session_and_queue(self):
proxy = self._create_mock_proxy()
session_key = "errored-session"
mock_response = self._create_mock_upstream_response(
[
b'event: message_start\ndata: {"type":"message_start"}\n\n',
],
terminal_exception=RuntimeError("stream exploded"),
)
proxy.http_client.build_request = MagicMock(return_value=MagicMock())
proxy.http_client.send = AsyncMock(return_value=mock_response)
result = await proxy._stream_response(
url="https://api.anthropic.com/v1/messages",
headers={"x-api-key": "sk-test", "x-headroom-session-id": session_key},
body={
"model": "claude-sonnet-4-20250514",
"max_tokens": 100,
"stream": True,
"messages": [{"role": "user", "content": "hi"}],
},
provider="anthropic",
model="claude-sonnet-4-20250514",
request_id="test-errored",
original_tokens=10,
optimized_tokens=10,
tokens_saved=0,
transforms_applied=[],
tags={},
optimization_latency=0.0,
session_key=session_key,
)
proxy._queue_mid_turn_message(
session_key,
{"messages": [{"role": "user", "content": "follow-up"}]},
)
try:
chunks = [chunk async for chunk in result.body_iterator]
assert any(b"event: error" in chunk for chunk in chunks)
assert session_key not in proxy._active_streams
assert session_key not in proxy._mid_turn_queues
mock_response.aclose.assert_awaited_once()
finally:
proxy._active_streams.discard(session_key)
proxy._mid_turn_queues.pop(session_key, None)