Compare commits
63
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
216bc39255 | ||
|
|
75ca8cdb83 | ||
|
|
aaf2e484d5 | ||
|
|
55da29a86f | ||
|
|
d424447d15 | ||
|
|
9d05af647b | ||
|
|
941d763129 | ||
|
|
9e7f8a2a0a | ||
|
|
8b50a0d643 | ||
|
|
555611db07 | ||
|
|
24b248884f | ||
|
|
e0ae6f886f | ||
|
|
55b349da07 | ||
|
|
6a26984bee | ||
|
|
a8561b4257 | ||
|
|
5ac73f290e | ||
|
|
05153bba8e | ||
|
|
d7cecc8fa8 | ||
|
|
0c29daa014 | ||
|
|
d8dd5ce92e | ||
|
|
cc9c8afed7 | ||
|
|
0c108ab7f9 | ||
|
|
83dd56f37f | ||
|
|
d354f30c27 | ||
|
|
b5264141c4 | ||
|
|
4b779ee00b | ||
|
|
deb20bb078 | ||
|
|
c63b1a6da2 | ||
|
|
ed883f6f20 | ||
|
|
3ef8a30291 | ||
|
|
be72aa0944 | ||
|
|
b277ff2f7c | ||
|
|
20a2b57998 | ||
|
|
05178be520 | ||
|
|
9e6e8bb793 | ||
|
|
321a717f91 | ||
|
|
36bf2d8644 | ||
|
|
85235e43a4 | ||
|
|
491c170d36 | ||
|
|
afed9a3cce | ||
|
|
71b93a885a | ||
|
|
7b5c7c3e4f | ||
|
|
7823718ff4 | ||
|
|
4c2b6d4265 | ||
|
|
dcd3e931f4 | ||
|
|
0a51affa72 | ||
|
|
f341dc6e07 | ||
|
|
8349fe8b71 | ||
|
|
a6534ee076 | ||
|
|
cfbbbe5f6c | ||
|
|
dae379273a | ||
|
|
b2129e0bc6 | ||
|
|
c980add807 | ||
|
|
10d826d1b1 | ||
|
|
dbeb56589c | ||
|
|
d3a09d892e | ||
|
|
e44a8ed0cb | ||
|
|
35887f1a68 | ||
|
|
5c8332928b | ||
|
|
d464998e4f | ||
|
|
e37a96433d | ||
|
|
4a68743b66 | ||
|
|
94b32737c5 |
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,39 @@
|
||||
{
|
||||
"generatedAt": "2026/07/20 15:20:13",
|
||||
"commitSha": "c980add8077dd1316a6e4d62be481bc4f1c94e25",
|
||||
"prNumber": 6,
|
||||
"tool": {
|
||||
"name": "code-review-resolve",
|
||||
"version": "0.0.8",
|
||||
"model": "(工具預設)"
|
||||
},
|
||||
"findings": [
|
||||
{
|
||||
"id": "F002",
|
||||
"reviewer": "Maya",
|
||||
"focus": "testing",
|
||||
"badge": "🧪",
|
||||
"severity": "警告",
|
||||
"file": "src/index.js",
|
||||
"startLine": 306,
|
||||
"endLine": 359,
|
||||
"problem": "建問題模式的核心流程已大幅改變,但 diff 中沒有對應測試驗證各分支:有保留問題時才建立 issue、暫存留言依序送出、無問題時靜默通過、嚴重與非嚴重問題送往正確位置,以及標籤失敗後仍須回貼 PR 連結。這些分支牽涉多次外部 API 呼叫與狀態切換,未測試時很容易出現漏留言、留言送錯 PR/issue,或在 `issue` 尚未建立時解參考的回歸。",
|
||||
"suggestion": "新增主流程測試並 mock Gitea、agent 與 git 操作,至少涵蓋:`kept=[]` 時不建立 issue 且不留言;僅嚴重問題;僅警告/建議;混合問題;建立 issue 或寫入暫存留言失敗;標籤查詢、AI 選標籤及補掛標籤失敗時仍回貼 issue 連結。除了呼叫次數,也應斷言 API 呼叫順序、目標 issue 編號及留言內容。",
|
||||
"suggestedCode": ""
|
||||
},
|
||||
{
|
||||
"id": "F004",
|
||||
"reviewer": "Maya",
|
||||
"focus": "testing",
|
||||
"badge": "🧪",
|
||||
"severity": "警告",
|
||||
"file": "src/lib/gitrepo.js",
|
||||
"startLine": 100,
|
||||
"endLine": 122,
|
||||
"problem": "`resolveMergeBase` 新增多階段 fetch 與淺層 checkout 修復邏輯,但沒有看到測試驗證成功、降級與最終失敗路徑。尤其初次 merge-base 失敗後,淺層與非淺層 repository 會走不同路徑,且多個 `tryGit` 失敗會被刻意吞掉;若參數、refspec 或重試順序有誤,只會在實際 CI checkout 深度不足時才暴露。",
|
||||
"suggestion": "以 stub 的 git 執行器或暫存 repository 補齊案例:首次 merge-base 成功;淺層 repository 經 `--unshallow` 後成功;`--unshallow` 失敗但 `--deepen=1000` 後成功;非淺層首次失敗後重試成功;所有策略失敗時拋出含 `baseRef` 且保留原始 `cause` 的錯誤。並斷言 base/head fetch 的 refspec 與執行順序。",
|
||||
"suggestedCode": ""
|
||||
}
|
||||
],
|
||||
"excluded": []
|
||||
}
|
||||
@@ -0,0 +1,65 @@
|
||||
{
|
||||
"generatedAt": "2026/07/20 15:57:46",
|
||||
"commitSha": "a6534ee0764fe2363ebbb5525586ad3868dc6720",
|
||||
"prNumber": 6,
|
||||
"tool": {
|
||||
"name": "code-review-resolve",
|
||||
"version": "0.0.8",
|
||||
"model": "(工具預設)"
|
||||
},
|
||||
"findings": [
|
||||
{
|
||||
"id": "F003",
|
||||
"reviewer": "Maya",
|
||||
"focus": "testing",
|
||||
"badge": "🧪",
|
||||
"severity": "警告",
|
||||
"file": "src/index.js",
|
||||
"startLine": 184,
|
||||
"endLine": 245,
|
||||
"problem": "建問題模式新增「issue 建立前暫存留言、建立後依序沖刷」的狀態流程,但沒有對應測試。尚未驗證 createIssue 或沖刷途中拋錯、空 buffer、重複呼叫、以及一般/建問題模式留言目的地是否正確;失敗路徑可能造成 issue 已建立但內容不完整或留言誤發到 PR。",
|
||||
"suggestion": "補主流程整合測試並 mock Gitea API,驗證:一般模式直接發 PR 且記錄留言 id;issue 未建立時只暫存;建立後依序沖刷並清空 buffer;createIssue 與第 N 則沖刷留言失敗時以失敗結束且不再發布後續內容。屬測試架構決策(專案目前無測試框架)。",
|
||||
"suggestedCode": ""
|
||||
},
|
||||
{
|
||||
"id": "F004",
|
||||
"reviewer": "Maya",
|
||||
"focus": "testing",
|
||||
"badge": "🧪",
|
||||
"severity": "警告",
|
||||
"file": "src/index.js",
|
||||
"startLine": 309,
|
||||
"endLine": 395,
|
||||
"problem": "建問題模式核心分支被大幅改寫,但沒有測試驗證各種 findings 組合與 API 失敗行為。kept.length===0、只有嚴重、只有警告/建議、兩者皆有,以及標籤挑選/issue 建立/PR 回貼連結/相依 API 失敗等路徑尚未試煉,無法確認「無問題完全靜默」「有問題才建 issue」及相依失敗僅降級等契約成立。",
|
||||
"suggestion": "以參數化測試覆蓋 findings 四種組合,斷言 API 呼叫順序/次數/issue number/統計;並分別讓 listLabels/selectLabels/createIssue/問題留言/PR 連結留言/addIssueDependency 拋錯,驗證哪些中止、哪些僅記警告續行;零 findings 時斷言所有寫入 API 皆不呼叫。屬測試架構決策。",
|
||||
"suggestedCode": ""
|
||||
},
|
||||
{
|
||||
"id": "F006",
|
||||
"reviewer": "Maya",
|
||||
"focus": "testing",
|
||||
"badge": "🧪",
|
||||
"severity": "警告",
|
||||
"file": "src/lib/gitrepo.js",
|
||||
"startLine": 103,
|
||||
"endLine": 157,
|
||||
"problem": "resolveMergeBase 新增多階段 fetch/重試策略,卻沒有測試鎖定淺層與失敗路徑:首次成功提早返回、非 shallow 不 unshallow、某次 fetch 失敗後仍嘗試下一策略、補抓成功立即停止、全部失敗時診斷與 cause 是否完整;易因呼叫順序或 off-by-one 在 runner 上才暴露。",
|
||||
"suggestion": "將 git 執行器注入或 stub,建立表格化案例覆蓋首次成功/unshallow 後成功/deepen base 後成功/deepen HEAD 後成功/各 fetch 個別失敗/全部失敗;逐案斷言 git 參數與順序、成功後不再額外 fetch,並檢查最終錯誤含各策略成敗摘要且保留首次錯誤為 cause。屬可測性重構+測試架構決策。",
|
||||
"suggestedCode": ""
|
||||
},
|
||||
{
|
||||
"id": "F007",
|
||||
"reviewer": "Maya",
|
||||
"focus": "testing",
|
||||
"badge": "🧪",
|
||||
"severity": "警告",
|
||||
"file": "src/lib/gitrepo.js",
|
||||
"startLine": 249,
|
||||
"endLine": 289,
|
||||
"problem": "推送流程新增 pushToken 分支,但沒有測試驗證兩套認證策略:有 PAT 時略過 origin、PAT 推送失敗不退回其他 token、無 PAT 時 origin 成功不重試、origin 失敗才用一般 token;也沒有案例保護含憑證資訊不出現在錯誤或測試輸出中。(本次已將認證改經 env 傳入並遮蔽 push 錯誤,測試仍待補。)",
|
||||
"suggestion": "mock git 執行器與 URL/env 組裝,補測 pushToken 有值/空、origin 成功/失敗、PAT 推送失敗及含特殊字元等案例;斷言 push 目標與呼叫次數,並確保任何拋出的錯誤、log 或快照都不含原始 token。屬測試架構決策。",
|
||||
"suggestedCode": ""
|
||||
}
|
||||
],
|
||||
"excluded": []
|
||||
}
|
||||
@@ -0,0 +1,104 @@
|
||||
{
|
||||
"generatedAt": "2026/07/20 17:37:54",
|
||||
"commitSha": "3ef8a302911c60b9f71024e1f4b60e0d4578b8fd",
|
||||
"prNumber": 6,
|
||||
"tool": {
|
||||
"name": "code-review-resolve",
|
||||
"version": "0.0.8",
|
||||
"model": "(工具預設)"
|
||||
},
|
||||
"findings": [
|
||||
{
|
||||
"id": "F001",
|
||||
"reviewer": "Leo",
|
||||
"focus": "maintainability",
|
||||
"badge": "🧰",
|
||||
"severity": "警告",
|
||||
"file": "src/index.js",
|
||||
"startLine": 121,
|
||||
"endLine": 145,
|
||||
"problem": "流程步驟編號硬編碼在主流程註解、日誌字串、README 與多個函式 JSDoc 中;插入一個步驟就要同步修改大量檔案,文件與實作高耦合,日後調整流程易漏改而互相矛盾。",
|
||||
"suggestion": "共用函式 JSDoc 改以語意階段名稱描述、不引用易變動的數字;日誌集中定義階段名稱或由單一流程描述產生編號;README 流程圖也以語意名稱為主。屬跨檔重構+設計取捨。",
|
||||
"suggestedCode": "const STAGE = Object.freeze({\n TOOL_DETECTION: '偵測工具',\n DIFF_COLLECTION: '整理差異',\n ATTACK_REVIEW: '攻擊方審查',\n DEFENSE_REVIEW: '防守方裁決',\n});\nlog(STAGE.DIFF_COLLECTION, 'INF', message);"
|
||||
},
|
||||
{
|
||||
"id": "F003",
|
||||
"reviewer": "Leo",
|
||||
"focus": "maintainability",
|
||||
"badge": "🧰",
|
||||
"severity": "警告",
|
||||
"file": "src/lib/gitrepo.js",
|
||||
"startLine": 47,
|
||||
"endLine": 65,
|
||||
"problem": "tryGit 將所有 git 失敗壓成布林值,resolveMergeBase 的診斷只知策略成敗、無法區分認證/refspec/網路/版本問題;CI 出錯時維護者只能重跑或自行重現,診斷成本高。",
|
||||
"suggestion": "讓嘗試結果保留結構化且已清理的錯誤分類(exit code、git 子命令、安全化後短訊息),仍避免記錄遠端 URL 或憑證;最終錯誤彙整足以行動的原因,並可對各失敗類型做單元測試。屬診斷重構+需測試。",
|
||||
"suggestedCode": "function tryGit(cwd, ...args) {\n try {\n git(cwd, ...args);\n return { ok: true };\n } catch (error) {\n return { ok: false, code: error.status ?? error.code ?? null, reason: sanitizeGitError(error) };\n }\n}"
|
||||
},
|
||||
{
|
||||
"id": "F004",
|
||||
"reviewer": "Maya",
|
||||
"focus": "testing",
|
||||
"badge": "🧪",
|
||||
"severity": "警告",
|
||||
"file": "src/lib/gitrepo.js",
|
||||
"startLine": 270,
|
||||
"endLine": 291,
|
||||
"problem": "findings 推送的認證路徑沒有測試。註:原「PAT 直接推送 vs origin 失敗重試」雙路徑已於先前 commit 合併為「一律以 token 明確認證推送」,測試仍待補:空 token 邊界、推送目標正確、錯誤與輸出不含 token 原文。",
|
||||
"suggestion": "補單元測試攔截 git 參數/env:斷言以 token 認證推送、推送目標 refspec 正確、呼叫次數,並確保任何拋出的錯誤、log 或快照都不含原始 token。屬測試架構決策。",
|
||||
"suggestedCode": ""
|
||||
},
|
||||
{
|
||||
"id": "F005",
|
||||
"reviewer": "Bard",
|
||||
"focus": "style",
|
||||
"badge": "🎼",
|
||||
"severity": "建議",
|
||||
"file": "action.yml",
|
||||
"startLine": 3,
|
||||
"endLine": 3,
|
||||
"problem": "檔頭「更新時間」為手動維護的固定字串,與實際檔案更新時間不一致;散落各檔的手動時間戳容易走調,讀者無法判斷可信度。",
|
||||
"suggestion": "屬 jsc spec-time-log 慣例(各檔頭「更新時間」由 doc-funcs 流程統一產生/同步)。是否移除改用版控紀錄、或如何統一更新,宜由 doc-funcs 流程處理,不在 resolve 逐條硬改。",
|
||||
"suggestedCode": ""
|
||||
},
|
||||
{
|
||||
"id": "F006",
|
||||
"reviewer": "Bard",
|
||||
"focus": "style",
|
||||
"badge": "🎼",
|
||||
"severity": "建議",
|
||||
"file": "readme.md",
|
||||
"startLine": 3,
|
||||
"endLine": 3,
|
||||
"problem": "README 檔頭手動「更新時間」與實際更新時間不符,並與 action.yml、src/index.js 重複保存同類易過期資訊,形成多個不一致的真相來源。",
|
||||
"suggestion": "同 F005:屬 jsc spec-time-log 慣例,交 doc-funcs 流程統一維護(移除或自動注入)。",
|
||||
"suggestedCode": ""
|
||||
},
|
||||
{
|
||||
"id": "F007",
|
||||
"reviewer": "Bard",
|
||||
"focus": "style",
|
||||
"badge": "🎼",
|
||||
"severity": "建議",
|
||||
"file": "src/index.js",
|
||||
"startLine": 7,
|
||||
"endLine": 7,
|
||||
"problem": "啟動橫幅硬編碼的「更新時間」與程式實際更新時間不一致,每次改程式都要人工校準,製造噪音並讓執行日誌呈現失真版本資訊。",
|
||||
"suggestion": "同 F005:屬 jsc spec-time-log 慣例,交 doc-funcs 流程統一維護;若日誌需辨識版本,可改顯示 CI 注入的 commit SHA/版本號(屬慣例調整)。",
|
||||
"suggestedCode": ""
|
||||
},
|
||||
{
|
||||
"id": "F008",
|
||||
"reviewer": "Bard",
|
||||
"focus": "style",
|
||||
"badge": "🎼",
|
||||
"severity": "建議",
|
||||
"file": "src/index.js",
|
||||
"startLine": 179,
|
||||
"endLine": 231,
|
||||
"problem": "main() 內新增兩個帶完整 JSDoc 的閉包函式與一大段「步驟 2:延後執行」說明,使主流程在進入步驟 3 前被近六十行細節打斷,留言路由、issue 建立與流程說明混在同一層,閱讀節奏沉重。",
|
||||
"suggestion": "將留言路由與 issue 建立封裝成具語義名稱的輔助物件/模組(例如 createCommentPublisher),讓 main() 只保留流程級呼叫;延後清理理由縮成貼近呼叫點的簡短註解。與 F001(語意階段名稱)同屬主流程重構,宜一併處理。",
|
||||
"suggestedCode": "const comments = createCommentPublisher({ ctx, gitea });\nawait comments.post(templates.toolComment({ /* ... */ }));"
|
||||
}
|
||||
],
|
||||
"excluded": []
|
||||
}
|
||||
@@ -0,0 +1,39 @@
|
||||
{
|
||||
"generatedAt": "2026/07/20 18:00:02",
|
||||
"commitSha": "d354f30c270e99baa9dcfc6aa76510710c0193ca",
|
||||
"prNumber": null,
|
||||
"tool": {
|
||||
"name": "code-review-resolve",
|
||||
"version": "0.0.8",
|
||||
"model": "(工具預設)"
|
||||
},
|
||||
"findings": [
|
||||
{
|
||||
"id": "F001",
|
||||
"reviewer": "🧰 Leo",
|
||||
"focus": "maintainability",
|
||||
"badge": "🧰",
|
||||
"severity": "警告",
|
||||
"file": "src/index.js",
|
||||
"startLine": 257,
|
||||
"endLine": 307,
|
||||
"problem": "流程步驟編號同時硬編碼在 log 字串、區段註解、JSDoc、README 與多個函式庫中。插入或調整一個步驟就必須跨大量檔案全面改號,容易讓文件與實際紀錄不一致。",
|
||||
"suggestion": "程式內改用穩定的語意階段名稱(如 diff、attack、defend、publish),由單一流程定義集中決定顯示順序;JSDoc 以階段名稱互相引用,README 流程圖由同一份階段資料產生或僅在文件層維護展示編號。",
|
||||
"suggestedCode": "const PHASE = Object.freeze({\n RESOLVE_OLD: '清理舊留言',\n DETECT_TOOL: '偵測工具',\n COLLECT_DIFF: '整理差異',\n ATTACK: '攻擊方審查',\n DEFEND: '防守方裁決',\n});\n\nlog(PHASE.COLLECT_DIFF, 'INF', `變更檔案 ${allFiles.length} 個…`);"
|
||||
},
|
||||
{
|
||||
"id": "F002",
|
||||
"reviewer": "🧪 Maya",
|
||||
"focus": "testing",
|
||||
"badge": "🧪",
|
||||
"severity": "警告",
|
||||
"file": "src/lib/gitrepo.js",
|
||||
"startLine": 252,
|
||||
"endLine": 289,
|
||||
"problem": "commitAndPushFindings 的推送行為(有無變更、認證方式、空 commit 防護、是否觸發 CI)缺少測試證明。此為本次變更的核心行為,卻沒有任何測試覆蓋。",
|
||||
"suggestion": "mock git 命令,斷言:無 staged diff 時回傳 false 且不執行 commit/push;有變更時以認證方式推送到正確 refspec 與分支。注意:原 finding 描述的 pushToken 對比 origin 雙軌邏輯已於重構後移除(現行一律以 token 經 pushWithCredential 認證推送),撰寫測試前需依現行程式碼重新界定情境。",
|
||||
"suggestedCode": ""
|
||||
}
|
||||
],
|
||||
"excluded": []
|
||||
}
|
||||
@@ -0,0 +1,209 @@
|
||||
{
|
||||
"generatedAt": "2026/07/20 18:31:07",
|
||||
"commitSha": "0c29daa01434d6b6fa1b20ce81c513c75b1b1c6a",
|
||||
"prNumber": null,
|
||||
"tool": {
|
||||
"name": "code-review-resolve",
|
||||
"version": "0.0.9",
|
||||
"model": "(工具預設)"
|
||||
},
|
||||
"findings": [
|
||||
{
|
||||
"id": "F001",
|
||||
"reviewer": "Leo",
|
||||
"focus": "",
|
||||
"badge": "🧰",
|
||||
"severity": "警告",
|
||||
"file": "src/index.js",
|
||||
"startLine": 119,
|
||||
"endLine": 139,
|
||||
"problem": "流程步驟編號被當成跨模組識別值,散落在 `index.js`、各 library 的日誌與 JSDoc、README 流程圖及功能表。這次僅因插入並延後一步,就必須同步修改大量 `步驟2`~`步驟8` 字串,而且實際執行順序已變成 1、3~8、2、9~10;未來再調整流程時非常容易讓文件、日誌與程式碼脫節。",
|
||||
"suggestion": "以穩定的語意階段名稱取代硬編碼序號,例如 `TOOL_DETECTION`、`COLLECT_DIFF`、`RESOLVE_OLD_COMMENTS`,由單一常數表集中決定顯示名稱;README 的流程順序則從同一份定義產生,或至少不要在各函式文件重複紀錄易變的數字。",
|
||||
"suggestedCode": "```\nconst PHASE = Object.freeze({\n FAST_RESULT: '快速回報',\n DETECT_TOOL: '偵測 AI 工具',\n COLLECT_DIFF: '整理變更',\n RESOLVE_OLD: '處理舊留言',\n PUBLISH_FINDINGS: '發布審查結果',\n});\n\nlog(PHASE.DETECT_TOOL, 'INF', `選用工具:${tool.name}。`);\n```",
|
||||
"sourceIssue": 11
|
||||
},
|
||||
{
|
||||
"id": "F002",
|
||||
"reviewer": "Leo",
|
||||
"focus": "",
|
||||
"badge": "🧰",
|
||||
"severity": "警告",
|
||||
"file": "readme.md",
|
||||
"startLine": 59,
|
||||
"endLine": 130,
|
||||
"problem": "功能索引把分支名稱與原始碼行號硬編碼在數十個連結中;本次僅因程式碼增行,就必須人工把大量 `#L...` 全面更新,已直接顯示這份文件存在高同步成本。之後任一檔案前段增刪程式碼,都會讓這些連結再次漂移,而且指向會持續變動的 `develop` 分支,使舊版 README 與實際連結內容無法穩定對應。",
|
||||
"suggestion": "不要手動維護原始碼行號。若只需導覽,連到檔案並由右欄既有章節錨點提供函式級定位;若必須精確指向定義,應由 AST/文件產生工具在 CI 自動建立索引,並連到固定 commit SHA 或版本 tag。至少增加連結檢查,避免半年後整張功能表悄悄失準。",
|
||||
"suggestedCode": "```\n| 功能名稱 | 功能描述 |\n| --- | --- |\n| [gitrepo.resolveMergeBase](src/lib/gitrepo.js) | [解析 base 分支與 HEAD 的 merge-base](#gitreporesolvemergebase) |\n```",
|
||||
"sourceIssue": 12
|
||||
},
|
||||
{
|
||||
"id": "F006",
|
||||
"reviewer": "Rogue",
|
||||
"focus": "",
|
||||
"badge": "⚡",
|
||||
"severity": "警告",
|
||||
"file": "src/lib/gitrepo.js",
|
||||
"startLine": 134,
|
||||
"endLine": 134,
|
||||
"problem": "在檢查是否為淺層 repository (shallow repository) 時,呼叫了外部子行程執行 `git rev-parse --is-shallow-repository`。建立與啟動 OS 子行程是非常昂貴的操作,會白白浪費數十毫秒的 CPU 週期與系統資源。",
|
||||
"suggestion": "Git 在淺層 clone 時會在 `.git` 目錄下建立一個 `shallow` 檔案。我們可以使用 Node.js 內建的 `fs.existsSync` 進行本地檔案檢查,不需啟動額外的 Git 子行程,執行速度可快上百倍。",
|
||||
"suggestedCode": "```\nconst fs = require('fs');\n// ...\nif (fs.existsSync(path.join(cwd, '.git', 'shallow'))) {\n strategies.push(['unshallow', 'fetch', '--no-tags', '--unshallow', 'origin']);\n}\n```",
|
||||
"sourceIssue": 14
|
||||
},
|
||||
{
|
||||
"id": "F007",
|
||||
"reviewer": "Leo",
|
||||
"focus": "",
|
||||
"badge": "🧰",
|
||||
"severity": "警告",
|
||||
"file": "src/lib/gitrepo.js",
|
||||
"startLine": 293,
|
||||
"endLine": 305,
|
||||
"problem": "為了防止 Git 推送失敗時在例外訊息中回顯包含 Token 與遠端 URL 的命令列參數,pushWithCredential 的 catch 區塊直接拋出一個固定的 Error('推送審查結果 commit 失敗...')。但這樣一來,它完全吞掉了原始的錯誤(例如 non-fast-forward 非快轉、分支保護規則阻擋、或連線逾時),六個月後的維護者在 CI log 中看到此錯誤時,完全無從判斷失敗的原因。",
|
||||
"suggestion": "建議在保留安全遮罩的前提下,保留原始 exception 的排錯線索。例如可以檢查並安全地過濾 err.message 或 err.stderr 中所有的敏感字串(如 Token/URL),然後將其作為新錯誤的 cause 屬性或附加訊息傳遞下去。",
|
||||
"suggestedCode": "```\n} catch (err) {\n // 過濾敏感資訊後保留錯誤細節\n const safeMessage = err.message ? redactSecrets(err.message) : '未知錯誤';\n const error = new Error(`推送審查結果 commit 失敗(${safeMessage})。`);\n error.cause = err;\n throw error;\n }\n```",
|
||||
"sourceIssue": 14
|
||||
},
|
||||
{
|
||||
"id": "F009",
|
||||
"reviewer": "Bard",
|
||||
"focus": "",
|
||||
"badge": "🎼",
|
||||
"severity": "建議",
|
||||
"file": "src/index.js",
|
||||
"startLine": 308,
|
||||
"endLine": 368,
|
||||
"problem": "新增或修改的步驟分隔註解(如步驟 8 分組、步驟 2 延後、步驟 9、步驟 10、及建問題模式收束)其尾隨的水平分隔線(─)長度不一或僅存單一字元,破壞了專案既有程式碼中整齊劃一的長分隔線視覺排版,視覺上顯得雜亂、走調。",
|
||||
"suggestion": "補足尾隨的水平線 ─,使其與鄰近步驟分隔註解的長度(約 70~80 字元寬度)與視覺風格保持一致,維持排版的美觀。",
|
||||
"suggestedCode": "```\n// ── 步驟 8(分組):依嚴重等級分組(嚴重/警告+建議),組內已依檔案與行數排序 ────────────────\n```",
|
||||
"sourceIssue": 14
|
||||
},
|
||||
{
|
||||
"id": "F010",
|
||||
"reviewer": "Rogue",
|
||||
"focus": "",
|
||||
"badge": "⚡",
|
||||
"severity": "建議",
|
||||
"file": "src/index.js",
|
||||
"startLine": 366,
|
||||
"endLine": 382,
|
||||
"problem": "在建問題模式收束時,先 `await gitea.createIssueComment` 再 `await gitea.addIssueDependency`,這兩個 Gitea API 呼叫是獨立且無資料相依性的,卻以序列(Sequential)方式執行,白白浪費了一次網路往返(RTT)的等待時間。",
|
||||
"suggestion": "使用 `Promise.all` 同時發起這兩個請求,並行處理以減少整體 execution 的等待時間。",
|
||||
"suggestedCode": "```\nconst commentPromise = gitea.createIssueComment(\n ctx,\n templates.issueLinkComment({\n issueNumber: issue.number,\n issueUrl: issue.html_url,\n severeCount: severe.length,\n otherCount: others.length,\n })\n );\n const dependencyPromise = gitea.addIssueDependency(ctx, ctx.prNumber, issue.number)\n .then(() => log('建問題', 'INF', `已將 PR #${ctx.prNumber} 設為相依於 issue #${issue.number}。`))\n .catch((err) => log('建問題', 'WRN', `設定 PR 相依失敗:${err.message}。`));\n \n await Promise.all([commentPromise, dependencyPromise]);\n```",
|
||||
"sourceIssue": 14
|
||||
},
|
||||
{
|
||||
"id": "F012",
|
||||
"reviewer": "Rogue",
|
||||
"focus": "",
|
||||
"badge": "⚡",
|
||||
"severity": "建議",
|
||||
"file": "src/lib/review.js",
|
||||
"startLine": 48,
|
||||
"endLine": 53,
|
||||
"problem": "在 `agentFailureDetail` 之中,進行 stderr 與 stdout 的遮罩處理時,是先截斷至 2,000 字元,然後執行多次複雜的 `redactSecrets` 正規表示式替換,最後再截斷至 500 字元輸出。這會造成 1,500 字元的複雜 regex 運算結果在下一步被直接丟棄,白白浪費了 CPU 進行字串比對與取代的週期。",
|
||||
"suggestion": "應在呼叫 `redactSecrets` 之前,就先將字串截斷至目標長度(500 字元),再進行遮罩,可大幅減少 regex 運算負擔。",
|
||||
"suggestedCode": "```\nconst stderr = redactSecrets(String((res && res.stderr) || '').slice(0, 500));\n if (stderr) parts.push(`stderr:${stderr}`);\n const stdout = redactSecrets(String((res && res.output) || '').slice(0, 500));\n if (stdout) parts.push(`stdout:${stdout}`);\n```",
|
||||
"sourceIssue": 14
|
||||
},
|
||||
{
|
||||
"id": "F014",
|
||||
"reviewer": "Leo",
|
||||
"focus": "",
|
||||
"badge": "🧰",
|
||||
"severity": "建議",
|
||||
"file": "readme.md",
|
||||
"startLine": 56,
|
||||
"endLine": 132,
|
||||
"problem": "README 的功能表大量手動維護 `src/branch/develop/...#Lxx` 深連結,這次光是分支與行號就改了整排。這類文件會隨任何插入註解、重排函式、換預設分支而失準,未來維護者必須在改程式時同步更新一大段文件,維護成本偏高。",
|
||||
"suggestion": "改成不依賴行號的相對連結,或用文件產生腳本從原始碼 JSDoc 自動產出這張表。若仍要指向 Gitea,建議至少移除 `#Lxx`,或集中定義分支名稱,避免每次改分支都要全表搜尋替換。",
|
||||
"suggestedCode": "",
|
||||
"sourceIssue": 15
|
||||
},
|
||||
{
|
||||
"id": "F022",
|
||||
"reviewer": "Leo",
|
||||
"focus": "",
|
||||
"badge": "🧰",
|
||||
"severity": "警告",
|
||||
"file": "readme.md",
|
||||
"startLine": 76,
|
||||
"endLine": 132,
|
||||
"problem": "README 內大量函式清單同時硬編分支名稱與行號錨點,這次 diff 已經整批從 `master` 改成 `develop` 並同步調整行號。這類文件和原始碼結構高度重複,後續只要插入幾行程式,文件連結就會失準,維護者必須靠人工記得同步整張表。",
|
||||
"suggestion": "改成不含行號的穩定檔案連結,或把這份 API/功能表改由 JSDoc/腳本產生。若一定要保留行號,建議把產生流程寫入 npm script,避免每次程式碼位移都人工批次修改 README。",
|
||||
"suggestedCode": "",
|
||||
"sourceIssue": 18
|
||||
},
|
||||
{
|
||||
"id": "F025",
|
||||
"reviewer": "Assassin",
|
||||
"focus": "",
|
||||
"badge": "🗡️",
|
||||
"severity": "警告",
|
||||
"file": "action.yml",
|
||||
"startLine": 21,
|
||||
"endLine": 24,
|
||||
"problem": "這裡建議呼叫端傳入「能觸發 CI 的 PAT」作為 action token。攻擊者最愛這種長效、可推送、可觸發 workflow 的憑證:只要此 action 在不受信任 PR 上執行,或 PR 能影響 action/workflow 執行內容,惡意變更就可能讀取 `INPUT_TOKEN`、推送結果 commit、再藉由可觸發 CI 的身分製造後續執行鏈。自動 token 原本不觸發 CI 是一道防線,這個建議等於要求使用者把防線拆掉。",
|
||||
"suggestion": "不要泛稱建議使用可觸發 CI 的 PAT。文件與介面應明確要求最小權限、repo 限定、短效或可輪替 token,並禁止在 fork/不受信任 PR context 暴露 PAT。更穩的設計是分離 API 留言 token 與 push token,且只有在明確受信任事件或受保護分支才允許 push token 存在;否則拒絕 commit/push,只做留言或 artifact。",
|
||||
"suggestedCode": "",
|
||||
"sourceIssue": 19
|
||||
},
|
||||
{
|
||||
"id": "F026",
|
||||
"reviewer": "Leo",
|
||||
"focus": "",
|
||||
"badge": "🧰",
|
||||
"severity": "建議",
|
||||
"file": "readme.md",
|
||||
"startLine": 59,
|
||||
"endLine": 132,
|
||||
"problem": "README 的功能列表手動維護了大量 `src/branch/develop/...#Lxx` 深連結與行號。這次 PR 已經一次改動數十個 branch/line anchor,代表文件和原始碼行號高度耦合;下一次只要插入幾行程式,文件就會悄悄過期,維護者很難知道哪些連結還準。",
|
||||
"suggestion": "避免在手寫 README 綁定行號,改連到函式所在檔案或穩定章節錨點;若必須保留行號,請把這段改成產生式文件,讓 CI 或腳本從原始碼/JSDoc 重新生成,減少人工同步成本。",
|
||||
"suggestedCode": "",
|
||||
"sourceIssue": 19
|
||||
},
|
||||
{
|
||||
"id": "F031",
|
||||
"reviewer": "Leo",
|
||||
"focus": "",
|
||||
"badge": "🧰",
|
||||
"severity": "建議",
|
||||
"file": "readme.md",
|
||||
"startLine": 56,
|
||||
"endLine": 132,
|
||||
"problem": "README 的功能表大量硬編遠端分支名稱與行號,這次只是從 `master` 改成 `develop` 並同步行號,但這種文件很容易在下一次函式移動、預設分支更名或重排時再次整批失準。未來維護者會被迫反覆做低價值的連結校正,文件也可能在沒人注意時指到錯誤位置。",
|
||||
"suggestion": "若 README 是 repo 內文件,優先改成相對路徑連結,並避免固定行號;若必須保留行號,建議用產生腳本統一輸出這張表,讓分支名與行號只從單一來源計算。",
|
||||
"suggestedCode": "",
|
||||
"sourceIssue": 21
|
||||
},
|
||||
{
|
||||
"id": "F040",
|
||||
"reviewer": "Assassin",
|
||||
"focus": "",
|
||||
"badge": "🗡️",
|
||||
"severity": "警告",
|
||||
"file": "action.yml",
|
||||
"startLine": 19,
|
||||
"endLine": 22,
|
||||
"problem": "這段新增說明鼓勵呼叫端傳入「能觸發 CI 的 PAT」。攻擊者最喜歡這種長效、高權限、可觸發 workflow 的憑證:若 action 跑在不可信 PR、AI CLI 被 prompt injection 誘導讀環境變數,或同 repo PR 可改動本 action 程式碼,就可能把 PAT 外送或濫用成寫入 repo/觸發 CI 的跳板。",
|
||||
"suggestion": "不要把長效 PAT 當建議預設。改用最小權限、短效的 GitHub App/Gitea App token,並明確禁止在不可信 fork PR 傳入可寫 token。若目標只是回報檢查結果,優先用 status/check API 寫結果,不要靠 PAT push 再觸發下一輪 CI。",
|
||||
"suggestedCode": "```\ndescription: 'Gitea API token(PR/issue 留言與 push findings 用;請使用最小權限、短效 token,勿在不可信 PR 傳入長效 PAT)'\n```",
|
||||
"sourceIssue": 23
|
||||
},
|
||||
{
|
||||
"id": "F041",
|
||||
"reviewer": "Leo",
|
||||
"focus": "",
|
||||
"badge": "🧰",
|
||||
"severity": "建議",
|
||||
"file": "readme.md",
|
||||
"startLine": 58,
|
||||
"endLine": 131,
|
||||
"problem": "README 的功能表把分支名稱與行號大量硬編在外部 URL 裡,這次已經需要整批 `master` 改 `develop` 並同步多個 `#Lxx`。這類文件會隨任何程式碼插行、函式移動或預設分支變更而失準,維護成本會線性累積,最後讀者點到的文件比沒有文件更誤導。",
|
||||
"suggestion": "改用 repo 相對連結、不固定行號,或把這段功能表改由腳本從 JSDoc 自動產生。若需要連到特定實作,優先連到檔案或錨點,避免每次重排程式碼都要同步更新幾十個行號。",
|
||||
"suggestedCode": "```\n| log.taipeiNow | [src/lib/log.js](src/lib/log.js) | 取得台北時區 yyyy/MM/dd HH:mm:ss 時間字串 |\n| review.runAttackers | [src/lib/review.js](src/lib/review.js) | 攻擊方 sub agent 並行找問題並合併列表 |\n```",
|
||||
"sourceIssue": 23
|
||||
}
|
||||
],
|
||||
"excluded": []
|
||||
}
|
||||
@@ -0,0 +1,184 @@
|
||||
{
|
||||
"generatedAt": "2026/07/21 14:27:42",
|
||||
"commitSha": "9e7f8a2a0a807c26e12e9bf0381e7decfb9e5568",
|
||||
"prNumber": 6,
|
||||
"tool": {
|
||||
"name": "codex",
|
||||
"version": "codex-cli 0.144.6",
|
||||
"model": "gpt-5.5"
|
||||
},
|
||||
"findings": [],
|
||||
"excluded": [
|
||||
{
|
||||
"reviewer": "Assassin",
|
||||
"focus": "security",
|
||||
"badge": "🗡️",
|
||||
"severity": "嚴重",
|
||||
"file": "src/lib/diagnostics.js",
|
||||
"startLine": 23,
|
||||
"endLine": 23,
|
||||
"problem": "攻擊者只要讓 AI CLI 在 debug 模式下把 `Authorization: token <secret>` 或 `Authorization: Basic <base64>` 印到 stderr/stdout,這條遮罩規則只會遮掉 `token`/`Basic` 這個 scheme,後面的真正憑證仍會進 CI log。這正好打穿本檔宣稱的「安全診斷」防線,PAT 或 API token 會被長期保存並暴露給可讀 log 的人。",
|
||||
"suggestion": "把整個 Authorization header value 視為機密,不要只特判 Bearer。應遮掉 scheme 與 credential 全段;若要保留 scheme,也只能保留固定白名單字樣,不能留下後面的 token。",
|
||||
"suggestedCode": ".replace(/(authorization\\s*[:=]\\s*)(?:\\S+\\s+)?\\S+/gi, '$1***')",
|
||||
"id": "F001",
|
||||
"verdicts": {
|
||||
"Paladin": {
|
||||
"exclude": true,
|
||||
"reason": "可排除(重複)。歷史 finding 已指出除錯診斷輸出中 Authorization 遮罩規則可能只遮到 scheme、留下後方憑證,並造成 CI log 洩漏,與本條同一問題。"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"reviewer": "Leo",
|
||||
"focus": "maintainability",
|
||||
"badge": "🧰",
|
||||
"severity": "警告",
|
||||
"file": "src/index.js",
|
||||
"startLine": 181,
|
||||
"endLine": 239,
|
||||
"problem": "`main()` 這次把「PR 留言」、「issue 暫存」、「issue 建立後 flush」三種狀態直接塞進閉包變數 `currentRunCommentIds`、`issueBuffer`、`issue` 與 `queueOrPostComment()`。未來只要再新增一種落地方式或調整留言順序,維護者必須同時理解整個主流程的時序,否則很容易出現留言漏發、舊留言誤標、或 issue 尚未建立卻被使用的狀態錯誤。這段已經不是單純編排,而是隱含一個留言發布狀態機。",
|
||||
"suggestion": "把留言目的地抽成小型模組,例如 `CommentSink` / `ReviewPublisher`,讓 `main()` 只負責流程編排:`publisher.postContext()`、`publisher.flushIssue()`、`publisher.resolveOldPrComments()`。建問題模式的暫存與 flush 可獨立測試,半年後改流程時不用在 `main()` 裡追閉包狀態。",
|
||||
"suggestedCode": "",
|
||||
"id": "F007",
|
||||
"verdicts": {
|
||||
"Paladin": {
|
||||
"exclude": true,
|
||||
"reason": "可排除(命中已知排除事項且重複)。既有紀錄已涵蓋 main() 內留言路由、issue 狀態、緩衝佇列與發布狀態機耦合的同一問題。"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"reviewer": "Leo",
|
||||
"focus": "maintainability",
|
||||
"badge": "🧰",
|
||||
"severity": "警告",
|
||||
"file": "readme.md",
|
||||
"startLine": 56,
|
||||
"endLine": 132,
|
||||
"problem": "README 這次把大量連結從 `branch/master` 改成 `branch/develop`,同時保留許多硬編碼行號。這種文件會隨分支名稱、預設分支、或任一檔案插入幾行就整批失準;未來維護者每次調整程式都得同步修幾十個 URL,否則文件看起來精準、實際上卻導到錯誤位置。",
|
||||
"suggestion": "改用 repo 相對連結並盡量避免行號,例如 `src/lib/log.js` 或 `src/lib/log.js#L20` 只保留少數真正需要精準定位的 API。若這段是產生文件,請把分支名稱與連結格式集中在產生器設定,不要把同一個 branch 字串散落在 README 表格裡。",
|
||||
"suggestedCode": "",
|
||||
"id": "F008",
|
||||
"verdicts": {
|
||||
"Paladin": {
|
||||
"exclude": true,
|
||||
"reason": "可排除(重複)。歷史 findings 已多次指出 README 大量硬編 branch 與行號深連結,造成文件與原始碼高同步成本;本條為同一問題。"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"reviewer": "Mage",
|
||||
"focus": "logic",
|
||||
"badge": "🔮",
|
||||
"severity": "警告",
|
||||
"file": "src/index.js",
|
||||
"startLine": 217,
|
||||
"endLine": 225,
|
||||
"problem": "建問題模式先建立 issue,再逐則 flush `issueBuffer`,但中途任一留言 API 失敗會直接拋出,沒有回滾或冪等處理。最小重現:`gitea.createIssue` 成功建立 #10,第一則 buffered comment 成功,第二則因 500/timeout 失敗 → 主流程 exit 1,PR 沒有 issue 連結、也沒有結果 commit;重跑時又建立 #11,留下半成品 issue #10。這會在暫時性 API 錯誤下造成重複追蹤 issue 與狀態不一致。",
|
||||
"suggestion": "建立 issue 後立即寫入可重試識別資訊,重跑前先搜尋/復用既有本 PR 的 AI review issue;或在 flush 失敗時捕捉錯誤,將已建立 issue 補上失敗狀態與 PR 回連,再讓流程以可診斷方式收束。",
|
||||
"suggestedCode": "",
|
||||
"id": "F010",
|
||||
"verdicts": {
|
||||
"Paladin": {
|
||||
"exclude": true,
|
||||
"reason": "可排除(命中已知排除事項且重複)。issue 建立後 flush 暫存留言失敗、重跑又建立重複 issue,正是已知排除事項與多筆歷史 findings 已記錄的問題。"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"reviewer": "Maya",
|
||||
"focus": "testing",
|
||||
"badge": "🧪",
|
||||
"severity": "警告",
|
||||
"file": "src/index.js",
|
||||
"startLine": 180,
|
||||
"endLine": 241,
|
||||
"problem": "建問題模式新增了「先暫存留言、確定有保留問題才建立 issue、再 flush 暫存留言」的流程,但目前新增測試只驗到低階 helper,沒有驗證主流程在 create-issue=true 時的留言去向與靜默通過行為。這裡若順序錯了,可能會把原本應該留在 issue 的工具/diff/角色留言發到 PR,或在無保留問題時留下不該出現的 PR 留言。",
|
||||
"suggestion": "請補主流程層級測試,stub `gitea`、`review.runAttackers`、`review.runDefenders`、`agents.detectTool`,至少驗證:\n\n| 情境 | 應斷言 |\n| --- | --- |\n| `createIssue=true` 且 `kept.length > 0` | 建 issue 前的情境留言先暫存,issue 建立後依序寫入該 issue |\n| `createIssue=true` 且 `kept.length === 0` | 不建立 issue、不對 PR 留言、不呼叫 `resolveOldComments` |\n| 一般模式 | 情境留言仍發到 PR,且 id 被加入 `currentRunCommentIds` |",
|
||||
"suggestedCode": "",
|
||||
"id": "F012",
|
||||
"verdicts": {
|
||||
"Paladin": {
|
||||
"exclude": true,
|
||||
"reason": "可排除(重複)。歷史 findings 已涵蓋 create-issue 模式中留言先暫存、issue 建立後依序寫入、無 finding 靜默通過與一般模式留言目的地缺少主流程測試。"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"reviewer": "Maya",
|
||||
"focus": "testing",
|
||||
"badge": "🧪",
|
||||
"severity": "警告",
|
||||
"file": "src/index.js",
|
||||
"startLine": 354,
|
||||
"endLine": 395,
|
||||
"problem": "新增的建問題模式會依嚴重度分流:嚴重問題改發到 issue、PR 回貼 issue 連結,且只有嚴重問題才呼叫 `addIssueDependency`。目前測試沒有覆蓋這個決策矩陣,等於沒有驗證「警告/建議不阻擋合併」與「嚴重問題要建立相依」這兩個關鍵行為。",
|
||||
"suggestion": "請補 create-issue 模式的結果分流測試,至少涵蓋:\n\n| findings | 應斷言 |\n| --- | --- |\n| 只有警告/建議 | 建 issue、逐條留言、PR 回貼連結,但不呼叫 `addIssueDependency` |\n| 有嚴重問題 | 呼叫 `postSevereToIssue`、PR 回貼連結,並呼叫 `addIssueDependency(ctx, ctx.prNumber, issue.number)` |\n| `addIssueDependency` 拋錯 | 流程降級完成,不中斷收尾 commit |",
|
||||
"suggestedCode": "",
|
||||
"id": "F013",
|
||||
"verdicts": {
|
||||
"Paladin": {
|
||||
"exclude": true,
|
||||
"reason": "可排除(重複)。歷史 findings 已涵蓋建問題模式的嚴重/非嚴重分流、PR 回貼、相依 API 降級與核心分支缺少測試;本條屬同一測試缺口。"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"reviewer": "Maya",
|
||||
"focus": "testing",
|
||||
"badge": "🧪",
|
||||
"severity": "警告",
|
||||
"file": "src/lib/gitrepo.js",
|
||||
"startLine": 130,
|
||||
"endLine": 188,
|
||||
"problem": "`resolveMergeBase` 新增了多段 fetch 補歷史策略、每次補抓後重試 merge-base、以及淺層 repo 才執行 `--unshallow` 的行為,但測試只驗證不安全 baseRef 會被拒絕,沒有驗證這些成功/失敗路徑。這段是 diff 基準的核心,一旦 fallback 順序或條件壞掉,review 可能拿錯範圍或在 shallow checkout 直接失敗。",
|
||||
"suggestion": "請把 git 執行層抽成可注入或以臨時 repo 測試,補齊:首次 merge-base 成功不跑 fallback、deepen base 後成功即停止、deepen PR HEAD 用目前 HEAD SHA、只有 shallow repo 才嘗試 `--unshallow`、全部策略失敗時錯誤訊息含診斷且保留 cause。",
|
||||
"suggestedCode": "",
|
||||
"id": "F014",
|
||||
"verdicts": {
|
||||
"Paladin": {
|
||||
"exclude": true,
|
||||
"reason": "可排除(重複)。歷史 findings 已針對 resolveMergeBase 多階段 fetch、shallow 與非 shallow 分支、停止條件、降級與最終失敗診斷缺少測試提出相同問題。"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"reviewer": "Maya",
|
||||
"focus": "testing",
|
||||
"badge": "🧪",
|
||||
"severity": "警告",
|
||||
"file": "src/lib/gitrepo.js",
|
||||
"startLine": 331,
|
||||
"endLine": 366,
|
||||
"problem": "`pushWithCredential` 是這次結果 commit 能否用 PAT 觸發下一輪 CI 的關鍵,但目前沒有測試驗證它真的清掉 checkout 的自動 token、再注入 PAT Authorization,也沒有測失敗時不外洩 remote URL/token。這條失敗路徑沒被試煉過,可能讓 `[failure]` 結果 commit 無法觸發快速回報,或在錯誤訊息裡洩漏認證資訊。",
|
||||
"suggestion": "請補 `commitAndPushFindings`/`pushWithCredential` 的測試,stub `execFileSync` 驗證:`git push` 使用不含帳密的 remote URL、`GIT_CONFIG_COUNT=2`、第 0 筆 extraheader 為空值、第 1 筆為 Basic Authorization、remote origin 不符時拒絕、push 失敗時拋出的錯誤不包含 token 或 remote URL。",
|
||||
"suggestedCode": "",
|
||||
"id": "F015",
|
||||
"verdicts": {
|
||||
"Paladin": {
|
||||
"exclude": true,
|
||||
"reason": "可排除(重複)。歷史 findings 已涵蓋 pushWithCredential/commitAndPushFindings 的認證推送策略、token 注入、推送目標與失敗時不外洩 token 或 URL 的測試缺口。"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"reviewer": "Maya",
|
||||
"focus": "testing",
|
||||
"badge": "🧪",
|
||||
"severity": "建議",
|
||||
"file": "src/lib/diagnostics.js",
|
||||
"startLine": 21,
|
||||
"endLine": 32,
|
||||
"problem": "`redactSecrets` 新增多個遮罩規則與控制字元單行化,但測試只透過 `agentFailureDetail` 間接覆蓋 Authorization 與 token 兩種格式。URL 內嵌帳密、長 token、GitHub token 樣式、控制字元注入與 null/undefined 邊界都還沒被直接驗證。",
|
||||
"suggestion": "請補 `redactSecrets` 的直接單元測試,包含:`https://user:pass@host`、`ghp_...`、40 字以上 token、含換行/tab 的假日誌注入、`null`/`undefined`。斷言重點是輸出為單行、敏感片段被 `***` 取代,且一般錯誤文字仍保留可診斷性。",
|
||||
"suggestedCode": "",
|
||||
"id": "F016",
|
||||
"verdicts": {
|
||||
"Paladin": {
|
||||
"exclude": true,
|
||||
"reason": "可排除(重複)。歷史 findings 已記錄失敗診斷與 redactSecrets 對 Authorization、URL 帳密、token 格式、控制字元、截斷與空值邊界缺少測試;本條為同一測試缺口。"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,204 @@
|
||||
{
|
||||
"generatedAt": "2026/07/21 14:42:39",
|
||||
"commitSha": "d424447d1502f49538fcb3093d23b5ac7bfa16c5",
|
||||
"prNumber": 6,
|
||||
"tool": {
|
||||
"name": "codex",
|
||||
"version": "codex-cli 0.144.6",
|
||||
"model": "gpt-5.5"
|
||||
},
|
||||
"findings": [
|
||||
{
|
||||
"reviewer": "Bard",
|
||||
"focus": "style",
|
||||
"badge": "🎼",
|
||||
"severity": "建議",
|
||||
"file": "src/lib/gitrepo.js",
|
||||
"startLine": 139,
|
||||
"endLine": 160,
|
||||
"problem": "`runFetch`、`tryMergeBase`、`firstError`、`strategies` 夾在 `resolveMergeBase` 主旋律中,使這個函式同時負責驗證、fetch 策略編排、診斷文字組裝與錯誤包裝。即使邏輯可行,閱讀節奏已偏密,維護者很難一眼分辨「主要流程」與「補救策略」。",
|
||||
"suggestion": "建議將 fetch 策略與診斷收集抽成小函式,例如 `fetchAndRecord`、`resolveMergeBaseWithStrategies`,讓 `resolveMergeBase` 保留高階流程:驗證 baseRef → fetch base → 嘗試 merge-base → 補抓歷史。",
|
||||
"suggestedCode": "",
|
||||
"id": "F003",
|
||||
"verdicts": {
|
||||
"Paladin": {
|
||||
"exclude": false,
|
||||
"reason": "保留。歷史 findings 主要涵蓋 resolveMergeBase 缺測試與診斷不足,本條指向函式內策略編排、診斷組裝與錯誤包裝混雜的可維護性問題,未被既有排除事項完整涵蓋。"
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"excluded": [
|
||||
{
|
||||
"reviewer": "Bard",
|
||||
"focus": "style",
|
||||
"badge": "🎼",
|
||||
"severity": "建議",
|
||||
"file": "src/index.js",
|
||||
"startLine": 179,
|
||||
"endLine": 212,
|
||||
"problem": "`queueOrPostComment` 與 `createIssueAndFlushBufferedComments` 這兩個閉包名稱像兩段不同旋律:一個強調「排隊或發布」,另一個卻把「建立 issue、flush 暫存留言、設定狀態」全塞進名稱與實作。讀者要來回追 `trackingIssue`、`pendingIssueCommentBodies`,節奏偏長且語意負擔重。",
|
||||
"suggestion": "建議統一命名語彙,例如把「暫存/發布」集中成 `postReviewComment`、`flushPendingIssueComments`,讓函式名稱只描述一件事;建立 issue 與 flush 留言也可拆成兩段,讀起來會更像樂句而不是長句。",
|
||||
"suggestedCode": "",
|
||||
"id": "F002",
|
||||
"verdicts": {
|
||||
"Paladin": {
|
||||
"exclude": true,
|
||||
"reason": "可排除(重複)。歷史 finding 已指出 main() 內新增閉包與 issue/comment 路由細節讓主流程閱讀負擔加重;本條只是改以目前函式名稱描述同一維護性問題。"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"reviewer": "Leo",
|
||||
"focus": "maintainability",
|
||||
"badge": "🧰",
|
||||
"severity": "警告",
|
||||
"file": "src/index.js",
|
||||
"startLine": 165,
|
||||
"endLine": 213,
|
||||
"problem": "`main()` 這次把「留言目的地切換、issue 建立、暫存留言 flush、標籤挑選前置狀態」都塞進閉包與可變狀態(`pendingIssueCommentBodies`、`trackingIssue`、`currentRunCommentIds`)。半年後要改建問題模式時,維護者得同時追蹤主流程步驟、閉包副作用與留言落點,任何新增留言點都可能忘記處理 queue/flush 或 PR 排除清單,長期會讓流程編排變得很脆弱。",
|
||||
"suggestion": "把留言目的地抽成明確的小型物件或模組,例如 `ReviewCommentSink` / `IssueCommentSink`,由它負責 `post()`、`flush()`、`currentRunCommentIds`。`main()` 只保留流程順序,不直接管理留言暫存與 issue 狀態。",
|
||||
"suggestedCode": "",
|
||||
"id": "F006",
|
||||
"verdicts": {
|
||||
"Paladin": {
|
||||
"exclude": true,
|
||||
"reason": "可排除(命中已知排除事項且重複)。已知與歷史 findings 已涵蓋 main() 內留言目的地、issue 狀態、緩衝佇列與可變閉包耦合,及應抽出發布器/sink 的方向。"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"reviewer": "Leo",
|
||||
"focus": "maintainability",
|
||||
"badge": "🧰",
|
||||
"severity": "警告",
|
||||
"file": "src/index.js",
|
||||
"startLine": 302,
|
||||
"endLine": 353,
|
||||
"problem": "建問題模式的收束邏輯把「挑標籤、建立 issue、發 finding、回貼 PR、設定 issue dependency、決定是否阻擋合併」全部展開在 `main()`。這段和前面的 `createIssueAndFlushBufferedComments` 共同組成一條隱性的 issue workflow,但邊界沒有被封裝;未來要新增 issue 模板、改排序、改阻擋條件或重試策略時,會在主流程裡到處補條件,維護成本會快速上升。",
|
||||
"suggestion": "把建問題模式整理成單一高階函式,例如 `review.publishIssueModeResults({ ctx, gitea, tool, model, cwd, kept, severe, others, bufferedComments })`,主流程只接收 `trackingIssue` / `filesToCommit` 等結果。這樣 PR 模式與 issue 模式的責任邊界會清楚很多。",
|
||||
"suggestedCode": "",
|
||||
"id": "F007",
|
||||
"verdicts": {
|
||||
"Paladin": {
|
||||
"exclude": true,
|
||||
"reason": "可排除(重複)。此條與 F006 及歷史 findings 同樣指向建問題模式在 main() 中承擔 issue workflow、發布分流與狀態管理,屬同一維護性問題的延伸描述。"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"reviewer": "Leo",
|
||||
"focus": "maintainability",
|
||||
"badge": "🧰",
|
||||
"severity": "建議",
|
||||
"file": "readme.md",
|
||||
"startLine": 56,
|
||||
"endLine": 132,
|
||||
"problem": "README 內大量維護到原始碼行號的連結,這次 diff 只是分支與行號位移就需要同步改一整片表格。這種文件和程式碼行號的硬耦合很容易在後續修改時過期,讀者點到錯誤位置,維護者也要花時間做機械式同步。",
|
||||
"suggestion": "若這份表格是 API 索引,建議改成自動產生,或至少移除 `#Lxx` 行號錨點,改連到檔案或穩定章節錨點。讓文件描述 API,而不是跟著每次程式碼行號漂移。",
|
||||
"suggestedCode": "",
|
||||
"id": "F008",
|
||||
"verdicts": {
|
||||
"Paladin": {
|
||||
"exclude": true,
|
||||
"reason": "可排除(重複)。歷史 findings 已多次指出 README 功能表硬編分支與行號連結,導致文件與原始碼高度耦合且容易失準。"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"reviewer": "Mage",
|
||||
"focus": "logic",
|
||||
"badge": "🔮",
|
||||
"severity": "警告",
|
||||
"file": "src/index.js",
|
||||
"startLine": 251,
|
||||
"endLine": 253,
|
||||
"problem": "無可審查變更的分支在一般模式下會先把舊留言標為過時,之後才保存 findings 與 commit/push 結果。最小重現:`files.length === 0`、`nothingToReviewComment` 成功、`resolveOldComments` 成功,但接著 `saveFindings` 因檔案系統錯誤或 `commitFindings` 因 push 失敗拋例外。此時舊審查結果已被標過時,但沒有成功落地本回合的 success 結果 commit,狀態會停在半更新。",
|
||||
"suggestion": "把 `review.resolveOldComments` 延後到 `saveFindings` 與必要的 `commitFindings` 成功之後;或至少在空變更路徑也遵守同一個交易順序:先產生並提交本回合結果,再清理舊留言。",
|
||||
"suggestedCode": "",
|
||||
"id": "F010",
|
||||
"verdicts": {
|
||||
"Paladin": {
|
||||
"exclude": true,
|
||||
"reason": "可排除(命中已知排除事項)。維護者已裁示舊留言應刻意在本回合結果發布前標為過時;本條要求延後清理,落在同一已排除範圍。"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"reviewer": "Maya",
|
||||
"focus": "testing",
|
||||
"badge": "🧪",
|
||||
"severity": "警告",
|
||||
"file": "src/index.js",
|
||||
"startLine": 160,
|
||||
"endLine": 353,
|
||||
"problem": "建問題模式的主流程被大幅改寫,但目前測試只驗證了少數 helper,沒有驗證「留言先暫存、確定有 kept finding 才建 issue、無保留問題時靜默通過、嚴重問題才加 issue dependency、最後回貼 PR 連結」這些新增流程。這些行為一旦順序或條件寫錯,測試不會擋下來。",
|
||||
"suggestion": "請補 `main()` 層級的流程測試,stub `agents`、`review`、`gitea`、`gitrepo`,至少覆蓋:`createIssue=true && kept=[]` 不建立 issue/不貼 PR 留言;`kept` 只有警告/建議時建立 issue、flush 暫存留言、回貼 PR 連結但不呼叫 `addIssueDependency`;`kept` 含嚴重時呼叫 `addIssueDependency`,且 dependency 失敗時流程仍完成並 commit failure findings。",
|
||||
"suggestedCode": "",
|
||||
"id": "F011",
|
||||
"verdicts": {
|
||||
"Paladin": {
|
||||
"exclude": true,
|
||||
"reason": "可排除(重複)。歷史 findings 已涵蓋建問題模式 main() 層級流程缺測試,包括暫存留言、有 finding 才建 issue、無 finding 靜默、PR 回貼、嚴重與非嚴重分流及 dependency 失敗降級。"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"reviewer": "Maya",
|
||||
"focus": "testing",
|
||||
"badge": "🧪",
|
||||
"severity": "警告",
|
||||
"file": "src/lib/gitrepo.js",
|
||||
"startLine": 307,
|
||||
"endLine": 361,
|
||||
"problem": "`pushWithCredential` 新增了關鍵認證行為,但沒有測試驗證它真的用 `GIT_CONFIG_*` 清掉 checkout 的 extraheader、再注入 PAT Authorization,也沒有測試遠端 URL 不符與 push 失敗時不洩漏 URL/token 的失敗路徑。這段是結果 commit 能否觸發下一輪 CI 的核心,沒有測試等於這個新契約還沒通過試煉。",
|
||||
"suggestion": "請補推送行為測試。可用可注入的 exec wrapper 或子程序測試方式驗證:`git push` argv 不含 token、env 包含兩筆同 scope extraheader、`GIT_CONFIG_VALUE_0` 為空值、`GIT_CONFIG_VALUE_1` 為 Basic header;再補 `remote.origin !== server.origin` 與 exec 失敗時錯誤訊息不含 token/remoteUrl 的案例。",
|
||||
"suggestedCode": "",
|
||||
"id": "F012",
|
||||
"verdicts": {
|
||||
"Paladin": {
|
||||
"exclude": true,
|
||||
"reason": "可排除(重複)。歷史 findings 已記錄 pushWithCredential/pushToken 認證推送路徑缺少測試,包含 token 不進 argv、認證遮蔽、推送目標與失敗訊息不洩漏敏感資訊。"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"reviewer": "Maya",
|
||||
"focus": "testing",
|
||||
"badge": "🧪",
|
||||
"severity": "警告",
|
||||
"file": "src/lib/gitrepo.js",
|
||||
"startLine": 130,
|
||||
"endLine": 192,
|
||||
"problem": "`resolveMergeBase` 新增多段 fetch fallback:先抓 base、再 deepen base、deepen PR HEAD、最後 shallow repo 才 unshallow,但現有測試只驗證不安全 baseRef 會被拒絕,沒有驗證淺層歷史補抓順序、每次 fetch 後會重試 merge-base、成功後會短路,也沒有覆蓋所有策略失敗時的診斷錯誤。",
|
||||
"suggestion": "請補針對 `resolveMergeBase` 的失敗與邊界測試。建議把 git 執行函式抽成可替換依賴,或用臨時 git repo 模擬 shallow 狀態,斷言:首次 merge-base 成功不走 fallback;deepen base 成功後立即回傳;deepen PR HEAD 使用目前 HEAD SHA 而不是遠端 `HEAD`;非 shallow repo 不呼叫 `--unshallow`;全部失敗時錯誤包含策略診斷。",
|
||||
"suggestedCode": "",
|
||||
"id": "F013",
|
||||
"verdicts": {
|
||||
"Paladin": {
|
||||
"exclude": true,
|
||||
"reason": "可排除(重複)。歷史 findings 已針對 resolveMergeBase 多階段 fetch、淺層與非淺層分支、成功短路、降級順序與最終失敗診斷缺測試提出相同問題。"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"reviewer": "Maya",
|
||||
"focus": "testing",
|
||||
"badge": "🧪",
|
||||
"severity": "建議",
|
||||
"file": "src/lib/diagnostics.js",
|
||||
"startLine": 18,
|
||||
"endLine": 69,
|
||||
"problem": "`redactSecrets` 與 `agentFailureDetail` 是新加入的安全診斷防線,但測試只覆蓋 Authorization/token 的基本遮罩。控制字元單行化、URL 內嵌帳密、長 token/hex、輸入與輸出長度截斷、以及沒有 error code 時的 fallback 訊息都還沒被驗證。",
|
||||
"suggestion": "請補診斷邊界測試,至少包含:含換行與 tab 的輸出不會產生多行 log;`https://user:pass@host` 會被遮罩;40 字元以上 token 會被遮罩;debug 模式下 stderr/stdout 只輸出到限制長度;沒有 `error.code`、`signal`、`stderr/stdout` 時仍回傳安全的 fallback 訊息。",
|
||||
"suggestedCode": "",
|
||||
"id": "F014",
|
||||
"verdicts": {
|
||||
"Paladin": {
|
||||
"exclude": true,
|
||||
"reason": "可排除(重複)。歷史 findings 已涵蓋 redactSecrets/agentFailureDetail 對控制字元、URL 帳密、token 格式、截斷與 fallback 診斷等邊界缺少測試。"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -34,16 +34,20 @@ jobs:
|
||||
- name: 安裝工具
|
||||
# 使用 Gitea composite action 安裝 Antigravity,版本由 vars 指定。
|
||||
uses: https://gitea.jsc.idv.tw/composite-actions/setup-antigravity@${{ vars.ACTION_SETUP_ANTIGRAVITY_VERSION }}
|
||||
with:
|
||||
oauth: ${{ secrets.ANTIGRAVITY_OAUTH }}
|
||||
# 執行目前存取庫的 AI Code Review action。
|
||||
- name: 程式碼審查
|
||||
# 以目前存取庫根目錄的 action.yml 作為 action 來源。
|
||||
uses: ./
|
||||
# 傳入 action inputs。
|
||||
with:
|
||||
# Gitea / GitHub token,用於 PR 留言與 findings 寫回。
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
# PR 留言與 findings 寫回用的 token(呼叫端以 secrets 傳入)。
|
||||
token: ${{ secrets.TOKEN }}
|
||||
# 啟用建問題模式:審查內容改發到追蹤 issue,並在 PR 回貼 issue 連結。
|
||||
create-issue: 'true'
|
||||
# 指定 AI 模型:CI 測試固定用 Antigravity 最省模型以降低消耗。
|
||||
model: gemini-3.5-flash
|
||||
# Codex 工具環境測試 job。
|
||||
test-codex:
|
||||
# Job 在 workflow UI 顯示的名稱。
|
||||
@@ -60,16 +64,20 @@ jobs:
|
||||
- name: 安裝工具
|
||||
# 使用 Gitea composite action 安裝 Codex,版本由 vars 指定。
|
||||
uses: https://gitea.jsc.idv.tw/composite-actions/setup-codex@${{ vars.ACTION_SETUP_CODEX_VERSION }}
|
||||
with:
|
||||
oauth: ${{ secrets.CODEX_OAUTH }}
|
||||
# 執行目前存取庫的 AI Code Review action。
|
||||
- name: 程式碼審查
|
||||
# 以目前存取庫根目錄的 action.yml 作為 action 來源。
|
||||
uses: ./
|
||||
# 傳入 action inputs。
|
||||
with:
|
||||
# Gitea / GitHub token,用於 PR 留言與 findings 寫回。
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
# PR 留言與 findings 寫回用的 token(呼叫端以 secrets 傳入)。
|
||||
token: ${{ secrets.TOKEN }}
|
||||
# 啟用建問題模式:審查內容改發到追蹤 issue,並在 PR 回貼 issue 連結。
|
||||
create-issue: 'true'
|
||||
# 指定 AI 模型:CI 測試固定用 Codex 最省模型以降低消耗。
|
||||
model: gpt-5.5
|
||||
# Claude 工具環境測試 job。
|
||||
test-claude:
|
||||
# Job 在 workflow UI 顯示的名稱。
|
||||
@@ -86,13 +94,17 @@ jobs:
|
||||
- name: 安裝工具
|
||||
# 使用 Gitea composite action 安裝 Claude,版本由 vars 指定。
|
||||
uses: https://gitea.jsc.idv.tw/composite-actions/setup-claude@${{ vars.ACTION_SETUP_CLAUDE_VERSION }}
|
||||
with:
|
||||
oauth: ${{ secrets.CLAUDE_OAUTH }}
|
||||
# 執行目前存取庫的 AI Code Review action。
|
||||
- name: 程式碼審查
|
||||
# 以目前存取庫根目錄的 action.yml 作為 action 來源。
|
||||
uses: ./
|
||||
# 傳入 action inputs。
|
||||
with:
|
||||
# Gitea / GitHub token,用於 PR 留言與 findings 寫回。
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
# PR 留言與 findings 寫回用的 token(呼叫端以 secrets 傳入)。
|
||||
token: ${{ secrets.TOKEN }}
|
||||
# 啟用建問題模式:審查內容改發到追蹤 issue,並在 PR 回貼 issue 連結。
|
||||
create-issue: 'true'
|
||||
# 指定 AI 模型:Claude job 使用 Opus 4.8。
|
||||
model: claude-opus-4-8
|
||||
|
||||
+4
-4
@@ -16,11 +16,11 @@ author: 'Jeffery'
|
||||
# 輸入參數區塊:呼叫端 workflow 以 `with:` 傳入,
|
||||
# runner 會自動注入為 INPUT_* 環境變數(例如 INPUT_TOKEN、INPUT_MODEL、INPUT_CREATE-ISSUE)供主程式讀取。
|
||||
inputs:
|
||||
# Gitea API token:用於對 PR 留言審查結果、以及 push 審查結果檔回 repo。
|
||||
# Gitea API token:用於對 PR/issue 留言審查結果,以及 push 審查結果檔(findings/exclusions)回 repo。
|
||||
token:
|
||||
# 參數用途說明:secrets/vars context 在 action 內不可用,
|
||||
# 故由呼叫端 workflow 以 secrets.GITHUB_TOKEN 傳入。
|
||||
description: 'Gitea API token(PR 留言與 push findings 用;呼叫端以 secrets.GITHUB_TOKEN 傳入)'
|
||||
# 參數用途說明:secrets/vars context 在 action 內不可用,故由呼叫端 workflow 以 secrets 傳入。
|
||||
# 建議傳入能觸發 CI 的 PAT;自動 token 推送結果 commit 時可能不會再觸發 workflow。
|
||||
description: 'Gitea API token(PR/issue 留言與 push findings 用;建議以能觸發 CI 的 PAT 由 secrets 傳入)'
|
||||
# 必填:缺少 token 無法呼叫 Gitea API,action 無法運作。
|
||||
required: true
|
||||
# 指定 AI 工具使用的模型名稱。
|
||||
|
||||
+2
-1
@@ -4,7 +4,8 @@
|
||||
"description": "AI 多角色 code review:攻擊方找問題、防守方裁決誤報,結果留言到 PR 並保存 findings",
|
||||
"main": "src/index.js",
|
||||
"scripts": {
|
||||
"build": "ncc build src/index.js -o dist"
|
||||
"build": "ncc build src/index.js -o dist",
|
||||
"test": "node --test"
|
||||
},
|
||||
"author": "Jeffery",
|
||||
"license": "MIT"
|
||||
|
||||
@@ -38,16 +38,16 @@ jobs:
|
||||
```mermaid
|
||||
flowchart TD
|
||||
S1[1 判斷 bot commit 標記] -->|命中| E0[直接回報 success/failure]
|
||||
S1 -->|未命中| S2[2 舊留言標記解決]
|
||||
S2 --> S3[3 偵測 AI 工具並留言]
|
||||
S3 --> S4[4 讀 .reviewignore 整理 diff 並留言]
|
||||
S4 --> S5[5 攻擊方登場留言]
|
||||
S5 --> S6[6 攻擊方 sub agent 並行找問題]
|
||||
S6 --> S7[7 防守方登場留言]
|
||||
S7 --> S8[8 防守方裁決 → 保存 findings + 誤判回寫 exclusions.json]
|
||||
S8 --> S9[9 嚴重問題逐條掛行留言]
|
||||
S9 --> S10[10 警告+建議彙整表格留言]
|
||||
S10 --> E1[收尾 commit/push + exit code]
|
||||
S1 -->|未命中| N3[3 偵測 AI 工具並留言]
|
||||
N3 --> N4[4 讀 .reviewignore 整理 diff 並留言]
|
||||
N4 --> N5[5 攻擊方登場留言]
|
||||
N5 --> N6[6 攻擊方 sub agent 並行找問題]
|
||||
N6 --> N7[7 防守方登場留言]
|
||||
N7 --> N8[8 防守方裁決 → 保存 findings + 誤判回寫 exclusions.json]
|
||||
N8 --> N2[2 延後將舊留言標記解決(成功產生結果後才執行)]
|
||||
N2 --> N9[9 嚴重問題逐條掛行留言]
|
||||
N9 --> N10[10 警告+建議彙整表格留言]
|
||||
N10 --> E1[收尾 commit/push + exit code]
|
||||
```
|
||||
|
||||
## 專案列表
|
||||
|
||||
+166
-103
@@ -72,7 +72,7 @@ function saveFindings({ cwd, ctx, tool, kept, excluded }) {
|
||||
* 供下一回合 `main()` 步驟 1 比對辨識、直接回報結果而不重複審查。
|
||||
* 依 `commitAndPushFindings` 的回傳值記錄不同日誌:true=已 commit/push;
|
||||
* false=檔案無實際變更(空 commit 防護),記「略過 commit/push」。
|
||||
* commit/push 失敗(例如與開發者新 commit 競態)時僅記 WRN log,不拋出例外、不改變審查結果。
|
||||
* commit/push 失敗(例如與開發者新 commit 競態)時僅記 WRN log,不拋出例外;呼叫端可依回傳值決定是否阻擋。
|
||||
*
|
||||
* @param {Object} params - 解構參數。
|
||||
* @param {string} params.cwd - repo 根目錄(workspace)絕對路徑,git 操作在此目錄執行。
|
||||
@@ -84,12 +84,14 @@ function saveFindings({ cwd, ctx, tool, kept, excluded }) {
|
||||
* @param {string} params.ctx.repository - `owner/repo` 形式的 repo 名稱。
|
||||
* @param {string[]} params.files - 要 commit 的檔案 repo 相對路徑陣列(如 findings 檔、`.gitea/ai-review/exclusions.json`);全數無變更時只記 INF 略過。
|
||||
* @param {'success'|'failure'} params.result - 本回合審查結果:success=無嚴重問題、failure=有嚴重問題;會拼進 commit 訊息尾端。
|
||||
* @returns {void} 無回傳值;成敗僅反映在 log 上。
|
||||
* @returns {boolean} true=已 commit/push;false=無變更或 commit/push 失敗。
|
||||
* @remarks
|
||||
* 使用情境:`main()` 於流程尾端依 `severe.length === 0 ? 'success' : 'failure'` 決定 result、
|
||||
* 依模式組出 filesToCommit(一般模式:findings 檔+有變更時的 exclusions.json;
|
||||
* 建問題模式:只有 exclusions.json)後呼叫本函式;另在步驟 4 判定無可審查變更且非建問題模式時,
|
||||
* 也會以 result: 'success' 提交空 findings。
|
||||
* 推送一律以 `ctx.token` 的身分進行(不走 runner 的 origin 自動 token);只要 token 是能觸發 CI 的
|
||||
* PAT,結果 commit 就會再觸發 CI、由步驟 1 快速回報;
|
||||
* 注意 commit 訊息與模組常數 `BOT_COMMIT_PREFIX` 耦合,修改前綴會使步驟 1 的快速回報失效。
|
||||
*/
|
||||
function commitFindings({ cwd, ctx, files, result }) {
|
||||
@@ -105,44 +107,35 @@ function commitFindings({ cwd, ctx, files, result }) {
|
||||
});
|
||||
if (committed) {
|
||||
log('收尾', 'INF', `審查結果檔已 commit 並 push 回 ${ctx.headRef}(結果:${result})。`);
|
||||
return true;
|
||||
} else {
|
||||
log('收尾', 'INF', '審查結果檔無實際變更,略過 commit/push。');
|
||||
return false;
|
||||
}
|
||||
} catch (err) {
|
||||
// push 失敗(例如與開發者新 commit 競態)時只記錄,不改變審查結果。
|
||||
// push 失敗(例如與開發者新 commit 競態)時只記錄,交由呼叫端依嚴重度決定是否阻擋。
|
||||
log('收尾', 'WRN', `commit/push 審查結果檔失敗:${err.message}。`);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* AI code review 主流程:依固定 10 步驟執行多角色審查,回傳 process exit code。
|
||||
* AI code review 主流程:編排多角色審查、發布審查結果,並回傳 process exit code。
|
||||
*
|
||||
* 流程概要(步驟 2~10 描述一般模式;建問題模式差異見末段):
|
||||
* 1. 快速回報 — 最新 commit 若為 ai-review-bot 的結果 commit([success]/[failure]),直接回報 0/1 不重審;
|
||||
* 2. 將 PR 既有舊留言標記為解決(跳過本回合留言;建問題模式不執行此步);
|
||||
* 3. 偵測 AI 工具(antigravity/codex/claude)並留言;
|
||||
* 4. 讀 .reviewignore、整理 git diff 並留言(無可審查變更時:留言+保存空 findings,
|
||||
* 一般模式 commit success、建問題模式略過 commit,回傳 0);
|
||||
* 5–6. 攻擊方登場留言、每位攻擊方一個 sub agent 並行找問題;
|
||||
* 7–8. 防守方登場留言、裁決誤報後排序並保存 findings JSON,
|
||||
* 並以 appendExclusions 把誤判/重複問題回寫 .gitea/ai-review/exclusions.json;
|
||||
* 9. 嚴重問題逐條掛在程式碼行上留言;
|
||||
* 10. 警告+建議彙整為單一表格留言;
|
||||
* 建問題模式(input: create-issue):不執行步驟 2、不觸碰 PR 既有留言;步驟 3~10 的所有留言
|
||||
* 改發到追蹤 issue(工具/diff/角色留言先暫存,確定有保留問題後才建立 issue 並一次寫入,
|
||||
* 嚴重問題與警告+建議亦發到該 issue);無保留問題則不建 issue、僅在 PR 留審查通過提示;
|
||||
* 收束時依保留問題補掛 issue 標籤,並在 PR 回貼 issue 連結形成雙向關聯;
|
||||
* 收尾:組 filesToCommit —— 一般模式 commit findings 檔(+有變更的 exclusions.json)、
|
||||
* 建問題模式只 commit exclusions.json、無檔案可 commit 時略過;
|
||||
* commit 訊息帶結果標記(success=無嚴重問題、failure=有嚴重問題)。
|
||||
* 一般模式會把審查情境、嚴重問題與警告/建議發布到 PR,並在成功產生本回合結果後才把舊留言標為過時。
|
||||
* 建問題模式會把審查情境與每條 finding 發到追蹤 issue;沒有保留 finding 時不建立 issue、PR 也不留言。
|
||||
* 嚴重 finding 會寫入 failure 結果 commit,警告與建議只建立追蹤資訊,不直接阻擋合併。
|
||||
*
|
||||
* @returns {Promise<number>} process exit code:0=成功(無嚴重問題或無可審查變更、或偵測到 success 標記);
|
||||
* 1=失敗(有嚴重問題、缺 PR 編號/token、找不到 AI 工具、或偵測到 failure 標記)。
|
||||
* @returns {Promise<number>} process exit code:本輪「審查」一律回傳 0(不因嚴重問題直接讓檢查失敗——
|
||||
* 失敗改由推出的 `[ai-review-bot][failure]` 結果 commit,於下一輪在步驟 1 讀 commit 訊息時回報);
|
||||
* 回傳 1 僅發生於:步驟 1 偵測到 `[ai-review-bot][failure]` 結果 commit,或前置條件不足
|
||||
* (缺 PR 編號/token、找不到 AI 工具)等無法進行審查的情況。
|
||||
* @remarks
|
||||
* 使用情境:由本檔尾端的頂層呼叫端執行 —— `main().then((code) => process.exit(code))`;
|
||||
* 非預期例外由頂層 `catch` 記 ERR log 後以 exit code 1 收場,且刻意不 commit 結果標記,
|
||||
* 讓下一次 workflow 觸發時重新完整審查。警告+建議等級的問題不影響成敗,只有「嚴重」會使結果為 failure;
|
||||
* 建問題模式只改變問題明細的落地方式(issue 留言取代 findings 進版控),不改變成敗判定。
|
||||
* 讓下一次 workflow 觸發時重新完整審查。警告+建議等級不影響結果標記,只有「嚴重」會使結果 commit
|
||||
* 標記為 failure;而「失敗檢查(exit 1)」只由步驟 1 讀到該 failure 結果 commit 時產生,審查本輪不直接 exit 1。
|
||||
* 建問題模式只改變問題明細的落地方式(issue 留言取代 findings 進版控),不改變上述結果標記判定。
|
||||
*/
|
||||
async function main() {
|
||||
const ctx = loadContext();
|
||||
@@ -172,14 +165,15 @@ async function main() {
|
||||
|
||||
// 本回合(一般模式)發出的 PR 留言 id:resolveOldComments 標註過時時要跳過這些。
|
||||
const currentRunCommentIds = new Set();
|
||||
// 建問題模式:issue 於「確定有保留問題」後才建立;在那之前的情境留言(工具/diff/角色)
|
||||
// 先暫存於 issueBuffer,建立 issue 後一次寫入。
|
||||
const issueBuffer = [];
|
||||
let issue = null;
|
||||
// 建問題模式:追蹤 issue 於「確定有保留問題」後才建立;在那之前的情境留言(工具/diff/角色)
|
||||
// 先暫存於 pendingIssueCommentBodies,建立 issue 後一次寫入。
|
||||
const pendingIssueCommentBodies = [];
|
||||
let issueModeActive = ctx.createIssue;
|
||||
let trackingIssue = null;
|
||||
/**
|
||||
* 發布一則審查留言。依模式決定去向:
|
||||
* - 一般模式:發到 PR,並記錄留言 id 供 `resolveOldComments` 排除。
|
||||
* - 建問題模式:issue 已建立時發到 issue;尚未建立時先暫存到 `issueBuffer`。
|
||||
* - 建問題模式:追蹤 issue 已建立時發到 issue;尚未建立時先暫存到 `pendingIssueCommentBodies`。
|
||||
*
|
||||
* @param {string} body 要發布的 Markdown 留言內容。
|
||||
* @returns {Promise<Object|null>} 一般模式、或建問題模式且 issue 已建立時回傳 Gitea 留言物件;
|
||||
@@ -188,10 +182,10 @@ async function main() {
|
||||
* 使用情境:只在 `main()` 內部使用,處理工具資訊、diff 摘要、角色登場與
|
||||
* 警告/建議彙整等留言。若 Gitea API 失敗,例外會往上拋出並由主流程頂層 catch 收斂。
|
||||
*/
|
||||
const postComment = async (body) => {
|
||||
if (ctx.createIssue) {
|
||||
if (issue) return gitea.createCommentOnIssue(ctx, issue.number, body);
|
||||
issueBuffer.push(body);
|
||||
const queueOrPostComment = async (body) => {
|
||||
if (issueModeActive) {
|
||||
if (trackingIssue) return gitea.createCommentOnIssue(ctx, trackingIssue.number, body);
|
||||
pendingIssueCommentBodies.push(body);
|
||||
return null;
|
||||
}
|
||||
const created = await gitea.createIssueComment(ctx, body);
|
||||
@@ -199,31 +193,48 @@ async function main() {
|
||||
return created;
|
||||
};
|
||||
/**
|
||||
* 建問題模式:建立追蹤 issue(標題=PR 標題、本文=PR 描述+回溯 PR 的引言,先不掛標籤),
|
||||
* 並把 `issueBuffer` 內暫存的情境留言依序寫入 issue;設定閉包變數 `issue` 供後續留言直接發到 issue。
|
||||
* 僅於「確定有保留問題」時呼叫一次。
|
||||
* 建問題模式:建立追蹤 issue(標題=PR 標題、本文=PR 描述+回溯 PR 的引言,連同挑好的標籤一次建立),
|
||||
* 並把 `pendingIssueCommentBodies` 內暫存的情境留言依流程順序寫入 issue;
|
||||
* 設定閉包變數 `trackingIssue` 供後續留言直接發到 issue。
|
||||
* 僅於「確定有保留問題」時呼叫一次。標籤於建立時一次帶入,省去「先建空標籤 issue 再補掛」的多餘 API 往返。
|
||||
*
|
||||
* @returns {Promise<void>} 無回傳值;結果反映在閉包變數 `issue` 與 issue 留言。
|
||||
* @param {number[]} [labelIds] - 建立 issue 時要一併掛上的標籤 id 陣列(由 `review.selectLabels` 事先挑選);
|
||||
* 空陣列或省略時不掛任何標籤(`gitea.createIssue` 對空陣列不帶 labels 欄位)。
|
||||
* @returns {Promise<void>} 無回傳值;結果反映在閉包變數 `trackingIssue` 與 issue 留言。
|
||||
*/
|
||||
const ensureIssueCreated = async () => {
|
||||
issue = await gitea.createIssue(ctx, {
|
||||
const createIssueAndFlushBufferedComments = async (labelIds = []) => {
|
||||
trackingIssue = await gitea.createIssue(ctx, {
|
||||
title: ctx.prTitle || `AI Code Review:PR #${ctx.prNumber}`,
|
||||
body: templates.issueBody({ prNumber: ctx.prNumber, prBody: ctx.prBody }),
|
||||
labels: [],
|
||||
labels: labelIds,
|
||||
});
|
||||
log('建問題', 'INF', `已建立追蹤 issue #${issue.number},寫入 ${issueBuffer.length} 則情境留言。`);
|
||||
for (const body of issueBuffer) {
|
||||
await gitea.createCommentOnIssue(ctx, issue.number, body);
|
||||
log('建問題', 'INF', `已建立追蹤 issue #${trackingIssue.number},寫入 ${pendingIssueCommentBodies.length} 則情境留言。`);
|
||||
for (const body of pendingIssueCommentBodies) {
|
||||
await gitea.createCommentOnIssue(ctx, trackingIssue.number, body);
|
||||
}
|
||||
issueBuffer.length = 0;
|
||||
pendingIssueCommentBodies.length = 0;
|
||||
};
|
||||
/**
|
||||
* 建問題模式降級:追蹤 issue 無法建立或寫入時,改把已暫存的情境留言發回 PR,後續沿用一般模式。
|
||||
*
|
||||
* @returns {Promise<void>} 無回傳值;會關閉建問題模式並把 PR 留言 id 登錄到 `currentRunCommentIds`。
|
||||
*/
|
||||
const fallbackToPrComments = async () => {
|
||||
issueModeActive = false;
|
||||
trackingIssue = null;
|
||||
for (const body of pendingIssueCommentBodies) {
|
||||
const created = await gitea.createIssueComment(ctx, body);
|
||||
currentRunCommentIds.add(created.id);
|
||||
}
|
||||
pendingIssueCommentBodies.length = 0;
|
||||
};
|
||||
|
||||
// ── 步驟 2:將 PR 既有留言標記為解決(本回合留言除外)───────────────────
|
||||
// 僅一般模式執行;建問題模式不觸碰 PR 既有留言(審查內容改發到 issue)。
|
||||
// 早於偵測工具與所有本回合留言:先把上一回合的 bot 留言標為過時(此時尚無本回合留言)。
|
||||
if (!ctx.createIssue) {
|
||||
await review.resolveOldComments({ ctx, gitea, currentRunCommentIds });
|
||||
}
|
||||
// ── 步驟 2:延後執行 ───────────────────────────────────────────────────
|
||||
// 「將 PR 既有留言標記為解決」原本在此執行,但若工具偵測/diff/攻防裁決任一失敗,
|
||||
// 舊結果會先被清掉卻沒有新結果。故延後到「本回合審查已成功產生結果、發布問題留言前」
|
||||
// 才呼叫 review.resolveOldComments(見下方步驟 4 空變更路徑與步驟 9 前);
|
||||
// 屆時本回合的工具/diff/角色留言已登錄於 currentRunCommentIds,不會被誤標為過時。
|
||||
// 建問題模式不清理 PR 既有審查內容,只在收束時標記舊追蹤 issue 連結。
|
||||
|
||||
// ── 步驟 3:偵測 AI agent 工具並留言 ──────────────────────────────────
|
||||
const tool = agents.detectTool();
|
||||
@@ -233,7 +244,7 @@ async function main() {
|
||||
}
|
||||
log('步驟3', 'INF', `選用工具:${tool.name}(${tool.version})。`);
|
||||
const runLink = `${ctx.serverUrl}/${ctx.repository}/actions/runs/${ctx.runId}`;
|
||||
await postComment(
|
||||
await queueOrPostComment(
|
||||
templates.toolComment({
|
||||
toolName: tool.name,
|
||||
version: tool.version,
|
||||
@@ -253,15 +264,17 @@ async function main() {
|
||||
log('步驟4', 'INF', `變更檔案 ${allFiles.length} 個,套用 .reviewignore 後送審 ${files.length} 個(排除 ${ignoredCount} 個)。`);
|
||||
|
||||
if (files.length === 0) {
|
||||
// 沒有可審查的變更:告知、保存空 findings、以 success 收場。
|
||||
// 建問題模式無問題可追蹤 → 不建 issue,直接在 PR 告知(暫存的情境留言捨棄)。
|
||||
if (ctx.createIssue) {
|
||||
await gitea.createIssueComment(ctx, templates.nothingToReviewComment(ignoredCount));
|
||||
// 沒有可審查的變更:保存空 findings、以 success 收場。
|
||||
// 一般模式在 PR 留言告知;建問題模式靜默通過(不建 issue、PR 也不留言,暫存的情境留言捨棄)。
|
||||
if (issueModeActive) {
|
||||
log('步驟4', 'INF', '建問題模式且無可審查變更:靜默通過(不建 issue、PR 不留言)。');
|
||||
} else {
|
||||
await postComment(templates.nothingToReviewComment(ignoredCount));
|
||||
await queueOrPostComment(templates.nothingToReviewComment(ignoredCount));
|
||||
// 已成功產生本回合結果留言(無可審查變更),此時才把舊留言標為過時(本回合留言已排除)。
|
||||
await review.resolveOldComments({ ctx, gitea, currentRunCommentIds });
|
||||
}
|
||||
const relativePath = saveFindings({ cwd, ctx, tool, kept: [], excluded: [] });
|
||||
if (ctx.createIssue) {
|
||||
if (issueModeActive) {
|
||||
// 建問題模式下 findings 不進版控,且 exclusions.json 無變更 → 沒東西可提交。
|
||||
log('收尾', 'INF', '建問題模式且無可審查變更,略過 commit/push。');
|
||||
} else {
|
||||
@@ -272,23 +285,25 @@ async function main() {
|
||||
|
||||
const diffRows = review.collectDiffRows({ cwd, files, base, gitrepo });
|
||||
await review.fillPurposes({ tool, model: ctx.model, cwd, diffRows });
|
||||
await postComment(templates.diffComment(diffRows, ignoredCount));
|
||||
await queueOrPostComment(templates.diffComment(diffRows, ignoredCount));
|
||||
|
||||
// ── 步驟 5:攻擊方角色登場留言 ─────────────────────────────────────────
|
||||
const roles = loadRoles(path.join(ctx.actionPath, 'src', 'prompts', 'roles'));
|
||||
const attackers = attackersOf(roles);
|
||||
const defenders = defendersOf(roles);
|
||||
log('步驟5', 'INF', `攻擊方 ${attackers.length} 位、防守方 ${defenders.length} 位。`);
|
||||
await postComment(templates.rolesComment({ title: '⚔️ 攻擊方登場', roles: attackers }));
|
||||
await queueOrPostComment(templates.rolesComment({ title: '⚔️ 攻擊方登場', roles: attackers }));
|
||||
|
||||
// ── 步驟 6:每個攻擊方一個 sub agent 並行分析,合併問題列表 ────────────
|
||||
const findings = await review.runAttackers({ tool, model: ctx.model, cwd, attackers, diffRows });
|
||||
|
||||
// ── 步驟 7:防守方角色登場留言 ─────────────────────────────────────────
|
||||
await postComment(templates.rolesComment({ title: '🛡️ 防守方登場', roles: defenders }));
|
||||
await queueOrPostComment(templates.rolesComment({ title: '🛡️ 防守方登場', roles: defenders }));
|
||||
|
||||
// ── 步驟 8:防守方裁決 → 排除 → 排序 → 保存 findings ──────────────────
|
||||
const { kept, excluded } = await review.runDefenders({ tool, model: ctx.model, cwd, defenders, findings });
|
||||
const { kept, excluded } = findings.length === 0
|
||||
? { kept: [], excluded: [] }
|
||||
: await review.runDefenders({ tool, model: ctx.model, cwd, defenders, findings });
|
||||
review.sortFindings(kept);
|
||||
const relativePath = saveFindings({ cwd, ctx, tool, kept, excluded });
|
||||
|
||||
@@ -301,36 +316,15 @@ async function main() {
|
||||
log('步驟8', 'INF', `分組結果:嚴重 ${severe.length} 條、警告+建議 ${others.length} 條。`);
|
||||
|
||||
// ── 建問題模式:確定有保留問題才建立 issue,並把暫存的情境留言一次寫入;
|
||||
// 無保留問題則不建 issue,改在 PR 留一則審查通過提示。 ──────────────────
|
||||
if (ctx.createIssue) {
|
||||
// 無保留問題則不建 issue、PR 也完全不留言(靜默通過,暫存的情境留言捨棄)。 ──────
|
||||
if (issueModeActive) {
|
||||
if (kept.length > 0) {
|
||||
await ensureIssueCreated();
|
||||
} else {
|
||||
log('建問題', 'INF', '沒有保留的問題,略過建立 issue,於 PR 留審查通過提示。');
|
||||
await gitea.createIssueComment(ctx, templates.noFindingsComment());
|
||||
}
|
||||
}
|
||||
|
||||
// ── 步驟 9:嚴重問題留言(一般模式掛在 PR 程式碼行上;建問題模式發到 issue)─
|
||||
if (severe.length > 0) {
|
||||
if (ctx.createIssue) {
|
||||
await review.postSevereToIssue({ ctx, gitea, issueNumber: issue.number, severe });
|
||||
} else {
|
||||
await review.postSevereComments({ ctx, gitea, severe, cwd });
|
||||
}
|
||||
}
|
||||
|
||||
// ── 步驟 10:警告+建議彙整為單一表格留言(去向由 postComment 依模式決定)──
|
||||
if (others.length > 0) {
|
||||
await postComment(templates.othersComment(others));
|
||||
log('步驟10', 'INF', `警告+建議表格留言已發布(${others.length} 條)。`);
|
||||
}
|
||||
|
||||
// ── 建問題模式收束:依保留問題補掛 issue 標籤,並在 PR 回貼 issue 連結(雙向關聯)─
|
||||
if (ctx.createIssue && issue) {
|
||||
// 先依保留問題挑好標籤,於建立 issue 時一次帶入(省去「先建空標籤 issue 再補掛」的多餘 API 往返);
|
||||
// 標籤挑選失敗一律降級為不掛標籤,不阻斷建 issue 流程。
|
||||
let labelIds = [];
|
||||
try {
|
||||
const labels = await gitea.listLabels(ctx);
|
||||
const labelIds = await review.selectLabels({
|
||||
labelIds = await review.selectLabels({
|
||||
tool,
|
||||
model: ctx.model,
|
||||
cwd,
|
||||
@@ -339,35 +333,104 @@ async function main() {
|
||||
prBody: ctx.prBody,
|
||||
findings: kept,
|
||||
});
|
||||
await gitea.addLabelsToIssue(ctx, issue.number, labelIds);
|
||||
} catch (err) {
|
||||
log('建問題', 'WRN', `補掛標籤失敗(${err.message}),issue 不掛標籤。`);
|
||||
log('建問題', 'WRN', `標籤挑選失敗(${err.message}),issue 不掛標籤。`);
|
||||
}
|
||||
try {
|
||||
await createIssueAndFlushBufferedComments(labelIds);
|
||||
} catch (err) {
|
||||
log('建問題', 'WRN', `建立或寫入追蹤 issue 失敗(${err.message}),改用 PR 留言與 findings 檔流程。`);
|
||||
await fallbackToPrComments();
|
||||
}
|
||||
} else {
|
||||
// 無保留問題 → 不建 issue、PR 也不留言(靜默通過,暫存的情境留言捨棄)。
|
||||
log('建問題', 'INF', '沒有保留的問題:靜默通過(不建 issue、PR 不留言)。');
|
||||
}
|
||||
}
|
||||
|
||||
// ── 步驟 2(延後執行,一般模式):審查已成功產生結果,發布問題留言前才把舊留言標為過時 ─
|
||||
// 延後到此可避免工具偵測/diff/攻防裁決任一失敗時舊結果先被清掉卻無新結果;
|
||||
// 本回合的工具/diff/角色留言已登錄於 currentRunCommentIds,不會被誤標為過時;
|
||||
// 嚴重/其他問題留言於本步驟之後才發布,同樣不受影響。
|
||||
if (!issueModeActive) {
|
||||
await review.resolveOldComments({ ctx, gitea, currentRunCommentIds });
|
||||
}
|
||||
|
||||
// ── 步驟 9:嚴重問題留言(一般模式掛在 PR 程式碼行上;建問題模式逐條發到 issue)─
|
||||
if (severe.length > 0) {
|
||||
if (issueModeActive && trackingIssue) {
|
||||
await review.postSevereToIssue({ ctx, gitea, issueNumber: trackingIssue.number, severe });
|
||||
} else {
|
||||
await review.postSevereComments({ ctx, gitea, severe, cwd });
|
||||
}
|
||||
}
|
||||
|
||||
// ── 步驟 10:警告+建議——一般模式彙整為單一表格留言到 PR;
|
||||
// 建問題模式逐條發到 issue,讓每條問題都能被個別回覆。 ──
|
||||
if (others.length > 0) {
|
||||
if (issueModeActive && trackingIssue) {
|
||||
await review.postOthersToIssue({ ctx, gitea, issueNumber: trackingIssue.number, others });
|
||||
} else {
|
||||
await queueOrPostComment(templates.othersComment(others));
|
||||
log('步驟10', 'INF', `警告+建議表格留言已發布(${others.length} 條)。`);
|
||||
}
|
||||
}
|
||||
|
||||
// ── 建問題模式收束:在 PR 回貼 issue 連結(雙向關聯);僅在有嚴重問題時才讓 PR 相依於該 issue ─
|
||||
// 標籤已於建立 issue 時一次帶入(見上方 selectLabels → createIssueAndFlushBufferedComments),此處不再補掛。
|
||||
if (issueModeActive && trackingIssue) {
|
||||
await review.resolveOldIssueLinkComments({ ctx, gitea });
|
||||
await gitea.createIssueComment(
|
||||
ctx,
|
||||
templates.issueLinkComment({
|
||||
issueNumber: issue.number,
|
||||
issueUrl: issue.html_url,
|
||||
templates.prIssueLinkComment({
|
||||
issueNumber: trackingIssue.number,
|
||||
issueUrl: trackingIssue.html_url,
|
||||
severeCount: severe.length,
|
||||
otherCount: others.length,
|
||||
}),
|
||||
);
|
||||
log('建問題', 'INF', `issue #${issue.number} 已寫入審查內容,並在 PR 回貼連結。`);
|
||||
// 只有「嚴重」問題才讓 PR 相依於追蹤 issue(issue 關閉前無法合併,需 repo 啟用「問題相依」功能);
|
||||
// 僅有警告/建議時,issue 仍建立供追蹤,但不掛相依、不阻擋 PR 合併。
|
||||
if (severe.length > 0) {
|
||||
try {
|
||||
await gitea.addIssueDependency(ctx, ctx.prNumber, trackingIssue.number);
|
||||
log('建問題', 'INF', `有嚴重問題:已將 PR #${ctx.prNumber} 設為相依於 issue #${trackingIssue.number},issue 關閉前無法合併。`);
|
||||
} catch (err) {
|
||||
log('建問題', 'WRN', `設定 PR 相依失敗(可能未啟用「問題相依」功能):${err.message}。`);
|
||||
}
|
||||
} else {
|
||||
log('建問題', 'INF', `無嚴重問題(僅警告/建議):issue #${trackingIssue.number} 僅供追蹤,不阻擋 PR 合併。`);
|
||||
}
|
||||
log('建問題', 'INF', `issue #${trackingIssue.number} 已寫入審查內容,並在 PR 回貼連結。`);
|
||||
}
|
||||
|
||||
// ── 收尾:commit 並 push(success=無嚴重問題、failure=有嚴重問題)───────
|
||||
// 一般模式:findings+exclusions.json;建問題模式:問題明細已在 issue 留言,只 commit exclusions.json。
|
||||
// 一般模式:findings+exclusions.json;建問題模式通常只 commit exclusions.json。
|
||||
// 若有嚴重問題,仍 commit findings 檔產生 [failure] 結果 commit,避免相依 API 不支援時 fail-open。
|
||||
const result = severe.length === 0 ? 'success' : 'failure';
|
||||
const filesToCommit = ctx.createIssue ? [] : [relativePath];
|
||||
if (exclusionsChanged) {
|
||||
filesToCommit.push(path.join('.gitea', 'ai-review', 'exclusions.json'));
|
||||
}
|
||||
const filesToCommit = review.resultFilesToCommit({
|
||||
createIssue: issueModeActive,
|
||||
severeCount: severe.length,
|
||||
relativePath,
|
||||
exclusionsChanged,
|
||||
});
|
||||
let resultCommitted = false;
|
||||
if (filesToCommit.length > 0) {
|
||||
commitFindings({ cwd, ctx, files: filesToCommit, result });
|
||||
resultCommitted = commitFindings({ cwd, ctx, files: filesToCommit, result });
|
||||
} else {
|
||||
log('收尾', 'INF', '建問題模式且 exclusions.json 無變更,略過 commit/push。');
|
||||
}
|
||||
return result === 'success' ? 0 : 1;
|
||||
// 本輪「審查」一律以成功收場、不直接讓檢查失敗;有嚴重問題時已推出 [failure] 結果 commit,
|
||||
// 由它再觸發的下一輪在步驟 1 讀 commit 訊息時才回報失敗(exit 1)。如此失敗檢查落在帶有結果
|
||||
// 標記的最新 head 上,與合併判定一致。(result 僅用於上方 commit 訊息的結果標記。)
|
||||
if (result === 'failure') {
|
||||
if (!resultCommitted) {
|
||||
log('收尾', 'ERR', '本輪有嚴重問題,但未成功產生 [failure] 結果 commit;直接回報失敗避免 fail-open。');
|
||||
return 1;
|
||||
}
|
||||
log('收尾', 'INF', '本輪有嚴重問題:已標記結果 commit 為 [failure],失敗檢查由下一輪步驟 1 讀 commit 訊息回報。');
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
main()
|
||||
|
||||
+2
-1
@@ -37,7 +37,8 @@ const path = require('path');
|
||||
* - repository:`owner/repo` 全名(GITHUB_REPOSITORY)。
|
||||
* - owner / repo:自 repository 拆出的擁有者與專案名,缺值時為空字串。
|
||||
* - apiBase:Gitea REST API 基底網址(`<serverUrl>/api/v1`)。
|
||||
* - token:action input `token`(INPUT_TOKEN),用於 API 認證,缺值時為空字串。
|
||||
* - token:action input `token`(INPUT_TOKEN),用於 Gitea API 認證,以及 push findings/exclusions
|
||||
* commit 回 repo;建議為「能觸發 CI 的 PAT」(自動 token 推送不會再觸發 CI)。缺值時為空字串。
|
||||
* - model:action input `model`(INPUT_MODEL,已 trim),指定 AI 模型,缺值時為空字串。
|
||||
* - createIssue:action input `create-issue`(INPUT_CREATE-ISSUE),是否將問題建到
|
||||
* 存取庫的問題追蹤(建問題模式);trim + 小寫後與字串 'true' 嚴格比對,預設 false。
|
||||
|
||||
@@ -0,0 +1,82 @@
|
||||
'use strict';
|
||||
|
||||
// AI CLI 失敗診斷與機密遮罩工具:供 review 流程記錄安全、限長的一行錯誤摘要。
|
||||
|
||||
// 遮罩前先截去的輸入上限,避免對數 MB 失敗輸出跑整份 O(k*n) 正規掃描。
|
||||
const AGENT_DIAGNOSTIC_INPUT_LIMIT = 2_000;
|
||||
// 每段診斷片段(stderr/stdout)寫入日誌的字元上限。
|
||||
const AGENT_DIAGNOSTIC_OUTPUT_LIMIT = 500;
|
||||
|
||||
/**
|
||||
* 遮罩診斷文字中的機密與控制字元,避免寫進 CI log 時外洩。
|
||||
*
|
||||
* 處理順序:換行與控制字元一律壓成單一空白(避免注入假日誌行)→ 遮蔽
|
||||
* `Authorization` 標頭、`token=`/`token:` 型憑證、URL 內嵌帳密、以及常見長金鑰/
|
||||
* 長 hex/`ghp_` 等 token 樣式。屬「盡力遮罩」——無法窮舉所有機密格式,作為輸出
|
||||
* CLI 診斷片段前的防線使用(見 {@link agentFailureDetail})。
|
||||
*
|
||||
* @param {*} text - 待遮罩的原始文字(非字串會先以 `String()` 轉型)。
|
||||
* @returns {string} 已去控制字元並遮蔽常見機密樣式的單行文字。
|
||||
*/
|
||||
function redactSecrets(text) {
|
||||
return String(text ?? '')
|
||||
.replace(/[\r\n\t\v\f\x00-\x1f\x7f]+/g, ' ')
|
||||
.replace(/(authorization\s*[:=]\s*)(?:bearer\s+)?\S+/gi, '$1***')
|
||||
.replace(/((?:api[_-]?key|token|password|secret|bearer)\s*[:=]\s*)\S+/gi, '$1***')
|
||||
.replace(/(https?:\/\/)[^\s/:@]+:[^\s/@]+@/gi, '$1***:***@')
|
||||
.replace(/\bgh[pousr]_[A-Za-z0-9]{16,}\b/g, '***')
|
||||
.replace(/\b[A-Za-z0-9_-]{40,}\b/g, '***')
|
||||
.trim();
|
||||
}
|
||||
|
||||
/**
|
||||
* 將 AI CLI 失敗輸出整理成單行、遮罩且限長的診斷片段。
|
||||
*
|
||||
* @param {string[]} parts - 要附加診斷片段的陣列。
|
||||
* @param {string} label - 診斷欄位名稱(如 stderr/stdout)。
|
||||
* @param {*} value - 原始診斷輸出。
|
||||
* @returns {void}
|
||||
*/
|
||||
function appendRedactedOutput(parts, label, value) {
|
||||
const redacted = redactSecrets(String(value || '').slice(0, AGENT_DIAGNOSTIC_INPUT_LIMIT));
|
||||
if (redacted) parts.push(`${label}:${redacted.slice(0, AGENT_DIAGNOSTIC_OUTPUT_LIMIT)}`);
|
||||
}
|
||||
|
||||
/**
|
||||
* 從 `runAgent` 的失敗結果組出可診斷的一行摘要:退出碼/訊號為主,原始輸出預設隱藏。
|
||||
*
|
||||
* 安全考量:AI CLI 失敗時可能在 stderr/stdout 回顯提示內容、環境資訊、token、PII 或
|
||||
* 原始碼祕密,這些會被長期保存並供多人讀取的 CI log 收錄。因此本函式預設只輸出退出碼、
|
||||
* 訊號與逾時狀態;只有 `ACTIONS_STEP_DEBUG=true` 時才附上經 {@link redactSecrets}
|
||||
* 遮罩且去除控制字元的 stderr/stdout 片段。
|
||||
*
|
||||
* @param {{error: (Error & {code?: number|string, signal?: string, killed?: boolean})|null, stderr?: string, output?: string}} agentResult
|
||||
* `runAgent` 的回傳物件。
|
||||
* @returns {string} 單行診斷摘要(各段以「|」分隔);無任何資訊時回傳固定字串。
|
||||
*/
|
||||
function agentFailureDetail(agentResult) {
|
||||
const parts = [];
|
||||
const err = agentResult && agentResult.error;
|
||||
if (err) {
|
||||
if (err.killed) parts.push('已逾時終止');
|
||||
if (typeof err.code === 'number') parts.push(`exit ${err.code}`);
|
||||
else if (err.code) parts.push(`code ${err.code}`);
|
||||
else if (err.signal) parts.push(`signal ${err.signal}`);
|
||||
}
|
||||
// 失敗輸出可能含 token 或 PII,預設不寫入長期 CI log;debug 模式才輸出遮罩後片段。
|
||||
if (process.env.ACTIONS_STEP_DEBUG === 'true') {
|
||||
appendRedactedOutput(parts, 'stderr', agentResult && agentResult.stderr);
|
||||
appendRedactedOutput(parts, 'stdout', agentResult && agentResult.output);
|
||||
}
|
||||
if (parts.length === 0) {
|
||||
parts.push((err && err.message && redactSecrets(err.message)) || 'AI CLI 執行失敗(無診斷輸出)');
|
||||
}
|
||||
return parts.join('|');
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
AGENT_DIAGNOSTIC_INPUT_LIMIT,
|
||||
AGENT_DIAGNOSTIC_OUTPUT_LIMIT,
|
||||
redactSecrets,
|
||||
agentFailureDetail,
|
||||
};
|
||||
+27
-21
@@ -119,7 +119,7 @@ function createCommentOnIssue(ctx, issueNumber, body) {
|
||||
* 依 Gitea API 回應而定)。
|
||||
* @throws {Error} 請求失敗(非 2xx)由底層 `api` 丟出,錯誤附 `status`、`data`。
|
||||
* @remarks 使用情境:AI review 各步驟把審查摘要、角色登場、問題彙整等內容
|
||||
* 以一般留言形式張貼到本次 PR 上(`main()` 的 `postComment` 閉包即以本函式實作)。
|
||||
* 以一般留言形式張貼到本次 PR 上(`main()` 的 `queueOrPostComment` 閉包即以本函式實作)。
|
||||
*/
|
||||
function createIssueComment(ctx, body) {
|
||||
return createCommentOnIssue(ctx, ctx.prNumber, body);
|
||||
@@ -134,9 +134,9 @@ function createIssueComment(ctx, body) {
|
||||
* @returns {Promise<object[]>} 標籤物件陣列(每筆含 `id`、`name`、`color` 等欄位,
|
||||
* 依 Gitea API 回應而定);存取庫無標籤時為空陣列。
|
||||
* @throws {Error} 任一頁請求失敗(非 2xx)由底層 `api` 丟出,錯誤附 `status`、`data`。
|
||||
* @remarks 使用情境:建問題模式(input: create-issue)下,`main()` 收束時
|
||||
* @remarks 使用情境:建問題模式(input: create-issue)下,`main()` 於確定有保留問題後
|
||||
* 先以本函式取得可用標籤,再交給 `review.selectLabels` 讓 AI 挑出適合的標籤子集合,
|
||||
* 最後以 `addLabelsToIssue` 補掛到追蹤 issue 上。
|
||||
* 最後於建立追蹤 issue 時(`createIssue`)一次帶入這些標籤。
|
||||
*/
|
||||
function listLabels(ctx) {
|
||||
return listAll(ctx, `/repos/${ctx.owner}/${ctx.repo}/labels`);
|
||||
@@ -156,9 +156,9 @@ function listLabels(ctx) {
|
||||
* @returns {Promise<object>} 建立成功的 issue 物件(含 `number`、`title`、
|
||||
* `html_url` 等欄位,依 Gitea API 回應而定)。
|
||||
* @throws {Error} 請求失敗(非 2xx)由底層 `api` 丟出,錯誤附 `status`、`data`。
|
||||
* @remarks 使用情境:建問題模式(input: create-issue)下,`main()` 的 `ensureIssueCreated`
|
||||
* 以 PR 標題/描述為 issue 標題與本文(先不掛標籤)呼叫本函式建立追蹤問題的 issue,
|
||||
* 之後再把審查內容留言到該 issue、並以 `addLabelsToIssue` 補掛標籤。
|
||||
* @remarks 使用情境:建問題模式(input: create-issue)下,`main()` 的 `createIssueAndFlushBufferedComments`
|
||||
* 以 PR 標題/描述為 issue 標題與本文,並帶入 `review.selectLabels` 事先挑好的標籤 id
|
||||
* 呼叫本函式一次建立追蹤問題的 issue(連同標籤),之後再把審查內容逐條留言到該 issue。
|
||||
*/
|
||||
function createIssue(ctx, { title, body, labels }) {
|
||||
return api(ctx, 'POST', `/repos/${ctx.owner}/${ctx.repo}/issues`, {
|
||||
@@ -169,24 +169,30 @@ function createIssue(ctx, { title, body, labels }) {
|
||||
}
|
||||
|
||||
/**
|
||||
* 為既有 issue 追加標籤(不影響既有標籤)。
|
||||
* 對應 endpoint:`POST /repos/{owner}/{repo}/issues/{issueNumber}/labels`。
|
||||
* `labels` 為空陣列時不呼叫 API、直接回傳 `null`(省一次無意義請求)。
|
||||
* 建立「問題相依」關係:讓 URL 上的 issue/PR 相依於(被阻擋於)表單指定的 issue。
|
||||
* 對應 endpoint:`POST /repos/{owner}/{repo}/issues/{issueNumber}/dependencies`
|
||||
* (body 為 IssueMeta:`{index, owner, repo}`)。
|
||||
*
|
||||
* 語義:URL 的 issue(`blockedIssueNumber`)相依於 body 的 issue(`blockingIssueNumber`)——
|
||||
* 在 `blockingIssueNumber` 關閉前,`blockedIssueNumber` 無法合併/關閉。本 endpoint 需 repo 啟用
|
||||
* 「問題相依(issue dependencies)」功能,屬版本/設定相依;未啟用或不支援時 API 會回非 2xx。
|
||||
*
|
||||
* @param {object} ctx - 執行環境 context。必要欄位:`apiBase`、`token`、
|
||||
* `owner`(repo 擁有者)、`repo`(repo 名稱)。
|
||||
* @param {number|string} issueNumber - 目標 issue 編號。
|
||||
* @param {number[]} labels - 要追加的標籤 id 陣列。
|
||||
* @returns {Promise<object[]|null>} 追加後該 issue 的標籤陣列(依 Gitea API 回應而定);
|
||||
* `labels` 為空時回傳 `null`(未發出請求)。
|
||||
* @throws {Error} 請求失敗(非 2xx)由底層 `api` 丟出,錯誤附 `status`、`data`。
|
||||
* @remarks 使用情境:建問題模式(input: create-issue)下先以空標籤建立 issue、
|
||||
* 待防守方裁決得到保留問題後,再以 `selectLabels` 挑出的標籤 id 呼叫本函式補掛,
|
||||
* 讓標籤挑選能參考最終的問題清單。
|
||||
* @param {number|string} blockedIssueNumber - 要被阻擋的 issue/PR 編號(相依方)。
|
||||
* @param {number} blockingIssueNumber - 作為阻擋來源的 issue 編號(同一 repo)。
|
||||
* @returns {Promise<object>} 建立成功的相依關係物件(依 Gitea API 回應而定)。
|
||||
* @throws {Error} 請求失敗(非 2xx,例如未啟用問題相依功能)由底層 `api` 丟出,錯誤附 `status`、`data`。
|
||||
* @remarks 使用情境:建問題模式(input: create-issue)下,`main()` 建立追蹤 issue 後,
|
||||
* 以本函式把「PR(`ctx.prNumber`)相依於追蹤 issue」,讓 issue 完成/關閉前 PR 無法合併;
|
||||
* 呼叫端以 try/catch 降級(功能未啟用時記 WRN、不阻斷流程)。
|
||||
*/
|
||||
function addLabelsToIssue(ctx, issueNumber, labels) {
|
||||
if (!labels || labels.length === 0) return Promise.resolve(null);
|
||||
return api(ctx, 'POST', `/repos/${ctx.owner}/${ctx.repo}/issues/${issueNumber}/labels`, { labels });
|
||||
function addIssueDependency(ctx, blockedIssueNumber, blockingIssueNumber) {
|
||||
return api(ctx, 'POST', `/repos/${ctx.owner}/${ctx.repo}/issues/${blockedIssueNumber}/dependencies`, {
|
||||
index: blockingIssueNumber,
|
||||
owner: ctx.owner,
|
||||
repo: ctx.repo,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -323,7 +329,7 @@ module.exports = {
|
||||
createCommentOnIssue,
|
||||
listLabels,
|
||||
createIssue,
|
||||
addLabelsToIssue,
|
||||
addIssueDependency,
|
||||
listIssueComments,
|
||||
editIssueComment,
|
||||
createReview,
|
||||
|
||||
+154
-32
@@ -4,6 +4,34 @@ const { execFileSync } = require('child_process');
|
||||
|
||||
// git 操作工具:一律以 execFileSync 呼叫 git(不經 shell,避免注入),輸出以 UTF-8 回傳。
|
||||
|
||||
/**
|
||||
* 驗證遠端分支名稱可安全用於 refspec 與 refs/remotes/origin/*。
|
||||
*
|
||||
* @param {string} refName - 使用者或事件 payload 提供的分支名稱。
|
||||
* @param {string} fieldName - 錯誤訊息中的欄位名稱。
|
||||
* @returns {string} 原樣回傳通過驗證的分支名稱。
|
||||
* @throws {Error} 分支名稱空白、含路徑穿越,或不符合 git 分支 ref 規則時拋出。
|
||||
* @remarks
|
||||
* 使用情境:`resolveMergeBase` 的 `baseRef` 與 `commitAndPushFindings` 的
|
||||
* `headRef` 會被組進 refspec;先驗證可避免惡意 payload 影響本地 refs 路徑。
|
||||
*/
|
||||
function assertSafeBranchRef(refName, fieldName) {
|
||||
const value = String(refName || '').trim();
|
||||
if (!value) throw new Error(`${fieldName} 不可為空。`);
|
||||
if (value.includes('..') || value.startsWith('/') || value.endsWith('/') || value.includes('\\')) {
|
||||
throw new Error(`${fieldName} 不是安全的分支名稱:${value}`);
|
||||
}
|
||||
try {
|
||||
execFileSync('git', ['check-ref-format', '--branch', value], {
|
||||
encoding: 'utf8',
|
||||
stdio: ['ignore', 'pipe', 'pipe'],
|
||||
});
|
||||
} catch {
|
||||
throw new Error(`${fieldName} 不是合法的 git 分支名稱:${value}`);
|
||||
}
|
||||
return value;
|
||||
}
|
||||
|
||||
/**
|
||||
* 同步執行 git 指令並回傳原始 stdout 輸出。
|
||||
*
|
||||
@@ -84,13 +112,17 @@ function latestCommitSubject(cwd) {
|
||||
* 解析 PR base 分支與目前 HEAD 的 merge-base commit SHA。
|
||||
*
|
||||
* 先以 refspec 明確更新 `origin/<baseRef>`,再以 `git merge-base origin/<baseRef> HEAD`
|
||||
* 取得共同祖先。若 checkout 是淺層歷史而導致 merge-base 失敗,會補抓完整或更深的
|
||||
* base/head 歷史後重試,避免 PR workflow 因 checkout 預設深度不足而中斷。
|
||||
* 取得共同祖先。若 checkout 是淺層歷史而導致 merge-base 失敗,會依序補抓更完整的
|
||||
* base/head 歷史;**每個補抓策略成功後立即重試 merge-base,一成功即回傳**,
|
||||
* 避免在已補到足夠歷史後仍多做無謂的 fetch 往返(例如 `--unshallow` 成功就不再 deepen)。
|
||||
* 各策略採資料驅動依序執行;全部用盡仍失敗時,丟出彙整了「哪個策略成功/失敗」診斷的錯誤,
|
||||
* 方便維護者判斷是哪一步補抓不足(診斷僅含策略名與成敗,不含 git 原始輸出以免洩漏遠端資訊)。
|
||||
*
|
||||
* @param {string} cwd - git 工作目錄(repo 的 checkout 路徑)。
|
||||
* @param {string} baseRef - PR 目標(base)分支名稱,例如 'master' 或 'develop';不含 'origin/' 前綴。
|
||||
* @returns {string} merge-base 的 commit SHA(40 碼十六進位字串)。
|
||||
* @throws {Error} 補抓歷史後仍無法取得共同祖先時,丟出含 baseRef 的明確錯誤。
|
||||
* @throws {Error} 補抓歷史後仍無法取得共同祖先時,丟出含 baseRef 與各策略診斷的明確錯誤
|
||||
* (`error.cause` 保留首次 merge-base 失敗的原始錯誤)。
|
||||
* @remarks
|
||||
* 使用情境:AI code review 以此結果作為 diff 比較基準——
|
||||
* 先 `resolveMergeBase(cwd, pr.base.ref)` 取得基準 SHA,
|
||||
@@ -98,25 +130,60 @@ function latestCommitSubject(cwd) {
|
||||
* 避免把 base 分支後續演進誤算進 diff。
|
||||
*/
|
||||
function resolveMergeBase(cwd, baseRef) {
|
||||
baseRef = assertSafeBranchRef(baseRef, 'baseRef');
|
||||
const remoteBase = `origin/${baseRef}`;
|
||||
tryGit(cwd, 'fetch', '--no-tags', 'origin', `+refs/heads/${baseRef}:refs/remotes/${remoteBase}`);
|
||||
try {
|
||||
return gitTrim(cwd, 'merge-base', remoteBase, 'HEAD');
|
||||
} catch (firstError) {
|
||||
const isShallow = gitTrim(cwd, 'rev-parse', '--is-shallow-repository') === 'true';
|
||||
if (isShallow) {
|
||||
tryGit(cwd, 'fetch', '--no-tags', '--unshallow', 'origin');
|
||||
}
|
||||
tryGit(cwd, 'fetch', '--no-tags', '--deepen=1000', 'origin', `+refs/heads/${baseRef}:refs/remotes/${remoteBase}`);
|
||||
tryGit(cwd, 'fetch', '--no-tags', '--deepen=1000', 'origin', 'HEAD');
|
||||
const diagnostics = [];
|
||||
// 執行一個 fetch 策略並記錄成敗(只記策略名與成敗,不含 git 原始輸出,避免洩漏遠端資訊)。
|
||||
const runFetch = (label, ...args) => {
|
||||
const ok = tryGit(cwd, ...args);
|
||||
diagnostics.push(`${label}:${ok ? '成功' : '失敗'}`);
|
||||
return ok;
|
||||
};
|
||||
// 每個補抓策略後重試 merge-base:成功回傳 SHA,失敗記診斷並回傳 null。
|
||||
const tryMergeBase = (label) => {
|
||||
try {
|
||||
return gitTrim(cwd, 'merge-base', remoteBase, 'HEAD');
|
||||
} catch {
|
||||
const error = new Error(`無法解析 origin/${baseRef} 與 HEAD 的 merge-base;請確認 checkout 有足夠歷史,或設定 checkout fetch-depth: 0。`);
|
||||
diagnostics.push(`merge-base(${label}):失敗`);
|
||||
return null;
|
||||
}
|
||||
};
|
||||
|
||||
// 先明確更新 origin/<baseRef>,再嘗試 merge-base。
|
||||
runFetch(`fetch base(${baseRef})`, 'fetch', '--no-tags', 'origin', `+refs/heads/${baseRef}:refs/remotes/${remoteBase}`);
|
||||
let firstError;
|
||||
try {
|
||||
return gitTrim(cwd, 'merge-base', remoteBase, 'HEAD');
|
||||
} catch (err) {
|
||||
firstError = err;
|
||||
diagnostics.push('merge-base(首次):失敗');
|
||||
}
|
||||
|
||||
// 資料驅動的補抓策略:先以固定深度分批加深 base 與 HEAD(每步後重試 merge-base,成功即回傳);
|
||||
// 只有仍失敗且為淺層 repo 時,才把成本最高的 --unshallow(下載完整歷史)當最後手段,
|
||||
// 避免大型/長壽 repo 只為找共同祖先就無謂拉全史。
|
||||
// 加深 HEAD 側須以「目前 HEAD 的 commit SHA」補抓——遠端符號 `HEAD` 由伺服器解析為
|
||||
// 遠端預設分支(非目前 checkout 的 PR head),只加深它並不會補到 PR head 的歷史。
|
||||
const headSha = gitTrim(cwd, 'rev-parse', 'HEAD');
|
||||
const strategies = [
|
||||
['deepen base', 'fetch', '--no-tags', '--deepen=1000', 'origin', `+refs/heads/${baseRef}:refs/remotes/${remoteBase}`],
|
||||
['deepen PR HEAD', 'fetch', '--no-tags', '--deepen=1000', 'origin', headSha],
|
||||
];
|
||||
if (gitTrim(cwd, 'rev-parse', '--is-shallow-repository') === 'true') {
|
||||
strategies.push(['unshallow', 'fetch', '--no-tags', '--unshallow', 'origin']);
|
||||
}
|
||||
|
||||
for (const [label, ...args] of strategies) {
|
||||
if (!runFetch(label, ...args)) continue; // fetch 失敗就換下一個策略。
|
||||
const sha = tryMergeBase(`${label} 後`);
|
||||
if (sha) return sha;
|
||||
}
|
||||
|
||||
const error = new Error(
|
||||
`無法解析 origin/${baseRef} 與 HEAD 的 merge-base;請確認 checkout 有足夠歷史,或設定 checkout fetch-depth: 0。診斷:${diagnostics.join(';')}`,
|
||||
);
|
||||
error.cause = firstError;
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -187,7 +254,9 @@ function fileLastUpdatedIso(cwd, file) {
|
||||
* 若目前 HEAD 不在 PR head commit(例如 checkout 停在 merge commit),
|
||||
* 會先 `git checkout --detach <headSha>` 站上 head,避免把 merge 內容推回來源分支。
|
||||
* commit 以 `-c` 臨時覆寫 user.name / user.email,不改動 repo 的 git 設定。
|
||||
* push 先走 origin;失敗(遠端未帶認證)時改用帶 token 的 URL 重試。
|
||||
* push 策略:一律以 `token` 的身分明確認證推送({@link pushWithCredential},不走 runner 的
|
||||
* origin 自動 token)——origin 帶的自動 token(gitea.token / GITHUB_TOKEN)推送不會再觸發 CI,
|
||||
* 改以呼叫端提供的 `token`(建議為 PAT)身分推送,才會讓 PR 的 synchronize 事件再觸發 CI。
|
||||
*
|
||||
* @param {string} cwd - git 工作目錄(repo 的 checkout 路徑)。
|
||||
* @param {object} options - 提交與推送設定。
|
||||
@@ -195,7 +264,7 @@ function fileLastUpdatedIso(cwd, file) {
|
||||
* @param {string} [options.headSha] - PR head 的 commit SHA;有提供且與目前 HEAD 不同時會先 detach 到此 commit。可省略(falsy 時不 detach,直接於目前 HEAD 上 commit)。
|
||||
* @param {string} options.message - commit 訊息。
|
||||
* @param {string[]} options.files - 要加入 commit 的檔案路徑清單(相對 repo 根目錄);全數無實際變更時不 commit、回傳 false。
|
||||
* @param {string} options.token - 具該 repo push 權限的 Gitea access token;僅在 origin push 失敗時用於組出帶認證的重試 URL。
|
||||
* @param {string} options.token - 具該 repo push 權限的 Gitea access token(建議為能觸發 CI 的 PAT);用於 findings commit 的認證推送。
|
||||
* @param {string} options.serverUrl - Gitea 伺服器根網址(例如 https://gitea.example.com),須為合法 URL。
|
||||
* @param {string} options.repository - repo 完整名稱(owner/repo 格式),與 serverUrl 組成 clone URL。
|
||||
* @returns {boolean} true=有變更且已 commit 並 push 到來源分支;false=暫存區與 HEAD 無差異,略過 commit/push。
|
||||
@@ -205,12 +274,13 @@ function fileLastUpdatedIso(cwd, file) {
|
||||
* findings 檔與 `.gitea/ai-review/exclusions.json` 等結果檔提交回 PR 來源分支,
|
||||
* 並依回傳值記錄「已 commit/push」或「無實際變更、略過」的不同日誌。
|
||||
*
|
||||
* 安全注意:push 重試時組出的 URL 內含 token(形如
|
||||
* `https://ai-review-bot:<token>@host/owner/repo.git`),
|
||||
* 絕對不得將此 URL 輸出到日誌、錯誤訊息或任何 action 輸出,以免洩漏 token;
|
||||
* 若需記錄重試行為,只能記載「改用帶認證 URL 重試」而不得包含 URL 本身。
|
||||
* 安全注意:帶認證的推送一律透過 {@link pushWithCredential} 進行——認證只以
|
||||
* 環境變數(`http.<url>.extraheader` 的 base64 Basic)傳入,**不進 argv**,
|
||||
* 推送目標 URL 本身不含帳密;且 push 失敗時改拋固定訊息,避免 `execFileSync`
|
||||
* 例外把命令列(含 token)回顯到 CI log 或程序清單。
|
||||
*/
|
||||
function commitAndPushFindings(cwd, { headRef, headSha, message, files, token, serverUrl, repository }) {
|
||||
headRef = assertSafeBranchRef(headRef, 'headRef');
|
||||
const current = gitTrim(cwd, 'rev-parse', 'HEAD');
|
||||
if (headSha && current !== headSha) {
|
||||
git(cwd, 'checkout', '--detach', headSha);
|
||||
@@ -228,19 +298,68 @@ function commitAndPushFindings(cwd, { headRef, headSha, message, files, token, s
|
||||
'-c', 'user.email=ai-review-bot@noreply.gitea',
|
||||
'commit', '-m', message,
|
||||
);
|
||||
try {
|
||||
git(cwd, 'push', 'origin', `HEAD:refs/heads/${headRef}`);
|
||||
} catch {
|
||||
// 遠端未帶認證(checkout 未保留 credentials)時,改用帶 token 的 URL 重試。
|
||||
// 注意:不得把這個 URL 輸出到日誌,避免洩漏 token。
|
||||
const url = new URL(`${serverUrl}/${repository}.git`);
|
||||
url.username = 'ai-review-bot';
|
||||
url.password = token;
|
||||
git(cwd, 'push', url.toString(), `HEAD:refs/heads/${headRef}`);
|
||||
}
|
||||
const refspec = `HEAD:refs/heads/${headRef}`;
|
||||
const remoteUrl = `${serverUrl}/${repository}.git`;
|
||||
// 一律以 token 的身分明確認證推送,不沿用 origin 的自動 token。
|
||||
pushWithCredential(cwd, remoteUrl, token, refspec, serverUrl);
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* 以帶認證的方式推送到指定遠端,認證資訊只經環境變數傳入、不進命令列 argv。
|
||||
*
|
||||
* 認證方式:等同 `https://ai-review-bot:<secret>@host/...` 的 HTTP Basic(git 會把
|
||||
* URL 帳密轉成相同的 `Authorization: Basic` 標頭送出),但改以 git 的
|
||||
* `GIT_CONFIG_*` 環境變數注入 `http.<serverUrl>/.extraheader`,使 base64 憑證**不出現在 argv**
|
||||
* (避免程序清單/例外回顯洩漏);推送目標 URL 亦不含帳密。
|
||||
*
|
||||
* 觸發 CI 關鍵:`actions/checkout` 會把「自動 Actions token」持久化在同一個
|
||||
* `http.<serverUrl>/.extraheader` scope;若沿用它推送,Gitea 會視為「自動 token 觸發」而
|
||||
* **不再觸發 workflow**(防遞迴)。故本函式對這次 push 於該 scope**先以空值重置**(清掉自動
|
||||
* token——git 對 extraHeader 給空值即清空既有清單),**再注入 PAT 的 Authorization**,讓推送以
|
||||
* PAT 身分進行、觸發 PR 的 synchronize;作用範圍僅限本次 push 的環境變數,不影響 action 其他
|
||||
* 仰賴 checkout 持久化憑證的 fetch(如 {@link resolveMergeBase})。
|
||||
* 推送失敗時**不重拋原始例外**(其 message 會含命令列與遠端 URL),改拋固定訊息。
|
||||
*
|
||||
* @param {string} cwd - git 工作目錄(repo 的 checkout 路徑)。
|
||||
* @param {string} remoteUrl - 不含帳密的遠端 URL(形如 `https://host/owner/repo.git`)。
|
||||
* @param {string} token - 具 push 權限的 token/PAT(作為 Basic 認證的密碼)。
|
||||
* @param {string} refspec - push 的 refspec(形如 `HEAD:refs/heads/<branch>`)。
|
||||
* @param {string} serverUrl - Gitea 伺服器根網址(用於定位 checkout 持久化 extraheader 的 scope)。
|
||||
* @returns {void} 成功即返回;失敗拋出不含 URL/argv/token 的固定錯誤。
|
||||
* @throws {Error} 推送失敗時拋出固定訊息(已隱藏遠端 URL 與認證資訊)。
|
||||
* @remarks 本函式未匯出,僅供 {@link commitAndPushFindings} 使用。
|
||||
*/
|
||||
function pushWithCredential(cwd, remoteUrl, token, refspec, serverUrl) {
|
||||
const server = new URL(serverUrl);
|
||||
const remote = new URL(remoteUrl);
|
||||
if (remote.origin !== server.origin || !remote.pathname.endsWith('.git')) {
|
||||
throw new Error('推送遠端 URL 與 Gitea 伺服器不相符,已停止推送。');
|
||||
}
|
||||
const basic = Buffer.from(`ai-review-bot:${token}`).toString('base64');
|
||||
// checkout 持久化自動 token 的 scope 為 `http.<serverUrl>/.extraheader`(結尾帶斜線)。
|
||||
const headerScope = `http.${server.origin}/.extraheader`;
|
||||
try {
|
||||
execFileSync('git', ['push', remoteUrl, refspec], {
|
||||
cwd,
|
||||
encoding: 'utf8',
|
||||
maxBuffer: 64 * 1024 * 1024,
|
||||
env: {
|
||||
...process.env,
|
||||
GIT_TERMINAL_PROMPT: '0',
|
||||
// 先清空 checkout extraheader,再注入本次 PAT header。
|
||||
GIT_CONFIG_COUNT: '2',
|
||||
GIT_CONFIG_KEY_0: headerScope,
|
||||
GIT_CONFIG_VALUE_0: '',
|
||||
GIT_CONFIG_KEY_1: headerScope,
|
||||
GIT_CONFIG_VALUE_1: `Authorization: Basic ${basic}`,
|
||||
},
|
||||
});
|
||||
} catch {
|
||||
throw new Error('推送審查結果 commit 失敗(已隱藏遠端 URL 與認證資訊)。');
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
latestCommitSubject,
|
||||
resolveMergeBase,
|
||||
@@ -248,4 +367,7 @@ module.exports = {
|
||||
fileDiff,
|
||||
fileLastUpdatedIso,
|
||||
commitAndPushFindings,
|
||||
__test: {
|
||||
assertSafeBranchRef,
|
||||
},
|
||||
};
|
||||
|
||||
+100
-11
@@ -5,6 +5,7 @@ const path = require('path');
|
||||
|
||||
const { log, taipeiFromIso, taipeiNow } = require('./log');
|
||||
const { runAgent, extractJson } = require('./agents');
|
||||
const { agentFailureDetail } = require('./diagnostics');
|
||||
const templates = require('./templates');
|
||||
|
||||
// 審查流程核心:.reviewignore 過濾、diff 整理、攻擊方找問題、防守方裁決、排序分組與舊留言處理。
|
||||
@@ -140,7 +141,7 @@ ${sections}
|
||||
- 不得輸出個資(PII)。`;
|
||||
const res = await runAgent(tool, { model, prompt, cwd, timeoutMs: 300_000 });
|
||||
if (!res.ok) {
|
||||
log('步驟4', 'WRN', '檔案用途摘要產生失敗,以「—」代替。');
|
||||
log('步驟4', 'WRN', `檔案用途摘要產生失敗,以「—」代替:${agentFailureDetail(res)}。`);
|
||||
return;
|
||||
}
|
||||
const parsed = extractJson(res.output);
|
||||
@@ -279,7 +280,7 @@ async function runAttackers({ tool, model, cwd, attackers, diffRows }) {
|
||||
log('步驟6', 'INF', `攻擊方 ${role.meta.name} 開始分析。`);
|
||||
const res = await runAgent(tool, { model, prompt: buildAttackPrompt(role, diffRows), cwd });
|
||||
if (!res.ok) {
|
||||
log('步驟6', 'WRN', `攻擊方 ${role.meta.name} 執行失敗:${(res.error && res.error.message) || '未知錯誤'}。`);
|
||||
log('步驟6', 'WRN', `攻擊方 ${role.meta.name} 執行失敗:${agentFailureDetail(res)}。`);
|
||||
return [];
|
||||
}
|
||||
const parsed = extractJson(res.output);
|
||||
@@ -459,7 +460,7 @@ async function runDefenders({ tool, model, cwd, defenders, findings }) {
|
||||
});
|
||||
const verdicts = new Map();
|
||||
if (!res.ok) {
|
||||
log('步驟8', 'WRN', `防守方 ${role.meta.name} 執行失敗,該角色視為全部保留。`);
|
||||
log('步驟8', 'WRN', `防守方 ${role.meta.name} 執行失敗,該角色視為全部保留:${agentFailureDetail(res)}。`);
|
||||
return { role: role.meta.name, verdicts };
|
||||
}
|
||||
const parsed = extractJson(res.output);
|
||||
@@ -556,6 +557,28 @@ function appendExclusions({ cwd, excluded, prNumber }) {
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* 依審查模式與結果決定收尾要提交的結果檔。
|
||||
*
|
||||
* 一般模式永遠提交本回合 findings 檔;建問題模式通常把問題明細留在 issue,不提交
|
||||
* findings。例外是有嚴重問題時仍提交 findings 檔,讓 `[failure]` 結果 commit 一定能產生,
|
||||
* 避免問題相依 API 不支援或設定失敗時 PR 缺少失敗檢查。
|
||||
*
|
||||
* @param {Object} params - 解構參數。
|
||||
* @param {boolean} params.createIssue - 是否啟用建問題模式。
|
||||
* @param {number} params.severeCount - 嚴重 finding 數量。
|
||||
* @param {string} params.relativePath - 本回合保存的 findings 檔 repo 相對路徑。
|
||||
* @param {boolean} params.exclusionsChanged - exclusions.json 是否有實際異動。
|
||||
* @returns {string[]} 應交給 `commitFindings` 的 repo 相對路徑清單。
|
||||
*/
|
||||
function resultFilesToCommit({ createIssue, severeCount, relativePath, exclusionsChanged }) {
|
||||
const files = createIssue ? (severeCount > 0 ? [relativePath] : []) : [relativePath];
|
||||
if (exclusionsChanged) {
|
||||
files.push(path.join('.gitea', 'ai-review', 'exclusions.json'));
|
||||
}
|
||||
return files;
|
||||
}
|
||||
|
||||
/**
|
||||
* 就地排序 findings:依 嚴重→警告→建議、再依檔案路徑、再依起始行遞增。
|
||||
*
|
||||
@@ -597,8 +620,8 @@ function sortFindings(findings) {
|
||||
* @returns {Promise<number[]>} 挑中的標籤 id 陣列(可用標籤的子集合);無適合標籤或任何失敗時為空陣列。
|
||||
* @remarks
|
||||
* 使用情境:建問題模式(input: create-issue)下,`main()`(src/index.js)
|
||||
* 在建立追蹤 issue 後先呼叫 `gitea.listLabels` 取得可用標籤,再以本函式依保留問題
|
||||
* 挑出標籤 id 子集合,交給 `gitea.addLabelsToIssue` 補掛到 issue 上。
|
||||
* 於確定有保留問題後、建立追蹤 issue 前先呼叫 `gitea.listLabels` 取得可用標籤,
|
||||
* 再以本函式依保留問題挑出標籤 id 子集合,於 `gitea.createIssue` 建立 issue 時一次帶入。
|
||||
*/
|
||||
async function selectLabels({ tool, model, cwd, labels, prTitle, prBody, findings }) {
|
||||
if (labels.length === 0) return [];
|
||||
@@ -633,7 +656,7 @@ ${JSON.stringify(brief)}
|
||||
- 沒有適合的標籤時輸出 []。`;
|
||||
const res = await runAgent(tool, { model, prompt, cwd, timeoutMs: 300_000 });
|
||||
if (!res.ok) {
|
||||
log('建問題', 'WRN', '標籤挑選失敗,issue 不掛標籤。');
|
||||
log('建問題', 'WRN', `標籤挑選失敗,issue 不掛標籤:${agentFailureDetail(res)}。`);
|
||||
return [];
|
||||
}
|
||||
const parsed = extractJson(res.output);
|
||||
@@ -663,7 +686,8 @@ ${JSON.stringify(brief)}
|
||||
* @remarks
|
||||
* 使用情境:建問題模式(input: create-issue)下,`main()`(src/index.js)於防守方裁決後
|
||||
* 建立追蹤 issue、寫入情境留言,再以本函式把嚴重問題逐條留言到該 issue;
|
||||
* 警告+建議則以 {@link templates.othersComment} 彙整成單一表格另發到同一 issue。
|
||||
* 警告+建議則由 {@link postOthersToIssue} 同樣逐條留言到同一 issue(皆可個別回覆),
|
||||
* 不使用 {@link templates.othersComment} 的單一表格——表格僅用於一般模式(PR)。
|
||||
*/
|
||||
async function postSevereToIssue({ ctx, gitea, issueNumber, severe }) {
|
||||
for (const finding of severe) {
|
||||
@@ -672,6 +696,32 @@ async function postSevereToIssue({ ctx, gitea, issueNumber, severe }) {
|
||||
log('步驟9', 'INF', `已將 ${severe.length} 條嚴重問題留言到 issue #${issueNumber}。`);
|
||||
}
|
||||
|
||||
/**
|
||||
* 建問題模式:把警告+建議(非嚴重)findings 逐條以獨立留言發到追蹤 issue。
|
||||
*
|
||||
* 與一般模式(PR)把警告+建議彙整成單一表格({@link templates.othersComment})不同:
|
||||
* issue 內每條問題各發一則留言({@link templates.issueFindingComment},內文標明位置),
|
||||
* 讓開發者能針對「單一問題」直接回覆討論,而非只能回覆一整張表格。
|
||||
* findings 由呼叫端事先以 {@link sortFindings} 排序(嚴重度→檔案→行號),本函式不再排序。
|
||||
*
|
||||
* @param {Object} params - 解構參數。
|
||||
* @param {Object} params.ctx - 執行環境 context(`loadContext()` 回傳);供 Gitea API 認證。
|
||||
* @param {Object} params.gitea - Gitea API 模組(src/lib/gitea.js);以參數注入便於測試替換,使用 `createCommentOnIssue`。
|
||||
* @param {number} params.issueNumber - 目標追蹤 issue 的編號。
|
||||
* @param {Array<Object>} params.others - severity 非「嚴重」(警告+建議)的 finding 列表(已排序;呼叫端保證非空)。
|
||||
* @returns {Promise<void>} 無回傳值;結果反映在 issue 留言與日誌。
|
||||
* @throws {Error} 逐條留言(`createCommentOnIssue`)失敗時未攔截、向上拋出,由主流程頂層 catch 收斂。
|
||||
* @remarks
|
||||
* 使用情境:建問題模式(input: create-issue)下,`main()`(src/index.js)步驟 10
|
||||
* 以本函式把警告+建議逐條留言到追蹤 issue,確保 issue 上每條問題都是可個別回覆的留言。
|
||||
*/
|
||||
async function postOthersToIssue({ ctx, gitea, issueNumber, others }) {
|
||||
for (const finding of others) {
|
||||
await gitea.createCommentOnIssue(ctx, issueNumber, templates.issueFindingComment(finding));
|
||||
}
|
||||
log('步驟10', 'INF', `已將 ${others.length} 條警告+建議逐條留言到 issue #${issueNumber}。`);
|
||||
}
|
||||
|
||||
/**
|
||||
* 讀取 finding 對應的程式碼片段:新版檔案的 startLine..endLine,最多 40 行。
|
||||
*
|
||||
@@ -714,12 +764,14 @@ function readSnippet(cwd, finding) {
|
||||
* @param {Object} params - 解構參數。
|
||||
* @param {Object} params.ctx - 執行環境 context(`loadContext()` 產出,含 repo/PR 編號/token 等 API 呼叫所需資訊)。
|
||||
* @param {Object} params.gitea - Gitea API 模組(`src/lib/gitea.js`),需提供 `whoAmI`/`listIssueComments`/`editIssueComment`/`listReviews`/`listReviewComments`/`tryResolveReviewComment`;以參數注入便於測試替換。
|
||||
* @param {Set<number>} params.currentRunCommentIds - 本回合發出的一般留言 id 集合;這些留言不標註過時。
|
||||
* @param {Set<number>} params.currentRunCommentIds - 本回合已發出的一般留言 id 集合;這些留言不標註過時。
|
||||
* @returns {Promise<void>} 無回傳值;結果反映在 PR 留言狀態與日誌。
|
||||
* @remarks
|
||||
* 使用情境:審查流程「步驟 2」在步驟 1 快速回報與前置檢查之後、偵測工具(步驟 3)
|
||||
* 與所有本回合留言之前呼叫;此時本回合尚未發出任何留言(currentRunCommentIds 為空),
|
||||
* 之後發出的留言自然不受影響,確保 PR 上只有最新回合的審查結果醒目可見。
|
||||
* 使用情境:一般模式下,`src/index.js` 於「確定本回合審查已成功產生結果後、發布嚴重/
|
||||
* 其他問題留言之前」呼叫(見 `main()`),刻意延後到工具偵測、diff 整理與攻防裁決都成功之後,
|
||||
* 避免任一前置步驟失敗時舊結果已被清掉、PR 卻沒有新結果。此時本回合的工具/diff/角色留言
|
||||
* 已發出並登錄於 `currentRunCommentIds`,本函式據此排除、不會把這些「新產生的留言」誤標為過時;
|
||||
* 之後才發布的嚴重/其他問題留言更不受影響,確保 PR 上只有最新回合的審查結果醒目可見。
|
||||
*/
|
||||
async function resolveOldComments({ ctx, gitea, currentRunCommentIds }) {
|
||||
let botLogin = '';
|
||||
@@ -780,6 +832,40 @@ async function resolveOldComments({ ctx, gitea, currentRunCommentIds }) {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 建問題模式:只將 PR 上舊的「追蹤問題連結」留言標註為過時,不觸碰 issue 內審查內容。
|
||||
*
|
||||
* @param {Object} params - 解構參數。
|
||||
* @param {Object} params.ctx - 執行環境 context(`loadContext()` 產出)。
|
||||
* @param {Object} params.gitea - Gitea API 模組,需提供 `whoAmI`、`listIssueComments`、`editIssueComment`。
|
||||
* @returns {Promise<void>} 無回傳值;失敗時只記 WRN,不阻斷主流程。
|
||||
*/
|
||||
async function resolveOldIssueLinkComments({ ctx, gitea }) {
|
||||
let botLogin = '';
|
||||
try {
|
||||
botLogin = (await gitea.whoAmI(ctx)).login || '';
|
||||
} catch (err) {
|
||||
log('建問題', 'WRN', `無法取得 bot 身分(${err.message}),略過舊追蹤連結標註。`);
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
const comments = await gitea.listIssueComments(ctx);
|
||||
let outdatedCount = 0;
|
||||
for (const comment of comments) {
|
||||
const isBot = comment.user && comment.user.login === botLogin;
|
||||
const body = typeof comment.body === 'string' ? comment.body : '';
|
||||
const isIssueLink = body.includes(templates.MARK) && body.includes('## 🔍 AI Code Review|已建立追蹤問題');
|
||||
if (!isBot || !isIssueLink || body.startsWith(templates.OUTDATED_PREFIX)) continue;
|
||||
await gitea.editIssueComment(ctx, comment.id, `${templates.OUTDATED_PREFIX}${body}`);
|
||||
outdatedCount += 1;
|
||||
}
|
||||
log('建問題', 'INF', `舊追蹤 issue 連結已標註〔已過時〕:${outdatedCount} 則。`);
|
||||
} catch (err) {
|
||||
log('建問題', 'WRN', `標註舊追蹤 issue 連結失敗:${err.message}。`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 步驟 9:嚴重問題逐條掛在 PR 程式碼行上留言(建立 code review);
|
||||
* 建立 review 失敗時降級為一般留言逐條發布(留言內補上檔案與行號位置)。
|
||||
@@ -827,8 +913,11 @@ module.exports = {
|
||||
runDefenders,
|
||||
sortFindings,
|
||||
appendExclusions,
|
||||
resultFilesToCommit,
|
||||
selectLabels,
|
||||
postSevereToIssue,
|
||||
postOthersToIssue,
|
||||
resolveOldComments,
|
||||
resolveOldIssueLinkComments,
|
||||
postSevereComments,
|
||||
};
|
||||
|
||||
+8
-27
@@ -55,7 +55,7 @@ function cell(text) {
|
||||
* @param {string} focus - 審查面向代碼(例如 `'logic'`、`'security'`);可為 undefined。
|
||||
* @returns {string} 顯示字串:命中時如 `'邏輯(logic)'`;未命中時原樣回傳 `focus`;falsy 時回傳 `'—'`。
|
||||
* @remarks
|
||||
* 使用情境:審查流程步驟 5/6 的角色登場留言——`rolesComment()`
|
||||
* 使用情境:審查流程步驟 5/7 的角色登場留言——`rolesComment()`
|
||||
* 產生「角色|面向|個性」表格時,以本函式把每位審查員
|
||||
* (攻擊方/防守方)的 focus 代碼轉成中英並列的面向欄位內容。
|
||||
* 本函式未匯出,僅供模組內部使用。
|
||||
@@ -150,7 +150,7 @@ function diffComment(rows, ignoredCount) {
|
||||
}
|
||||
|
||||
/**
|
||||
* 產生審查流程步驟 5/6 共用的「角色登場」PR 留言內容。
|
||||
* 產生審查流程步驟 5/7 共用的「角色登場」PR 留言內容。
|
||||
*
|
||||
* 以三欄表格(角色/面向/個性)列出本回合登場的審查員;
|
||||
* 攻擊方(步驟 5)與防守方(步驟 7)共用本模板,僅標題不同。
|
||||
@@ -302,7 +302,7 @@ function othersComment(findings) {
|
||||
* @param {string} [params.prBody] - PR 描述原文;nullish 或 trim 後為空時輸出佔位文字。
|
||||
* @returns {string} 完整 issue 本文 Markdown 字串(含 MARK 隱藏標記)。
|
||||
* @remarks
|
||||
* 使用情境:建問題模式下 `main()`(src/index.js)的 `ensureIssueCreated` 建立 issue 時,
|
||||
* 使用情境:建問題模式下 `main()`(src/index.js)的 `createIssueAndFlushBufferedComments` 建立 issue 時,
|
||||
* 以「標題=PR 標題、本文=本函式輸出」呼叫 `gitea.createIssue`,
|
||||
* 讓 issue 讀者能從本文回溯到觸發審查的 PR,再從下方留言逐條查看問題明細。
|
||||
*/
|
||||
@@ -334,9 +334,9 @@ ${body || '(PR 無描述)'}
|
||||
* @param {string} [finding.suggestedCode] - 建議寫法程式碼;有值才輸出「建議寫法」區塊。
|
||||
* @returns {string} 完整留言 Markdown 字串(含 MARK 隱藏標記)。
|
||||
* @remarks
|
||||
* 使用情境:建問題模式下 `review.postSevereToIssue`(src/lib/review.js)把每條嚴重 finding
|
||||
* 以本函式產生留言內容、經 `gitea.createCommentOnIssue` 發布到追蹤 issue 上,
|
||||
* 作為問題明細的追蹤紀錄。
|
||||
* 使用情境:建問題模式下 `review.postSevereToIssue` 與 `review.postOthersToIssue`
|
||||
* 把每條 finding 以本函式產生留言內容、經 `gitea.createCommentOnIssue`
|
||||
* 發布到追蹤 issue 上,作為問題明細的追蹤紀錄。
|
||||
*/
|
||||
function issueFindingComment(finding) {
|
||||
const emoji = SEVERITY_EMOJI[finding.severity] || '🔵';
|
||||
@@ -400,31 +400,13 @@ function nothingToReviewComment(ignoredCount) {
|
||||
* 以本函式對 PR 留一則連結留言,達成「問題關聯回 PR」;issue 內文另以
|
||||
* {@link issueBody} 反向引用 `PR #N`,形成雙向交叉連結。
|
||||
*/
|
||||
function issueLinkComment({ issueNumber, issueUrl, severeCount, otherCount }) {
|
||||
function prIssueLinkComment({ issueNumber, issueUrl, severeCount, otherCount }) {
|
||||
return `${MARK}
|
||||
## 🔍 AI Code Review|已建立追蹤問題
|
||||
|
||||
本次審查結果已彙整到 issue [#${issueNumber}](${issueUrl})(🔴 嚴重 ${severeCount} 條、🟠🔵 警告+建議 ${otherCount} 條),請至該問題追蹤與討論。`;
|
||||
}
|
||||
|
||||
/**
|
||||
* 產生「已審查但無需保留問題」時,回貼到「PR」的審查通過留言。
|
||||
*
|
||||
* 建問題模式下,若防守方裁決後沒有任何保留問題(不值得為此開 issue),
|
||||
* 以本留言在 PR 上告知審查通過,取代原本會發到 issue 的問題內容。
|
||||
*
|
||||
* @returns {string} 完整留言 Markdown 字串(含 MARK 隱藏標記)。
|
||||
* @remarks
|
||||
* 使用情境:建問題模式下 `main()`(src/index.js)於防守方裁決後
|
||||
* `kept.length === 0` 時呼叫;此情況不建立 issue,僅在 PR 留下本則通過提示。
|
||||
*/
|
||||
function noFindingsComment() {
|
||||
return `${MARK}
|
||||
## ✅ AI Code Review|審查通過
|
||||
|
||||
本次 AI Code Review 未發現需保留的問題,視為審查通過。`;
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
MARK,
|
||||
OUTDATED_PREFIX,
|
||||
@@ -439,6 +421,5 @@ module.exports = {
|
||||
issueBody,
|
||||
issueFindingComment,
|
||||
nothingToReviewComment,
|
||||
issueLinkComment,
|
||||
noFindingsComment,
|
||||
prIssueLinkComment,
|
||||
};
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
'use strict';
|
||||
|
||||
const assert = require('node:assert/strict');
|
||||
const test = require('node:test');
|
||||
|
||||
const gitea = require('../src/lib/gitea');
|
||||
|
||||
function withFetchStub(handler, callback) {
|
||||
const originalFetch = global.fetch;
|
||||
const calls = [];
|
||||
global.fetch = async (url, options = {}) => {
|
||||
calls.push({ url, options });
|
||||
return handler(url, options);
|
||||
};
|
||||
return Promise.resolve()
|
||||
.then(() => callback(calls))
|
||||
.finally(() => {
|
||||
global.fetch = originalFetch;
|
||||
});
|
||||
}
|
||||
|
||||
function jsonResponse(data, ok = true, status = 200) {
|
||||
return {
|
||||
ok,
|
||||
status,
|
||||
async text() {
|
||||
return JSON.stringify(data);
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
test('addIssueDependency 使用正確 endpoint、method 與 IssueMeta body', async () => {
|
||||
const ctx = {
|
||||
apiBase: 'https://gitea.example.test/api/v1',
|
||||
token: 'hidden',
|
||||
owner: 'owner',
|
||||
repo: 'repo',
|
||||
};
|
||||
|
||||
await withFetchStub(() => jsonResponse({ ok: true }), async (calls) => {
|
||||
await gitea.addIssueDependency(ctx, 12, 34);
|
||||
|
||||
assert.equal(calls.length, 1);
|
||||
assert.equal(calls[0].url, 'https://gitea.example.test/api/v1/repos/owner/repo/issues/12/dependencies');
|
||||
assert.equal(calls[0].options.method, 'POST');
|
||||
assert.equal(calls[0].options.headers.Authorization, 'token hidden');
|
||||
assert.deepEqual(JSON.parse(calls[0].options.body), {
|
||||
index: 34,
|
||||
owner: 'owner',
|
||||
repo: 'repo',
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
test('createIssue 空 labels 不送出 labels 欄位', async () => {
|
||||
const ctx = {
|
||||
apiBase: 'https://gitea.example.test/api/v1',
|
||||
token: 'hidden',
|
||||
owner: 'owner',
|
||||
repo: 'repo',
|
||||
};
|
||||
|
||||
await withFetchStub(() => jsonResponse({ number: 5 }), async (calls) => {
|
||||
await gitea.createIssue(ctx, { title: 'title', body: 'body', labels: [] });
|
||||
|
||||
assert.equal(calls[0].url, 'https://gitea.example.test/api/v1/repos/owner/repo/issues');
|
||||
assert.equal(calls[0].options.method, 'POST');
|
||||
assert.deepEqual(JSON.parse(calls[0].options.body), {
|
||||
title: 'title',
|
||||
body: 'body',
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,24 @@
|
||||
'use strict';
|
||||
|
||||
const assert = require('node:assert/strict');
|
||||
const test = require('node:test');
|
||||
|
||||
const gitrepo = require('../src/lib/gitrepo');
|
||||
|
||||
test('assertSafeBranchRef 接受一般分支名稱', () => {
|
||||
assert.equal(gitrepo.__test.assertSafeBranchRef('feature/review-123', 'baseRef'), 'feature/review-123');
|
||||
});
|
||||
|
||||
test('assertSafeBranchRef 拒絕路徑穿越分支名稱', () => {
|
||||
assert.throws(
|
||||
() => gitrepo.__test.assertSafeBranchRef('../../hooks/pre-push', 'baseRef'),
|
||||
/不是安全的分支名稱/,
|
||||
);
|
||||
});
|
||||
|
||||
test('resolveMergeBase 會在 git fetch 前拒絕不安全 baseRef', () => {
|
||||
assert.throws(
|
||||
() => gitrepo.resolveMergeBase(process.cwd(), '../../hooks/pre-push'),
|
||||
/不是安全的分支名稱/,
|
||||
);
|
||||
});
|
||||
@@ -0,0 +1,136 @@
|
||||
'use strict';
|
||||
|
||||
const assert = require('node:assert/strict');
|
||||
const test = require('node:test');
|
||||
|
||||
const review = require('../src/lib/review');
|
||||
const diagnostics = require('../src/lib/diagnostics');
|
||||
|
||||
test('agentFailureDetail 預設不輸出 stderr/stdout 片段', () => {
|
||||
const oldDebug = process.env.ACTIONS_STEP_DEBUG;
|
||||
delete process.env.ACTIONS_STEP_DEBUG;
|
||||
try {
|
||||
const detail = diagnostics.agentFailureDetail({
|
||||
ok: false,
|
||||
error: Object.assign(new Error('boom'), { code: 1 }),
|
||||
stderr: 'token=super-secret-value',
|
||||
output: 'stdout with password=hidden',
|
||||
});
|
||||
assert.match(detail, /exit 1/);
|
||||
assert.doesNotMatch(detail, /super-secret-value|password|stdout|stderr/);
|
||||
} finally {
|
||||
if (oldDebug === undefined) delete process.env.ACTIONS_STEP_DEBUG;
|
||||
else process.env.ACTIONS_STEP_DEBUG = oldDebug;
|
||||
}
|
||||
});
|
||||
|
||||
test('agentFailureDetail 在 debug 模式輸出遮罩後片段', () => {
|
||||
const oldDebug = process.env.ACTIONS_STEP_DEBUG;
|
||||
process.env.ACTIONS_STEP_DEBUG = 'true';
|
||||
try {
|
||||
const detail = diagnostics.agentFailureDetail({
|
||||
ok: false,
|
||||
error: Object.assign(new Error('boom'), { code: 2 }),
|
||||
stderr: 'Authorization: Bearer abcdefghijklmnopqrstuvwxyz1234567890',
|
||||
output: 'token=abcdefghijklmnopqrstuvwxyz1234567890TOKEN',
|
||||
});
|
||||
assert.match(detail, /exit 2/);
|
||||
assert.match(detail, /stderr:Authorization: \*\*\*/);
|
||||
assert.match(detail, /stdout:token=\*\*\*/);
|
||||
assert.doesNotMatch(detail, /abcdefghijklmnopqrstuvwxyz/);
|
||||
} finally {
|
||||
if (oldDebug === undefined) delete process.env.ACTIONS_STEP_DEBUG;
|
||||
else process.env.ACTIONS_STEP_DEBUG = oldDebug;
|
||||
}
|
||||
});
|
||||
|
||||
test('postOthersToIssue 依序送出 issue 留言以維持排序', async () => {
|
||||
const calls = [];
|
||||
let active = 0;
|
||||
let maxActive = 0;
|
||||
const fakeGitea = {
|
||||
async createCommentOnIssue(ctx, issueNumber, body) {
|
||||
active += 1;
|
||||
maxActive = Math.max(maxActive, active);
|
||||
calls.push({ ctx, issueNumber, body });
|
||||
await new Promise((resolve) => setTimeout(resolve, 20));
|
||||
active -= 1;
|
||||
return { id: calls.length };
|
||||
},
|
||||
};
|
||||
|
||||
await review.postOthersToIssue({
|
||||
ctx: { token: 'hidden' },
|
||||
gitea: fakeGitea,
|
||||
issueNumber: 7,
|
||||
others: [
|
||||
{ severity: '警告', reviewer: 'Maya', file: 'a.js', startLine: 1, endLine: 1, problem: 'p1', suggestion: 's1' },
|
||||
{ severity: '建議', reviewer: 'Bard', file: 'b.js', startLine: 2, endLine: 2, problem: 'p2', suggestion: 's2' },
|
||||
],
|
||||
});
|
||||
|
||||
assert.equal(calls.length, 2);
|
||||
assert.equal(calls[0].issueNumber, 7);
|
||||
assert.equal(maxActive, 1);
|
||||
});
|
||||
|
||||
test('resultFilesToCommit 在建問題模式有嚴重問題時仍提交 findings', () => {
|
||||
assert.deepEqual(
|
||||
review.resultFilesToCommit({
|
||||
createIssue: true,
|
||||
severeCount: 1,
|
||||
relativePath: '.gitea/ai-review/findings/run.json',
|
||||
exclusionsChanged: false,
|
||||
}),
|
||||
['.gitea/ai-review/findings/run.json'],
|
||||
);
|
||||
});
|
||||
|
||||
test('resultFilesToCommit 在建問題模式無嚴重問題時只提交 exclusions 異動', () => {
|
||||
assert.deepEqual(
|
||||
review.resultFilesToCommit({
|
||||
createIssue: true,
|
||||
severeCount: 0,
|
||||
relativePath: '.gitea/ai-review/findings/run.json',
|
||||
exclusionsChanged: true,
|
||||
}),
|
||||
['.gitea/ai-review/exclusions.json'],
|
||||
);
|
||||
});
|
||||
|
||||
test('resolveOldIssueLinkComments 只標註舊追蹤 issue 連結', async () => {
|
||||
const edited = [];
|
||||
const fakeGitea = {
|
||||
async whoAmI() {
|
||||
return { login: 'bot' };
|
||||
},
|
||||
async listIssueComments() {
|
||||
return [
|
||||
{
|
||||
id: 1,
|
||||
user: { login: 'bot' },
|
||||
body: '<!-- ai-code-review -->\n## 🔍 AI Code Review|已建立追蹤問題\nold',
|
||||
},
|
||||
{
|
||||
id: 2,
|
||||
user: { login: 'bot' },
|
||||
body: '<!-- ai-code-review -->\n## 📋 變更摘要(送審 git diff)\nkeep',
|
||||
},
|
||||
{
|
||||
id: 3,
|
||||
user: { login: 'someone' },
|
||||
body: '<!-- ai-code-review -->\n## 🔍 AI Code Review|已建立追蹤問題\nkeep',
|
||||
},
|
||||
];
|
||||
},
|
||||
async editIssueComment(ctx, commentId, body) {
|
||||
edited.push({ ctx, commentId, body });
|
||||
},
|
||||
};
|
||||
|
||||
await review.resolveOldIssueLinkComments({ ctx: { token: 'hidden' }, gitea: fakeGitea });
|
||||
|
||||
assert.equal(edited.length, 1);
|
||||
assert.equal(edited[0].commentId, 1);
|
||||
assert.match(edited[0].body, /^> 〔已過時〕/);
|
||||
});
|
||||
Reference in New Issue
Block a user