headroom/tests/test_provider_model_fallback.py
Abhay Singh 3ed8f76019
fix(providers): don't crash on a non-object HEADROOM_MODEL_LIMITS / models.json (#3089)
## Description

`_load_custom_model_config` in both `headroom/providers/anthropic.py`
and `headroom/providers/openai.py` loads the operator's custom model
configuration from `HEADROOM_MODEL_LIMITS` (a JSON string or a file
path) and `~/.headroom/models.json`, then reads it with
`loaded.get(...)`:

```python
loaded = json.loads(env_config)          # or json.load(f)
anthropic_config = loaded.get("anthropic", loaded)
```

The `try` guards only `except (json.JSONDecodeError, OSError)`. When the
value is **valid JSON but not an object** (a JSON array, number, string,
bool, or `null`), `json.loads` succeeds and returns a non-dict, so
`loaded.get(...)` raises `AttributeError` — which is *not* one of the
caught types. Instead of the intended warn-and-fall-back-to-defaults, a
misconfigured `HEADROOM_MODEL_LIMITS` (e.g.
`HEADROOM_MODEL_LIMITS='[1,2,3]'` or `'"gpt-4"'`) crashes provider
initialization. The same gap exists in the `models.json` branch of both
providers.

## Fix

After each load, validate `isinstance(loaded, dict)` and raise
`ValueError` with a clear message, and broaden the handler from `except
(json.JSONDecodeError, OSError)` to `except (ValueError, OSError)`.
`json.JSONDecodeError` is a subclass of `ValueError`, so this strictly
supersets the previous handling: every previously-caught malformed value
still warns and falls back, and a valid-JSON-but-non-object value now
does too, instead of crashing.

## Type of Change

- [x] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature
- [ ] Breaking change
- [ ] Documentation update
- [ ] Performance improvement
- [ ] Code refactoring (no functional changes)

## Changes Made

- `headroom/providers/anthropic.py` and `headroom/providers/openai.py`
(`_load_custom_model_config`): add an `isinstance(loaded, dict)` guard
(raising `ValueError`) after the env-var load and after the
`models.json` load, and change both `except` clauses to `(ValueError,
OSError)`.
- `tests/test_provider_model_fallback.py`: added parametrized
`test_non_object_env_var_falls_back_to_defaults` (array / string /
number / bool / null) for both providers, and
`test_non_object_config_file_falls_back_to_defaults` for a non-object
`models.json`.

## Testing

- [x] Unit tests pass (`pytest`)
- [x] Linting passes (`ruff check`)
- [x] Type checking passes (`mypy`)
- [x] New tests added

### Test Output

```text
tests/test_provider_model_fallback.py  44 passed
# uvx ruff@0.15.22 check  -> All checks passed!
# uvx mypy@1.20.2 headroom/providers/anthropic.py headroom/providers/openai.py -> Success: no issues found in 2 source files
```

## Real Behavior Proof

- Environment: Windows 11, Python 3.12.11, project venv, pytest 9.1.1,
ruff 0.15.22 and mypy 1.20.2 via uvx.
- Exact command / steps: reverted both providers and ran the new
regressions to capture the bug (`python -m pytest
tests/test_provider_model_fallback.py::TestAnthropicConfigLoading::test_non_object_env_var_falls_back_to_defaults
tests/test_provider_model_fallback.py::TestOpenAIConfigLoading::test_non_object_env_var_falls_back_to_defaults
tests/test_provider_model_fallback.py::TestAnthropicConfigLoading::test_non_object_config_file_falls_back_to_defaults`
-> 11 failed with `AttributeError` on `loaded.get` across the
array/string/number/bool/null shapes); restored the fix; re-ran the full
file (`python -m pytest tests/test_provider_model_fallback.py` -> 44
passed); then `uvx ruff@0.15.22 format`, `uvx ruff@0.15.22 check`, and
`uvx mypy@1.20.2` on both providers.
- Observed result: before the fix, `HEADROOM_MODEL_LIMITS='[1,2,3]'` (or
`'"gpt-4"'`, `'42'`, `'true'`, `'null'`) raised `AttributeError` out of
`_load_custom_model_config`; after the fix the same values log a warning
and the loader returns the default `{"context_limits": {}, "pricing":
{}[, "encodings": {}]}`, and a well-formed object config is unchanged.
- Not tested: a live proxy boot with a corrupt `HEADROOM_MODEL_LIMITS`
(the loader is exercised directly, which is the exact function provider
init calls).

## Runtime Rollout Safety

- Rollout-managed feature(s): none. This is defensive parsing in the
provider model-config loader, not a rollout-channel-gated runtime
feature.
- Minimum rollout channel: N/A (no rollout-managed behavior).
- Stable/default behavior changed: only for a previously-crashing input.
A non-object `HEADROOM_MODEL_LIMITS` / `models.json` now warns and uses
built-in defaults instead of raising. Well-formed object configs are
parsed exactly as before.
- Kill switch / disable path: N/A — remove or correct the malformed
config value to load custom limits.
- Unsafe override required: no.
- Qualification impact: a corrupt or mistyped model-limits value
degrades to built-in defaults with a warning rather than failing
provider init.
- Rollback path: revert this PR; the loader returns to catching only
`json.JSONDecodeError`/`OSError`.

## 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 my code, particularly in hard-to-understand areas
- [x] My changes generate no new warnings
- [x] I have added tests that prove my fix is effective
- [x] New and existing unit tests pass locally with my changes
- [x] I did **not** edit `CHANGELOG.md`: it is generated by
release-please from my Conventional Commit PR title

## Additional Notes

Both providers carry the same loader shape, so the guard and the widened
`except` are applied identically to keep them in sync. The message names
the offending source (`HEADROOM_MODEL_LIMITS` vs the resolved
config-file path) so the warning is actionable.
2026-08-17 20:18:58 -07:00

432 lines
17 KiB
Python

"""Tests for provider model fallback and configuration."""
import json
import os
import tempfile
from pathlib import Path
from unittest.mock import patch
import pytest
from headroom.providers.anthropic import (
AnthropicProvider,
_infer_model_tier,
)
from headroom.providers.anthropic import (
_load_custom_model_config as anthropic_load_config,
)
from headroom.providers.google import GeminiTokenCounter, GoogleProvider
from headroom.providers.openai import (
OpenAIProvider,
_infer_model_family,
)
from headroom.providers.openai import (
_load_custom_model_config as openai_load_config,
)
class TestGoogleModelFallback:
"""Tests for Google provider model fallback."""
def test_future_gemini_model_uses_registry_family_fallback(self):
"""Future Gemini models should not hard-fail token counting."""
provider = GoogleProvider()
with patch("headroom.models.registry.get_model_pricing", return_value=None):
assert provider.supports_model("gemini-3-pro-preview")
assert provider.get_context_limit("gemini-3-pro-preview") == 1000000
assert isinstance(
provider.get_token_counter("gemini-3-pro-preview"),
GeminiTokenCounter,
)
def test_litellm_prefixed_gemini_model_uses_registry_family_fallback(self):
"""LiteLLM-style Gemini ids should resolve through the Google provider."""
provider = GoogleProvider()
with patch("headroom.models.registry.get_model_pricing", return_value=None):
assert provider.supports_model("gemini/gemini-3-pro-preview")
assert provider.get_context_limit("gemini/gemini-3-pro-preview") == 1000000
def test_google_legacy_context_limits_are_preserved(self):
"""Moving lookup through ModelRegistry must keep legacy Gemini limits."""
provider = GoogleProvider()
with patch("headroom.models.registry.get_model_pricing", return_value=None):
assert provider.get_context_limit("gemini-1.5-pro-latest") == 2000000
assert provider.get_context_limit("gemini-1.0-pro") == 32768
def test_unknown_non_gemini_model_still_rejected(self):
"""The Google provider should not claim unrelated unknown models."""
provider = GoogleProvider()
assert not provider.supports_model("not-a-google-model")
assert not provider.supports_model("gpt-4o")
with pytest.raises(ValueError):
provider.get_token_counter("not-a-google-model")
class TestAnthropicModelFallback:
"""Tests for Anthropic provider model fallback."""
def test_known_claude_4_models(self):
"""Test that Claude 4/4.5 models are recognized."""
provider = AnthropicProvider()
# Claude Opus 4.5
assert provider.get_context_limit("claude-opus-4-5-20251101") == 200000
assert provider.supports_model("claude-opus-4-5-20251101")
# Claude Sonnet 4
assert provider.get_context_limit("claude-sonnet-4-20250514") == 200000
assert provider.supports_model("claude-sonnet-4-20250514")
# Claude Haiku 4
assert provider.get_context_limit("claude-haiku-4-5-20251001") == 200000
assert provider.supports_model("claude-haiku-4-5-20251001")
def test_pattern_based_inference_opus(self):
"""Test pattern-based inference for opus models."""
provider = AnthropicProvider()
# Future opus model should infer 200K and opus pricing
limit = provider.get_context_limit("claude-opus-5-20260101")
assert limit == 200000
pricing = provider._get_pricing("claude-opus-5-20260101")
assert pricing["input"] == 5.00
assert pricing["output"] == 25.00
def test_pattern_based_inference_sonnet(self):
"""Test pattern-based inference for sonnet models."""
provider = AnthropicProvider()
limit = provider.get_context_limit("claude-sonnet-6-20260101")
assert limit == 200000
pricing = provider._get_pricing("claude-sonnet-6-20260101")
assert pricing["input"] == 3.00
assert pricing["output"] == 15.00
def test_pattern_based_inference_haiku(self):
"""Test pattern-based inference for haiku models."""
provider = AnthropicProvider()
limit = provider.get_context_limit("claude-haiku-5-20260101")
assert limit == 200000
pricing = provider._get_pricing("claude-haiku-5-20260101")
assert pricing["input"] == 0.80
assert pricing["output"] == 4.00
def test_unknown_claude_model_fallback(self):
"""Test fallback for unknown Claude models."""
provider = AnthropicProvider()
# Unknown Claude model should get 200K default
limit = provider.get_context_limit("claude-unknown-model")
assert limit == 200000
# Should still support it
assert provider.supports_model("claude-unknown-model")
def test_no_exception_for_unknown_model(self):
"""Test that unknown models don't raise exceptions."""
provider = AnthropicProvider()
# Should not raise
limit = provider.get_context_limit("claude-future-model-xyz")
assert limit > 0
def test_infer_model_tier(self):
"""Test model tier inference."""
assert _infer_model_tier("claude-opus-4-5-20251101") == "opus"
assert _infer_model_tier("claude-sonnet-4-20250514") == "sonnet"
assert _infer_model_tier("claude-haiku-4-5-20251001") == "haiku"
assert _infer_model_tier("claude-3-5-sonnet-latest") == "sonnet"
assert _infer_model_tier("CLAUDE-OPUS-FUTURE") == "opus" # Case insensitive
assert _infer_model_tier("some-other-model") is None
def test_explicit_context_limits_override(self):
"""Test that explicit context_limits override defaults."""
provider = AnthropicProvider(context_limits={"custom-model": 500000})
assert provider.get_context_limit("custom-model") == 500000
def test_pricing_for_known_models(self):
"""Test pricing retrieval for known models."""
provider = AnthropicProvider()
# Claude Opus 4.5
pricing = provider._get_pricing("claude-opus-4-5-20251101")
assert pricing["input"] == 5.00
assert pricing["output"] == 25.00
assert pricing["cached_input"] == 0.50
def test_cost_estimation_for_new_models(self):
"""Test cost estimation works for new models."""
provider = AnthropicProvider()
cost = provider.estimate_cost(
input_tokens=1000000,
output_tokens=100000,
model="claude-opus-4-5-20251101",
cached_tokens=0,
)
# $5/1M input + $25/1M * 0.1M output = $5 + $2.5 = $7.5
assert cost == pytest.approx(7.5, rel=0.01)
class TestAnthropicConfigLoading:
"""Tests for Anthropic config file/env var loading."""
def test_load_from_env_var_json(self):
"""Test loading config from JSON env var."""
config = {"context_limits": {"test-model": 300000}}
with patch.dict(os.environ, {"HEADROOM_MODEL_LIMITS": json.dumps(config)}):
loaded = anthropic_load_config()
assert loaded["context_limits"]["test-model"] == 300000
def test_load_from_env_var_file(self):
"""Test loading config from file path in env var."""
config = {"context_limits": {"file-model": 400000}}
with tempfile.TemporaryDirectory() as tmpdir:
config_path = Path(tmpdir) / "model_limits.json"
config_path.write_text(json.dumps(config))
with patch.dict(os.environ, {"HEADROOM_MODEL_LIMITS": str(config_path)}):
loaded = anthropic_load_config()
assert loaded["context_limits"]["file-model"] == 400000
def test_load_from_config_file(self):
"""Test loading from ~/.headroom/models.json."""
config = {
"anthropic": {
"context_limits": {"config-model": 250000},
"pricing": {"config-model": {"input": 5.0, "output": 25.0}},
}
}
with tempfile.TemporaryDirectory() as tmpdir:
config_dir = Path(tmpdir) / ".headroom"
config_dir.mkdir()
config_file = config_dir / "models.json"
config_file.write_text(json.dumps(config))
with patch.object(Path, "home", return_value=Path(tmpdir)):
loaded = anthropic_load_config()
assert loaded["context_limits"]["config-model"] == 250000
def test_env_var_overrides_config_file(self):
"""Test that env var takes precedence over config file."""
env_config = {"context_limits": {"test-model": 100000}}
file_config = {"anthropic": {"context_limits": {"test-model": 200000}}}
with tempfile.TemporaryDirectory() as tmpdir:
config_dir = Path(tmpdir) / ".headroom"
config_dir.mkdir()
config_file = config_dir / "models.json"
config_file.write_text(json.dumps(file_config))
with patch.object(Path, "home", return_value=Path(tmpdir)):
with patch.dict(os.environ, {"HEADROOM_MODEL_LIMITS": json.dumps(env_config)}):
loaded = anthropic_load_config()
# Env var should win
assert loaded["context_limits"]["test-model"] == 100000
@pytest.mark.parametrize("raw", ["[1, 2, 3]", '"gpt-4"', "42", "true", "null"])
def test_non_object_env_var_falls_back_to_defaults(self, raw):
"""A valid-JSON-but-not-an-object env var must warn and use defaults,
not crash provider init with AttributeError on ``loaded.get``."""
with patch.dict(os.environ, {"HEADROOM_MODEL_LIMITS": raw}):
loaded = anthropic_load_config()
assert loaded == {"context_limits": {}, "pricing": {}}
def test_non_object_config_file_falls_back_to_defaults(self):
"""A models.json whose top level is not an object must not crash."""
with tempfile.TemporaryDirectory() as tmpdir:
config_dir = Path(tmpdir) / ".headroom"
config_dir.mkdir()
(config_dir / "models.json").write_text("[1, 2, 3]")
with patch.object(Path, "home", return_value=Path(tmpdir)):
loaded = anthropic_load_config()
assert loaded == {"context_limits": {}, "pricing": {}}
class TestOpenAIModelFallback:
"""Tests for OpenAI provider model fallback."""
def test_known_models(self):
"""Test that known models work."""
provider = OpenAIProvider()
assert provider.get_context_limit("gpt-4o") == 128000
assert provider.get_context_limit("gpt-4o-mini") == 128000
assert provider.get_context_limit("o1") == 200000
assert provider.get_context_limit("o3-mini") == 200000
def test_pattern_based_inference_gpt4o(self):
"""Test pattern-based inference for gpt-4o models."""
provider = OpenAIProvider()
# Future gpt-4o model
limit = provider.get_context_limit("gpt-4o-2025-01-01")
assert limit == 128000
def test_pattern_based_inference_o1(self):
"""Test pattern-based inference for o1 models."""
provider = OpenAIProvider()
limit = provider.get_context_limit("o1-super-2025")
assert limit == 200000
def test_pattern_based_inference_o3(self):
"""Test pattern-based inference for o3 models."""
provider = OpenAIProvider()
limit = provider.get_context_limit("o3-large-2025")
assert limit == 200000
def test_unknown_model_fallback(self):
"""Test fallback for unknown models."""
provider = OpenAIProvider()
# Unknown model should get 128K default. Deliberately a name that
# matches no known family prefix -- this used to say "gpt-5-future",
# which stopped being unknown once gpt-5 was added to _CONTEXT_LIMITS.
limit = provider.get_context_limit("gpt-9-imaginary")
assert limit == 128000
def test_unknown_variant_inherits_its_family_limit(self):
"""An unrecognized variant of a *known* family takes that family's limit.
This is the same prefix inheritance that gives "gpt-4o-2024-11-20" the
gpt-4o limit, and it is strictly better than dropping such a model to
the generic 128K default.
"""
provider = OpenAIProvider()
assert provider.get_context_limit("gpt-5-future") == 272000
assert provider.get_context_limit("gpt-4.1-preview") == 1_047_576
def test_no_exception_for_unknown_model(self):
"""Test that unknown models don't raise exceptions."""
provider = OpenAIProvider()
# Should not raise
limit = provider.get_context_limit("gpt-future-xyz")
assert limit > 0
def test_infer_model_family(self):
"""Test model family inference."""
assert _infer_model_family("gpt-4o-2024-11-20") == "gpt-4o"
assert _infer_model_family("gpt-4-turbo-preview") == "gpt-4-turbo"
assert _infer_model_family("gpt-4") == "gpt-4"
assert _infer_model_family("gpt-3.5-turbo") == "gpt-3.5"
assert _infer_model_family("o1-preview") == "o1"
assert _infer_model_family("o3-mini") == "o3"
assert _infer_model_family("unknown") is None
def test_explicit_context_limits_override(self):
"""Test that explicit context_limits override defaults."""
provider = OpenAIProvider(context_limits={"custom-model": 500000})
assert provider.get_context_limit("custom-model") == 500000
def test_supports_model_expanded(self):
"""Test that supports_model works for new patterns."""
provider = OpenAIProvider()
# Should support any gpt-* or o1/o3
assert provider.supports_model("gpt-4o")
assert provider.supports_model("gpt-4o-future")
assert provider.supports_model("gpt-5-future")
assert provider.supports_model("o1-mega")
assert provider.supports_model("o3-ultra")
class TestOpenAIConfigLoading:
"""Tests for OpenAI config file/env var loading."""
def test_load_from_env_var_json(self):
"""Test loading config from JSON env var."""
config = {"openai": {"context_limits": {"test-model": 300000}}}
with patch.dict(os.environ, {"HEADROOM_MODEL_LIMITS": json.dumps(config)}):
loaded = openai_load_config()
assert loaded["context_limits"]["test-model"] == 300000
def test_load_pricing_from_config(self):
"""Test loading pricing from config."""
config = {"openai": {"pricing": {"test-model": [5.0, 15.0]}}}
with tempfile.TemporaryDirectory() as tmpdir:
config_path = Path(tmpdir) / "model_limits.json"
config_path.write_text(json.dumps(config))
with patch.dict(os.environ, {"HEADROOM_MODEL_LIMITS": str(config_path)}):
loaded = openai_load_config()
assert loaded["pricing"]["test-model"] == [5.0, 15.0]
@pytest.mark.parametrize("raw", ["[1, 2, 3]", '"gpt-4"', "42", "true", "null"])
def test_non_object_env_var_falls_back_to_defaults(self, raw):
"""A valid-JSON-but-not-an-object env var must warn and use defaults,
not crash provider init with AttributeError on ``loaded.get``."""
with patch.dict(os.environ, {"HEADROOM_MODEL_LIMITS": raw}):
loaded = openai_load_config()
assert loaded == {"context_limits": {}, "pricing": {}, "encodings": {}}
class TestCrossProviderConsistency:
"""Tests for consistency across providers."""
def test_both_providers_use_same_env_var(self):
"""Test that both providers use HEADROOM_MODEL_LIMITS."""
config = {
"anthropic": {"context_limits": {"anthropic-model": 100000}},
"openai": {"context_limits": {"openai-model": 200000}},
}
with patch.dict(os.environ, {"HEADROOM_MODEL_LIMITS": json.dumps(config)}):
anthropic = anthropic_load_config()
openai = openai_load_config()
assert anthropic["context_limits"]["anthropic-model"] == 100000
assert openai["context_limits"]["openai-model"] == 200000
def test_both_providers_never_raise_for_unknown_models(self):
"""Test that neither provider raises for unknown models."""
anthropic = AnthropicProvider()
openai = OpenAIProvider()
# Neither should raise
anthropic.get_context_limit("claude-future-model-xyz")
openai.get_context_limit("gpt-future-model-xyz")
def test_both_providers_warn_for_unknown_models(self):
"""Test that both providers warn for unknown models."""
# Clear warning caches
from headroom.providers import anthropic as anthropic_module
from headroom.providers import openai as openai_module
anthropic_module._UNKNOWN_MODEL_WARNINGS.clear()
openai_module._UNKNOWN_MODEL_WARNINGS.clear()
with (
patch.object(anthropic_module.logger, "warning") as anthropic_warning,
patch.object(openai_module.logger, "warning") as openai_warning,
):
anthropic = AnthropicProvider()
anthropic.get_context_limit("claude-test-unknown-model")
openai = OpenAIProvider()
openai.get_context_limit("gpt-test-unknown-model")
anthropic_warning.assert_called_once()
openai_warning.assert_called_once()
assert "claude-test-unknown-model" in anthropic_warning.call_args.args[0]
assert "gpt-test-unknown-model" in openai_warning.call_args.args[0]