mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
## Description Closes #1858 Docker/Compose source builds could report stale or misleading version information: the dashboard initially rendered a hardcoded `v0.3.0`, then `/health` replaced it with installed package metadata, which can be stale when building locally from `main` without release metadata in the image. This change makes source Docker Compose builds report an explicit source-build identity, removes the stale dashboard fallback, and keeps CLI/doctor version checks from treating source-build labels as release-version drift. ## 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 - Add `HEADROOM_VERSION` / `HEADROOM_BUILD_VERSION` runtime version overrides and optional packaged `_build_info.py` metadata. - Teach Docker Compose source builds to pass a `source-build` sentinel that the Dockerfile expands to `source-build+g<sha>` when git metadata is available, or `source-build+sha256.<digest>` otherwise. - Keep release/published image builds on normal package metadata when `HEADROOM_BUILD_VERSION` is unset. - Include only minimal `.git` metadata in the Docker build context so the source-build label can identify the checkout without copying git objects. - Treat source-build labels and raw hashes as non-release labels in `wrap` and `doctor`, avoiding false stale-proxy restarts and drift warnings. - Replace the dashboard hardcoded `0.3.0` fallback with `loading` / `unknown` and format non-release build labels without a `v` prefix. - Include the runtime version in proxy startup logs, `/health`, `/livez`, and OTEL service version reporting. ## Testing - [x] Unit tests pass (`pytest` in GitHub CI) - [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 GitHub CI: all checks passing - CI: build, build-wheel, lint, test shards, test-extras, test-agno, test-dashboard-ui - Docker: docker-native-e2e, docker-wrap-e2e, docker-init-e2e - Native wrappers: macOS, Windows, Ubuntu - Security: CodeQL, gitleaks, pip-audit - Governance: template, label, merge-conflicts, commitlint $ HEADROOM_REQUIRE_RUST_CORE=false PYTHONPATH=/Users/vinaygupta/Desktop/git/headroom-fix-1858-version-mismatch pytest tests/test_package_init_lazy.py::test_version_prefers_explicit_build_env tests/test_package_init_lazy.py::test_version_label_helpers_only_prefix_release_versions tests/test_package_init_lazy.py::test_version_uses_packaged_build_metadata tests/test_package_init_lazy.py::test_observability_version_uses_runtime_version tests/test_docker_compose_persistence.py tests/test_cli_doctor.py::TestProxyLiveness::test_up_leaves_source_label_unprefixed tests/test_cli_doctor.py::TestVersionDrift::test_non_release_version_labels_skip_drift_comparison tests/test_cli/test_wrap_persistent.py::test_proxy_version_restart_ignores_non_release_source_labels tests/test_proxy_dashboard_stats_cache.py::test_dashboard_uses_cached_stats_and_lazy_history_feed_polling -q 13 passed, 1 warning $ uvx ruff==0.15.17 check . All checks passed! $ uvx ruff==0.15.17 format --check . 1058 files already formatted $ uvx mypy==1.20.2 headroom --ignore-missing-imports Success: no issues found in 407 source files $ git diff --check # no output $ docker compose config # resolved headroom-proxy build args include HEADROOM_BUILD_VERSION: source-build $ HEADROOM_BUILD_VERSION=6266a1d docker compose config # explicit override is preserved as HEADROOM_BUILD_VERSION: 6266a1d $ docker build --check --build-arg HEADROOM_BUILD_VERSION=source-build . Check complete, no warnings found. ``` ## Real Behavior Proof - Environment: macOS local checkout, Python 3.13.5, Docker Desktop builder `desktop-linux`, plus GitHub Actions CI. - Exact command / steps: `docker compose config`, `HEADROOM_BUILD_VERSION=6266a1d docker compose config`, and `docker build --check --build-arg HEADROOM_BUILD_VERSION=source-build .`. - Observed result: Compose defaults the top-level `headroom-proxy` build arg to the `source-build` sentinel, preserves explicit overrides, and Dockerfile syntax/check validation passes for the source-build path. - Not tested: Full end-to-end release publishing flow; this PR only changes local/source-build reporting. - CI proof: GitHub Actions completed successfully across Docker E2E, CI test shards, lint/type checks, native wrapper checks, security checks, and PR governance. ## 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/CI with my changes - [ ] I have updated the CHANGELOG.md if applicable ## Screenshots (if applicable) N/A ## Additional Notes Docs and changelog are N/A for this runtime-reporting bug fix. The PR is open and ready for review with all GitHub checks passing.
333 lines
11 KiB
Python
333 lines
11 KiB
Python
import os
|
|
from types import SimpleNamespace
|
|
|
|
import pytest
|
|
|
|
pytest.importorskip("fastapi")
|
|
pytest.importorskip("httpx")
|
|
|
|
from fastapi.testclient import TestClient
|
|
|
|
from headroom.proxy.server import ProxyConfig, __version__, create_app
|
|
|
|
|
|
@pytest.fixture
|
|
def client(monkeypatch):
|
|
# Skip the live upstream connectivity probe in unit tests — tests verify
|
|
# the check logic separately (see test_readyz_upstream_check_* below).
|
|
monkeypatch.setenv("HEADROOM_SKIP_UPSTREAM_CHECK", "1")
|
|
config = ProxyConfig(
|
|
optimize=False,
|
|
cache_enabled=False,
|
|
rate_limit_enabled=False,
|
|
cost_tracking_enabled=False,
|
|
)
|
|
app = create_app(config)
|
|
# Loopback client/Host: /health serves the `config` block only to loopback
|
|
# callers (network callers get the /readyz-shape body, no config).
|
|
with TestClient(app, base_url="http://127.0.0.1", client=("127.0.0.1", 12345)) as test_client:
|
|
yield test_client
|
|
|
|
|
|
def test_livez_reports_process_health(client):
|
|
response = client.get("/livez")
|
|
|
|
assert response.status_code == 200
|
|
data = response.json()
|
|
assert data["service"] == "headroom-proxy"
|
|
assert data["status"] == "healthy"
|
|
assert data["alive"] is True
|
|
assert data["version"] == __version__
|
|
assert data["uptime_seconds"] >= 0
|
|
|
|
|
|
def test_readyz_reports_core_subsystem_checks(client):
|
|
response = client.get("/readyz")
|
|
|
|
assert response.status_code == 200
|
|
data = response.json()
|
|
assert data["ready"] is True
|
|
assert data["status"] == "healthy"
|
|
assert "config" not in data
|
|
assert data["checks"]["startup"]["status"] == "healthy"
|
|
assert data["checks"]["http_client"]["status"] == "healthy"
|
|
assert data["checks"]["cache"]["status"] == "disabled"
|
|
assert data["checks"]["rate_limiter"]["status"] == "disabled"
|
|
assert data["checks"]["memory"]["status"] == "disabled"
|
|
runtime = data["runtime"]
|
|
assert runtime["anthropic_pre_upstream"]["resolved_concurrency"] == max(
|
|
2, min(8, os.cpu_count() or 4)
|
|
)
|
|
assert runtime["anthropic_pre_upstream"]["source"] == "auto"
|
|
assert runtime["anthropic_pre_upstream"]["acquire_timeout_seconds"] == 15.0
|
|
assert runtime["anthropic_pre_upstream"]["compression_timeout_seconds"] == 30.0
|
|
assert runtime["anthropic_pre_upstream"]["memory_context_timeout_seconds"] == 2.0
|
|
assert runtime["anthropic_pre_upstream"]["codex_ws_gated"] is False
|
|
assert runtime["websocket_sessions"]["active_sessions"] == 0
|
|
assert runtime["websocket_sessions"]["active_relay_tasks"] == 0
|
|
|
|
|
|
def test_health_preserves_backwards_compatible_config_payload(client):
|
|
response = client.get("/health")
|
|
|
|
assert response.status_code == 200
|
|
data = response.json()
|
|
assert data["status"] == "healthy"
|
|
assert data["ready"] is True
|
|
assert data["version"] == __version__
|
|
config = data["config"]
|
|
assert config["backend"] == "anthropic"
|
|
assert config["optimize"] is False
|
|
assert config["cache"] is False
|
|
assert config["rate_limit"] is False
|
|
assert config["memory"] is False
|
|
assert config["learn"] is False
|
|
assert config["code_graph"] is False
|
|
assert config["savings_profile"] is None
|
|
assert config["target_ratio"] is None
|
|
assert config["max_items_after_crush"] == 50
|
|
assert config["smart_crusher_with_compaction"] is None
|
|
assert isinstance(config["pid"], int)
|
|
|
|
|
|
def test_health_reports_agent_savings_config():
|
|
config = ProxyConfig(
|
|
optimize=False,
|
|
cache_enabled=False,
|
|
rate_limit_enabled=False,
|
|
cost_tracking_enabled=False,
|
|
savings_profile="agent-90",
|
|
target_ratio=0.10,
|
|
compress_user_messages=True,
|
|
compress_system_messages=True,
|
|
protect_recent=2,
|
|
protect_analysis_context=True,
|
|
min_tokens_to_crush=120,
|
|
max_items_after_crush=8,
|
|
smart_crusher_with_compaction=False,
|
|
accuracy_guard="strict",
|
|
)
|
|
app = create_app(config)
|
|
|
|
with TestClient(app, base_url="http://127.0.0.1", client=("127.0.0.1", 12345)) as client:
|
|
response = client.get("/health")
|
|
|
|
assert response.status_code == 200
|
|
reported = response.json()["config"]
|
|
assert reported["savings_profile"] == "agent-90"
|
|
assert reported["target_ratio"] == 0.10
|
|
assert reported["compress_user_messages"] is True
|
|
assert reported["compress_system_messages"] is True
|
|
assert reported["protect_recent"] == 2
|
|
assert reported["protect_analysis_context"] is True
|
|
assert reported["min_tokens_to_crush"] == 120
|
|
assert reported["max_items_after_crush"] == 8
|
|
assert reported["smart_crusher_with_compaction"] is False
|
|
assert reported["accuracy_guard"] == "strict"
|
|
|
|
|
|
def test_health_includes_deployment_metadata_when_present(monkeypatch):
|
|
monkeypatch.setenv("HEADROOM_SKIP_UPSTREAM_CHECK", "1")
|
|
monkeypatch.setenv("HEADROOM_DEPLOYMENT_PROFILE", "default")
|
|
monkeypatch.setenv("HEADROOM_DEPLOYMENT_PRESET", "persistent-service")
|
|
monkeypatch.setenv("HEADROOM_DEPLOYMENT_RUNTIME", "python")
|
|
monkeypatch.setenv("HEADROOM_DEPLOYMENT_SUPERVISOR", "service")
|
|
monkeypatch.setenv("HEADROOM_DEPLOYMENT_SCOPE", "user")
|
|
|
|
config = ProxyConfig(
|
|
optimize=False,
|
|
cache_enabled=False,
|
|
rate_limit_enabled=False,
|
|
cost_tracking_enabled=False,
|
|
)
|
|
app = create_app(config)
|
|
|
|
with TestClient(app) as client:
|
|
response = client.get("/health")
|
|
|
|
assert response.status_code == 200
|
|
assert response.json()["deployment"] == {
|
|
"profile": "default",
|
|
"preset": "persistent-service",
|
|
"runtime": "python",
|
|
"supervisor": "service",
|
|
"scope": "user",
|
|
}
|
|
|
|
|
|
def test_health_remains_200_when_proxy_is_not_ready(client):
|
|
client.app.state.ready = False
|
|
|
|
response = client.get("/health")
|
|
|
|
assert response.status_code == 200
|
|
assert response.json()["ready"] is False
|
|
|
|
|
|
def test_readyz_reports_memory_backend_when_enabled(tmp_path, monkeypatch):
|
|
monkeypatch.setenv("HEADROOM_SKIP_UPSTREAM_CHECK", "1")
|
|
config = ProxyConfig(
|
|
optimize=False,
|
|
cache_enabled=False,
|
|
rate_limit_enabled=False,
|
|
cost_tracking_enabled=False,
|
|
memory_enabled=True,
|
|
memory_backend="local",
|
|
memory_db_path=str(tmp_path / "headroom_memory.db"),
|
|
memory_inject_tools=True,
|
|
memory_inject_context=True,
|
|
)
|
|
app = create_app(config)
|
|
|
|
with TestClient(app) as client:
|
|
response = client.get("/readyz")
|
|
|
|
assert response.status_code == 200
|
|
data = response.json()
|
|
assert data["checks"]["memory"]["status"] == "healthy"
|
|
assert data["checks"]["memory"]["backend"] == "local"
|
|
assert data["checks"]["memory"]["initialized"] is True
|
|
|
|
|
|
def test_readyz_initializes_qdrant_memory_backend(monkeypatch):
|
|
monkeypatch.setenv("HEADROOM_SKIP_UPSTREAM_CHECK", "1")
|
|
from headroom.memory.backends import direct_mem0
|
|
|
|
init_calls: list[str] = []
|
|
|
|
class FakeDirectMem0Adapter:
|
|
def __init__(self, config):
|
|
self.config = config
|
|
|
|
async def ensure_initialized(self):
|
|
init_calls.append("initialized")
|
|
|
|
monkeypatch.setattr(direct_mem0, "DirectMem0Adapter", FakeDirectMem0Adapter)
|
|
|
|
config = ProxyConfig(
|
|
optimize=False,
|
|
cache_enabled=False,
|
|
rate_limit_enabled=False,
|
|
cost_tracking_enabled=False,
|
|
memory_enabled=True,
|
|
memory_backend="qdrant-neo4j",
|
|
)
|
|
app = create_app(config)
|
|
|
|
with TestClient(app) as client:
|
|
response = client.get("/readyz")
|
|
|
|
assert response.status_code == 200
|
|
data = response.json()
|
|
assert init_calls == ["initialized"]
|
|
assert data["checks"]["memory"]["status"] == "healthy"
|
|
assert data["checks"]["memory"]["backend"] == "qdrant-neo4j"
|
|
assert data["checks"]["memory"]["initialized"] is True
|
|
|
|
|
|
def test_shutdown_tolerates_stubbed_memory_handler(monkeypatch):
|
|
monkeypatch.setenv("HEADROOM_SKIP_UPSTREAM_CHECK", "1")
|
|
config = ProxyConfig(
|
|
optimize=False,
|
|
cache_enabled=False,
|
|
rate_limit_enabled=False,
|
|
cost_tracking_enabled=False,
|
|
)
|
|
app = create_app(config)
|
|
|
|
with TestClient(app) as client:
|
|
client.app.state.proxy.memory_handler = SimpleNamespace(
|
|
health_status=lambda: {
|
|
"enabled": False,
|
|
"backend": None,
|
|
"initialized": False,
|
|
"native_tool": False,
|
|
"bridge_enabled": False,
|
|
}
|
|
)
|
|
response = client.get("/health")
|
|
|
|
assert response.status_code == 200
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Upstream connectivity check tests
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
def test_readyz_upstream_check_disabled_by_env_var(monkeypatch):
|
|
"""HEADROOM_SKIP_UPSTREAM_CHECK=1 suppresses the probe and reports ready."""
|
|
monkeypatch.setenv("HEADROOM_SKIP_UPSTREAM_CHECK", "1")
|
|
config = ProxyConfig(
|
|
optimize=False,
|
|
cache_enabled=False,
|
|
rate_limit_enabled=False,
|
|
cost_tracking_enabled=False,
|
|
)
|
|
app = create_app(config)
|
|
|
|
with TestClient(app) as test_client:
|
|
response = test_client.get("/readyz")
|
|
|
|
assert response.status_code == 200
|
|
data = response.json()
|
|
assert data["ready"] is True
|
|
# When the check is skipped the component is reported as "disabled"
|
|
assert data["checks"]["upstream"]["enabled"] is False
|
|
assert data["checks"]["upstream"]["ready"] is True
|
|
|
|
|
|
def test_readyz_upstream_check_failure_returns_503(monkeypatch):
|
|
"""A failed upstream probe makes /readyz return HTTP 503."""
|
|
from unittest.mock import AsyncMock, patch
|
|
|
|
import httpx
|
|
|
|
monkeypatch.delenv("HEADROOM_SKIP_UPSTREAM_CHECK", raising=False)
|
|
|
|
config = ProxyConfig(
|
|
optimize=False,
|
|
cache_enabled=False,
|
|
rate_limit_enabled=False,
|
|
cost_tracking_enabled=False,
|
|
)
|
|
app = create_app(config)
|
|
|
|
# Patch the proxy's shared http_client.head so the probe uses the same
|
|
# client as real traffic (which also means TLS/CA config is consistent).
|
|
with TestClient(app) as test_client:
|
|
with patch.object(
|
|
test_client.app.state.proxy.http_client,
|
|
"head",
|
|
new=AsyncMock(side_effect=httpx.ConnectError("connection refused (test)")),
|
|
):
|
|
response = test_client.get("/readyz")
|
|
|
|
assert response.status_code == 503
|
|
data = response.json()
|
|
assert data["ready"] is False
|
|
assert data["checks"]["upstream"]["ready"] is False
|
|
assert "connection refused" in data["checks"]["upstream"]["error"]
|
|
|
|
|
|
def test_health_includes_upstream_check_result(monkeypatch):
|
|
"""/health always returns 200 but exposes the upstream check result."""
|
|
monkeypatch.setenv("HEADROOM_SKIP_UPSTREAM_CHECK", "1")
|
|
config = ProxyConfig(
|
|
optimize=False,
|
|
cache_enabled=False,
|
|
rate_limit_enabled=False,
|
|
cost_tracking_enabled=False,
|
|
)
|
|
app = create_app(config)
|
|
|
|
with TestClient(app) as test_client:
|
|
response = test_client.get("/health")
|
|
|
|
assert response.status_code == 200
|
|
data = response.json()
|
|
assert "upstream" in data["checks"]
|
|
upstream = data["checks"]["upstream"]
|
|
assert "enabled" in upstream
|
|
assert "ready" in upstream
|
|
assert "status" in upstream
|