Raven-1/scripts/commit_lint.py

96 lines
2.4 KiB
Python
Raw Permalink Normal View History

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
"""The shared lint rules for commit messages, PR titles, and PR bodies."""
from __future__ import annotations
import re
from dataclasses import dataclass
ALLOWED_TYPES = {
"feat",
"fix",
"docs",
"refactor",
"perf",
"test",
"build",
"ci",
"chore",
"revert",
}
HEADER_RE = re.compile(r"^(?P<type>[a-z]+)(?:\((?P<scope>[a-z0-9_*.-]+)\))?: (?P<subject>.+)$")
@dataclass(frozen=True)
class LintResult:
errors: list[str]
@property
def ok(self) -> bool:
return not self.errors
fix(commitlint): unify commit/PR length to header-max-length (#196) ## Change description Follow-up to #187 (which fixed the subject-case dimension). The length dimension had the same "passes the PR, fails after merge" flaw: `scripts/commit_lint.py` capped the subject at 72 (commits) / 90 (PR titles) while commitlint capped the whole header at 100, so a PR title with a 73-90 char subject passed the pre-merge PR-title check but failed commit-lint on the squash commit after merge. This makes commitlint `header-max-length` (100) the single length authority (the config-conventional standard) and removes the bespoke Python 72/90 caps. CI now validates the PR title as the prospective squash header `<title> (#NN)` (in the commit-messages job, which already has Node), so a title that passes cannot fail after merge; the `edited` trigger re-checks title edits. Deliberately NOT `extends @commitlint/config-conventional`, to avoid pulling in body/footer line-length rules. Verified locally: proper-noun titles pass, a 79-char subject (header 102) is now rejected at PR stage, header exactly 100 passes and 101 fails, Title Case still rejected, `tests/test_commit_lint.py` green. ## Type of change - [x] Bug fix - [ ] New feature - [ ] Document - [ ] Others ## Related issues (if there is) Closes #195 ## Checklists ### Development - [x] Lint rules pass locally - [x] Application changes have been tested thoroughly - [x] Automated tests covering modified code pass ### Security - [x] Security impact of change has been considered - [x] Code follows security best practices and guidelines ### Code review - [x] Pull request has a descriptive title and context useful to a reviewer. Screenshots or screencasts are attached as necessary Co-authored-by: Claude (claude-opus-4-8) <noreply@anthropic.com>
2026-07-23 16:25:22 +08:00
def check_commit_message(message: str) -> LintResult:
return _check_message(message)
fix(commitlint): unify commit/PR length to header-max-length (#196) ## Change description Follow-up to #187 (which fixed the subject-case dimension). The length dimension had the same "passes the PR, fails after merge" flaw: `scripts/commit_lint.py` capped the subject at 72 (commits) / 90 (PR titles) while commitlint capped the whole header at 100, so a PR title with a 73-90 char subject passed the pre-merge PR-title check but failed commit-lint on the squash commit after merge. This makes commitlint `header-max-length` (100) the single length authority (the config-conventional standard) and removes the bespoke Python 72/90 caps. CI now validates the PR title as the prospective squash header `<title> (#NN)` (in the commit-messages job, which already has Node), so a title that passes cannot fail after merge; the `edited` trigger re-checks title edits. Deliberately NOT `extends @commitlint/config-conventional`, to avoid pulling in body/footer line-length rules. Verified locally: proper-noun titles pass, a 79-char subject (header 102) is now rejected at PR stage, header exactly 100 passes and 101 fails, Title Case still rejected, `tests/test_commit_lint.py` green. ## Type of change - [x] Bug fix - [ ] New feature - [ ] Document - [ ] Others ## Related issues (if there is) Closes #195 ## Checklists ### Development - [x] Lint rules pass locally - [x] Application changes have been tested thoroughly - [x] Automated tests covering modified code pass ### Security - [x] Security impact of change has been considered - [x] Code follows security best practices and guidelines ### Code review - [x] Pull request has a descriptive title and context useful to a reviewer. Screenshots or screencasts are attached as necessary Co-authored-by: Claude (claude-opus-4-8) <noreply@anthropic.com>
2026-07-23 16:25:22 +08:00
def check_pr_title(title: str) -> LintResult:
return _check_message(title)
ci: enforce ascii-only pr body and widen the self-check grep (#98) ## Summary A non-ASCII PR body slipped onto main via #97: the repo squash-merges with the PR description as the commit body, but nothing checked that body before merge, so an em-dash only tripped the post-merge commit lint on main (too late to fix cleanly). Close the gap at both the guidance and the enforcement layer. - Enforcement (CI): add `check_pr_body` (ASCII-only, reusing `commit_lint._is_ascii`) and a "Validate PR body" step in the pull_request job, so a non-ASCII PR body fails the PR check before merge and points at the offending line. - Guidance (AGENTS.md 3.7): the preview grep now uses `[^\x00-\x7F]` (any non-ASCII), not a CJK-only pattern that gave a false pass. - Guidance (AGENTS.md 3.1.1): state the punctuation rule is ASCII-only, not merely no-full-width (calls out em-dash / curly quotes / ellipsis). ## Type - [x] CI / tooling - [x] Docs ## Verification - [x] Relevant tests pass locally ``` uv run pytest tests/test_commit_lint.py -q # 12 passed PR_BODY="line with a non-ascii dash" python3 scripts/check_pr_body.py # exit 1, flags line python3 scripts/check_commit_messages.py "origin/main..HEAD" # PASS grep -nP "[^\x00-\x7F]" <this body> # 0 matches ``` ## Risk - [x] Backward compatibility considered The new check runs in the existing required pull_request job, so it is enforced immediately without a new required-check name. ASCII-only PR bodies are already implied by the squash-to-main constraint, so this only moves the check earlier (pre-merge instead of post-merge). ## Related Issues N/A (follow-up to the commit-lint failure on #97) --------- Co-authored-by: Claude (claude-opus-4-8) <noreply@anthropic.com>
2026-07-07 21:20:25 +08:00
def check_pr_body(body: str) -> LintResult:
"""The PR body becomes the squash commit body, so it must be ASCII-only.
Only the ASCII rule applies (the body is free-form Markdown, not a
Conventional-Commits header), so the header/subject checks are skipped.
"""
errors: list[str] = []
if not _is_ascii(body):
errors.append("must be ASCII-only English")
return LintResult(errors)
fix(commitlint): unify commit/PR length to header-max-length (#196) ## Change description Follow-up to #187 (which fixed the subject-case dimension). The length dimension had the same "passes the PR, fails after merge" flaw: `scripts/commit_lint.py` capped the subject at 72 (commits) / 90 (PR titles) while commitlint capped the whole header at 100, so a PR title with a 73-90 char subject passed the pre-merge PR-title check but failed commit-lint on the squash commit after merge. This makes commitlint `header-max-length` (100) the single length authority (the config-conventional standard) and removes the bespoke Python 72/90 caps. CI now validates the PR title as the prospective squash header `<title> (#NN)` (in the commit-messages job, which already has Node), so a title that passes cannot fail after merge; the `edited` trigger re-checks title edits. Deliberately NOT `extends @commitlint/config-conventional`, to avoid pulling in body/footer line-length rules. Verified locally: proper-noun titles pass, a 79-char subject (header 102) is now rejected at PR stage, header exactly 100 passes and 101 fails, Title Case still rejected, `tests/test_commit_lint.py` green. ## Type of change - [x] Bug fix - [ ] New feature - [ ] Document - [ ] Others ## Related issues (if there is) Closes #195 ## Checklists ### Development - [x] Lint rules pass locally - [x] Application changes have been tested thoroughly - [x] Automated tests covering modified code pass ### Security - [x] Security impact of change has been considered - [x] Code follows security best practices and guidelines ### Code review - [x] Pull request has a descriptive title and context useful to a reviewer. Screenshots or screencasts are attached as necessary Co-authored-by: Claude (claude-opus-4-8) <noreply@anthropic.com>
2026-07-23 16:25:22 +08:00
def _check_message(message: str) -> LintResult:
errors: list[str] = []
text = message.strip()
header = text.splitlines()[0] if text else ""
if header.startswith(("fixup!", "squash!")):
errors.append("fixup/squash commits are not allowed")
return LintResult(errors)
if header.startswith("Merge "):
errors.append("merge commits are not allowed in PR ranges")
return LintResult(errors)
if not _is_ascii(text):
errors.append("must be ASCII-only English")
match = HEADER_RE.match(header)
if not match:
errors.append("must match <type>(<scope>): <subject>")
return LintResult(errors)
commit_type = match.group("type")
subject = match.group("subject")
if commit_type not in ALLOWED_TYPES:
errors.append(f"type must be one of: {', '.join(sorted(ALLOWED_TYPES))}")
first_alpha = next((ch for ch in subject if ch.isalpha()), "")
if first_alpha and not first_alpha.islower():
errors.append("subject must start lowercase")
if subject.endswith((".", "!", "?")):
errors.append("subject must not end with punctuation")
return LintResult(errors)
def _is_ascii(text: str) -> bool:
try:
text.encode("ascii")
except UnicodeEncodeError:
return False
return True