Files
chopratejas--headroom/tests/test_shared_context.py
thejesh23 35701ce809 fix(shared_context): don't evict an unrelated entry on an update at capacity (#2136)
Fixes #2135.

## Summary

`SharedContext.put` ran `_evict_if_needed` before writing, and the
eviction loop only checked `len(self._entries) >= self._max_entries`.
When a caller updated a key that was already cached at capacity, the put
would not have grown the map — but the loop still dropped the oldest
unrelated entry.

Same defect class as fixed for `SemanticCache` in #2094: the eviction
path must know the incoming key so an update is not treated as an
insert. This mirrors that fix over to `SharedContext`.

Threads the incoming key through `_evict_if_needed` and skips capacity
eviction when it names an entry that already exists. Expired-entry
cleanup still runs unconditionally.

Issue #2135 has the reproduction and impact writeup.

## Test plan

- [x] `uv run pytest tests/test_shared_context.py` — 16 passed (added
`test_updating_existing_key_at_capacity_does_not_evict`).
- [x] `uv run ruff check headroom/shared_context.py
tests/test_shared_context.py` — clean.
- [x] `uv run ruff format --check headroom/shared_context.py
tests/test_shared_context.py` — already formatted.

## Real behavior proof

**Setup:** macOS 25.4 (Darwin arm64), Python 3.12.13, `uv 0.11.28`, this
branch (`fix/shared-context-evict-on-update`).

**Before the patch (unpatched `main`)**

\`\`\`
before update: ['a', 'b', 'c']
after update: ['b', 'c'] # <-- 'a' evicted, even though 'c' was an
update
\`\`\`

**After the patch (this branch)**

\`\`\`
\$ uv run python <<'PY'
from headroom.shared_context import SharedContext
ctx = SharedContext(ttl=3600, max_entries=3)
ctx.put(\"a\", \"x\"*400)
ctx.put(\"b\", \"x\"*400)
ctx.put(\"c\", \"x\"*400)
print(\"before update:\", sorted(ctx.keys()))
ctx.put(\"c\", \"y\"*400)   # update existing at capacity
print(\"after update: \", sorted(ctx.keys()))
print(\"c value:\", ctx.get(\"c\", full=True)[:12] + \"...\")
PY
before update: ['a', 'b', 'c']
after update:  ['a', 'b', 'c']
c value: yyyyyyyyyyyy...
\`\`\`

**Test output**

\`\`\`
\$ uv run pytest tests/test_shared_context.py -q
................ [100%]
16 passed in 2.17s
\`\`\`

**What I did NOT test**

- Multi-thread test — the fix is inside the existing `self._lock`, so
serialization semantics are unchanged; I did not add a concurrent-put
stress test.
- Interaction with TTL expiry AND capacity in one call — the existing
`test_evicts_oldest_at_capacity` and `test_expired_entry_returns_none`
still pass, but I did not add a combined case.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-authored-by: Tejas Chopra <chopratejas@gmail.com>
2026-07-13 19:57:32 -04:00

151 lines
4.7 KiB
Python

"""Tests for SharedContext — compressed inter-agent context sharing."""
from headroom.shared_context import SharedContext
class TestPutGet:
def test_put_and_get_compressed(self) -> None:
ctx = SharedContext()
content = " ".join(f"item_{i}: data value {i} with details" for i in range(100))
entry = ctx.put("research", content, agent="researcher")
assert entry.original_tokens > 0
assert entry.key == "research"
assert entry.agent == "researcher"
compressed = ctx.get("research")
assert compressed is not None
assert len(compressed) <= len(content)
def test_get_full(self) -> None:
ctx = SharedContext()
content = "short content that may not compress much"
ctx.put("data", content)
full = ctx.get("data", full=True)
assert full == content
def test_get_missing_key(self) -> None:
ctx = SharedContext()
assert ctx.get("nonexistent") is None
def test_overwrite_key(self) -> None:
ctx = SharedContext()
ctx.put("k", "first version")
ctx.put("k", "second version")
assert ctx.get("k", full=True) == "second version"
def test_get_entry_metadata(self) -> None:
ctx = SharedContext()
ctx.put("findings", "some data", agent="agent_a")
entry = ctx.get_entry("findings")
assert entry is not None
assert entry.agent == "agent_a"
assert entry.original_tokens >= 0
assert isinstance(entry.savings_percent, float)
def test_get_entry_missing(self) -> None:
ctx = SharedContext()
assert ctx.get_entry("missing") is None
class TestExpiry:
def test_expired_entry_returns_none(self) -> None:
ctx = SharedContext(ttl=0) # Expire immediately
ctx.put("k", "value")
import time
time.sleep(0.01)
assert ctx.get("k") is None
def test_expired_entry_cleaned_from_get_entry(self) -> None:
ctx = SharedContext(ttl=0)
ctx.put("k", "value")
import time
time.sleep(0.01)
assert ctx.get_entry("k") is None
class TestKeys:
def test_lists_active_keys(self) -> None:
ctx = SharedContext()
ctx.put("a", "data a")
ctx.put("b", "data b")
keys = ctx.keys()
assert "a" in keys
assert "b" in keys
def test_excludes_expired_keys(self) -> None:
ctx = SharedContext(ttl=0)
ctx.put("expired", "gone")
import time
time.sleep(0.01)
assert "expired" not in ctx.keys()
class TestStats:
def test_stats_aggregates(self) -> None:
ctx = SharedContext()
content = " ".join(f"word_{i}" for i in range(50))
ctx.put("a", content)
ctx.put("b", content)
stats = ctx.stats()
assert stats.entries == 2
assert stats.total_original_tokens > 0
def test_stats_empty(self) -> None:
ctx = SharedContext()
stats = ctx.stats()
assert stats.entries == 0
assert stats.savings_percent == 0.0
class TestEviction:
def test_evicts_oldest_at_capacity(self) -> None:
ctx = SharedContext(max_entries=2)
ctx.put("first", "data 1")
ctx.put("second", "data 2")
ctx.put("third", "data 3") # Should evict "first"
assert ctx.get("first") is None
assert ctx.get("second") is not None
assert ctx.get("third") is not None
def test_updating_existing_key_at_capacity_does_not_evict(self) -> None:
"""Overwriting an existing key at capacity must not evict an unrelated one.
Regression: ``_evict_if_needed`` runs before the assignment, so it
drops the oldest entry even when the ``put`` was going to overwrite
(not grow) the map — the size stays inside the cap without eviction.
Same class of bug as fixed for ``SemanticCache`` in #2094.
"""
ctx = SharedContext(max_entries=3)
ctx.put("a", "data a")
ctx.put("b", "data b")
ctx.put("c", "data c")
assert set(ctx.keys()) == {"a", "b", "c"}
# Update an existing key at capacity — must be a no-op for the others.
ctx.put("c", "data c UPDATED")
assert set(ctx.keys()) == {"a", "b", "c"}
assert ctx.get("c", full=True) == "data c UPDATED"
class TestClear:
def test_clear_removes_all(self) -> None:
ctx = SharedContext()
ctx.put("a", "x")
ctx.put("b", "y")
ctx.clear()
assert ctx.keys() == []
class TestImport:
def test_importable_from_headroom(self) -> None:
from headroom import SharedContext as SC
assert SC is not None
ctx = SC()
assert isinstance(ctx, SharedContext)