headroom/tests/test_auth_mode.py
Michael Sam 6d3f39f213
feat: add dashboard agent usage stats (#814)
## Description

Add a clear dashboard view for per-agent token usage so end users can
see Cursor, Claude, Codex, and other detected clients with before/after
token counts, tokens saved, and savings percentages. The stats API now
exposes a stable `agent_usage` object that the dashboard renders near
the top of the session view.

Fixes #

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

### New Files

**Tests:**
- `tests/test_dashboard_agent_usage.py` — Covers agent classification,
exact per-request aggregation, and aggregate fallback behavior.

### Modified Files

- `headroom/proxy/server.py` — Adds per-agent usage aggregation to
`/stats` with before tokens, after tokens, output tokens, saved tokens,
savings percentage, source, providers, and models.
- `headroom/dashboard/templates/dashboard.html` — Adds a prominent Agent
Usage panel with totals, coverage status, per-agent token-flow bars,
request counts, before/after tokens, saved tokens, and share of savings.

## Testing

- [x] Unit tests pass: `.venv312/bin/pytest
tests/test_dashboard_agent_usage.py`
- [x] Linting passes: `.venv312/bin/ruff check headroom/proxy/server.py
tests/test_dashboard_agent_usage.py`
- [x] Diff whitespace check passes: `git diff --check
origin/main...HEAD`
- [x] Dashboard smoke render: local proxy on `127.0.0.1:8790`, captured
Chrome headless screenshot of `/dashboard`
- [x] New tests added for new functionality

## 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 or that my
feature works
- [x] New and existing relevant unit tests pass locally with my changes
- [ ] I have made corresponding changes to the documentation
- [ ] I have updated the CHANGELOG.md if applicable

## Additional Notes

The agent usage panel uses exact request-log data when available. If
detailed request logs are empty, it falls back to aggregate
provider/model request counts and labels the coverage as aggregate
fallback so users are not misled.
2026-06-12 14:12:22 -05:00

195 lines
7 KiB
Python

"""Python parity tests for ``headroom.proxy.auth_mode.classify_auth_mode``.
Mirrors the Rust matrix in ``crates/headroom-core/tests/auth_mode.rs``
byte-for-byte. The two implementations MUST agree on every header set
covered here. Any divergence is a bug — we catch it at PR review by
running both suites side by side.
"""
from __future__ import annotations
import time
import pytest
from headroom.proxy.auth_mode import (
SUBSCRIPTION_UA_PREFIXES,
AuthMode,
classify_auth_mode,
classify_client,
)
def _h(**pairs: str) -> dict[str, str]:
"""Build a plain-dict header set in one expression."""
return dict(pairs)
# ── Required matrix ──────────────────────────────────────────────
def test_api_key_classified_payg() -> None:
"""Anthropic PAYG: ``Authorization: Bearer sk-ant-api03-...``."""
headers = {"authorization": "Bearer sk-ant-api03-abc123def456"}
assert classify_auth_mode(headers) is AuthMode.PAYG
def test_oauth_jwt_classified_oauth() -> None:
"""Codex / Cursor OAuth bearer: classic 3-segment JWT."""
jwt = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0In0.signaturepart"
headers = {"authorization": f"Bearer {jwt}"}
assert classify_auth_mode(headers) is AuthMode.OAUTH
def test_oauth_sk_ant_oat_classified_oauth() -> None:
"""Claude Pro / Max OAuth: ``Bearer sk-ant-oat-...``."""
headers = {"authorization": "Bearer sk-ant-oat-01-abc123def456"}
assert classify_auth_mode(headers) is AuthMode.OAUTH
def test_claude_code_ua_classified_subscription() -> None:
"""Claude Code CLI: ``User-Agent: claude-code/1.2.3 ...``."""
headers = {"user-agent": "claude-code/1.2.3 (darwin; arm64)"}
assert classify_auth_mode(headers) is AuthMode.SUBSCRIPTION
def test_cursor_ua_classified_subscription() -> None:
"""Cursor CLI: ``User-Agent: cursor/1.0``."""
headers = {"user-agent": "cursor/1.0"}
assert classify_auth_mode(headers) is AuthMode.SUBSCRIPTION
def test_no_auth_no_user_agent_default_payg() -> None:
"""Empty headers → safest default is PAYG.
The OAuth/bedrock branch fires only when there's a positive
non-Bearer auth signal. Choosing PAYG by default favors the
OSS-default workload (per-token cost saving).
"""
assert classify_auth_mode({}) is AuthMode.PAYG
def test_bedrock_no_auth_classified_oauth() -> None:
"""Bedrock SigV4: ``Authorization: AWS4-HMAC-SHA256 Credential=...``.
Not a Bearer scheme; we treat all non-Bearer Authorization as
OAuth (passthrough-prefer).
"""
headers = {
"authorization": (
"AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20260501/"
"us-east-1/bedrock/aws4_request, SignedHeaders=host;x-amz-date, "
"Signature=fe5f80f77d5fa3beca038a248ff027"
),
}
assert classify_auth_mode(headers) is AuthMode.OAUTH
# ── Bonus matrix ──────────────────────────────────────────────────
def test_openai_payg_sk_classified_payg() -> None:
"""OpenAI PAYG: ``Authorization: Bearer sk-proj-...``."""
headers = {"authorization": "Bearer sk-proj-abcdef0123456789"}
assert classify_auth_mode(headers) is AuthMode.PAYG
def test_gemini_x_goog_api_key_classified_payg() -> None:
"""Google Gemini API key as ``x-goog-api-key``."""
headers = {"x-goog-api-key": "AIzaSyDUMMYKEY1234567890"}
assert classify_auth_mode(headers) is AuthMode.PAYG
def test_subscription_takes_precedence_over_oauth_token() -> None:
"""Claude Code CLI sends ``Bearer sk-ant-oat-...`` but is subscription.
UA wins because the rate-limit / fingerprint policy is bound to
the CLI, not the token shape. The same token via a non-CLI UA
would be OAuth.
"""
headers = {
"user-agent": "claude-code/1.5.0 (linux; x86_64)",
"authorization": "Bearer sk-ant-oat-01-abc123",
}
assert classify_auth_mode(headers) is AuthMode.SUBSCRIPTION
# ── Edge cases (defensive coverage) ──────────────────────────────
def test_anthropic_x_api_key_classified_payg() -> None:
"""Anthropic API key style: ``x-api-key: sk-ant-...``."""
headers = {"x-api-key": "sk-ant-api03-abcdef"}
assert classify_auth_mode(headers) is AuthMode.PAYG
@pytest.mark.parametrize("prefix", SUBSCRIPTION_UA_PREFIXES)
def test_every_subscription_prefix_classified_subscription(prefix: str) -> None:
"""Each entry in the prefix list classifies as Subscription on its own."""
headers = {"user-agent": f"{prefix}1.0 (test)"}
assert classify_auth_mode(headers) is AuthMode.SUBSCRIPTION
def test_unparseable_authorization_does_not_raise() -> None:
"""Bytes-valued non-UTF-8 authorization warns and falls through.
Mirrors the Rust ``classify`` behaviour: never panic, always
return a valid ``AuthMode``. With nothing else to disambiguate,
we land on PAYG (the safe default).
"""
headers = {"authorization": b"\xffnope"}
# Should not raise.
result = classify_auth_mode(headers)
assert result is AuthMode.PAYG
def test_case_insensitive_header_lookup() -> None:
"""Header names are matched case-insensitively (Starlette parity)."""
headers = {"Authorization": "Bearer sk-ant-api03-test"}
assert classify_auth_mode(headers) is AuthMode.PAYG
def test_enum_values_match_rust_as_str() -> None:
"""The string form of each enum member matches the Rust ``as_str()``."""
assert AuthMode.PAYG.value == "payg"
assert AuthMode.OAUTH.value == "oauth"
assert AuthMode.SUBSCRIPTION.value == "subscription"
# ── Performance ──────────────────────────────────────────────────
def test_classify_under_100us_per_call() -> None:
"""Smoke perf check.
Python is slower than Rust by an order of magnitude on string
work, so the budget here is 100us (vs 10us in Rust). The proxy
only calls this once per request, and the absolute ceiling is
well under 1ms; this guards against pathological regressions.
"""
headers = {
"user-agent": "claude-code/1.5.0 (linux; x86_64) anthropic/0.42.0",
"authorization": "Bearer sk-ant-oat-01-abcdefghijklmnopqrstuv",
"content-type": "application/json",
"accept": "application/json",
"host": "api.anthropic.com",
}
# Warmup
for _ in range(1000):
classify_auth_mode(headers)
iters = 10_000
start = time.perf_counter()
for _ in range(iters):
classify_auth_mode(headers)
elapsed = time.perf_counter() - start
per_call_us = (elapsed / iters) * 1_000_000
assert per_call_us < 100, f"classify_auth_mode took {per_call_us:.2f} us/call (limit: 100 us)"
def test_classify_client_uses_default_when_no_client_signal():
headers = {"user-agent": "anthropic/0.42.0"}
assert classify_client(headers, default="claude") == "claude"