headroom/tests/test_mid_turn_steering.py
TenderDeve a4bd2e62a5
fix(proxy): gate mid-turn message coalescing to Claude Code clients (#1643)
## Description

`headroom wrap opencode` (and any other `@ai-sdk/anthropic` client)
can't use subagents. The subagent is spawned, receives the prompt, and
never responds; OpenCode throws `invalid_union / "No matching
discriminator" / discriminator: "type"`.

Root cause is headroom's mid-turn message coalescing. It keys concurrent
streaming requests by `md5(model:system[:500])` (`_get_session_key`,
`handlers/streaming.py`). An OpenCode subagent runs concurrently with
the main agent on the same model and same first-500-char system prefix,
so it produces the **same** session key and collides with the
still-active main stream. Two things then break it:

1. `handlers/anthropic.py` sees the key in `_active_streams` and answers
the subagent's request with a bare `202 headroom_queued` instead of
forwarding it — so the subagent never gets a response.
2. When the main stream ends, `handlers/streaming.py` emits a
non-standard `event: headroom_pending_messages` SSE event.
`@ai-sdk/anthropic`'s SSE parser keys its Zod union on `type`, and
`headroom_pending_messages` isn't a valid Anthropic event type — hence
the error.

The 202 reply and the `headroom_pending_messages` event are a Claude
Code-only protocol (nothing else consumes them). This gates coalescing
to Claude Code clients; every other harness streams normally.

Closes #1608

## Type of Change

- [x] Bug fix (non-breaking change that fixes an issue)

## Changes Made

- `handlers/streaming.py`: only register a stream in `_active_streams`
when `classify_client(headers) == "claude-code"`, and only emit the
`headroom_pending_messages` SSE event for Claude Code.
- `handlers/anthropic.py`: only take the queue-and-`202` branch when the
client is Claude Code (in addition to the existing `session_key in
_active_streams` check).
- Regression tests in `tests/test_mid_turn_steering.py` for all four
cases (active-stream registration and pending-event emission, each for a
Claude Code vs. a non-Claude-Code client).

## Testing

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

### Test Output

```text
$ pytest tests/test_mid_turn_steering.py -q
9 passed in 0.46s

$ ruff check headroom/proxy/handlers/streaming.py headroom/proxy/handlers/anthropic.py tests/test_mid_turn_steering.py
All checks passed!

$ ruff format --check <same files>
3 files already formatted

$ mypy headroom/proxy/handlers/streaming.py headroom/proxy/handlers/anthropic.py --ignore-missing-imports
Success: no issues found in 2 source files
```

## Real Behavior Proof

- Environment: macOS (arm64), Python 3.14 venv, editable install of this
branch.
- Exact command / steps: ran `pytest tests/test_mid_turn_steering.py` —
the new tests drive `_stream_response` with a queued mid-turn message
under an `opencode/1.0` User-Agent vs. a `claude-code/1.2.3` User-Agent
and assert the streamed bytes. Also ran the streaming + anthropic
handler suites (`pytest tests/test_mid_turn_steering.py
tests/test_proxy_streaming_* tests/test_anthropic_*
tests/test_streaming_usage_parser.py`).
- Observed result: with the `opencode/1.0` client the session is never
added to `_active_streams` and the response contains no
`headroom_pending_messages` event; with `claude-code/1.2.3` both still
happen (protocol preserved). Handler suites: 155 passed, 3 skipped.
Before this change the non-Claude client received the
`headroom_pending_messages` event (the exact byte string the OpenCode
parser rejects).
- Not tested: end-to-end against a live OpenCode + real subagent run —
reproduced deterministically at the proxy layer instead (the emitted SSE
bytes are the direct source of the reported `invalid_union` error).

## Review Readiness

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

## Additional Notes

Gating on `classify_client == "claude-code"` (User-Agent `claude-code/`
/ `claude-cli/`) is the same client identification used elsewhere in the
proxy. Unidentified clients (no recognized User-Agent) are treated as
non-Claude-Code and stream normally, which is the safe default for this
feature.


## Maintainer Update (2026-07-21)

- Removed the manual `CHANGELOG.md` entry so release-please remains the
source of changelog updates; pushed `d8e36540`.
- Validation: `tests/test_mid_turn_steering.py` passed (12 tests), the
related streaming/Anthropic suite passed (72 tests), Ruff check passed
for touched files, Ruff format check passed, and `git diff --check
upstream/main...HEAD` passed.

---------

Co-authored-by: JerrettDavis <mxjerrett@gmail.com>
2026-08-11 23:36:39 -05:00

315 lines
13 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)
# --- #1608: mid-turn coalescing must be gated to Claude Code clients ---
def _normal_stream(self):
return self._create_mock_upstream_response(
[
b'event: message_start\ndata: {"type":"message_start"}\n\n',
b'event: message_stop\ndata: {"type":"message_stop"}\n\n',
]
)
async def _run_stream(self, proxy, session_key, user_agent):
mock_response = self._normal_stream()
proxy.http_client.build_request = MagicMock(return_value=MagicMock())
proxy.http_client.send = AsyncMock(return_value=mock_response)
return await proxy._stream_response(
url="https://api.anthropic.com/v1/messages",
headers={"x-api-key": "sk-test", "user-agent": user_agent},
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-1608",
original_tokens=10,
optimized_tokens=10,
tokens_saved=0,
transforms_applied=[],
tags={},
optimization_latency=0.0,
session_key=session_key,
)
@pytest.mark.asyncio
async def test_non_claude_client_not_registered_active(self):
# An OpenCode subagent shares the main agent's body-derived session
# key; if it registered as active, the concurrent request would be
# swallowed. Non-Claude-Code clients must never be registered.
proxy = self._create_mock_proxy()
session_key = "opencode-session"
result = await self._run_stream(proxy, session_key, "opencode/1.0")
try:
assert session_key not in proxy._active_streams
finally:
async for _chunk in result.body_iterator:
pass
proxy._active_streams.discard(session_key)
proxy._mid_turn_queues.pop(session_key, None)
@pytest.mark.asyncio
async def test_claude_code_client_registered_active(self):
proxy = self._create_mock_proxy()
session_key = "claude-session"
result = await self._run_stream(proxy, session_key, "claude-code/1.2.3")
try:
assert session_key in proxy._active_streams
finally:
async for _chunk in result.body_iterator:
pass
proxy._active_streams.discard(session_key)
proxy._mid_turn_queues.pop(session_key, None)
@pytest.mark.asyncio
async def test_pending_event_not_emitted_for_non_claude(self):
# Even with a queued message, a non-Claude-Code stream must not emit the
# custom `headroom_pending_messages` SSE event — @ai-sdk/anthropic can't
# parse it and throws "invalid_union / No matching discriminator".
proxy = self._create_mock_proxy()
session_key = "opencode-pending"
proxy._queue_mid_turn_message(
session_key, {"messages": [{"role": "user", "content": "queued"}]}
)
result = await self._run_stream(proxy, session_key, "opencode/1.0")
try:
body = b"".join([chunk async for chunk in result.body_iterator])
assert b"headroom_pending_messages" not in body
finally:
proxy._active_streams.discard(session_key)
proxy._mid_turn_queues.pop(session_key, None)
@pytest.mark.asyncio
async def test_pending_event_emitted_for_claude_code(self):
proxy = self._create_mock_proxy()
session_key = "claude-pending"
proxy._queue_mid_turn_message(
session_key, {"messages": [{"role": "user", "content": "queued"}]}
)
result = await self._run_stream(proxy, session_key, "claude-code/1.2.3")
try:
body = b"".join([chunk async for chunk in result.body_iterator])
assert b"headroom_pending_messages" in body
finally:
proxy._active_streams.discard(session_key)
proxy._mid_turn_queues.pop(session_key, None)
class TestCoalescingCapability:
"""The capability predicate that gates the mid-turn coalescing protocol."""
def test_claude_code_supports_coalescing(self):
from headroom.proxy.auth_mode import supports_mid_turn_coalescing
assert supports_mid_turn_coalescing("claude-code") is True
def test_other_clients_do_not_support_coalescing(self):
from headroom.proxy.auth_mode import supports_mid_turn_coalescing
for client in ("opencode", "codex", "cursor", "aider", "", None):
assert supports_mid_turn_coalescing(client) is False