limit event to created comments (#46)

<!-- This is an auto-generated comment: release notes by openai -->
### Summary by OpenAI

**Release Notes**

This pull request introduces a new feature that limits the event to
created comments only. The changes include adding a new event type
"created" to trigger the workflow only when a new pull request review
comment is created, updating the pull request event to trigger only on
"created" comments, refactoring getConversationChain method to use
getTopLevelComment method, adding getTopLevelComment method to get
top-level comment of a conversation chain, adding COMMENT_GREETING
constant for greeting message, and modifying handleReviewComment
function to skip events that are not created and include the new comment
in the conversation chain.
<!-- end of auto-generated comment: release notes by openai -->

Author: harjotgill

.github/workflows/chatgpt-review.yml

@@ -4,7 +4,10 @@ permissions:
   contents: read
   pull-requests: write
 
-on: [pull_request, pull_request_review_comment]
+on:
+  pull_request:
+  pull_request_review_comment:
+    types: [created]
 
 concurrency:
   group:

README.md

@@ -32,7 +32,10 @@ permissions:
   contents: read
   pull-requests: write
 
-on: [pull_request, pull_request_review_comment]
+on:
+  pull_request:
+  pull_request_review_comment:
+    types: [created]
 
 concurrency:
   group:

dist/index.js

@@ -141,28 +141,18 @@ ${tag}`
   async getConversationChain(pull_number: number, comment: any) {
     try {
       const reviewComments = await list_review_comments(pull_number)
-      const conversationChain: string[] = [
-        `${comment.user.login}-(${comment.id}): ${comment.body}`
-      ]
-
-      let in_reply_to_id = comment.in_reply_to_id
-      let topLevelComment: any | null
+      const topLevelComment = await this.getTopLevelComment(
+        reviewComments,
+        comment
+      )
 
-      while (in_reply_to_id) {
-        const parentComment = reviewComments.find(
-          (cmt: any) => cmt.id === in_reply_to_id
-        )
+      const conversationChain = reviewComments
+        .filter((cmt: any) => cmt.in_reply_to_id === topLevelComment.id)
+        .map((cmt: any) => `${cmt.user.login}-(${cmt.id}): ${cmt.body}`)
 
-        if (parentComment) {
-          conversationChain.unshift(
-            `${parentComment.user.login}-(${parentComment.id}): ${parentComment.body}`
-          )
-          in_reply_to_id = parentComment.in_reply_to_id
-          topLevelComment = parentComment
-        } else {
-          break
-        }
-      }
+      conversationChain.unshift(
+        `${topLevelComment.user.login}: ${topLevelComment.body}`
+      )
 
       return {
         chain: conversationChain.join('\n---\n'),
@@ -176,6 +166,24 @@ ${tag}`
       }
     }
   }
+
+  async getTopLevelComment(reviewComments: any[], comment: any) {
+    let topLevelComment = comment
+
+    while (topLevelComment.in_reply_to_id) {
+      const parentComment = reviewComments.find(
+        (cmt: any) => cmt.id === topLevelComment.in_reply_to_id
+      )
+
+      if (parentComment) {
+        topLevelComment = parentComment
+      } else {
+        break
+      }
+    }
+
+    return topLevelComment
+  }
 }
 
 const list_review_comments = async (target: number, page: number = 1) => {

src/commenter.ts

@@ -2,7 +2,12 @@ import * as core from '@actions/core'
 import * as github from '@actions/github'
 import {Octokit} from '@octokit/action'
 import {Bot} from './bot.js'
-import {Commenter, COMMENT_REPLY_TAG, COMMENT_TAG} from './commenter.js'
+import {
+  Commenter,
+  COMMENT_GREETING,
+  COMMENT_REPLY_TAG,
+  COMMENT_TAG
+} from './commenter.js'
 
 const token = core.getInput('token')
   ? core.getInput('token')
@@ -11,7 +16,7 @@ const token = core.getInput('token')
 const octokit = new Octokit({auth: `token ${token}`})
 const context = github.context
 const repo = context.repo
-const BOT_INVITE = '@openai'
+const ASK_BOT = '@openai'
 
 export const handleReviewComment = async (bot: Bot) => {
   const commenter: Commenter = new Commenter()
@@ -38,6 +43,12 @@ export const handleReviewComment = async (bot: Bot) => {
     return
   }
 
+  // check if the comment was created and not edited or deleted
+  if (context.payload.action !== 'created') {
+    core.warning(`Skipped: ${context.eventName} event is not created`)
+    return
+  }
+
   // Check if the comment is not from the bot itself
   if (
     !comment.body.includes(COMMENT_TAG) &&
@@ -50,11 +61,12 @@ export const handleReviewComment = async (bot: Bot) => {
       pull_number,
       comment
     )
+    core.info(`Conversation chain: ${chain}`)
     // check whether this chain contains replies from the bot
     if (
       chain.includes(COMMENT_TAG) ||
       chain.includes(COMMENT_REPLY_TAG) ||
-      comment.body.startsWith(BOT_INVITE)
+      comment.body.startsWith(ASK_BOT)
     ) {
       const prompt = `I would like you to reply to the new comment made on a conversation chain on a code review diff.
 
@@ -63,16 +75,24 @@ Diff:
 ${diffHunk}
 \`\`\`
 
-Conversation chain:
+Conversation chain (including the new comment):
 \`\`\`
 ${chain}
 \`\`\`
 
-Please reply to the latest comment in the conversation chain without extra prose as that reply will be posted as-is.`
+Please reply to the new comment in the conversation chain without extra prose as that reply will be posted as-is. Make sure to tag the user in your reply. Providing below the new comment again as reference:
+\`\`\`
+${comment.user.login}: ${comment.body}
+\`\`\`
+`
 
       const [reply] = await bot.chat(prompt, {})
-      const message = `${COMMENT_REPLY_TAG}\n${reply}`
+      const message = `${COMMENT_GREETING}
+
+${reply}
 
+${COMMENT_REPLY_TAG}
+`
       if (topLevelComment) {
         const topLevelCommentId = topLevelComment.id
         try {
@@ -102,5 +122,7 @@ Please reply to the latest comment in the conversation chain without extra prose
         core.warning(`Failed to find the top-level comment to reply to`)
       }
     }
+  } else {
+    core.info(`Skipped: ${context.eventName} event is from the bot itself`)
   }
 }