mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
## Description **`main` cannot currently run its own test suite on macOS.** `pytest tests/` dies at roughly 2% with exit code 2 — no traceback, no summary, no failing test named. The pytest process is simply gone. Two independent defects, both landed today, both invisible to CI. ### 1. The macOS malloc re-exec replaces the calling process `headroom proxy` re-execs itself once on Darwin to apply two libmalloc knobs that libmalloc only reads before `main()` (#2820, PR #2879): ```python os.execv(sys.executable, [sys.executable, "-m", "headroom.cli", *sys.argv[1:]]) ``` That reconstruction is only faithful when the process really *is* the Headroom CLI. Ten-plus test files invoke the `proxy` command in-process through Click's `CliRunner`. There, `os.execv` replaces **pytest** with a Headroom process holding pytest's argv. Run with `-s`, the mechanism is visible: ``` tests/test_agent_savings.py Usage: python -m headroom.cli [OPTIONS] COMMAND [ARGS]... Error: No such command 'tests/test_agent_savings.py::test_proxy_cli_reads_agent_90_profile_env'. ``` Everything after the first such test — roughly 98% of the suite — never runs. The same hazard applies to any application embedding the CLI. **The documented kill switch does not help.** `tests/conftest.py:41` scrubs every `HEADROOM_*` variable for hermeticity, so `HEADROOM_MALLOC_TUNING` is deleted before the guard reads it. Only the private `_HEADROOM_MALLOC_TUNED` survives, because it starts with an underscore. **CI could not have caught this.** The tuning is Darwin-only, and while the repo *does* have macOS jobs (`macos-native-wrapper`, `wrap-native (macos-latest)`), neither runs the Python test suite — the `test` shards are `ubuntu-latest` only. So `sys.platform != "darwin"` returns first everywhere pytest actually runs. #2879 merged with 37 green checks. ### 2. A semantic merge conflict between two green PRs #3051 added `bind_scope(tags, request.scope)` at `gemini.py:325` and updated the three Gemini fakes it knew about. #3035 branched earlier and added a fourth `_FakeRequest` without `.scope`. Each was green against its own base; together they fail: ``` AttributeError: '_FakeRequest' object has no attribute 'scope' ``` Git merged both cleanly. Only running the suite on merged `main` surfaces it. ## 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 ## Changes Made - Added `_process_is_headroom_cli_entrypoint()`: the re-exec now verifies its own precondition — `argv[0]` must be the `headroom` console script or `headroom/cli/__main__.py`. - The embedded path returns **before** stamping `_HEADROOM_MALLOC_TUNED`, so a genuine CLI child inheriting the environment can still apply the tuning. - Gave the Gemini `_FakeRequest` the `.scope` every real Starlette `Request` carries. - `test_reexec_skips_when_operator_already_set_vars` now sets a realistic `argv[0]`, matching its sibling exec test. - New `tests/test_cli_proxy_malloc_reexec_guard.py` asserting the guard's logic on **every** platform, since no CI runner is macOS. ## Testing - [x] Unit tests pass - [x] Linting passes (ruff check + format) - [ ] Type checking passes (`uv run mypy headroom`) — not run - [x] New tests added for new functionality ### Test Output Before, on `main`: ```text $ .venv/bin/python -m pytest tests/ -q collected 11622 items / 8 skipped ... tests/test_agent_savings.py ............................ $ echo $? 2 ``` No summary line — the run does not end, it is replaced. After, on this branch: ```text $ .venv/bin/python -m pytest tests/ -q 3 failed, 11055 passed, 581 skipped, 6034 warnings in 303.69s (0:05:03) ``` All three remaining failures reproduce at `f9807fd6`, before today's merges, and are unrelated: | test | cause | |---|---| | `test_graceful_shutdown::test_run_server_installs_cancelled_error_filter` | full-suite ordering; passes in isolation (11 passed) | | `test_learn/test_integration::TestCodexIntegration::test_full_pipeline` | pre-existing | | `test_release_workflows::test_no_native_tls_in_wheel_build_tree` | requires `cargo`, absent on this host | ## Real Behavior Proof - Environment: macOS 15 (darwin 25.4.0), Python 3.12.13, arm64, real checkout of `main` at `ef7e07e0`. - Exact command / steps: bisected the crash to a single test, then to a single commit — `be5b26d8` (parent) exits 0, `6d87825f` (#2879) exits 2. Confirmed causation by temporarily replacing the `os.execv` line with `return`, which makes the test pass. Recovered the mechanism by running the crashing test with `-s`, which prints the Headroom CLI rejecting pytest's own argv. - Observed result: on `main` the suite cannot reach a summary; on this branch it completes with 11,055 passing. The two-file reproduction (`test_agent_savings.py` + `test_anthropic_beta_session_sticky.py`) goes from exit 2 to 62 passed. - Not tested: a real `headroom proxy` launch on macOS confirming libmalloc still receives the knobs after re-exec. The guard is covered by unit tests asserting `execv` is still called with `["-m", "headroom.cli", "proxy", "--port", "8787"]` for a console-script `argv[0]`, but I have not watched `vmmap` on a live proxy. **A macOS maintainer should confirm #2820's RSS fix still works end to end before this ships.** ## Runtime Rollout Safety - Rollout-managed feature(s): none. - Minimum rollout channel: N/A. - Stable/default behavior changed: no for a real CLI launch; the re-exec no longer fires when the CLI is invoked in-process, which was never intended to work. - Kill switch / disable path: `HEADROOM_MALLOC_TUNING=0` still disables the tuning outright. - Unsafe override required: none. - Qualification impact: none. - Rollback path: revert this commit — but that restores a `main` whose test suite cannot run on macOS. ## 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 ## Additional Notes **This is my fault and worth recording.** I merged both #2879 and #3035 earlier today on the rule "approved + green CI". Both were genuinely approved and genuinely green. Neither was rebased onto current `main` first, and CI has no macOS runner, so green meant less than it appeared to. Two process gaps this exposes, neither of which this PR fixes: 1. **The Python test suite never runs on macOS.** The repo has macOS jobs (`macos-native-wrapper`, `wrap-native (macos-latest)`), but the `test` shards are `ubuntu-latest` only, so Darwin-only code paths — the allocator tuning is one, `wrap` has others — are unreachable by pytest in CI. Even a reduced macOS shard would have caught this. 2. **Nothing requires a PR to be current with `main` before merging.** Both defects here are cross-PR interactions that no per-PR check can see. Enabling "require branches to be up to date before merging" on `main` would have forced a rebase and surfaced the Gemini fake. I would suggest an issue for each rather than folding them in here. Co-authored-by: Tejas Chopra <tejas@Tejass-MacBook-Pro.local>
134 lines
4.7 KiB
Python
134 lines
4.7 KiB
Python
"""A Gemini CCR continuation with a present-null usage count must not 502.
|
|
|
|
The initial-response and non-CCR extraction sites guard against Gemini
|
|
returning a *present-null* ``promptTokenCount`` (a key that is present with a
|
|
JSON ``null`` value, which ``.get(key, default)`` returns as ``None`` rather
|
|
than the default). The CCR-continuation site re-read the continuation's
|
|
``usageMetadata`` with a bare ``.get(key, prior)`` and skipped that guard, so a
|
|
present-null count on the continuation turned the ``max(0, prompt - cache_read)``
|
|
arithmetic into ``None`` math, raised ``TypeError``, and the outer handler
|
|
masked a successful 200 as a synthetic 502.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import json
|
|
from types import SimpleNamespace
|
|
|
|
import pytest
|
|
|
|
from headroom.proxy.handlers.gemini import GeminiHandlerMixin
|
|
|
|
|
|
class _FakeRequest:
|
|
def __init__(self) -> None:
|
|
self.headers: dict[str, str] = {}
|
|
self.query_params: dict[str, str] = {}
|
|
self.url = SimpleNamespace(path="/v1beta/models/gemini-pro:generateContent", query="")
|
|
# Every real Starlette Request carries a scope, and the Gemini handler
|
|
# binds the savings-attribution ledger to it (#3051). Without this the
|
|
# double is a shape that cannot occur in production.
|
|
self.scope: dict = {"type": "http", "method": "POST"}
|
|
|
|
|
|
class _CcrToolCallResponse:
|
|
"""Initial 200 carrying a CCR tool call and a valid promptTokenCount."""
|
|
|
|
status_code = 200
|
|
content = json.dumps(
|
|
{
|
|
"candidates": [
|
|
{"content": {"parts": [{"functionCall": {"name": "headroom_retrieve"}}]}}
|
|
],
|
|
"usageMetadata": {"promptTokenCount": 100, "candidatesTokenCount": 5},
|
|
}
|
|
).encode()
|
|
headers = {"content-type": "application/json"}
|
|
|
|
def json(self) -> object:
|
|
return json.loads(self.content)
|
|
|
|
|
|
class _CcrConfig:
|
|
enabled = True
|
|
|
|
|
|
class _CcrHandler:
|
|
"""Stub CCR handler whose continuation reports a present-null usage count."""
|
|
|
|
config = _CcrConfig()
|
|
|
|
def has_ccr_tool_calls(self, resp_json, provider) -> bool: # noqa: ANN001
|
|
return True
|
|
|
|
async def handle_response(self, resp_json, contents, native_fns, api_call_fn, provider): # noqa: ANN001, ANN201
|
|
return {
|
|
"candidates": [{"content": {"parts": [{"text": "resolved"}]}}],
|
|
# The continuation turn omits real counts as JSON null.
|
|
"usageMetadata": {
|
|
"promptTokenCount": None,
|
|
"candidatesTokenCount": None,
|
|
"cachedContentTokenCount": None,
|
|
},
|
|
}
|
|
|
|
def residual_ccr_status(self, final_resp_json, provider): # noqa: ANN001, ANN201
|
|
return None # not RESIDUAL_CCR_ERROR
|
|
|
|
|
|
class _FakeMetrics:
|
|
def __init__(self) -> None:
|
|
self.failed: list[str] = []
|
|
|
|
async def record_failed(self, *, provider: str, model: str = "") -> None:
|
|
self.failed.append(f"{provider}:{model}")
|
|
|
|
|
|
class _Handler(GeminiHandlerMixin):
|
|
GEMINI_API_URL = "https://gemini.example"
|
|
|
|
def __init__(self) -> None:
|
|
self.memory_handler = None
|
|
self.rate_limiter = None
|
|
self.usage_reporter = None
|
|
self.config = SimpleNamespace(
|
|
optimize=False,
|
|
anthropic_pre_upstream_memory_context_timeout_seconds=0.1,
|
|
)
|
|
self.metrics = _FakeMetrics()
|
|
self.ccr_response_handler = _CcrHandler()
|
|
self.outcomes: list = []
|
|
|
|
async def _next_request_id(self) -> str:
|
|
return "req-ccr-1"
|
|
|
|
async def _retry_request(self, method, url, headers, body): # noqa: ANN001, ANN201
|
|
return _CcrToolCallResponse()
|
|
|
|
async def _record_request_outcome(self, outcome) -> None: # noqa: ANN001
|
|
self.outcomes.append(outcome)
|
|
|
|
async def _count_tokens_offloaded(self, model, messages): # noqa: ANN001, ANN201
|
|
return SimpleNamespace(), 100
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_ccr_continuation_present_null_usage_does_not_502(
|
|
monkeypatch: pytest.MonkeyPatch,
|
|
) -> None:
|
|
async def payload(request): # noqa: ANN001, ANN201
|
|
return {"contents": [{"role": "user", "parts": [{"text": "hello"}]}]}
|
|
|
|
monkeypatch.setattr("headroom.proxy.helpers._read_request_json", payload)
|
|
|
|
handler = _Handler()
|
|
response = await handler.handle_gemini_generate_content(_FakeRequest(), "gemini-pro")
|
|
|
|
# Before the fix this raised TypeError on the None arithmetic and the outer
|
|
# handler returned a synthetic 502 with a recorded failure.
|
|
assert response.status_code == 200
|
|
assert handler.metrics.failed == []
|
|
assert handler.outcomes[0].status_code == 200
|
|
# The pre-continuation count (100) survives as the fallback.
|
|
assert handler.outcomes[0].optimized_tokens == 100
|
|
assert handler.outcomes[0].cache_read_tokens == 0
|