mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
## 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>
127 lines
4.4 KiB
Python
127 lines
4.4 KiB
Python
"""Playwright validation for persisted lifetime Prefix Cache metrics.
|
|
|
|
The Session dashboard now reports only current-process cache activity,
|
|
while durable cache totals live behind the Lifetime view. These tests pin
|
|
that split after a restart with zero session traffic.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import copy
|
|
import json
|
|
from urllib.parse import urlsplit
|
|
|
|
import pytest
|
|
|
|
from headroom.dashboard import get_dashboard_html
|
|
from tests.test_dashboard_cache_ttl_playwright import (
|
|
_fulfill_static_asset,
|
|
_sample_history,
|
|
_sample_stats,
|
|
)
|
|
|
|
playwright = pytest.importorskip("playwright.sync_api")
|
|
Page = playwright.Page
|
|
expect = playwright.expect
|
|
sync_playwright = playwright.sync_playwright
|
|
|
|
|
|
def _session_stats_no_cache() -> dict:
|
|
"""Post-restart session payload: zero current-process cache traffic."""
|
|
stats = copy.deepcopy(_sample_stats())
|
|
totals = stats.setdefault("prefix_cache", {}).setdefault("totals", {})
|
|
totals.update({"requests": 0, "cache_read_tokens": 0, "cache_write_tokens": 0})
|
|
return stats
|
|
|
|
|
|
def _lifetime_cache_payload(
|
|
*,
|
|
cache_read_tokens: int = 629_537_547,
|
|
cache_savings_usd: float = 7.2,
|
|
) -> dict:
|
|
return {
|
|
"requests": {"total": 6088, "failed": 0, "rate_limited": 0, "cached": 0},
|
|
"tokens": {"saved": 42_181},
|
|
"cost": {
|
|
"input_usd": 12.5,
|
|
"compression_savings_usd": 0.5,
|
|
"cache_savings_usd": cache_savings_usd,
|
|
},
|
|
"prefix_cache": {
|
|
"cache_read_tokens": cache_read_tokens,
|
|
"cache_write_tokens": 0,
|
|
"hit_requests": 0,
|
|
"requests": 0,
|
|
"bust_count": 0,
|
|
"bust_tokens": 0,
|
|
},
|
|
"projects": {},
|
|
"by_model": {},
|
|
"by_stack": {},
|
|
"waste_signals": {},
|
|
"persistence": {"healthy": True, "enabled": True, "pending_records": 0},
|
|
}
|
|
|
|
|
|
def _install_dashboard_routes(page: Page, stats: dict, lifetime: dict) -> None:
|
|
history = _sample_history()
|
|
health = {"status": "healthy", "version": "0.3.0"}
|
|
dashboard_html = get_dashboard_html()
|
|
|
|
def handler(route) -> None: # type: ignore[no-untyped-def]
|
|
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 _open_dashboard(page: Page, stats: dict, lifetime: dict) -> None:
|
|
_install_dashboard_routes(page, stats, lifetime)
|
|
page.goto("http://headroom.local/dashboard")
|
|
page.wait_for_load_state("networkidle")
|
|
|
|
|
|
def test_card_renders_lifetime_cache_reads_after_zero_traffic_restart() -> None:
|
|
with sync_playwright() as p:
|
|
browser = p.chromium.launch()
|
|
page = browser.new_page(viewport={"width": 1440, "height": 1600})
|
|
_open_dashboard(page, _session_stats_no_cache(), _lifetime_cache_payload())
|
|
|
|
expect(page.get_by_text("Prefix Cache Impact", exact=True)).to_have_count(0)
|
|
page.get_by_role("button", name="Lifetime", exact=True).click()
|
|
expect(page.get_by_role("heading", name="Prefix Cache", exact=True)).to_be_visible()
|
|
expect(page.get_by_text("629.5M / 0", exact=True)).to_be_visible()
|
|
expect(page.get_by_text("$7.20", exact=True)).to_be_visible()
|
|
|
|
browser.close()
|
|
|
|
|
|
def test_card_hidden_when_no_session_and_no_lifetime_data() -> None:
|
|
stats = _session_stats_no_cache()
|
|
lifetime = _lifetime_cache_payload(cache_read_tokens=0, cache_savings_usd=0.0)
|
|
|
|
with sync_playwright() as p:
|
|
browser = p.chromium.launch()
|
|
page = browser.new_page(viewport={"width": 1440, "height": 1600})
|
|
_open_dashboard(page, stats, lifetime)
|
|
|
|
expect(page.get_by_text("Prefix Cache Impact", exact=True)).to_have_count(0)
|
|
|
|
browser.close()
|