refactor(test): performance and code readbility improvements

[fabienzucchet]

Various code improvements:

• make file splitting into chunks linear instead of quadratic
• cleaner code for generating test reports

[github-actions]

LOGAF Level 2 - /home/runner/work/code-review-gpt/code-review-gpt/src/review/prompt/constructPrompt.ts

1. Error Handling: The readFiles function currently logs an error message and continues execution when a file fails to be processed. This could lead to unexpected behavior later in the code if the error is not properly handled. Consider throwing the error to halt execution, or handle the error in a way that the rest of the code can safely continue.

try {
  const fileContent = await readFile(fileName, "utf8");
  files.push({ fileName, fileContent });
} catch (error) {
  throw new Error(`Failed to process file ${fileName}: ${error}`);
}

2. Performance: The splitFilesIntoBatches function could be optimized. Currently, it iterates over the files array and checks the size of each file individually. Consider calculating the size of all files beforehand and storing them in a separate array or map. This would reduce the number of times the getSizeOfReviewFile function is called.

---

LOGAF Level 3 - /home/runner/work/code-review-gpt/code-review-gpt/src/test/run/generateTestReport.ts

1. Code Duplication: The generateTestReport and displayDetailedReport functions both contain similar code for generating a report. Consider creating a helper function to generate a report to reduce code duplication.

const generateReport = (testCase: TestCase, review: string, similarReview: string) => `
 > Test case snippet: ${testCase.snippet}

===============================================================================

 > Review:
${review}
===============================================================================

> Similar review:
${similarReview}

`;

2. Magic Numbers: The determineTestResult function uses magic numbers (1, 2). Consider defining these numbers as constants at the top of your file to improve readability and maintainability.

const MAX_SIMILARITY_SCORE = 1;
const WARNING_THRESHOLD_MULTIPLIER = 2;

3. Error Handling: The formatTestResult function throws an error for an unknown test result. Consider defining a default case in the switch statement to handle unknown test results gracefully.

---

🚫🔄🔢

---

Powered by Code Review GPT

[github-actions]

Test results summary:

✅ [PASS] - Test case: Bad variable name
✅ [PASS] - Test case: Exposed secret
✅ [PASS] - Test case: Too many nested loops
✅ [PASS] - Test case: Unawaited Promise

SUMMARY: ✅ PASS: 4 - ⚠️ WARN: 0 - ❌ FAIL: 0

---

Tests Powered by Code Review GPT