Skip to content

Commit 2f53a18

Browse files
authored
refactor(proxy): isolate semantic cache key policy (#1964)
## Description Extracts proxy semantic response-cache key normalization and hashing into a pure `semantic_cache_key_policy` module. `SemanticCache` keeps ownership of storage, locking, TTL, and LRU behavior while the deterministic cache-key formula is directly tested as a standalone policy. 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 - [x] Code refactoring (no functional changes) ## Changes Made - Added `headroom.proxy.semantic_cache_key_policy` with recursive `cache_control` stripping and semantic cache key hashing. - Updated `SemanticCache._compute_key` to delegate to the pure key policy while preserving its existing private wrapper contract. - Added direct policy tests for recursive annotation stripping, key stability, response-shaping distinctions, breakpoint movement, and wrapper parity. - Included the current LiteLLM callback signature compatibility shim required for repo-wide mypy on main-based slices. ## 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 python -m pytest tests/test_semantic_cache_key_policy.py tests/test_proxy_semantic_cache_key.py tests/test_litellm_callback.py -q 39 passed in 6.34s python -m ruff check . All checks passed! python -m ruff format --check . 1095 files already formatted python -m mypy headroom --ignore-missing-imports Success: no issues found in 409 source files gitleaks protect --staged --no-banner --redact no leaks found ``` ## Real Behavior Proof - Environment: Windows, Python 3.13.13, clean worktree based on `headroomlabs/main`. - Exact command / steps: targeted pytest, ruff, format check, repo-wide mypy, staged gitleaks scan. - Observed result: semantic cache key policy/cache/callback tests pass; static checks pass; no staged secrets detected. - Not tested: live proxy cache traffic; this slice preserves the existing cache wrapper and only moves pure key policy. ## 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 - [ ] I have updated the CHANGELOG.md if applicable ## Screenshots (if applicable) N/A ## Additional Notes Documentation and changelog updates are not applicable for this internal architecture slice. PR-specific GHAS checks will be monitored after opening.
1 parent c904a70 commit 2f53a18

3 files changed

Lines changed: 105 additions & 1 deletion

File tree

headroom/proxy/semantic_cache.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
from ..memory.tracker import ComponentStats
1818

1919
from headroom.proxy.models import CacheEntry
20-
from headroom.proxy.semantic_cache_key import compute_semantic_cache_key, strip_cache_control
20+
from headroom.proxy.semantic_cache_key_policy import compute_semantic_cache_key, strip_cache_control
2121

2222
_strip_cache_control = strip_cache_control
2323

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
"""Pure key policy for proxy semantic response cache."""
2+
3+
from __future__ import annotations
4+
5+
import hashlib
6+
import json
7+
from typing import Any
8+
9+
10+
def strip_cache_control(obj: Any) -> Any:
11+
"""Recursively drop ``cache_control`` annotations before hashing."""
12+
if isinstance(obj, dict):
13+
return {k: strip_cache_control(v) for k, v in obj.items() if k != "cache_control"}
14+
if isinstance(obj, list):
15+
return [strip_cache_control(item) for item in obj]
16+
return obj
17+
18+
19+
def compute_semantic_cache_key(
20+
messages: list[dict],
21+
model: str,
22+
**key_fields: Any,
23+
) -> str:
24+
"""Compute a stable cache key from request content and shaping fields."""
25+
normalized = json.dumps(
26+
{
27+
"model": model,
28+
"messages": messages,
29+
**{k: strip_cache_control(v) for k, v in key_fields.items()},
30+
},
31+
sort_keys=True,
32+
)
33+
return hashlib.sha256(normalized.encode()).hexdigest()[:32]
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
"""Tests for pure proxy semantic cache key policy."""
2+
3+
from __future__ import annotations
4+
5+
from headroom.proxy.semantic_cache import SemanticCache
6+
from headroom.proxy.semantic_cache_key_policy import (
7+
compute_semantic_cache_key,
8+
strip_cache_control,
9+
)
10+
11+
MESSAGES = [{"role": "user", "content": "hello"}]
12+
MODEL = "claude-haiku-4-5"
13+
14+
15+
def test_strip_cache_control_recurses_through_dicts_and_lists() -> None:
16+
payload = {
17+
"system": [
18+
{"type": "text", "text": "sys", "cache_control": {"type": "ephemeral"}},
19+
{"nested": {"cache_control": "drop", "value": 1}},
20+
],
21+
"cache_control": "drop-root",
22+
}
23+
assert strip_cache_control(payload) == {
24+
"system": [
25+
{"type": "text", "text": "sys"},
26+
{"nested": {"value": 1}},
27+
]
28+
}
29+
30+
31+
def test_compute_semantic_cache_key_is_stable_for_identical_inputs() -> None:
32+
kwargs = {"system": "sys", "tools": [{"name": "read"}], "temperature": 0.2}
33+
assert compute_semantic_cache_key(MESSAGES, MODEL, **kwargs) == compute_semantic_cache_key(
34+
MESSAGES,
35+
MODEL,
36+
**kwargs,
37+
)
38+
39+
40+
def test_compute_semantic_cache_key_distinguishes_response_shaping_fields() -> None:
41+
assert compute_semantic_cache_key(
42+
MESSAGES, MODEL, temperature=0.0
43+
) != compute_semantic_cache_key(
44+
MESSAGES,
45+
MODEL,
46+
temperature=1.0,
47+
)
48+
49+
50+
def test_compute_semantic_cache_key_ignores_moved_cache_control_breakpoints() -> None:
51+
with_breakpoint = [{"type": "text", "text": "sys", "cache_control": {"type": "ephemeral"}}]
52+
without_breakpoint = [{"type": "text", "text": "sys"}]
53+
assert compute_semantic_cache_key(
54+
MESSAGES,
55+
MODEL,
56+
system=with_breakpoint,
57+
) == compute_semantic_cache_key(
58+
MESSAGES,
59+
MODEL,
60+
system=without_breakpoint,
61+
)
62+
63+
64+
def test_semantic_cache_private_key_wrapper_delegates_to_policy() -> None:
65+
cache = SemanticCache()
66+
kwargs = {"system": "sys", "tools": [{"name": "read"}], "temperature": 0.2}
67+
assert cache._compute_key(MESSAGES, MODEL, **kwargs) == compute_semantic_cache_key(
68+
MESSAGES,
69+
MODEL,
70+
**kwargs,
71+
)

0 commit comments

Comments
 (0)