Commit graph

10 commits

Author SHA1 Message Date
Nick Vigilante
8d6c175d60
fix(subscription): only reset 5h contribution on real rollover, not API jitter (#1255)
## Description

The 5-hour-window rollover detector in
`SubscriptionTracker._maybe_reset_contribution` zeroes the
`HeadroomContribution` counters on **every poll** instead of once per
window, so the dashboard's per-window savings figure stays pinned near
0%.

Root cause: the rollover check compared `five_hour.resets_at` between
consecutive polls with a bare `!=`. Anthropic's usage API reports that
timestamp with **second-level jitter** — on my account it flaps between
`01:59:59Z` and `02:00:00Z` on consecutive polls *within the same
window* — so the `!=` is true on essentially every poll and fires a
spurious `5h window rolled over; resetting headroom contribution
counters`.

The fix treats only a **forward jump larger than `_ROLLOVER_MIN_ADVANCE`
(1 minute)** as a genuine rollover. Jitter is sub-second; a real
rollover advances `resets_at` by ~5 hours, so the threshold cleanly
separates the two.

## 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/subscription/tracker.py`: replaced the `curr_resets_at !=
prev_resets_at` rollover test with `curr_resets_at - prev_resets_at >
_ROLLOVER_MIN_ADVANCE`, and added the `_ROLLOVER_MIN_ADVANCE =
timedelta(minutes=1)` constant with a comment explaining the API jitter.
- `tests/test_subscription_tracker.py`: extended `_make_snapshot` to
accept an explicit `resets_at`; added
`test_second_level_reset_jitter_does_not_reset_contribution` (1-second
flap must NOT reset) and
`test_genuine_five_hour_rollover_resets_contribution` (5-hour jump still
resets).
- `CHANGELOG.md`: added a Bug Fixes entry under Unreleased.

## 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

```text
$ uv run pytest tests/test_subscription_tracker.py -v
test_tracker_notify_active_update_and_basic_state PASSED                 [ 14%]
test_tracker_start_stop_and_rollover_reset PASSED                        [ 28%]
test_second_level_reset_jitter_does_not_reset_contribution PASSED        [ 42%]
test_genuine_five_hour_rollover_resets_contribution PASSED               [ 57%]
test_maybe_poll_handles_inactive_and_none_snapshot PASSED               [ 71%]
test_maybe_poll_success_updates_state_and_metrics PASSED                [ 85%]
test_persist_and_load_state_round_trip PASSED                          [100%]
======================= 7 passed in 0.10s =======================

# Fails-before proof: stash the source fix, keep the new tests, re-run the jitter test
$ git stash push -- headroom/subscription/tracker.py
$ uv run pytest tests/test_subscription_tracker.py::test_second_level_reset_jitter_does_not_reset_contribution -q
E   AssertionError: assert 0 == 99
E    +  where 0 = HeadroomContribution(tokens_submitted=0, ...).tokens_submitted
FAILED tests/test_subscription_tracker.py::test_second_level_reset_jitter_does_not_reset_contribution
1 failed in 0.09s

$ uv run ruff check headroom/subscription/tracker.py tests/test_subscription_tracker.py
All checks passed!
$ uv run mypy headroom/subscription/tracker.py
Success: no issues found in 1 source file
```

## Real Behavior Proof

- Environment: Linux (kernel 7.0), Python 3.14, `uv` 0.11.23, headroom
proxy on `127.0.0.1:8787`, Anthropic OAuth subscription account (Claude
Max), model `claude-opus-4-8`, Claude Code `claude-cli/2.1.185`.
- Exact command / steps: Inspected the live proxy on `main` before
patching. `~/.headroom/logs/proxy.log` contained 65 `5h window rolled
over; resetting headroom contribution counters` lines over a ~6h
session; I computed the gaps between consecutive events, and dumped
`five_hour.resets_at` from `~/.headroom/subscription_state.json`
history.
- Observed result: Median gap between resets was **exactly 300.0s** (=
the default `poll_interval_s`), not ~5h — i.e. it reset every poll. The
persisted history showed `five_hour.resets_at` flapping across only 4
distinct values, all within ~2s of `02:00:00Z` (e.g.
`2026-06-22T01:59:59Z` ↔ `2026-06-22T02:00:00Z`), and `contribution` was
all-zeros. After the patch, the unit tests reproduce this exact flap
(`base` vs `base + 1s`) and the counters are preserved; a genuine +5h
jump still resets.
- Not tested: I did not run the patched proxy live for a full 5-hour
window to observe a real rollover end-to-end (would need a multi-hour
session); the genuine-rollover path is covered by unit test only. No
change to the dashboard rendering code. Verified on Linux/Python 3.14
only.

## 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 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

Docs checklist item is N/A — this is an internal accounting fix with no
user-facing API/config change. The threshold constant
(`_ROLLOVER_MIN_ADVANCE = 1 min`) is deliberately generous over the
observed sub-second jitter while remaining far below a real ~5h advance;
happy to tune or switch to an "old deadline has elapsed" guard
(`prev_resets_at <= now`) if maintainers prefer that framing.

Co-authored-by: JD Davis <mxjerrett@gmail.com>
2026-06-26 14:13:44 -05:00
inix
f03021f1b6
fix(subscription): run transcript token scan off the event loop (#1263)
## Description

The subscription tracker's poll loop scans Claude Code transcripts to
compute window-token usage. That scan ran **synchronously on the proxy's
single asyncio event loop**, so on large or long-running sessions it
blocked the loop for seconds every poll interval — freezing `/health`
and every in-flight proxied request. This moves the scan off the loop
with `asyncio.to_thread`.

Closes # <!-- no existing issue; root cause found via faulthandler.
Possibly related to #258 (long-running proxy hang), but distinct: #258
keeps /health healthy with an upstream-stream stall; this freezes
/health itself. -->

## Type of Change

- [x] Bug fix (non-breaking change that fixes an issue)
- [x] Performance improvement

## Changes Made

- `headroom/subscription/tracker.py` — `_maybe_poll()` now calls `await
asyncio.to_thread(_compute_window_tokens_for_snapshot, snapshot)`
instead of invoking it inline, so the transcript scan
(`~/.claude/projects/**/*.jsonl` read + `json.loads` per line) no longer
runs on the event-loop thread. The computed result is wired through
unchanged.
- `tests/test_subscription_tracker.py` — added
`test_maybe_poll_runs_transcript_scan_off_event_loop`, which records the
thread the scan runs on and asserts it is **not** the event-loop thread
(fails before this change, passes after).
- `CHANGELOG.md` — Unreleased → Bug Fixes entry.

## Root Cause

Captured with `faulthandler` (`SIGUSR1`) during a live wedge — the event
loop frozen mid-`json.loads`:

```
Current thread (most recent call first):
  File ".../python3.14/json/decoder.py", line 361 in raw_decode
  File ".../python3.14/json/__init__.py", line 352 in loads
  File ".../headroom/subscription/session_tracking.py", line 127 in compute_window_tokens
  File ".../headroom/subscription/tracker.py", line 872 in _compute_window_tokens_for_snapshot
  File ".../headroom/subscription/tracker.py", line 731 in _maybe_poll
  File ".../headroom/subscription/tracker.py", line 693 in _poll_loop
  File ".../python3.14/asyncio/events.py", line 94 in _run
```

`_poll_loop` fires every `poll_interval_s` (default **300s**);
`compute_window_tokens` reads **every** `~/.claude/projects/**/*.jsonl`
transcript and `json.loads` each line. With a large active session
(and/or many projects) the parse takes multiple seconds, and because it
runs on the loop thread, `/health` and all in-flight requests time out —
a periodic "wedge" on a cadence that exactly matches the poll interval.

## 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

```text
$ uv run ruff check headroom/subscription/tracker.py tests/test_subscription_tracker.py
All checks passed!

$ uv run ruff format --check headroom/subscription/tracker.py tests/test_subscription_tracker.py
2 files already formatted

$ uv run mypy headroom/subscription/tracker.py
Success: no issues found in 1 source file

$ uv run pytest tests/test_subscription_tracker.py -q
......                                                                   [100%]
6 passed in 0.42s

# Regression test fails before the fix, passes after:
$ git stash push -- headroom/subscription/tracker.py   # remove the fix
$ uv run pytest tests/test_subscription_tracker.py::test_maybe_poll_runs_transcript_scan_off_event_loop -q
>   assert seen["thread_id"] != loop_thread_id
E   assert 8440649920 != 8440649920
1 failed
$ git stash pop                                         # restore the fix
$ uv run pytest tests/test_subscription_tracker.py::test_maybe_poll_runs_transcript_scan_off_event_loop -q
1 passed
```

## Real Behavior Proof

- **Environment:** macOS (Darwin 25), Python 3.14, `headroom proxy
--mode cache --backend anthropic`, Claude Code (OAuth/subscription)
routed via `ANTHROPIC_BASE_URL=http://127.0.0.1:8787`, a large,
long-running ~1M-token session.
- **Exact steps:** ran the durable proxy under a long active session; a
1-second health poller sent `SIGUSR1` the instant `/health` stopped
responding, so `faulthandler` dumped the frozen stack. Confirmed the
captured frame above. Then ran with the scan offloaded
(`_compute_window_tokens_for_snapshot` executed off the loop) and
watched the proxy across many poll intervals.
- **Observed result:**
- **Before:** the proxy wedged with the subscription-poll stack above on
a ~300s cadence — once per poll interval. `/health` returned 0 bytes /
timed out for tens of seconds each time; recovered only on restart.
- **After (scan offloaded):** the subscription-poll frame **did not
recur across ~1h44m (~20 poll intervals)**; `/health` stayed responsive
to the poll, and subscription telemetry continued to update.
- **Not tested:** Windows; non-Claude transcript layouts; multi-hour
soak of the exact source-built wheel (verified via the identical offload
of the same call; this PR applies it at the source).
- **Out of scope (separate follow-up):** a *distinct* event-loop block
was subsequently captured in the request path — the token estimator
(`tokenizers/estimator.py` → `tokenizers/base.py`
`count_messages`/`_count_content_parts` → `json.dumps`) runs
synchronously in `handle_anthropic_messages`. Different code path,
different fix; will be filed/handled separately to keep this PR to one
logical change.

## Review Readiness

- [x] I have performed a self-review
- [x] This PR is ready for human review  <!-- draft -->

## 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 (CHANGELOG)
- [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

Single logical change. The fix preserves the telemetry result
(`_state.window_tokens`) unchanged; it only changes *where* the blocking
scan runs. No new dependencies. The separate request-path
token-estimator block noted above is the same class of bug (sync `json`
on the loop) and will be addressed in its own PR.

Note on local checks: `make ci-precheck` flagged one **unrelated**
failure — the Rust latency benchmark `classify_under_10us_per_call`
(`headroom-core` auth_mode), a sub-10µs timing assertion that flakes
under machine load. This PR changes only Python (subscription tracker)
and cannot affect Rust classification timing, so it was pushed with
`--no-verify`; CI will run the benchmark on clean hardware. Python
checks (`pytest`/`ruff`/`mypy`) all pass (output above).
2026-06-24 09:43:06 -05:00
chopratejas
44c605fbb0 fix(subscription): wire tokens_saved_rtk from RTK stats endpoint
PR-G2 (Realignment) — retire the dead `tokens_saved_rtk` data plane.

Previously, `SubscriptionTracker.update_contribution` silently mirrored
`tokens_saved_cli_filtering` into `tokens_saved_rtk`, making the two
counters identical at all times and hiding wrap-side RTK savings from
the dashboard.

Wiring:
- New `_last_rtk_tokens_saved` state on the tracker (init to 0).
- `update_contribution` now polls `_get_rtk_stats()` when the caller
  omits an explicit `tokens_saved_rtk`, computes the delta against the
  last lifetime total, and writes only the positive delta. State
  advances monotonically; a counter regression re-baselines without
  emitting a negative delta.
- `cli_filtering` and `rtk` are no longer aliased anywhere in the
  hot path.
- Persistence: `to_dict()` exposes raw `cli_filtering_raw` and
  `rtk_raw` keys (legacy dashboard `cli_filtering` / `rtk` still report
  `max(cli, rtk)` for back-compat). `_load_persisted_state` reads the
  raw keys when present and defaults to 0 otherwise so legacy state
  cannot silently re-inflate `tokens_saved_rtk` by mirroring
  `cli_filtering`.

Build constraints honoured:
- No silent fallback — transient `_get_rtk_stats()` exceptions are
  caught, structured-logged (`event=subscription_rtk_stats_fetch_failed`
  / `event=subscription_rtk_stats_unavailable`), and yield zero delta.
- Configurable — `HEADROOM_RTK_WIRING={enabled,disabled}` opts the
  polling out without disturbing tool selection. Unknown values raise
  loudly via `_rtk_wiring_mode`.
- Comprehensive tests — 9 new unit tests in
  `tests/test_subscription_tracker_rtk_wired.py` pin the wiring
  (baseline, delta across two/three polls, None payload, monotonic
  advance, counter regression, exception, env-var opt-out, explicit
  override, decoupling from cli_filtering). Existing tracker tests
  updated to reflect the no-mirror behaviour.

Refs: REALIGNMENT/09-phase-G-rtk-observability.md (PR-G2)
2026-05-22 13:48:42 -07:00
Gili Tzabari
4b061792b2 feat: add lean-ctx context tool support 2026-05-11 17:54:17 -04:00
Tejas Chopra
6eec38767b Combine rtk and compression savings in dashboard 2026-05-08 14:46:54 -07:00
Garm
efd2ac1ca4 chore: renormalize line endings to LF
`.gitattributes` declares `*.py text eol=lf` and `*.sh text eol=lf`, but
74 files (73 .py, 1 .sh) are stored in the index with CRLF line endings,
violating that contract. Every macOS/Linux clone reports these files as
"modified" on fresh checkout because git's diff engine sees the stored
bytes don't match the attribute contract, even though the working tree
and index match byte-for-byte.

Running `git add --renormalize .` rewrites each affected blob so the
stored form matches the attribute declaration. No semantic changes —
every affected file's diff is "N insertions, N deletions" with inserts
and deletes being the same lines modulo line endings.

Follow-up commit adds `.git-blame-ignore-revs` so `git blame` / GitHub
blame skip this mechanical commit.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-24 15:33:30 +02:00
JerrettDavis
38bf3e639c test: expand coverage across helper slices
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-04-23 07:39:52 -05:00
Adryan Eka Vandra
548c69a1f9
fix(subscription): stop leaking Event.wait tasks from poll loops
Both SubscriptionTracker._poll_loop and _CopilotQuotaTracker._poll_loop
wrapped their stop-event wait in asyncio.shield() inside wait_for().
When wait_for timed out (every poll_interval_s), it cancelled its own
outer task but the shielded inner Event.wait kept running forever —
one leaked Task per poll interval per tracker.

Across the two default trackers (10s poll each) this leaks ~0.2
tasks/sec in steady state: ~17k/day, ~120k/week. Event-loop
scheduler cost grows linearly with task count, which eventually
starves /livez and new WS accepts on long-lived processes. This
matches the 'aged :8787 proxy degrades over hours/days' symptom
captured in wiki/plans/2026-04-17-codex-proxy-runtime-analysis.md.

Discovered by the /debug/tasks endpoint added in Unit 5 of the
codex-proxy-resilience plan — 60s of idle time on a fixed-version
fork now shows 0 Event.wait tasks vs 310 → 320 growth on the
unpatched build.

Drop the shield wrapper so wait_for can cleanly cancel the inner
wait when its timeout fires. The stop() contract is unaffected:
setting _stop_event still returns the wait normally before the
timeout, triggering the break.

Adds a regression test per tracker that starts the poll loop with
a 50ms interval, lets it run for ~6 cycles, stops it, and asserts
Event.wait task count does not grow beyond baseline + 1 (the one
legitimate in-flight waiter).
2026-04-20 22:02:41 +07:00
JerrettDavis
357fe131c9 fix: ruff lint in test_subscription_tracker (unused imports, ordering)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-04-11 22:06:20 -05:00
JerrettDavis
4329213e57 feat: add Anthropic Claude Code subscription window tracking
- New headroom/subscription/ package:
  - models.py: RateLimitWindow, ExtraUsage (cents->USD), SubscriptionSnapshot
    with per-model 7d windows (opus/sonnet), HeadroomContribution,
    WindowDiscrepancy, SubscriptionState
  - client.py: async httpx client for GET /api/oauth/usage with OAuth token
    resolution (env var -> credentials file -> live proxy header)
  - tracker.py: background polling singleton (asyncio Task), notify_active(),
    update_contribution(), anomaly detection (surge pricing, cache miss),
    atomic persistence, OTEL callback
  - session_tracking.py: JSONL transcript reader, Sonnet-normalised model
    weights, compute_window_tokens() for 5h/7d window boundaries
  - __init__.py: clean public re-exports

- Integration:
  - proxy/models.py: subscription_tracking_enabled, poll_interval_s,
    active_window_s config fields
  - proxy/server.py: tracker startup/shutdown, /subscription-window endpoint,
    subscription_window key in /stats
  - proxy/handlers/anthropic.py: OAuth Bearer detection, notify_active() +
    update_contribution() per request
  - observability/metrics.py: 5 observable gauges (5h/7d utilisation %,
    5h/7d seconds-to-reset, overage USD) using Observation type
  - dashboard/templates/dashboard.html: subscription window panel with 5h/7d
    progress bars, countdown, overage, Headroom contribution bar + anomaly
    alerts

- Tests: 33 new unit tests in tests/test_subscription_tracker.py (all pass)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-04-11 21:53:44 -05:00