Files
chopratejas--headroom/tests/test_compression_policy_toin_gate.py
wehub-resource-sync 0ef5fcb1c5
Security / Dependency audit (pip-audit) (push) Has been cancelled
Security / CodeQL (javascript-typescript) (push) Has been cancelled
Security / CodeQL (python) (push) Has been cancelled
Security / Secret scan (gitleaks) (push) Has been cancelled
rust / test (ubuntu) (push) Has been cancelled
rust / simulator e2e (macos-latest) (push) Has been cancelled
rust / simulator e2e (ubuntu-latest) (push) Has been cancelled
rust / simulator e2e (windows-latest) (push) Has been cancelled
rust / wheels (aarch64-apple-darwin) (push) Has been cancelled
rust / wheels (x86_64-unknown-linux-gnu) (push) Has been cancelled
rust / wheels (x86_64-apple-darwin) (push) Has been cancelled
rust / audit (push) Has been cancelled
rust / parity (nightly, allowed to fail during Phase 0) (push) Has been cancelled
CI / commitlint (push) Has been skipped
Dev Containers / validate (.devcontainer/devcontainer.json, default) (push) Failing after 0s
Dev Containers / validate (.devcontainer/memory-stack/devcontainer.json, memory-stack) (push) Failing after 0s
Dev Containers / validate-worktree (push) Failing after 0s
CI / changes (push) Failing after 4s
Deploy Documentation / validate (push) Has been skipped
Deploy Documentation / deploy (push) Failing after 1s
Init Native E2E / init-native (ubuntu-latest, claude) (push) Failing after 1s
Init Native E2E / init-native (ubuntu-latest, codex) (push) Failing after 1s
Install Native E2E / install-native (ubuntu-latest) (push) Failing after 1s
OpenCode Plugin / typecheck + build + test (push) Failing after 1s
Init Native E2E / init-native (ubuntu-latest, copilot) (push) Failing after 1s
Release Please / release-please (push) Failing after 1s
Wrap E2E / docker-wrap-e2e (push) Failing after 1s
Wrap Native E2E / wrap-native (ubuntu-latest) (push) Failing after 1s
Init E2E / docker-init-e2e (push) Failing after 4s
Merge Conflicts / merge-conflicts (push) Failing after 4s
CI / lint (push) Has been cancelled
CI / build-wheel (push) Has been cancelled
CI / build-wheel-windows (push) Has been cancelled
CI / prefetch-model (push) Has been cancelled
CI / test-dashboard-ui (push) Has been cancelled
CI / test (1) (push) Has been cancelled
CI / test (2) (push) Has been cancelled
CI / test (3) (push) Has been cancelled
CI / test (4) (push) Has been cancelled
CI / test-extras (push) Has been cancelled
CI / test-agno (push) Has been cancelled
CI / build (push) Has been cancelled
CI / workflow-validation (push) Has been cancelled
CI / docker-native-e2e (push) Has been cancelled
CI / windows-native-wrapper (push) Has been cancelled
CI / macos-native-wrapper (push) Has been cancelled
Docker / docker-build (map[name:arm64 platform:linux/arm64 runs_on:ubuntu-24.04-arm], map[bake_target:runtime-code-nonroot name:code-nonroot]) (push) Has been cancelled
Docker / docker-build (map[name:arm64 platform:linux/arm64 runs_on:ubuntu-24.04-arm], map[bake_target:runtime-code-slim name:code-slim]) (push) Has been cancelled
Docker / docker-build (map[name:arm64 platform:linux/arm64 runs_on:ubuntu-24.04-arm], map[bake_target:runtime-code-slim-nonroot name:code-slim-nonroot]) (push) Has been cancelled
Docker / docker-build (map[name:arm64 platform:linux/arm64 runs_on:ubuntu-24.04-arm], map[bake_target:runtime-nonroot name:nonroot]) (push) Has been cancelled
Docker / docker-build (map[name:arm64 platform:linux/arm64 runs_on:ubuntu-24.04-arm], map[bake_target:runtime-slim name:slim]) (push) Has been cancelled
Docker / docker-build (map[name:arm64 platform:linux/arm64 runs_on:ubuntu-24.04-arm], map[bake_target:runtime-slim-nonroot name:slim-nonroot]) (push) Has been cancelled
Docker / docker-manifest (map[bake_target:runtime name:]) (push) Has been cancelled
Docker / docker-manifest (map[bake_target:runtime-code name:code]) (push) Has been cancelled
Docker / docker-manifest (map[bake_target:runtime-code-nonroot name:code-nonroot]) (push) Has been cancelled
Docker / docker-manifest (map[bake_target:runtime-code-slim name:code-slim]) (push) Has been cancelled
Docker / docker-manifest (map[bake_target:runtime-code-slim-nonroot name:code-slim-nonroot]) (push) Has been cancelled
Docker / docker-manifest (map[bake_target:runtime-nonroot name:nonroot]) (push) Has been cancelled
Docker / docker-manifest (map[bake_target:runtime-slim name:slim]) (push) Has been cancelled
Docker / docker-manifest (map[bake_target:runtime-slim-nonroot name:slim-nonroot]) (push) Has been cancelled
Docker / docker-build (map[name:amd64 platform:linux/amd64 runs_on:ubuntu-24.04], map[bake_target:runtime name:]) (push) Has been cancelled
Docker / docker-build (map[name:amd64 platform:linux/amd64 runs_on:ubuntu-24.04], map[bake_target:runtime-code name:code]) (push) Has been cancelled
Docker / docker-build (map[name:amd64 platform:linux/amd64 runs_on:ubuntu-24.04], map[bake_target:runtime-code-nonroot name:code-nonroot]) (push) Has been cancelled
Docker / docker-build (map[name:amd64 platform:linux/amd64 runs_on:ubuntu-24.04], map[bake_target:runtime-code-slim name:code-slim]) (push) Has been cancelled
Docker / docker-build (map[name:amd64 platform:linux/amd64 runs_on:ubuntu-24.04], map[bake_target:runtime-code-slim-nonroot name:code-slim-nonroot]) (push) Has been cancelled
Docker / docker-build (map[name:amd64 platform:linux/amd64 runs_on:ubuntu-24.04], map[bake_target:runtime-nonroot name:nonroot]) (push) Has been cancelled
Docker / docker-build (map[name:amd64 platform:linux/amd64 runs_on:ubuntu-24.04], map[bake_target:runtime-slim name:slim]) (push) Has been cancelled
Docker / docker-build (map[name:amd64 platform:linux/amd64 runs_on:ubuntu-24.04], map[bake_target:runtime-slim-nonroot name:slim-nonroot]) (push) Has been cancelled
Docker / docker-build (map[name:arm64 platform:linux/arm64 runs_on:ubuntu-24.04-arm], map[bake_target:runtime name:]) (push) Has been cancelled
Docker / docker-build (map[name:arm64 platform:linux/arm64 runs_on:ubuntu-24.04-arm], map[bake_target:runtime-code name:code]) (push) Has been cancelled
Docker / promote-latest (push) Has been cancelled
Init Native E2E / init-native (macos-latest, claude) (push) Has been cancelled
Init Native E2E / init-native (macos-latest, codex) (push) Has been cancelled
Init Native E2E / init-native (macos-latest, copilot) (push) Has been cancelled
Install Native E2E / install-native (macos-latest) (push) Has been cancelled
Wrap Native E2E / wrap-native (macos-latest) (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 12:03:20 +08:00

290 lines
11 KiB
Python

"""F2.2: TOIN write-gate tests for the per-mode CompressionPolicy.
When ``CompressionPolicy.toin_read_only`` is ``True`` (Subscription
auth mode), TOIN must serve cached recommendations but NEVER write new
pattern observations from this request. PAYG / OAuth keep writing so
the network effect keeps growing. The gate is read at the
``record_compression`` call site in ``smart_crusher.py`` and
``content_router.py``.
These tests mirror the structure of
``tests/test_smart_crusher_toin_attachment.py`` (the F2.1-era TOIN
re-attachment regression suite) so a future contributor can locate the
expected behaviour by name.
Behaviour matrix:
| Mode | toin_read_only | record_compression called? |
|--------------|----------------|----------------------------|
| Payg | False | yes |
| OAuth | False | yes |
| Subscription | True | NO |
Direct callers (those that call ``crush()`` / ``crush_array_json()``
without going through ``apply()``) don't set
``self._runtime_compression_policy``, so they keep their pre-F2.2
write-enabled behaviour. That's a deliberate compatibility decision —
non-proxy callers have no auth context.
"""
from __future__ import annotations
import json
import tempfile
from pathlib import Path
import pytest
from headroom.proxy.auth_mode import AuthMode
from headroom.telemetry.toin import TOINConfig, get_toin, reset_toin
from headroom.tokenizer import Tokenizer
from headroom.tokenizers import EstimatingTokenCounter
from headroom.transforms.compression_policy import policy_for_mode
def _has_core() -> bool:
"""Match the pattern in ``test_smart_crusher_rust_parity.py``.
SmartCrusher's __init__ hard-imports ``headroom._core`` (the Rust
PyO3 wheel). On dev machines or CI lanes that haven't run
``scripts/build_rust_extension.sh``, the wheel is absent. Skip the
SmartCrusher-touching tests rather than fail loudly — the
ContentRouter tests don't need the wheel and exercise the same
F2.2 gate code path.
"""
try:
from headroom._core import SmartCrusher # noqa: F401
return True
except ImportError:
return False
_skip_no_core = pytest.mark.skipif(
not _has_core(),
reason="headroom._core wheel not installed (run `scripts/build_rust_extension.sh`)",
)
@pytest.fixture
def fresh_toin():
"""Per-test TOIN instance backed by a tempdir to avoid global drift."""
reset_toin()
with tempfile.TemporaryDirectory() as tmpdir:
storage = str(Path(tmpdir) / "toin.json")
toin = get_toin(
TOINConfig(
storage_path=storage,
auto_save_interval=0,
)
)
yield toin
reset_toin()
def _bigger_array(n: int = 60) -> str:
"""JSON array of `n` dicts, sized to trigger crushing.
Mirrors the helper in ``test_smart_crusher_toin_attachment.py`` so
these tests use the same shape and any "didn't trigger compression"
skip lines up with the existing suite.
"""
items = [{"status": "ok", "tag": "x", "n": i} for i in range(n)]
return json.dumps(items)
def _wrap_in_tool_message(payload: str) -> list[dict]:
"""Build the OpenAI-style ``role=tool`` message ``apply()`` walks."""
return [{"role": "tool", "content": payload, "tool_call_id": "t1"}]
def _tokenizer() -> Tokenizer:
return Tokenizer(EstimatingTokenCounter()) # type: ignore[arg-type]
# ─── SmartCrusher: apply() with policy ──────────────────────────────────
@_skip_no_core
def test_smart_crusher_payg_policy_writes_to_toin(fresh_toin):
"""PAYG: ``toin_read_only=False`` → record_compression IS called."""
from headroom.transforms.smart_crusher import SmartCrusher, SmartCrusherConfig
crusher = SmartCrusher(SmartCrusherConfig())
messages = _wrap_in_tool_message(_bigger_array(60))
pre = sum(p.total_compressions for p in fresh_toin._patterns.values())
policy = policy_for_mode(AuthMode.PAYG)
assert policy.toin_read_only is False # baseline sanity
result = crusher.apply(messages, _tokenizer(), compression_policy=policy)
if not result.transforms_applied:
pytest.skip("payload didn't trigger compression — bump the size")
post = sum(p.total_compressions for p in fresh_toin._patterns.values())
assert post > pre, "PAYG should write to TOIN (network effect)"
@_skip_no_core
def test_smart_crusher_oauth_policy_writes_to_toin(fresh_toin):
"""OAuth: identical to PAYG in F2.2 — writes enabled."""
from headroom.transforms.smart_crusher import SmartCrusher, SmartCrusherConfig
crusher = SmartCrusher(SmartCrusherConfig())
messages = _wrap_in_tool_message(_bigger_array(60))
pre = sum(p.total_compressions for p in fresh_toin._patterns.values())
policy = policy_for_mode(AuthMode.OAUTH)
assert policy.toin_read_only is False
result = crusher.apply(messages, _tokenizer(), compression_policy=policy)
if not result.transforms_applied:
pytest.skip("payload didn't trigger compression — bump the size")
post = sum(p.total_compressions for p in fresh_toin._patterns.values())
assert post > pre, "OAuth (matches PAYG today) should write to TOIN"
@_skip_no_core
def test_smart_crusher_subscription_policy_skips_toin_write(fresh_toin):
"""Subscription: ``toin_read_only=True`` → record_compression is NOT called.
This is THE behaviour change of F2.2 — keep the learning pool
consistent for cache-stability-sensitive traffic.
"""
from headroom.transforms.smart_crusher import SmartCrusher, SmartCrusherConfig
crusher = SmartCrusher(SmartCrusherConfig())
messages = _wrap_in_tool_message(_bigger_array(60))
pre = sum(p.total_compressions for p in fresh_toin._patterns.values())
policy = policy_for_mode(AuthMode.SUBSCRIPTION)
assert policy.toin_read_only is True # baseline sanity
result = crusher.apply(messages, _tokenizer(), compression_policy=policy)
# Compression itself should still complete — this gate is on the
# learning side only, not the compression path.
if not result.transforms_applied:
pytest.skip("payload didn't trigger compression — bump the size")
post = sum(p.total_compressions for p in fresh_toin._patterns.values())
assert post == pre, (
"Subscription MUST NOT write to TOIN — load-bearing for keeping "
"the learning pool consistent across cache-sensitive traffic"
)
@_skip_no_core
def test_smart_crusher_no_policy_keeps_legacy_write_behaviour(fresh_toin):
"""Direct ``apply()`` call without ``compression_policy`` keeps
pre-F2.2 behaviour: TOIN writes are not gated.
Many test fixtures and non-proxy callers don't pass a policy; they
must continue to feed the learning pool exactly as they did
before F2.2.
"""
from headroom.transforms.smart_crusher import SmartCrusher, SmartCrusherConfig
crusher = SmartCrusher(SmartCrusherConfig())
messages = _wrap_in_tool_message(_bigger_array(60))
pre = sum(p.total_compressions for p in fresh_toin._patterns.values())
# No `compression_policy` kwarg.
result = crusher.apply(messages, _tokenizer())
if not result.transforms_applied:
pytest.skip("payload didn't trigger compression — bump the size")
post = sum(p.total_compressions for p in fresh_toin._patterns.values())
assert post > pre, "no policy → legacy write-enabled behaviour"
# ─── ContentRouter: apply() captures the policy ─────────────────────────
def test_content_router_apply_stores_runtime_policy():
"""``ContentRouter.apply()`` must populate
``self._runtime_compression_policy`` from kwargs so
``_record_to_toin`` can read it.
We don't assert TOIN behaviour here (the router routes most JSON
arrays to SmartCrusher, which has its own gate already covered
above); the load-bearing thing for the parity guard is that the
field is wired through.
"""
from headroom.transforms.content_router import ContentRouter
router = ContentRouter()
# Sanity: the field exists on a fresh instance and starts None.
assert router._runtime_compression_policy is None
policy = policy_for_mode(AuthMode.SUBSCRIPTION)
# Empty-message apply is fine — the field assignment happens
# before the message walk, so we don't need a payload that
# actually compresses.
router.apply([], _tokenizer(), compression_policy=policy)
assert router._runtime_compression_policy is policy, (
"ContentRouter.apply() must capture the policy onto self so _record_to_toin can read it"
)
def test_content_router_subscription_skips_toin_record(fresh_toin):
"""ContentRouter._record_to_toin returns early when
policy.toin_read_only is True.
We exercise the gate directly rather than building a fixture that
routes to a non-SmartCrusher compressor — both are equivalent
coverage for the gate, and the direct call avoids the routing
flake from ``test_smart_crusher_toin_attachment.py``'s comments.
"""
from headroom.transforms.content_router import (
CompressionStrategy,
ContentRouter,
)
router = ContentRouter()
router._runtime_compression_policy = policy_for_mode(AuthMode.SUBSCRIPTION)
pre = sum(p.total_compressions for p in fresh_toin._patterns.values())
# Pick TEXT strategy (not SMART_CRUSHER, which has its own
# early-return). With Subscription policy, the F2.2 gate fires
# and the call returns before ever loading TOIN.
router._record_to_toin(
strategy=CompressionStrategy.TEXT,
content="some text content",
compressed="compressed",
original_tokens=100,
compressed_tokens=50,
)
post = sum(p.total_compressions for p in fresh_toin._patterns.values())
assert post == pre, "Subscription policy must skip ContentRouter TOIN write"
def test_content_router_payg_records_to_toin(fresh_toin):
"""PAYG policy → ContentRouter._record_to_toin proceeds to the
real TOIN call. Asserts the gate doesn't accidentally fire when
``toin_read_only=False``.
"""
from headroom.transforms.content_router import (
CompressionStrategy,
ContentRouter,
)
router = ContentRouter()
router._runtime_compression_policy = policy_for_mode(AuthMode.PAYG)
pre = sum(p.total_compressions for p in fresh_toin._patterns.values())
router._record_to_toin(
strategy=CompressionStrategy.TEXT,
content="some text content with structure that learns",
compressed="compressed shorter",
original_tokens=100,
compressed_tokens=50,
)
post = sum(p.total_compressions for p in fresh_toin._patterns.values())
# Real TOIN write should happen unless _create_content_signature
# returns None (it can for malformed inputs). We accept either
# "post > pre" (signature succeeded) OR "post == pre with a
# signature-None path"; the load-bearing assertion is that the
# F2.2 gate did NOT fire (which it would with toin_read_only=True
# regardless of signature).
assert post >= pre, (
"PAYG must not be blocked by the F2.2 gate — write should happen or fall through naturally"
)