mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
## Description `_to_anthropic_response` in both backends converts a non-streaming OpenAI-shape response to Anthropic shape and indexes the first choice directly: ```python # headroom/backends/litellm.py choice = litellm_response.choices[0] # headroom/backends/anyllm.py choice = response.choices[0] ``` A non-streaming upstream response can be HTTP 200 with an **empty** `choices` list: Azure OpenAI content filtering does exactly this, and any OpenAI-compatible gateway can return a usage-only / filtered turn the same way. With `choices: []`, `choices[0]` raises `IndexError`, which surfaces as a 500 for the request instead of a normal (if empty) turn. This is an intra-file asymmetry: the streaming siblings in the same two files already guard it (`if not chunk.choices: continue` / `if hasattr(chunk, "choices") and chunk.choices:`), and `headroom/proxy/handlers/openai.py` documents the exact hazard in `_apply_stream_usage_option`: "the common `chunk.choices[0].delta` pattern then raises IndexError" on a usage-only `choices: []` chunk. The non-streaming converters just never got the same guard. ## Fix Return a valid empty assistant turn (`content: []`, `stop_reason: "end_turn"`, usage still mapped) when `choices` is empty, before indexing. The client gets a clean empty response instead of a 500, matching how the streaming path already tolerates the same shape. Non-empty responses 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 - `headroom/backends/litellm.py`: empty-`choices` guard at the top of `_to_anthropic_response`, returning an empty assistant turn with mapped usage. - `headroom/backends/anyllm.py`: same guard in its `_to_anthropic_response`. - `tests/test_litellm_nonstream_cache_usage.py`, `tests/test_backend_anyllm.py`: regressions passing an empty-`choices` response through each converter and asserting an empty turn instead of IndexError. ## 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 ### Test Output ```text $ python -m pytest tests/test_litellm_nonstream_cache_usage.py::test_to_anthropic_response_empty_choices_returns_empty_turn tests/test_backend_anyllm.py::test_to_anthropic_response_empty_choices_returns_empty_turn -q 2 passed # with the fix reverted, both fail with # IndexError: list index out of range $ uvx ruff@0.15.17 check headroom/backends/litellm.py headroom/backends/anyllm.py tests/test_backend_anyllm.py tests/test_litellm_nonstream_cache_usage.py All checks passed! $ uvx mypy@1.20.2 --ignore-missing-imports headroom/backends/litellm.py headroom/backends/anyllm.py Success: no issues found in 2 source files ``` Note: `tests/test_backend_anyllm.py` has 7 `@pytest.mark.asyncio` tests that fail locally because pytest-asyncio is not configured in this environment (`Unknown config option: asyncio_mode`); they are unrelated to this change and pass in CI. The two new tests here are synchronous and pass locally. ## Real Behavior Proof - Environment: Windows 11, Python 3.12, project venv (`uv sync --extra proxy`), `uvx ruff@0.15.17` / `uvx mypy@1.20.2`, pytest in the venv. - Exact command / steps: built a response stand-in with `choices=[]` and a usage object, called `LiteLLMBackend._to_anthropic_response` (on a bare `object.__new__` instance) and `AnyLLMBackend._to_anthropic_response` (via the file's fake-backend fixture); then reverted both backend files and re-ran. - Observed result: with the fix each converter returns `{type: message, role: assistant, content: [], stop_reason: end_turn, usage: {...}}` with the input/output token counts mapped; with the fix reverted both raise `IndexError: list index out of range`. Ran against the actual modules via the two test files. - Not tested: a live Azure OpenAI content-filtered response routed through the backend end to end. ## 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 - [ ] 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
474 lines
16 KiB
Python
474 lines
16 KiB
Python
from __future__ import annotations
|
|
|
|
from types import SimpleNamespace
|
|
|
|
import pytest
|
|
|
|
from headroom.backends import anyllm
|
|
from headroom.backends.base import BackendResponse, StreamEvent
|
|
|
|
|
|
class FakeAsyncStream:
|
|
def __init__(self, items) -> None: # noqa: ANN001
|
|
self._items = list(items)
|
|
|
|
def __aiter__(self):
|
|
self._iter = iter(self._items)
|
|
return self
|
|
|
|
async def __anext__(self):
|
|
try:
|
|
return next(self._iter)
|
|
except StopIteration as exc:
|
|
raise StopAsyncIteration from exc
|
|
|
|
|
|
class FakeAnyLLMInstance:
|
|
def __init__(self) -> None:
|
|
self.calls: list[dict[str, object]] = []
|
|
self.response = None
|
|
self.raise_error: Exception | None = None
|
|
|
|
async def acompletion(self, **kwargs): # noqa: ANN003
|
|
self.calls.append(kwargs)
|
|
if self.raise_error is not None:
|
|
raise self.raise_error
|
|
return self.response
|
|
|
|
|
|
def make_backend(
|
|
monkeypatch: pytest.MonkeyPatch, provider: str = "groq"
|
|
) -> tuple[anyllm.AnyLLMBackend, FakeAnyLLMInstance]:
|
|
fake_instance = FakeAnyLLMInstance()
|
|
|
|
class FakeAnyLLM:
|
|
@staticmethod
|
|
def create(requested_provider: str, **kwargs): # noqa: ANN003
|
|
assert requested_provider == provider
|
|
return fake_instance
|
|
|
|
monkeypatch.setattr(anyllm, "ANYLLM_AVAILABLE", True)
|
|
monkeypatch.setattr(anyllm, "AnyLLM", FakeAnyLLM)
|
|
return anyllm.AnyLLMBackend(provider=provider.upper()), fake_instance
|
|
|
|
|
|
def test_init_forwards_api_base_and_api_key(monkeypatch: pytest.MonkeyPatch) -> None:
|
|
"""Regression for #942: custom api_base/api_key must reach AnyLLM.create."""
|
|
fake_instance = FakeAnyLLMInstance()
|
|
create_calls: list[dict[str, object]] = []
|
|
|
|
class FakeAnyLLM:
|
|
@staticmethod
|
|
def create(requested_provider: str, **kwargs): # noqa: ANN003
|
|
create_calls.append({"provider": requested_provider, **kwargs})
|
|
return fake_instance
|
|
|
|
monkeypatch.setattr(anyllm, "ANYLLM_AVAILABLE", True)
|
|
monkeypatch.setattr(anyllm, "AnyLLM", FakeAnyLLM)
|
|
|
|
backend = anyllm.AnyLLMBackend(
|
|
provider="openai",
|
|
api_key="sk-custom",
|
|
api_base="https://custom-provider.example/v1",
|
|
)
|
|
|
|
assert backend.api_base == "https://custom-provider.example/v1"
|
|
assert create_calls == [
|
|
{
|
|
"provider": "openai",
|
|
"api_key": "sk-custom",
|
|
"api_base": "https://custom-provider.example/v1",
|
|
}
|
|
]
|
|
|
|
|
|
def test_init_omits_unset_api_base_and_api_key(monkeypatch: pytest.MonkeyPatch) -> None:
|
|
"""Unset overrides must not be forwarded, preserving provider env defaults."""
|
|
fake_instance = FakeAnyLLMInstance()
|
|
create_calls: list[dict[str, object]] = []
|
|
|
|
class FakeAnyLLM:
|
|
@staticmethod
|
|
def create(requested_provider: str, **kwargs): # noqa: ANN003
|
|
create_calls.append({"provider": requested_provider, **kwargs})
|
|
return fake_instance
|
|
|
|
monkeypatch.setattr(anyllm, "ANYLLM_AVAILABLE", True)
|
|
monkeypatch.setattr(anyllm, "AnyLLM", FakeAnyLLM)
|
|
|
|
anyllm.AnyLLMBackend(provider="openai")
|
|
|
|
assert create_calls == [{"provider": "openai"}]
|
|
|
|
|
|
def test_init_treats_empty_overrides_as_unset(monkeypatch: pytest.MonkeyPatch) -> None:
|
|
"""Empty-string api_base/api_key must not be forwarded (env var set to "")."""
|
|
fake_instance = FakeAnyLLMInstance()
|
|
create_calls: list[dict[str, object]] = []
|
|
|
|
class FakeAnyLLM:
|
|
@staticmethod
|
|
def create(requested_provider: str, **kwargs): # noqa: ANN003
|
|
create_calls.append({"provider": requested_provider, **kwargs})
|
|
return fake_instance
|
|
|
|
monkeypatch.setattr(anyllm, "ANYLLM_AVAILABLE", True)
|
|
monkeypatch.setattr(anyllm, "AnyLLM", FakeAnyLLM)
|
|
|
|
backend = anyllm.AnyLLMBackend(provider="openai", api_key="", api_base="")
|
|
|
|
assert backend.api_base is None
|
|
assert backend.api_key is None
|
|
assert create_calls == [{"provider": "openai"}]
|
|
|
|
|
|
def make_choice(
|
|
content: str = "hello", finish_reason: str = "stop", tool_calls=None, index: int = 0
|
|
):
|
|
return SimpleNamespace(
|
|
index=index,
|
|
finish_reason=finish_reason,
|
|
message=SimpleNamespace(role="assistant", content=content, tool_calls=tool_calls),
|
|
)
|
|
|
|
|
|
def make_response(*choices, usage=None):
|
|
return SimpleNamespace(
|
|
id="resp_123",
|
|
created=123456,
|
|
choices=list(choices),
|
|
usage=usage,
|
|
)
|
|
|
|
|
|
def make_tool_call(tool_id: str, name: str, arguments):
|
|
return SimpleNamespace(id=tool_id, function=SimpleNamespace(name=name, arguments=arguments))
|
|
|
|
|
|
def test_init_raises_without_anyllm() -> None:
|
|
original_available = anyllm.ANYLLM_AVAILABLE
|
|
try:
|
|
anyllm.ANYLLM_AVAILABLE = False
|
|
with pytest.raises(ImportError):
|
|
anyllm.AnyLLMBackend()
|
|
finally:
|
|
anyllm.ANYLLM_AVAILABLE = original_available
|
|
|
|
|
|
def test_init_name_and_basic_methods(monkeypatch: pytest.MonkeyPatch) -> None:
|
|
backend, instance = make_backend(monkeypatch, provider="groq")
|
|
|
|
assert backend.provider == "groq"
|
|
assert backend.name == "anyllm-groq"
|
|
assert backend.map_model_id("claude-3-5") == "claude-3-5"
|
|
assert backend.supports_model("anything") is True
|
|
assert backend.llm is instance
|
|
|
|
|
|
def test_convert_content_blocks_and_messages(monkeypatch: pytest.MonkeyPatch) -> None:
|
|
backend, _instance = make_backend(monkeypatch)
|
|
|
|
assert backend._convert_content_blocks([{"type": "text", "text": "hello"}]) == "hello"
|
|
assert backend._convert_content_blocks(
|
|
[
|
|
{"type": "text", "text": "caption"},
|
|
{
|
|
"type": "image",
|
|
"source": {"type": "base64", "media_type": "image/jpeg", "data": "abc"},
|
|
},
|
|
{"type": "image", "source": {"type": "url", "url": "https://example.com/img.png"}},
|
|
]
|
|
) == [
|
|
{"type": "text", "text": "caption"},
|
|
{"type": "image_url", "image_url": {"url": "data:image/jpeg;base64,abc"}},
|
|
{"type": "image_url", "image_url": {"url": "https://example.com/img.png"}},
|
|
]
|
|
assert backend._convert_content_blocks([{"type": "tool_use", "id": "ignored"}]) == ""
|
|
|
|
converted = backend._convert_messages(
|
|
[
|
|
{"role": "user", "content": "plain text"},
|
|
{
|
|
"role": "assistant",
|
|
"content": [{"type": "text", "text": "a"}, {"type": "text", "text": "b"}],
|
|
},
|
|
{
|
|
"role": "user",
|
|
"content": [
|
|
{"type": "text", "text": "look"},
|
|
{"type": "image", "source": {"type": "url", "url": "https://example.com"}},
|
|
],
|
|
},
|
|
{"role": "user", "content": 123},
|
|
]
|
|
)
|
|
|
|
assert converted == [
|
|
{"role": "user", "content": "plain text"},
|
|
{"role": "assistant", "content": "a\nb"},
|
|
{
|
|
"role": "user",
|
|
"content": [
|
|
{"type": "text", "text": "look"},
|
|
{"type": "image_url", "image_url": {"url": "https://example.com"}},
|
|
],
|
|
},
|
|
]
|
|
|
|
|
|
def test_to_anthropic_response_maps_tool_calls_and_usage(monkeypatch: pytest.MonkeyPatch) -> None:
|
|
backend, _instance = make_backend(monkeypatch)
|
|
response = make_response(
|
|
make_choice(
|
|
content="hello",
|
|
finish_reason="tool_calls",
|
|
tool_calls=[
|
|
make_tool_call("tc1", "memory_save", '{"content":"python"}'),
|
|
make_tool_call("tc2", "memory_search", {"query": "python"}),
|
|
],
|
|
),
|
|
usage=SimpleNamespace(prompt_tokens=12, completion_tokens=7),
|
|
)
|
|
|
|
converted = backend._to_anthropic_response(response, "claude-sonnet")
|
|
|
|
assert converted["type"] == "message"
|
|
assert converted["role"] == "assistant"
|
|
assert converted["model"] == "claude-sonnet"
|
|
assert converted["stop_reason"] == "tool_use"
|
|
assert converted["usage"] == {"input_tokens": 12, "output_tokens": 7}
|
|
assert converted["content"][0] == {"type": "text", "text": "hello"}
|
|
assert converted["content"][1]["input"] == {"content": "python"}
|
|
assert converted["content"][2]["input"] == {"query": "python"}
|
|
|
|
|
|
def test_to_anthropic_response_empty_choices_returns_empty_turn(
|
|
monkeypatch: pytest.MonkeyPatch,
|
|
) -> None:
|
|
# A content-filtered / usage-only upstream response can be 200 with an empty
|
|
# choices list (e.g. Azure OpenAI content filtering). Indexing choices[0]
|
|
# would raise IndexError; the converter must return a valid empty turn, the
|
|
# way the streaming path already skips empty-choice chunks.
|
|
backend, _instance = make_backend(monkeypatch)
|
|
response = make_response(usage=SimpleNamespace(prompt_tokens=9, completion_tokens=0))
|
|
|
|
converted = backend._to_anthropic_response(response, "claude-sonnet")
|
|
|
|
assert converted["type"] == "message"
|
|
assert converted["role"] == "assistant"
|
|
assert converted["model"] == "claude-sonnet"
|
|
assert converted["content"] == []
|
|
assert converted["stop_reason"] == "end_turn"
|
|
assert converted["usage"] == {"input_tokens": 9, "output_tokens": 0}
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_send_message_builds_anthropic_response(monkeypatch: pytest.MonkeyPatch) -> None:
|
|
backend, instance = make_backend(monkeypatch)
|
|
instance.response = make_response(
|
|
make_choice("done", "stop"),
|
|
usage=SimpleNamespace(prompt_tokens=4, completion_tokens=6),
|
|
)
|
|
|
|
result = await backend.send_message(
|
|
{
|
|
"model": "claude-3-7-sonnet",
|
|
"messages": [{"role": "user", "content": [{"type": "text", "text": "hello"}]}],
|
|
"system": [{"text": "system rule"}, "extra"],
|
|
"max_tokens": 200,
|
|
"temperature": 0.3,
|
|
"top_p": 0.8,
|
|
"stop_sequences": ["END"],
|
|
"tools": [{"name": "t"}],
|
|
"tool_choice": {"type": "auto"},
|
|
},
|
|
{},
|
|
)
|
|
|
|
assert isinstance(result, BackendResponse)
|
|
assert result.status_code == 200
|
|
assert result.headers == {"content-type": "application/json"}
|
|
assert result.body["content"][0]["text"] == "done"
|
|
assert instance.calls[0]["messages"][0] == {"role": "system", "content": "system rule extra"}
|
|
assert instance.calls[0]["stop"] == ["END"]
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_send_message_returns_error_response(monkeypatch: pytest.MonkeyPatch) -> None:
|
|
backend, instance = make_backend(monkeypatch)
|
|
instance.raise_error = RuntimeError("authentication api_key missing")
|
|
|
|
result = await backend.send_message({"messages": []}, {})
|
|
|
|
assert result.status_code == 401
|
|
assert result.body["error"]["type"] == "authentication_error"
|
|
assert result.error == "authentication api_key missing"
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_stream_message_yields_events_and_error(monkeypatch: pytest.MonkeyPatch) -> None:
|
|
backend, instance = make_backend(monkeypatch)
|
|
instance.response = FakeAsyncStream(
|
|
[
|
|
SimpleNamespace(choices=[SimpleNamespace(delta=SimpleNamespace(content="hel"))]),
|
|
SimpleNamespace(choices=[SimpleNamespace(delta=SimpleNamespace(content="lo"))]),
|
|
SimpleNamespace(choices=[]),
|
|
]
|
|
)
|
|
|
|
events = [
|
|
event
|
|
async for event in backend.stream_message(
|
|
{"model": "claude", "messages": [], "system": "sys"}, {}
|
|
)
|
|
]
|
|
|
|
assert [event.event_type for event in events] == [
|
|
"message_start",
|
|
"content_block_start",
|
|
"content_block_delta",
|
|
"content_block_delta",
|
|
"content_block_stop",
|
|
"message_delta",
|
|
"message_stop",
|
|
]
|
|
assert events[0].data["message"]["model"] == "claude"
|
|
assert events[5].data["usage"] == {"output_tokens": 2}
|
|
assert instance.calls[0]["stream"] is True
|
|
assert instance.calls[0]["messages"][0] == {"role": "system", "content": "sys"}
|
|
|
|
backend_error, instance_error = make_backend(monkeypatch, provider="openai")
|
|
instance_error.raise_error = RuntimeError("stream broke")
|
|
error_events = [event async for event in backend_error.stream_message({"messages": []}, {})]
|
|
assert error_events[-1].event_type == "error"
|
|
assert error_events[-1].data["error"]["message"] == "stream broke"
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_send_openai_message_maps_choices_and_tool_calls(
|
|
monkeypatch: pytest.MonkeyPatch,
|
|
) -> None:
|
|
backend, instance = make_backend(monkeypatch)
|
|
instance.response = make_response(
|
|
make_choice(
|
|
content="answer",
|
|
finish_reason="stop",
|
|
tool_calls=[
|
|
make_tool_call("tc1", "memory_search", '{"query":"python"}'),
|
|
SimpleNamespace(id="tc2", function=None),
|
|
],
|
|
index=0,
|
|
),
|
|
usage=SimpleNamespace(prompt_tokens=2, completion_tokens=3, total_tokens=5),
|
|
)
|
|
|
|
result = await backend.send_openai_message(
|
|
{
|
|
"model": "gpt-4o",
|
|
"messages": [{"role": "user", "content": "hi"}],
|
|
"max_tokens": 50,
|
|
"temperature": 0.2,
|
|
"top_p": 0.9,
|
|
"stop": ["END"],
|
|
"tools": [{"name": "memory"}],
|
|
"tool_choice": "auto",
|
|
"response_format": {"type": "json_object"},
|
|
"seed": 1,
|
|
"n": 2,
|
|
},
|
|
{},
|
|
)
|
|
|
|
assert result.status_code == 200
|
|
assert result.body["object"] == "chat.completion"
|
|
assert (
|
|
result.body["choices"][0]["message"]["tool_calls"][0]["function"]["name"] == "memory_search"
|
|
)
|
|
assert result.body["choices"][0]["message"]["tool_calls"][1] == {
|
|
"id": "tc2",
|
|
"type": "function",
|
|
}
|
|
assert result.body["usage"] == {"prompt_tokens": 2, "completion_tokens": 3, "total_tokens": 5}
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_send_openai_message_returns_error_response(monkeypatch: pytest.MonkeyPatch) -> None:
|
|
backend, instance = make_backend(monkeypatch)
|
|
instance.raise_error = RuntimeError("model not found")
|
|
|
|
result = await backend.send_openai_message({"messages": []}, {})
|
|
|
|
assert result.status_code == 404
|
|
assert result.body["error"]["type"] == "model_not_found"
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_stream_openai_message_yields_sse_chunks_and_done(
|
|
monkeypatch: pytest.MonkeyPatch,
|
|
) -> None:
|
|
backend, instance = make_backend(monkeypatch)
|
|
instance.response = FakeAsyncStream(
|
|
[
|
|
SimpleNamespace(
|
|
model_dump=lambda **kwargs: {
|
|
"id": "chunk1",
|
|
"choices": [{"delta": {"content": "a"}}],
|
|
}
|
|
),
|
|
SimpleNamespace(
|
|
model_dump=lambda **kwargs: {
|
|
"id": "chunk2",
|
|
"choices": [{"delta": {"content": "b"}}],
|
|
}
|
|
),
|
|
]
|
|
)
|
|
|
|
chunks = [
|
|
chunk
|
|
async for chunk in backend.stream_openai_message(
|
|
{
|
|
"messages": [{"role": "user", "content": "hi"}],
|
|
"stream_options": {"include_usage": True},
|
|
},
|
|
{},
|
|
)
|
|
]
|
|
|
|
assert chunks[0].startswith("data: {")
|
|
assert chunks[-1] == "data: [DONE]\n\n"
|
|
assert instance.calls[0]["stream"] is True
|
|
assert instance.calls[0]["stream_options"] == {"include_usage": True}
|
|
|
|
backend_error, instance_error = make_backend(monkeypatch, provider="anthropic")
|
|
instance_error.raise_error = RuntimeError("rate limit hit")
|
|
error_chunks = [
|
|
chunk async for chunk in backend_error.stream_openai_message({"messages": []}, {})
|
|
]
|
|
assert '"backend_error"' in error_chunks[0]
|
|
assert error_chunks[-1] == "data: [DONE]\n\n"
|
|
|
|
|
|
def test_error_response_classifies_common_failures(monkeypatch: pytest.MonkeyPatch) -> None:
|
|
backend, _instance = make_backend(monkeypatch)
|
|
|
|
auth = backend._error_response(RuntimeError("authentication api key missing"))
|
|
rate = backend._error_response(RuntimeError("rate limit exceeded"), openai_format=True)
|
|
model = backend._error_response(RuntimeError("model not found"), openai_format=True)
|
|
generic = backend._error_response(RuntimeError("other error"))
|
|
|
|
assert auth.status_code == 401
|
|
assert auth.body["error"]["type"] == "authentication_error"
|
|
assert rate.status_code == 429
|
|
assert rate.body["error"]["type"] == "rate_limit_exceeded"
|
|
assert model.status_code == 404
|
|
assert model.body["error"]["type"] == "model_not_found"
|
|
assert generic.status_code == 500
|
|
assert generic.body["error"]["type"] == "api_error"
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_close_is_noop(monkeypatch: pytest.MonkeyPatch) -> None:
|
|
backend, _instance = make_backend(monkeypatch)
|
|
assert await backend.close() is None
|
|
assert isinstance(StreamEvent(event_type="message_start", data={}), StreamEvent)
|