Files
headroom/tests/test_recursive_json.py
Mansurshakh JaparovandJerrettDavis 93279f3208 fix(smart-crusher): preserve unchanged JSON bytes (#4044)
## Description

Closes #3697.

An unchanged SmartCrusher result now keeps the original bytes and
reports no structural compression. Formatting-only savings come from the
existing Rust JsonMinifier, not from pretending the JSON value changed.

The minifier preserves duplicate keys, order, escapes and number
literals. A mixed result cannot use one section's CCR marker to hide
unmarked loss in another.

## Type of Change

- [x] Bug fix (non-breaking change that fixes an issue)
- [x] Documentation update

## Changes Made

- Keep SmartCrusher's exact-byte no-op behavior; route actual whitespace
savings through JsonMinifier in Python and the eligible native live
zone.
- Keep all records and JSON literals; do not store originals or inject
CCR markers for lossless minification.
- Preserve mixed routing and reject uncovered lossy sections in both
tool-result formats. Explicit no-CCR behavior is unchanged.
- Replace incidental forwarding tests with native minification and
complete-record regressions; document the distinction.

## Testing

- [ ] Entire Python suite — not claimed.
- [x] Four consumer/native modules: `python -m pytest -q
tests/test_recursive_json.py tests/test_transforms_content_router.py
tests/test_transforms/test_smart_crusher_rust_parity.py
tests/test_transforms/test_smart_crusher_lossless_default.py`
- [x] Changed-file Ruff checks; normal commit hooks, including mypy and
commitlint.
- [x] Manual public-API runs, with and without the HTML extra.

### Test Output

Consumer/native modules:

```text
collected 136 items
============================= 136 passed in 36.43s =============================
```

Normal pre-push (fmt, clippy, 1,668 Rust tests with 3 ignored, native
build, Python checks, commitlint):

```text
======================== 180 passed, 1 warning in 8.35s ========================
✅ ci-precheck PASSED — safe to push.
To https://github.com/oxura/headroom.git
   64688217..0002af3e  HEAD -> fix/3697-unchanged-json-passthrough
```

The first push stopped on an inherited commit footer because
`origin/main` was stale. Fetching the actual upstream ref fixed the lint
range; the normal push then passed. No source merge, lint-rule change or
hook bypass.

Hosted checks on `0002af3e` now pass: all four Python shards, Windows
permissions, smoke tests, native wrappers, parity and Docker e2e.
[Checks](https://github.com/headroomlabs-ai/headroom/pull/4044/checks).

## Real Behavior Proof

- Environment: Linux x86-64, Python 3.13.14, Rust 1.95 and the actual
extension built from this checkout. No provider billing calls.
- Exact command / steps: the earlier localhost `/v1/compress` and
TransformPipeline runs exercised the original fix. For this follow-up,
call `ContentRouter.compress` on a data-only HTML page containing 60
complete records, with `smart_crusher_lossless_only=True`,
`smart_crusher_with_compaction=False`, and `enable_kompress=False`. Run
it once without trafilatura, then with the locked 2.0.0 extra. The new
public-API test contains the full input/config. Separately call
`route_embedded_json` on a compact array followed by a padded array,
with Unicode and CRLF surroundings.
- Observed result: both HTML modes keep all 60 records and the
surrounding markup, with no unrecoverable section. The unchanged first
JSON span does not stop the second span's compaction; surrounding text
stays exact. Final Codecov is 96%; the two remaining lines are the
deferred HTML fallback return. The real no-HTML-extra API run executed
both, and local coverage also exercises the unchanged-span branch.
- Not tested: live provider acceptance, invoices or production cache hit
rates. No native eligibility or admission gates changed.

## Runtime Rollout Safety

- Rollout-managed feature(s): none; existing JSON routing.
- Minimum rollout channel: unchanged.
- Stable/default behavior changed: eligible formatting savings return as
json_minifier; standalone SmartCrusher remains byte-exact on no-ops.
- Kill switch / disable path: existing routing configuration and
HEADROOM_LIVE_ZONE_DISABLE_ARMS.
- Unsafe override required: no.
- Qualification impact: no-op, formatting, structural and CCR paths
exercised separately.
- Rollback path: revert the minifier integration; no persistence
migration.

## 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 made corresponding changes to the documentation
- [x] I did not edit CHANGELOG.md — release-please owns it

## Additional Notes

Addresses the [minifier
review](https://github.com/headroomlabs-ai/headroom/pull/4044#issuecomment-6157583285).
The maintainer’s main merge is retained. The latest follow-up only
changes consumer tests.

AI-assisted; no subagents.

---------

Co-authored-by: JerrettDavis <mxjerrett@gmail.com>
2026-11-03 21:32:42 -06:00

215 lines
8.1 KiB
Python

"""Embedded JSON routing: preserved surroundings and per-adopted-span recovery."""
from __future__ import annotations
import json
from headroom.transforms.recursive_json import (
carries_record_array,
json_document_spans,
route_embedded_json,
)
def _minify_dispatch(span: str) -> tuple[str, bool]:
return json.dumps(json.loads(span), separators=(",", ":")), True
def test_embedded_json_routed_and_surroundings_exact() -> None:
rows = [{"id": i, "ok": True} for i in range(6)]
payload = json.dumps(rows, indent=2)
content = f"Fetched rows from API:\n{payload}\nDone (200 OK)."
assert route_embedded_json(content, _minify_dispatch) == (
f"Fetched rows from API:\n{json.dumps(rows, separators=(',', ':'))}\nDone (200 OK).",
True,
)
def test_noop_json_span_does_not_block_later_compaction() -> None:
compact = json.dumps([{"id": i, "ok": True} for i in range(6)], separators=(",", ":"))
rows = [{"id": i, "message": f"entry-{i}"} for i in range(20, 26)]
padded = json.dumps(rows, indent=2)
leading, between, trailing = "Début 🚀\r\nfirst: ", "\r\nsecond: ", "\r\nFin."
content = leading + compact + between + padded + trailing
assert route_embedded_json(content, _minify_dispatch) == (
leading + compact + between + json.dumps(rows, separators=(",", ":")) + trailing,
True,
)
def test_ccr_marker_span_passed_through() -> None:
content = 'prefix [{"a":1,"b":2},{"a":3,"b":"<<ccr:deadbeef,json,900>>"}] suffix'
assert route_embedded_json(content, _minify_dispatch) is None
def test_no_json_is_noop() -> None:
assert route_embedded_json("just prose, nothing structured here", _minify_dispatch) is None
def test_whole_block_json_is_callers_job() -> None:
content = json.dumps([{"a": i} for i in range(5)], separators=(",", ":"))
assert route_embedded_json(content, _minify_dispatch) is None
def test_benefit_gate_declines_when_not_smaller() -> None:
payload = json.dumps([{"a": i} for i in range(5)])
assert route_embedded_json(f"x {payload} y", lambda s: (s + " " * 999, True)) is None
def test_unmarked_loss_cannot_borrow_another_spans_marker() -> None:
first = json.dumps([{"id": i} for i in range(10)], indent=2)
second = json.dumps([{"value": i} for i in range(10)], indent=2)
def dispatch(span: str) -> tuple[str, bool]:
rows = json.loads(span)
if "id" in rows[0]:
return "<<ccr:deadbeef,json,100>>", True
return json.dumps(rows[:1]), False
for left, right in ((first, second), (second, first)):
result = route_embedded_json(f"first: {left}\nsecond: {right}", dispatch, tok=len)
assert result is not None
text, reversible = result
assert "<<ccr:deadbeef,json,100>>" in text
assert '{"value": 0}' in text and '{"value": 9}' not in text
assert reversible is False
def test_rejected_lossy_candidate_does_not_taint_adopted_minification() -> None:
first = json.dumps([{"id": i} for i in range(10)], indent=2)
second = json.dumps([{"value": i} for i in range(10)], indent=2)
def dispatch(span: str) -> tuple[str, bool]:
rows = json.loads(span)
if "id" in rows[0]:
return json.dumps(rows[:1]) + " " * len(span), False
return _minify_dispatch(span)
assert route_embedded_json(f"first: {first}\nsecond: {second}", dispatch, tok=len) == (
f"first: {first}\nsecond: {json.dumps(json.loads(second), separators=(',', ':'))}",
True,
)
def test_scalar_array_not_routed() -> None:
assert route_embedded_json("nums: [1,2,3,4,5,6,7,8] done", _minify_dispatch) is None
def test_json_document_spans_finds_containers_anywhere() -> None:
doc = json.dumps({"domains": [{"name": "a"}, {"name": "b"}]})
arr = json.dumps([1, 2, 3])
text = "Tool result: " + doc + " and a list " + arr + " done"
assert [text[a:b] for a, b in json_document_spans(text)] == [doc, arr]
def test_json_document_spans_ignores_scalars_prose_and_unbalanced_json() -> None:
assert json_document_spans('"just a quoted sentence"') == []
assert json_document_spans("42") == []
assert json_document_spans("prose with a [note] and {braces} but no JSON") == []
assert json_document_spans('{"truncated": [1, 2, 3') == []
assert json_document_spans("{{HEADROOM_TAG_0}}") == []
assert json_document_spans("") == []
def test_json_document_spans_whole_document() -> None:
doc = json.dumps({"a": [1, 2]})
assert json_document_spans(doc) == [(0, len(doc))]
assert json_document_spans(" " + doc + "\n") == [(2, 2 + len(doc))]
def test_carries_record_array_separates_the_two_shapes() -> None:
assert carries_record_array(json.dumps({"domains": [{"name": "a"}, {"name": "b"}]}))
assert carries_record_array(json.dumps([{"id": 1}, {"id": 2}]))
# A lone object, or an array of scalars, has no record delimiter whose
# deletion leaves a valid-but-shorter document.
assert not carries_record_array(json.dumps({"file": "src/mod.py", "line": 1}))
assert not carries_record_array(json.dumps([1, 2, 3]))
assert not carries_record_array(json.dumps([{"id": 1}]))
# --- the span walk is linear on brace-heavy text -----------------------------
#
# ``_spans`` used to call ``_match_span`` at every opening bracket, and a ``{``
# that never closes walks to the end of the text: source code and logs full of
# unmatched braces cost one full pass per brace. ``_scan_spans`` memoizes each
# bracket's verdict from the walk that already crossed it. These tests pin that
# the result did not change and that the work did.
def _reference_spans(text: str) -> list[tuple[int, int]]:
"""The previous ``_spans``: ``_match_span`` at every opening bracket."""
from headroom.transforms.recursive_json import _match_span
out: list[tuple[int, int]] = []
i, n = 0, len(text)
while i < n:
if text[i] in "[{":
end = _match_span(text, i)
if end is not None:
out.append((i, end))
i = end
continue
i += 1
return out
def test_span_walk_matches_the_previous_semantics_exactly() -> None:
import random
from headroom.transforms.recursive_json import _scan_spans
rng = random.Random(3673)
alphabet = '{}[]"\\ a,:\n'
samples = [
"".join(rng.choice(alphabet) for _ in range(rng.randint(0, 120))) for _ in range(4000)
]
samples += [
'noise {"a": [1, {"b": "}"}]} tail [1,2] {oops',
'He said "a {quote" then {"k": "v"} and "another {one}"',
'{"esc": "a \\" } still string"} {x',
"[{]}] {[}] {{{{",
]
for text in samples:
spans, complete = _scan_spans(text)
assert complete, text
assert spans == _reference_spans(text), text
def test_span_walk_is_linear_on_unmatched_braces(monkeypatch) -> None:
import headroom.transforms.recursive_json as rj
line = ' if (flags & MASK) { log.debug("state={}", state); retry(ctx, {timeout: 30, max\n'
text = line * 800 # ~70 KB, about three unmatched `{` per line
walked = 0
real = rj._scan_from
def counting(t, start, known): # noqa: ANN001, ANN202
nonlocal walked
end, n = real(t, start, known)
walked += n
return end, n
monkeypatch.setattr(rj, "_scan_from", counting)
spans, complete = rj._scan_spans(text)
assert complete
# One pass, give or take the per-line restarts inside quoted strings. The
# previous walk re-read the rest of the text for every unmatched brace:
# hundreds of times the input size here.
assert walked <= 2 * len(text), (walked, len(text))
# Same answer as before on the same shape (a slice keeps the quadratic
# reference fast enough to run).
small = line * 40
assert rj._scan_spans(small)[0] == _reference_spans(small)
def test_scan_stops_at_its_budget_and_says_so(monkeypatch) -> None:
import headroom.transforms.recursive_json as rj
monkeypatch.setattr(rj, "_SCAN_BUDGET_PER_CHAR", 0)
monkeypatch.setattr(rj, "_SCAN_BUDGET_FLOOR", 0)
text = 'prose {"a": 1} then [{"id": 1}, {"id": 2}]'
spans, complete = rj.scan_json_documents(text)
assert complete is False
assert spans == []