gitutil.py 34 KB

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