mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-11-22 13:29:19 +08:00
fix(proxy): turn off the image stage when --compressor leaves out image
`--compressor` / HEADROOM_COMPRESSORS maps a selection onto the router's enable_* flags, but the Anthropic and OpenAI handlers gate image compression on ProxyConfig.image_optimize, which no selection changed. A selection without `image` therefore still sent every screenshot through the image stage. A selection that disables the router's image optimizer now also sets image_optimize to False. No selection, a selection that includes `image`, and `*` behave as before. Refs #4613
This commit is contained in:
@@ -337,7 +337,7 @@ Fine-grained control over what gets compressed and how hard. Most users pick a [
|
||||
| `HEADROOM_COMPRESS_SYSTEM_MESSAGES` | unset | Compress system prompts. Off by default to keep the hottest cache prefix stable. |
|
||||
| `HEADROOM_PROTECT_RECENT` | profile | Never compress the N most recent turns. |
|
||||
| `--protect-tool-results` / `HEADROOM_PROTECT_TOOL_RESULTS` | empty | Comma-separated tool names whose output is never lossy-compressed. |
|
||||
| `--compressor` (repeatable) / `HEADROOM_COMPRESSORS` | all | Restrict to specific compressors: `smart_crusher,kompress,code_aware,search,log,tabular,config,html,image`. |
|
||||
| `--compressor` (repeatable) / `HEADROOM_COMPRESSORS` | all | Restrict to specific compressors: `smart_crusher,kompress,code_aware,search,log,tabular,config,html,image`. Leaving out `image` also turns off the proxy's image stage. |
|
||||
| `--code-aware` / `--no-code-aware` | off | AST-based [code compression](/docs/code-compression). Requires `headroom-ai[code]`. |
|
||||
|
||||
### Kompress (ML compression)
|
||||
|
||||
@@ -1118,6 +1118,12 @@ class HeadroomProxy(
|
||||
# Runs BEFORE the disable_kompress override below so that flag stays
|
||||
# authoritative for turning Kompress off.
|
||||
_apply_compressor_selection(router_config, config.compressors)
|
||||
# The provider handlers gate their image stage on
|
||||
# `config.image_optimize`, not on the router's `enable_image_optimizer`,
|
||||
# so a selection that leaves out `image` must turn that gate off too or
|
||||
# the proxy keeps compressing images (#4613).
|
||||
if not router_config.enable_image_optimizer:
|
||||
config.image_optimize = False
|
||||
# The proxy is long-lived: keep compression results it has no memory
|
||||
# budget for in a SQLite file instead of compressing them again
|
||||
# (headroom.cache.result_store; off in stateless mode).
|
||||
|
||||
@@ -0,0 +1,184 @@
|
||||
"""A compressor selection without ``image`` turns off the proxy image stage (#4613).
|
||||
|
||||
``--compressor`` / ``HEADROOM_COMPRESSORS`` maps a selection onto the router's
|
||||
``enable_*`` flags, but the provider handlers gate image compression on
|
||||
``ProxyConfig.image_optimize``. A selection that leaves out ``image`` has to
|
||||
switch that gate off as well, or screenshots still go through the image stage.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import Any
|
||||
|
||||
import httpx
|
||||
import pytest
|
||||
|
||||
fastapi = pytest.importorskip("fastapi")
|
||||
|
||||
from fastapi.testclient import TestClient # noqa: E402
|
||||
|
||||
import headroom.proxy.helpers as helpers # noqa: E402
|
||||
from headroom.proxy.server import ProxyConfig, create_app # noqa: E402
|
||||
|
||||
# A 1x1 PNG; the stub below never decodes it.
|
||||
PNG_B64 = "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg=="
|
||||
|
||||
|
||||
class _CountingCompressor:
|
||||
"""Stands in for the image compressor and counts image-stage entries."""
|
||||
|
||||
def __init__(self) -> None:
|
||||
self.calls = 0
|
||||
|
||||
def has_images(self, messages: Any) -> bool:
|
||||
self.calls += 1
|
||||
return False
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def image_stage(monkeypatch: pytest.MonkeyPatch) -> _CountingCompressor:
|
||||
stub = _CountingCompressor()
|
||||
monkeypatch.setattr(helpers, "_get_image_compressor", lambda: stub)
|
||||
return stub
|
||||
|
||||
|
||||
def _config(mode: str, compressors: set[str] | None) -> ProxyConfig:
|
||||
return ProxyConfig(
|
||||
mode=mode,
|
||||
optimize=False,
|
||||
cache_enabled=False,
|
||||
rate_limit_enabled=False,
|
||||
memory_enabled=False,
|
||||
compressors=compressors,
|
||||
)
|
||||
|
||||
|
||||
async def _fake_retry(method, url, headers, body, *args, **kwargs): # noqa: ANN001
|
||||
if "chat/completions" in url:
|
||||
payload: dict[str, Any] = {
|
||||
"id": "chatcmpl-1",
|
||||
"object": "chat.completion",
|
||||
"model": "gpt-test",
|
||||
"choices": [
|
||||
{
|
||||
"index": 0,
|
||||
"message": {"role": "assistant", "content": "a screenshot"},
|
||||
"finish_reason": "stop",
|
||||
}
|
||||
],
|
||||
"usage": {"prompt_tokens": 10, "completion_tokens": 3, "total_tokens": 13},
|
||||
}
|
||||
else:
|
||||
payload = {
|
||||
"id": "msg_1",
|
||||
"type": "message",
|
||||
"role": "assistant",
|
||||
"model": "sonnet-test",
|
||||
"content": [{"type": "text", "text": "a screenshot"}],
|
||||
"stop_reason": "end_turn",
|
||||
"usage": {"input_tokens": 10, "output_tokens": 3},
|
||||
}
|
||||
return httpx.Response(200, json=payload, headers={"content-type": "application/json"})
|
||||
|
||||
|
||||
def _anthropic_image_request(client: TestClient) -> httpx.Response:
|
||||
return client.post(
|
||||
"/v1/messages",
|
||||
headers={"x-api-key": "test-key", "anthropic-version": "2023-06-01"},
|
||||
json={
|
||||
"model": "sonnet-test",
|
||||
"max_tokens": 32,
|
||||
"messages": [
|
||||
{
|
||||
"role": "user",
|
||||
"content": [
|
||||
{
|
||||
"type": "image",
|
||||
"source": {
|
||||
"type": "base64",
|
||||
"media_type": "image/png",
|
||||
"data": PNG_B64,
|
||||
},
|
||||
},
|
||||
{"type": "text", "text": "what is on this screen?"},
|
||||
],
|
||||
}
|
||||
],
|
||||
},
|
||||
)
|
||||
|
||||
|
||||
def _openai_image_request(client: TestClient) -> httpx.Response:
|
||||
return client.post(
|
||||
"/v1/chat/completions",
|
||||
headers={"authorization": "Bearer test-key"},
|
||||
json={
|
||||
"model": "gpt-test",
|
||||
"messages": [
|
||||
{
|
||||
"role": "user",
|
||||
"content": [
|
||||
{
|
||||
"type": "image_url",
|
||||
"image_url": {"url": f"data:image/png;base64,{PNG_B64}"},
|
||||
},
|
||||
{"type": "text", "text": "what is on this screen?"},
|
||||
],
|
||||
}
|
||||
],
|
||||
},
|
||||
)
|
||||
|
||||
|
||||
def _image_stage_runs(
|
||||
config: ProxyConfig, send: Any, image_stage: _CountingCompressor
|
||||
) -> tuple[int, bool]:
|
||||
with TestClient(create_app(config)) as client:
|
||||
proxy = client.app.state.proxy
|
||||
proxy._retry_request = _fake_retry
|
||||
response = send(client)
|
||||
assert response.status_code == 200, response.text
|
||||
return image_stage.calls, proxy.config.image_optimize
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("mode", "send"),
|
||||
[
|
||||
# Anthropic skips the image stage in cache mode, so token mode exercises it.
|
||||
("token", _anthropic_image_request),
|
||||
# The OpenAI route compresses images in either mode.
|
||||
("cache", _openai_image_request),
|
||||
],
|
||||
ids=["anthropic-token", "openai-cache"],
|
||||
)
|
||||
class TestImageStageFollowsSelection:
|
||||
def test_selection_without_image_skips_the_image_stage(
|
||||
self, mode: str, send: Any, image_stage: _CountingCompressor
|
||||
) -> None:
|
||||
runs, image_optimize = _image_stage_runs(
|
||||
_config(mode, {"smart_crusher"}), send, image_stage
|
||||
)
|
||||
assert image_optimize is False
|
||||
assert runs == 0
|
||||
|
||||
def test_selection_with_image_keeps_the_image_stage(
|
||||
self, mode: str, send: Any, image_stage: _CountingCompressor
|
||||
) -> None:
|
||||
runs, image_optimize = _image_stage_runs(
|
||||
_config(mode, {"smart_crusher", "image"}), send, image_stage
|
||||
)
|
||||
assert image_optimize is True
|
||||
assert runs == 1
|
||||
|
||||
def test_wildcard_keeps_the_image_stage(
|
||||
self, mode: str, send: Any, image_stage: _CountingCompressor
|
||||
) -> None:
|
||||
runs, _ = _image_stage_runs(_config(mode, {"*"}), send, image_stage)
|
||||
assert runs == 1
|
||||
|
||||
def test_no_selection_keeps_the_image_stage(
|
||||
self, mode: str, send: Any, image_stage: _CountingCompressor
|
||||
) -> None:
|
||||
runs, image_optimize = _image_stage_runs(_config(mode, None), send, image_stage)
|
||||
assert image_optimize is True
|
||||
assert runs == 1
|
||||
Reference in New Issue
Block a user