Compare commits

...

4 Commits

3 changed files with 135 additions and 89 deletions
+4
View File
@@ -3,5 +3,9 @@
"role": "Rex", "role": "Rex",
"location": "app/git.js", "location": "app/git.js",
"suggestion": "請避免將敏感資料(如 GITEA_TOKEN)直接寫入環境變數" "suggestion": "請避免將敏感資料(如 GITEA_TOKEN)直接寫入環境變數"
},
{
"location": "app/git.js",
"suggestion": "GITEA_TOKEN 直接嵌入 URL 中"
} }
] ]
+74 -88
View File
@@ -1,114 +1,100 @@
[ [
{ {
"level": "warning", "level": "critical",
"role": "Rex", "role": "Leo",
"location": "app/git.js:14", "location": "app/git.js:14",
"suggestion": "在 cloneRepo 函數中,請確保 GIT_TOKEN 不會被寫入到檔案系統中,避免敏感資訊洩漏。", "suggestion": "GITEA_TOKEN 直接嵌入 URL 中,可能導致憑證洩漏。建議使用環境變數或安全的憑證管理方式來處理敏感資訊。",
"is_new": false "is_new": true
},
{
"level": "critical",
"role": "Zara",
"location": "app/git.js:14",
"suggestion": "GITEA_TOKEN 直接嵌入 URL 中,可能導致憑證洩漏。建議使用環境變數或安全的憑證管理方式來處理敏感資訊。",
"is_new": true
},
{
"level": "critical",
"role": "Maya",
"location": "app/git.js:1",
"suggestion": "缺少對 cloneRepo 函數的單元測試,應該為其添加測試以確保其正確性。",
"is_new": true
},
{
"level": "critical",
"role": "Maya",
"location": "app/git.js:1",
"suggestion": "缺少對 commitAndPush 函數的單元測試,應該為其添加測試以確保其正確性。",
"is_new": true
}, },
{ {
"level": "warning", "level": "warning",
"role": "Leo", "role": "Leo",
"location": "app/git.js:25",
"suggestion": "在使用 fs.existsSync 檢查目錄是否存在時,應考慮使用非同步方法以避免阻塞事件循環。",
"is_new": true
},
{
"level": "warning",
"role": "Leo",
"location": "app/git.js:29",
"suggestion": "在 git clone 時使用 --depth=1 可能會導致未來需要完整歷史紀錄時的性能問題,建議根據實際需求調整。",
"is_new": true
},
{
"level": "warning",
"role": "Maya",
"location": "app/findings.js:1",
"suggestion": "loadExclusions 函數中對於 JSON 格式的驗證不足,建議增加對於資料結構的檢查,以避免潛在的錯誤。",
"is_new": true
},
{
"level": "warning",
"role": "Maya",
"location": "app/findings.js:1",
"suggestion": "applyExclusions 函數中對於 findings 和 exclusions 參數的有效性檢查不足,建議增加檢查以提高程式的健壯性。",
"is_new": true
},
{
"level": "info",
"role": "Aria",
"location": "README.md",
"suggestion": "建議在 README 中增加對於新功能(如排除問題過濾)的詳細說明,以便未來的維護者能快速了解其功能.",
"is_new": true
},
{
"level": "info",
"role": "Rex",
"location": "app/findings.js:93", "location": "app/findings.js:93",
"suggestion": "建議在 loadExclusions 函式中增加對於 JSON 格式的驗證,確保讀取的資料符合預期格式,避免潛在的錯誤。", "suggestion": "建議在 loadExclusions 函式中增加對於 JSON 格式的驗證,確保讀取的資料符合預期格式,避免潛在的錯誤。",
"is_new": false "is_new": true
}, },
{ {
"level": "warning", "level": "info",
"role": "Leo", "role": "Rex",
"location": "app/findings.js:40", "location": "app/findings.js:40",
"suggestion": "在 applyExclusions 函式中,建議增加對於 findings 和 exclusions 參數的有效性檢查,以提高程式的健壯性。", "suggestion": "在 applyExclusions 函式中,建議增加對於 findings 和 exclusions 參數的有效性檢查,以提高程式的健壯性。",
"is_new": false "is_new": true
}, },
{ {
"level": "warning", "level": "info",
"role": "Zara", "role": "Zara",
"location": "app/findings.js:40", "location": "app/findings.js:93",
"suggestion": "在 applyExclusions 函數中,使用 Array.prototype.some 進行過濾時,可能會導致性能問題,特別是當 findings 和 exclusions 的數量都很大時。建議使用更高效的資料結構(如 HashSet)來加速查詢。", "suggestion": "建議在 loadExclusions 函式中增加對於 JSON 格式的驗證,確保讀取的資料符合預期格式,避免潛在的錯誤。",
"is_new": false "is_new": true
},
{
"level": "warning",
"role": "Maya",
"location": "app/findings.js:40",
"suggestion": "建議在 applyExclusions 函數中增加對 findings 內容的驗證,確保其格式正確,以提高測試的穩定性和可靠性。",
"is_new": false
},
{
"level": "info",
"role": "Leo",
"location": "README.md",
"suggestion": "建議在 README 中增加對於新功能(如排除問題過濾)的詳細說明,以便未來的維護者能快速了解其功能。",
"is_new": false
},
{
"level": "info",
"role": "Leo",
"location": "app/main.js",
"suggestion": "建議在 main 函式中增加對於每個步驟的詳細註解,讓未來的維護者能更容易理解程式邏輯。",
"is_new": false
}, },
{ {
"level": "info", "level": "info",
"role": "Zara", "role": "Zara",
"location": "app/findings.js:39", "location": "app/findings.js:40",
"suggestion": "在過濾 findings 時,建議將過濾條件的邏輯提取為獨立函數,以提高可讀性和可維護性。", "suggestion": "在 applyExclusions 函式中,建議增加對於 findings 和 exclusions 參數的有效性檢查,以提高程式的健壯性。",
"is_new": false "is_new": true
},
{
"level": "info",
"role": "Zara",
"location": "app/main.js:64",
"suggestion": "在讀取排除問題檔案時,建議考慮使用非同步方法(如 fs.promises.readFile)來避免阻塞事件循環,提升效能。",
"is_new": false
},
{
"level": "info",
"role": "Aria",
"location": "README.md:8",
"suggestion": "建議將「如果PR問題表格中有嚴重問題,則不要讓 workflow 執行成功(exit 1)」的描述改為「如果 PR 問題表格中有嚴重問題,則不要讓 workflow 執行成功(exit 1)」以提高可讀性。",
"is_new": false
},
{
"level": "info",
"role": "Aria",
"location": "TODO.md:4",
"suggestion": "建議將「階段四:findings 寫入與 comment 發布」的標題改為「階段四:排除問題過濾」,以更清楚地反映內容。",
"is_new": false
},
{
"level": "info",
"role": "Aria",
"location": "app/config.js",
"suggestion": "建議在 EXCLUSIONS_PATH 的定義上方添加註解,說明該常數的用途,以提高可讀性。",
"is_new": false
},
{
"level": "info",
"role": "Aria",
"location": "app/findings.js",
"suggestion": "建議在 loadExclusions 函數的開頭添加註解,說明該函數的用途,以提高可讀性。",
"is_new": false
},
{
"level": "info",
"role": "Aria",
"location": "app/findings.js",
"suggestion": "建議在 applyExclusions 函數的開頭添加註解,說明該函數的用途,以提高可讀性。",
"is_new": false
}, },
{ {
"level": "info", "level": "info",
"role": "Maya", "role": "Maya",
"location": "app/findings.js:7", "location": "app/main.js:1",
"suggestion": "建議為 loadExclusions 和 applyExclusions 函數撰寫單元測試,以確保功能正確並能處理邊界條件。", "suggestion": "建議為主要流程中的每個步驟添加詳細的單元測試,以確保整體功能正確性和穩定性。",
"is_new": false "is_new": true
},
{
"level": "info",
"role": "Maya",
"location": "app/main.js:48",
"suggestion": "建議在每個主要步驟之後增加測試用例,以驗證每個步驟的輸出是否符合預期。",
"is_new": false
} }
] ]
+57 -1
View File
@@ -3,7 +3,7 @@ import assert from 'node:assert/strict';
import fs from 'fs'; import fs from 'fs';
import os from 'os'; import os from 'os';
import path from 'path'; import path from 'path';
import { commitAndPush } from './git.js'; import { commitAndPush, cloneRepo } from './git.js';
// --- helpers --- // --- helpers ---
function makeTmpWorkspace() { function makeTmpWorkspace() {
@@ -91,3 +91,59 @@ describe('commitAndPush', () => {
await assert.doesNotReject(() => commitAndPush(workspace, failSpawn)); await assert.doesNotReject(() => commitAndPush(workspace, failSpawn));
}); });
}); });
describe('cloneRepo', () => {
let workspace;
before(() => { workspace = fs.mkdtempSync(path.join(os.tmpdir(), 'clone-test-')); });
after(() => { fs.rmSync(workspace, { recursive: true, force: true }); });
it('clones repo when repoDir does not exist', () => {
const spawn = makeSpawn();
cloneRepo(workspace, spawn);
const cloneCalled = spawn.calls.some(c => c.args[0] === 'clone');
assert.ok(cloneCalled, 'expected git clone to be called');
});
it('fetches and checks out when repoDir already exists', () => {
const repoDir = path.join(workspace, 'repo');
fs.mkdirSync(repoDir, { recursive: true });
const spawn = makeSpawn();
cloneRepo(workspace, spawn);
const cloneCalled = spawn.calls.some(c => c.args[0] === 'clone');
const fetchCalled = spawn.calls.some(c => c.args[0] === 'fetch');
assert.ok(!cloneCalled, 'clone should not run when repoDir exists');
assert.ok(fetchCalled, 'fetch should run when repoDir exists');
});
it('does not embed token in any git command argument', () => {
const spawn = makeSpawn();
cloneRepo(workspace, spawn);
for (const { args } of spawn.calls) {
assert.ok(!args.join(' ').includes('test-token'), `Token leaked in git args: ${args.join(' ')}`);
}
});
it('uses GIT_ASKPASS for network operations', () => {
const spawn = makeSpawn();
cloneRepo(workspace, spawn);
const networkCalls = spawn.calls.filter(c => ['clone', 'fetch'].includes(c.args[0]));
assert.ok(networkCalls.length > 0, 'expected at least one network git call');
for (const { args, opts } of networkCalls) {
assert.ok(opts?.env?.GIT_ASKPASS, `GIT_ASKPASS missing for git ${args[0]}`);
}
});
it('cleans up askpass script after run', () => {
const spawn = makeSpawn();
cloneRepo(workspace, spawn);
const leftover = fs.readdirSync(workspace).filter(f => f.endsWith('.git-askpass.sh'));
assert.equal(leftover.length, 0, 'askpass script was not cleaned up');
});
it('returns repoDir path', () => {
const spawn = makeSpawn();
const result = cloneRepo(workspace, spawn);
assert.equal(result, path.join(workspace, 'repo'));
});
});