headroom/tests/test_ccr_response_handler.py

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

749 lines
24 KiB
Python
Raw Permalink Normal View History

"""Tests for CCR response handler.
These tests verify that:
1. CCR tool calls are correctly detected in responses
2. Retrieval execution works for both full and search modes
3. Continuation flow handles multiple rounds
4. Provider-specific formats are handled correctly
5. Streaming buffer detection works
"""
import json
import pytest
from headroom.cache.compression_store import (
get_compression_store,
reset_compression_store,
)
from headroom.ccr.response_handler import (
CCRResponseHandler,
CCRToolCall,
CCRToolResult,
ResponseHandlerConfig,
StreamingCCRBuffer,
)
from headroom.ccr.tool_injection import CCR_TOOL_NAME
class TestCCRToolCallDetection:
"""Test detection of CCR tool calls in responses."""
@pytest.fixture(autouse=True)
def reset_store(self):
"""Reset global store before each test."""
reset_compression_store()
yield
reset_compression_store()
def test_detect_anthropic_ccr_tool_call(self):
"""Detect CCR tool call in Anthropic format."""
handler = CCRResponseHandler()
response = {
"content": [
{"type": "text", "text": "Let me retrieve that data."},
{
"type": "tool_use",
"id": "tool_123",
"name": CCR_TOOL_NAME,
"input": {"hash": "abc123"},
},
]
}
assert handler.has_ccr_tool_calls(response, "anthropic")
def test_detect_openai_ccr_tool_call(self):
"""Detect CCR tool call in OpenAI format."""
handler = CCRResponseHandler()
response = {
"choices": [
{
"message": {
"role": "assistant",
"content": "Let me retrieve that data.",
"tool_calls": [
{
"id": "call_123",
"type": "function",
"function": {
"name": CCR_TOOL_NAME,
"arguments": '{"hash": "abc123"}',
},
}
],
}
}
]
}
assert handler.has_ccr_tool_calls(response, "openai")
def test_no_ccr_tool_call_anthropic(self):
"""No false positive when no CCR tool call present."""
handler = CCRResponseHandler()
response = {
"content": [
{"type": "text", "text": "Here is the data."},
{
"type": "tool_use",
"id": "tool_123",
"name": "some_other_tool",
"input": {"param": "value"},
},
]
}
assert not handler.has_ccr_tool_calls(response, "anthropic")
def test_no_ccr_tool_call_openai(self):
"""No false positive when no CCR tool call present in OpenAI format."""
handler = CCRResponseHandler()
response = {
"choices": [
{
"message": {
"role": "assistant",
"content": "Here is the data.",
"tool_calls": [
{
"id": "call_123",
"type": "function",
"function": {
"name": "other_tool",
"arguments": '{"param": "value"}',
},
}
],
}
}
]
}
assert not handler.has_ccr_tool_calls(response, "openai")
def test_text_only_response(self):
"""No false positive for text-only responses."""
handler = CCRResponseHandler()
response = {"content": [{"type": "text", "text": "Just plain text."}]}
assert not handler.has_ccr_tool_calls(response, "anthropic")
def test_empty_response(self):
"""Handle empty response gracefully."""
handler = CCRResponseHandler()
assert not handler.has_ccr_tool_calls({}, "anthropic")
assert not handler.has_ccr_tool_calls({"content": []}, "anthropic")
class TestCCRToolCallParsing:
"""Test parsing of CCR tool calls."""
def test_parse_anthropic_full_retrieval(self):
"""Parse full retrieval call from Anthropic format."""
handler = CCRResponseHandler()
response = {
"content": [
{
"type": "tool_use",
"id": "tool_123",
"name": CCR_TOOL_NAME,
"input": {"hash": "abc123def456abc123def456"},
}
]
}
ccr_calls, other_calls = handler._parse_ccr_tool_calls(response, "anthropic")
assert len(ccr_calls) == 1
assert ccr_calls[0].tool_call_id == "tool_123"
assert ccr_calls[0].hash_key == "abc123def456abc123def456"
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
assert not hasattr(ccr_calls[0], "query")
assert len(other_calls) == 0
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
def test_parse_anthropic_retrieval_ignores_query(self):
"""Retrieval parses the hash; any legacy ``query`` input is ignored."""
handler = CCRResponseHandler()
response = {
"content": [
{
"type": "tool_use",
"id": "tool_456",
"name": CCR_TOOL_NAME,
"input": {"hash": "def456abc123def456abc123", "query": "authentication error"},
}
]
}
ccr_calls, other_calls = handler._parse_ccr_tool_calls(response, "anthropic")
assert len(ccr_calls) == 1
assert ccr_calls[0].hash_key == "def456abc123def456abc123"
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
assert not hasattr(ccr_calls[0], "query")
def test_parse_mixed_tool_calls(self):
"""Parse response with both CCR and other tool calls."""
handler = CCRResponseHandler()
response = {
"content": [
{
"type": "tool_use",
"id": "tool_1",
"name": CCR_TOOL_NAME,
"input": {"hash": "abc123def456abc123def456"},
},
{
"type": "tool_use",
"id": "tool_2",
"name": "read_file",
"input": {"path": "/etc/config"},
},
]
}
ccr_calls, other_calls = handler._parse_ccr_tool_calls(response, "anthropic")
assert len(ccr_calls) == 1
assert len(other_calls) == 1
assert other_calls[0]["name"] == "read_file"
class TestCCRRetrievalExecution:
"""Test CCR retrieval execution."""
@pytest.fixture(autouse=True)
def reset_store(self):
"""Reset global store before each test."""
reset_compression_store()
yield
reset_compression_store()
def test_full_retrieval_success(self):
"""Successfully retrieve full content."""
store = get_compression_store()
original = json.dumps([{"id": i} for i in range(100)])
compressed = json.dumps([{"id": i} for i in range(10)])
hash_key = store.store(
original=original,
compressed=compressed,
original_item_count=100,
compressed_item_count=10,
)
handler = CCRResponseHandler()
call = CCRToolCall(tool_call_id="test_id", hash_key=hash_key)
result = handler._execute_retrieval(call)
assert result.success
assert result.items_retrieved == 100
# Check content structure
content = json.loads(result.content)
assert content["hash"] == hash_key
assert "original_content" in content
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
def test_retrieval_returns_full_content_for_cached_hash(self):
"""Retrieval always returns the full original content (never empty)."""
store = get_compression_store()
items = [
{"id": 1, "text": "Python programming language tutorial"},
{"id": 2, "text": "JavaScript web development framework"},
{"id": 3, "text": "Python data science machine learning"},
{"id": 4, "text": "Ruby programming language basics"},
{"id": 5, "text": "Python web framework django flask"},
]
original = json.dumps(items)
compressed = json.dumps(items[:1])
hash_key = store.store(
original=original,
compressed=compressed,
original_item_count=5,
compressed_item_count=1,
)
handler = CCRResponseHandler()
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
call = CCRToolCall(tool_call_id="test_id", hash_key=hash_key)
result = handler._execute_retrieval(call)
assert result.success
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
assert result.items_retrieved == 5
content = json.loads(result.content)
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
assert content["hash"] == hash_key
# Full content is always returned — the complete original round-trips.
assert json.loads(content["original_content"]) == items
def test_retrieval_nonexistent_hash(self):
"""Handle retrieval of nonexistent hash."""
handler = CCRResponseHandler()
call = CCRToolCall(tool_call_id="test_id", hash_key="nonexistent123")
result = handler._execute_retrieval(call)
assert not result.success
assert result.items_retrieved == 0
content = json.loads(result.content)
assert "error" in content
class TestCCRToolResultMessage:
"""Test tool result message creation."""
def test_anthropic_tool_result_format(self):
"""Create tool result message in Anthropic format."""
handler = CCRResponseHandler()
results = [
CCRToolResult(
tool_call_id="tool_123",
content='{"data": "retrieved"}',
success=True,
items_retrieved=10,
)
]
message = handler._create_tool_result_message(results, "anthropic")
assert message["role"] == "user"
assert len(message["content"]) == 1
assert message["content"][0]["type"] == "tool_result"
assert message["content"][0]["tool_use_id"] == "tool_123"
def test_openai_tool_result_format(self):
"""Create tool result messages in OpenAI format."""
handler = CCRResponseHandler()
results = [
CCRToolResult(
tool_call_id="call_123",
content='{"data": "retrieved"}',
success=True,
),
CCRToolResult(
tool_call_id="call_456",
content='{"data": "more data"}',
success=True,
),
]
message = handler._create_tool_result_message(results, "openai")
assert "_openai_tool_results" in message
assert len(message["_openai_tool_results"]) == 2
assert message["_openai_tool_results"][0]["role"] == "tool"
class TestCCRResponseHandling:
"""Test the full response handling flow."""
@pytest.fixture(autouse=True)
def reset_store(self):
"""Reset global store before each test."""
reset_compression_store()
yield
reset_compression_store()
@pytest.mark.asyncio
async def test_handle_response_no_ccr(self):
"""Handle response with no CCR calls (pass-through)."""
handler = CCRResponseHandler()
response = {"content": [{"type": "text", "text": "Just text."}]}
async def mock_api_call(messages, tools):
return {"content": [{"type": "text", "text": "Response"}]}
result = await handler.handle_response(response, [], None, mock_api_call, "anthropic")
# Should return original response unchanged
assert result == response
@pytest.mark.asyncio
async def test_handle_response_with_ccr(self):
"""Handle response containing CCR tool call."""
store = get_compression_store()
original = json.dumps([{"id": i} for i in range(50)])
hash_key = store.store(
original=original,
compressed="[]",
original_item_count=50,
)
handler = CCRResponseHandler()
# Initial response with CCR tool call
initial_response = {
"content": [
{"type": "text", "text": "Let me get that data."},
{
"type": "tool_use",
"id": "tool_123",
"name": CCR_TOOL_NAME,
"input": {"hash": hash_key},
},
]
}
# Final response after tool result
final_response = {"content": [{"type": "text", "text": "Here is all 50 items of data."}]}
call_count = 0
async def mock_api_call(messages, tools):
nonlocal call_count
call_count += 1
return final_response
result = await handler.handle_response(
initial_response,
[{"role": "user", "content": "Get me the data"}],
None,
mock_api_call,
"anthropic",
)
# Should have made continuation call
assert call_count == 1
# Should return final response
assert result == final_response
@pytest.mark.asyncio
async def test_handle_response_max_rounds(self):
"""Respects max retrieval rounds limit."""
store = get_compression_store()
hash_key = store.store(original="[1,2,3]", compressed="[]")
config = ResponseHandlerConfig(max_retrieval_rounds=2)
handler = CCRResponseHandler(config)
# Response that always has CCR tool call (simulating infinite loop)
ccr_response = {
"content": [
{
"type": "tool_use",
"id": "tool_123",
"name": CCR_TOOL_NAME,
"input": {"hash": hash_key},
}
]
}
call_count = 0
async def mock_api_call(messages, tools):
nonlocal call_count
call_count += 1
return ccr_response
await handler.handle_response(ccr_response, [], None, mock_api_call, "anthropic")
# Should stop after max rounds
assert call_count == 2
@pytest.mark.asyncio
async def test_handle_response_disabled(self):
"""Disabled handler returns response unchanged."""
config = ResponseHandlerConfig(enabled=False)
handler = CCRResponseHandler(config)
response = {
"content": [
{
"type": "tool_use",
"id": "tool_123",
"name": CCR_TOOL_NAME,
"input": {"hash": "abc123"},
}
]
}
async def mock_api_call(messages, tools):
raise AssertionError("Should not be called")
result = await handler.handle_response(response, [], None, mock_api_call, "anthropic")
assert result == response
fix(ccr): skip CCR when model calls headroom_retrieve alongside user tools (#839) ## Summary - When the LLM calls `headroom_retrieve` **and** a non-CCR tool (e.g. `read_file`) in the same turn, the previous code attempted a continuation with only the CCR result - Anthropic requires every `tool_use` block to have a matching `tool_result` — the continuation was rejected with 400, a round-trip was wasted, and the original response (with unresolved `headroom_retrieve`) was returned anyway - Fix: if `other_calls` is non-empty alongside `ccr_calls`, log a warning and return the original response immediately — no continuation attempted ## Root cause `_parse_ccr_tool_calls` correctly separates CCR and non-CCR calls, but `handle_response` never checked `other_calls` before building the continuation. `_create_tool_result_message` only adds results for CCR calls, leaving the non-CCR `tool_use` blocks without matching `tool_result` entries. ## Files changed - `headroom/ccr/response_handler.py` — guard at top of `while` loop in `handle_response` - `tests/test_ccr_response_handler.py` — regression test: asserts `api_call_count == 0` and original response returned unchanged when model uses mixed tools ## Test plan - [x] `pytest tests/test_ccr_response_handler.py::TestCCRResponseHandling::test_handle_response_mixed_tools_skips_ccr` — passes - [x] `pytest tests/test_ccr_response_handler.py tests/test_ccr_response_handler_extra.py tests/test_ccr_tool_injection.py tests/test_ccr_tool_always_on.py` — 85 passed - [x] Pre-commit hooks (ruff, mypy) — clean 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-10 19:12:26 -07:00
@pytest.mark.asyncio
async def test_handle_response_mixed_tools_skips_ccr(self):
"""When CCR and non-CCR tools are called together, skip CCR.
Building a valid continuation is impossible without results for the
non-CCR tools (Anthropic requires every tool_use to have a
tool_result). Skipping CCR avoids a wasted 400 API call and returns
the original response immediately so the client can resolve all
tool calls itself.
"""
store = get_compression_store()
hash_key = store.store(original="[1,2,3]", compressed="[]")
handler = CCRResponseHandler()
mixed_response = {
"content": [
{
"type": "tool_use",
"id": "ccr_call",
"name": CCR_TOOL_NAME,
"input": {"hash": hash_key},
},
{
"type": "tool_use",
"id": "user_call",
"name": "read_file",
"input": {"path": "/etc/config"},
},
]
}
api_call_count = 0
async def mock_api_call(messages, tools):
nonlocal api_call_count
api_call_count += 1
return {"content": [{"type": "text", "text": "continuation"}]}
result = await handler.handle_response(mixed_response, [], None, mock_api_call, "anthropic")
# CCR skipped — no continuation call made (avoids the 400 API round-trip)
assert api_call_count == 0, "should not attempt continuation with mixed tools"
# Original response returned unchanged so client can handle all tool calls
assert result is mixed_response
class TestCCRResponseHandlerStats:
"""Test handler statistics."""
@pytest.fixture(autouse=True)
def reset_store(self):
"""Reset global store before each test."""
reset_compression_store()
yield
reset_compression_store()
@pytest.mark.asyncio
async def test_retrieval_count_tracking(self):
"""Track total retrieval count."""
store = get_compression_store()
hash_key = store.store(original="[1,2,3]", compressed="[]")
handler = CCRResponseHandler()
initial_response = {
"content": [
{
"type": "tool_use",
"id": "tool_123",
"name": CCR_TOOL_NAME,
"input": {"hash": hash_key},
}
]
}
final_response = {"content": [{"type": "text", "text": "Done"}]}
async def mock_api_call(messages, tools):
return final_response
await handler.handle_response(initial_response, [], None, mock_api_call, "anthropic")
stats = handler.get_stats()
assert stats["total_retrievals"] == 1
class TestStreamingCCRBuffer:
"""Test streaming buffer for CCR detection."""
def test_buffer_accumulation(self):
"""Buffer accumulates chunks."""
buffer = StreamingCCRBuffer()
buffer.add_chunk(b"part1")
buffer.add_chunk(b"part2")
buffer.add_chunk(b"part3")
assert buffer.get_accumulated() == b"part1part2part3"
def test_detect_ccr_tool_in_stream(self):
"""Detect CCR tool call in streaming chunks."""
buffer = StreamingCCRBuffer()
# Simulate streaming response with tool_use
chunk1 = b'{"type":"content_block_start","content_block":{"type":"tool_use"'
chunk2 = f',"name":"{CCR_TOOL_NAME}"'.encode()
detected = buffer.add_chunk(chunk1)
assert not detected # Not complete yet
detected = buffer.add_chunk(chunk2)
assert detected # Now detected
assert buffer.detected_ccr
def test_no_false_positive_detection(self):
"""No false positive for non-CCR tool calls."""
buffer = StreamingCCRBuffer()
chunk = b'{"type":"content_block_start","content_block":{"type":"tool_use","name":"other_tool"}}'
detected = buffer.add_chunk(chunk)
assert not detected
assert not buffer.detected_ccr
def test_buffer_clear(self):
"""Buffer clears state correctly."""
buffer = StreamingCCRBuffer()
buffer.add_chunk(b"data")
buffer.detected_ccr = True
buffer.clear()
assert buffer.get_accumulated() == b""
assert not buffer.detected_ccr
class TestResponseHandlerConfig:
"""Test response handler configuration."""
def test_default_config(self):
"""Default config values."""
config = ResponseHandlerConfig()
assert config.enabled is True
assert config.max_retrieval_rounds == 3
assert config.strip_ccr_from_response is True
assert config.continuation_timeout_ms == 120000
def test_custom_config(self):
"""Custom config values."""
config = ResponseHandlerConfig(
enabled=False,
max_retrieval_rounds=5,
)
assert config.enabled is False
assert config.max_retrieval_rounds == 5
class TestCCRToolCallDataClass:
"""Test CCRToolCall dataclass."""
def test_full_retrieval_call(self):
"""Create full retrieval call."""
call = CCRToolCall(
tool_call_id="test_123",
hash_key="abc123",
)
assert call.tool_call_id == "test_123"
assert call.hash_key == "abc123"
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
assert not hasattr(call, "query")
class TestCCRToolResultDataClass:
"""Test CCRToolResult dataclass."""
def test_successful_result(self):
"""Create successful result."""
result = CCRToolResult(
tool_call_id="test_123",
content='{"data": "content"}',
success=True,
items_retrieved=50,
)
assert result.success
assert result.items_retrieved == 50
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
assert not hasattr(result, "was_search")
def test_failed_result(self):
"""Create failed result."""
result = CCRToolResult(
tool_call_id="test_789",
content='{"error": "not found"}',
success=False,
)
assert not result.success
assert result.items_retrieved == 0
class TestExtractAssistantMessage:
"""Test extraction of assistant messages from responses."""
def test_extract_anthropic_message(self):
"""Extract assistant message from Anthropic response."""
handler = CCRResponseHandler()
response = {
"content": [
{"type": "text", "text": "Hello"},
{"type": "tool_use", "id": "123", "name": "test", "input": {}},
]
}
message = handler._extract_assistant_message(response, "anthropic")
assert message["role"] == "assistant"
assert message["content"] == response["content"]
def test_extract_openai_message(self):
"""Extract assistant message from OpenAI response."""
handler = CCRResponseHandler()
response = {
"choices": [
{
"message": {
"role": "assistant",
"content": "Hello",
"tool_calls": [{"id": "123"}],
}
}
]
}
message = handler._extract_assistant_message(response, "openai")
assert message["role"] == "assistant"
assert message["content"] == "Hello"
assert message["tool_calls"] == [{"id": "123"}]
fix(ccr): guard empty/malformed OpenAI choices in _extract_assistant_message (#2389) ## Description `CCRResponseHandler._extract_assistant_message` extracts the assistant message from an upstream response while building the CCR retrieval-continuation history. The OpenAI branch is not defensive about an empty or malformed `choices` array: ```python elif provider == "openai": message = response.get("choices", [{}])[0].get("message", {}) ``` `response.get("choices", [{}])` only falls back to `[{}]` when the key is **absent**. When `choices` is present but empty (`[]`) or carries a null first element (`[null]`), this raises on the success path: - `choices: []` → `[][0]` → `IndexError` - `choices: [null]` → `None.get(...)` → `AttributeError` OpenAI-compatible gateways can return those shapes on content-filtered or usage-only responses. The sibling **Google** branch a few lines below already guards this (`candidates = response.get("candidates", []); if candidates: ... else: parts = []`), and so does `ccr/tool_calls.py` (it checks `isinstance(choices, list)`, non-empty, and `isinstance(first_choice, dict)`). Only this OpenAI branch was missed. ## Fix Guard the list and the first element the same way the siblings do: ```python elif provider == "openai": choices = response.get("choices") first = choices[0] if isinstance(choices, list) and choices else {} message = first.get("message", {}) if isinstance(first, dict) else {} return { "role": "assistant", "content": message.get("content"), "tool_calls": message.get("tool_calls"), } ``` A well-formed response is unaffected; an empty/null/absent `choices` now yields `{"role": "assistant", "content": None, "tool_calls": None}` instead of raising. ## 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 - `headroom/ccr/response_handler.py`: guard empty/non-list `choices` and a non-dict first element in the OpenAI branch of `_extract_assistant_message`. - `tests/test_ccr_response_handler.py`: add `TestExtractAssistantMessageEdgeCases` (empty `choices`, `[null]`, absent, and the normal case). - `CHANGELOG.md`: Bug Fixes entry. ## Testing - [x] Unit tests pass (`pytest`) - [x] Linting passes (`ruff check .`) - [x] Type checking passes (`mypy headroom`) - [x] New tests added for new functionality - [ ] Manual testing performed ### Test Output ```text $ uvx ruff@0.15.17 check headroom/ccr/response_handler.py tests/test_ccr_response_handler.py All checks passed! $ uvx ruff@0.15.17 format --check headroom/ccr/response_handler.py tests/test_ccr_response_handler.py 2 files already formatted # Verified against the REAL imported module (headroom.ccr.response_handler is # light — no ML imports), so this ran locally in the project venv: $ python -c "from headroom.ccr.response_handler import CCRResponseHandler as H; h=H(); \ assert h._extract_assistant_message({'choices': []}, 'openai') == {'role':'assistant','content':None,'tool_calls':None}" # (no IndexError; normal case still extracts content/tool_calls) ``` ## Real Behavior Proof - Environment: Windows 11, Python 3.12, project venv (`uv sync --extra proxy`), `uvx ruff@0.15.17`. - Exact command / steps: imported the real `CCRResponseHandler` and called `_extract_assistant_message` with `{"choices": []}`, `{"choices": [null]}`, `{}` (absent), and a normal `{"choices": [{"message": {...}}]}`. - Observed result: the OLD code raised `IndexError` on `[]` and `AttributeError` on `[null]`; the NEW code returns `{"role": "assistant", "content": None, "tool_calls": None}` for all three malformed shapes and still extracts `content`/`tool_calls` from a well-formed response. Because `response_handler` has no ML imports, this ran against the actual module, not a replica. - Not tested: a live CCR retrieval round trip through a gateway that emits empty choices; the added unit tests drive `_extract_assistant_message` directly. ## 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 with my changes - [x] I have updated the CHANGELOG.md if applicable ## Additional Notes `headroom/ccr/response_handler.py` is a light module (no ML imports), so unlike most of my recent PRs I verified the fix by importing the real class in the project venv (output above), in addition to the added unit tests. This aligns the OpenAI branch with the already-defensive Google branch and `ccr/tool_calls.py`.
2026-07-19 05:17:59 +05:30
class TestExtractAssistantMessageEdgeCases:
"""Regression: `_extract_assistant_message` must not crash on an empty or
malformed OpenAI `choices` array (OpenAI-compatible gateways can send
`choices: []` or `[null]` on content-filtered / usage-only responses)."""
def test_openai_empty_choices_does_not_crash(self):
handler = CCRResponseHandler()
msg = handler._extract_assistant_message({"choices": []}, "openai")
assert msg == {"role": "assistant", "content": None, "tool_calls": None}
def test_openai_null_first_choice_does_not_crash(self):
handler = CCRResponseHandler()
msg = handler._extract_assistant_message({"choices": [None]}, "openai")
assert msg == {"role": "assistant", "content": None, "tool_calls": None}
def test_openai_absent_choices_does_not_crash(self):
handler = CCRResponseHandler()
msg = handler._extract_assistant_message({}, "openai")
assert msg == {"role": "assistant", "content": None, "tool_calls": None}
def test_openai_normal_choice_still_extracts(self):
handler = CCRResponseHandler()
resp = {"choices": [{"message": {"content": "hi", "tool_calls": [{"id": "1"}]}}]}
msg = handler._extract_assistant_message(resp, "openai")
assert msg == {"role": "assistant", "content": "hi", "tool_calls": [{"id": "1"}]}