mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
The optional `query` parameter on headroom_retrieve routed retrieval through CompressionStore.search(), which BM25-scored the items inside a single cached blob and dropped everything below a 0.3 relevance floor. On small per-blob corpora with conversational queries this returned an empty result the large majority of the time, so the LLM saw "nothing found" for content that was actually present — pushing users to turn compression off entirely. Retrieval is fundamentally a hash lookup (this already matches the Rust proxy's CCR store, which is put/get only — "no BM25 search"). Remove the query/search path end to end and always return the full original content: Core (Python proxy): - tool schemas (anthropic/openai/google) drop the `query` property - parse_tool_call returns the hash (str | None) instead of (hash, query) - response handler, proxy POST/GET/tool-call handlers, the MCP retrieve tool, and the streaming feedback recorders retrieve by hash only - proactive context-tracker expansion always restores full content - delete CompressionStore.search() and its BM25 machinery (the bm25 module stays — it is still used by relevance/) - CCRToolCall.query, CCRToolResult.was_search, and ExpansionRecommendation.expand_full/search_query are removed Plugins (advertised a now-defunct query param to the LLM): - hermes (Python), openclaw + opencode (TypeScript) retrieve tools drop `query` from their schemas, signatures, request URLs, and tests Benchmarks/docs: - ccr_regression + adversarial benchmarks switch from store.search() to full hash retrieval (search input-injection tests repurposed to the hash, the only remaining input surface) - wiki/ARCHITECTURE.md, wiki/ccr.md, docs/content/docs/ccr.mdx, config.py and store docstrings updated to describe hash-only retrieval Tests updated to assert full-content retrieval and guard the removed surface; the full CCR/proxy/store/TOIN suite passes. ruff + mypy clean. ## Description <!-- Briefly explain the change and why it is needed. --> Closes # ## Type of Change - [ ] 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 - ## Testing <!-- Check what you actually ran, then paste the real command output below. --> - [ ] Unit tests pass (`pytest`) - [ ] Linting passes (`ruff check .`) - [ ] Type checking passes (`mypy headroom`) - [ ] New tests added for new functionality - [ ] Manual testing performed ### Test Output ```text # Paste relevant command output or artifact links here ``` ## Real Behavior Proof - Environment: - Exact command / steps: - Observed result: - Not tested: ## Review Readiness - [ ] I have performed a self-review - [ ] This PR is ready for human review ## Checklist - [ ] My code follows the project's style guidelines - [ ] I have performed a self-review of my code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] I have updated the CHANGELOG.md if applicable ## Screenshots (if applicable) Add screenshots to help explain your changes. ## Additional Notes <!-- Mention any N/A checklist items, tradeoffs, follow-ups, or maintainer context. -->
184 lines
5.6 KiB
Python
184 lines
5.6 KiB
Python
"""Tests for the Hermes headroom_retrieve plugin (plugins/hermes/).
|
|
|
|
The plugin targets the Hermes Agent runtime, which provides a
|
|
``tools.registry`` module. That module does not exist inside the headroom
|
|
codebase, so these tests stub it before loading the plugin file directly
|
|
via importlib.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import importlib.util
|
|
import json
|
|
import sys
|
|
import types
|
|
from pathlib import Path
|
|
from typing import Any
|
|
|
|
import httpx
|
|
import pytest
|
|
|
|
PLUGIN_PATH = (
|
|
Path(__file__).resolve().parent.parent
|
|
/ "plugins"
|
|
/ "hermes"
|
|
/ "headroom_retrieve"
|
|
/ "__init__.py"
|
|
)
|
|
|
|
|
|
def _load_plugin() -> types.ModuleType:
|
|
"""Load the plugin file with a stubbed Hermes ``tools.registry``."""
|
|
registry = types.ModuleType("tools.registry")
|
|
registry.tool_error = lambda msg: json.dumps({"error": msg}) # type: ignore[attr-defined]
|
|
registry.tool_result = lambda data: json.dumps({"result": data}) # type: ignore[attr-defined]
|
|
tools_pkg = types.ModuleType("tools")
|
|
tools_pkg.registry = registry # type: ignore[attr-defined]
|
|
sys.modules.setdefault("tools", tools_pkg)
|
|
sys.modules["tools.registry"] = registry
|
|
|
|
spec = importlib.util.spec_from_file_location("hermes_headroom_retrieve", PLUGIN_PATH)
|
|
assert spec is not None and spec.loader is not None
|
|
module = importlib.util.module_from_spec(spec)
|
|
spec.loader.exec_module(module)
|
|
return module
|
|
|
|
|
|
class _FakeResponse:
|
|
def __init__(self, status_code: int, payload: dict[str, Any] | None = None) -> None:
|
|
self.status_code = status_code
|
|
self._payload = payload or {}
|
|
self.text = json.dumps(self._payload)
|
|
|
|
def json(self) -> dict[str, Any]:
|
|
return self._payload
|
|
|
|
|
|
@pytest.fixture()
|
|
def plugin() -> types.ModuleType:
|
|
return _load_plugin()
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
("raw", "expected"),
|
|
[
|
|
("abc123", "abc123"),
|
|
("ccr:abc123", "abc123"),
|
|
("<<ccr:abc123>>", "abc123"),
|
|
("<<ccr:abc123,base64,4.5KB>>", "abc123"),
|
|
("hash=abc123", "abc123"),
|
|
(" <<ccr:abc123>> ", "abc123"),
|
|
],
|
|
)
|
|
def test_handler_normalizes_marker_shapes_to_bare_hash(
|
|
plugin: types.ModuleType, monkeypatch: pytest.MonkeyPatch, raw: str, expected: str
|
|
) -> None:
|
|
# Arrange
|
|
seen: dict[str, Any] = {}
|
|
|
|
def fake_post(url: str, json: dict[str, Any], timeout: int) -> _FakeResponse: # noqa: A002
|
|
seen["payload"] = json
|
|
return _FakeResponse(200, {"original_content": "data", "original_tokens": 1})
|
|
|
|
monkeypatch.setattr(plugin.httpx, "post", fake_post)
|
|
|
|
# Act
|
|
plugin._handle_headroom_retrieve({"hash": raw})
|
|
|
|
# Assert
|
|
assert seen["payload"]["hash"] == expected
|
|
|
|
|
|
def test_handler_ignores_legacy_query(
|
|
plugin: types.ModuleType, monkeypatch: pytest.MonkeyPatch
|
|
) -> None:
|
|
# Retrieval is by hash only; a legacy ``query`` in the args is dropped,
|
|
# not forwarded to the proxy.
|
|
seen: dict[str, Any] = {}
|
|
|
|
def fake_post(url: str, json: dict[str, Any], timeout: int) -> _FakeResponse: # noqa: A002
|
|
seen["payload"] = json
|
|
return _FakeResponse(200, {"original_content": "data"})
|
|
|
|
monkeypatch.setattr(plugin.httpx, "post", fake_post)
|
|
|
|
# Act
|
|
plugin._handle_headroom_retrieve({"hash": "abc123", "query": "error lines"})
|
|
|
|
# Assert
|
|
assert seen["payload"] == {"hash": "abc123"}
|
|
|
|
|
|
def test_handler_returns_original_content_on_200(
|
|
plugin: types.ModuleType, monkeypatch: pytest.MonkeyPatch
|
|
) -> None:
|
|
# Arrange
|
|
payload = {"original_content": "full text", "original_tokens": 42, "tool_name": "read_file"}
|
|
monkeypatch.setattr(plugin.httpx, "post", lambda *a, **kw: _FakeResponse(200, payload))
|
|
|
|
# Act
|
|
out = json.loads(plugin._handle_headroom_retrieve({"hash": "abc123"}))
|
|
|
|
# Assert
|
|
assert out["result"]["original_content"] == "full text"
|
|
assert out["result"]["original_tokens"] == 42
|
|
assert out["result"]["tool_name"] == "read_file"
|
|
|
|
|
|
def test_handler_reports_expired_entry_on_404(
|
|
plugin: types.ModuleType, monkeypatch: pytest.MonkeyPatch
|
|
) -> None:
|
|
# Arrange
|
|
monkeypatch.setattr(plugin.httpx, "post", lambda *a, **kw: _FakeResponse(404))
|
|
|
|
# Act
|
|
out = json.loads(plugin._handle_headroom_retrieve({"hash": "deadbeef"}))
|
|
|
|
# Assert: actionable message, not a bare error
|
|
assert "expired" in out["error"]
|
|
assert "re-run" in out["error"].lower()
|
|
|
|
|
|
def test_handler_reports_unreachable_proxy_on_connection_error(
|
|
plugin: types.ModuleType, monkeypatch: pytest.MonkeyPatch
|
|
) -> None:
|
|
# Arrange
|
|
def raise_connect_error(*a: Any, **kw: Any) -> None:
|
|
raise httpx.ConnectError("connection refused")
|
|
|
|
monkeypatch.setattr(plugin.httpx, "post", raise_connect_error)
|
|
|
|
# Act
|
|
out = json.loads(plugin._handle_headroom_retrieve({"hash": "abc123"}))
|
|
|
|
# Assert
|
|
assert "unreachable" in out["error"]
|
|
|
|
|
|
def test_handler_rejects_empty_hash(plugin: types.ModuleType) -> None:
|
|
# Act
|
|
out = json.loads(plugin._handle_headroom_retrieve({"hash": " "}))
|
|
|
|
# Assert
|
|
assert "required" in out["error"]
|
|
|
|
|
|
def test_register_exposes_tool_with_marker_aware_schema(plugin: types.ModuleType) -> None:
|
|
# Arrange
|
|
registered: dict[str, Any] = {}
|
|
|
|
class FakeCtx:
|
|
def register_tool(self, **kwargs: Any) -> None:
|
|
registered.update(kwargs)
|
|
|
|
# Act
|
|
plugin.register(FakeCtx())
|
|
|
|
# Assert
|
|
assert registered["name"] == "headroom_retrieve"
|
|
assert registered["toolset"] == "headroom"
|
|
assert registered["schema"]["parameters"]["required"] == ["hash"]
|
|
# The description must teach both marker formats so the model recognizes them.
|
|
description = registered["schema"]["description"]
|
|
assert "<<ccr:" in description
|
|
assert "hash=" in description
|