mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
## Description
Adds a durable, cross-process savings ledger and a `headroom savings`
CLI that shows cost avoided plus Today / Last 7 days / All time
breakdowns by model and client. Unlike `headroom_stats` (a per-session,
in-memory snapshot), the ledger is on disk and survives proxy and agent
restarts, and is safe across the many MCP processes Headroom spawns.
## Type of Change
- [ ] Bug fix (non-breaking change that fixes an issue)
- [x] 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
- Add `headroom/savings_ledger.py`: append-only, `fcntl`-locked JSONL
ledger at `~/.headroom/savings_events.jsonl`, safe across concurrent
writers (main MCP server, each subagent, and the proxy), aggregated on
read so totals survive restarts.
- litellm list pricing for known models; blended `$3/1M` input-token
fallback for `model="unknown"` (MCP compressions do not know the
upstream model). Self-pruning: events past the 365-day retention window
are dropped on read and the file is compacted once large.
- Add `headroom savings` CLI (`headroom/cli/savings.py`) with `--json`,
`--days N`, and `--reset` flags.
- Proxy client attribution: `record_request` accepts `client` and
threads `outcome.client` into the ledger, so proxy events record the
real harness (claude-code, codex, cursor, …) from the existing
`classify_client()` detection, falling back to `"proxy"` only when
unidentified.
- MCP compress hook records the client (from `clientInfo.name`) and
tokens saved after each `headroom_compress`; `HEADROOM_MCP_CLIENT` /
`HEADROOM_MCP_MODEL` env overrides.
- Add the `savings_events_path()` helper +
`HEADROOM_SAVINGS_EVENTS_PATH` env in `headroom/paths.py`, the docs page
`docs/content/docs/savings.mdx`, and 15 tests.
## Testing
- [x] Unit tests pass (`pytest`)
- [x] Linting passes (`ruff check .`)
- [x] Type checking passes (`mypy headroom`)
- [x] New tests added for new functionality
- [x] Manual testing performed
### Test Output
The single warning is a pre-existing, repo-wide
`StarletteDeprecationWarning` from
`fastapi.testclient` (the venv has `httpx`, not `httpx2`); it is
unrelated to this
change and fires in every proxy test that spins up a `TestClient`.
```text
$ .venv/bin/python -m pytest tests/test_savings_ledger.py -q
............... [100%]
15 passed, 1 warning in 5.17s
# warning: fastapi/testclient.py StarletteDeprecationWarning (httpx vs httpx2) — third-party, pre-existing
$ .venv/bin/ruff check headroom/savings_ledger.py headroom/cli/savings.py \
headroom/ccr/mcp_server.py headroom/proxy/prometheus_metrics.py \
headroom/proxy/outcome.py headroom/paths.py tests/test_savings_ledger.py
All checks passed!
$ .venv/bin/mypy headroom/savings_ledger.py headroom/cli/savings.py \
headroom/ccr/mcp_server.py headroom/proxy/prometheus_metrics.py \
headroom/proxy/outcome.py headroom/paths.py
Success: no issues found in 6 source files
```
## Real Behavior Proof
- Environment: macOS (Darwin 25.5.0), Python 3.13.13, editable install
of this branch, proxy running on :8787
- Exact command / steps: route live agent + proxy traffic through
Headroom, then run `headroom savings`
- Observed result: distinct Today / Last 7 days / All time windows with
per-model and per-client breakdowns, as below
- Not tested: Windows runtime (no `fcntl`; the ledger falls back to
best-effort append)
```text
Today ██░░░░░░░░░░░░░░ 11.3% saved 472,870 / 4,193,288 tokens $1.5920
Last 7 days ██░░░░░░░░░░░░░░ 11.9% saved 505,170 / 4,244,288 tokens $1.7385
All time ██░░░░░░░░░░░░░░ 13.0% saved 566,170 / 4,339,288 tokens $1.9815
Cost avoided per model:
claude-sonnet-4-6 $1.2200
claude-opus-4-8 $0.6685
gpt-5.5 $0.0840
claude-haiku-4-5 $0.0090
Savings by client:
claude-code 60 calls · 524,970 tokens saved
cursor 2 calls · 16,800 tokens saved
codex 3 calls · 24,400 tokens saved
```
## 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] 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
- [x] I have updated the CHANGELOG.md if applicable
## Additional Notes
The one pytest warning is a third-party `StarletteDeprecationWarning`
from `fastapi.testclient` (pre-existing, repo-wide); not introduced
here. CHANGELOG.md not updated.
281 lines
10 KiB
Python
281 lines
10 KiB
Python
"""Tests for the durable savings event ledger and the `headroom savings` CLI."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import json
|
|
from datetime import datetime, timedelta, timezone
|
|
|
|
import pytest
|
|
|
|
from headroom import savings_ledger as L
|
|
|
|
UTC = timezone.utc
|
|
|
|
|
|
def _events_env(monkeypatch, tmp_path):
|
|
path = tmp_path / "savings_events.jsonl"
|
|
monkeypatch.setenv("HEADROOM_SAVINGS_EVENTS_PATH", str(path))
|
|
return path
|
|
|
|
|
|
# --------------------------------------------------------------------------- #
|
|
# core ledger
|
|
# --------------------------------------------------------------------------- #
|
|
|
|
|
|
def test_unknown_model_uses_blended_fallback(monkeypatch, tmp_path):
|
|
_events_env(monkeypatch, tmp_path)
|
|
assert L.record_savings_event(tokens_before=1000, tokens_after=400, model=None, client="c")
|
|
report = L.aggregate_savings()
|
|
assert report.lifetime["tokens_saved"] == 600
|
|
expected = round(600 * L.DEFAULT_FALLBACK_INPUT_COST_PER_TOKEN, 6)
|
|
assert report.lifetime["cost_usd"] == pytest.approx(expected)
|
|
assert any(row["model"] == "unknown" for row in report.by_model)
|
|
|
|
|
|
def test_estimate_cost_unknown_short_circuits_to_fallback():
|
|
assert L.estimate_cost_usd("unknown", 1000, fallback_rate=1e-6) == pytest.approx(0.001)
|
|
assert L.estimate_cost_usd(L.UNKNOWN, 0) == 0.0
|
|
|
|
|
|
def test_explicit_cost_is_honored(monkeypatch, tmp_path):
|
|
_events_env(monkeypatch, tmp_path)
|
|
L.record_savings_event(tokens_before=100, tokens_after=10, model="x", client="c", cost_usd=1.25)
|
|
assert L.aggregate_savings().lifetime["cost_usd"] == pytest.approx(1.25)
|
|
|
|
|
|
def test_zero_or_negative_savings_not_recorded(monkeypatch, tmp_path):
|
|
path = _events_env(monkeypatch, tmp_path)
|
|
assert L.record_savings_event(tokens_before=100, tokens_after=100) is False
|
|
assert L.record_savings_event(tokens_before=50, tokens_after=80) is False
|
|
assert not path.exists() or path.read_text().strip() == ""
|
|
assert L.aggregate_savings().lifetime["calls"] == 0
|
|
|
|
|
|
def test_breakdowns_aggregate_by_dimension(monkeypatch, tmp_path):
|
|
_events_env(monkeypatch, tmp_path)
|
|
L.record_savings_event(tokens_before=1000, tokens_after=300, model=None, client="claude-code")
|
|
L.record_savings_event(tokens_before=500, tokens_after=200, model=None, client="claude-code")
|
|
L.record_savings_event(
|
|
tokens_before=2000, tokens_after=600, model="gpt", client="proxy", cost_usd=0.5
|
|
)
|
|
report = L.aggregate_savings()
|
|
|
|
clients = {row["client"]: row for row in report.by_client}
|
|
assert clients["claude-code"]["calls"] == 2
|
|
assert clients["proxy"]["tokens_saved"] == 1400
|
|
|
|
|
|
def test_windows_today_week_alltime(monkeypatch, tmp_path):
|
|
_events_env(monkeypatch, tmp_path)
|
|
now = datetime(2026, 6, 17, 12, 0, tzinfo=UTC)
|
|
L.record_savings_event(
|
|
tokens_before=1000, tokens_after=500, model=None, client="c", timestamp=now
|
|
)
|
|
L.record_savings_event(
|
|
tokens_before=1000,
|
|
tokens_after=600,
|
|
model=None,
|
|
client="c",
|
|
timestamp=now - timedelta(days=3),
|
|
)
|
|
L.record_savings_event(
|
|
tokens_before=1000,
|
|
tokens_after=700,
|
|
model=None,
|
|
client="c",
|
|
timestamp=now - timedelta(days=30),
|
|
)
|
|
report = L.aggregate_savings(now=now)
|
|
assert report.windows["today"]["tokens_saved"] == 500
|
|
assert report.windows["last_7_days"]["tokens_saved"] == 500 + 400
|
|
assert report.windows["all_time"]["tokens_saved"] == 500 + 400 + 300
|
|
assert report.windows["all_time"]["calls"] == 3
|
|
# 500 saved out of 1000 before today
|
|
assert report.windows["today"]["savings_percent"] == pytest.approx(50.0)
|
|
|
|
|
|
def test_retention_excludes_old_events(monkeypatch, tmp_path):
|
|
_events_env(monkeypatch, tmp_path)
|
|
now = datetime(2026, 6, 17, 12, 0, tzinfo=UTC)
|
|
L.record_savings_event(
|
|
tokens_before=1000, tokens_after=500, model=None, client="c", timestamp=now
|
|
)
|
|
L.record_savings_event(
|
|
tokens_before=1000,
|
|
tokens_after=500,
|
|
model=None,
|
|
client="c",
|
|
timestamp=now - timedelta(days=400),
|
|
)
|
|
report = L.aggregate_savings(now=now, retention_days=365)
|
|
assert report.lifetime["calls"] == 1
|
|
|
|
|
|
def test_appends_do_not_clobber_and_survive_restart(monkeypatch, tmp_path):
|
|
path = _events_env(monkeypatch, tmp_path)
|
|
for _ in range(5):
|
|
L.record_savings_event(tokens_before=100, tokens_after=10, model=None, client="c")
|
|
lines = [ln for ln in path.read_text().splitlines() if ln.strip()]
|
|
assert len(lines) == 5
|
|
# aggregate_savings holds no in-memory state — it reads purely from disk,
|
|
# so this also proves durability across a process restart.
|
|
assert L.aggregate_savings().lifetime["calls"] == 5
|
|
assert L.aggregate_savings().lifetime["tokens_saved"] == 5 * 90
|
|
|
|
|
|
def test_corrupt_lines_are_skipped(monkeypatch, tmp_path):
|
|
path = _events_env(monkeypatch, tmp_path)
|
|
L.record_savings_event(tokens_before=1000, tokens_after=400, model=None, client="c")
|
|
with open(path, "a", encoding="utf-8") as handle:
|
|
handle.write("not json\n\n")
|
|
assert L.aggregate_savings().lifetime["calls"] == 1
|
|
|
|
|
|
# --------------------------------------------------------------------------- #
|
|
# CLI
|
|
# --------------------------------------------------------------------------- #
|
|
|
|
|
|
def test_cli_reset_deletes_ledger(monkeypatch, tmp_path):
|
|
pytest.importorskip("click")
|
|
from click.testing import CliRunner
|
|
|
|
from headroom.cli.savings import savings
|
|
|
|
path = _events_env(monkeypatch, tmp_path)
|
|
L.record_savings_event(tokens_before=1000, tokens_after=300, model=None, client="claude-code")
|
|
assert path.exists()
|
|
|
|
result = CliRunner().invoke(savings, ["--reset"])
|
|
assert result.exit_code == 0
|
|
assert "reset" in result.output.lower()
|
|
assert not path.exists()
|
|
|
|
# second reset on missing file is a no-op
|
|
result2 = CliRunner().invoke(savings, ["--reset"])
|
|
assert result2.exit_code == 0
|
|
assert "Nothing to reset" in result2.output
|
|
|
|
|
|
def test_cli_empty_state(monkeypatch, tmp_path):
|
|
pytest.importorskip("click")
|
|
from click.testing import CliRunner
|
|
|
|
from headroom.cli.savings import savings
|
|
|
|
_events_env(monkeypatch, tmp_path)
|
|
result = CliRunner().invoke(savings, [])
|
|
assert result.exit_code == 0
|
|
assert "No savings recorded yet." in result.output
|
|
|
|
|
|
def test_cli_renders_sections_and_json(monkeypatch, tmp_path):
|
|
pytest.importorskip("click")
|
|
from click.testing import CliRunner
|
|
|
|
from headroom.cli.savings import savings
|
|
|
|
_events_env(monkeypatch, tmp_path)
|
|
L.record_savings_event(tokens_before=1000, tokens_after=300, model=None, client="claude-code")
|
|
runner = CliRunner()
|
|
|
|
result = runner.invoke(savings, [])
|
|
assert result.exit_code == 0
|
|
# No redundant top-line headline; the windows lead the output.
|
|
assert "cost avoided" not in result.output
|
|
assert "Today" in result.output and "All time" in result.output
|
|
assert "Savings by client" in result.output and "claude-code" in result.output
|
|
assert "Per-repo totals" not in result.output
|
|
|
|
result_json = runner.invoke(savings, ["--json"])
|
|
assert result_json.exit_code == 0
|
|
payload = json.loads(result_json.output)
|
|
assert payload["lifetime"]["tokens_saved"] == 700
|
|
assert payload["windows"]["all_time"]["calls"] == 1
|
|
assert "by_repo" not in payload
|
|
|
|
|
|
# --------------------------------------------------------------------------- #
|
|
# MCP tool path
|
|
# --------------------------------------------------------------------------- #
|
|
|
|
|
|
def test_mcp_compress_records_durable_event(monkeypatch, tmp_path):
|
|
pytest.importorskip("mcp", reason="MCP SDK required")
|
|
from headroom.ccr import mcp_server
|
|
|
|
_events_env(monkeypatch, tmp_path)
|
|
monkeypatch.setenv("HEADROOM_MCP_CLIENT", "claude-code")
|
|
|
|
server = mcp_server.HeadroomMCPServer(check_proxy=False)
|
|
server._record_savings({"original_tokens": 1000, "compressed_tokens": 250})
|
|
|
|
report = L.aggregate_savings()
|
|
assert report.lifetime["tokens_saved"] == 750
|
|
assert {row["client"] for row in report.by_client} == {"claude-code"}
|
|
|
|
|
|
def test_mcp_record_savings_ignores_noop(monkeypatch, tmp_path):
|
|
pytest.importorskip("mcp", reason="MCP SDK required")
|
|
from headroom.ccr import mcp_server
|
|
|
|
_events_env(monkeypatch, tmp_path)
|
|
server = mcp_server.HeadroomMCPServer(check_proxy=False)
|
|
server._record_savings({"original_tokens": 500, "compressed_tokens": 500})
|
|
assert L.aggregate_savings().lifetime["calls"] == 0
|
|
|
|
|
|
# --------------------------------------------------------------------------- #
|
|
# proxy path
|
|
# --------------------------------------------------------------------------- #
|
|
|
|
|
|
def test_proxy_record_request_appends_ledger_event(tmp_path, monkeypatch):
|
|
pytest.importorskip("fastapi")
|
|
import asyncio
|
|
|
|
from fastapi.testclient import TestClient
|
|
|
|
from headroom.proxy.server import ProxyConfig, create_app
|
|
|
|
monkeypatch.setenv("HEADROOM_SAVINGS_PATH", str(tmp_path / "proxy_savings.json"))
|
|
monkeypatch.setenv("HEADROOM_SAVINGS_EVENTS_PATH", str(tmp_path / "savings_events.jsonl"))
|
|
monkeypatch.setattr(
|
|
"headroom.proxy.server.CostTracker._get_cache_prices",
|
|
lambda self, model: (0.001, 0.0015, 0.002),
|
|
)
|
|
|
|
config = ProxyConfig(cache_enabled=False, rate_limit_enabled=False, log_requests=False)
|
|
with TestClient(create_app(config)) as client:
|
|
proxy = client.app.state.proxy
|
|
# identified harness -> recorded as that client
|
|
asyncio.run(
|
|
proxy.metrics.record_request(
|
|
provider="openai",
|
|
model="gpt-4o",
|
|
input_tokens=120,
|
|
output_tokens=24,
|
|
tokens_saved=40,
|
|
latency_ms=15.0,
|
|
client="claude-code",
|
|
)
|
|
)
|
|
# unidentified harness -> falls back to "proxy"
|
|
asyncio.run(
|
|
proxy.metrics.record_request(
|
|
provider="openai",
|
|
model="gpt-4o",
|
|
input_tokens=80,
|
|
output_tokens=10,
|
|
tokens_saved=20,
|
|
latency_ms=15.0,
|
|
)
|
|
)
|
|
|
|
report = L.aggregate_savings()
|
|
assert report.lifetime["tokens_saved"] == 60
|
|
clients = {row["client"] for row in report.by_client}
|
|
assert "claude-code" in clients
|
|
assert "proxy" in clients
|
|
assert any(row["model"] == "gpt-4o" for row in report.by_model)
|