mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
## Description Closes #3071 `headroom_retrieve` is injected once and kept resident for the session so the tools array stays byte-stable and the prompt cache survives. The buffered-CCR path keyed on that tool merely being **present**, so once a session went sticky, *every* later streaming turn was silently converted to `stream: false`, buffered whole, and resynthesized as SSE: ``` CCR: stream:true request has headroom_retrieve available; using buffered stream:false upstream request ``` Buffering leaves time-to-last-byte roughly unchanged but makes **time-to-first-byte the entire generation**. The reporter measured 8s average and up to 100s across 234 requests in one day — turns that would have streamed a first token in ~1s instead delivered nothing until done. Retrieval can only expand a `<<ccr:...>>` marker present in the outgoing body, so a turn carrying none cannot benefit from the buffered path at all. Gate on that instead of on the tool. This is also the root cause #3082 traced independently from the OpenCode side — its plugin registers `headroom_retrieve` unconditionally, so *every* turn buffered and neither `--no-ccr` nor `HEADROOM_NO_CCR` stopped it. ## Type of Change - [x] Bug fix (non-breaking change that fixes an issue) ## Changes Made - New `_outgoing_body_has_redeemable_marker()` scans the body **about to go on the wire** and verifies ownership against the compression store — the same `exists()` check the retrieve endpoint performs, so a same-shaped marker from another context tool is not adopted (#2836). Unexpected shapes answer `True`, keeping the long-standing behavior. - The buffered-stream decision site gates on it, and logs at INFO when it skips buffering. - The correctness detail worth reviewing: the check reads `body`, **not** the earlier `scan_for_markers(optimized_messages)` result. `optimized_messages` is reassigned five times after that scan (memory hooks, pre-send extensions, tool-search repair, CCR repair), so reusing it would have been stale. - Two existing test files encoded the very coupling this removes and had to be repaired — see Testing. Scope: this narrows *when* buffering happens; it does not make buffered turns stream. A turn that genuinely carries a marker still loses incremental delivery — restoring streaming there means wiring `StreamingCCRHandler`, which is #3069's scope. It does not fix #3088 either, whose requests do carry markers. ## Testing - [x] Unit tests pass (`pytest`) - [x] Linting passes (`ruff check .`) - [x] New tests added for new functionality - [x] Manual testing performed Two existing files built a request with `headroom_retrieve` and **no** marker, relying on the tool alone to trigger buffering: - `tests/test_proxy/test_anthropic_streaming_ccr_retrieve.py` (11 tests) fell through to the live streaming path, where only `_retry_request` is stubbed — so the requests reached the network and the file **hung indefinitely** rather than failing. Seeded real markers; now passes in ~5s. - `tests/test_proxy_response_cache_replay.py::test_buffered_ccr_turn_does_not_write_the_response_cache` asserts its own premise (*"the conversion really happened — otherwise this test proves nothing"*), so it failed loudly instead of passing vacuously. Seeded a marker. New `test_buffering_is_gated_on_a_redeemable_marker` pins all three directions: owned marker → buffered, no marker → streaming, foreign marker → streaming. ### Test Output ```text $ pytest tests/test_ccr_buffered_stream_signed_thinking.py -q 8 passed, 1 warning in 4.45s $ pytest tests/test_proxy/test_anthropic_streaming_ccr_retrieve.py -q 11 passed, 1 warning in 4.94s # was: hung indefinitely $ pytest tests/test_proxy_response_cache_replay.py -q 9 passed, 1 warning in 1.69s $ pytest tests/ -q 3 failed, 11151 passed, 581 skipped in 398.28s (0:06:38) Same 3 failures as a clean-main baseline run on this machine: tests/test_graceful_shutdown.py::test_run_server_installs_cancelled_error_filter tests/test_learn/test_integration.py::TestCodexIntegration::test_full_pipeline tests/test_release_workflows.py::test_no_native_tls_in_wheel_build_tree $ ruff check . && ruff format --check . All checks passed! ``` ## Real Behavior Proof - Environment: this branch driven through the real FastAPI app with the outbound HTTP client captured; macOS arm64, Python 3.12. - Exact command / steps: posted a `stream: true` `/v1/messages` request carrying a resident `headroom_retrieve` tool in three variants — no marker, a marker seeded into the compression store, and a correctly-shaped marker the store does not own — recording whether `_retry_request` saw a `stream: false` body. - Observed result: no marker → **streams**, `_retry_request` never sees a flipped body; owned marker → **buffers**, exactly as before; foreign marker → streams, honoring #2836 rather than adopting another tool's hash. - Not tested: the latency improvement against live client traffic. The mechanism is verified (the buffered conversion no longer occurs), but the reported 8s → ~1s TTFB needs the reporter's traffic to confirm. ## Runtime Rollout Safety - Rollout-managed feature(s): none — this narrows an existing code path and is not behind a rollout channel. - Minimum rollout channel: n/a (ships to stable with the fix). - Stable/default behavior changed: yes. A streaming turn whose body carries no redeemable marker now stays streaming instead of being buffered. Turns carrying a marker are unchanged. - Kill switch / disable path: no new switch. Existing CCR controls still apply — disabling the CCR response handler bypasses this decision site entirely, and the helper fails open (returns `True`, i.e. the old behavior) on any unexpected message shape. - Unsafe override required: no. - Qualification impact: none — no qualification-gated surface is touched. - Rollback path: revert this commit. Note it also carries two test repairs; reverting the production change alone would leave those tests passing but vacuous. ## 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 - [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 did **not** edit `CHANGELOG.md` ## Additional Notes Documentation update is marked N/A: no user-facing flag or endpoint changes. Type checking (`mypy headroom`) was not run separately; `ruff` is the gate this repo's CI enforces. Related: #2836 (marker ownership), #3069 (streaming CCR handler), #3082, #3088. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Tejas Chopra <tejas@Tejass-MacBook-Pro.local> Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
322 lines
12 KiB
Python
322 lines
12 KiB
Python
"""Buffered-CCR streaming vs. byte-faithful passthrough (issue #2952).
|
|
|
|
The buffered-CCR path is the one place the Anthropic handler changes the
|
|
request *for its own benefit*: it flips ``stream`` to False so the reply comes
|
|
back as one JSON document it can inspect for ``headroom_retrieve`` calls, then
|
|
resynthesizes SSE for the client.
|
|
|
|
That only works if the flip reaches the wire. When conversation history carries
|
|
a signed ``thinking`` block, ``select_outbound_body`` forwards the client's
|
|
original bytes instead — ``"stream": true`` and all — so upstream streams, the
|
|
JSON parse fails, resynthesis is skipped, and the client is left with a 200 and
|
|
nothing it can read. These tests pin the three defenses: don't take the path,
|
|
survive the reply if we somehow do, and never cache a body in the wrong format.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import asyncio
|
|
import json
|
|
from datetime import datetime
|
|
|
|
import pytest
|
|
|
|
fastapi = pytest.importorskip("fastapi")
|
|
httpx = pytest.importorskip("httpx")
|
|
|
|
from fastapi.testclient import TestClient # noqa: E402
|
|
|
|
from headroom.proxy.models import CacheEntry # noqa: E402
|
|
from headroom.proxy.server import ProxyConfig, create_app # noqa: E402
|
|
|
|
RETRIEVE_TOOL = {
|
|
"name": "headroom_retrieve",
|
|
"description": "Retrieve original content",
|
|
"input_schema": {"type": "object", "properties": {}},
|
|
}
|
|
|
|
SIGNED_THINKING_TURN = {
|
|
"role": "assistant",
|
|
"content": [
|
|
{
|
|
"type": "thinking",
|
|
"thinking": "private reasoning",
|
|
"signature": "sig-abc123",
|
|
},
|
|
{"type": "text", "text": "Answered."},
|
|
],
|
|
}
|
|
|
|
SSE_BODY = (
|
|
b'event: message_start\ndata: {"type":"message_start","message":{"id":"msg_1"}}\n\n'
|
|
b'event: message_stop\ndata: {"type":"message_stop"}\n\n'
|
|
)
|
|
|
|
|
|
def _config() -> ProxyConfig:
|
|
return ProxyConfig(
|
|
optimize=False,
|
|
cache_enabled=True,
|
|
rate_limit_enabled=False,
|
|
memory_enabled=False,
|
|
)
|
|
|
|
|
|
@pytest.fixture
|
|
def ccr_marker() -> str:
|
|
"""A marker this proxy actually owns, so retrieval could really fire.
|
|
|
|
The buffered path is only taken when the outgoing body carries a redeemable
|
|
marker (#3071) — ``headroom_retrieve`` has nothing to expand otherwise. These
|
|
tests are about what happens *on* that path, so they have to earn it.
|
|
"""
|
|
from headroom.cache.backends import InMemoryBackend
|
|
from headroom.cache.compression_store import get_compression_store, reset_compression_store
|
|
|
|
reset_compression_store()
|
|
store = get_compression_store(backend=InMemoryBackend())
|
|
hash_key = store.store(
|
|
"the original, uncompressed tool output",
|
|
"<<ccr:placeholder>>",
|
|
original_tokens=100,
|
|
compressed_tokens=5,
|
|
tool_name="Read",
|
|
)
|
|
try:
|
|
yield hash_key
|
|
finally:
|
|
reset_compression_store()
|
|
|
|
|
|
def _body(*, with_thinking: bool, marker: str | None = None) -> dict:
|
|
first = "hi" if marker is None else f"hi — earlier output is at <<ccr:{marker}>>"
|
|
messages: list[dict] = [{"role": "user", "content": first}]
|
|
if with_thinking:
|
|
messages.append(SIGNED_THINKING_TURN)
|
|
messages.append({"role": "user", "content": "continue"})
|
|
return {
|
|
"model": "claude-sonnet-4-20250514",
|
|
"max_tokens": 64,
|
|
"stream": True,
|
|
"tools": [RETRIEVE_TOOL],
|
|
"messages": messages,
|
|
}
|
|
|
|
|
|
def _headers() -> dict[str, str]:
|
|
return {"Authorization": "Bearer test-key", "x-api-key": "test-key"}
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
("with_thinking", "expect_plain_streaming"),
|
|
[(True, True), (False, False)],
|
|
)
|
|
def test_signed_thinking_history_skips_the_buffered_ccr_path(
|
|
with_thinking: bool, expect_plain_streaming: bool, ccr_marker: str
|
|
) -> None:
|
|
"""The buffered path is only chosen when the stream:false flip can land."""
|
|
calls: dict[str, object] = {}
|
|
|
|
async def fake_stream_response(url, headers, body, *args, **kwargs): # noqa: ANN001
|
|
calls["stream_body"] = body
|
|
return fastapi.responses.StreamingResponse(iter([SSE_BODY]), media_type="text/event-stream")
|
|
|
|
async def fake_retry(method, url, headers, req_body, *args, **kwargs): # noqa: ANN001
|
|
calls["buffered_body"] = json.loads(json.dumps(req_body))
|
|
return httpx.Response(
|
|
200,
|
|
json={
|
|
"id": "msg_1",
|
|
"type": "message",
|
|
"role": "assistant",
|
|
"model": "claude-sonnet-4-20250514",
|
|
"content": [{"type": "text", "text": "ok"}],
|
|
"stop_reason": "end_turn",
|
|
"usage": {"input_tokens": 10, "output_tokens": 5},
|
|
},
|
|
headers={"content-type": "application/json"},
|
|
)
|
|
|
|
app = create_app(_config())
|
|
with TestClient(app) as client:
|
|
client.app.state.proxy._stream_response = fake_stream_response
|
|
client.app.state.proxy._retry_request = fake_retry
|
|
resp = client.post(
|
|
"/v1/messages",
|
|
json=_body(with_thinking=with_thinking, marker=ccr_marker),
|
|
headers=_headers(),
|
|
)
|
|
|
|
assert resp.status_code == 200, resp.text
|
|
if expect_plain_streaming:
|
|
# Passthrough is locked in, so we must not pretend we can buffer.
|
|
assert "stream_body" in calls, "expected the plain streaming path"
|
|
assert "buffered_body" not in calls
|
|
# The turn still leaves as a streaming request, matching the bytes
|
|
# that passthrough will actually forward.
|
|
assert calls["stream_body"]["stream"] is True
|
|
else:
|
|
assert "buffered_body" in calls, "expected the buffered CCR path"
|
|
assert calls["buffered_body"]["stream"] is False
|
|
|
|
|
|
@pytest.mark.parametrize("upstream_delay", [0.0, 1.2], ids=["prompt", "past-keepalive"])
|
|
def test_buffered_ccr_relays_an_unexpected_sse_reply_and_does_not_cache_it(
|
|
upstream_delay: float, ccr_marker: str
|
|
) -> None:
|
|
"""A 200 SSE reply on the buffered path reaches the client as a stream.
|
|
|
|
The delay matters: ``_BufferedCCRResponse`` commits SSE response headers
|
|
after a 1 s keepalive, and past that point it can only forward a result
|
|
that exposes a ``body_iterator``. A plain ``Response`` there degrades to a
|
|
bare ``event: error`` — which is what a real (multi-second) Anthropic turn
|
|
hit in #2952.
|
|
"""
|
|
|
|
async def fake_retry(method, url, headers, req_body, *args, **kwargs): # noqa: ANN001
|
|
if upstream_delay:
|
|
await asyncio.sleep(upstream_delay)
|
|
return httpx.Response(200, content=SSE_BODY, headers={"content-type": "text/event-stream"})
|
|
|
|
app = create_app(_config())
|
|
with TestClient(app) as client:
|
|
proxy = client.app.state.proxy
|
|
proxy._retry_request = fake_retry
|
|
resp = client.post(
|
|
"/v1/messages",
|
|
json=_body(with_thinking=False, marker=ccr_marker),
|
|
headers=_headers(),
|
|
)
|
|
|
|
assert resp.status_code == 200, resp.text
|
|
assert resp.headers["content-type"].startswith("text/event-stream")
|
|
assert b"message_start" in resp.content
|
|
# Caching SSE bytes under a key with no `stream` component is what
|
|
# served a stream to a buffered caller in the first place.
|
|
assert proxy.cache is not None
|
|
assert len(proxy.cache._cache) == 0, "an unparseable body must never be cached"
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
("marker_kind", "expect_buffered"),
|
|
[
|
|
("owned", True),
|
|
("none", False),
|
|
("foreign", False),
|
|
],
|
|
)
|
|
def test_buffering_is_gated_on_a_redeemable_marker(
|
|
marker_kind: str, expect_buffered: bool, ccr_marker: str
|
|
) -> None:
|
|
"""A resident ``headroom_retrieve`` is not on its own a reason to buffer (#3071).
|
|
|
|
The tool is injected once and kept resident so the tools array stays
|
|
byte-stable for the prompt cache. Buffering on its presence alone meant
|
|
every later streaming turn of a sticky session lost incremental delivery —
|
|
time-to-first-byte became the whole generation. Retrieval can only expand a
|
|
marker that is in the outgoing body *and* redeemable now, so that is what
|
|
the wire-format decision keys on.
|
|
"""
|
|
marker = {
|
|
"owned": ccr_marker,
|
|
"none": None,
|
|
# Correct shape, not ours: adopting it would send the model to a
|
|
# retrieval that is guaranteed to miss (#2836).
|
|
"foreign": "deadbeefcafe",
|
|
}[marker_kind]
|
|
|
|
calls: dict[str, object] = {}
|
|
|
|
async def fake_stream_response(url, headers, body, *args, **kwargs): # noqa: ANN001
|
|
calls["stream_body"] = body
|
|
return fastapi.responses.StreamingResponse(iter([SSE_BODY]), media_type="text/event-stream")
|
|
|
|
async def fake_retry(method, url, headers, req_body, *args, **kwargs): # noqa: ANN001
|
|
calls["buffered_body"] = json.loads(json.dumps(req_body))
|
|
return httpx.Response(
|
|
200,
|
|
json={
|
|
"id": "msg_1",
|
|
"type": "message",
|
|
"role": "assistant",
|
|
"model": "claude-sonnet-4-20250514",
|
|
"content": [{"type": "text", "text": "ok"}],
|
|
"stop_reason": "end_turn",
|
|
"usage": {"input_tokens": 10, "output_tokens": 5},
|
|
},
|
|
headers={"content-type": "application/json"},
|
|
)
|
|
|
|
app = create_app(_config())
|
|
with TestClient(app) as client:
|
|
client.app.state.proxy._stream_response = fake_stream_response
|
|
client.app.state.proxy._retry_request = fake_retry
|
|
resp = client.post(
|
|
"/v1/messages",
|
|
json=_body(with_thinking=False, marker=marker),
|
|
headers=_headers(),
|
|
)
|
|
|
|
assert resp.status_code == 200, resp.text
|
|
if expect_buffered:
|
|
assert "buffered_body" in calls, "a redeemable marker must still buffer"
|
|
assert calls["buffered_body"]["stream"] is False
|
|
else:
|
|
assert "stream_body" in calls, "nothing to retrieve — the client must keep streaming"
|
|
assert "buffered_body" not in calls
|
|
assert calls["stream_body"]["stream"] is True
|
|
|
|
|
|
def test_cache_hit_never_replays_a_foreign_content_type() -> None:
|
|
"""A cache entry cannot hand a caller a wire format it did not ask for."""
|
|
body = {
|
|
"model": "claude-sonnet-4-20250514",
|
|
"max_tokens": 64,
|
|
"stream": False,
|
|
"messages": [{"role": "user", "content": "hi"}],
|
|
}
|
|
payload = json.dumps(
|
|
{
|
|
"id": "msg_1",
|
|
"type": "message",
|
|
"role": "assistant",
|
|
"model": "claude-sonnet-4-20250514",
|
|
"content": [{"type": "text", "text": "cached"}],
|
|
"stop_reason": "end_turn",
|
|
"usage": {"input_tokens": 1, "output_tokens": 1},
|
|
}
|
|
).encode()
|
|
|
|
async def fail_retry(*args, **kwargs): # noqa: ANN001, ANN002, ANN003
|
|
raise AssertionError("upstream must not be called on a cache hit")
|
|
|
|
app = create_app(_config())
|
|
with TestClient(app) as client:
|
|
proxy = client.app.state.proxy
|
|
proxy._retry_request = fail_retry
|
|
key = proxy.cache._compute_key(
|
|
body["messages"],
|
|
body["model"],
|
|
system=None,
|
|
tools=None,
|
|
tool_choice=None,
|
|
temperature=None,
|
|
top_p=None,
|
|
top_k=None,
|
|
max_tokens=64,
|
|
stop=None,
|
|
thinking=None,
|
|
output_config=None,
|
|
)
|
|
proxy.cache._cache[key] = CacheEntry(
|
|
response_body=payload,
|
|
response_headers={"content-type": "text/event-stream"},
|
|
created_at=datetime.now(),
|
|
ttl_seconds=3600,
|
|
)
|
|
|
|
resp = client.post("/v1/messages", json=body, headers=_headers())
|
|
|
|
assert resp.status_code == 200, resp.text
|
|
assert resp.headers["content-type"].startswith("application/json")
|
|
assert resp.json()["content"][0]["text"] == "cached"
|