## 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.
110 lines
3.3 KiB
Python
110 lines
3.3 KiB
Python
"""The commit/PR lint rules: accepted shapes and every rejection reason."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import subprocess
|
|
from pathlib import Path
|
|
|
|
from scripts import check_commit_file
|
|
from scripts.commit_lint import (
|
|
check_commit_message,
|
|
check_pr_body,
|
|
check_pr_title,
|
|
)
|
|
|
|
|
|
def test_accepts_valid_conventional_commit_with_scope() -> None:
|
|
result = check_commit_message("docs(readme): sharpen launch positioning")
|
|
|
|
assert result.ok
|
|
assert result.errors == []
|
|
|
|
|
|
def test_rejects_missing_conventional_commit_type() -> None:
|
|
result = check_commit_message("update README")
|
|
|
|
assert not result.ok
|
|
assert "must match <type>(<scope>): <subject>" in result.errors[0]
|
|
|
|
|
|
def test_rejects_cjk_and_full_width_punctuation() -> None:
|
|
result = check_commit_message("docs: 更新 README。")
|
|
|
|
assert not result.ok
|
|
assert "must be ASCII-only English" in result.errors
|
|
|
|
|
|
def test_rejects_uppercase_subject_and_trailing_period() -> None:
|
|
result = check_commit_message("docs: Update README.")
|
|
|
|
assert not result.ok
|
|
assert "subject must start lowercase" in result.errors
|
|
assert "subject must not end with punctuation" in result.errors
|
|
|
|
|
|
def test_python_checker_does_not_enforce_length() -> None:
|
|
# Length is owned solely by commitlint (header-max-length); the Python
|
|
# checker must not re-impose a subject-length cap of its own.
|
|
result = check_commit_message("docs: " + "a" * 200)
|
|
|
|
assert result.ok
|
|
|
|
|
|
def test_rejects_fixup_and_merge_subjects() -> None:
|
|
fixup = check_commit_message("fixup! docs: sharpen launch positioning")
|
|
merge = check_commit_message("Merge branch 'main' into feature")
|
|
|
|
assert not fixup.ok
|
|
assert not merge.ok
|
|
assert "fixup/squash commits are not allowed" in fixup.errors
|
|
assert "merge commits are not allowed in PR ranges" in merge.errors
|
|
|
|
|
|
def test_pr_title_matches_commit_message_rules() -> None:
|
|
assert check_pr_title("docs(readme): sharpen launch positioning").ok
|
|
assert not check_pr_title("update README").ok
|
|
|
|
|
|
def test_pr_body_accepts_ascii_markdown() -> None:
|
|
result = check_pr_body("## Summary\n\nPlain ASCII body - fine.\n")
|
|
|
|
assert result.ok
|
|
|
|
|
|
def test_pr_body_rejects_em_dash() -> None:
|
|
# The em-dash (U+2014) is the char that slipped past the CJK-only grep and
|
|
# failed the post-merge commit lint once the PR body became the squash body.
|
|
result = check_pr_body("drops the hint only — empty submits still ignored")
|
|
|
|
assert not result.ok
|
|
assert "must be ASCII-only English" in result.errors
|
|
|
|
|
|
def test_pr_body_allows_empty() -> None:
|
|
assert check_pr_body("").ok
|
|
|
|
|
|
def test_commit_msg_hook_runs_commitlint_before_python_checker(monkeypatch, tmp_path: Path) -> None:
|
|
message_file = tmp_path / "COMMIT_EDITMSG"
|
|
message_file.write_text("docs: add launch notes\n")
|
|
calls: list[list[str]] = []
|
|
|
|
def fake_run(cmd: list[str], check: bool) -> subprocess.CompletedProcess:
|
|
calls.append(cmd)
|
|
return subprocess.CompletedProcess(cmd, 0)
|
|
|
|
monkeypatch.setattr(check_commit_file.subprocess, "run", fake_run)
|
|
|
|
assert check_commit_file.main([str(message_file)]) == 0
|
|
assert calls == [
|
|
[
|
|
"npx",
|
|
"--no-install",
|
|
"commitlint",
|
|
"--edit",
|
|
str(message_file),
|
|
"--config",
|
|
"commitlint.config.cjs",
|
|
]
|
|
]
|