mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
## Description
Fixes `/v1/compress` so its `ccr_hashes` response includes retrievable
CCR hashes embedded in compressed message content, including row-drop
and recursive JSON markers that may not be present in
`TransformResult.markers_inserted`.
The original PR also changed query-based JSON row search. Current `main`
intentionally made CCR retrieval a hash-only, full-content lookup in
#1532, so that obsolete half is not restored. This reconciliation
preserves the reporting bug fix without reversing the current retrieval
contract.
## 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 causes existing functionality
to change)
- [ ] Documentation update
- [ ] Performance improvement
- [ ] Code refactoring (no functional changes)
## Changes Made
- extract 12–24 character CCR hashes from `Retrieve more`, `Retrieve
original`, and `<<ccr:...>>` markers
- scan both transform marker metadata and nested rendered message values
- preserve stable encounter order and deduplicate case-insensitively
- exclude non-retrieval transform metadata such as tool digests and
stable-prefix hashes
- return the normalized hashes from `/v1/compress`
- add helper-level and endpoint-level regression coverage
## Testing
- [x] Unit tests pass (`pytest`)
- [x] Linting passes (`ruff check`)
- [ ] Type checking passes (`mypy headroom`)
- [x] New tests added for new functionality
- [x] Manual behavior inspection performed
### Test Output
```text
$ uv run --extra dev pytest tests/test_proxy_compress_endpoint.py -q
50 passed, 1 warning in 6.54s
$ uv run --extra dev ruff check headroom/proxy/handlers/openai.py tests/test_proxy_compress_endpoint.py
All checks passed!
$ uv run --extra dev ruff format --check headroom/proxy/handlers/openai.py tests/test_proxy_compress_endpoint.py
2 files already formatted
$ git diff --check
# no output
```
## Real Behavior Proof
- Environment: macOS, Python 3.12.13, current `main` at `7940c05e`,
project native extension built by `uv`
- Exact command / steps: ran the complete `/v1/compress` endpoint test
module, including a mocked pipeline response containing an embedded
row-drop marker but only unrelated tool-digest marker metadata
- Observed result: endpoint returned exactly the embedded retrievable
hash; helper coverage also proved nested markers, case normalization,
deduplication, stable ordering, and exclusion of unrelated metadata
- Not tested: full repository test and CI matrix; GitHub CI covers the
broader matrix
## 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 the non-obvious marker filtering behavior
- [x] Documentation is unchanged because the public response contract is
corrected, not expanded
- [x] My changes generate no new warnings
- [x] I have added tests that prove the fix is effective
- [x] New and existing endpoint tests pass locally
- [x] I did **not** edit `CHANGELOG.md` — it is generated by
release-please from the Conventional Commit PR title
## Screenshots (if applicable)
Not applicable. This changes a JSON API response and tests, with no
graphical UI changes.
## Additional Notes
The query-based JSON row-search changes from the original branch were
made obsolete by #1532 and are deliberately excluded rather than
reviving a retired API behavior. The original contributor remains the
commit author for the reconciled fix.
---------
Co-authored-by: JD Davis <jd@jds-macbook-air.tail2a279.ts.net>
170 lines
5.9 KiB
Python
170 lines
5.9 KiB
Python
from __future__ import annotations
|
|
|
|
import json
|
|
import time
|
|
from typing import Any
|
|
|
|
import pytest
|
|
|
|
pytest.importorskip("fastapi")
|
|
pytest.importorskip("headroom._core")
|
|
|
|
from fastapi.testclient import TestClient
|
|
|
|
from headroom.config import TransformResult
|
|
from headroom.proxy.server import ProxyConfig, create_app
|
|
|
|
|
|
def _proxy_config(**overrides: Any) -> ProxyConfig:
|
|
defaults: dict[str, Any] = {
|
|
"optimize": True,
|
|
"cache_enabled": False,
|
|
"rate_limit_enabled": False,
|
|
"cost_tracking_enabled": False,
|
|
"log_requests": False,
|
|
"ccr_inject_tool": False,
|
|
"ccr_handle_responses": False,
|
|
"ccr_context_tracking": False,
|
|
"image_optimize": False,
|
|
"disable_kompress": True,
|
|
"compression_max_workers": 1,
|
|
}
|
|
defaults.update(overrides)
|
|
return ProxyConfig(**defaults)
|
|
|
|
|
|
def test_proxy_health_surfaces_compression_runtime_metrics(monkeypatch) -> None:
|
|
monkeypatch.setenv("HEADROOM_SKIP_UPSTREAM_CHECK", "1")
|
|
app = create_app(_proxy_config(optimize=False))
|
|
|
|
with TestClient(app, base_url="http://127.0.0.1", client=("127.0.0.1", 12345)) as client:
|
|
live = client.get("/livez")
|
|
health = client.get("/health")
|
|
|
|
assert live.status_code == 200
|
|
assert live.json()["alive"] is True
|
|
assert health.status_code == 200
|
|
runtime = health.json()["runtime"]
|
|
assert runtime["compression_executor"]["max_workers"] == 1
|
|
assert runtime["compression_executor"]["queued"] == 0
|
|
assert runtime["compression_executor"]["queue_timeouts_total"] == 0
|
|
|
|
|
|
def test_v1_compress_success_reports_actual_metrics(monkeypatch) -> None:
|
|
monkeypatch.setenv("HEADROOM_SKIP_UPSTREAM_CHECK", "1")
|
|
app = create_app(_proxy_config())
|
|
proxy = app.state.proxy
|
|
request_messages = [{"role": "user", "content": "summarize this repeated payload"}]
|
|
compressed_messages = [{"role": "user", "content": "summary payload"}]
|
|
ccr_hash = "abc123def4567890abc123de"
|
|
|
|
def fake_apply(**kwargs):
|
|
assert kwargs["messages"] == request_messages
|
|
assert kwargs["model"] == "gpt-4o"
|
|
return TransformResult(
|
|
messages=compressed_messages,
|
|
tokens_before=100,
|
|
tokens_after=40,
|
|
transforms_applied=["test:compress"],
|
|
markers_inserted=[ccr_hash],
|
|
)
|
|
|
|
# The default /v1/compress mode runs a marker-free pipeline derived from
|
|
# `openai_pipeline`, not `openai_pipeline` itself, so patch the one the
|
|
# route actually uses. It is built eagerly at create_app() time.
|
|
monkeypatch.setattr(proxy._compress_pipeline_cache["no_ccr"], "apply", fake_apply)
|
|
|
|
with TestClient(app, base_url="http://127.0.0.1", client=("127.0.0.1", 12345)) as client:
|
|
response = client.post(
|
|
"/v1/compress",
|
|
json={"model": "gpt-4o", "messages": request_messages},
|
|
)
|
|
|
|
body = response.json()
|
|
assert response.status_code == 200
|
|
assert body["messages"] == compressed_messages
|
|
assert body["tokens_before"] == 100
|
|
assert body["tokens_after"] == 40
|
|
assert body["tokens_saved"] == 60
|
|
assert body["compression_ratio"] == 0.4
|
|
assert body["transforms_applied"] == ["test:compress"]
|
|
assert body["transforms_summary"] == {"test:compress": 1}
|
|
assert body["ccr_hashes"] == [ccr_hash]
|
|
|
|
|
|
def test_v1_compress_timeout_fails_open_quickly(monkeypatch) -> None:
|
|
monkeypatch.setenv("HEADROOM_SKIP_UPSTREAM_CHECK", "1")
|
|
app = create_app(_proxy_config())
|
|
proxy = app.state.proxy
|
|
request_messages = [{"role": "user", "content": "do not mutate me"}]
|
|
|
|
async def timeout_executor(fn, *, timeout): # noqa: ANN001
|
|
raise TimeoutError("compression deadline exceeded")
|
|
|
|
monkeypatch.setattr(proxy, "_run_compression_in_executor", timeout_executor)
|
|
|
|
with TestClient(app, base_url="http://127.0.0.1", client=("127.0.0.1", 12345)) as client:
|
|
started = time.perf_counter()
|
|
response = client.post(
|
|
"/v1/compress",
|
|
json={"model": "gpt-4o", "messages": request_messages},
|
|
)
|
|
elapsed = time.perf_counter() - started
|
|
|
|
body = response.json()
|
|
assert response.status_code == 200
|
|
assert elapsed < 0.5
|
|
assert body["messages"] == request_messages
|
|
assert body["tokens_saved"] == 0
|
|
assert body["compression_ratio"] == 1.0
|
|
assert body["transforms_applied"] == []
|
|
assert body["compression_skipped"] is True
|
|
assert body["skip_reason"] == "compression_timeout"
|
|
|
|
|
|
def test_v1_compress_real_json_tool_payload_reduces_tokens(monkeypatch) -> None:
|
|
monkeypatch.setenv("HEADROOM_SKIP_UPSTREAM_CHECK", "1")
|
|
app = create_app(
|
|
_proxy_config(
|
|
ccr_inject_marker=False,
|
|
min_tokens_to_crush=20,
|
|
max_items_after_crush=10,
|
|
)
|
|
)
|
|
items = [
|
|
{
|
|
"id": i,
|
|
"status": "ok",
|
|
"score": i % 5,
|
|
"message": "same repeated value " * 20,
|
|
}
|
|
for i in range(80)
|
|
]
|
|
request = {
|
|
"model": "gpt-4o",
|
|
"messages": [
|
|
{"role": "user", "content": "summarize rows"},
|
|
{
|
|
"role": "assistant",
|
|
"content": None,
|
|
"tool_calls": [
|
|
{
|
|
"id": "call-1",
|
|
"type": "function",
|
|
"function": {"name": "list_rows", "arguments": "{}"},
|
|
}
|
|
],
|
|
},
|
|
{"role": "tool", "tool_call_id": "call-1", "content": json.dumps(items)},
|
|
],
|
|
}
|
|
|
|
with TestClient(app, base_url="http://127.0.0.1", client=("127.0.0.1", 12345)) as client:
|
|
response = client.post("/v1/compress", json=request)
|
|
|
|
body = response.json()
|
|
assert response.status_code == 200, response.text
|
|
assert body["tokens_before"] > body["tokens_after"], body
|
|
assert body["tokens_saved"] > 0
|
|
assert body["compression_ratio"] < 1.0
|
|
assert body["transforms_applied"], body
|