headroom/tests/test_providers/test_universal.py
Tejas Chopra 6d2254dfb5
fix(anthropic): honor the [1m] 1M-context tier, and price it correctly (#3073)
Two coupled defects on Anthropic's 1M-context tier: Headroom
**under-budgeted** those sessions and **under-priced** them by ~2x. The
second gets worse once the first is fixed, so they ship together.

---

# Part 1 — `[1m]` was lost before the context budget was sized

`sanitize_anthropic_model_id()` strips a trailing `[1m]`, which is
correct for the wire — upstream Anthropic rejects the suffix, and #2027
added the strip for exactly that reason.

But `[1m]` is not only an ANSI artifact. Claude Code appends it to a
model id to request the **1M context tier**, and only sends the
`context-1m` beta header when it is present (#1158 — what `headroom wrap
claude --1m` sets up).

`get_context_limit()` sanitized *before* resolving, so the tier was gone
by lookup time:

```python
provider.get_context_limit("claude-sonnet-4-5[1m]")  # 200_000  ← real window is 1M
```

The request still reached Anthropic correctly and still got a 1M window
— the beta header goes through untouched. What broke is our **budget**:
Headroom sized a 1M session at 200K and began compacting at a fifth of
the available room.

Models whose base is already 1M (`claude-opus-5`, `claude-sonnet-5`)
resolved to 1M either way, which is why this went unnoticed. It bites
the Sonnet 4 / 4.5 family — the models `[1m]` exists for.

**Fix:** read the tier off the id *before* sanitizing; raise the
resolved limit to at least 1M. `max()` rather than assignment, so a base
wider than 1M keeps its own window. Detection is deliberately narrower
than the sanitizer — only a literal `[1m]`; `[0m]`, `[1;32m]` and real
`ESC[` sequences still strip without promoting.

| model id | wire id (unchanged) | limit before | limit after |
|---|---|---|---|
| `claude-sonnet-4-5` | `claude-sonnet-4-5` | 200K | 200K |
| `claude-sonnet-4-5[1m]` | `claude-sonnet-4-5` | **200K** | **1M** |
| `claude-opus-5[1m]` | `claude-opus-5` | 1M | 1M |
| `claude-sonnet-4-5[0m]` | `claude-sonnet-4-5` | 200K | 200K |
| `ESC[1m claude-sonnet-4-5 ESC[0m` | `claude-sonnet-4-5` | 200K | 200K
|

The wire id is unchanged in every case, so #2027 holds — guarded by a
regression test.

---

# Part 2 — the pricing that reports those sessions was wrong

### 2a. The LiteLLM cost path was dead in every provider

`litellm.completion_cost()` no longer accepts `prompt_tokens` /
`completion_tokens`. Every call raised `TypeError`:

```
TypeError: completion_cost() got an unexpected keyword argument 'prompt_tokens'
```

All five providers — `anthropic`, `openai`, `google`, `cohere`,
`litellm` — caught it with a bare `except` and silently fell through to
their hand-maintained tables. The "up-to-date pricing from LiteLLM" the
docstrings promise **has not run at all**. Anthropic additionally passed
`input_tokens - cached_tokens`, the wrong convention (LiteLLM expects
the cache-inclusive total), which would also have suppressed the
long-context threshold even had the call worked.

Replaced with `litellm.cost_per_token()` behind one shared helper,
`pricing.litellm_pricing.estimate_cost_from_tokens()`, which reuses the
existing gateway-alias candidate chain and returns `None` (not an
exception) when LiteLLM can't price a model.

### 2b. Neither path applied Anthropic's long-context premium

On the Sonnet 4 / 4.5 family a prompt over 200K re-prices the **whole**
request — input 2×, output 1.5×, cache 2× — not just the tokens past the
threshold. Rates confirmed from LiteLLM's `*_above_200k_tokens` fields.

| request (`claude-sonnet-4-5`) | reported before | true | error |
|---|---|---|---|
| 100K in / 5K out | $0.3750 | $0.3750 | — |
| 300K in / 5K out | $0.9750 | **$1.9125** | −49% |
| 300K in (150K cached) / 5K out | $0.5700 | **$1.1025** | −48% |

LiteLLM applies this itself once the call works. The manual fallback
needed `_apply_long_context_premium()` — the LiteLLM dependency is gated
`python_version < '3.14'`, so on 3.14 the fallback is the *only* path.
**Both paths now agree to four decimal places on every case under
test.**

---

## What I checked and did *not* change

The fork report that prompted this claimed the Anthropic tables were
materially stale ("Opus 4.x priced wrong"). **That does not hold.** I
audited every entry against LiteLLM's vendored table:

- **Anthropic** — every model LiteLLM knows matches exactly, Opus 4.x
included.
- **OpenAI** — all 17 entries match; the two that don't resolve are
retired models.

The defect was the mechanism, not the numbers, so the rate cards are
untouched.

One thing the repaired path fixes for free: OpenAI's cached-input
discount is **50% on gpt-4o, 75% on gpt-4.1, 90% on gpt-5**, but the
manual path applies a flat 50% estimate. With LiteLLM live, real
per-model rates are used. The flat estimate remains only as the offline
fallback.

## Scope

**No Rust change needed.**
`crates/headroom-proxy/src/compression/model_limits.rs` resolves context
windows but has **no in-tree callers**; the Rust `[1m]` handling is
wire-body sanitization only, correct as-is, and its integration tests
assert behavior this PR does not touch.

**Judgment call worth a reviewer's eye:** the `[1m]` marker is honored
for *any* model, including ones with no 1M tier
(`claude-haiku-4-5-20251001[1m]` → 1M). Gating on an allowlist would be
more precise but reintroduces a hand-maintained table that rots — the
failure mode `model_limits.rs` already documents against. Since `[1m]`
is set by our own wrapper and Claude Code's opt-in, honoring it seemed
the better default. Happy to tighten.

## Tests

- `TestContext1MSuffix` — detection, the 200K→1M promotion, the `max()`
floor, ANSI non-promotion, and the wire-id guard for #2027.
- `TestLongContextPricing` — the premium on both paths (parametrized),
threshold boundary (200,000 vs 200,001), an untiered model charged no
premium, and the two halves meeting: a `[1m]` request gets both the 1M
window and the premium rate.
- `TestLiteLLMCostHelper` — unknown model returns `None`, a known model
prices correctly, and `input_tokens` is cache-inclusive.

Two existing tests were updated, both pinned to the broken behavior:
- `test_estimate_cost_basic` probed a "per 1M" rate by sending exactly
1M tokens, which now crosses the 200K threshold. Re-probed at 100K.
(Worth knowing: `claude-3-5-sonnet-20241022` is retired and no longer in
LiteLLM, so the alias chain resolves it to `claude-sonnet-4-20250514`
and it inherits that model's tier. Harmless — a 200K-window model can't
exceed 200K in reality — but it explains the number.)
- `test_litellm_provider_info_and_cost_fallbacks` monkeypatched
`litellm.completion_cost`; repointed at the new helper seam.

```
ruff check / ruff format / mypy — clean across all six changed source files
```

🤖 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>
2026-08-16 22:46:12 -07:00

516 lines
20 KiB
Python

"""Tests for universal provider support.
Tests OpenAICompatibleProvider, GoogleProvider, and LiteLLMProvider.
"""
from __future__ import annotations
import pytest
from headroom.providers import (
GoogleProvider,
LiteLLMProvider,
ModelCapabilities,
OpenAICompatibleProvider,
create_anyscale_provider,
create_fireworks_provider,
create_groq_provider,
create_litellm_provider,
create_lmstudio_provider,
create_ollama_provider,
create_together_provider,
create_vllm_provider,
is_litellm_available,
)
def _transformers_available() -> bool:
"""Check if transformers is available."""
try:
import transformers # noqa: F401
return True
except ImportError:
return False
class TestOpenAICompatibleProvider:
"""Tests for OpenAICompatibleProvider."""
def test_init_default(self):
"""Test initialization with defaults."""
provider = OpenAICompatibleProvider()
assert provider.name == "openai_compatible"
assert provider.base_url is None
def test_init_with_config(self):
"""Test initialization with configuration."""
provider = OpenAICompatibleProvider(
name="custom",
base_url="http://localhost:8080/v1",
api_key="test-key",
)
assert provider.name == "custom"
assert provider.base_url == "http://localhost:8080/v1"
assert provider.api_key == "test-key"
def test_supports_any_model(self):
"""Test that provider supports any model."""
provider = OpenAICompatibleProvider()
assert provider.supports_model("any-model") is True
assert provider.supports_model("llama-3") is True
assert provider.supports_model("custom-finetuned") is True
@pytest.mark.skipif(
not _transformers_available(),
reason="transformers not installed - needed for HuggingFace tokenizer",
)
def test_get_token_counter(self):
"""Test getting token counter."""
provider = OpenAICompatibleProvider()
counter = provider.get_token_counter("llama-3-8b")
assert counter is not None
# Should be able to count tokens
count = counter.count_text("Hello, world!")
assert count > 0
def test_get_context_limit_known_model(self):
"""Test context limit for known models."""
provider = OpenAICompatibleProvider()
# Llama 3.1 has 128K context
limit = provider.get_context_limit("llama-3.1-8b")
assert limit == 128000
def test_get_context_limit_deepseek_v3_is_1m(self):
"""DeepSeek V3/V4 support 1M context, not 128K (#1038)."""
provider = OpenAICompatibleProvider()
assert provider.get_context_limit("deepseek-v3") == 1048576
assert provider.get_context_limit("deepseek-v4") == 1048576
assert provider.get_context_limit("deepseek") == 1048576
assert provider.get_context_limit("deepseek-v2") == 128000
assert provider.get_context_limit("deepseek-v3.2") == 128000
assert provider.get_context_limit("deepseek-v4-pro") == 1_000_000
assert provider.get_context_limit("deepseek-v4-flash") == 1_000_000
assert provider.get_context_limit("deepseek-r1") == 131072
assert provider.get_context_limit("deepseek-coder-v2") == 128000
def test_get_context_limit_unknown_model(self):
"""Test context limit for unknown models (defaults to 128K)."""
provider = OpenAICompatibleProvider()
limit = provider.get_context_limit("unknown-model")
assert limit == 128000
def test_register_model(self):
"""Test registering a custom model."""
provider = OpenAICompatibleProvider()
provider.register_model(
"my-model",
context_window=64000,
max_output_tokens=8192,
input_cost_per_1m=1.0,
output_cost_per_1m=2.0,
)
assert provider.get_context_limit("my-model") == 64000
def test_estimate_cost_registered_model(self):
"""Test cost estimation for registered model."""
provider = OpenAICompatibleProvider()
provider.register_model(
"priced-model",
input_cost_per_1m=1.0,
output_cost_per_1m=2.0,
)
cost = provider.estimate_cost(
input_tokens=1000000,
output_tokens=500000,
model="priced-model",
)
assert cost == 2.0 # 1.0 + 1.0
def test_estimate_cost_unknown_model(self):
"""Test cost estimation returns None for unknown model."""
provider = OpenAICompatibleProvider()
cost = provider.estimate_cost(
input_tokens=1000,
output_tokens=500,
model="unknown-model",
)
assert cost is None
def test_register_model_accepts_capabilities_object(self):
provider = OpenAICompatibleProvider()
caps = ModelCapabilities(model="caps-model", context_window=16000, tokenizer_backend="test")
provider.register_model("caps-model", capabilities=caps)
assert provider.get_context_limit("caps-model") == 16000
def test_get_token_counter_uses_registered_tokenizer_backend(self, monkeypatch):
recorded: list[tuple[str, str | None]] = []
class DummyTokenizer:
def count_text(self, text: str) -> int:
return len(text.split())
monkeypatch.setattr(
"headroom.providers.openai_compatible.get_tokenizer",
lambda model, backend=None: recorded.append((model, backend)) or DummyTokenizer(),
)
provider = OpenAICompatibleProvider(
models={
"custom-model": ModelCapabilities(
model="custom-model",
tokenizer_backend="custom-backend",
)
}
)
counter = provider.get_token_counter("custom-model")
assert counter.count_text("one two three") == 3
assert recorded == [("custom-model", "custom-backend")]
def test_openai_compatible_token_counter_counts_message_parts(self, monkeypatch):
class DummyTokenizer:
def count_text(self, text: str) -> int:
return len(text)
monkeypatch.setattr(
"headroom.providers.openai_compatible.get_tokenizer",
lambda model, backend=None: DummyTokenizer(),
)
counter = OpenAICompatibleProvider().get_token_counter("demo-model")
tokens = counter.count_message(
{
"role": "user",
"content": [{"type": "text", "text": "hi"}, "there"],
"name": "tester",
"tool_calls": [{"function": {"name": "lookup", "arguments": '{"x":1}'}}],
"tool_call_id": "call_123",
}
)
total = counter.count_messages(
[
{"role": "user", "content": "hello"},
{"role": "assistant", "content": ["world"]},
]
)
assert tokens == 55
assert total == 34
def test_openai_compatible_token_counter_prices_declared_media(self, monkeypatch):
"""An image block costs tokens; a non dict/str part still contributes none.
This previously asserted that BOTH contribute 0 — i.e. it pinned the
defect. The counter handled only ``type == "text"``, so every other block
priced at ~0: measured on a 6,800-char block, tool_result / thinking /
document / mcp_tool_result all returned 8 tokens, overhead only. Counters
now delegate to the shared walker, which prices a declared image with the
pixel-based estimate (1600, the max after provider auto-resize) rather
than either ignoring it or serializing its base64 as text.
"""
class DummyTokenizer:
def count_text(self, text: str) -> int:
return len(text)
monkeypatch.setattr(
"headroom.providers.openai_compatible.get_tokenizer",
lambda model, backend=None: DummyTokenizer(),
)
counter = OpenAICompatibleProvider().get_token_counter("demo-model")
# Non-list, non-str content is still ignored.
assert counter.count_message({"role": "user", "content": {}}) == 8
# A bare int is not a block and still contributes nothing.
assert counter.count_message({"role": "user", "content": [123]}) == 8
# A declared image is now priced instead of silently free.
assert counter.count_message({"role": "user", "content": [{"type": "image"}, 123]}) == 1608
def test_get_context_limit_prefix_output_buffer_and_partial_pricing(self):
provider = OpenAICompatibleProvider(
models={
"buffered": ModelCapabilities(
model="buffered",
max_output_tokens=1200,
input_cost_per_1m=1.0,
)
}
)
assert provider.get_context_limit("mistral-custom") == 32768
assert provider.get_output_buffer("buffered", default=4000) == 1200
assert provider.get_output_buffer("unknown", default=2222) == 2222
assert provider.estimate_cost(1000, 1000, "buffered") is None
class TestModelCapabilities:
"""Tests for ModelCapabilities dataclass."""
def test_default_values(self):
"""Test default capability values."""
caps = ModelCapabilities(model="test-model")
assert caps.context_window == 128000
assert caps.max_output_tokens == 4096
assert caps.supports_tools is True
assert caps.supports_vision is False
assert caps.supports_streaming is True
def test_custom_values(self):
"""Test custom capability values."""
caps = ModelCapabilities(
model="custom-model",
context_window=32000,
max_output_tokens=16384,
supports_tools=False,
supports_vision=True,
input_cost_per_1m=0.5,
output_cost_per_1m=1.5,
)
assert caps.context_window == 32000
assert caps.max_output_tokens == 16384
assert caps.supports_tools is False
assert caps.supports_vision is True
assert caps.input_cost_per_1m == 0.5
assert caps.output_cost_per_1m == 1.5
class TestGoogleProvider:
"""Tests for GoogleProvider."""
@pytest.fixture
def provider(self):
"""Create Google provider."""
return GoogleProvider()
def test_name(self, provider):
"""Test provider name."""
assert provider.name == "google"
def test_supports_gemini_models(self, provider):
"""Test support for Gemini models."""
assert provider.supports_model("gemini-2.0-flash") is True
assert provider.supports_model("gemini-1.5-pro") is True
assert provider.supports_model("gemini-1.5-flash") is True
def test_not_supports_other_models(self, provider):
"""Test non-support for other models."""
assert provider.supports_model("gpt-4o") is False
assert provider.supports_model("claude-3") is False
def test_get_token_counter(self, provider):
"""Test getting token counter."""
counter = provider.get_token_counter("gemini-2.0-flash")
assert counter is not None
count = counter.count_text("Hello, world!")
assert count > 0
def test_get_context_limit_gemini_2(self, provider):
"""Test context limit for Gemini 2.0."""
limit = provider.get_context_limit("gemini-2.0-flash")
# LiteLLM returns 1048576 (2^20), fallback returns 1000000
assert limit in (1000000, 1048576) # ~1M tokens
def test_get_context_limit_gemini_1_5_pro(self, provider):
"""Test context limit for Gemini 1.5 Pro (2M!)."""
limit = provider.get_context_limit("gemini-1.5-pro")
# LiteLLM returns 2097152 (2^21), fallback returns 2000000
assert limit in (2000000, 2097152) # ~2M tokens!
def test_estimate_cost(self, provider):
"""Test cost estimation."""
cost = provider.estimate_cost(
input_tokens=1000000,
output_tokens=500000,
model="gemini-2.0-flash",
)
assert cost is not None
# 1M input * $0.10 + 0.5M output * $0.40 = $0.10 + $0.20 = $0.30
assert abs(cost - 0.30) < 0.01
def test_openai_compatible_url(self):
"""Test OpenAI-compatible URL."""
url = GoogleProvider.get_openai_compatible_url("test-key")
assert "generativelanguage.googleapis.com" in url
class TestProviderFactoryFunctions:
"""Tests for provider factory functions."""
def test_create_ollama_provider(self):
"""Test creating Ollama provider."""
provider = create_ollama_provider()
assert provider.name == "ollama"
assert provider.base_url == "http://localhost:11434/v1"
def test_create_ollama_provider_custom_url(self):
"""Test creating Ollama provider with custom URL."""
provider = create_ollama_provider("http://192.168.1.100:11434/v1")
assert provider.base_url == "http://192.168.1.100:11434/v1"
def test_create_together_provider(self):
"""Test creating Together provider."""
provider = create_together_provider()
assert provider.name == "together"
assert "together.xyz" in provider.base_url
def test_create_groq_provider(self):
"""Test creating Groq provider."""
provider = create_groq_provider()
assert provider.name == "groq"
assert "groq.com" in provider.base_url
def test_create_vllm_provider(self):
"""Test creating vLLM provider."""
provider = create_vllm_provider("http://localhost:8000/v1")
assert provider.name == "vllm"
assert provider.base_url == "http://localhost:8000/v1"
def test_create_lmstudio_provider(self):
"""Test creating LM Studio provider."""
provider = create_lmstudio_provider()
assert provider.name == "lmstudio"
assert provider.base_url == "http://localhost:1234/v1"
def test_create_fireworks_and_anyscale_providers(self):
fireworks = create_fireworks_provider(api_key="fireworks-key")
anyscale = create_anyscale_provider(api_key="anyscale-key")
assert fireworks.name == "fireworks"
assert fireworks.base_url == "https://api.fireworks.ai/inference/v1"
assert fireworks.api_key == "fireworks-key"
assert anyscale.name == "anyscale"
assert anyscale.base_url == "https://api.endpoints.anyscale.com/v1"
assert anyscale.api_key == "anyscale-key"
class TestLiteLLMProvider:
"""Tests for LiteLLM provider."""
def test_is_litellm_available(self):
"""Test checking LiteLLM availability."""
result = is_litellm_available()
assert isinstance(result, bool)
def test_unavailable_litellm_paths(self, monkeypatch):
import headroom.providers.litellm as litellm_module
monkeypatch.setattr(litellm_module, "LITELLM_AVAILABLE", False)
assert litellm_module.is_litellm_available() is False
assert litellm_module.LiteLLMProvider.list_supported_providers() == []
with pytest.raises(RuntimeError, match="LiteLLM is required"):
litellm_module.LiteLLMTokenCounter("gpt-4o")
with pytest.raises(RuntimeError, match="LiteLLM is required"):
litellm_module.LiteLLMProvider()
def test_litellm_token_counter_fallback_paths(self, monkeypatch):
import headroom.providers.litellm as litellm_module
class DummyFallback:
def count_text(self, text: str) -> int:
return len(text.split())
monkeypatch.setattr(litellm_module, "LITELLM_AVAILABLE", True)
monkeypatch.setattr(
litellm_module,
"litellm_token_counter",
lambda **kwargs: (_ for _ in ()).throw(RuntimeError("boom")),
)
monkeypatch.setattr(litellm_module, "EstimatingTokenCounter", DummyFallback)
counter = litellm_module.LiteLLMTokenCounter("gpt-4o")
assert counter.count_text("") == 0
assert counter.count_text("one two three") == 3
assert counter.count_message({"content": "one two"}) == 6
assert counter.count_messages([]) == 0
assert counter.count_messages([{"content": "one two"}, {"content": "three"}]) == 14
def test_litellm_provider_info_and_cost_fallbacks(self, monkeypatch):
import headroom.providers.litellm as litellm_module
monkeypatch.setattr(litellm_module, "LITELLM_AVAILABLE", True)
monkeypatch.setattr(
litellm_module,
"litellm_get_model_info",
lambda model: {
"ctx-model": {"max_input_tokens": 64000},
"max-model": {"max_tokens": 32000},
"none-model": {"max_input_tokens": None, "max_output_tokens": None},
"output-model": {"max_output_tokens": 6000},
}[model],
)
# Cost now resolves through the shared pricing helper rather than a
# direct `litellm.completion_cost` call, so patch that seam. The helper
# returns None (not an exception) for a model LiteLLM can't price.
monkeypatch.setattr(
litellm_module,
"estimate_cost_from_tokens",
lambda model, **kwargs: 1.23 if model == "priced-model" else None,
)
provider = litellm_module.LiteLLMProvider()
assert provider.get_context_limit("ctx-model") == 64000
assert provider.get_context_limit("max-model") == 32000
assert provider.get_context_limit("none-model") == 128000
assert provider.get_output_buffer("output-model", default=4000) == 4000
assert provider.get_output_buffer("none-model", default=2222) == 2222
assert provider.estimate_cost(1000, 1000, "priced-model") == 1.23
assert provider.estimate_cost(1000, 1000, "missing-price") is None
def test_litellm_provider_handles_info_exceptions_and_factory(self, monkeypatch):
import headroom.providers.litellm as litellm_module
monkeypatch.setattr(litellm_module, "LITELLM_AVAILABLE", True)
monkeypatch.setattr(
litellm_module,
"litellm_get_model_info",
lambda model: (_ for _ in ()).throw(RuntimeError("boom")),
)
provider = create_litellm_provider()
assert isinstance(provider, LiteLLMProvider)
assert provider.get_context_limit("gpt-4o") == 128000
assert provider.get_output_buffer("gpt-4o", default=3333) == 3333
@pytest.mark.skipif(
not is_litellm_available(),
reason="LiteLLM not installed",
)
def test_create_litellm_provider(self):
"""Test creating LiteLLM provider."""
from headroom.providers import create_litellm_provider
provider = create_litellm_provider()
assert provider.name == "litellm"
@pytest.mark.skipif(
not is_litellm_available(),
reason="LiteLLM not installed",
)
def test_litellm_supports_any_model(self):
"""Test LiteLLM supports any model."""
from headroom.providers import create_litellm_provider
provider = create_litellm_provider()
assert provider.supports_model("gpt-4o") is True
assert provider.supports_model("claude-3-sonnet") is True
assert provider.supports_model("any-model") is True
@pytest.mark.skipif(
not is_litellm_available(),
reason="LiteLLM not installed",
)
def test_litellm_list_providers(self):
"""Test listing LiteLLM providers."""
from headroom.providers import LiteLLMProvider
providers = LiteLLMProvider.list_supported_providers()
assert "openai" in providers
assert "anthropic" in providers
assert "ollama" in providers