mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
## Description OpenAI-format `POST /v1/chat/completions` requests routed through `--backend litellm-vertex` fail when the client includes `max_tokens`. The proxy currently runs its direct-OpenAI compatibility shim before backend dispatch, renames `max_tokens` to `max_completion_tokens`, then the LiteLLM path no longer recognizes that field as standard and sweeps it into `extra_body`. Vertex rejects the resulting request with `extra_body: Extra inputs are not permitted`. This change scopes the rename shim to the direct OpenAI path only. Backend-routed chat requests now keep `max_tokens`, which LiteLLM already forwards correctly for the Vertex Anthropic path. Direct GPT-5 and o-series compatibility stays unchanged. Closes #2392. ## 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 - Thread a backend-owned translation flag into `_normalize_openai_max_tokens`. - Skip the legacy-to-completion-token rename on backend-routed OpenAI chat requests. - Keep the direct OpenAI compatibility path covered with a backend-owned translation no-op test. - Add buffered and streaming handler-level regressions for the exact `litellm-vertex` request shape, proving the request survives the `/v1/chat/completions` normalization boundary with vendor fields intact. ## Testing - [x] Unit tests pass (`uv run pytest tests/test_proxy/test_openai_backend_path.py tests/test_openai_streaming_backend.py tests/test_openai_max_completion_tokens.py tests/test_litellm_openai_passthrough.py -q`) - [x] Linting passes (`uv run ruff check headroom/proxy/handlers/openai.py tests/test_openai_max_completion_tokens.py tests/test_litellm_openai_passthrough.py tests/test_proxy/test_openai_backend_path.py tests/test_openai_streaming_backend.py`) - [ ] Type checking passes (`uv run mypy headroom`) - [x] New tests added for new functionality when applicable - [x] Manual testing performed ### Test Output ```text $ uv run pytest tests/test_proxy/test_openai_backend_path.py tests/test_openai_streaming_backend.py tests/test_openai_max_completion_tokens.py tests/test_litellm_openai_passthrough.py -q ......sss............ [100%] 20 passed, 3 skipped, 1 warning in 42.13s $ uv run ruff check headroom/proxy/handlers/openai.py tests/test_openai_max_completion_tokens.py tests/test_litellm_openai_passthrough.py tests/test_proxy/test_openai_backend_path.py tests/test_openai_streaming_backend.py All checks passed! $ uv run ruff format headroom/proxy/handlers/openai.py tests/test_openai_max_completion_tokens.py tests/test_litellm_openai_passthrough.py tests/test_proxy/test_openai_backend_path.py tests/test_openai_streaming_backend.py --check 5 files already formatted ``` ## Real Behavior Proof - Environment: Windows, synced Headroom development environment, mocked LiteLLM provider boundary, no paid GCP credentials required - Exact command / steps: run `uv run pytest tests/test_proxy/test_openai_backend_path.py tests/test_openai_streaming_backend.py tests/test_openai_max_completion_tokens.py tests/test_litellm_openai_passthrough.py -q`, using the issue payload shape `{"model":"claude-sonnet-4-6","max_tokens":32,"messages":[{"role":"user","content":"hi"}],"chat_template_kwargs":{"enable_thinking":false}}` through `POST /v1/chat/completions` - Observed result: buffered and streaming `litellm-vertex` requests keep `max_tokens` as a named backend kwarg, preserve `chat_template_kwargs` in `extra_body`, omit `max_completion_tokens` from `extra_body`, and return success through the handler boundary. Direct-path normalization still renames legacy `max_tokens`. - Not tested: live Vertex AI request ## Review Readiness - [x] I have performed a self-review - [x] This PR is ready for human review ## Checklist - [ ] My code follows the project's style guidelines - [ ] 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 - [ ] 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 ## Additional Notes - `CHANGELOG.md`: N/A, the release pipeline generates it from the conventional-commit subject. - Scope is intentionally narrow: this fixes the exact backend-routed `max_tokens` failure and does not broaden `extra_body` hardening for unrelated OpenAI fields.
417 lines
15 KiB
Python
417 lines
15 KiB
Python
"""Tests for the OpenAI chat-completions backend (LiteLLM/Bedrock) path.
|
|
|
|
Covers Fix #1 (PrefixCacheTracker.update_from_response on backend path)
|
|
and Fix #2 (CCR response intercept for the OpenAI provider shape) on the
|
|
non-streaming backend path of ``handle_openai_chat``.
|
|
|
|
All three scenarios mock ``anthropic_backend.send_openai_message`` so we
|
|
don't need a real provider:
|
|
|
|
1. Backend response with cache_read_input_tokens > 0 → tracker.update_from_response
|
|
is called with the right cache_read_tokens and cache_write_tokens.
|
|
2. Backend response with headroom_retrieve tool call → ccr_response_handler.handle_response
|
|
is awaited with provider="openai", and the final body returned.
|
|
3. CCR intercept exception path → re-raises (NOT swallowed).
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from types import SimpleNamespace
|
|
from unittest.mock import AsyncMock, MagicMock, patch
|
|
|
|
import pytest
|
|
|
|
fastapi = pytest.importorskip("fastapi")
|
|
httpx = pytest.importorskip("httpx")
|
|
|
|
from fastapi.testclient import TestClient # noqa: E402
|
|
|
|
from headroom.backends.base import BackendResponse # noqa: E402
|
|
from headroom.proxy.server import ProxyConfig, create_app # noqa: E402
|
|
|
|
|
|
class _RecordingTracker:
|
|
"""Stub PrefixCacheTracker that records ``update_from_response`` calls."""
|
|
|
|
def __init__(self, provider: str = "openai") -> None:
|
|
self.provider = provider
|
|
self.calls: list[dict] = []
|
|
self._frozen = 0
|
|
self._last_original: list[dict] = []
|
|
self._last_forwarded: list[dict] = []
|
|
|
|
def update_from_response(
|
|
self,
|
|
cache_read_tokens: int,
|
|
cache_write_tokens: int,
|
|
messages: list[dict],
|
|
message_token_counts: list[int] | None = None,
|
|
original_messages: list[dict] | None = None,
|
|
) -> None:
|
|
self.calls.append(
|
|
{
|
|
"cache_read_tokens": cache_read_tokens,
|
|
"cache_write_tokens": cache_write_tokens,
|
|
"messages": messages,
|
|
}
|
|
)
|
|
self._last_original = list(original_messages or messages)
|
|
self._last_forwarded = list(messages)
|
|
|
|
# Minimal surface used by handle_openai_chat — return 0 so we never freeze.
|
|
def get_frozen_message_count(self) -> int:
|
|
return self._frozen
|
|
|
|
def get_last_original_messages(self) -> list[dict]:
|
|
return list(self._last_original)
|
|
|
|
def get_last_forwarded_messages(self) -> list[dict]:
|
|
return list(self._last_forwarded)
|
|
|
|
|
|
def _make_config() -> ProxyConfig:
|
|
return ProxyConfig(
|
|
optimize=False,
|
|
cache_enabled=False,
|
|
rate_limit_enabled=False,
|
|
backend="anyllm",
|
|
anyllm_provider="openai",
|
|
)
|
|
|
|
|
|
def _make_mock_backend(response_body: dict, status_code: int = 200) -> MagicMock:
|
|
backend = MagicMock()
|
|
backend.name = "anyllm-openai"
|
|
backend.send_openai_message = AsyncMock(
|
|
return_value=BackendResponse(
|
|
body=response_body,
|
|
status_code=status_code,
|
|
headers={"content-type": "application/json"},
|
|
)
|
|
)
|
|
return backend
|
|
|
|
|
|
def _make_litellm_response() -> SimpleNamespace:
|
|
return SimpleNamespace(
|
|
id="resp_2392",
|
|
created=123456,
|
|
choices=[
|
|
SimpleNamespace(
|
|
index=0,
|
|
finish_reason="stop",
|
|
message=SimpleNamespace(role="assistant", content="ok", tool_calls=None),
|
|
)
|
|
],
|
|
usage=SimpleNamespace(prompt_tokens=2, completion_tokens=3, total_tokens=5),
|
|
)
|
|
|
|
|
|
def _install_tracker_stub(client: TestClient) -> _RecordingTracker:
|
|
"""Force the session_tracker_store to hand out our recording tracker."""
|
|
tracker = _RecordingTracker(provider="openai")
|
|
# Find the proxy instance behind the app — it's stored as app.state.proxy.
|
|
proxy = client.app.state.proxy
|
|
proxy.session_tracker_store.get_or_create = MagicMock(return_value=tracker)
|
|
return tracker
|
|
|
|
|
|
def test_backend_response_updates_prefix_tracker_with_bedrock_cache_fields():
|
|
"""Bedrock/Anthropic-shape cache fields → tracker sees authoritative read/write counts."""
|
|
config = _make_config()
|
|
response_body = {
|
|
"id": "chatcmpl-bedrock-1",
|
|
"object": "chat.completion",
|
|
"model": "anthropic.claude-3-5-sonnet-20241022-v2:0",
|
|
"choices": [
|
|
{
|
|
"index": 0,
|
|
"message": {"role": "assistant", "content": "Hi!"},
|
|
"finish_reason": "stop",
|
|
}
|
|
],
|
|
"usage": {
|
|
"prompt_tokens": 1000,
|
|
"completion_tokens": 20,
|
|
"total_tokens": 1020,
|
|
# Bedrock/Anthropic top-level keys
|
|
"cache_read_input_tokens": 700,
|
|
"cache_creation_input_tokens": 100,
|
|
# OpenAI shape (always populated by the LiteLLM normalizer)
|
|
"prompt_tokens_details": {"cached_tokens": 700},
|
|
},
|
|
}
|
|
|
|
mock_backend = _make_mock_backend(response_body)
|
|
with patch("headroom.proxy.server.AnyLLMBackend", return_value=mock_backend):
|
|
app = create_app(config)
|
|
with TestClient(app) as client:
|
|
tracker = _install_tracker_stub(client)
|
|
resp = client.post(
|
|
"/v1/chat/completions",
|
|
json={
|
|
"model": "anthropic.claude-3-5-sonnet-20241022-v2:0",
|
|
"messages": [{"role": "user", "content": "hi"}],
|
|
"stream": False,
|
|
},
|
|
headers={"Authorization": "Bearer test-key"},
|
|
)
|
|
|
|
assert resp.status_code == 200, resp.text
|
|
assert mock_backend.send_openai_message.await_count == 1
|
|
assert len(tracker.calls) == 1, tracker.calls
|
|
call = tracker.calls[0]
|
|
# Prefer the Bedrock authoritative top-level read/write counts.
|
|
assert call["cache_read_tokens"] == 700
|
|
assert call["cache_write_tokens"] == 100
|
|
|
|
|
|
def test_backend_response_falls_back_to_openai_cached_tokens_when_bedrock_keys_absent():
|
|
"""Pure OpenAI shape (no top-level Anthropic keys) → fall back to prompt_tokens_details + infer write."""
|
|
config = _make_config()
|
|
response_body = {
|
|
"id": "chatcmpl-openai-1",
|
|
"object": "chat.completion",
|
|
"model": "gpt-4o-mini",
|
|
"choices": [
|
|
{
|
|
"index": 0,
|
|
"message": {"role": "assistant", "content": "Hi!"},
|
|
"finish_reason": "stop",
|
|
}
|
|
],
|
|
"usage": {
|
|
"prompt_tokens": 500,
|
|
"completion_tokens": 10,
|
|
"total_tokens": 510,
|
|
# No top-level Anthropic keys, only OpenAI shape
|
|
"prompt_tokens_details": {"cached_tokens": 200},
|
|
},
|
|
}
|
|
|
|
mock_backend = _make_mock_backend(response_body)
|
|
with patch("headroom.proxy.server.AnyLLMBackend", return_value=mock_backend):
|
|
app = create_app(config)
|
|
with TestClient(app) as client:
|
|
tracker = _install_tracker_stub(client)
|
|
resp = client.post(
|
|
"/v1/chat/completions",
|
|
json={
|
|
"model": "gpt-4o-mini",
|
|
"messages": [{"role": "user", "content": "hi"}],
|
|
"stream": False,
|
|
},
|
|
headers={"Authorization": "Bearer test-key"},
|
|
)
|
|
|
|
assert resp.status_code == 200, resp.text
|
|
assert len(tracker.calls) == 1
|
|
call = tracker.calls[0]
|
|
assert call["cache_read_tokens"] == 200
|
|
# No cache_creation_input_tokens → inferred = prompt_tokens - cache_read = 500 - 200 = 300
|
|
assert call["cache_write_tokens"] == 300
|
|
|
|
|
|
def test_litellm_vertex_backend_path_preserves_max_tokens_and_vendor_fields():
|
|
config = ProxyConfig(
|
|
optimize=False,
|
|
cache_enabled=False,
|
|
rate_limit_enabled=False,
|
|
backend="litellm-vertex",
|
|
)
|
|
|
|
with (
|
|
patch("headroom.backends.litellm._fetch_bedrock_inference_profiles", return_value={}),
|
|
patch("headroom.backends.litellm.acompletion", new_callable=AsyncMock) as mock_acomp,
|
|
):
|
|
mock_acomp.return_value = _make_litellm_response()
|
|
app = create_app(config)
|
|
with TestClient(app) as client:
|
|
response = client.post(
|
|
"/v1/chat/completions",
|
|
json={
|
|
"model": "claude-sonnet-4-6",
|
|
"messages": [{"role": "user", "content": "hi"}],
|
|
"max_tokens": 32,
|
|
"chat_template_kwargs": {"enable_thinking": False},
|
|
"stream": False,
|
|
},
|
|
headers={"Authorization": "Bearer test-key"},
|
|
)
|
|
|
|
assert response.status_code == 200, response.text
|
|
kwargs = mock_acomp.await_args.kwargs
|
|
assert kwargs["max_tokens"] == 32
|
|
assert kwargs["extra_body"] == {"chat_template_kwargs": {"enable_thinking": False}}
|
|
assert "max_completion_tokens" not in kwargs["extra_body"]
|
|
|
|
|
|
def test_backend_response_with_ccr_tool_call_is_intercepted_and_resolved():
|
|
"""OpenAI-shape response carrying headroom_retrieve → CCR handler resolves it."""
|
|
config = _make_config()
|
|
# First response: tool_call for headroom_retrieve
|
|
tool_call_response = {
|
|
"id": "chatcmpl-ccr-1",
|
|
"object": "chat.completion",
|
|
"model": "anthropic.claude-3-5-sonnet-20241022-v2:0",
|
|
"choices": [
|
|
{
|
|
"index": 0,
|
|
"message": {
|
|
"role": "assistant",
|
|
"content": None,
|
|
"tool_calls": [
|
|
{
|
|
"id": "call_abc",
|
|
"type": "function",
|
|
"function": {
|
|
"name": "headroom_retrieve",
|
|
"arguments": '{"hash": "deadbeef"}',
|
|
},
|
|
}
|
|
],
|
|
},
|
|
"finish_reason": "tool_calls",
|
|
}
|
|
],
|
|
"usage": {
|
|
"prompt_tokens": 100,
|
|
"completion_tokens": 10,
|
|
"total_tokens": 110,
|
|
},
|
|
}
|
|
final_resp_json = {
|
|
"id": "chatcmpl-ccr-final",
|
|
"object": "chat.completion",
|
|
"model": "anthropic.claude-3-5-sonnet-20241022-v2:0",
|
|
"choices": [
|
|
{
|
|
"index": 0,
|
|
"message": {"role": "assistant", "content": "Resolved!"},
|
|
"finish_reason": "stop",
|
|
}
|
|
],
|
|
"usage": {
|
|
"prompt_tokens": 100,
|
|
"completion_tokens": 5,
|
|
"total_tokens": 105,
|
|
},
|
|
}
|
|
|
|
mock_backend = _make_mock_backend(tool_call_response)
|
|
with patch("headroom.proxy.server.AnyLLMBackend", return_value=mock_backend):
|
|
app = create_app(config)
|
|
with TestClient(app) as client:
|
|
_install_tracker_stub(client)
|
|
proxy = client.app.state.proxy
|
|
# Replace the response handler with a recording mock.
|
|
recording_handler = MagicMock()
|
|
recording_handler.has_ccr_tool_calls = MagicMock(return_value=True)
|
|
recording_handler.handle_response = AsyncMock(return_value=final_resp_json)
|
|
proxy.ccr_response_handler = recording_handler
|
|
|
|
resp = client.post(
|
|
"/v1/chat/completions",
|
|
json={
|
|
"model": "anthropic.claude-3-5-sonnet-20241022-v2:0",
|
|
"messages": [{"role": "user", "content": "hi"}],
|
|
"stream": False,
|
|
},
|
|
headers={"Authorization": "Bearer test-key"},
|
|
)
|
|
|
|
assert resp.status_code == 200, resp.text
|
|
# handle_response was awaited with provider="openai"
|
|
recording_handler.handle_response.assert_awaited_once()
|
|
_args, kwargs = recording_handler.handle_response.call_args
|
|
assert kwargs.get("provider") == "openai"
|
|
# Resolved body propagated back to the client
|
|
assert resp.json()["choices"][0]["message"]["content"] == "Resolved!"
|
|
|
|
|
|
def test_backend_ccr_intercept_exception_is_reraised_not_swallowed():
|
|
"""CCR resolution failure on the backend path → 500, NOT silent fallback to original body."""
|
|
config = _make_config()
|
|
tool_call_response = {
|
|
"id": "chatcmpl-ccr-fail",
|
|
"object": "chat.completion",
|
|
"model": "anthropic.claude-3-5-sonnet-20241022-v2:0",
|
|
"choices": [
|
|
{
|
|
"index": 0,
|
|
"message": {
|
|
"role": "assistant",
|
|
"content": None,
|
|
"tool_calls": [
|
|
{
|
|
"id": "call_bad",
|
|
"type": "function",
|
|
"function": {
|
|
"name": "headroom_retrieve",
|
|
"arguments": '{"hash": "badhash"}',
|
|
},
|
|
}
|
|
],
|
|
},
|
|
"finish_reason": "tool_calls",
|
|
}
|
|
],
|
|
"usage": {"prompt_tokens": 50, "completion_tokens": 5, "total_tokens": 55},
|
|
}
|
|
|
|
mock_backend = _make_mock_backend(tool_call_response)
|
|
with patch("headroom.proxy.server.AnyLLMBackend", return_value=mock_backend):
|
|
app = create_app(config)
|
|
with TestClient(app) as client:
|
|
_install_tracker_stub(client)
|
|
proxy = client.app.state.proxy
|
|
failing_handler = MagicMock()
|
|
failing_handler.has_ccr_tool_calls = MagicMock(return_value=True)
|
|
failing_handler.handle_response = AsyncMock(
|
|
side_effect=RuntimeError("ccr-store-blew-up")
|
|
)
|
|
proxy.ccr_response_handler = failing_handler
|
|
|
|
resp = client.post(
|
|
"/v1/chat/completions",
|
|
json={
|
|
"model": "anthropic.claude-3-5-sonnet-20241022-v2:0",
|
|
"messages": [{"role": "user", "content": "hi"}],
|
|
"stream": False,
|
|
},
|
|
headers={"Authorization": "Bearer test-key"},
|
|
)
|
|
|
|
# The outer `try/except Exception` on the backend block converts the
|
|
# re-raise into a 500 response. The critical assertion is that the
|
|
# original tool_call body is NOT returned to the client — which is
|
|
# what a silent fallback would do.
|
|
failing_handler.handle_response.assert_awaited_once()
|
|
assert resp.status_code == 500, (
|
|
f"expected 500 (CCR error re-raised), got {resp.status_code}: {resp.text[:200]}"
|
|
)
|
|
body = resp.json()
|
|
# Confirm we didn't propagate the original tool_call body.
|
|
assert (
|
|
"choices" not in body
|
|
or body.get("choices", [{}])[0].get("message", {}).get("tool_calls") is None
|
|
)
|
|
assert "error" in body
|
|
assert "ccr-store-blew-up" in body["error"]["message"]
|
|
|
|
|
|
def test_backend_streaming_passes_prefix_tracker_through():
|
|
"""Streaming backend path should accept and use prefix_tracker — non-regression smoke."""
|
|
# The wiring contract is structural — just confirm the parameter exists.
|
|
import inspect
|
|
|
|
from headroom.proxy.handlers.streaming import StreamingMixin
|
|
|
|
sig = inspect.signature(StreamingMixin._stream_openai_via_backend)
|
|
assert "prefix_tracker" in sig.parameters, (
|
|
"_stream_openai_via_backend must accept prefix_tracker to match the direct path"
|
|
)
|
|
assert "optimized_messages" in sig.parameters, (
|
|
"_stream_openai_via_backend must accept optimized_messages so the "
|
|
"tracker can record the messages that were sent"
|
|
)
|