headroom/tests/test_transforms/test_kompress_compressor.py
gglucass 841663da16
fix(proxy): make Kompress eager preload cache-only so a cold cache can't block startup (#783)
## Description

`ContentRouter.eager_load_compressors()` runs a network
`hf_hub_download` of the Kompress ONNX model on the **blocking
startup/lifespan path**, before the proxy binds its port. On a cold
cache this is unsafe:

- the download can hang long enough to blow the supervisor's bind
timeout, or
- a native crash in the download/ML stack (an **uncatchable `Fatal
Python error: Aborted` / SIGABRT**) kills the interpreter before it ever
`listen()`s.

Either way the supervisor sees "proxy never opened its port" and gives
up. We observed this in the field from the desktop app (process aborted
during `eager_load_compressors -> _load_kompress_onnx ->
hf_hub_download` of `onnx/kompress-int8.onnx`, while the only Python
thread was parked in the HuggingFace download file-lock; the abort came
from a native thread, so `try/except` at the call site cannot catch it).

The eager preload is a latency optimization and must never be able to
block — or kill — startup. This change makes startup preload
**cache-only**: if the model isn't already cached, we defer the download
to first use (off the startup path) and bind the port normally. Warm
starts are unchanged.

## 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 would cause existing
functionality to change)
- [ ] Documentation update
- [ ] Performance improvement
- [ ] Code refactoring (no functional changes)

## Changes Made

- `onnx_runtime.hf_hub_download_local_first(...)`: added `allow_network`
(default `True`). When `False`, a cache miss re-raises the local-lookup
error instead of falling back to a network download.
- `kompress_compressor`: added `allow_download` (default `True`)
threaded through `preload()` -> `_load_kompress()` ->
`_load_kompress_onnx()` / `_load_kompress_pytorch()` and the ModernBERT
tokenizer load. Added `KompressModelNotCached`, raised when a cache-only
load misses. Auto-mode no longer falls back to a PyTorch network
download on a cache-only miss — it propagates so the caller can defer.
- `content_router.eager_load_compressors()`: calls
`preload(allow_download=False)`. On `KompressModelNotCached` it logs and
reports the component as `"deferred"` (a status
`warmup.merge_transform_status` already handles gracefully) instead of
letting a cold download run on the startup path.

Default (first-request) loading behavior and warm-start preload are
unchanged.

## Testing

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

New tests in `tests/test_kompress_preload_deferral.py` cover: cache-only
`hf_hub_download_local_first` never hits the network; default still
falls back; cache-only ONNX load raises `KompressModelNotCached`;
auto-mode does **not** trigger a PyTorch download on a cache-only miss;
and `eager_load_compressors` reports `deferred` (cold) / `enabled`
(warm). Existing `_load_kompress` dispatch tests updated for the new
keyword-only param.

> Note on environment: I do not have a clean reproduction of the native
SIGABRT itself (it depends on a specific machine's HF download/ML native
stack), so the "Manual testing performed" box is left unchecked. The
tests target the structural fix — that startup preload can no longer
perform a network download — which is the precondition for the crash.

## Test Output

```
$ uv run pytest -v tests/test_kompress_preload_deferral.py
tests/test_kompress_preload_deferral.py::test_local_first_no_network_when_disallowed PASSED
tests/test_kompress_preload_deferral.py::test_local_first_falls_back_to_network_by_default PASSED
tests/test_kompress_preload_deferral.py::test_load_kompress_onnx_cache_miss_raises_not_cached PASSED
tests/test_kompress_preload_deferral.py::test_load_kompress_auto_does_not_pytorch_download_on_cache_miss PASSED
tests/test_kompress_preload_deferral.py::test_eager_load_defers_when_model_not_cached PASSED
tests/test_kompress_preload_deferral.py::test_eager_load_enabled_when_model_cached PASSED
6 passed in 4.82s

$ uv run pytest tests/test_transforms/test_kompress_compressor.py tests/test_transforms_content_router.py tests/test_onnx_runtime.py tests/test_proxy_warmup.py
63 passed

$ uv run ruff check <changed files>            # All checks passed!
$ uv run mypy headroom/onnx_runtime.py headroom/transforms/kompress_compressor.py headroom/transforms/content_router.py
Success: no issues found
```

## 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
- [ ] I have made corresponding changes to the documentation
- [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
- [ ] I have updated the CHANGELOG.md if applicable (auto-generated from
conventional commits)

## Additional Notes

This contains the cold-start case. A native crash in onnxruntime
*session init* (as opposed to the download) on first request would still
be a separate issue; it is not what was observed here (the abort was
during the HF download), and isolating it would be a larger, separate
change.

---------

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-11 12:53:03 -05:00

487 lines
19 KiB
Python

"""Tests for Kompress compressor.
Covers:
- Lazy imports: module importable without torch installed
- is_kompress_available(): correct detection of [ml] extra
- KompressConfig / KompressResult: dataclass defaults
- KompressCompressor: passthrough for short content, fallback on error
- Transform interface: apply() method
"""
import logging
from types import SimpleNamespace
from unittest.mock import MagicMock, patch
# ── Import safety (the whole point of the fix) ─────────────────────────
class TestLazyImports:
"""The module must be importable without torch/transformers."""
def test_is_kompress_available_importable(self) -> None:
"""is_kompress_available can be imported even without torch."""
from headroom.transforms.kompress_compressor import is_kompress_available
# Should return bool (True or False depending on environment)
result = is_kompress_available()
assert isinstance(result, bool)
def test_module_import_without_torch(self) -> None:
"""Importing the module with torch blocked should not raise."""
import sys
# Block torch AND onnxruntime imports
with patch.dict(
sys.modules,
{"torch": None, "torch.nn": None, "onnxruntime": None},
):
from headroom.transforms.kompress_compressor import (
_is_pytorch_available,
)
# Without both torch and onnxruntime, should return False
assert _is_pytorch_available() is False
# Note: is_kompress_available() may still return True if onnxruntime
# was already imported before patching. Test the individual checkers.
def test_dataclasses_importable_without_torch(self) -> None:
"""KompressConfig, KompressResult, KompressCompressor are importable without torch."""
from headroom.transforms.kompress_compressor import (
KompressCompressor, # noqa: F401
KompressConfig,
KompressResult,
)
# These don't need torch to instantiate
config = KompressConfig()
assert config.device == "auto"
assert config.enable_ccr is True
result = KompressResult(
compressed="hello",
original="hello world",
original_tokens=2,
compressed_tokens=1,
compression_ratio=0.5,
)
assert result.tokens_saved == 1
assert result.savings_percentage == 50.0
class TestKompressBackendSelection:
def test_selected_backend_aliases(self, monkeypatch) -> None:
import headroom.transforms.kompress_compressor as kmod
monkeypatch.setenv("HEADROOM_KOMPRESS_BACKEND", "mps")
assert kmod._selected_backend() == "pytorch_mps"
monkeypatch.setenv("HEADROOM_KOMPRESS_BACKEND", "coreml")
assert kmod._selected_backend() == "onnx_coreml"
monkeypatch.setenv("HEADROOM_KOMPRESS_BACKEND", "cpu")
assert kmod._selected_backend() == "onnx_cpu"
monkeypatch.setenv("HEADROOM_KOMPRESS_BACKEND", "unknown")
assert kmod._selected_backend() == "auto"
def test_unrecognized_backend_warns_and_falls_back_to_auto(self, monkeypatch, caplog) -> None:
import headroom.transforms.kompress_compressor as kmod
monkeypatch.setenv("HEADROOM_KOMPRESS_BACKEND", "tpu")
with caplog.at_level(logging.WARNING, logger=kmod.logger.name):
assert kmod._selected_backend() == "auto"
assert any(
"unrecognized" in record.getMessage() and "tpu" in record.getMessage()
for record in caplog.records
)
def test_valid_backend_values_do_not_warn(self, monkeypatch, caplog) -> None:
import headroom.transforms.kompress_compressor as kmod
with caplog.at_level(logging.WARNING, logger=kmod.logger.name):
for value in ("auto", "onnx", "cpu", "coreml", "mps", "torch", "ONNX-CPU"):
monkeypatch.setenv("HEADROOM_KOMPRESS_BACKEND", value)
kmod._selected_backend()
monkeypatch.delenv("HEADROOM_KOMPRESS_BACKEND", raising=False)
kmod._selected_backend()
assert not caplog.records
def test_forced_pytorch_mps_backend_uses_mps_device(self, monkeypatch) -> None:
import headroom.transforms.kompress_compressor as kmod
calls: list[tuple[str, str]] = []
monkeypatch.setenv("HEADROOM_KOMPRESS_BACKEND", "pytorch_mps")
monkeypatch.setattr(kmod, "_kompress_cache", {})
monkeypatch.setattr(
kmod,
"_load_kompress_pytorch",
lambda model_id, device, *, allow_download=True: (
calls.append((model_id, device)) or ("model", "tokenizer", "pytorch")
),
)
assert kmod._load_kompress("model-a", device="auto") == ("model", "tokenizer", "pytorch")
assert calls == [("model-a", "mps")]
def test_forced_coreml_backend_uses_onnx_coreml(self, monkeypatch) -> None:
import headroom.transforms.kompress_compressor as kmod
calls: list[tuple[str, bool]] = []
monkeypatch.setenv("HEADROOM_KOMPRESS_BACKEND", "onnx_coreml")
monkeypatch.setattr(kmod, "_kompress_cache", {})
monkeypatch.setattr(
kmod,
"_load_kompress_onnx",
lambda model_id, *, use_coreml=False, allow_download=True: (
calls.append((model_id, use_coreml)) or ("model", "tokenizer", "onnx_coreml")
),
)
assert kmod._load_kompress("model-b") == ("model", "tokenizer", "onnx_coreml")
assert calls == [("model-b", True)]
def test_auto_backend_preserves_onnx_first(self, monkeypatch) -> None:
import headroom.transforms.kompress_compressor as kmod
calls: list[str] = []
monkeypatch.delenv("HEADROOM_KOMPRESS_BACKEND", raising=False)
monkeypatch.setattr(kmod, "_kompress_cache", {})
monkeypatch.setattr(kmod, "_is_onnx_available", lambda: True)
monkeypatch.setattr(kmod, "_is_pytorch_available", lambda: True)
monkeypatch.setattr(
kmod,
"_load_kompress_onnx",
lambda model_id, *, use_coreml=False, allow_download=True: (
calls.append("onnx") or ("model", "tokenizer", "onnx")
),
)
monkeypatch.setattr(
kmod,
"_load_kompress_pytorch",
lambda model_id, device, *, allow_download=True: (
calls.append("pytorch") or ("model", "tokenizer", "pytorch")
),
)
assert kmod._load_kompress("model-c") == ("model", "tokenizer", "onnx")
assert calls == ["onnx"]
def test_onnx_session_options_read_thread_caps(self, monkeypatch) -> None:
import headroom.transforms.kompress_compressor as kmod
created: list[SimpleNamespace] = []
class FakeSessionOptions:
def __init__(self) -> None:
self.intra_op_num_threads = None
self.inter_op_num_threads = None
self.enable_cpu_mem_arena = True
self.enable_mem_pattern = True
fake_ort = SimpleNamespace(
SessionOptions=lambda: created.append(FakeSessionOptions()) or created[-1]
)
monkeypatch.setenv("HEADROOM_KOMPRESS_ONNX_INTRA_THREADS", "2")
monkeypatch.setenv("HEADROOM_KOMPRESS_ONNX_INTER_THREADS", "1")
options = kmod._onnx_session_options(fake_ort)
assert options.intra_op_num_threads == 2
assert options.inter_op_num_threads == 1
assert options.enable_cpu_mem_arena is False
assert options.enable_mem_pattern is False
# ── KompressResult ──────────────────────────────────────────────────────
class TestKompressResult:
def test_tokens_saved(self) -> None:
from headroom.transforms.kompress_compressor import KompressResult
r = KompressResult(
compressed="a b",
original="a b c d",
original_tokens=4,
compressed_tokens=2,
compression_ratio=0.5,
)
assert r.tokens_saved == 2
def test_tokens_saved_no_negative(self) -> None:
from headroom.transforms.kompress_compressor import KompressResult
r = KompressResult(
compressed="a b c d e",
original="a b c",
original_tokens=3,
compressed_tokens=5,
compression_ratio=1.67,
)
assert r.tokens_saved == 0
def test_savings_percentage_zero_tokens(self) -> None:
from headroom.transforms.kompress_compressor import KompressResult
r = KompressResult(
compressed="",
original="",
original_tokens=0,
compressed_tokens=0,
compression_ratio=1.0,
)
assert r.savings_percentage == 0.0
def test_default_model(self) -> None:
from headroom.transforms.kompress_compressor import HF_MODEL_ID, KompressResult
r = KompressResult(
compressed="x",
original="x y",
original_tokens=2,
compressed_tokens=1,
compression_ratio=0.5,
)
assert r.model_used == HF_MODEL_ID
# ── KompressCompressor (without model) ──────────────────────────────────
class TestKompressCompressorPassthrough:
"""Test compressor behavior that doesn't require the actual model."""
def test_short_content_passthrough(self) -> None:
"""Content under 10 words should pass through unchanged."""
from headroom.transforms.kompress_compressor import KompressCompressor
compressor = KompressCompressor()
result = compressor.compress("hello world")
assert result.compressed == "hello world"
assert result.compression_ratio == 1.0
assert result.original_tokens == 2
assert result.compressed_tokens == 2
def test_empty_content_passthrough(self) -> None:
from headroom.transforms.kompress_compressor import KompressCompressor
compressor = KompressCompressor()
result = compressor.compress("")
assert result.compressed == ""
assert result.compression_ratio == 1.0
def test_fallback_on_model_error(self) -> None:
"""If _load_kompress fails, compress should return passthrough."""
from headroom.transforms.kompress_compressor import KompressCompressor
compressor = KompressCompressor()
long_text = " ".join(f"word{i}" for i in range(20))
with patch(
"headroom.transforms.kompress_compressor._load_kompress",
side_effect=RuntimeError("no model"),
):
result = compressor.compress(long_text)
assert result.compressed == long_text
assert result.compression_ratio == 1.0
# ── Transform interface ─────────────────────────────────────────────────
class TestKompressTransformInterface:
def test_apply_short_messages_unchanged(self) -> None:
"""Messages with <10 words should pass through apply() unchanged."""
from headroom.transforms.kompress_compressor import KompressCompressor
compressor = KompressCompressor()
messages = [
{"role": "user", "content": "hello"},
{"role": "tool", "content": "short"},
]
tokenizer = MagicMock()
tokenizer.count_text = MagicMock(return_value=5)
result = compressor.apply(messages, tokenizer)
assert len(result.messages) == 2
assert result.messages[0]["content"] == "hello"
assert result.messages[1]["content"] == "short"
def test_apply_preserves_user_messages(self) -> None:
"""User messages should never be compressed."""
from headroom.transforms.kompress_compressor import KompressCompressor
compressor = KompressCompressor()
long_text = " ".join(f"word{i}" for i in range(50))
messages = [{"role": "user", "content": long_text}]
tokenizer = MagicMock()
tokenizer.count_text = MagicMock(return_value=50)
with patch(
"headroom.transforms.kompress_compressor._load_kompress",
side_effect=RuntimeError("should not be called"),
):
result = compressor.apply(messages, tokenizer)
assert result.messages[0]["content"] == long_text
# ── compress_batch ──────────────────────────────────────────────────────
class TestKompressCompressorBatch:
"""Tests for the batched compression API (compress_batch).
These exercise the non-model paths — passthrough handling, argument
validation, order preservation, and fallback behavior on model-load
failure. The actual batched inference path is covered by integration
tests that require the model to be downloaded.
"""
def test_empty_batch_returns_empty_list(self) -> None:
from headroom.transforms.kompress_compressor import KompressCompressor
compressor = KompressCompressor()
result = compressor.compress_batch([])
assert result == []
def test_all_short_texts_passthrough_without_model(self) -> None:
"""Texts under 10 words must passthrough; model never loaded."""
from headroom.transforms.kompress_compressor import KompressCompressor
compressor = KompressCompressor()
contents = ["hello", "world", "short text here"]
with patch(
"headroom.transforms.kompress_compressor._load_kompress",
side_effect=AssertionError("model should not be loaded for short texts"),
):
results = compressor.compress_batch(contents)
assert len(results) == 3
for i, r in enumerate(results):
assert r.compressed == contents[i]
assert r.compression_ratio == 1.0
def test_order_preserved(self) -> None:
"""Output order must match input order even when model load fails."""
from headroom.transforms.kompress_compressor import KompressCompressor
compressor = KompressCompressor()
long_texts = [
" ".join(f"alpha{i}" for i in range(20)),
" ".join(f"beta{i}" for i in range(20)),
" ".join(f"gamma{i}" for i in range(20)),
]
with patch(
"headroom.transforms.kompress_compressor._load_kompress",
side_effect=RuntimeError("no model"),
):
results = compressor.compress_batch(long_texts)
assert len(results) == 3
assert results[0].original.startswith("alpha0")
assert results[1].original.startswith("beta0")
assert results[2].original.startswith("gamma0")
def test_mixed_short_and_long_passthrough_on_model_failure(self) -> None:
"""Short texts passthrough; long texts fall back to passthrough on model failure."""
from headroom.transforms.kompress_compressor import KompressCompressor
compressor = KompressCompressor()
contents = [
"short",
" ".join(f"word{i}" for i in range(20)), # triggers model path
"also short",
]
with patch(
"headroom.transforms.kompress_compressor._load_kompress",
side_effect=RuntimeError("no model"),
):
results = compressor.compress_batch(contents)
assert len(results) == 3
assert results[0].compressed == "short"
assert results[0].compression_ratio == 1.0
assert results[1].compression_ratio == 1.0 # passthrough fallback
assert results[2].compressed == "also short"
def test_ratio_list_length_mismatch_raises(self) -> None:
"""If target_ratio is a list it must match contents length."""
from headroom.transforms.kompress_compressor import KompressCompressor
compressor = KompressCompressor()
contents = ["a b c", "d e f"]
# Too short
try:
compressor.compress_batch(contents, target_ratio=[0.5])
raise AssertionError("expected ValueError for length mismatch")
except ValueError as e:
assert "length" in str(e).lower()
# Too long
try:
compressor.compress_batch(contents, target_ratio=[0.5, 0.5, 0.5])
raise AssertionError("expected ValueError for length mismatch")
except ValueError as e:
assert "length" in str(e).lower()
def test_batch_of_one_equivalent_to_single_compress_on_short_text(self) -> None:
"""Batch-of-one with short text should produce identical passthrough."""
from headroom.transforms.kompress_compressor import KompressCompressor
compressor = KompressCompressor()
text = "hello world"
single = compressor.compress(text)
batch = compressor.compress_batch([text])
assert len(batch) == 1
assert batch[0].compressed == single.compressed
assert batch[0].compression_ratio == single.compression_ratio
assert batch[0].original_tokens == single.original_tokens
def test_uniform_ratio_scalar(self) -> None:
"""A scalar target_ratio must apply to every text in the batch."""
from headroom.transforms.kompress_compressor import KompressCompressor
compressor = KompressCompressor()
# Short texts — passthrough regardless of ratio
contents = ["short a", "short b", "short c"]
results = compressor.compress_batch(contents, target_ratio=0.3)
assert len(results) == 3
for r, original in zip(results, contents, strict=True):
assert r.compressed == original # short passthrough
def test_per_item_ratio_list_with_nones(self) -> None:
"""A list of ratios with some None entries must be accepted."""
from headroom.transforms.kompress_compressor import KompressCompressor
compressor = KompressCompressor()
contents = ["short a", "short b", "short c"]
ratios: list[float | None] = [0.5, None, 0.25]
# Short texts always passthrough; validating the list shape alone.
results = compressor.compress_batch(contents, target_ratio=ratios)
assert len(results) == 3
# ── unload_kompress_model ───────────────────────────────────────────────
class TestUnloadKompressModel:
def test_unload_when_no_model(self) -> None:
import headroom.transforms.kompress_compressor as kmod
from headroom.transforms.kompress_compressor import unload_kompress_model
# Ensure no model is loaded (previous tests may have set the cache)
kmod._kompress_cache.clear()
# Should return False when no model is loaded
assert unload_kompress_model() is False