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

233 lines
8.4 KiB
Python

"""Run-spec loading: YAML -> validated RunSpec (+ --smoke overlay).
The YAML shape:
bench: appworld
repo_root: /path/to/subject # the repo being evolved
base_sha: <commit> # optional; omitted -> repo_root HEAD at launch
work_dir: ./evo_work
models: # optional; omitted -> raven's own model
driver: {provider: claude_cli, model: claude-haiku-4-5}
design: {provider: claude_cli, model: claude-opus-4-8}
verdict: {provider: openai_compat, base_url: ..., model: ...}
funnel: # optional; SOP-aligned defaults
k_screen: 1
k_confirm: 3
budget: {max_why_per_round: 2, candidates_per_why: 3}
termination: {patience: 10, max_rounds: 20}
anchor: {n_sentinel: 12, cull_sigma_mult: 1.5}
bench_config: {...} # schema owned by the bench entry
smoke: {...} # optional deep-merge overlay for --smoke
``--smoke`` applies built-in shrink defaults (1 WHY x 1 candidate x 1 round,
K=1) first, then the user's ``smoke:`` section on top, and suffixes work_dir
with ``_smoke`` so a smoke run never touches the real run's state.
"""
from __future__ import annotations
import copy
import subprocess
from dataclasses import dataclass, field
from pathlib import Path
import yaml
from evolver.orchestrator.config import (
AnchorParams,
Budget,
OrchestratorConfig,
Termination,
)
SMOKE_BUILTIN: dict = {
"funnel": {
"k_confirm": 1,
"budget": {"max_why_per_round": 1, "candidates_per_why": 1, "recombinations_per_round": 0},
"termination": {"patience": 1, "max_rounds": 1},
},
}
class RunSpecError(ValueError):
"""A config file problem the user must fix; message says exactly what."""
def _redact_secrets(models: dict) -> dict:
if not isinstance(models, dict):
return models
out = {}
for role, spec in models.items():
if isinstance(spec, dict):
out[role] = {k: ("<redacted>" if "key" in k.lower() and k != "api_key_env" else v) for k, v in spec.items()}
else:
out[role] = spec
return out
def deep_merge(base: dict, overlay: dict) -> dict:
out = copy.deepcopy(base)
for k, v in overlay.items():
if isinstance(v, dict) and isinstance(out.get(k), dict):
out[k] = deep_merge(out[k], v)
else:
out[k] = copy.deepcopy(v)
return out
@dataclass
class RunSpec:
bench: str
repo_root: Path
base_sha: str
work_dir: Path
funnel: OrchestratorConfig
models: dict = field(default_factory=dict)
bench_config: dict = field(default_factory=dict)
smoke: bool = False
base_sha_defaulted: bool = False
config_dir: Path = field(default_factory=Path.cwd)
raw: dict = field(default_factory=dict)
def snapshot(self) -> dict:
"""The effective configuration recorded in run_meta (drift guard).
Secrets are redacted before they reach disk — work dirs get shared —
and the redaction is a constant, so rotating a key does not trip the
config-drift guard.
"""
return {
"bench": self.bench,
"repo_root": str(self.repo_root),
"base_sha": self.base_sha,
"models": _redact_secrets(self.raw.get("models", {})),
"funnel": self.raw.get("funnel", {}),
"bench_config": self.raw.get("bench_config", {}),
"smoke": self.smoke,
}
def _build_funnel(repo_root: Path, work_dir: Path, funnel: dict) -> OrchestratorConfig:
if not isinstance(funnel, dict):
raise RunSpecError(f"funnel: must be a mapping, got {type(funnel).__name__}")
known = {"k_screen", "k_confirm", "anchor", "budget", "termination", "sealed_test_split"}
unknown = set(funnel) - known
if unknown:
raise RunSpecError(f"funnel: unknown keys {sorted(unknown)}")
try:
cfg = OrchestratorConfig(
repo_root=repo_root,
work_dir=work_dir,
driver_llm_spec={},
k_screen=int(funnel.get("k_screen", 1)),
k_confirm=int(funnel.get("k_confirm", 3)),
anchor=AnchorParams(**(funnel.get("anchor") or {})),
budget=Budget(**(funnel.get("budget") or {})),
termination=Termination(**(funnel.get("termination") or {})),
sealed_test_split=funnel.get("sealed_test_split", "test"),
sealed_output_dir=work_dir / "sealed",
)
except (TypeError, ValueError) as exc:
raise RunSpecError(f"funnel: {exc}") from exc
if cfg.k_screen < 1 or cfg.k_confirm < 1:
raise RunSpecError("funnel: k_screen and k_confirm must be >= 1")
if cfg.budget.max_why_per_round < 1 or cfg.budget.candidates_per_why < 1:
raise RunSpecError("funnel: budget.max_why_per_round and budget.candidates_per_why must be >= 1")
if cfg.termination.patience < 1 or cfg.termination.max_rounds < 1:
raise RunSpecError("funnel: termination.patience and termination.max_rounds must be >= 1")
return cfg
def load_run_spec(config_path: str | Path, *, smoke: bool = False) -> RunSpec:
path = Path(config_path)
if not path.is_file():
raise RunSpecError(f"config file not found: {path}")
try:
data = yaml.safe_load(path.read_text())
except yaml.YAMLError as exc:
raise RunSpecError(f"{path}: invalid YAML: {exc}") from exc
if not isinstance(data, dict):
raise RunSpecError(f"{path}: top level must be a mapping")
if smoke:
overlay = data.pop("smoke", {}) or {}
data = deep_merge(deep_merge(data, SMOKE_BUILTIN), overlay)
else:
data.pop("smoke", None)
missing = [k for k in ("bench", "repo_root", "work_dir") if not data.get(k)]
if missing:
raise RunSpecError(f"{path}: missing required keys: {missing}")
def _abs(value: str) -> Path:
# Relative paths resolve against the config file, not the CWD — a
# resume from another directory must find the same work_dir, not
# silently start a fresh run.
p = Path(value).expanduser()
return p if p.is_absolute() else (path.parent / p).resolve()
repo_root = _abs(data["repo_root"])
if not (repo_root / ".git").exists():
raise RunSpecError(f"repo_root is not a git checkout: {repo_root}")
base_sha = str(data.get("base_sha") or "").strip()
base_sha_defaulted = not base_sha
if base_sha_defaulted:
base_sha = _resolve_head(repo_root)
data["base_sha"] = base_sha
work_dir = _abs(data["work_dir"])
if smoke:
work_dir = work_dir.with_name(work_dir.name + "_smoke")
models = data.get("models") or {}
if not isinstance(models, dict):
raise RunSpecError("models: must be a mapping of role -> provider spec")
unknown_roles = set(models) - {"driver", "design", "verdict"}
if unknown_roles:
raise RunSpecError(f"models: unknown roles {sorted(unknown_roles)}")
for role, spec_val in models.items():
if not isinstance(spec_val, dict):
raise RunSpecError(f"models.{role}: must be a mapping (provider/model/...), got {type(spec_val).__name__}")
return RunSpec(
bench=str(data["bench"]),
repo_root=repo_root,
base_sha=base_sha,
work_dir=work_dir,
funnel=_build_funnel(repo_root, work_dir, data.get("funnel") or {}),
models=models,
bench_config=data.get("bench_config") or {},
smoke=smoke,
base_sha_defaulted=base_sha_defaulted,
config_dir=path.parent.resolve(),
raw=data,
)
def _resolve_head(repo_root: Path) -> str:
"""Resolve the subject repo's HEAD when the yaml omits ``base_sha``.
Resolved to a full sha at load time and recorded in the config snapshot,
so the run stays pinned to the commit HEAD pointed at when it started —
resuming after the repo gained commits trips the drift guard instead of
silently moving the root.
"""
try:
proc = subprocess.run(
["git", "-C", str(repo_root), "rev-parse", "HEAD"],
capture_output=True,
text=True,
)
except OSError as exc:
raise RunSpecError(f"git is not runnable ({exc}) — install git") from exc
if proc.returncode != 0:
raise RunSpecError(f"base_sha omitted and resolving HEAD of {repo_root} failed: {proc.stderr.strip()}")
return proc.stdout.strip()
__all__ = ["RunSpec", "RunSpecError", "load_run_spec", "deep_merge", "SMOKE_BUILTIN"]