gitutil.py 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787
  1. """
  2. Leaf git/subprocess helpers and diff parsing for the security-guidance plugin.
  3. Everything here is a thin wrapper over ``git``/``subprocess`` plus pure
  4. diff-text parsing and source-file classification. None of these functions
  5. reference any name that the test suite monkeypatches on
  6. ``security_reminder_hook`` and then calls *through* another function in this
  7. module — that property is what makes them safe to live in their own module
  8. while still being re-exported (so tests that patch ``hook._git_toplevel`` and
  9. then call a handler in ``security_reminder_hook`` continue to see the patched
  10. binding).
  11. Functions that DO compose patched leaves (``compute_v2_review_set``,
  12. ``_list_untracked``, ``_append_reviewed_shas``) deliberately remain in
  13. ``security_reminder_hook.py`` for that reason.
  14. """
  15. import contextlib
  16. import os
  17. import re
  18. import subprocess
  19. from _base import debug_log
  20. GIT_CMD = [
  21. "git",
  22. "-c", "core.fsmonitor=false",
  23. "-c", "core.hooksPath=/dev/null",
  24. ]
  25. def _git_rev_parse_head(cwd):
  26. """Return the current HEAD SHA, or None if not a git repo / no commits."""
  27. try:
  28. # See #2099: text=True on Windows cp1252 crashes the reader thread on
  29. # any UTF-8 byte undefined in cp1252 (e.g. via a git error message
  30. # referencing a non-ASCII filename in stderr). stdout is a SHA so it
  31. # IS safe; stderr is not. capture_output=True with bytes-by-default
  32. # never decodes, so the reader thread can't crash.
  33. result = subprocess.run(
  34. [*GIT_CMD, "rev-parse", "HEAD"],
  35. cwd=cwd, capture_output=True, timeout=5
  36. )
  37. if result.returncode == 0 and result.stdout.strip():
  38. return result.stdout.decode("utf-8", errors="replace").strip()
  39. return None
  40. except (subprocess.TimeoutExpired, FileNotFoundError, OSError):
  41. return None
  42. def _find_git_index(cwd):
  43. """
  44. Find the real index file for a git repo. Handles worktrees where .git
  45. is a file pointing to the main repo's gitdir.
  46. Returns the absolute path to the index file, or None.
  47. """
  48. try:
  49. # See #2099: stdout here is a PATH which can contain non-ASCII bytes
  50. # (e.g. C:\אבטחה\repo\.git). text=True decodes via cp1252 strict on
  51. # Windows → crashes the reader thread → returns stdout=None →
  52. # caller does .strip() on None → AttributeError. Decode manually.
  53. result = subprocess.run(
  54. [*GIT_CMD, "rev-parse", "--git-dir"],
  55. cwd=cwd, capture_output=True, timeout=5
  56. )
  57. if result.returncode != 0:
  58. return None
  59. git_dir = result.stdout.decode("utf-8", errors="replace").strip()
  60. if not os.path.isabs(git_dir):
  61. git_dir = os.path.join(cwd, git_dir)
  62. index_path = os.path.join(git_dir, "index")
  63. return index_path if os.path.isfile(index_path) else None
  64. except (subprocess.TimeoutExpired, FileNotFoundError, OSError):
  65. return None
  66. def _diff_pathspec(cwd, paths):
  67. """Convert absolute touched-paths to repo-relative pathspec args for
  68. git diff. Paths outside cwd (e.g. ~/.claude/…) are dropped. Returns the
  69. list to splice after `--`, or [] for an unrestricted diff. realpath both
  70. sides so the macOS /var ↔ /private/var symlink doesn't make in-repo
  71. paths look external."""
  72. if not paths:
  73. return []
  74. cwd_abs = os.path.realpath(cwd)
  75. rel = []
  76. for p in paths:
  77. try:
  78. r = os.path.relpath(os.path.realpath(p), cwd_abs)
  79. except ValueError:
  80. continue
  81. if r.startswith(".."):
  82. continue
  83. rel.append(r)
  84. return ["--"] + rel if rel else []
  85. @contextlib.contextmanager
  86. def _temp_index(cwd, untracked_paths=None):
  87. """Yield an env dict pointing GIT_INDEX_FILE at a throwaway copy of the
  88. repo's index with `git add --intent-to-add` applied, so untracked files
  89. show up in subsequent `git diff` calls without touching the user's real
  90. index. Yields None if no index can be found (bare repo / not a repo); the
  91. caller should fall back to a plain diff. Always cleans up the temp file.
  92. Perf: when `untracked_paths` is given, only those paths are added (O(n)
  93. in untracked count). The default `add -N .` stats every file in the
  94. worktree — slow in large repos vs fast targeted scan. v2 callers
  95. already know the untracked set from `git status --porcelain`, so they
  96. pass it; v1 keeps the whole-tree scan since it has no prior list."""
  97. import shutil
  98. import tempfile
  99. real_index = _find_git_index(cwd)
  100. if not real_index:
  101. yield None
  102. return
  103. tmp_fd, tmp_index = tempfile.mkstemp(prefix="security_hook_idx_")
  104. os.close(tmp_fd)
  105. try:
  106. shutil.copy2(real_index, tmp_index)
  107. env = {**os.environ, "GIT_INDEX_FILE": tmp_index}
  108. if untracked_paths is None:
  109. add_args = ["."]
  110. elif untracked_paths:
  111. # `git add -N -- a b nonexistent` is atomic — one missing path
  112. # makes it exit 128 and add NOTHING, so a file removed between
  113. # `git status` and here would silently drop ALL untracked files
  114. # from the diff. --ignore-missing only works with --dry-run, so
  115. # filter to surviving paths (lexists so dangling symlinks count).
  116. surviving = [p for p in untracked_paths
  117. if os.path.lexists(os.path.join(cwd, p))]
  118. add_args = ["--"] + surviving if surviving else None
  119. else:
  120. add_args = None
  121. if add_args:
  122. # No stdout used here (only returncode matters), but text=True
  123. # still spawns reader threads that decode stderr — git error
  124. # messages can reference non-ASCII filenames and crash on
  125. # cp1252. See #2099. Drop text=True so bytes stay raw.
  126. subprocess.run(
  127. [*GIT_CMD, "add", "--intent-to-add"] + add_args,
  128. cwd=cwd, capture_output=True, timeout=10,
  129. env=env,
  130. )
  131. yield env
  132. finally:
  133. try:
  134. os.unlink(tmp_index)
  135. except OSError:
  136. pass
  137. def _git_toplevel(cwd):
  138. """Absolute repo root for `cwd`, or None if not in a work tree."""
  139. try:
  140. # See #2099: stdout is a PATH — `C:\אבטחה\repo` returned as UTF-8
  141. # bytes by git. text=True would decode via cp1252 strict on Windows
  142. # → reader-thread crash. Decode manually with errors="replace".
  143. r = subprocess.run(
  144. [*GIT_CMD, "rev-parse", "--show-toplevel"],
  145. cwd=cwd, capture_output=True, timeout=5,
  146. )
  147. if r.returncode != 0:
  148. return None
  149. path = r.stdout.decode("utf-8", errors="replace").strip()
  150. return path if path else None
  151. except (subprocess.TimeoutExpired, FileNotFoundError, OSError):
  152. return None
  153. def _git_dir(repo_root):
  154. """Absolute shared `.git` directory for repo_root.
  155. Uses `rev-parse --git-common-dir` so linked worktrees resolve to the
  156. SHARED gitdir, not the per-worktree `.git/worktrees/<name>/`. That way
  157. push-sweep's reviewed-shas record (and the bash-hook-once sentinel)
  158. is per-clone — a commit reviewed in one worktree counts as reviewed
  159. if a different worktree later pushes it. Returns None on failure so
  160. callers can degrade (push-sweep state is best-effort).
  161. """
  162. try:
  163. # See #2099: stdout is a PATH (shared gitdir), may be non-ASCII.
  164. # Decode bytes manually to avoid cp1252 reader-thread crash.
  165. r = subprocess.run(
  166. [*GIT_CMD, "rev-parse", "--git-common-dir"],
  167. cwd=repo_root, capture_output=True, timeout=5,
  168. )
  169. if r.returncode != 0:
  170. return None
  171. d = r.stdout.decode("utf-8", errors="replace").strip()
  172. return d if os.path.isabs(d) else os.path.join(repo_root, d)
  173. except (subprocess.TimeoutExpired, FileNotFoundError, OSError):
  174. return None
  175. def _git_rev_list_range(repo_root, base, head="HEAD"):
  176. """Shas in `base..head`, oldest→newest. Empty list on error."""
  177. try:
  178. # See #2099: stdout is ASCII SHAs, but stderr can carry git error
  179. # messages referencing non-ASCII filenames — keep bytes raw.
  180. r = subprocess.run(
  181. [*GIT_CMD, "rev-list", "--reverse", f"{base}..{head}"],
  182. cwd=repo_root, capture_output=True, timeout=10,
  183. )
  184. if r.returncode != 0:
  185. return []
  186. return [s for s in r.stdout.decode("utf-8", errors="replace").strip().split("\n") if s]
  187. except (subprocess.TimeoutExpired, FileNotFoundError, OSError):
  188. return []
  189. def _git_diff_range(repo_root, base, head="HEAD"):
  190. """`git diff -p base head` as text on success, None on error.
  191. Distinguishing failure from success-with-empty-diff matters: the push-sweep
  192. caller marks the tail reviewed when the diff is empty (nothing to review),
  193. but on failure (timeout, non-zero exit, missing git) it must NOT mark
  194. them reviewed — otherwise unreviewed commits get permanently silenced.
  195. """
  196. try:
  197. # core.quotePath=false makes git emit raw UTF-8 in `diff --git a/... b/...`
  198. # headers instead of C-quoting non-ASCII path bytes (`"a/\303\201vila/..."`
  199. # vs `a/Ávila/...`). The downstream `re.match(r'^a/(.+?) b/(.+)$', ...)`
  200. # in parse_diff_into_files / extract_file_paths_from_diff matches the
  201. # raw form only — quoted headers slip past and the entire file is
  202. # silently dropped from review. See #2082 (sibling of #2056 / #2075).
  203. r = subprocess.run(
  204. [*GIT_CMD, "-c", "core.quotePath=false",
  205. "diff", "-p", "--no-color", "--no-ext-diff", base, head],
  206. cwd=repo_root, capture_output=True, timeout=30,
  207. )
  208. if r.returncode != 0:
  209. return None
  210. return r.stdout.decode("utf-8", errors="replace")
  211. except (subprocess.TimeoutExpired, FileNotFoundError, OSError):
  212. return None
  213. def _detect_main_branch(repo_root):
  214. for ref in ("origin/HEAD", "origin/main", "origin/master", "main", "master"):
  215. try:
  216. # See #2099: stdout is a SHA but stderr can carry non-ASCII git
  217. # warnings — keep bytes raw to avoid cp1252 reader-thread crash.
  218. r = subprocess.run(
  219. [*GIT_CMD, "rev-parse", "--verify", "-q", ref],
  220. cwd=repo_root, capture_output=True, timeout=5,
  221. )
  222. if r.returncode == 0 and r.stdout.strip():
  223. return ref
  224. except (subprocess.TimeoutExpired, FileNotFoundError, OSError):
  225. pass
  226. return None
  227. def _git_reflog_recent_commits(repo_root, max_age_s=120, max_n=5):
  228. """Return (fresh_commit_shas, stale_count) from the HEAD reflog.
  229. Scans the last `max_n` reflog entries and returns the SHAs whose action is
  230. `commit*` AND whose commit timestamp is within `max_age_s` of now,
  231. newest-first. `stale_count` is the number of commit-action entries that
  232. were too old (so the caller can distinguish "no commit happened" from
  233. "commit happened earlier than the window").
  234. Used by commit-review when stdout-based `[branch sha]` detection fails
  235. (output piped/redirected/-q, or a chained command after `git commit`
  236. pushed the success line off — `git commit && git push` makes HEAD@{0}
  237. `update by push`, not `commit:`). The HEAD@{0}-only check
  238. keeps the not-yet-visible-HEAD skip rare; analysis showed the
  239. residual is dominated by these chained-command and noop-guard cases.
  240. Safety vs. blindly reading HEAD:
  241. - cross-repo (`cd ../other && git commit`): repo_root's own reflog has
  242. no fresh commit, so this returns ([], 0).
  243. - commit actually failed (pre-commit reject, nothing-staged): reflog's
  244. recent entries are the prior checkout/commit/reset → ([], 0) or only
  245. stale entries.
  246. - HEAD raced ahead (a second commit landed before this async hook ran):
  247. both commits appear in the scan and both get reviewed — correct.
  248. - prior Bash call's commit within the window: would be returned here,
  249. but the call site deduplicates against `.git/sg-reviewed-shas` so a
  250. SHA is reviewed at most once. This is also the non-overlap invariant
  251. with push-sweep.
  252. """
  253. if not repo_root:
  254. return [], 0
  255. try:
  256. # %gs (the reflog subject) is `commit: <commit-msg first line>` and can
  257. # contain `|`; put it LAST so split("|", 2) leaves it intact. %H is
  258. # hex and %ct is integer, so the first two fields are delimiter-safe.
  259. #
  260. # Bytes + decode utf-8/replace: %gs embeds commit-message subjects
  261. # which git stores as raw bytes — commits can be authored in
  262. # latin-1 / cp1252 / shift-jis etc., and text=True would raise
  263. # UnicodeDecodeError in the subprocess reader thread on Windows
  264. # cp1252 (subprocess.run returns r.stdout=None, then
  265. # r.stdout.splitlines() AttributeErrors). Mirrors the existing
  266. # migration at security_reminder_hook.py:540 — same pattern was
  267. # missed here. See anthropics/claude-plugins-official#2056.
  268. r = subprocess.run(
  269. [*GIT_CMD, "log", "-g", "-n", str(max_n),
  270. "--format=%H|%ct|%gs", "HEAD"],
  271. cwd=repo_root, capture_output=True, timeout=5,
  272. )
  273. except (subprocess.TimeoutExpired, FileNotFoundError, OSError, ValueError):
  274. return [], 0
  275. if r.returncode != 0:
  276. return [], 0
  277. stdout = (r.stdout or b"").decode("utf-8", errors="replace")
  278. import time as _time
  279. now = int(_time.time())
  280. fresh, stale = [], 0
  281. for idx, line in enumerate(stdout.splitlines()):
  282. parts = line.split("|", 2)
  283. if len(parts) != 3:
  284. continue
  285. sha, ct, subject = parts
  286. # `commit: msg`, `commit (amend): msg`, `commit (initial): msg`,
  287. # `commit (merge): msg` — all create a reviewable commit object.
  288. if not subject.startswith("commit"):
  289. continue
  290. try:
  291. age = now - int(ct)
  292. except ValueError:
  293. continue
  294. # HEAD@{0} (idx==0) is exempt from the age gate. The gate exists to
  295. # bound the WIDENED HEAD@{1..max_n-1} scan from picking up commits
  296. # made by *prior* Bash calls; HEAD@{0} is by definition the most
  297. # recent reflog entry and was previously accepted unconditionally
  298. # (_git_reflog_head_if_just_committed previously had no age check).
  299. # Applying max_age_s to idx==0 made the not-yet-visible-HEAD skip
  300. # noticeably more frequent on chained
  301. # `git commit && <slow command>` where %ct is >120s old by the
  302. # time the async PostToolUse hook fires.
  303. if idx == 0 or age <= max_age_s:
  304. fresh.append(sha)
  305. else:
  306. stale += 1
  307. return fresh, stale
  308. def _git_name_only(cwd, base, include_untracked=False):
  309. """Return the set of repo-root-relative paths that differ from `base`,
  310. or None if git failed (unresolvable ref, not a repo, timeout). Callers
  311. must distinguish None (error → don't trust as a filter) from set()
  312. (genuinely nothing changed). `-c core.quotePath=false -z` keeps non-ASCII
  313. and space-containing paths intact."""
  314. # Decode stdout/stderr as UTF-8 with errors="replace" instead of using
  315. # text=True. core.quotePath=false makes git emit raw UTF-8 for non-ASCII
  316. # paths, and text=True on Windows decodes via cp1252 strict — a non-ASCII
  317. # changed path would crash the subprocess reader thread, leave
  318. # result.stdout=None, and propagate AttributeError out of the helper.
  319. # Same fix shape as diffstate._list_untracked. See #2056.
  320. def _run(env):
  321. result = subprocess.run(
  322. [*GIT_CMD, "-c", "core.quotePath=false", "diff", "--name-only", "-z", base],
  323. cwd=cwd, capture_output=True, timeout=30,
  324. env=env,
  325. )
  326. if result.returncode != 0:
  327. stderr_str = (result.stderr or b"").decode("utf-8", errors="replace")
  328. debug_log(f"_git_name_only({base!r}) rc={result.returncode}: {stderr_str[:200]}")
  329. return None
  330. stdout = (result.stdout or b"").decode("utf-8", errors="replace")
  331. return {p for p in stdout.split("\0") if p}
  332. try:
  333. if not include_untracked:
  334. return _run(None)
  335. with _temp_index(cwd) as env:
  336. return _run(env)
  337. except (subprocess.TimeoutExpired, FileNotFoundError, OSError, ValueError) as e:
  338. debug_log(f"_git_name_only({base!r}) error: {e}")
  339. return None
  340. def _git_status_porcelain(cwd):
  341. """One `git status --porcelain=v1 -z` → (tracked_dirty, untracked) sets of
  342. repo-root-relative paths, or (None, None) on error. Replaces the
  343. `_temp_index + git diff HEAD --name-only` pair for the v2 dirty_now
  344. computation: faster in large repos, and yields the
  345. untracked set separately so the later get_git_diff can do a targeted
  346. `add -N -- <files>` instead of a whole-tree `add -N .`.
  347. -uall: list individual files inside untracked directories (default
  348. collapses to `dir/`). Required so the untracked set subtracts cleanly
  349. against the UPS-time `_list_untracked` snapshot, which uses ls-files and
  350. therefore always lists individual files."""
  351. # Lenient decode: same UTF-8 + errors="replace" pattern as the
  352. # sibling helpers — a non-ASCII path in the worktree would otherwise
  353. # crash the cp1252 reader thread on Windows. See #2056.
  354. try:
  355. r = subprocess.run(
  356. [*GIT_CMD, "-c", "core.quotePath=false", "status",
  357. "--porcelain=v1", "-uall", "-z"],
  358. cwd=cwd, capture_output=True, timeout=30,
  359. )
  360. if r.returncode != 0:
  361. stderr_str = (r.stderr or b"").decode("utf-8", errors="replace")
  362. debug_log(f"_git_status_porcelain rc={r.returncode}: {stderr_str[:200]}")
  363. return None, None
  364. tracked, untracked = set(), set()
  365. stdout = (r.stdout or b"").decode("utf-8", errors="replace")
  366. entries = stdout.split("\0")
  367. i = 0
  368. while i < len(entries):
  369. e = entries[i]
  370. if not e:
  371. i += 1
  372. continue
  373. xy, path = e[:2], e[3:]
  374. if xy == "??":
  375. untracked.add(path)
  376. else:
  377. tracked.add(path)
  378. # Rename/copy entries are XY old\0new\0 — second NUL field is
  379. # the origin path; consume it so it isn't misparsed as a new
  380. # 2-char-status entry.
  381. if "R" in xy or "C" in xy:
  382. i += 1
  383. i += 1
  384. return tracked, untracked
  385. except (subprocess.TimeoutExpired, FileNotFoundError, OSError, ValueError) as e:
  386. # ValueError guards against any future strict-decode regression
  387. # so the helper degrades to (None, None) instead of crashing.
  388. debug_log(f"_git_status_porcelain error: {e}")
  389. return None, None
  390. def _is_ancestor(cwd, maybe_ancestor, descendant):
  391. """True if `maybe_ancestor` is reachable from `descendant` (i.e. HEAD
  392. moved forward via commit/merge, not sideways via checkout)."""
  393. try:
  394. # See #2099: only returncode matters, but text=True spawns reader
  395. # threads that decode stderr — git error messages can carry non-ASCII
  396. # filenames. Drop text=True to keep bytes raw, avoid cp1252 crash.
  397. result = subprocess.run(
  398. [*GIT_CMD, "merge-base", "--is-ancestor", maybe_ancestor, descendant],
  399. cwd=cwd, capture_output=True, timeout=5,
  400. )
  401. return result.returncode == 0
  402. except (subprocess.TimeoutExpired, FileNotFoundError, OSError):
  403. return False
  404. def get_git_diff(cwd, baseline_sha, full_context=False, paths=None, untracked_paths=None):
  405. """
  406. Get the git diff between the baseline SHA and the current working tree,
  407. including untracked (new) files.
  408. Uses a temporary copy of the git index (GIT_INDEX_FILE) so the user's
  409. real index is never modified. The temp index gets intent-to-add entries
  410. for untracked files, making them visible in the diff output. Cleanup
  411. is just deleting the temp file in a finally block.
  412. If `paths` is given, the diff is restricted to those paths (relative to
  413. cwd; absolute paths are converted, paths outside cwd are dropped).
  414. `untracked_paths` (repo-root-relative) is forwarded to _temp_index so it
  415. can add only those files instead of scanning the whole worktree.
  416. """
  417. pathspec = _diff_pathspec(cwd, paths)
  418. if paths and not pathspec:
  419. # Caller restricted to specific paths but none are inside this repo
  420. # (e.g. only ~/.claude/... edits). Returning "" flows to skip(6); an
  421. # empty pathspec would mean an UNRESTRICTED diff — the bug this whole
  422. # change exists to fix.
  423. return ""
  424. # core.quotePath=false: emit raw UTF-8 in `diff --git a/... b/...` headers
  425. # so non-ASCII paths aren't C-quoted past the downstream parse_diff_into_files
  426. # regex. See #2082 (sibling of #2056 / #2075).
  427. cmd = [*GIT_CMD, "-c", "core.quotePath=false",
  428. "diff", "--no-color", "--no-ext-diff", baseline_sha] + (["--unified=99999"] if full_context else []) + pathspec
  429. try:
  430. with _temp_index(cwd, untracked_paths) as env:
  431. # env is None when no index could be found (bare repo / not a
  432. # repo) — diff still runs, just without untracked-file support.
  433. result = subprocess.run(cmd, cwd=cwd, capture_output=True, timeout=30, env=env)
  434. if result.returncode != 0:
  435. debug_log(f"git diff failed: {result.stderr[:200].decode('utf-8', errors='replace')}")
  436. return None
  437. # Decode with errors='replace' so binary diffs don't crash
  438. return result.stdout.decode("utf-8", errors="replace")
  439. except (subprocess.TimeoutExpired, FileNotFoundError, OSError) as e:
  440. debug_log(f"git diff error: {e}")
  441. return None
  442. # Source file extensions worth reviewing for security
  443. SOURCE_CODE_EXTENSIONS = {
  444. '.py', '.js', '.ts', '.jsx', '.tsx', '.go', '.java', '.rb', '.php',
  445. '.rs', '.c', '.cpp', '.h', '.hpp', '.cs', '.swift', '.kt', '.scala',
  446. '.html', '.htm', '.ejs', '.yaml', '.yml', '.properties',
  447. '.mjs', '.cjs', '.mts', '.cts', '.vue', '.svelte',
  448. '.sh', '.bash', '.zsh', '.fish', '.ksh', '.ps1', '.sql',
  449. '.gradle', '.groovy',
  450. '.tf', '.hcl', '.tfvars',
  451. '.json', '.toml', '.ipynb',
  452. }
  453. # Reviewable files identified by basename rather than extension (lowercased).
  454. # These are by-convention extensionless but contain executable recipes/DSL
  455. # with shell/exec surface (Make recipes, Jenkinsfile Groovy, Rakefile Ruby).
  456. SOURCE_CODE_BASENAMES = {
  457. 'dockerfile', 'makefile', 'gnumakefile', 'jenkinsfile', 'vagrantfile',
  458. 'rakefile', 'gemfile', 'procfile', 'brewfile', 'justfile',
  459. }
  460. # Extensionless basenames that are NOT source — plain-text metadata. Anything
  461. # extensionless not in this set is treated as source (likely a shebang script
  462. # under bin/ or scripts/). Analysis of skipped reviews found
  463. # extensionless executables (bin/deploy, scripts/run-canary) were the largest
  464. # remaining false-negative class — they carry shell-injection surface but
  465. # `splitext` gives '' so they were filtered out. _cap_files_for_prompt bounds
  466. # the byte cost downstream, and the reviewer ignores prose, so opting
  467. # extensionless IN with this small deny-list is the better default than
  468. # opting OUT.
  469. NON_SOURCE_EXTENSIONLESS_BASENAMES = {
  470. 'license', 'licence', 'copying', 'notice', 'patents', 'authors',
  471. 'contributors', 'maintainers', 'changelog', 'changes', 'news',
  472. 'readme', 'todo', 'install', 'version', 'codeowners',
  473. 'owners', 'copyright',
  474. }
  475. # Directory components and file suffixes that are never worth reviewing even
  476. # when the extension is in SOURCE_CODE_EXTENSIONS — vendored deps, build
  477. # output, generated code, minified bundles, lockfiles, protobuf stubs.
  478. # Matched as path *components* (so `node_modules/` matches anywhere in the
  479. # path, not just as a prefix) and as case-sensitive suffixes (the ecosystems
  480. # that emit `.min.js` / `_pb2.py` / `.pb.go` are case-consistent).
  481. SKIP_PATH_PATTERNS = (
  482. 'node_modules/', 'dist/', 'build/', '.next/', 'vendor/',
  483. '__generated__/', '__pycache__/', '.venv/', 'target/',
  484. )
  485. SKIP_FILE_SUFFIXES = (
  486. '.min.js', '.min.css', '.d.ts', '.d.mts', '.d.cts',
  487. '.lock', '_pb2.py', '.pb.go',
  488. )
  489. # Path tokens that bump a file's review priority when a commit exceeds
  490. # MAX_DIFF_FILES and we have to pick a subset. These are exactly the surfaces
  491. # single-shot and agentic reviews disagree on most (auth, routing, IPC,
  492. # subprocess, deserialization). Matched as lowercase substrings against the
  493. # path; not regex — keep it cheap.
  494. _SECURITY_RISK_PATH_TOKENS = (
  495. "auth", "login", "session", "token", "secret", "credential", "perm",
  496. "acl", "rbac", "iam", "policy",
  497. "route", "handler", "controller", "endpoint", "api/", "/api", "gateway",
  498. "middleware", "view",
  499. "exec", "subprocess", "shell", "spawn", "command",
  500. "client", "request", "fetch", "http", "url",
  501. "serialize", "pickle", "yaml", "parse", "deser",
  502. # Short tokens that would substring-match unrelated names (`format`,
  503. # `transform`, `sandbox`, `platform`) are intentionally omitted —
  504. # `sql`/`query` already cover the DB surface.
  505. "sql", "query",
  506. )
  507. # Suffixes that pass _is_reviewable_source but are almost always low-signal
  508. # in large scaffolds — generated clients, migrations, test fixtures, config
  509. # shims. These go to the BACK of the priority sort, not dropped outright.
  510. _LOW_PRIORITY_SUFFIXES = (
  511. ".gen.ts", ".gen.tsx", ".generated.ts", "_gen.py",
  512. ".test.ts", ".test.tsx", ".test.py", ".spec.ts", ".spec.js",
  513. ".config.js", ".config.ts", ".config.mjs", ".config.cjs",
  514. )
  515. _LOW_PRIORITY_PATH_TOKENS = (
  516. "/migrations/", "/alembic/versions/", "/__tests__/", "/fixtures/",
  517. )
  518. def _prioritize_diff_files(diff_files, cap):
  519. """When `diff_files` exceeds `cap`, return the top-`cap` by security
  520. relevance plus the count dropped. Otherwise return (diff_files, 0).
  521. Score = (risk_tokens_in_path, not_low_priority, added_lines). The
  522. added-lines proxy is `content.count('\\n+')` which counts diff additions
  523. cheaply without re-parsing hunks. This is a heuristic, not a guarantee —
  524. the goal is to review the likely-dangerous subset of an over-cap diff
  525. instead of reviewing nothing. Diffs that exceed the cap are typically
  526. large multi-file scaffolds, and the cross-file source→sink vulnerabilities
  527. in them concentrate in a handful of api/client/route files.
  528. """
  529. if len(diff_files) <= cap:
  530. return diff_files, 0
  531. def _score(item):
  532. fp, content = item
  533. low = fp.lower()
  534. # Prepend "/" so leading-slash patterns in _LOW_PRIORITY_PATH_TOKENS
  535. # match top-level dirs (git diff paths are repo-root-relative, e.g.
  536. # `migrations/001.py` not `/migrations/001.py`). Same trick as
  537. # _is_reviewable_source.
  538. low_slashed = "/" + low
  539. risk = sum(1 for t in _SECURITY_RISK_PATH_TOKENS if t in low)
  540. low_prio = (
  541. fp.endswith(_LOW_PRIORITY_SUFFIXES)
  542. or any(t in low_slashed for t in _LOW_PRIORITY_PATH_TOKENS)
  543. )
  544. # added_lines: count('\n+') over-counts by including '+++' header and
  545. # any literal '+' at line start in context, but it's a consistent
  546. # ordinal across files in the same diff which is all we need.
  547. added = content.count("\n+")
  548. return (risk, not low_prio, added)
  549. ranked = sorted(diff_files, key=_score, reverse=True)
  550. return ranked[:cap], len(diff_files) - cap
  551. def _is_reviewable_source(file_path):
  552. # Normalize for component matching: a path like `.next/x.js` or
  553. # `pkg/node_modules/y.ts` should both be excluded; matching against
  554. # `'/' + path` lets each pattern be checked as `'/' + p in '/' + path`
  555. # without false-positiving on `rebuild/` matching `build/`.
  556. norm = "/" + file_path.replace("\\", "/")
  557. if any(("/" + p) in norm for p in SKIP_PATH_PATTERNS):
  558. return False
  559. if file_path.endswith(SKIP_FILE_SUFFIXES):
  560. return False
  561. ext = os.path.splitext(file_path)[1].lower()
  562. if ext in SOURCE_CODE_EXTENSIONS:
  563. return True
  564. base = os.path.basename(file_path).lower()
  565. # Accept dot-suffixed variants too: `Dockerfile.dev`, `Makefile.am`,
  566. # `Jenkinsfile.release`. splitext gives ext='.dev'/'.am' for these so they
  567. # miss both the extension check and the exact-basename check otherwise.
  568. if base in SOURCE_CODE_BASENAMES \
  569. or base.split(".", 1)[0] in SOURCE_CODE_BASENAMES:
  570. return True
  571. # Extensionless files default to reviewable unless they're known
  572. # plain-text metadata or dotfiles. Covers shebang scripts under bin/ or
  573. # scripts/ (`deploy`, `run-canary`, `entrypoint`) which carry
  574. # shell-injection surface but were previously filtered out — the largest
  575. # remaining false-negative class for extensionless files. Dotfiles (`.gitignore`,
  576. # `.nvmrc`, `.env`) are config, not code; `.bashrc`-style runnables are
  577. # rare in repos and not worth the noise. The deny-list is prefix-aware on
  578. # `-`/`_` so dual-license / i18n variants (`LICENSE-MIT`, `README-CN`)
  579. # don't fall through as source.
  580. if ext == "" and not base.startswith("."):
  581. if any(base == x or base.startswith(x + "-") or base.startswith(x + "_")
  582. for x in NON_SOURCE_EXTENSIONLESS_BASENAMES):
  583. return False
  584. return True
  585. return False
  586. def extract_file_paths_from_diff(diff_output):
  587. """
  588. Extract file paths from unified diff output (without content).
  589. Only includes files with source code extensions.
  590. Returns a list of file paths.
  591. """
  592. if not diff_output or not diff_output.strip():
  593. return []
  594. paths = []
  595. file_diffs = diff_output.split("diff --git ")
  596. for file_diff in file_diffs:
  597. if not file_diff.strip():
  598. continue
  599. lines = file_diff.split('\n')
  600. header_match = re.match(r'^a/(.+?) b/(.+)$', lines[0])
  601. if not header_match:
  602. continue
  603. file_path = header_match.group(2) or header_match.group(1) or ''
  604. if not _is_reviewable_source(file_path):
  605. continue
  606. paths.append(file_path)
  607. return paths
  608. def parse_diff_into_files(diff_output):
  609. """
  610. Parse unified diff output into a list of (file_path, diff_content) tuples.
  611. Only includes files with source code extensions.
  612. """
  613. if not diff_output or not diff_output.strip():
  614. return []
  615. files = []
  616. file_diffs = diff_output.split("diff --git ")
  617. for file_diff in file_diffs:
  618. if not file_diff.strip():
  619. continue
  620. # Extract filename from first line: "a/path/to/file b/path/to/file"
  621. lines = file_diff.split('\n')
  622. header_match = re.match(r'^a/(.+?) b/(.+)$', lines[0])
  623. if not header_match:
  624. continue
  625. file_path = header_match.group(2) or header_match.group(1) or ''
  626. # Filter to source code files only
  627. if not _is_reviewable_source(file_path):
  628. continue
  629. # Extract the diff content (from first @@ onwards)
  630. diff_lines = []
  631. in_hunks = False
  632. for line in lines[1:]:
  633. if line.startswith('@@'):
  634. in_hunks = True
  635. if in_hunks:
  636. diff_lines.append(line)
  637. if diff_lines:
  638. files.append((file_path, '\n'.join(diff_lines)))
  639. return files
  640. def filter_preexisting_from_diff(diff_files, cwd, baseline_sha):
  641. """
  642. Filter out pre-existing content from diff files.
  643. When a file is fully rewritten (Write tool replaces entire content),
  644. git shows all lines as removed (-) then re-added (+). This function
  645. detects such rewrites and strips lines from the + section that also
  646. appeared in the - section, so the LLM reviewer only sees truly new code.
  647. """
  648. if not baseline_sha:
  649. return diff_files
  650. filtered = []
  651. for file_path, diff_content in diff_files:
  652. lines = diff_content.split('\n')
  653. # Collect removed and added lines (stripping the +/- prefix)
  654. removed_lines = set()
  655. added_lines = []
  656. for line in lines:
  657. if line.startswith('-') and not line.startswith('---'):
  658. removed_lines.add(line[1:].strip())
  659. elif line.startswith('+') and not line.startswith('+++'):
  660. added_lines.append(line[1:].strip())
  661. if not removed_lines:
  662. # New file, no pre-existing content to filter
  663. filtered.append((file_path, diff_content))
  664. continue
  665. # Check what fraction of added lines were pre-existing
  666. preexisting_count = sum(1 for l in added_lines if l in removed_lines)
  667. if preexisting_count == 0:
  668. filtered.append((file_path, diff_content))
  669. continue
  670. added_lines_set = set(added_lines)
  671. # Rebuild diff with pre-existing lines converted to context (space prefix).
  672. # Known imprecision: .strip() matches across indentation (so reindented
  673. # code is treated as unchanged) and the set lets one removal mask N
  674. # additions of the same stripped text. Accepted trade-off — this filter
  675. # exists for the full-file Write rewrite case where exact-match would
  676. # miss everything; the diff-review prompt's previous-findings recheck
  677. # is the backstop.
  678. new_lines = []
  679. for line in lines:
  680. if line.startswith('+') and not line.startswith('+++'):
  681. content = line[1:].strip()
  682. if content in removed_lines:
  683. # Convert to context line (pre-existing, not new)
  684. new_lines.append(' ' + line[1:])
  685. else:
  686. new_lines.append(line)
  687. elif line.startswith('-') and not line.startswith('---'):
  688. content = line[1:].strip()
  689. if content in added_lines_set:
  690. # Skip removed lines that were re-added (they become context)
  691. continue
  692. else:
  693. new_lines.append(line)
  694. else:
  695. new_lines.append(line)
  696. filtered.append((file_path, '\n'.join(new_lines)))
  697. return filtered