akadmin/headroom
1
0
Fork 0
mirror of https://github.com/headroomlabs-ai/headroom.git synced 2026-08-27 14:17:10 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
headroom/tests/test_dashboard_cache_ttl_playwright.py
Rod Boev 78591545ce
fix: publish headroom-opencode in release workflow (#2372) 
## Description

`headroom-opencode` is documented as an npm package, but the release
workflow never published it, so installs failed with a registry 404 even
though the plugin source already lived under `plugins/opencode`. This
wires the existing package into the npm release path, keeps its version
synced with root releases, and adds release guards for the new package.
Closes #76.

## 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)
- [x] Documentation update
- [ ] Performance improvement
- [ ] Code refactoring (no functional changes)

## Changes Made

- added `headroom-opencode` to the npm release workflow, including
release-version stamping and `headroom-ai` dependency rewrite before
publish
- added `plugins/opencode/package.json` to release-please and local
version-sync guards
- synced the source opencode package version to the current release line
and documented the new npm package in the release docs
- added focused release workflow and version-sync tests for the opencode
package
- aligned the two failing dashboard Playwright tests with the current
Session/Lifetime split and `/stats-lifetime` fixture contract

## Testing

- [x] Unit tests pass (`uv run pytest scripts/tests/test_version_sync.py
-q`, `uv run pytest tests/test_release_workflows.py -q -k
'publish_npm_rewrites_opencode_dependency_after_version_and_before_publish
or opencode_source_dependency_matches_lockfile_registry_range or
release_please_manifest_config_consistency'`)
- [x] Unit tests pass (`uv run pytest
tests/test_dashboard_cache_lifetime_playwright.py
tests/test_dashboard_cache_ttl_playwright.py -q`)
- [x] Linting passes (`uv run ruff check scripts/verify-versions.py
scripts/version-sync.py scripts/tests/test_version_sync.py
tests/test_release_workflows.py`)
- [ ] Type checking passes (`uv run mypy headroom`)
- [x] New tests added for new functionality when applicable
- [x] Manual testing performed

### Test Output

```text
$ uv run pytest scripts/tests/test_version_sync.py -q
8 passed, 1 warning in 0.51s

$ uv run pytest tests/test_release_workflows.py -q -k 'publish_npm_rewrites_opencode_dependency_after_version_and_before_publish or opencode_source_dependency_matches_lockfile_registry_range or release_please_manifest_config_consistency'
2 passed, 38 deselected, 1 warning in 0.07s

$ uv run pytest tests/test_dashboard_cache_lifetime_playwright.py tests/test_dashboard_cache_ttl_playwright.py -q
4 passed, 1 warning in 4.04s

$ uv run ruff check scripts/verify-versions.py scripts/version-sync.py scripts/tests/test_version_sync.py tests/test_release_workflows.py
All checks passed!

$ npm ci && npm run build  (plugins/opencode)
Build success; dist/index.js, dist/entry.opencode.js, and DTS outputs emitted
```

## Real Behavior Proof

- Environment: Windows, Python 3.11.15, Node v24.15.0, npm 11.16.0
- Exact command / steps: inspected `.github/workflows/release.yml`,
updated the npm publish path for `plugins/opencode`, aligned the two
failing dashboard Playwright tests with the current Session/Lifetime
split, then ran the focused pytest commands above plus `npm ci && npm
run build` in `plugins/opencode`
- Observed result: the release workflow now versions and publishes
`headroom-opencode`, release-please and version-sync track
`plugins/opencode/package.json`, the dashboard tests now fetch durable
cache and setup-url data from the Lifetime view, and the opencode
package still builds locally from source
- Not tested: GitHub Package Registry publish

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

`CHANGELOG.md` is unchanged because release-please owns changelog
generation here.

---------

Co-authored-by: JD Davis <mxjerrett@gmail.com>
2026-08-11 23:56:40 -05:00

273 lines
10 KiB
Python
Raw Permalink Blame History

"""Behavior-driven Playwright validation for dashboard TTL cache metrics."""
from __future__ import annotations
import json
import os
from pathlib import Path
from urllib.parse import urlsplit
import pytest
from headroom.dashboard import STATIC_DIR, get_dashboard_html
playwright = pytest.importorskip("playwright.sync_api")
Page = playwright.Page
expect = playwright.expect
sync_playwright = playwright.sync_playwright
def _sample_stats() -> dict:
return {
"cost": {
"savings_usd": 12.34,
"compression_savings_usd": 12.34,
"cache_savings_usd": 5.25,
},
"requests": {
"total": 128,
"cached": 96,
"rate_limited": 0,
"failed": 0,
"by_provider": {"anthropic": 128},
"by_model": {"claude-opus-4-6": 128},
},
"tokens": {
"input": 245_000,
"output": 88_000,
"saved": 143_000,
"total_before_compression": 388_000,
"savings_percent": 36.86,
},
"overhead": {"average_ms": 14.2, "min_ms": 4.5, "max_ms": 42.7},
"ttfb": {"average_ms": 1320.0, "min_ms": 420.0, "max_ms": 2900.0},
"latency": {"average_ms": 1510.0, "min_ms": 520.0, "max_ms": 3300.0},
"waste_signals": {"json_bloat": 95_000, "repetition": 48_000},
"savings_history": [
["2026-04-01T00:00:00Z", 12_000],
["2026-04-02T00:00:00Z", 38_000],
["2026-04-03T00:00:00Z", 57_000],
["2026-04-04T00:00:00Z", 102_000],
["2026-04-05T00:00:00Z", 143_000],
],
"persistent_savings": {
"display_session": {},
"lifetime": {"tokens_saved": 143_000, "compression_savings_usd": 12.34},
},
"pipeline_timing": {},
"compression_cache": {"mode": "cache"},
"prefix_cache": {
"by_provider": {
"anthropic": {
"cache_read_tokens": 9_800_000,
"cache_write_tokens": 420_000,
"cache_write_5m_tokens": 185_000,
"cache_write_1h_tokens": 235_000,
"cache_write_5m_requests": 18,
"cache_write_1h_requests": 24,
"requests": 128,
"hit_requests": 96,
"hit_rate": 75.0,
"bust_count": 0,
"bust_write_tokens": 0,
"read_discount": "90%",
"write_premium": "25%",
"savings_usd": 5.67,
"write_premium_usd": 0.42,
"net_savings_usd": 5.25,
"label": "Explicit breakpoints, 5-min TTL",
"observed_ttl_buckets": {
"5m": {"tokens": 185_000, "requests": 18},
"1h": {"tokens": 235_000, "requests": 24},
},
"observed_ttl_mix": {
"5m_pct": 44.0,
"1h_pct": 56.0,
"active_buckets": ["5m", "1h"],
},
}
},
"totals": {
"cache_read_tokens": 9_800_000,
"cache_write_tokens": 420_000,
"cache_write_5m_tokens": 185_000,
"cache_write_1h_tokens": 235_000,
"cache_write_5m_requests": 18,
"cache_write_1h_requests": 24,
"requests": 128,
"hit_requests": 96,
"bust_count": 0,
"bust_write_tokens": 0,
"savings_usd": 5.67,
"write_premium_usd": 0.42,
"net_savings_usd": 5.25,
"hit_rate": 75.0,
"observed_ttl_buckets": {
"5m": {"tokens": 185_000, "requests": 18},
"1h": {"tokens": 235_000, "requests": 24},
},
"observed_ttl_mix": {
"5m_pct": 44.0,
"1h_pct": 56.0,
"active_buckets": ["5m", "1h"],
},
},
"prefix_freeze": {
"busts_avoided": 0,
"tokens_preserved": 0,
"compression_foregone_tokens": 0,
"net_benefit_tokens": 0,
},
"attribution": "Observed provider TTL buckets.",
},
}
def _sample_history() -> dict:
return {
"history": [
{
"timestamp": "2026-04-01T00:00:00Z",
"total_tokens_saved": 12_000,
"compression_savings_usd": 0.6,
},
{
"timestamp": "2026-04-05T00:00:00Z",
"total_tokens_saved": 143_000,
"compression_savings_usd": 12.34,
},
],
"series": {
"daily": [
{
"timestamp": "2026-04-05T00:00:00Z",
"tokens_saved": 20_000,
"total_tokens_saved": 143_000,
"compression_savings_usd_delta": 1.7,
}
],
"weekly": [],
"monthly": [],
},
"lifetime": {"tokens_saved": 143_000, "compression_savings_usd": 12.34},
}
def _fulfill_static_asset(route, path: str) -> bool: # type: ignore[no-untyped-def]
"""Serve the vendored dashboard JS from disk; True when it handled the route.
The harnesses in this file and its siblings intercept every request, so the
dashboard's relative asset URLs would otherwise fall through to a real fetch
against a fake origin with nothing listening. Alpine has to load: every
section of <main> lives inside a `<template x-if>`, which renders nothing at
all without it, so an empty <main> is the symptom to look for here.
"""
if not path.startswith("/dashboard/static/"):
return False
route.fulfill(
status=200,
content_type="text/javascript",
body=(STATIC_DIR / Path(path).name).read_bytes(),
)
return True
def _install_dashboard_routes(page: Page) -> None:
stats = _sample_stats()
history = _sample_history()
lifetime = {"projects": {}}
health = {"status": "healthy", "version": "0.3.0"}
dashboard_html = get_dashboard_html()
def handler(route) -> None: # type: ignore[no-untyped-def]
# Match on the URL path only: the dashboard fetches /stats?cached=1,
# so suffix checks against the full URL miss it and the request
# escapes the harness to the real network.
path = urlsplit(route.request.url).path
if path in ("/dashboard", "/"):
route.fulfill(status=200, content_type="text/html", body=dashboard_html)
return
if _fulfill_static_asset(route, path):
return
if "/stats-history" in path:
route.fulfill(
status=200,
content_type="application/json",
body=json.dumps(history),
)
return
if path.endswith("/stats-lifetime"):
route.fulfill(status=200, content_type="application/json", body=json.dumps(lifetime))
return
if path.endswith("/stats"):
route.fulfill(status=200, content_type="application/json", body=json.dumps(stats))
return
if path.endswith("/health"):
route.fulfill(status=200, content_type="application/json", body=json.dumps(health))
return
route.continue_()
page.route("**/*", handler)
def test_dashboard_per_project_setup_url_uses_current_origin() -> None:
with sync_playwright() as pw:
browser = pw.chromium.launch()
page = browser.new_page(viewport={"width": 1720, "height": 1400}, color_scheme="dark")
_install_dashboard_routes(page)
page.goto("http://127.0.0.1:8788/dashboard", wait_until="load")
page.get_by_role("button", name="Lifetime", exact=True).click()
expect(
page.get_by_text(
"ANTHROPIC_BASE_URL: http://127.0.0.1:8788/p/<project-name>", exact=True
)
).to_be_visible()
expect(
page.get_by_text(
"ANTHROPIC_BASE_URL: http://127.0.0.1:8787/p/<project-name>", exact=True
)
).to_have_count(0)
page.goto("http://headroom.local:9393/dashboard", wait_until="load")
page.get_by_role("button", name="Lifetime", exact=True).click()
expect(
page.get_by_text(
"ANTHROPIC_BASE_URL: http://headroom.local:9393/p/<project-name>", exact=True
)
).to_be_visible()
expect(
page.get_by_text(
"ANTHROPIC_BASE_URL: http://127.0.0.1:8787/p/<project-name>", exact=True
)
).to_have_count(0)
browser.close()
def test_dashboard_renders_observed_ttl_metrics_and_can_capture_screenshot() -> None:
artifact_dir = os.environ.get("HEADROOM_PLAYWRIGHT_ARTIFACT_DIR")
with sync_playwright() as pw:
browser = pw.chromium.launch()
page = browser.new_page(viewport={"width": 1720, "height": 1400}, color_scheme="dark")
_install_dashboard_routes(page)
page.goto("http://headroom.local/dashboard", wait_until="load")
expect(page.get_by_text("Observed TTL Buckets")).to_be_visible()
expect(page.get_by_text("Provider-reported cache write mix")).to_be_visible()
expect(page.get_by_test_id("ttl-bucket-headline")).to_have_text("1h leaning")
expect(page.get_by_test_id("ttl-bucket-mix-1h-pct")).to_have_text("1h 56.0%")
expect(page.get_by_test_id("ttl-bucket-mix-5m-pct")).to_have_text("5m 44.0%")
expect(page.get_by_test_id("ttl-bucket-1h-value")).to_have_text("235.0k")
expect(page.get_by_test_id("ttl-bucket-5m-value")).to_have_text("185.0k")
expect(page.get_by_text("TTL 1h 56.0% / 5m 44.0%")).to_be_visible()
screenshot_path = (
Path(artifact_dir) / "dashboard-cache-ttl-main.png"
if artifact_dir
else Path.cwd() / "dashboard-cache-ttl-main.png"
)
screenshot_path.parent.mkdir(parents=True, exist_ok=True)
page.screenshot(path=str(screenshot_path), full_page=True)
browser.close()
Reference in a new issue View git blame Copy permalink