mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
## Description Fixes #1602. OpenCode Zen custom-base requests can reach Headroom through the generic passthrough path, but that route was not supplying endpoint/provider metadata for Zen chat completions. This made forwarded Zen traffic invisible in dashboard provider, usage, and token telemetry. Closes #1602 ## 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 - Added a narrow OpenCode Zen custom-base classifier for `POST /zen/v1/chat/completions` on `opencode.ai` and `www.opencode.ai`. - Passed `endpoint_name="chat/completions"` and `provider="zen"` into catch-all passthrough telemetry for matching Zen traffic. - Attributed normalized OpenCode transport traffic (`/v1/chat/completions` with `x-headroom-original-path: /zen/v1/chat/completions`) to `zen` for request outcomes while keeping the OpenAI parser path unchanged. - Added coverage for direct catch-all routing, normalized original-path routing, token usage outcome recording, and false-positive paths like `/mcp/v1/chat/completions`, `/npm/v1/chat/completions`, and `/context7/v1/chat/completions`. ## Testing - [x] Unit tests pass (`pytest`) - [x] Linting passes (`ruff check .`) - [ ] Type checking passes (`mypy headroom`) - [x] New tests added for new functionality - [ ] Manual testing performed ### Test Output ```text $ rtk pytest tests/test_custom_base_passthrough_telemetry.py -q Pytest: 4 passed $ rtk uvx --from ruff==0.15.17 ruff check headroom/proxy/handlers/openai.py headroom/providers/proxy_routes.py tests/test_custom_base_passthrough_telemetry.py tests/test_provider_proxy_routes.py tests/test_proxy/test_openai_transport_path_prefix.py All checks passed! $ rtk uvx --from ruff==0.15.17 ruff format --check headroom/proxy/handlers/openai.py headroom/providers/proxy_routes.py tests/test_custom_base_passthrough_telemetry.py tests/test_provider_proxy_routes.py tests/test_proxy/test_openai_transport_path_prefix.py 5 files already formatted $ rtk /Library/Frameworks/Python.framework/Versions/3.13/bin/python3 -m py_compile headroom/proxy/handlers/openai.py headroom/providers/proxy_routes.py tests/test_custom_base_passthrough_telemetry.py tests/test_provider_proxy_routes.py tests/test_proxy/test_openai_transport_path_prefix.py # passed $ rtk git diff --check # passed ``` GitHub Actions also passed after the final push, including CI, Docker native/wrap/init E2E, security, lint, and PR governance. ## Real Behavior Proof - Environment: local worktree on macOS plus GitHub Actions for PR #1648. - Exact command / steps: ran focused pytest coverage for Zen passthrough telemetry, Ruff check/format validation on touched files, Python compile validation, `git diff --check`, and waited for the full GitHub Actions rollup. - Observed result: Zen custom-base chat completions now record request outcomes as provider `zen` with endpoint `chat/completions`; false-positive OpenCode paths remain unattributed to Zen; GitHub checks are green. - Not tested: full local test suite did not collect in this worktree because the native `headroom._core` extension is not installed. `rtk npm --prefix plugins/opencode test` is also blocked locally because `vitest` is not installed in `plugins/opencode/node_modules`. ## 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 - [ ] 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 ## Screenshots (if applicable) N/A ## Additional Notes The documentation and CHANGELOG checklist items are not applicable for this narrow telemetry bug fix. No new comments were added because the code path is covered by narrowly named helper/test cases.
303 lines
10 KiB
Python
303 lines
10 KiB
Python
"""Tests for OpenAI transport path-prefix reconstruction from upstream hints."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import httpx
|
|
import pytest
|
|
|
|
pytest.importorskip("fastapi")
|
|
|
|
from fastapi.testclient import TestClient
|
|
|
|
from headroom.proxy.server import ProxyConfig, create_app
|
|
|
|
_OPENAI_CHAT_PATH = "/v1/chat/completions"
|
|
_OPENAI_RESPONSES_PATH = "/v1/responses"
|
|
|
|
|
|
def _build_openai_client():
|
|
config = ProxyConfig(
|
|
optimize=False,
|
|
cache_enabled=False,
|
|
rate_limit_enabled=False,
|
|
cost_tracking_enabled=False,
|
|
log_requests=False,
|
|
ccr_inject_tool=False,
|
|
ccr_handle_responses=False,
|
|
ccr_context_tracking=False,
|
|
image_optimize=False,
|
|
)
|
|
|
|
app = create_app(config)
|
|
proxy = app.state.proxy
|
|
captured: dict[str, object] = {}
|
|
|
|
async def _fake_retry(
|
|
method: str,
|
|
url: str,
|
|
headers: dict[str, str],
|
|
body: dict,
|
|
**_kwargs: object,
|
|
) -> httpx.Response:
|
|
captured["method"] = method
|
|
captured["url"] = url
|
|
captured["headers"] = headers
|
|
captured["body"] = body
|
|
return httpx.Response(
|
|
200,
|
|
json={
|
|
"id": "msg_1",
|
|
"object": "response",
|
|
"usage": {
|
|
"input_tokens": 10,
|
|
"output_tokens": 2,
|
|
"cache_read_input_tokens": 0,
|
|
"cache_creation_input_tokens": 0,
|
|
"total_tokens": 12,
|
|
},
|
|
},
|
|
)
|
|
|
|
proxy._retry_request = _fake_retry
|
|
|
|
async def _record_request_outcome(outcome: object) -> None:
|
|
captured["outcome"] = outcome
|
|
|
|
proxy._record_request_outcome = _record_request_outcome
|
|
|
|
return TestClient(app), captured
|
|
|
|
|
|
def _assert_internal_header_absent(captured: dict[str, object], name: str) -> None:
|
|
assert isinstance(captured.get("headers"), dict)
|
|
headers = {k.lower() for k in captured["headers"].keys()} # type: ignore[union-attr]
|
|
assert name.lower() not in headers
|
|
|
|
|
|
def _assert_path(captured: dict[str, object], path: str) -> None:
|
|
url = captured.get("url")
|
|
assert isinstance(url, str)
|
|
assert url.endswith(path)
|
|
|
|
|
|
def _assert_origin(captured: dict[str, object], origin: str) -> None:
|
|
url = captured.get("url")
|
|
assert isinstance(url, str)
|
|
assert url.startswith(origin)
|
|
|
|
|
|
def test_chat_upstream_reconstruction_base_fails_head_passes() -> None:
|
|
endpoint = _OPENAI_CHAT_PATH
|
|
body = {"model": "gpt-4o", "messages": [{"role": "user", "content": "hi"}]}
|
|
base_fail = "://bad-base"
|
|
|
|
for headers in [
|
|
{
|
|
"Authorization": "Bearer sk-test",
|
|
"x-headroom-base-url": base_fail,
|
|
"x-headroom-original-path": "/chat/completions",
|
|
},
|
|
{
|
|
"Authorization": "Bearer sk-test",
|
|
"x-headroom-base-url": "https://api.deepseek.com",
|
|
"x-headroom-original-path": "/chat/completions",
|
|
},
|
|
]:
|
|
client, captured = _build_openai_client()
|
|
response = client.post(endpoint, headers=headers, json=body)
|
|
assert response.status_code == 200, response.text
|
|
|
|
assert captured["method"] == "POST"
|
|
if headers["x-headroom-base-url"] == base_fail:
|
|
_assert_path(captured, "/v1/chat/completions")
|
|
else:
|
|
_assert_origin(captured, "https://api.deepseek.com")
|
|
_assert_path(captured, "/chat/completions")
|
|
|
|
|
|
def test_responses_upstream_reconstruction_base_fails_head_passes() -> None:
|
|
endpoint = _OPENAI_RESPONSES_PATH
|
|
body = {"model": "gpt-4o", "input": "hi"}
|
|
base_fail = "://bad-base"
|
|
|
|
for headers in [
|
|
{
|
|
"Authorization": "Bearer sk-test",
|
|
"x-headroom-base-url": base_fail,
|
|
"x-headroom-original-path": "/responses",
|
|
},
|
|
{
|
|
"Authorization": "Bearer sk-test",
|
|
"x-headroom-base-url": "https://api.deepseek.com",
|
|
"x-headroom-original-path": "/responses",
|
|
},
|
|
]:
|
|
client, captured = _build_openai_client()
|
|
response = client.post(endpoint, headers=headers, json=body)
|
|
assert response.status_code == 200, response.text
|
|
|
|
assert captured["method"] == "POST"
|
|
if headers["x-headroom-base-url"] == base_fail:
|
|
_assert_path(captured, "/v1/responses")
|
|
else:
|
|
_assert_origin(captured, "https://api.deepseek.com")
|
|
_assert_path(captured, "/responses")
|
|
|
|
|
|
def test_direct_v1_paths_are_preserved() -> None:
|
|
cases = [
|
|
(
|
|
_OPENAI_CHAT_PATH,
|
|
{"model": "gpt-4o", "messages": [{"role": "user", "content": "hi"}]},
|
|
"/v1/chat/completions",
|
|
),
|
|
(
|
|
_OPENAI_RESPONSES_PATH,
|
|
{"model": "gpt-4o", "input": "hi"},
|
|
"/v1/responses",
|
|
),
|
|
]
|
|
|
|
for endpoint, body, expected_path in cases:
|
|
client, captured = _build_openai_client()
|
|
response = client.post(
|
|
endpoint,
|
|
headers={"Authorization": "Bearer sk-test"},
|
|
json=body,
|
|
)
|
|
assert response.status_code == 200, response.text
|
|
assert captured["method"] == "POST"
|
|
_assert_path(captured, expected_path)
|
|
|
|
|
|
def test_query_string_is_preserved_for_reconstructed_upstream_paths() -> None:
|
|
cases = [
|
|
(
|
|
_OPENAI_CHAT_PATH,
|
|
{"model": "gpt-4o", "messages": [{"role": "user", "content": "hi"}]},
|
|
{
|
|
"Authorization": "Bearer sk-test",
|
|
"x-headroom-base-url": "https://api.deepseek.com",
|
|
"x-headroom-original-path": "/base/chat/completions",
|
|
},
|
|
"/base/chat/completions?foo=1",
|
|
),
|
|
(
|
|
_OPENAI_RESPONSES_PATH,
|
|
{"model": "gpt-4o", "input": "hi"},
|
|
{
|
|
"Authorization": "Bearer sk-test",
|
|
"x-headroom-base-url": "https://api.deepseek.com",
|
|
"x-headroom-original-path": "/base/responses",
|
|
},
|
|
"/base/responses?foo=1",
|
|
),
|
|
]
|
|
|
|
for endpoint, body, headers, expected_path in cases:
|
|
client, captured = _build_openai_client()
|
|
response = client.post(f"{endpoint}?foo=1", headers=headers, json=body)
|
|
assert response.status_code == 200, response.text
|
|
assert captured["method"] == "POST"
|
|
_assert_origin(captured, "https://api.deepseek.com")
|
|
_assert_path(captured, expected_path)
|
|
|
|
|
|
def test_opencode_zen_reconstructed_chat_path_records_zen_provider() -> None:
|
|
headers = {
|
|
"Authorization": "Bearer sk-test",
|
|
"x-headroom-base-url": "https://opencode.ai",
|
|
"x-headroom-original-path": "/zen/v1/chat/completions",
|
|
}
|
|
body = {"model": "zen-model", "messages": [{"role": "user", "content": "hi"}]}
|
|
|
|
client, captured = _build_openai_client()
|
|
response = client.post(_OPENAI_CHAT_PATH, headers=headers, json=body)
|
|
assert response.status_code == 200, response.text
|
|
|
|
_assert_origin(captured, "https://opencode.ai")
|
|
_assert_path(captured, "/zen/v1/chat/completions")
|
|
outcome = captured.get("outcome")
|
|
assert outcome is not None
|
|
assert outcome.provider == "zen"
|
|
assert outcome.model == "zen-model"
|
|
|
|
|
|
def test_non_http_base_url_falls_back_to_v1() -> None:
|
|
cases = [
|
|
(
|
|
_OPENAI_CHAT_PATH,
|
|
{"model": "gpt-4o", "messages": [{"role": "user", "content": "hi"}]},
|
|
{
|
|
"Authorization": "Bearer sk-test",
|
|
"x-headroom-base-url": "ws://api.deepseek.com",
|
|
"x-headroom-original-path": "/chat/completions",
|
|
},
|
|
"/v1/chat/completions",
|
|
),
|
|
(
|
|
_OPENAI_RESPONSES_PATH,
|
|
{"model": "gpt-4o", "input": "hi"},
|
|
{
|
|
"Authorization": "Bearer sk-test",
|
|
"x-headroom-base-url": "wss://api.deepseek.com",
|
|
"x-headroom-original-path": "/responses",
|
|
},
|
|
"/v1/responses",
|
|
),
|
|
]
|
|
|
|
for endpoint, body, headers, expected_path in cases:
|
|
client, captured = _build_openai_client()
|
|
response = client.post(endpoint, headers=headers, json=body)
|
|
assert response.status_code == 200, response.text
|
|
assert captured["method"] == "POST"
|
|
_assert_path(captured, expected_path)
|
|
|
|
|
|
def test_invalid_original_path_falls_back_to_v1() -> None:
|
|
cases = [
|
|
(
|
|
_OPENAI_CHAT_PATH,
|
|
{"model": "gpt-4o", "messages": [{"role": "user", "content": "hi"}]},
|
|
{
|
|
"Authorization": "Bearer sk-test",
|
|
"x-headroom-base-url": "https://api.deepseek.com",
|
|
"x-headroom-original-path": "https://evil.example/chat/completions",
|
|
},
|
|
"/v1/chat/completions",
|
|
),
|
|
(
|
|
_OPENAI_RESPONSES_PATH,
|
|
{"model": "gpt-4o", "input": "hi"},
|
|
{
|
|
"Authorization": "Bearer sk-test",
|
|
"x-headroom-base-url": "https://api.deepseek.com",
|
|
"x-headroom-original-path": "/x/responses?bad",
|
|
},
|
|
"/v1/responses",
|
|
),
|
|
]
|
|
|
|
for endpoint, body, headers, expected_path in cases:
|
|
client, captured = _build_openai_client()
|
|
response = client.post(endpoint, headers=headers, json=body)
|
|
assert response.status_code == 200, response.text
|
|
assert captured["method"] == "POST"
|
|
_assert_path(captured, expected_path)
|
|
|
|
|
|
def test_original_path_header_is_not_forwarded_upstream() -> None:
|
|
headers = {
|
|
"Authorization": "Bearer sk-test",
|
|
"x-headroom-base-url": "https://api.deepseek.com",
|
|
"x-headroom-original-path": "/chat/completions",
|
|
}
|
|
body = {"model": "gpt-4o", "messages": [{"role": "user", "content": "hi"}]}
|
|
|
|
client, captured = _build_openai_client()
|
|
response = client.post(_OPENAI_CHAT_PATH, headers=headers, json=body)
|
|
assert response.status_code == 200, response.text
|
|
|
|
_assert_internal_header_absent(captured, "x-headroom-original-path")
|
|
_assert_internal_header_absent(captured, "x-headroom-base-url")
|