mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
## Description Fixes #1701. On Windows, `headroom proxy --anthropic-api-url https://api.deepseek.com/anthropic` froze: the first `/v1/messages` request took ~610s (`optimization_latency_ms=609972`) with only router/lifecycle markers, and afterwards the whole server was a zombie — `/livez`, `/readyz` and `/health` hung until the process was killed. `HEADROOM_DETECT_BACKEND=python` was already set, so this was not the #575/#845 native-detect deadlock. Root cause: DeepSeek model names route to the HuggingFace tokenizer backend (`MODEL_PATTERNS` in `headroom/tokenizers/registry.py`). `HuggingFaceTokenizer` loads lazily, so the registry's construction-time fallback never fires; the first `count_messages` calls `AutoTokenizer.from_pretrained(..., trust_remote_code=True)` — unbounded network downloads/retries — and this ran **synchronously inside the async Anthropic messages handler** (`get_tokenizer(model)` + `tokenizer.count_messages(messages)`), outside the 30s `_run_compression_in_executor` bound. huggingface_hub retry chains on a restricted network easily reach ~10 minutes, blocking the entire asyncio event loop; subsequent on-loop counting kept it pinned. tiktoken got a bounded eager load for the same bug class long ago (#956); the HF backend never did. ## Type of Change - [x] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update - [ ] Refactoring (no functional changes) ## Changes Made - `headroom/tokenizers/huggingface.py`: `_load_tokenizer` now tries the local HF cache first (`local_files_only=True`, no network), then bounds the network load with `HEADROOM_HF_TOKENIZER_LOAD_TIMEOUT_SECS` (default 10s; `0` disables network loads) on a daemon thread. Timeouts/failures return `None` (cached by `lru_cache`, so the hub is probed at most once per process per tokenizer) and `count_messages` fails open to char-based estimation via the existing `_use_fallback()` path. - `headroom/proxy/handlers/anthropic.py`: new `AnthropicHandlerMixin._count_tokens_offloaded(model, messages)` runs `get_tokenizer` + `count_messages` on the compression executor bounded by `COMPRESSION_TIMEOUT_SECONDS`, failing open to `EstimatingTokenCounter` (downgrade logged once per model). Used in `handle_anthropic_messages` (the issue's hot path, both count sites) and `handle_anthropic_batch_create`; the batch path's inline `anthropic_pipeline.apply()` is now offloaded via `_run_compression_in_executor` (mirrors the #1612 image-compression offload). - `headroom/proxy/handlers/batch.py`: the two remaining inline `openai_pipeline.apply()` calls (`handle_google_batch_create`, `_compress_batch_jsonl`) are offloaded the same way; existing `except` blocks keep the pass-through fail-open semantics. - Tests: `tests/test_huggingface_tokenizer_timeout.py` (cache-first, bounded timeout, failure caching, timeout=0, fail-open estimation), `tests/test_tokenizer_count_offload.py` (wiring guards, runs on `headroom-compress` worker, event loop stays responsive during slow tokenizer work, fail-open), plus `_run_compression_in_executor` stub on the batch test double. ## Testing - [x] All existing tests pass - [x] Added new tests for the changes - [ ] Manual testing performed ``` $ python -m pytest tests/test_huggingface_tokenizer_timeout.py tests/test_tokenizer_count_offload.py tests/test_image_compression_offload.py tests/test_gemini_compression_offload.py tests/test_tokenizers tests/test_proxy_handlers_batch.py -q 50 passed $ ruff check . # No issues found $ ruff format --check . # 1043 files already formatted $ mypy headroom --ignore-missing-imports # 0 errors ``` ## Real Behavior Proof - Environment: Windows 11 Pro (10.0.26200), Python 3.13, local checkout of this branch with the Rust core built. - Exact command / steps: `python -m pytest tests/test_tokenizer_count_offload.py -q` — includes `test_count_tokens_offloaded_keeps_loop_responsive`, which reproduces the issue's mechanism: a tokenizer whose `count_messages` blocks (stand-in for the unbounded `AutoTokenizer.from_pretrained` network load) while an asyncio ticker measures event-loop liveness. Also `python -m pytest tests/test_huggingface_tokenizer_timeout.py -q` with a `from_pretrained` stub that sleeps 60s and `HEADROOM_HF_TOKENIZER_LOAD_TIMEOUT_SECS=0.2`. - Observed result: with the fix, the slow count runs on a `headroom-compress` worker thread and the loop keeps ticking (`ticks >= 5`; inline it yields ~0 — the zombie). The 60s-hung HF load unblocks at the 0.2s timeout, falls back to estimation, and the second call returns instantly (failure cached, no re-probe). All 10 new tests pass. - Not tested: live reproduction against `api.deepseek.com` from a network where HF hub downloads stall (the reporter's exact environment); actual HF vocab download timing on a healthy network. ## Review Readiness - [x] I have performed a self-review - [x] This PR is ready for human review Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
126 lines
4.9 KiB
Python
126 lines
4.9 KiB
Python
"""Token counting must run off the event loop (GH #1701): the Anthropic messages
|
|
handler resolved the tokenizer and counted the conversation inline in the async
|
|
handler. For HF-backed models (e.g. deepseek-*) first use triggers an unbounded
|
|
network download, freezing the whole server (610s request, then /livez, /readyz
|
|
and /health hang until kill). The fix routes resolution + counting through
|
|
HeadroomProxy._count_tokens_offloaded (compression executor, bounded by
|
|
COMPRESSION_TIMEOUT_SECONDS, fail-open to estimation), and offloads the inline
|
|
batch pipeline.apply() calls the same way.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import asyncio
|
|
import inspect
|
|
import threading
|
|
import time
|
|
|
|
from headroom.proxy.handlers.anthropic import AnthropicHandlerMixin
|
|
from headroom.proxy.handlers.batch import BatchHandlerMixin
|
|
from headroom.proxy.server import ProxyConfig, create_app
|
|
from headroom.tokenizers import EstimatingTokenCounter
|
|
|
|
|
|
def _make_proxy(): # noqa: ANN202 — returns the internal HeadroomProxy
|
|
app = create_app(
|
|
ProxyConfig(
|
|
optimize=True,
|
|
cache_enabled=False,
|
|
rate_limit_enabled=False,
|
|
cost_tracking_enabled=False,
|
|
)
|
|
)
|
|
return app.state.proxy
|
|
|
|
|
|
def test_handlers_offload_token_counting_and_batch_apply() -> None:
|
|
"""Wiring guard: the request paths must use the offloaded helpers, not inline
|
|
get_tokenizer/count_messages or pipeline.apply on the event loop."""
|
|
fn = AnthropicHandlerMixin.handle_anthropic_messages
|
|
assert inspect.iscoroutinefunction(fn)
|
|
src = inspect.getsource(fn)
|
|
assert "_count_tokens_offloaded(" in src, "token counting not offloaded"
|
|
assert "tokenizer = get_tokenizer(" not in src, "tokenizer resolved inline on the loop"
|
|
|
|
for mixin, method in (
|
|
(AnthropicHandlerMixin, "handle_anthropic_batch_create"),
|
|
(BatchHandlerMixin, "handle_google_batch_create"),
|
|
(BatchHandlerMixin, "_compress_batch_jsonl"),
|
|
):
|
|
fn = getattr(mixin, method)
|
|
assert inspect.iscoroutinefunction(fn), f"{method} must be async"
|
|
src = inspect.getsource(fn)
|
|
if "pipeline.apply(" in src:
|
|
assert "_run_compression_in_executor(" in src, f"{method}: apply() not offloaded"
|
|
assert "COMPRESSION_TIMEOUT_SECONDS" in src, f"{method}: offload missing timeout"
|
|
|
|
helper_src = inspect.getsource(AnthropicHandlerMixin._count_tokens_offloaded)
|
|
assert "COMPRESSION_TIMEOUT_SECONDS" in helper_src
|
|
assert "EstimatingTokenCounter" in helper_src, "helper must fail open to estimation"
|
|
|
|
|
|
async def test_count_tokens_offloaded_runs_on_worker_thread(monkeypatch) -> None: # noqa: ANN001
|
|
proxy = _make_proxy()
|
|
loop_thread = threading.current_thread().name
|
|
seen: dict[str, str] = {}
|
|
|
|
class _SpyTokenizer(EstimatingTokenCounter):
|
|
def count_messages(self, messages): # noqa: ANN001, ANN201
|
|
seen["thread"] = threading.current_thread().name
|
|
return super().count_messages(messages)
|
|
|
|
monkeypatch.setattr("headroom.tokenizers.get_tokenizer", lambda *a, **k: _SpyTokenizer())
|
|
|
|
_, tokens = await proxy._count_tokens_offloaded("gpt-4", [{"role": "user", "content": "hi"}])
|
|
|
|
assert tokens > 0
|
|
assert seen["thread"].startswith("headroom-compress")
|
|
assert seen["thread"] != loop_thread
|
|
|
|
|
|
async def test_count_tokens_offloaded_keeps_loop_responsive(monkeypatch) -> None: # noqa: ANN001
|
|
"""A slow tokenizer (stand-in for an HF network load) must not starve the loop —
|
|
the pre-fix inline call yielded ~0 ticks here."""
|
|
proxy = _make_proxy()
|
|
ticks = 0
|
|
|
|
async def _ticker() -> None:
|
|
nonlocal ticks
|
|
while True:
|
|
await asyncio.sleep(0.01)
|
|
ticks += 1
|
|
|
|
class _SlowTokenizer(EstimatingTokenCounter):
|
|
def count_messages(self, messages): # noqa: ANN001, ANN201
|
|
time.sleep(0.3)
|
|
return super().count_messages(messages)
|
|
|
|
monkeypatch.setattr("headroom.tokenizers.get_tokenizer", lambda *a, **k: _SlowTokenizer())
|
|
|
|
tick_task = asyncio.create_task(_ticker())
|
|
try:
|
|
_, tokens = await proxy._count_tokens_offloaded("m", [{"role": "user", "content": "hi"}])
|
|
finally:
|
|
tick_task.cancel()
|
|
|
|
assert tokens > 0
|
|
assert ticks >= 5
|
|
|
|
|
|
async def test_count_tokens_offloaded_fails_open(monkeypatch) -> None: # noqa: ANN001
|
|
"""Resolution errors and timeouts downgrade to estimation instead of raising."""
|
|
proxy = _make_proxy()
|
|
|
|
def _boom(*a, **k): # noqa: ANN002, ANN003, ANN202
|
|
raise RuntimeError("tokenizer backend exploded")
|
|
|
|
monkeypatch.setattr("headroom.tokenizers.get_tokenizer", _boom)
|
|
|
|
tokenizer, tokens = await proxy._count_tokens_offloaded(
|
|
"deepseek-chat", [{"role": "user", "content": "hello world"}]
|
|
)
|
|
|
|
assert isinstance(tokenizer, EstimatingTokenCounter)
|
|
assert tokens > 0
|
|
# Logged-once bookkeeping records the downgraded model.
|
|
assert "deepseek-chat" in proxy._token_count_fallback_models
|