actions/ai-codereviewer
2
0
Fork 0
mirror of https://github.com/freeedcom/ai-codereviewer.git synced 2025-04-21 10:06:47 +00:00
Code Issues Projects Releases Packages Wiki Activity

CICO-113127: Initial commit

Browse source
This commit is contained in:
Arun Murugan 2024-09-24 22:02:40 +05:30
parent 79fc10f459
commit 9afc21f502
3 changed files with 176 additions and 372 deletions
Download patch file Download diff file Expand all files Collapse all files

288
src/main.ts
View file

@ -8,13 +8,10 @@ import minimatch from "minimatch";
const GITHUB_TOKEN: string = core.getInput("GITHUB_TOKEN");
const OPENAI_API_KEY: string = core.getInput("OPENAI_API_KEY");
const OPENAI_API_MODEL: string = core.getInput("OPENAI_API_MODEL");
const FRAMEWORK: string = core.getInput("framework"); // New input for framework
const FRAMEWORK: string = core.getInput("framework");
const octokit = new Octokit({ auth: GITHUB_TOKEN });
const openai = new OpenAI({
apiKey: OPENAI_API_KEY,
});
const openai = new OpenAI({ apiKey: OPENAI_API_KEY });
interface PRDetails {
owner: string;
@ -53,8 +50,9 @@ async function getDiff(
pull_number,
mediaType: { format: "diff" },
});
// @ts-expect-error - response.data is a string
return response.data;
// Fix: return the response as a string
return response.data as unknown as string; // Explicitly cast it to string
}
async function analyzeCode(
@ -62,16 +60,23 @@ async function analyzeCode(
prDetails: PRDetails
): Promise<Array<{ body: string; path: string; line: number }>> {
const comments: Array<{ body: string; path: string; line: number }> = [];
const existingComments = new Set<string>();
for (const file of parsedDiff) {
if (file.to === "/dev/null") continue; // Ignore deleted files
if (file.to === "/dev/null") continue;
for (const chunk of file.chunks) {
const prompt = createPrompt(file, chunk, prDetails);
const aiResponse = await getAIResponse(prompt);
if (aiResponse) {
const newComments = createComment(file, chunk, aiResponse);
if (newComments) {
comments.push(...newComments);
for (const change of chunk.changes) {
if (!change.content.startsWith("+")) continue;
const prompt = createPrompt(file, chunk, prDetails);
const aiResponse = await getAIResponse(prompt);
if (aiResponse) {
const newComments = createComment(file, chunk, aiResponse, existingComments);
if (newComments) {
comments.push(...newComments);
}
}
}
}
@ -81,93 +86,18 @@ async function analyzeCode(
function getRailsGuidelines(): string {
return `
- **Environment Specific Code**: Avoid hard-coding values. Use configuration files or environment variables.
- **Legacy Code**: Remove hard-coded values, clean up unused code, and ensure cross-environment compatibility.
- **Code Quality**: Adhere to Ruby and Rails Style Guides. Use Rubocop.
- **OOP Principles**: Follow SOLID principles.
- **Methods**: Keep methods concise. Use guard clauses and refactoring to reduce complexity.
- **Variables**: Use clear and descriptive names within appropriate scope.
- **File Structure**:
- \`app/\`: Domain-specific code.
- \`lib/\`: Generic Ruby code.
- **Keyword Arguments**: Prefer keyword arguments for readability.
- **Service Layer**: Encapsulate business logic within services.
- **Database Performance**: Avoid N+1 queries. Use \`includes\` or \`preload\`. Index frequently queried columns and use bulk operations.
- **Safe Migrations**: Avoid models in migrations. Use plain SQL and commit \`structure.sql\`. Use \`LHM\` for complex migrations.
- **Environment Specific Code**: Avoid hard-coding values. Use configuration files or environment variables.
- **Legacy Code**: Clean up unused code and ensure cross-environment compatibility.
- **OOP Principles**: Follow SOLID principles.
- **Database Performance**: Avoid N+1 queries. Use \`includes\` or \`preload\`.
`;
}
function getAngularGuidelines(): string {
return `
- **Component Structure**: Ensure components are small and focused on a single responsibility. Follow the Angular style guide for component structure.
- **Module Organization**: Organize modules to keep related functionalities together. Use feature modules for distinct features.
- **Service Usage**: Use services for business logic and data access. Keep components focused on presentation logic.
- **Reactive Programming**: Prefer the use of RxJS for asynchronous operations. Ensure proper management of subscriptions to avoid memory leaks.
- **Templates**: Keep templates clean and readable. Use Angular directives (\`*ngIf\`, \`*ngFor\`) appropriately.
- **Change Detection**: Optimize change detection by using \`OnPush\` strategy where possible to improve performance.
- **Forms**: Use Reactive Forms for complex forms and Template-driven forms for simpler ones. Ensure proper validation.
- **Routing**: Use the Angular Router for navigation. Ensure routes are organized and lazy load modules where appropriate.
- **Dependency Injection**: Use Angular's dependency injection to manage dependencies. Avoid creating instances manually.
- **Testing**: Ensure comprehensive unit tests for components, services, and other classes. Use Jasmine and Karma for testing.
`;
}
function getAngularJSGuidelines(): string {
return `
- **Component Structure**: Ensure components follow a single responsibility principle. Organize code using modules.
- **Controller Usage**: Minimize the use of controllers. Prefer directives and services.
- **Scope Management**: Avoid excessive use of \`$scope\`. Prefer using \`controllerAs\` syntax and bind properties to the controller.
- **Service Usage**: Use services and factories for business logic. Keep controllers lean.
- **Templates**: Keep templates clean. Use directives to encapsulate reusable components.
- **Dependency Injection**: Use AngularJS dependency injection to manage dependencies. Avoid creating instances manually.
- **Performance**: Optimize watchers and digest cycles. Use one-time bindings where possible.
- **Testing**: Ensure comprehensive unit tests for controllers, services, and directives. Use Jasmine and Karma for testing.
`;
}
function getCypressGuidelines(): string {
return `
- **Test Structure**: Organize tests in a logical structure. Use \`describe\` and \`it\` blocks to structure test cases.
- **Selectors**: Use data attributes for selecting elements (\`data-cy\`). Avoid using selectors based on CSS or HTML structure which may change.
- **Assertions**: Use appropriate assertions to verify application behavior. Avoid excessive assertions in a single test.
- **Test Data**: Use fixtures and factories for test data. Avoid hardcoding data within tests.
- **Commands**: Use custom Cypress commands to reuse common test logic.
- **Error Handling**: Ensure tests handle errors gracefully and provide meaningful error messages.
- **Performance**: Optimize tests to run quickly. Avoid unnecessary steps and redundant tests.
- **Cross-browser Testing**: Ensure tests run across different browsers to verify compatibility.
- **Component Structure**: Ensure components are small and focused on a single responsibility.
- **Reactive Programming**: Prefer the use of RxJS for asynchronous operations.
- **Testing**: Ensure comprehensive unit tests for components, services, and other classes.
`;
}
@ -178,52 +108,29 @@ function createPrompt(file: File, chunk: Chunk, prDetails: PRDetails): string {
guidelines = getRailsGuidelines();
} else if (FRAMEWORK === "Angular") {
guidelines = getAngularGuidelines();
} else if (FRAMEWORK === "AngularJS") {
guidelines = getAngularJSGuidelines();
} else if (FRAMEWORK === "Cypress") {
guidelines = getCypressGuidelines();
}
return `Your task is to review a pull request for ${FRAMEWORK} code. Follow these instructions:
- Provide your response in JSON format: {"reviews": [{"lineNumber": <line_number>, "reviewComment": "<review comment>", "optimizedCode": "<optimized code>"}]}
- Comment only where there is an issue or a suggestion for improvement. No positive comments.
- Use GitHub Markdown format for comments.
- For each issue or suggestion, provide the optimized code snippet.
- Identify specific types of issues:
- **Security**: Look for vulnerabilities such as SQL injection, XSS, and insecure configurations.
- **Performance**: Identify potential performance bottlenecks and suggest optimizations.
- **Maintainability**: Ensure the code is easy to read and maintain. Suggest refactoring if necessary.
- **Best Practices**: Ensure adherence to best practices specific to ${FRAMEWORK} and the overall project.
- **Testing**: Verify that the code changes include appropriate tests. If not, suggest adding tests.
- **Documentation**: Check if the code changes are well-documented. If not, suggest improvements in documentation.
- Provide your response in JSON format: {"reviews": [{"lineNumber": <line_number>, "reviewComment": "<review comment>", "optimizedCode": "<optimized code>", "severity": "Low"|"Medium"|"High"}]}
- Comment only where there is an issue or a suggestion for improvement. No positive comments.
- Only include comments with a severity of "Medium" or "High".
${guidelines}
Review the following code diff in the file "${file.to}", considering the pull request title and description for context:
Pull request title: ${prDetails.title}
Pull request description:
---
${prDetails.description}
---
Git diff to review:
\`\`\`diff
${chunk.content}
${chunk.changes
.map((c) => `${'ln' in c ? c.ln : 'ln2' in c ? c.ln2 : ''} ${c.content}`)
.join("\n")}
${chunk.changes.map((c) => `${'ln' in c ? c.ln : 'ln2' in c ? c.ln2 : ''} ${c.content}`).join("\n")}
\`\`\`
`;
`;
}
async function getAIResponse(prompt: string): Promise<Array<{
lineNumber: string;
reviewComment: string;
optimizedCode: string;
severity: string;
}> | null> {
const queryConfig = {
model: OPENAI_API_MODEL,
@ -237,41 +144,48 @@ async function getAIResponse(prompt: string): Promise<Array<{
try {
const response = await openai.chat.completions.create({
...queryConfig,
messages: [
{
role: "system",
content: prompt,
},
],
messages: [{ role: "system", content: prompt }],
});
// Log the raw response for debugging
console.log('Raw response:', JSON.stringify(response, null, 2));
const res = response.choices[0].message?.content?.trim() || "";
// Extract JSON content from Markdown code block
const jsonContent = res.match(/```json([\s\S]*)```/)?.[1];
if (!jsonContent) {
console.error("Failed to extract JSON content from response.");
return null;
}
// Attempt to parse JSON
try {
return JSON.parse(jsonContent).reviews;
} catch (e) {
console.error("Failed to parse JSON:", e);
console.error("Response content:", jsonContent);
return null;
}
return JSON.parse(jsonContent).reviews;
} catch (error) {
console.error("Error:", error);
return null;
}
}
function getSimilarityRatio(original: string, optimized: string): number {
let changes = 0;
const minLength = Math.min(original.length, optimized.length);
for (let i = 0; i < minLength; i++) {
if (original[i] !== optimized[i]) {
changes++;
}
}
return 1 - (changes / Math.max(original.length, optimized.length));
}
function isSignificantDifference(original: string, optimized: string): boolean {
const threshold = 0.9;
const similarityRatio = getSimilarityRatio(original, optimized);
return similarityRatio < threshold;
}
function isDuplicateComment(comment: string, existingComments: Set<string>): boolean {
if (existingComments.has(comment)) {
return true;
} else {
existingComments.add(comment);
return false;
}
}
function createComment(
file: File,
chunk: Chunk,
@ -279,7 +193,8 @@ function createComment(
lineNumber: string;
reviewComment: string;
optimizedCode: string;
}>
}>,
existingComments: Set<string>
): Array<{ body: string; path: string; line: number }> {
return aiResponses.flatMap((aiResponse) => {
if (!file.to) {
@ -287,26 +202,23 @@ function createComment(
}
const lineNumber = Number(aiResponse.lineNumber);
// Find the matching change in the chunk
const change = chunk.changes.find((c) => {
if ("ln" in c && c.ln === lineNumber) return true;
if ("ln2" in c && c.ln2 === lineNumber) return true;
return false;
});
const change = chunk.changes.find((c) => ("ln" in c && c.ln === lineNumber) || ("ln2" in c && c.ln2 === lineNumber));
if (!change) {
console.error(`Line number ${aiResponse.lineNumber} not found in the diff for file ${file.to}`);
return [];
}
const commentLine = "ln" in change ? change.ln : "ln2" in change ? change.ln2 : 0;
return {
body: `${aiResponse.reviewComment}\n\n**Optimized Code:**\n\`\`\`${FRAMEWORK === 'Ruby on Rails' ? 'ruby' : FRAMEWORK === 'Cypress' ? 'javascript' : 'typescript'}\n${aiResponse.optimizedCode}\n\`\`\``,
if (!isSignificantDifference(change.content, aiResponse.optimizedCode) || isDuplicateComment(aiResponse.reviewComment, existingComments)) {
return [];
}
return [{
body: `${aiResponse.reviewComment}\n\n**Optimized Code:**\n\`\`\`${FRAMEWORK === 'Ruby on Rails' ? 'ruby' : 'typescript'}\n${aiResponse.optimizedCode}\n\`\`\``,
path: file.to,
line: commentLine,
};
}];
});
}
@ -325,27 +237,31 @@ async function createReviewComment(
});
}
async function removeOldComments(owner: string, repo: string, pull_number: number) {
const reviews = await octokit.pulls.listReviews({ owner, repo, pull_number });
const reviewIds = reviews.data.map((review) => review.id);
for (const reviewId of reviewIds) {
await octokit.pulls.deletePendingReview({ owner, repo, pull_number, review_id: reviewId }); // Fix: Use deletePendingReview
}
}
async function main() {
const prDetails = await getPRDetails();
let diff: string | null;
const eventData = JSON.parse(
readFileSync(process.env.GITHUB_EVENT_PATH ?? "", "utf8")
);
const eventData = JSON.parse(readFileSync(process.env.GITHUB_EVENT_PATH ?? "", "utf8"));
if (eventData.action === "opened") {
diff = await getDiff(
prDetails.owner,
prDetails.repo,
prDetails.pull_number
);
diff = await getDiff(prDetails.owner, prDetails.repo, prDetails.pull_number);
} else if (eventData.action === "synchronize") {
if (eventData.forced) {
await removeOldComments(prDetails.owner, prDetails.repo, prDetails.pull_number);
}
const newBaseSha = eventData.before;
const newHeadSha = eventData.after;
const response = await octokit.repos.compareCommits({
headers: {
accept: "application/vnd.github.v3.diff",
},
headers: { accept: "application/vnd.github.v3.diff" },
owner: prDetails.owner,
repo: prDetails.repo,
base: newBaseSha,
@ -354,40 +270,22 @@ async function main() {
diff = String(response.data);
} else {
console.log("Unsupported event:", process.env.GITHUB_EVENT_NAME);
return;
}
if (!diff) {
console.log("No diff found");
return;
}
if (!diff) return;
const parsedDiff = parseDiff(diff);
const excludePatterns = core.getInput("exclude").split(",").map((s) => s.trim());
const excludePatterns = core
.getInput("exclude")
.split(",")
.map((s) => s.trim());
const filteredDiff = parsedDiff.filter((file) => {
return !excludePatterns.some((pattern) =>
minimatch(file.to ?? "", pattern)
);
});
const filteredDiff = parsedDiff.filter((file) => !excludePatterns.some((pattern) => minimatch(file.to ?? "", pattern)));
const comments = await analyzeCode(filteredDiff, prDetails);
if (comments.length > 0) {
await createReviewComment(
prDetails.owner,
prDetails.repo,
prDetails.pull_number,
comments
);
await createReviewComment(prDetails.owner, prDetails.repo, prDetails.pull_number, comments);
}
}
main().catch((error) => {
console.error("Error:", error);
process.exit(1);
});
});