Merge pull request #89 from devverseio/fix/prevent-synchronize-if-coo-authored-with-bot

fix: prevent synchronize if co authored with bot

Author: meness

src/handlers/app.handler.ts

@@ -51,7 +51,12 @@ export class AppHandler {
 
     // Handler initialization
     this.handlers = {
-      reviewHandler: new ReviewHandler(this.services.aiService, this.services.queueService, this.services.cacheService),
+      reviewHandler: new ReviewHandler(
+        this.services.aiService,
+        this.services.queueService,
+        this.services.cacheService,
+        this.services.appService
+      ),
       walkthroughHandler: new WalkthroughHandler(
         this.services.aiService,
         this.services.queueService,
@@ -97,6 +102,7 @@ export class AppHandler {
       apiKey = await this.services.configService.getApiKey(context);
       config = await this.services.configService.getConfig(context, apiKey);
 
+      await this.services.appService.init(context);
       await callback(apiKey, config);
     } catch (error) {
       if ('repository' in context.payload) {
@@ -124,7 +130,6 @@ export class AppHandler {
   ): Promise<void> {
     await this.safeEventHandler(context, async (apiKey, config) => {
       await this.handlers.contributorHandler.safeCacheContributors(context, apiKey);
-      await this.services.appService.init(context);
       await this.handlers.chatHandler.handle(context, apiKey, config);
     });
   }

src/handlers/review.handler.ts

@@ -8,19 +8,26 @@ 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 { AiService, AppService, CacheService, GitHubService, QueueService, TemplateService } from '~services';
 import { reviewCommentTemplate, reviewPromptTemplate, reviewSystemTemplate } from '~templates';
 import { ReviewSkipConditions } from '~utils';
 
 export class ReviewHandler implements Handler<'pull_request'> {
   constructor(
     private readonly aiService: AiService,
     private readonly queueService: QueueService,
-    private readonly cacheService: CacheService
+    private readonly cacheService: CacheService,
+    private readonly appService: AppService
   ) {}
 
   async handle(context: Context<'pull_request'>, apiKey: string, config: Config): Promise<void> {
-    const shouldSkip = await new ReviewSkipConditions(context, config, this.cacheService, apiKey).shouldSkip();
+    const shouldSkip = await new ReviewSkipConditions(
+      context,
+      config,
+      this.cacheService,
+      this.appService,
+      apiKey
+    ).shouldSkip();
 
     if (shouldSkip) {
       return;

src/services/app.service.ts

@@ -7,6 +7,7 @@ import { GitHubService } from './github.service';
 export class AppService {
   private static instance: AppService;
   private appData?: RestEndpointMethodTypes['apps']['getAuthenticated']['response']['data'];
+  private user?: RestEndpointMethodTypes['users']['getByUsername']['response']['data'];
 
   private constructor() {}
 
@@ -19,11 +20,13 @@ export class AppService {
   }
 
   async init(context: Context): Promise<void> {
-    if (!this.appData) {
+    if (!this.appData || !this.user) {
       try {
         const { data } = await GitHubService.getAuthenticated(context);
 
         this.appData = data;
+
+        this.user = await GitHubService.getByUsername(this.appData!.slug + '[bot]', context);
       } catch (error) {
         throw new SystemError('Failed to get authenticated app data', Severity.ERROR, error);
       }
@@ -41,4 +44,16 @@ export class AppService {
 
     return this.appData!.slug;
   }
+
+  getLogin(): string {
+    this.ensureInitialized();
+
+    return this.user!.login;
+  }
+
+  getEmail(): string {
+    this.ensureInitialized();
+
+    return `${this.user!.id}+${this.user!.login}@users.noreply.github.com`;
+  }
 }

src/services/github.service.ts

@@ -27,6 +27,19 @@ export class GitHubService {
     }
   }
 
+  static getCommit = (
+    commitSha: string,
+    context: Context
+  ): Promise<RestEndpointMethodTypes['repos']['getCommit']['response']> => {
+    const { owner, repo } = context.repo();
+
+    return context.octokit.repos.getCommit({
+      owner,
+      repo,
+      ref: commitSha
+    });
+  };
+
   static getGitHubRepoVariable(
     variableName: string,
     context: Context
@@ -57,6 +70,17 @@ export class GitHubService {
     return context.octokit.apps.getAuthenticated();
   }
 
+  static getByUsername = async (
+    username: string,
+    context: Context
+  ): Promise<RestEndpointMethodTypes['users']['getByUsername']['response']['data']> => {
+    const { data } = await context.octokit.users.getByUsername({
+      username
+    });
+
+    return data;
+  };
+
   static paginateListComments(
     context: Context
   ): Promise<RestEndpointMethodTypes['issues']['listComments']['response']['data']> {

src/utils/review-skip-conditions.util.ts

@@ -2,13 +2,14 @@ import { RestEndpointMethodTypes } from '@octokit/plugin-rest-endpoint-methods';
 import { Context } from 'probot';
 import { Config } from '~common/types';
 import { getUserContributorsCacheKey } from '~helpers';
-import { CacheService } from '~services';
+import { AppService, CacheService, GitHubService } from '~services';
 
 export class ReviewSkipConditions {
   constructor(
     private readonly context: Context<'pull_request'>,
     private readonly config: Config,
     private readonly cacheService: CacheService,
+    private readonly appService: AppService,
     private readonly apiKey: string
   ) {}
 
@@ -24,12 +25,28 @@ export class ReviewSkipConditions {
       this.isMerged(),
       this.isUserIgnored(),
       this.isContributorOnly(),
-      this.isAuthorOnly()
+      this.isAuthorOnly(),
+      this.isCoAuthoredWithBot()
     ];
 
     return (await Promise.all(skipChecks)).some(Boolean);
   }
 
+  private async isCoAuthoredWithBot(): Promise<boolean> {
+    if (this.context.payload.action === 'synchronize') {
+      const commitSha = this.context.payload.after;
+      const commit = await GitHubService.getCommit(commitSha, this.context);
+      const { message } = commit.data.commit;
+      const login = this.appService.getLogin();
+      const email = this.appService.getEmail();
+      const coAuthoredMessage = `${login} <${email}>`;
+
+      return message.toLowerCase().includes(coAuthoredMessage.toLowerCase());
+    }
+
+    return false;
+  }
+
   private async isContributorOnly(): Promise<boolean> {
     const { 'contributors-only': contributorsOnly, always } = this.config.review.allow['pull-requests'];