headroom/tests/test_toin_feedback.py
Tejas Chopra c2fc4d3753
fix(ccr): make headroom_retrieve a hash-only full-content lookup (#1532)
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. -->
2026-06-28 10:32:43 -07:00

452 lines
16 KiB
Python

"""Tests for TOIN feedback loop: headroom_retrieve calls flow back to TOIN."""
from __future__ import annotations
from unittest.mock import MagicMock, patch
import pytest
from headroom.cache.compression_store import get_compression_store, reset_compression_store
from headroom.telemetry import (
TOINConfig,
ToolIntelligenceNetwork,
ToolPattern,
ToolSignature,
get_toin,
reset_toin,
)
from headroom.transforms.kompress_compressor import KompressCompressor
@pytest.fixture(autouse=True)
def reset_globals(monkeypatch, tmp_path):
"""Reset global state before each test."""
temp_toin_path = str(tmp_path / "toin_test.json")
monkeypatch.setenv("HEADROOM_TOIN_PATH", temp_toin_path)
reset_toin()
reset_compression_store()
yield
reset_compression_store()
reset_toin()
def _make_config(min_samples: int = 5) -> TOINConfig:
"""Create a TOIN config for testing."""
return TOINConfig(
enabled=True,
min_samples_for_recommendation=min_samples,
storage_path="", # disable persistence
)
def _make_signature(structure_hash: str = "test_hash_123") -> ToolSignature:
"""Create a minimal ToolSignature for testing."""
return ToolSignature(
structure_hash=structure_hash,
field_count=3,
has_nested_objects=False,
has_arrays=True,
max_depth=1,
)
def test_kompress_ccr_retrieval_updates_toin():
"""Kompress CCR entries should be first-class TOIN patterns."""
original = "\n".join(
[
"HEADROOM_MODE=debug PATH=/tmp/headroom",
"ordinary line without the target token",
"another ordinary line",
]
)
compressed = "HEADROOM_MODE=debug"
compressor = KompressCompressor()
hash_key = compressor._store_in_ccr(
original,
compressed,
original_tokens=len(original.split()),
)
assert hash_key is not None
store = get_compression_store()
entry = store.retrieve(hash_key)
assert entry is not None
assert entry.tool_signature_hash is not None
# Retrieval is by hash and returns the full original content.
assert "HEADROOM" in entry.original_content
stats = get_toin().get_stats()
assert stats["total_compressions"] == 1
assert stats["total_retrievals"] == 1
@pytest.mark.skip(reason="PR-B5: observations counter and request-time hint API retired")
class TestGetRecommendationObservations:
"""Bug 1: get_recommendation() should increment observations counter."""
def test_increments_observations_when_pattern_exists(self):
"""get_recommendation() should increment observations when pattern exists."""
config = _make_config(min_samples=5)
toin = ToolIntelligenceNetwork(config=config)
sig = _make_signature("obs_test_hash")
# Record enough compressions to create a pattern with sufficient samples
for _ in range(15):
toin.record_compression(
tool_signature=sig,
original_count=100,
compressed_count=20,
original_tokens=5000,
compressed_tokens=1000,
strategy="top_n",
)
# Get recommendation
toin.get_recommendation(sig)
# Check observations incremented
pattern = toin._patterns[("unknown", "unknown", sig.structure_hash)]
assert pattern.observations == 1
# Call again
toin.get_recommendation(sig)
assert pattern.observations == 2
def test_increments_observations_even_below_min_samples(self):
"""observations increments even when sample_size < min_samples."""
config = _make_config(min_samples=100)
toin = ToolIntelligenceNetwork(config=config)
sig = _make_signature("low_sample_hash")
# Record just a few compressions (below min_samples)
for _ in range(3):
toin.record_compression(
tool_signature=sig,
original_count=50,
compressed_count=10,
original_tokens=2000,
compressed_tokens=500,
strategy="top_n",
)
result = toin.get_recommendation(sig)
assert result.source == "local" # Not enough samples
pattern = toin._patterns[("unknown", "unknown", sig.structure_hash)]
assert pattern.observations == 1
def test_no_increment_for_unknown_pattern(self):
"""get_recommendation() should NOT increment for unknown patterns."""
config = _make_config()
toin = ToolIntelligenceNetwork(config=config)
sig = _make_signature("nonexistent_hash")
result = toin.get_recommendation(sig)
assert result.source == "default"
assert result.reason == "No pattern data for this tool type"
# No pattern exists, nothing to increment
assert "nonexistent_hash" not in toin._patterns
def test_observations_survives_serialization(self):
"""observations field should serialize and deserialize correctly."""
pattern = ToolPattern(
tool_signature_hash="serial_test",
total_compressions=10,
observations=42,
)
d = pattern.to_dict()
assert d["observations"] == 42
restored = ToolPattern.from_dict(d)
assert restored.observations == 42
def test_observations_defaults_to_zero(self):
"""observations defaults to 0 for new patterns."""
pattern = ToolPattern(tool_signature_hash="new_pattern")
assert pattern.observations == 0
class TestRecordRetrievalPopulatesFields:
"""Bug 1 related: record_retrieval with query_fields populates field data."""
def test_record_retrieval_populates_fields(self):
"""record_retrieval with query_fields should populate field_retrieval_frequency."""
config = _make_config()
toin = ToolIntelligenceNetwork(config=config)
sig_hash = "retrieval_field_test"
# Record some compressions first to create the pattern
sig = _make_signature(sig_hash)
for _ in range(5):
toin.record_compression(
tool_signature=sig,
original_count=50,
compressed_count=10,
original_tokens=2000,
compressed_tokens=500,
strategy="top_n",
)
# Record multiple retrievals with same field
for _ in range(5):
toin.record_retrieval(
sig_hash,
"search",
query="error_message:timeout",
query_fields=["error_message"],
)
pattern = toin._patterns[("unknown", "unknown", sig_hash)]
assert pattern.total_retrievals == 5
assert pattern.search_retrievals == 5
assert len(pattern.field_retrieval_frequency) > 0
class TestCCRFeedbackExtraction:
"""Bug 2: _record_ccr_feedback_from_response extracts headroom_retrieve calls."""
def test_extract_headroom_retrieve_from_response(self):
"""Should detect headroom_retrieve tool_use blocks in response content."""
response = {
"content": [
{"type": "text", "text": "Let me retrieve that."},
{
"type": "tool_use",
"id": "toolu_123",
"name": "headroom_retrieve",
"input": {"hash": "abc123def456"},
},
]
}
# Extract tool calls the same way _record_ccr_feedback_from_response does
content = response.get("content", [])
retrieve_calls = []
for block in content:
if not isinstance(block, dict):
continue
if block.get("type") == "tool_use" and block.get("name") == "headroom_retrieve":
input_data = block.get("input", {})
if input_data.get("hash"):
retrieve_calls.append(input_data)
assert len(retrieve_calls) == 1
assert retrieve_calls[0]["hash"] == "abc123def456"
def test_ignore_non_retrieve_tool_calls(self):
"""Should ignore tool_use blocks that are not headroom_retrieve."""
response = {
"content": [
{
"type": "tool_use",
"id": "toolu_456",
"name": "some_other_tool",
"input": {"data": "something"},
},
{
"type": "tool_use",
"id": "toolu_789",
"name": "headroom_retrieve",
"input": {"hash": "xyz789"},
},
]
}
content = response.get("content", [])
retrieve_calls = []
for block in content:
if not isinstance(block, dict):
continue
if block.get("type") == "tool_use" and block.get("name") == "headroom_retrieve":
input_data = block.get("input", {})
if input_data.get("hash"):
retrieve_calls.append(input_data)
assert len(retrieve_calls) == 1
assert retrieve_calls[0]["hash"] == "xyz789"
def test_empty_content_does_not_crash(self):
"""Should handle empty or missing content gracefully."""
for response in [
{"content": []},
{"content": "not a list"},
{},
]:
content = response.get("content", [])
if not isinstance(content, list):
continue
# Should not raise
for _block in content:
pass
def test_missing_hash_skipped(self):
"""Should skip headroom_retrieve calls without a hash."""
response = {
"content": [
{
"type": "tool_use",
"id": "toolu_000",
"name": "headroom_retrieve",
"input": {"query": "some query"}, # No hash
},
]
}
content = response.get("content", [])
retrieve_calls = []
for block in content:
if not isinstance(block, dict):
continue
if block.get("type") == "tool_use" and block.get("name") == "headroom_retrieve":
input_data = block.get("input", {})
if input_data.get("hash"):
retrieve_calls.append(input_data)
assert len(retrieve_calls) == 0
class TestStreamingFeedbackIntegration:
"""Bug 2: Full feedback loop — streaming headroom_retrieve reaches TOIN."""
def test_record_ccr_feedback_calls_store_retrieve(self):
"""_record_ccr_feedback_from_response calls store.retrieve by hash.
Retrieval is by hash only — any legacy ``query`` in the tool input is
ignored, and the full content is fetched for the feedback side effect.
"""
from headroom.proxy.server import HeadroomProxy
response = {
"content": [
{
"type": "tool_use",
"id": "toolu_001",
"name": "headroom_retrieve",
"input": {"hash": "feedbackhash1", "query": "error details"},
},
]
}
mock_store = MagicMock()
with patch(
"headroom.cache.compression_store.get_compression_store",
return_value=mock_store,
):
# Create a minimal proxy to test the method
proxy = HeadroomProxy.__new__(HeadroomProxy)
proxy.config = MagicMock()
proxy.config.ccr_inject_tool = True
proxy._record_ccr_feedback_from_response(response, "anthropic", "req-test-001")
mock_store.retrieve.assert_called_once_with("feedbackhash1")
mock_store.search.assert_not_called()
def test_record_ccr_feedback_calls_store_retrieve_no_query(self):
"""_record_ccr_feedback_from_response calls store.retrieve by hash."""
from headroom.proxy.server import HeadroomProxy
response = {
"content": [
{
"type": "tool_use",
"id": "toolu_002",
"name": "headroom_retrieve",
"input": {"hash": "feedbackhash2"},
},
]
}
mock_store = MagicMock()
with patch(
"headroom.cache.compression_store.get_compression_store",
return_value=mock_store,
):
proxy = HeadroomProxy.__new__(HeadroomProxy)
proxy.config = MagicMock()
proxy.config.ccr_inject_tool = True
proxy._record_ccr_feedback_from_response(response, "anthropic", "req-test-002")
mock_store.retrieve.assert_called_once_with("feedbackhash2")
def test_record_ccr_feedback_handles_store_exception(self):
"""_record_ccr_feedback_from_response should not raise on store errors."""
from headroom.proxy.server import HeadroomProxy
response = {
"content": [
{
"type": "tool_use",
"id": "toolu_003",
"name": "headroom_retrieve",
"input": {"hash": "feedbackhash3"},
},
]
}
mock_store = MagicMock()
mock_store.retrieve.side_effect = RuntimeError("store unavailable")
with patch(
"headroom.cache.compression_store.get_compression_store",
return_value=mock_store,
):
proxy = HeadroomProxy.__new__(HeadroomProxy)
proxy.config = MagicMock()
proxy.config.ccr_inject_tool = True
# Should not raise
proxy._record_ccr_feedback_from_response(response, "anthropic", "req-test-003")
class TestParseSSEToolUse:
"""Bug 3: _parse_sse_to_response correctly handles tool_use blocks."""
def test_parse_sse_extracts_tool_use(self):
"""SSE with tool_use content_block should be parsed correctly."""
from headroom.proxy.server import HeadroomProxy
sse_data = (
'data: {"type":"message_start","message":{"id":"msg_01","model":"claude-3-5-sonnet-20241022","role":"assistant","stop_reason":null,"usage":{"input_tokens":100,"output_tokens":0}}}\n'
"\n"
'data: {"type":"content_block_start","index":0,"content_block":{"type":"text","text":""}}\n'
"\n"
'data: {"type":"content_block_delta","index":0,"delta":{"type":"text_delta","text":"Let me retrieve that."}}\n'
"\n"
'data: {"type":"content_block_stop","index":0}\n'
"\n"
'data: {"type":"content_block_start","index":1,"content_block":{"type":"tool_use","id":"toolu_abc","name":"headroom_retrieve"}}\n'
"\n"
'data: {"type":"content_block_delta","index":1,"delta":{"type":"input_json_delta","partial_json":"{\\"hash\\": \\"abc123\\"}"}}\n'
"\n"
'data: {"type":"content_block_stop","index":1}\n'
"\n"
'data: {"type":"message_delta","delta":{"stop_reason":"tool_use"},"usage":{"output_tokens":50}}\n'
)
proxy = HeadroomProxy.__new__(HeadroomProxy)
result = proxy._parse_sse_to_response(sse_data, "anthropic")
assert result is not None
assert len(result["content"]) == 2
text_block = result["content"][0]
assert text_block["type"] == "text"
assert "retrieve" in text_block["text"]
tool_block = result["content"][1]
assert tool_block["type"] == "tool_use"
assert tool_block["name"] == "headroom_retrieve"
assert tool_block["id"] == "toolu_abc"
assert tool_block["input"]["hash"] == "abc123"
def test_parse_sse_non_anthropic_returns_none(self):
"""Non-anthropic provider should return None."""
from headroom.proxy.server import HeadroomProxy
proxy = HeadroomProxy.__new__(HeadroomProxy)
result = proxy._parse_sse_to_response("data: {}", "openai")
assert result is None