Use GitHub Review API for comments (#373)

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

```
**New Feature**
- Added support for GitHub Review API in comments.
- Introduced a new method `deletePendingReview` to delete pending reviews.
- Enhanced `submitReview` method to handle review comments and create reviews.
- Updated logic for deleting and updating review comments.
- Reduced `maxRetries` value from 10 to 3 for improved performance.

> 🎉 Here's to the code that now gleams,
> With reviews flowing like streams.
> Deleting, updating, no more waiting,
> For our efficiency, it seems. 🚀
> Max retries cut down in size,
> Oh, how time flies! 🕰️
> Celebrate this PR's rise,
> To the occasion, it truly ties. 🎈
```
<!-- end of auto-generated comment: release notes by openai -->

Author: harjotgill

dist/index.js

@@ -190,14 +190,43 @@ ${COMMENT_TAG}`
     })
   }
 
+  async deletePendingReview(pullNumber: number) {
+    try {
+      const reviews = await octokit.pulls.listReviews({
+        owner: repo.owner,
+        repo: repo.repo,
+        // eslint-disable-next-line camelcase
+        pull_number: pullNumber
+      })
+
+      const pendingReview = reviews.data.find(
+        review => review.state === 'PENDING'
+      )
+
+      if (pendingReview) {
+        info(
+          `Deleting pending review for PR #${pullNumber} id: ${pendingReview.id}`
+        )
+        try {
+          await octokit.pulls.deletePendingReview({
+            owner: repo.owner,
+            repo: repo.repo,
+            // eslint-disable-next-line camelcase
+            pull_number: pullNumber,
+            // eslint-disable-next-line camelcase
+            review_id: pendingReview.id
+          })
+        } catch (e) {
+          warning(`Failed to delete pending review: ${e}`)
+        }
+      }
+    } catch (e) {
+      warning(`Failed to list reviews: ${e}`)
+    }
+  }
+
   async submitReview(pullNumber: number, commitId: string) {
-    info(
-      `Submitting review for PR #${pullNumber}, total comments: ${this.reviewCommentsBuffer.length}`
-    )
-    let commentCounter = 0
     for (const comment of this.reviewCommentsBuffer) {
-      info(`Posting comment: ${comment.message}`)
-      let found = false
       const comments = await this.getCommentsAtRange(
         pullNumber,
         comment.path,
@@ -207,25 +236,74 @@ ${COMMENT_TAG}`
       for (const c of comments) {
         if (c.body.includes(COMMENT_TAG)) {
           info(
-            `Updating review comment for ${comment.path}:${comment.startLine}-${comment.endLine}: ${comment.message}`
+            `Deleting review comment for ${comment.path}:${comment.startLine}-${comment.endLine}: ${comment.message}`
           )
           try {
-            await octokit.pulls.updateReviewComment({
+            await octokit.pulls.deleteReviewComment({
               owner: repo.owner,
               repo: repo.repo,
               // eslint-disable-next-line camelcase
-              comment_id: c.id,
-              body: comment.message
+              comment_id: c.id
             })
           } catch (e) {
-            warning(`Failed to update review comment: ${e}`)
+            warning(`Failed to delete review comment: ${e}`)
           }
-          found = true
-          break
         }
       }
+    }
+
+    await this.deletePendingReview(pullNumber)
+
+    const generateCommentData = (comment: any) => {
+      const commentData: any = {
+        path: comment.path,
+        body: comment.message,
+        line: comment.endLine
+      }
+
+      if (comment.startLine !== comment.endLine) {
+        // eslint-disable-next-line camelcase
+        commentData.start_line = comment.startLine
+        // eslint-disable-next-line camelcase
+        commentData.start_side = 'RIGHT'
+      }
+
+      return commentData
+    }
 
-      if (!found) {
+    try {
+      const review = await octokit.pulls.createReview({
+        owner: repo.owner,
+        repo: repo.repo,
+        // eslint-disable-next-line camelcase
+        pull_number: pullNumber,
+        // eslint-disable-next-line camelcase
+        commit_id: commitId,
+        comments: this.reviewCommentsBuffer.map(comment =>
+          generateCommentData(comment)
+        )
+      })
+
+      info(
+        `Submitting review for PR #${pullNumber}, total comments: ${this.reviewCommentsBuffer.length}, review id: ${review.data.id}`
+      )
+
+      await octokit.pulls.submitReview({
+        owner: repo.owner,
+        repo: repo.repo,
+        // eslint-disable-next-line camelcase
+        pull_number: pullNumber,
+        // eslint-disable-next-line camelcase
+        review_id: review.data.id,
+        event: 'COMMENT'
+      })
+    } catch (e) {
+      warning(
+        `Failed to create review: ${e}. Falling back to individual comments.`
+      )
+      await this.deletePendingReview(pullNumber)
+      let commentCounter = 0
+      for (const comment of this.reviewCommentsBuffer) {
         info(
           `Creating new review comment for ${comment.path}:${comment.startLine}-${comment.endLine}: ${comment.message}`
         )
@@ -236,28 +314,20 @@ ${COMMENT_TAG}`
           pull_number: pullNumber,
           // eslint-disable-next-line camelcase
           commit_id: commitId,
-          body: comment.message,
-          path: comment.path,
-          line: comment.endLine
+          ...generateCommentData(comment)
         }
 
-        if (comment.startLine !== comment.endLine) {
-          // eslint-disable-next-line camelcase
-          commentData.start_side = 'RIGHT'
-          // eslint-disable-next-line camelcase
-          commentData.start_line = comment.startLine
-        }
         try {
           await octokit.pulls.createReviewComment(commentData)
-        } catch (e) {
-          warning(`Failed to create review comment: ${e}`)
+        } catch (ee) {
+          warning(`Failed to create review comment: ${ee}`)
         }
-      }
 
-      commentCounter++
-      info(
-        `Comment ${commentCounter}/${this.reviewCommentsBuffer.length} posted`
-      )
+        commentCounter++
+        info(
+          `Comment ${commentCounter}/${this.reviewCommentsBuffer.length} posted`
+        )
+      }
     }
   }
 
@@ -483,7 +553,7 @@ ${chain}
 
   async create(body: string, target: number) {
     try {
-      // get commend ID from the response
+      // get comment ID from the response
       await octokit.issues.createComment({
         owner: repo.owner,
         repo: repo.repo,

src/commenter.ts

@@ -33,6 +33,6 @@ Retry count: ${retryCount}
   },
   retry: {
     doNotRetry: ['429'],
-    maxRetries: 10
+    maxRetries: 3
   }
 })