## 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.
125 lines
5.0 KiB
Python
125 lines
5.0 KiB
Python
"""Where the loop's off switches come from, and which of them can be reversed.
|
|
|
|
Two sources meet in ``AgentLoop._withheld_tool_names``: the config file, read live
|
|
so a switch flipped on the settings page takes effect on the next turn, and a list
|
|
handed to the constructor by an eval harness that has no config file at all. They
|
|
are composed in one place and nowhere else, and the composition is the part with a
|
|
failure mode neither half has -- a name that arrives through the constructor is
|
|
fixed for the life of the process, so copying the file's list in there would make
|
|
every switch that was on at launch permanent, whatever the file says afterwards.
|
|
|
|
The halves have their own files (``test_config_live.py`` for the read,
|
|
``test_tool_registry_withheld.py`` for what the registry does with the answer);
|
|
this one is only about the seam.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import json
|
|
from pathlib import Path
|
|
|
|
from raven.agent.loop.main import AgentLoop
|
|
from tests._wiring import wire
|
|
|
|
|
|
class _StubProvider:
|
|
"""Construction reads the default model; no turn is ever run here."""
|
|
|
|
def get_default_model(self) -> str:
|
|
return "stub-model"
|
|
|
|
async def chat_with_retry(self, **kwargs): # pragma: no cover - never invoked
|
|
raise NotImplementedError
|
|
|
|
|
|
def _write_switches(path: Path, names: list[str]) -> None:
|
|
path.write_text(json.dumps({"tools": {"disabledTools": names}}), encoding="utf-8")
|
|
|
|
|
|
def _loop(tmp_path: Path, **kwargs) -> AgentLoop:
|
|
return AgentLoop(provider=_StubProvider(), workspace=tmp_path / "ws", **wire(**kwargs))
|
|
|
|
|
|
def _offered(loop: AgentLoop) -> set[str]:
|
|
return {d["function"]["name"] for d in loop.tools.get_definitions()}
|
|
|
|
|
|
class TestTheFileIsTheAuthority:
|
|
"""The direction that used to be impossible. Asserted through the assembled
|
|
array rather than through ``_withheld_tool_names``, because the array is what a
|
|
turn actually sends and the helper is an implementation detail of it."""
|
|
|
|
def test_a_switch_flipped_after_startup_is_honoured(self, tmp_path: Path, monkeypatch) -> None:
|
|
cfg = tmp_path / "config.json"
|
|
_write_switches(cfg, [])
|
|
monkeypatch.setattr("raven.home._current_config_path", cfg)
|
|
loop = _loop(tmp_path)
|
|
assert "grep" in _offered(loop)
|
|
|
|
_write_switches(cfg, ["grep"])
|
|
|
|
assert "grep" not in _offered(loop)
|
|
|
|
def test_and_so_is_flipping_it_back(self, tmp_path: Path, monkeypatch) -> None:
|
|
"""The regression this file exists for: a tool that was off when the
|
|
process started must be reachable again once the file stops saying so. The
|
|
boot-time copy of the config's own list outvoted the live read, so the
|
|
page could remove the name and nothing changed until the next restart --
|
|
and then only until the next time it was switched off."""
|
|
cfg = tmp_path / "config.json"
|
|
_write_switches(cfg, ["grep"])
|
|
monkeypatch.setattr("raven.home._current_config_path", cfg)
|
|
loop = _loop(tmp_path)
|
|
assert "grep" not in _offered(loop)
|
|
|
|
_write_switches(cfg, [])
|
|
|
|
assert "grep" in _offered(loop)
|
|
|
|
def test_the_config_list_is_not_copied_at_construction(self, tmp_path: Path, monkeypatch) -> None:
|
|
"""The same fact stated where it broke, so a future caller re-adding
|
|
``disabled_tools=config.tools.disabled_tools`` at a CLI site is caught by
|
|
name rather than by the symptom two layers away."""
|
|
cfg = tmp_path / "config.json"
|
|
_write_switches(cfg, ["grep"])
|
|
monkeypatch.setattr("raven.home._current_config_path", cfg)
|
|
|
|
loop = _loop(tmp_path)
|
|
|
|
assert loop._disabled_tools == set()
|
|
|
|
|
|
class TestTheHarnessListStillHolds:
|
|
"""``benchmarks/appworld/agent_cli.py`` passes ten names directly and has no
|
|
config file behind them, so the constructor path cannot simply be deleted."""
|
|
|
|
def test_a_constructor_name_is_withheld_with_no_config_at_all(self, tmp_path: Path, monkeypatch) -> None:
|
|
monkeypatch.setattr("raven.home._current_config_path", tmp_path / "absent.json")
|
|
|
|
loop = _loop(tmp_path, disabled_tools=["grep"])
|
|
|
|
assert "grep" not in _offered(loop)
|
|
|
|
def test_it_survives_a_config_that_does_not_mention_it(self, tmp_path: Path, monkeypatch) -> None:
|
|
"""A union rather than a fallback: an empty list in the file is a real
|
|
answer, and it must not hand the harness back a tool it excluded."""
|
|
cfg = tmp_path / "config.json"
|
|
_write_switches(cfg, [])
|
|
monkeypatch.setattr("raven.home._current_config_path", cfg)
|
|
|
|
loop = _loop(tmp_path, disabled_tools=["grep"])
|
|
|
|
assert "grep" not in _offered(loop)
|
|
|
|
def test_the_two_sources_add_up(self, tmp_path: Path, monkeypatch) -> None:
|
|
cfg = tmp_path / "config.json"
|
|
_write_switches(cfg, ["read_file"])
|
|
monkeypatch.setattr("raven.home._current_config_path", cfg)
|
|
|
|
loop = _loop(tmp_path, disabled_tools=["grep"])
|
|
offered = _offered(loop)
|
|
|
|
assert "grep" not in offered
|
|
assert "read_file" not in offered
|
|
assert "write_file" in offered
|