Raven-1/evolver/applier/path_guard.py
Handsome-wzw 7b45527b5b fix(tools): an array sent as its own JSON is still an array
## Summary

Reported as "deliver_files is broken". It is not: **the tool never ran.**

Every `deliver_files` call on one install was refused before dispatch -- five in a row in a single session -- and nothing was ever delivered:

```
Error: Invalid parameters for tool 'deliver_files': files should be array
```

What the model sent was the array, spelled as a string:

```json
{"files": "[{\"path\": \"...poster.png\", \"title\": \"...\"}]", "message": "..."}
```

`cast_params` already forgives that spelling for every scalar type -- `"3"` for an integer, `"true"` for a boolean -- and did not for arrays or objects, which are exactly the types a model is most likely to stringify.

## Type

- [x] Fix
- [ ] Feature

## The edge of the forgiving is the design

When the value is a string, try `json.loads`, and take the result **only if it is the type the schema asked for**. A string that is not JSON, or is JSON of the wrong shape, is returned unchanged so the validator still names the real problem -- the point is to widen what is accepted, not to swallow a type error.

**Nothing here can raise.** Turning "your argument has the wrong type" into a traceback would be worse than the refusal it replaces, so the parse is wrapped and failure falls through.

**A `type: "string"` field is never parsed.** JSON is ordinary text in a message body or a file's content, and replacing it would hand the tool something it never asked for. Two independent things prevent it today (the string branch returns before the parse is reached, and the parse only wins on a type match), which is why the case pinning it is a tripwire rather than a load-bearing assertion -- said so in its own docstring rather than left to look like coverage.

## Not just deliver_files

Six built-in tools declare an array or object parameter and were all exposed:

| tool | parameter |
|---|---|
| `deliver_files` | `files` |
| `ask_user` | `questions` |
| `image_generate` | `images` |
| `message` | `media` |
| `create_playbook` | `skills` |
| `video_generate` | `params` |

The same failure was already seen from the other side: `acp_client/acp_agent.py` records `update_task_state` and `operations should be array` from a real dispatch.

## Verification

```
make lint-python    ruff check + ruff format --check, 1850 files
make lint-imports   9 contracts kept, 0 broken
pytest tests/       19,699 passed, 7 failed (all pre-existing, see below)
```

- [x] Relevant tests pass locally
- [x] Relevant lint / type checks pass locally
- [ ] User-facing docs or screenshots -- no user-facing string

**End to end, through the real tool**, with the exact payload that failed five times in production:

```
files sent as:            str -> [{"path": ".../poster.png", "title": "..."}]
returned:                 Delivered 1 file(s): poster.png (72 B).
still "should be array":  False
registered in the store:  True
```

Twelve cases, five mutations, each killing at least one:

| mutation | red |
|---|---|
| drop the whole branch (the old behaviour) | 3 |
| raise instead of falling through on a parse failure | 5 |
| accept the parse whatever type it yielded | 1 |
| do not re-cast the parsed value, so items are not cast | 1 |
| widen the tuple to include `string` | **survived -- unreachable** |

The last is worth stating rather than hiding: that mutation cannot change behaviour, because the `type == "string"` branch returns earlier and the type check would refuse the result anyway. I also tried moving the new block above that branch, alone and combined with widening the tuple, and neither reddens anything either. The invariant holds by construction; the case that documents it says so.

**Pre-existing failures, checked against the base.** 7 failed in the full run, all in `tests/test_security_network.py` (`test_a_redirect_to_a_dangerous_address_is_refused` and siblings). Running that file alone on this same tree gives 4 -- the count is order-dependent -- and the change touches only `raven/agent/tools/params.py` plus a new test file, neither of which `raven/security/network.py` imports. The failures are the box's resolver: it returns poisoned answers roughly half the time, which I measured separately (`en.wikipedia.org` came back as `2001::1` on 3 of 6 lookups). Not introduced here, and worth someone's attention on its own.

## Risk

- [x] Security impact considered -- widens what reaches a tool's own validation, not what bypasses it. A parsed value is still validated against the same schema, and a parse that yields the wrong type is refused exactly as before
- [x] Backward compatibility considered -- a call that worked before takes the identical path; the new branch is reached only by a `str` where an array or object is declared, which previously always failed
- [x] Rollback path is clear -- single-commit revert

## Related Issues

N/A

## Swept

`mr-review-patterns` pre-submit sweep, over `git diff origin/main...HEAD`.

- **1 (a write location moved)** -- nothing moved; a branch was added to an existing dispatch on `target_type`. Grepped every caller of `cast_params`: the registry is the only one, and it runs `validate_params` right after, which is the reader this affects.
- **2 (a value with several entry points)** -- the cast is the single funnel every tool argument passes through, which is why the fix belongs here and not in `deliver_files`.
- **3 (a guard)** -- checked both directions: what it wrongly lets through (JSON of the wrong type, non-JSON text -- both refused, with cases) and what it wrongly refuses (a real list, unaffected, with a case).
- **4 (tests)** -- five mutations above, one honestly reported as unreachable. Failing-ID sets diffed against the base rather than counts.
- **6 (stale text)** -- the module docstring enumerated what is coerced ("a string that should be an integer"); it now names arrays and objects too. Grepped the tracked tree for other statements of the rule: none.
- **9 (error handling)** -- the new path adds one way to end and it is caught: `json.loads` raises `ValueError` on bad text and `TypeError` on a non-string, and both fall through to the untouched value.
- **11** -- `git ls-files | grep -c node_modules` is 0; the commit-message gate was run, not eyeballed.

Not applicable, with reasons: **3b, 3c, 3d, 3e** (no tool schema produced, no state moved, one lane, no assertion lost its symbol); **4b, 4c, 4d** (no platform branch, no shell, no rendered number); **5, 5b** (no dependency; `json` is stdlib and already imported across this package); **6b, 6c** (no backup, no generated artifact); **7, 7b** (nothing on disk); **8** (no asset, no secret); **10** (no prompt text).

## Deliberately not fixed

The error text still ends with `[Analyze the error above and try a different approach.]`, and the model plainly did not -- it sent the same shape five times. A message naming the expected spelling (`files must be a JSON array, not a string containing one`) would give it something to act on. That is a change to the registry's error surface, affects every tool, and deserves its own argument.

## Moved from !594

Opened on a compliant source branch. AGENTS.md 2.1 asks for a 3-5 word snake_case description and the previous branch had seven; GitLab cannot change an existing merge request's source branch, so the change moves rather than the name.

Same commits, rebased onto `c2a9768f`. Both code findings from the review on !594 are already in them -- `RecursionError` caught with its regression case, and the implementation comment reduced to the two non-obvious reasons. Nothing else changed, so that review carries.
2026-09-09 15:42:36 +00:00

226 lines
8.8 KiB
Python

"""Path guard for evolver-generated patches (spec §22 + §22.7).
The immutable set is **evolver-immutable**, not human-immutable.
Human-driven development (PR review) can still touch these paths
through normal workflow; only auto-evolver patches are blocked.
Two pattern types are supported in ``IMMUTABLE_PATTERNS``:
- **Exact file** — e.g. ``"raven/agent/loop/main.py"``. Matches
exactly this repo-relative path.
- **Directory subtree** — trailing-slash, e.g. ``"evolver/"``.
Matches the directory itself and any descendant path.
``MUTABLE_OVERRIDES`` takes precedence: a path matching an override is
mutable even if it also matches an immutable pattern. Use this to carve
out mutable sub-trees from a broader immutable directory.
Why repo-relative-string matching instead of full glob:
This module's job is fast, predictable, easy-to-audit gating. Glob
patterns (``**``, ``*.py``) invite surprises (case-sensitivity, slash
behaviour). Exact paths + directory subtrees cover everything in
§22.2 without ambiguity.
Reference layers (spec §22.1, §22.2):
L1 — Self-reference (evolver/**)
L2 — Evaluation substrate (eval_engine + external grader)
L3 — Capability contract (agent loop, tools framework, providers,
skill loader, sandbox, config schema, ...)
L4 — Audit / data integrity (tool_audit_hook)
L5 — Tests, deps, CI
"""
from __future__ import annotations
# ---------------------------------------------------------------------------
# Immutable pattern list (spec §22.2)
# ---------------------------------------------------------------------------
# All paths are repo-relative with forward-slash separators.
# A trailing slash means "this directory and everything inside it".
IMMUTABLE_PATTERNS: tuple[str, ...] = (
# ── L1 — Self-reference ────────────────────────────────────────────────
"evolver/",
# ── L2 — Evaluation substrate ──────────────────────────────────────────
"raven/eval_engine/engine.py",
"raven/eval_engine/adapter/",
"raven/eval_engine/judge/",
# The AppWorld evolve glue (adapter/eval/diagnose/editor/precheck, plus
# grade.py — the /evaluate call, success/infra classification and result
# write) scores candidates; it sits INSIDE the designer whitelist tree,
# so the guard must carve it out (maps the upstream evaluation/ entry).
"benchmarks/appworld/evolve/",
# The batch scorer orchestrates trials and records runner-level infra;
# a candidate that can edit it can reshape its own denominator. The
# editable agent surface is agent_cli.py (loop/prompt) and tool.py.
"benchmarks/appworld/batch.py",
# ── L3 — Capability contract ───────────────────────────────────────────
"raven/agent/loop/main.py",
"raven/agent/context/",
"raven/contracts/tool.py",
"raven/agent/tools/registry.py",
"raven/agent/personalizer/",
"raven/agent/subagent/",
# Raven replaced the upstream agent/api with the spine: the runner is the
# bridge every turn goes through, same contract level.
"raven/agent/spine_runner.py",
"raven/spine/",
"raven/providers/",
"raven/session/",
"raven/memory_engine/",
"raven/skill_hub/",
"raven/context_engine/",
"raven/sandbox/",
"raven/security/",
# config: schema/loader (.py) are immutable; values (.yaml/.json) mutable
"raven/config/__init__.py",
"raven/config/raven.py",
"raven/config/loader.py",
"raven/config/paths.py",
"raven/config/schema.py",
"raven/config/update.py",
"raven/config/update_channels.py",
"raven/config/update_providers.py",
# ── L4 — Audit / data integrity ────────────────────────────────────────
"raven/eval_engine/hooks/tool_audit_hook.py",
# ── L5 — Tests, deps, CI ───────────────────────────────────────────────
"tests/",
"pyproject.toml",
"uv.lock",
".github/",
# ── Core version (spec §22.5) — only humans bump ───────────────────────
"raven/__init__.py",
)
# Carve-outs for paths inside immutable subtrees that should remain
# mutable. Empty at the moment — no carve-outs needed under the current
# §22.2 layout. Add an entry like ``"raven/sandbox/policies.yaml"``
# here if a specific file inside an immutable directory needs to evolve.
MUTABLE_OVERRIDES: tuple[str, ...] = ()
# ---------------------------------------------------------------------------
# Public API
# ---------------------------------------------------------------------------
class ImmutablePathError(ValueError):
"""Raised when an evolver patch targets an immutable kernel path.
See spec §22 for the evolver-immutable kernel definition. If a
legitimate patch is being blocked, two options:
1. Reframe the patch — split off the mutable part, drop the
immutable part. This is what `path_guard` expects.
2. Walk the human-driven development path: open a PR that
updates ``MUTABLE_OVERRIDES`` (if the path was misclassified)
or that modifies the kernel directly (then bump ``core_version``
per spec §22.5).
"""
# ---------------------------------------------------------------------------
# Internal helpers
# ---------------------------------------------------------------------------
def _normalise(path: str) -> str:
"""Normalise a path to repo-relative, forward-slash form.
- Windows-style backslashes are converted to forward slashes
- A leading ``./`` is stripped (callers sometimes pass it)
Callers are expected to pass repo-relative paths; absolute paths
will not match any pattern (and therefore be reported as mutable).
Validating that is the caller's responsibility.
"""
p = path.replace("\\", "/")
if p.startswith("./"):
p = p[2:]
return p
def _match(path: str, pattern: str) -> bool:
"""Match a normalised path against one pattern.
Two pattern shapes:
- Trailing slash → directory subtree match (the directory itself
and any descendant).
- Otherwise → exact-string match.
"""
if pattern.endswith("/"):
prefix = pattern.rstrip("/")
return path == prefix or path.startswith(pattern)
return path == pattern
# ---------------------------------------------------------------------------
# Predicates
# ---------------------------------------------------------------------------
def is_immutable(path: str) -> bool:
"""Return True iff ``path`` is in the evolver-immutable kernel.
Algorithm:
1. Normalise the path (handle Windows paths + leading ``./``).
2. If any pattern in ``MUTABLE_OVERRIDES`` matches → return False
(override wins).
3. If any pattern in ``IMMUTABLE_PATTERNS`` matches → return True.
4. Otherwise → return False (path is mutable by default).
"""
norm = _normalise(path)
for pat in MUTABLE_OVERRIDES:
if _match(norm, pat):
return False
for pat in IMMUTABLE_PATTERNS:
if _match(norm, pat):
return True
return False
def check_patch_paths(target_files: list[str]) -> list[str]:
"""Return the subset of ``target_files`` that hit immutable paths.
Useful for evolver code that wants to inspect violations without
raising — e.g., to route the patch to a TODO markdown
(spec §21.4.2) instead of attempting to apply it.
"""
return [p for p in target_files if is_immutable(p)]
def assert_patch_allowed(target_files: list[str]) -> None:
"""Raise :class:`ImmutablePathError` if any target is immutable.
Use this as the first-line gate in the evolver applier:
.. code-block:: python
from evolver.applier import assert_patch_allowed
assert_patch_allowed([c.target_file for c in patch.components])
# ... proceed to apply patch only if no error
"""
offenders = check_patch_paths(target_files)
if offenders:
head = offenders[:5]
more = f" ... and {len(offenders) - 5} more" if len(offenders) > 5 else ""
raise ImmutablePathError(
f"Patch targets {len(offenders)} evolver-immutable path(s): "
f"{head}{more}. The gates, ledgers, and eval glue may never be "
"edited by a candidate (see IMMUTABLE_PATTERNS in this module)."
)
__all__ = [
"IMMUTABLE_PATTERNS",
"MUTABLE_OVERRIDES",
"ImmutablePathError",
"assert_patch_allowed",
"check_patch_paths",
"is_immutable",
]