mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
## Description `headroom learn --agent opencode` can silently mine a frozen conversation corpus. `OpenCodePlugin` hardcodes `~/.local/share/opencode/opencode.db`, but source-built OpenCode writes `opencode-local.db` in the same directory. When both files exist, learn still succeeds against the stale packaged DB and ignores the live source-built corpus. This follows the report in https://github.com/headroomlabs-ai/headroom/issues/2581 and builds on the existing OpenCode learn path introduced in https://github.com/headroomlabs-ai/headroom/pull/559. This change keeps explicit constructor paths authoritative, honors `HEADROOM_OPENCODE_DB` when it is set, and otherwise selects the newest existing database between `opencode.db` and `opencode-local.db`, preferring canonical `opencode.db` on exact ties. It also updates the OpenCode learn docs line so the documented behavior matches the landed resolver. Closes #2581. The branch also carries one narrow CI repair requested during review: `headroom/cli/wrap.py` now binds the `unwrap claude` Click command back to `unwrap_claude` instead of the leak-warning helper, which restores the existing unwrap test surface and leaves the helper as an internal warning function. ## 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 a private OpenCode DB resolver in `headroom/learn/plugins/opencode.py` with precedence `db_path` then `HEADROOM_OPENCODE_DB` then newest existing default filename then canonical fallback - preserve canonical `opencode.db` for exact mtime ties and for canonical-only installs - add focused regression coverage for newer-local, explicit-path, canonical-only, equal-tie, missing-override, and end-to-end scanning cases - sync the OpenCode learn docs paragraph so it no longer claims `opencode.db` is the only supported default path - restore the `unwrap claude` Click command binding in `headroom/cli/wrap.py` and apply the repo formatter so the branch passes the existing unwrap test and lint gates ## Testing - [x] Unit tests pass (`uv run pytest tests/test_learn/test_opencode_scanner.py -q`) - [x] Linting passes (`uv run ruff check headroom/learn/plugins/opencode.py tests/test_learn/test_opencode_scanner.py`) - [x] Type checking passes (`uv run mypy headroom/learn/plugins/opencode.py`) - [x] New tests added for new functionality when applicable - [x] Manual testing performed ### Test Output ```text uv run pytest tests/test_learn/test_opencode_scanner.py -q -k "newer_local_database" 1 passed, 9 deselected in 0.26s uv run pytest tests/test_learn/test_opencode_scanner.py -q 10 passed in 0.50s uv run ruff check headroom/learn/plugins/opencode.py tests/test_learn/test_opencode_scanner.py All checks passed! uv run ruff format headroom/learn/plugins/opencode.py tests/test_learn/test_opencode_scanner.py --check 2 files already formatted uv run mypy headroom/learn/plugins/opencode.py Success: no issues found in 1 source file rg -n "opencode-local\.db|HEADROOM_OPENCODE_DB|opencode\.db" docs/content/docs/opencode.mdx 78:`headroom learn` supports OpenCode as a scan target. It reads past sessions from the newer of `~/.local/share/opencode/opencode-local.db` and `~/.local/share/opencode/opencode.db`, or from `HEADROOM_OPENCODE_DB` when you set an explicit override, and writes corrections to your project's `AGENTS.md`. uv run pytest tests/test_cli/test_unwrap_claude.py -q -k "removes_mcp_rtk_and_stops_proxy or preserves_user_managed_serena or removes_headroom_installed_serena or keep_flags_skip_cleanup or restores_all_base_url_modes or stops_claude_owned_persistent_deployment or reports_ambiguous_same_port_persistent_deployment or warns_about_same_port_inherited_env or ignores_malformed_inherited_env_port" 9 passed, 5 deselected in 0.40s uv run ruff check . All checks passed! uv run ruff format --check . 1340 files already formatted ``` ## Real Behavior Proof - Environment: temporary SQLite databases exercised through the production `OpenCodePlugin()` constructor - Exact command / steps: run `uv run pytest tests/test_learn/test_opencode_scanner.py -q -k "newer_local_database"` against `origin/main` with the new regression test overlaid, then run the same command and the full `uv run pytest tests/test_learn/test_opencode_scanner.py -q` suite on the branch head - Observed result: the base reproduction fails with `AssertionError: assert 'Canonical' == 'Local'`, proving current main still selects the stale canonical DB; the branch head passes the reproduction row and the full 10-test scanner suite - Not tested: live user OpenCode corpus ## 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 - [ ] 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 - [ ] I have updated the CHANGELOG.md if applicable ## Additional Notes - `CHANGELOG.md` stays untouched because Headroom generates release notes from conventional commits. - The automatic chooser is intentionally limited to the two known default filenames, `opencode.db` and `opencode-local.db`. Other layouts can use `HEADROOM_OPENCODE_DB`. - The fix stays inside `headroom/learn/plugins/opencode.py`; no provider-neutral learn or pipeline code changes are planned.
335 lines
10 KiB
Python
335 lines
10 KiB
Python
"""Tests for the OpenCode learn scanner."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import json
|
|
import os
|
|
import sqlite3
|
|
from pathlib import Path
|
|
|
|
import pytest
|
|
|
|
import headroom.learn.plugins.opencode as opencode_module
|
|
from headroom.learn.models import ErrorCategory
|
|
from headroom.learn.plugins.opencode import OpenCodePlugin
|
|
from headroom.learn.registry import get_registry, reset_registry
|
|
from headroom.learn.writer import CodexWriter
|
|
|
|
|
|
def _create_opencode_db(
|
|
db_path: Path,
|
|
project_path: Path,
|
|
*,
|
|
project_id: str = "project-1",
|
|
project_name: str = "Headroom",
|
|
session_id: str = "session-1",
|
|
tool_command: str = "pytest",
|
|
) -> None:
|
|
conn = sqlite3.connect(db_path)
|
|
try:
|
|
conn.executescript(
|
|
"""
|
|
CREATE TABLE project (
|
|
id TEXT PRIMARY KEY,
|
|
name TEXT,
|
|
worktree TEXT
|
|
);
|
|
CREATE TABLE session (
|
|
id TEXT PRIMARY KEY,
|
|
project_id TEXT,
|
|
time_created INTEGER
|
|
);
|
|
CREATE TABLE message (
|
|
id TEXT PRIMARY KEY,
|
|
session_id TEXT
|
|
);
|
|
CREATE TABLE part (
|
|
id TEXT PRIMARY KEY,
|
|
message_id TEXT,
|
|
data TEXT,
|
|
time_created INTEGER
|
|
);
|
|
"""
|
|
)
|
|
conn.execute(
|
|
"INSERT INTO project (id, name, worktree) VALUES (?, ?, ?)",
|
|
(project_id, project_name, str(project_path)),
|
|
)
|
|
conn.execute(
|
|
"INSERT INTO session (id, project_id, time_created) VALUES (?, ?, ?)",
|
|
(session_id, project_id, 1_700_000_000_000),
|
|
)
|
|
conn.execute(
|
|
"INSERT INTO message (id, session_id) VALUES (?, ?)",
|
|
("message-1", session_id),
|
|
)
|
|
conn.execute(
|
|
"INSERT INTO part (id, message_id, data, time_created) VALUES (?, ?, ?, ?)",
|
|
(
|
|
"part-1",
|
|
"message-1",
|
|
json.dumps(
|
|
{
|
|
"type": "tool",
|
|
"tool": "bash",
|
|
"callID": "call-1",
|
|
"state": {
|
|
"status": "error",
|
|
"input": {"command": tool_command},
|
|
"output": "Error: command failed with exit code 1",
|
|
},
|
|
}
|
|
),
|
|
1_700_000_000_001,
|
|
),
|
|
)
|
|
conn.commit()
|
|
finally:
|
|
conn.close()
|
|
|
|
|
|
def _patch_default_paths(monkeypatch: pytest.MonkeyPatch, db_dir: Path) -> tuple[Path, Path]:
|
|
canonical_db = db_dir / "opencode.db"
|
|
local_db = db_dir / "opencode-local.db"
|
|
monkeypatch.setattr(opencode_module, "_OPENCODE_DIR", db_dir, raising=False)
|
|
monkeypatch.setattr(opencode_module, "_OPENCODE_DB", canonical_db, raising=False)
|
|
return canonical_db, local_db
|
|
|
|
|
|
def _set_mtime(path: Path, *, seconds: int) -> None:
|
|
os.utime(path, ns=(seconds * 1_000_000_000, seconds * 1_000_000_000))
|
|
|
|
|
|
def _write_agents_file(project_path: Path) -> None:
|
|
project_path.mkdir()
|
|
(project_path / "AGENTS.md").write_text("# Existing context\n", encoding="utf-8")
|
|
|
|
|
|
def test_opencode_plugin_explicit_path_discovers_projects_and_scans_tool_failures(
|
|
tmp_path: Path,
|
|
) -> None:
|
|
project_path = tmp_path / "repo"
|
|
_write_agents_file(project_path)
|
|
db_path = tmp_path / "opencode.db"
|
|
_create_opencode_db(db_path, project_path)
|
|
|
|
plugin = OpenCodePlugin(db_path=db_path)
|
|
|
|
projects = plugin.discover_projects()
|
|
assert len(projects) == 1
|
|
assert projects[0].name == "Headroom"
|
|
assert projects[0].project_path == project_path
|
|
assert projects[0].context_file == project_path / "AGENTS.md"
|
|
|
|
sessions = plugin.scan_project(projects[0])
|
|
assert len(sessions) == 1
|
|
assert sessions[0].session_id == "session-1"
|
|
assert sessions[0].timestamp is not None
|
|
|
|
tool_call = sessions[0].tool_calls[0]
|
|
assert tool_call.name == "Bash"
|
|
assert tool_call.tool_call_id == "call-1"
|
|
assert tool_call.input_data == {"command": "pytest"}
|
|
assert tool_call.is_error is True
|
|
assert tool_call.error_category == ErrorCategory.RUNTIME_ERROR
|
|
|
|
|
|
def test_opencode_plugin_newer_local_database_wins_by_default(
|
|
tmp_path: Path, monkeypatch: pytest.MonkeyPatch
|
|
) -> None:
|
|
project_path = tmp_path / "repo"
|
|
_write_agents_file(project_path)
|
|
db_dir = tmp_path / "opencode"
|
|
db_dir.mkdir()
|
|
canonical_db, local_db = _patch_default_paths(monkeypatch, db_dir)
|
|
_create_opencode_db(
|
|
canonical_db,
|
|
project_path,
|
|
project_name="Canonical",
|
|
tool_command="canonical-command",
|
|
)
|
|
_create_opencode_db(
|
|
local_db,
|
|
project_path,
|
|
project_name="Local",
|
|
tool_command="local-command",
|
|
)
|
|
_set_mtime(canonical_db, seconds=1)
|
|
_set_mtime(local_db, seconds=2)
|
|
|
|
plugin = OpenCodePlugin()
|
|
|
|
assert plugin.detect() is True
|
|
projects = plugin.discover_projects()
|
|
assert len(projects) == 1
|
|
assert projects[0].name == "Local"
|
|
|
|
sessions = plugin.scan_project(projects[0])
|
|
assert sessions[0].tool_calls[0].input_data == {"command": "local-command"}
|
|
|
|
|
|
def test_opencode_plugin_canonical_only_default_path(
|
|
tmp_path: Path, monkeypatch: pytest.MonkeyPatch
|
|
) -> None:
|
|
project_path = tmp_path / "repo"
|
|
_write_agents_file(project_path)
|
|
db_dir = tmp_path / "opencode"
|
|
db_dir.mkdir()
|
|
canonical_db, _ = _patch_default_paths(monkeypatch, db_dir)
|
|
_create_opencode_db(
|
|
canonical_db,
|
|
project_path,
|
|
project_name="Canonical",
|
|
tool_command="canonical-command",
|
|
)
|
|
|
|
plugin = OpenCodePlugin()
|
|
|
|
assert plugin.detect() is True
|
|
projects = plugin.discover_projects()
|
|
assert len(projects) == 1
|
|
assert projects[0].name == "Canonical"
|
|
assert plugin._db_path == canonical_db
|
|
|
|
|
|
def test_opencode_plugin_local_only_default_path(
|
|
tmp_path: Path, monkeypatch: pytest.MonkeyPatch
|
|
) -> None:
|
|
project_path = tmp_path / "repo"
|
|
_write_agents_file(project_path)
|
|
db_dir = tmp_path / "opencode"
|
|
db_dir.mkdir()
|
|
_, local_db = _patch_default_paths(monkeypatch, db_dir)
|
|
_create_opencode_db(
|
|
local_db,
|
|
project_path,
|
|
project_name="Local",
|
|
tool_command="local-command",
|
|
)
|
|
|
|
plugin = OpenCodePlugin()
|
|
|
|
assert plugin.detect() is True
|
|
projects = plugin.discover_projects()
|
|
assert len(projects) == 1
|
|
assert projects[0].name == "Local"
|
|
assert plugin._db_path == local_db
|
|
|
|
|
|
def test_opencode_plugin_equal_mtime_prefers_canonical(
|
|
tmp_path: Path, monkeypatch: pytest.MonkeyPatch
|
|
) -> None:
|
|
project_path = tmp_path / "repo"
|
|
_write_agents_file(project_path)
|
|
db_dir = tmp_path / "opencode"
|
|
db_dir.mkdir()
|
|
canonical_db, local_db = _patch_default_paths(monkeypatch, db_dir)
|
|
_create_opencode_db(
|
|
canonical_db,
|
|
project_path,
|
|
project_name="Canonical",
|
|
tool_command="canonical-command",
|
|
)
|
|
_create_opencode_db(
|
|
local_db,
|
|
project_path,
|
|
project_name="Local",
|
|
tool_command="local-command",
|
|
)
|
|
_set_mtime(canonical_db, seconds=1)
|
|
_set_mtime(local_db, seconds=1)
|
|
|
|
plugin = OpenCodePlugin()
|
|
|
|
assert plugin._db_path == canonical_db
|
|
projects = plugin.discover_projects()
|
|
assert len(projects) == 1
|
|
assert projects[0].name == "Canonical"
|
|
|
|
|
|
def test_opencode_plugin_env_override_wins(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None:
|
|
project_path = tmp_path / "repo"
|
|
_write_agents_file(project_path)
|
|
db_dir = tmp_path / "opencode"
|
|
db_dir.mkdir()
|
|
canonical_db, local_db = _patch_default_paths(monkeypatch, db_dir)
|
|
override_db = db_dir / "override.db"
|
|
_create_opencode_db(
|
|
canonical_db,
|
|
project_path,
|
|
project_name="Canonical",
|
|
tool_command="canonical-command",
|
|
)
|
|
_create_opencode_db(
|
|
local_db,
|
|
project_path,
|
|
project_name="Local",
|
|
tool_command="local-command",
|
|
)
|
|
_create_opencode_db(
|
|
override_db,
|
|
project_path,
|
|
project_name="Override",
|
|
tool_command="override-command",
|
|
)
|
|
_set_mtime(canonical_db, seconds=1)
|
|
_set_mtime(local_db, seconds=2)
|
|
monkeypatch.setenv(opencode_module._OPENCODE_DB_ENV, str(override_db))
|
|
|
|
plugin = OpenCodePlugin()
|
|
|
|
assert plugin._db_path == override_db
|
|
projects = plugin.discover_projects()
|
|
assert len(projects) == 1
|
|
assert projects[0].name == "Override"
|
|
|
|
|
|
def test_opencode_plugin_missing_override_stays_missing(
|
|
tmp_path: Path, monkeypatch: pytest.MonkeyPatch
|
|
) -> None:
|
|
project_path = tmp_path / "repo"
|
|
_write_agents_file(project_path)
|
|
db_dir = tmp_path / "opencode"
|
|
db_dir.mkdir()
|
|
canonical_db, local_db = _patch_default_paths(monkeypatch, db_dir)
|
|
missing_db = db_dir / "override-missing.db"
|
|
_create_opencode_db(canonical_db, project_path, project_name="Canonical")
|
|
_create_opencode_db(local_db, project_path, project_name="Local")
|
|
_set_mtime(canonical_db, seconds=1)
|
|
_set_mtime(local_db, seconds=2)
|
|
monkeypatch.setenv(opencode_module._OPENCODE_DB_ENV, str(missing_db))
|
|
|
|
plugin = OpenCodePlugin()
|
|
|
|
assert plugin._db_path == missing_db
|
|
assert plugin.detect() is False
|
|
assert plugin.discover_projects() == []
|
|
|
|
|
|
def test_opencode_plugin_no_default_database_detects_missing(
|
|
tmp_path: Path, monkeypatch: pytest.MonkeyPatch
|
|
) -> None:
|
|
db_dir = tmp_path / "opencode"
|
|
db_dir.mkdir()
|
|
canonical_db, _ = _patch_default_paths(monkeypatch, db_dir)
|
|
|
|
plugin = OpenCodePlugin()
|
|
|
|
assert plugin._db_path == canonical_db
|
|
assert plugin.detect() is False
|
|
assert plugin.discover_projects() == []
|
|
|
|
|
|
def test_opencode_plugin_uses_agents_writer(tmp_path: Path) -> None:
|
|
plugin = OpenCodePlugin(db_path=tmp_path / "missing.db")
|
|
|
|
assert plugin.detect() is False
|
|
assert isinstance(plugin.create_writer(), CodexWriter)
|
|
|
|
|
|
def test_opencode_plugin_is_discovered_by_registry() -> None:
|
|
reset_registry()
|
|
try:
|
|
assert "opencode" in get_registry()
|
|
finally:
|
|
reset_registry()
|