fix: improve code

Author: meness

src/handlers/diagram.handler.ts

@@ -6,6 +6,7 @@ import { Handler } from '~common/interfaces';
 import { Config, FileContent } from '~common/types';
 import { aiConfig, appConfig } from '~configs';
 import { SystemError } from '~errors';
+import { addMetadataToComment } from '~helpers';
 import { AiService, CacheService, GitHubService, QueueService, TemplateService } from '~services';
 import { diagramCommentTemplate, diagramPromptTemplate, diagramSystemTemplate } from '~templates';
 import { DiagramSkipConditions } from '~utils';
@@ -29,21 +30,21 @@ export class DiagramHandler implements Handler<'pull_request'> {
     const existingComment = await this.findExistingComment(context);
 
     if (existingComment?.id) {
-      await this.queueService.schedule(() =>
-        GitHubService.updateComment(
-          context,
-          existingComment.id,
-          TemplateService.render(diagramCommentTemplate, {
-            diagram,
-            commentType: appConfig.metadata.diagram
-          })
-        )
+      const commentBody = addMetadataToComment(
+        TemplateService.render(diagramCommentTemplate, {
+          diagram
+        }),
+        appConfig.metadata.diagram
       );
+
+      await this.queueService.schedule(() => GitHubService.updateComment(context, existingComment.id, commentBody));
     } else {
-      const commentBody = TemplateService.render(diagramCommentTemplate, {
-        diagram,
-        commentType: appConfig.metadata.diagram
-      });
+      const commentBody = addMetadataToComment(
+        TemplateService.render(diagramCommentTemplate, {
+          diagram
+        }),
+        appConfig.metadata.diagram
+      );
 
       await this.queueService.schedule(() => GitHubService.createComment(context, commentBody));
     }

src/handlers/summary.handler.ts

@@ -7,6 +7,7 @@ import { Handler } from '~common/interfaces';
 import { Config, FileContent, SummaryObject } from '~common/types';
 import { aiConfig, appConfig } from '~configs';
 import { SystemError } from '~errors';
+import { addMetadataToComment } from '~helpers';
 import { summaryObjectSchema } from '~schemas';
 import { AiService, CacheService, GitHubService, QueueService, TemplateService } from '~services';
 import { summaryCommentTemplate, summaryPromptTemplate, summarySystemTemplate } from '~templates';
@@ -32,21 +33,21 @@ export class SummaryHandler implements Handler<'pull_request'> {
     const existingComment = await this.findExistingComment(context);
 
     if (existingComment?.id) {
-      await this.queueService.schedule(() =>
-        GitHubService.updateComment(
-          context,
-          existingComment.id,
-          TemplateService.render(summaryCommentTemplate, {
-            summary,
-            commentType: appConfig.metadata.summary
-          })
-        )
+      const commentBody = addMetadataToComment(
+        TemplateService.render(summaryCommentTemplate, {
+          summary
+        }),
+        appConfig.metadata.summary
       );
+
+      await this.queueService.schedule(() => GitHubService.updateComment(context, existingComment.id, commentBody));
     } else {
-      const commentBody = TemplateService.render(summaryCommentTemplate, {
-        summary,
-        commentType: appConfig.metadata.summary
-      });
+      const commentBody = addMetadataToComment(
+        TemplateService.render(summaryCommentTemplate, {
+          summary
+        }),
+        appConfig.metadata.summary
+      );
 
       await this.queueService.schedule(() => GitHubService.createComment(context, commentBody));
     }

src/handlers/walkthrough.handler.ts

@@ -7,6 +7,7 @@ import { Handler } from '~common/interfaces';
 import { Config, FileContent, WalkthroughObject } from '~common/types';
 import { aiConfig, appConfig } from '~configs';
 import { SystemError } from '~errors';
+import { addMetadataToComment } from '~helpers';
 import { walkthroughObjectSchema } from '~schemas';
 import { AiService, CacheService, GitHubService, QueueService, TemplateService } from '~services';
 import { walkthroughCommentTemplate, walkthroughPromptTemplate, walkthroughSystemTemplate } from '~templates';
@@ -32,23 +33,23 @@ export class WalkthroughHandler implements Handler<'pull_request'> {
     const changes = this.generateMarkdown(walkthroughObject.changes);
 
     if (existingComment?.id) {
-      await this.queueService.schedule(() =>
-        GitHubService.updateComment(
-          context,
-          existingComment.id,
-          TemplateService.render(walkthroughCommentTemplate, {
-            description: walkthroughObject.description,
-            changes,
-            commentType: appConfig.metadata.walkthrough
-          })
-        )
+      const commentBody = addMetadataToComment(
+        TemplateService.render(walkthroughCommentTemplate, {
+          description: walkthroughObject.description,
+          changes
+        }),
+        appConfig.metadata.walkthrough
       );
+
+      await this.queueService.schedule(() => GitHubService.updateComment(context, existingComment.id, commentBody));
     } else {
-      const commentBody = TemplateService.render(walkthroughCommentTemplate, {
-        description: walkthroughObject.description,
-        changes,
-        commentType: appConfig.metadata.walkthrough
-      });
+      const commentBody = addMetadataToComment(
+        TemplateService.render(walkthroughCommentTemplate, {
+          description: walkthroughObject.description,
+          changes
+        }),
+        appConfig.metadata.walkthrough
+      );
 
       await this.queueService.schedule(() => GitHubService.createComment(context, commentBody));
     }

src/helpers/comment.helper.ts

@@ -0,0 +1 @@
+export const addMetadataToComment = (comment: string, metadata: string): string => `${metadata}\n${comment}`;

src/helpers/index.ts

@@ -1,5 +1,6 @@
 export * from './ai.helper';
 export * from './cache.helper';
+export * from './comment.helper';
 export * from './guard.helper';
 export * from './hash.helper';
 export * from './object.helper';

src/templates/comments/diagram.comment.template.md

@@ -1,4 +1,3 @@
-{{commentType}}
 # Sequence Diagram(s) by Dr. Git
 
 {{diagram}}

src/templates/comments/summary.comment.template.md

@@ -1,4 +1,3 @@
-{{commentType}}
 # Summary by Dr. Git
-<!-- heading title summary -->
+
 {{summary}}

src/templates/comments/walkthrough.comment.template.md

@@ -1,6 +1,5 @@
-{{commentType}}
 # Walkthrough by Dr. Git
-<!-- heading title walkthrough -->
+
 {{description}}
 
 {{changes}}