headroom/tests/test_ccr_mcp_server.py
Vsevolod Rychkov 7a5d8a7ace
fix(mcp): reap orphaned mcp serve on client death (#2226)
## Description

`headroom mcp serve` processes survive after the launching MCP client
(e.g. Claude Code) exits, get reparented to init/launchd (`ppid == 1`),
and never terminate — piling up one pinned Python interpreter +
tree-sitter grammars per dead session (observed 3+ simultaneously).

An MCP stdio server is supposed to shut down on stdin EOF, but an abrupt
client `SIGKILL` leaves the MCP SDK's blocking stdin-reader thread
wedged, so `await self.server.run(...)` in `run_stdio()` never returns
and the process orphans.

Refs #2185 (its secondary "orphaned `mcp serve` pileup", left out of
#2204's `Refs`-only Perl fix), #1761 (same symptom: "orphaned `headroom
mcp serve` processes accumulate … even after quitting").

## 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/ccr/mcp_server.py`:
- Added `PARENT_DEATH_POLL_INTERVAL = 5.0` module constant.
- Added `HeadroomMCPServer._await_parent_death(interval)`: captures the
launch ppid and resolves once it changes. Watching for a *change* (not a
hard `== 1`) is portable to Linux PID subreapers, which adopt the orphan
with their own pid.
- Reworked `run_stdio()` to run that watchdog concurrently with
`server.run()`. On parent death it `os._exit(0)`s **from inside** the
`stdio_server()` context manager — the wedged stdin reader would also
hang the context-manager teardown and a cooperative `server.run` cancel,
so a hard exit is the only reliable reaper. The normal stdin-EOF path is
unchanged: `server.run` wins the race, the watchdog is cancelled, and
the context manager unwinds cleanly.

`tests/test_ccr_mcp_server.py`: 3 regression tests (below).
`CHANGELOG.md`: entry under Unreleased → Fixed.

## Testing

- [x] Unit tests pass (`uv run pytest tests/test_ccr_mcp_server.py -q`)
- [x] Linting passes (`uv run ruff check headroom/ccr/mcp_server.py
tests/test_ccr_mcp_server.py`)
- [x] Type checking passes (`uv run mypy headroom/ccr/mcp_server.py`)
- [x] New tests added for new functionality
- [x] Manual testing performed (see Real Behavior Proof)

New tests:
- `test_parent_death_watchdog_fires_when_reparented` — ppid change
resolves the watchdog.
- `test_parent_death_watchdog_stays_quiet_with_live_parent` — a stable
ppid never trips it.
- `test_run_stdio_reaps_process_on_parent_death` — on reparent,
`run_stdio` cleans up and hits `os._exit(0)` even though the (stubbed)
`server.run` never returns.

### Test Output

```text
$ uv run pytest tests/test_ccr_mcp_server.py -q
collected 21 items
tests/test_ccr_mcp_server.py .....................                       [100%]
============================== 21 passed in 0.57s ==============================

$ uv run ruff check headroom/ccr/mcp_server.py tests/test_ccr_mcp_server.py
All checks passed!

$ uv run mypy headroom/ccr/mcp_server.py
Success: no issues found in 1 source file
```

## Real Behavior Proof

- Environment: macOS 26.5 arm64, Python 3.14.6, headroom built from this
branch via `uv sync --all-extras` (Rust extension compiled). No provider
call.
- Exact command / steps: launch a real `HeadroomMCPServer.run_stdio()`
as a child of a throwaway parent, with stdin wired to a FIFO whose write
end is held open by a separate process (so stdin **never** reaches EOF —
this isolates the watchdog as the only possible reaper). Then `kill -9`
the parent to reparent the server to `pid 1`, and watch. The watchdog
poll interval is passed via `run_stdio(parent_death_poll_interval=…)` to
A/B the exact same shipped code path:

```text
### interval=9999s  (watchdog effectively OFF — reproduces the bug) ###  ppid(pre-kill)=43438
  -> STILL ALIVE after 8s (orphan lingers)

### interval=0.5s   (watchdog ON — the fix) ###  ppid(pre-kill)=43461
  -> REAPED at ~2s
```

And with the default flow (`headroom mcp serve`, default 5s interval),
the watchdog logs before the process exits:

```text
headroom.ccr.mcp - INFO - Headroom MCP Server starting (proxy: http://127.0.0.1:8787)
headroom.ccr.mcp - WARNING - parent process gone (ppid 41956 -> 1); shutting down MCP server
```

- Observed result: with the watchdog disabled the orphaned server
lingers indefinitely (reproduces the reported pileup); with it enabled
the orphan is reaped within one poll interval of the parent dying.
- Not tested: Linux/systemd and Windows spawn paths (the change is
POSIX-portable via ppid-change detection, but I only exercised macOS);
the reporters' desktop-app menu-bar quit path.

## 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
- [x] New and existing unit tests pass locally with my changes
- [x] I have updated the CHANGELOG.md

## Additional Notes

- Deliberately `os._exit(0)`, not a cooperative shutdown: the failure
mode is a wedged native stdin-reader thread, so both `server.run`
cancellation and the `stdio_server` context-manager exit can block
forever. Exiting from inside the context manager is the only path that
reliably reaps the orphan; the normal EOF path never reaches it.
- A Linux-only `prctl(PR_SET_PDEATHSIG)` fast-path could cut reap
latency to ~0, but it is racy (must re-check `getppid()` after arming)
and non-portable, so the portable poll is the primary mechanism. Happy
to add prctl as a follow-up optimization if wanted.
- Watchdog latency is bounded by `PARENT_DEATH_POLL_INTERVAL` (5s
default); trivial to make env-configurable if a tighter bound is
preferred.



---

🤖 This PR was created with [Claude Code](https://claude.com/claude-code)
but checked by the author

Co-authored-by: JerrettDavis <mxjerrett@gmail.com>
2026-07-15 18:57:32 +00:00

494 lines
17 KiB
Python

from __future__ import annotations
import asyncio
import contextlib
import json
import pytest
from headroom.cache import compression_store as compression_store_module
from headroom.cache.compression_store import (
get_compression_store,
reset_compression_store,
)
from tests._mcp_stub import import_module_with_mcp_stub
mcp_server = import_module_with_mcp_stub("headroom.ccr.mcp_server")
def test_shared_stats_work_without_fcntl(monkeypatch, tmp_path) -> None:
monkeypatch.setattr(mcp_server, "_HAS_FCNTL", False)
monkeypatch.setattr(mcp_server, "fcntl", None)
monkeypatch.setattr(mcp_server, "SHARED_STATS_DIR", tmp_path)
monkeypatch.setattr(mcp_server, "SHARED_STATS_FILE", tmp_path / "session_stats.jsonl")
monkeypatch.setattr(mcp_server.os, "getpid", lambda: 4242)
monkeypatch.setattr(mcp_server.time, "time", lambda: 1001.0)
event = {"type": "compress", "timestamp": 1000.0}
mcp_server._append_shared_event(event)
raw_lines = mcp_server.SHARED_STATS_FILE.read_text(encoding="utf-8").splitlines()
assert len(raw_lines) == 1
assert json.loads(raw_lines[0]) == {"type": "compress", "timestamp": 1000.0, "pid": 4242}
events = mcp_server._read_shared_events(window_seconds=60)
assert events == [{"type": "compress", "timestamp": 1000.0, "pid": 4242}]
# --- Shared compression store wiring ---------------------------------------
# MCP's _get_local_store() must return the get_compression_store() singleton —
# the same instance the proxy and response_handler use — so content compressed
# on either side is retrievable in-process. These pin that wiring so a private
# store can't creep back.
@pytest.fixture
def fresh_store():
reset_compression_store()
yield
reset_compression_store()
def test_mcp_uses_shared_singleton_store(fresh_store) -> None:
"""MCP's store is the global singleton, not a private instance."""
server = mcp_server.HeadroomMCPServer(check_proxy=False)
assert server._get_local_store() is get_compression_store()
def test_mcp_retrieves_proxy_stored_content(fresh_store) -> None:
"""Content stored via the singleton (as the proxy does) is retrievable
through MCP's local-store path. The HTTP fallback is disabled so this
passes only via the shared store."""
original = '{"some": "original proxy-compressed content"}'
hash_key = get_compression_store().store(original, '{"compressed": true}')
server = mcp_server.HeadroomMCPServer(check_proxy=False)
result = asyncio.run(server._retrieve_content(hash_key))
assert result.get("source") == "local"
assert result["original_content"] == original
def test_compress_savings_percent_tracks_token_counts(fresh_store) -> None:
"""``savings_percent`` must be the *removed* percentage derived from the
token counts — never the retained percentage. Regression for the inversion
where ``(1 - compression_ratio)`` reported a no-op (0% saved) as 100%."""
pytest.importorskip("mcp", reason="MCP SDK required")
server = mcp_server.HeadroomMCPServer(check_proxy=False)
# Repetitive JSON array — the shape the engine actually compresses.
content = json.dumps([{"id": i, "status": "ok", "kind": "run"} for i in range(40)])
result = server._compress_content(content)
orig = result["original_tokens"]
comp = result["compressed_tokens"]
expected = round((1 - comp / orig) * 100, 1) if orig > 0 else 0
# Reported savings agrees with the token fields (and with tokens_saved).
assert result["savings_percent"] == expected
assert 0.0 <= result["savings_percent"] <= 100.0
if result["tokens_saved"] == 0:
assert result["savings_percent"] == 0.0 # not inverted to 100
else:
assert result["savings_percent"] > 0.0
def test_mcp_compress_surfaces_unreachable_proxy(fresh_store) -> None:
server = mcp_server.HeadroomMCPServer(
proxy_url="http://127.0.0.1:9",
check_proxy=True,
)
response = asyncio.run(server._handle_compress({"content": "dead proxy check"}))
payload = json.loads(response[0].kwargs["text"])
assert payload["proxy"]["status"] == "unreachable"
assert payload["proxy"]["url"] == "http://127.0.0.1:9"
assert "unreachable" in payload["warning"].lower()
def test_mcp_stats_surfaces_unreachable_proxy() -> None:
server = mcp_server.HeadroomMCPServer(
proxy_url="http://127.0.0.1:9",
check_proxy=True,
)
response = asyncio.run(server._handle_stats())
payload = json.loads(response[0].kwargs["text"])
assert payload["proxy"]["status"] == "unreachable"
assert payload["proxy"]["url"] == "http://127.0.0.1:9"
assert "unreachable" in payload["warning"].lower()
def test_mcp_proxy_probe_preserves_shared_proxy_client(monkeypatch: pytest.MonkeyPatch) -> None:
class ProbeResponse:
status_code = 200
text = ""
@staticmethod
def json() -> dict[str, object]:
return {"status": "healthy", "alive": True}
class ProbeClient:
def __init__(self, *, timeout: float) -> None:
seen["timeout"] = timeout
async def __aenter__(self) -> ProbeClient:
return self
async def __aexit__(self, *_args: object) -> None:
seen["closed"] = True
async def get(self, url: str) -> ProbeResponse:
seen["url"] = url
return ProbeResponse()
seen: dict[str, object] = {}
shared_client = object()
monkeypatch.setattr(mcp_server.httpx, "AsyncClient", ProbeClient)
server = mcp_server.HeadroomMCPServer(
proxy_url="http://127.0.0.1:8765",
check_proxy=True,
)
server._http_client = shared_client # type: ignore[assignment]
result = asyncio.run(server._probe_proxy_unreachable())
assert result is None
assert seen == {
"timeout": 5.0,
"url": "http://127.0.0.1:8765/livez",
"closed": True,
}
assert server._http_client is shared_client
def test_mcp_local_mode_still_works_without_proxy_checking(fresh_store) -> None:
server = mcp_server.HeadroomMCPServer(
proxy_url="http://127.0.0.1:9",
check_proxy=False,
)
response = asyncio.run(server._handle_compress({"content": "local mode stays available"}))
payload = json.loads(response[0].kwargs["text"])
assert "proxy" not in payload
assert "warning" not in payload or "unreachable" not in payload["warning"].lower()
def test_mcp_retrieve_returns_full_content(fresh_store) -> None:
"""Retrieval is by hash: a stored, unexpired entry always returns its full
original content (never empty, never a spurious "not found")."""
original = "the the the the the the the the the the\n" * 5
hash_key = get_compression_store().store(original, "<<small>>")
server = mcp_server.HeadroomMCPServer(check_proxy=False)
result = asyncio.run(server._retrieve_content(hash_key))
assert "error" not in result
assert result.get("source") == "local"
assert result["original_content"] == original
def test_mcp_retrieve_expired_hash_returns_terminal_guidance(
monkeypatch,
fresh_store,
) -> None:
"""An expired local hash should say it expired and tell the agent to stop retrying."""
current_time = [1000.0]
def fake_time() -> float:
return current_time[0]
monkeypatch.setattr(mcp_server.time, "time", fake_time)
monkeypatch.setattr(compression_store_module.time, "time", fake_time)
store = get_compression_store()
hash_key = store.store("expired content", "<<small>>", ttl=1)
current_time[0] = 1002.0
server = mcp_server.HeadroomMCPServer(check_proxy=False)
result = asyncio.run(server._retrieve_content(hash_key))
assert result["status"] == "expired"
assert result["ttl_seconds"] == 1
assert result["age_seconds"] == pytest.approx(2.0)
assert "Entry expired" in result["error"]
assert "do not retry the same hash" in result["error"].lower()
assert "re-run the command" in result["hint"].lower()
def test_mcp_retrieve_hash_expiring_during_lookup_returns_terminal_guidance(
monkeypatch,
fresh_store,
) -> None:
phase = "store"
status_seen = False
def fake_time() -> float:
if phase == "store":
return 1000.0
return 1001.1 if status_seen else 1000.5
monkeypatch.setattr(mcp_server.time, "time", fake_time)
monkeypatch.setattr(compression_store_module.time, "time", fake_time)
store = get_compression_store()
hash_key = store.store("expired during retrieve", "<<small>>", ttl=1)
phase = "retrieve"
original_get_entry_status = store.get_entry_status
original_retrieve = store.retrieve
def get_entry_status_then_expire(*args, **kwargs):
nonlocal status_seen
result = original_get_entry_status(*args, **kwargs)
status_seen = True
return result
monkeypatch.setattr(store, "get_entry_status", get_entry_status_then_expire)
monkeypatch.setattr(store, "retrieve", original_retrieve)
server = mcp_server.HeadroomMCPServer(check_proxy=False)
result = asyncio.run(server._retrieve_content(hash_key))
assert result["status"] == "expired"
assert result["ttl_seconds"] == 1
assert result["age_seconds"] == pytest.approx(1.1)
assert "Entry expired" in result["error"]
assert "do not retry the same hash" in result["error"].lower()
def test_mcp_retrieve_missing_local_hash_can_still_hit_proxy(
monkeypatch,
fresh_store,
) -> None:
monkeypatch.setattr(mcp_server, "HTTPX_AVAILABLE", True)
server = mcp_server.HeadroomMCPServer(check_proxy=True)
async def retrieve_via_proxy(hash_key: str) -> dict[str, object]:
return {"hash": hash_key, "original_content": "from proxy"}
server._retrieve_via_proxy = retrieve_via_proxy
result = asyncio.run(server._retrieve_content("proxy_hash"))
assert result["source"] == "proxy"
assert result["hash"] == "proxy_hash"
assert result["original_content"] == "from proxy"
def test_mcp_retrieve_expired_local_hash_can_still_hit_proxy(
monkeypatch,
fresh_store,
) -> None:
current_time = [1000.0]
def fake_time() -> float:
return current_time[0]
monkeypatch.setattr(mcp_server, "HTTPX_AVAILABLE", True)
monkeypatch.setattr(mcp_server.time, "time", fake_time)
monkeypatch.setattr(compression_store_module.time, "time", fake_time)
store = get_compression_store()
hash_key = store.store("expired local content", "<<small>>", ttl=1)
current_time[0] = 1002.0
server = mcp_server.HeadroomMCPServer(check_proxy=True)
async def retrieve_via_proxy(proxy_hash_key: str) -> dict[str, object]:
return {"hash": proxy_hash_key, "original_content": "from proxy"}
server._retrieve_via_proxy = retrieve_via_proxy
result = asyncio.run(server._retrieve_content(hash_key))
assert result["source"] == "proxy"
assert result["hash"] == hash_key
assert result["original_content"] == "from proxy"
def test_mcp_retrieve_missing_hash_still_errors(fresh_store) -> None:
"""A never-stored hash must stay on the generic missing path, not expired guidance."""
server = mcp_server.HeadroomMCPServer(check_proxy=False)
result = asyncio.run(server._retrieve_content("nonexistent_hash"))
assert result.get("status") is None
assert result["error"] == "Content not found. It may have expired or the hash may be incorrect."
assert "do not retry the same hash" not in result.get("hint", "").lower()
def test_handle_stats_session_output_is_window_scoped() -> None:
"""window-scoped stats output should be explicitly labeled after this change."""
async def fetch_stats() -> dict[str, object]:
return {
"summary": {
"mode": "token",
"api_requests": 3,
"compression": {},
}
}
server = mcp_server.HeadroomMCPServer(check_proxy=True)
server._fetch_full_proxy_stats = fetch_stats
response = asyncio.run(server._handle_stats())
text = response[0].kwargs["text"]
assert "Headroom Window-Scoped Session Summary" in text
assert "Headroom Session Summary" not in text
def test_handle_stats_includes_lifetime_totals_from_persistent_savings() -> None:
"""Lifetime savings are appended from /stats persistent_savings.lifetime."""
async def fetch_stats() -> dict[str, object]:
return {
"summary": {
"mode": "token",
"api_requests": 3,
"compression": {},
},
"persistent_savings": {
"lifetime": {"tokens_saved": 12345, "compression_savings_usd": 7.25}
},
}
server = mcp_server.HeadroomMCPServer(check_proxy=True)
server._fetch_full_proxy_stats = fetch_stats
response = asyncio.run(server._handle_stats())
text = response[0].kwargs["text"]
assert "Lifetime Savings:" in text
assert "Tokens saved: 12,345" in text
assert "Compression savings: $7.25" in text
def test_handle_stats_falls_back_gracefully_without_persistent_lifetime() -> None:
"""Missing lifetime data should still return a valid session summary."""
async def fetch_stats() -> dict[str, object]:
return {
"summary": {
"mode": "token",
"api_requests": 3,
"compression": {},
},
"persistent_savings": {"lifetime": None},
}
server = mcp_server.HeadroomMCPServer(check_proxy=True)
server._fetch_full_proxy_stats = fetch_stats
response = asyncio.run(server._handle_stats())
text = response[0].kwargs["text"]
assert "Headroom Window-Scoped Session Summary" in text
assert "Lifetime Savings:" not in text
def test_handle_stats_shows_zero_lifetime_totals_when_present() -> None:
"""A present lifetime payload should still render explicit zero totals."""
async def fetch_stats() -> dict[str, object]:
return {
"summary": {
"mode": "token",
"api_requests": 3,
"compression": {},
},
"persistent_savings": {"lifetime": {"tokens_saved": 0, "compression_savings_usd": 0.0}},
}
server = mcp_server.HeadroomMCPServer(check_proxy=True)
server._fetch_full_proxy_stats = fetch_stats
response = asyncio.run(server._handle_stats())
text = response[0].kwargs["text"]
assert "Lifetime Savings:" in text
assert "Tokens saved: 0" in text
assert "Compression savings: $0.00" in text
# --- Parent-death watchdog: reap orphaned `mcp serve` on client death --------
# When the launching MCP client is SIGKILLed, stdin EOF may never arrive and the
# SDK's blocking stdin reader wedges server.run() forever, orphaning this process
# under init/launchd. run_stdio() runs a watchdog that detects the reparent and
# forces shutdown. Refs headroomlabs-ai/headroom#2185 (secondary), #1761.
def test_parent_death_watchdog_fires_when_reparented(monkeypatch) -> None:
"""When ppid changes (client died), the watchdog resolves promptly."""
server = mcp_server.HeadroomMCPServer(check_proxy=False)
calls = {"n": 0}
def fake_getppid() -> int:
calls["n"] += 1
return 500 if calls["n"] == 1 else 1 # captured live, then reparented
monkeypatch.setattr(mcp_server.os, "getppid", fake_getppid)
async def run() -> None:
await asyncio.wait_for(server._await_parent_death(0.001), timeout=1.0)
asyncio.run(run()) # returns => detected reparent; TimeoutError would fail
def test_parent_death_watchdog_stays_quiet_with_live_parent(monkeypatch) -> None:
"""A stable ppid must never trip the watchdog."""
server = mcp_server.HeadroomMCPServer(check_proxy=False)
monkeypatch.setattr(mcp_server.os, "getppid", lambda: 500)
async def run() -> None:
with pytest.raises(asyncio.TimeoutError):
await asyncio.wait_for(server._await_parent_death(0.001), timeout=0.05)
asyncio.run(run())
def test_run_stdio_reaps_process_on_parent_death(monkeypatch) -> None:
"""On reparent, run_stdio cleans up and calls os._exit(0) even though the
(stubbed) server.run never returns — the orphan-reaper path."""
server = mcp_server.HeadroomMCPServer(check_proxy=False)
@contextlib.asynccontextmanager
async def fake_stdio_server():
yield (object(), object())
monkeypatch.setattr(mcp_server, "stdio_server", fake_stdio_server)
async def never_returns(*_args, **_kwargs) -> None:
await asyncio.sleep(3600) # emulate the wedged SDK reader
# DummyServer (MCP SDK stub) has no `.run`; raising=False lets us add it.
monkeypatch.setattr(server.server, "run", never_returns, raising=False)
calls = {"n": 0}
def fake_getppid() -> int:
calls["n"] += 1
return 500 if calls["n"] == 1 else 1
monkeypatch.setattr(mcp_server.os, "getppid", fake_getppid)
cleaned = {"done": False}
async def fake_cleanup() -> None:
cleaned["done"] = True
monkeypatch.setattr(server, "cleanup", fake_cleanup)
class _Exited(Exception):
pass
def fake_exit(code: int) -> None:
raise _Exited(code) # intercept so pytest survives
monkeypatch.setattr(mcp_server.os, "_exit", fake_exit)
with pytest.raises(_Exited) as excinfo:
asyncio.run(server.run_stdio(parent_death_poll_interval=0.001))
assert excinfo.value.args[0] == 0
assert cleaned["done"] is True