Merge pull request #88 from devverseio/fix/reviews

Fix/reviews

Author: meness

.vscode/settings.json

@@ -81,6 +81,7 @@
   "cSpell.words": [
     "brotli",
     "Chinmaya",
+    "commitable",
     "commitlint",
     "consts",
     "drgit",

bun.lockb

@@ -6,6 +6,7 @@ export * from './diff-line.type';
 export * from './diff-position.type';
 export * from './file-content.type';
 export * from './file-context.type';
+export * from './review-object.type';
 export * from './summary-object.type';
 export * from './template-replacement.type';
 export * from './walkthrough-object.type';

src/common/types/index.ts

@@ -0,0 +1,4 @@
+import { z } from 'zod';
+import { reviewObjectSchema } from '~schemas';
+
+export type ReviewObject = z.infer<typeof reviewObjectSchema>;

src/common/types/review-object.type.ts

@@ -1,14 +1,15 @@
-import { generateText } from 'ai';
+import { generateObject } from 'ai';
 import { Context } from 'probot';
 import { profileDetails, toneDetails } from '~common/consts';
 import { Severity } from '~common/enums';
 import { Handler } from '~common/interfaces';
-import { CombinedLineGroup, Config, DiffLine, DiffPosition } from '~common/types';
+import { CombinedLineGroup, Config, DiffLine, DiffPosition, ReviewObject } from '~common/types';
 import { aiConfig } from '~configs';
 import { SystemError } from '~errors';
 import { cleanDiffString } from '~helpers';
+import { reviewObjectSchema } from '~schemas';
 import { AiService, CacheService, GitHubService, QueueService, TemplateService } from '~services';
-import { reviewPromptTemplate, reviewSystemTemplate } from '~templates';
+import { reviewCommentTemplate, reviewPromptTemplate, reviewSystemTemplate } from '~templates';
 import { ReviewSkipConditions } from '~utils';
 
 export class ReviewHandler implements Handler<'pull_request'> {
@@ -30,18 +31,30 @@ export class ReviewHandler implements Handler<'pull_request'> {
 
     await Promise.all(
       fileContents.flatMap((file) => {
-        const combinedDiff = diffPositions.find((diffFile) => diffFile?.path === file.name)?.positions;
+        const combinedDiff = diffPositions.find((diffFile) => diffFile.path === file.name)?.positions;
 
         if (combinedDiff) {
-          return Promise.all(
-            combinedDiff.map(async (diff) => {
-              const result = await this.generateReport(apiKey, config, file.content, diff.content);
-
-              return this.queueService.schedule(() =>
-                GitHubService.createInlineReviewComment(context, result, file.name, diff.endDiffPosition)
-              );
-            })
-          );
+          return combinedDiff.map(async (diff) => {
+            const { commitableSuggestion, review, shouldReview } = await this.generateReport(
+              apiKey,
+              config,
+              file.content,
+              diff.content
+            );
+
+            if (!shouldReview) {
+              return null;
+            }
+
+            const comment = TemplateService.render(reviewCommentTemplate, {
+              review,
+              commitableSuggestion
+            });
+
+            return this.queueService.schedule(() =>
+              GitHubService.createInlineReviewComment(context, comment, file.name, diff.endDiffPosition)
+            );
+          });
         }
 
         return [];
@@ -141,7 +154,7 @@ export class ReviewHandler implements Handler<'pull_request'> {
     return result;
   }
 
-  private async generateReport(apiKey: string, config: Config, content: string, diff: string): Promise<string> {
+  private async generateReport(apiKey: string, config: Config, content: string, diff: string): Promise<ReviewObject> {
     const prompt = TemplateService.render(reviewPromptTemplate, {
       content,
       diff: cleanDiffString(diff)
@@ -154,14 +167,15 @@ export class ReviewHandler implements Handler<'pull_request'> {
 
     return this.queueService.schedule(async () => {
       try {
-        const result = await generateText({
+        const result = await generateObject<ReviewObject>({
           model: this.aiService.getModel(aiConfig.model.incrementalReview, apiKey),
           topP: aiConfig.topP.review,
           system,
-          prompt
+          prompt,
+          schema: reviewObjectSchema
         });
 
-        return result.text;
+        return result.object;
       } catch (error) {
         throw new SystemError('Failed to generate review', Severity.ERROR, error);
       }

src/handlers/review.handler.ts

@@ -88,7 +88,7 @@ export class SummaryHandler implements Handler<'pull_request'> {
       const result = await this.queueService.schedule(() =>
         generateObject<SummaryObject>({
           topP: aiConfig.topP.summary,
-          model: this.aiService.getModel(aiConfig.model.summary, apiKey, true),
+          model: this.aiService.getModel(aiConfig.model.summary, apiKey),
           system: TemplateService.render(summarySystemTemplate, {
             tone: toneDetails[config.summary.tone],
             language: config.language

src/handlers/summary.handler.ts

@@ -80,7 +80,7 @@ export class WalkthroughHandler implements Handler<'pull_request'> {
       const result = await this.queueService.schedule(() =>
         generateObject<WalkthroughObject>({
           topP: aiConfig.topP.walkthrough,
-          model: this.aiService.getModel(aiConfig.model.walkthrough, apiKey, true),
+          model: this.aiService.getModel(aiConfig.model.walkthrough, apiKey),
           system: TemplateService.render(walkthroughSystemTemplate, {
             tone: toneDetails[config.walkthrough.tone],
             language: config.language

src/handlers/walkthrough.handler.ts

@@ -1,3 +1,4 @@
 export * from './config.schema';
+export * from './review-object.schema';
 export * from './summary-object.schema';
 export * from './walkthrough-object.schema';

src/schemas/index.ts

@@ -0,0 +1,15 @@
+import { z } from 'zod';
+
+export const reviewObjectSchema = z.object({
+  shouldReview: z.boolean().describe('Whether the review should be done or not'),
+  review: z.string().describe('The review generated if shouldReview is true'),
+  commitableSuggestion: z.string()
+    .describe(`The commitable suggestion generated if shouldReview is true. Make sure to use suggestion block like this:
+                \`\`\`suggestion
+                <...>
+                <...>
+                <...>
+                <...>
+                \`\`\`
+              `)
+});

src/schemas/review-object.schema.ts

@@ -19,11 +19,10 @@ export class AiService {
     return AiService.instance;
   }
 
-  public getModel(model: SupportedModel, apiKey: string, structuredOutputs: boolean = false): LanguageModelV1 {
+  public getModel(model: SupportedModel, apiKey: string): LanguageModelV1 {
     return this.provider(model, {
       logprobs: false,
-      user: hashSha256(apiKey),
-      structuredOutputs
+      user: hashSha256(apiKey)
     });
   }