update index.js (#390)

Author: harjotgill

dist/index.js

@@ -231,7 +231,7 @@ ${COMMENT_TAG}`
     }
   }
 
-  async submitReview(pullNumber: number, commitId: string) {
+  async submitReview(pullNumber: number, commitId: string, statusMsg: string) {
     if (this.reviewCommentsBuffer.length === 0) {
       return
     }
@@ -297,14 +297,20 @@ ${COMMENT_TAG}`
         `Submitting review for PR #${pullNumber}, total comments: ${this.reviewCommentsBuffer.length}, review id: ${review.data.id}`
       )
 
+      const body = `${COMMENT_GREETING}
+
+${statusMsg}
+`
+
       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'
+        event: 'COMMENT',
+        body
       })
     } catch (e) {
       warning(
@@ -732,11 +738,7 @@ ${chain}
   }
 
   // add in-progress status to the comment body
-  addInProgressStatus(
-    commentBody: string,
-    headCommitId: string,
-    highestReviewedCommitId: string
-  ): string {
+  addInProgressStatus(commentBody: string, statusMsg: string): string {
     const start = commentBody.indexOf(IN_PROGRESS_START_TAG)
     const end = commentBody.indexOf(IN_PROGRESS_END_TAG)
     // add to the beginning of the comment body if the marker doesn't exist
@@ -746,10 +748,7 @@ ${chain}
 
 Currently reviewing new changes in this PR...
 
-<details>
-<summary>Details</summary>
-The files that changed from the \`base\` of the PR and between \`${highestReviewedCommitId}\` and \`${headCommitId}\` commits are being reviewed.
-</details>
+${statusMsg}
 
 ${IN_PROGRESS_END_TAG}
 

src/commenter.ts

@@ -262,11 +262,37 @@ ${hunks.oldHunk}
     return
   }
 
+  let statusMsg = `<details>
+<summary>Commits</summary>
+Files that changed from the base of the PR and between ${highestReviewedCommitId} and ${
+    context.payload.pull_request.head.sha
+  } commits.
+</details>
+<details>
+<summary>Files selected ${filesAndChanges.length}</summary>
+
+${filesAndChanges
+  .map(([filename, , , patches]) => `* ${filename} (${patches.length} hunks)`)
+  .join('\n')}
+</details>
+${
+  filterIgnoredFiles.length > 0
+    ? `
+<details>
+<summary>Files ignored due to filter (${filterIgnoredFiles.length})</summary>
+
+* ${filterIgnoredFiles.map(file => file.filename).join('\n* ')}
+
+</details>
+`
+    : ''
+}
+`
+
   // update the existing comment with in progress status
   const inProgressSummarizeCmt = commenter.addInProgressStatus(
     existingSummarizeCmtBody,
-    context.payload.pull_request.head.sha,
-    highestReviewedCommitId
+    statusMsg
   )
 
   // add in progress status to the summarize comment
@@ -402,7 +428,7 @@ ${filename}: ${summary}
     if (releaseNotesResponse === '') {
       info('release notes: nothing obtained from openai')
     } else {
-      let message = '### Summary by CodeRabbit OSS\n\n'
+      let message = '### Summary by CodeRabbit\n\n'
       message += releaseNotesResponse
       try {
         await commenter.updateDescription(
@@ -446,23 +472,10 @@ ${SHORT_SUMMARY_END_TAG}
 ### Ignoring further reviews
 - Type \`@coderabbitai: ignore\` anywhere in the PR description to ignore further reviews from the bot.
 
-</details>
-
-${
-  filterIgnoredFiles.length > 0
-    ? `
-<details>
-<summary>Files ignored due to filter (${filterIgnoredFiles.length})</summary>
-
-### Ignored files
-
-* ${filterIgnoredFiles.map(file => file.filename).join('\n* ')}
-
 </details>
 `
-    : ''
-}
 
+  statusMsg += `
 ${
   skippedFiles.length > 0
     ? `
@@ -471,15 +484,12 @@ ${
         skippedFiles.length
       })</summary>
 
-### Not processed
-
 * ${skippedFiles.join('\n* ')}
 
 </details>
 `
     : ''
 }
-
 ${
   summariesFailed.length > 0
     ? `
@@ -488,15 +498,14 @@ ${
         summariesFailed.length
       })</summary>
 
-### Failed to summarize
-
 * ${summariesFailed.join('\n* ')}
 
 </details>
 `
     : ''
 }
 `
+
   if (!options.disableReview) {
     const filesAndChangesReview = filesAndChanges.filter(([filename]) => {
       const needsReview =
@@ -673,32 +682,25 @@ ${commentChain}
 
     await Promise.all(reviewPromises)
 
-    summarizeComment += `
+    statusMsg += `
 ${
   reviewsFailed.length > 0
     ? `<details>
-<summary>Files not reviewed due to errors in the recent run (${
-        reviewsFailed.length
-      })</summary>
-
-### Failed to review in the last run
+<summary>Files not reviewed due to errors (${reviewsFailed.length})</summary>
 
 * ${reviewsFailed.join('\n* ')}
 
 </details>
 `
     : ''
 }
-
 ${
   reviewsSkipped.length > 0
     ? `<details>
 <summary>Files not reviewed due to simple changes (${
         reviewsSkipped.length
       })</summary>
 
-### Skipped review in the recent run
-
 * ${reviewsSkipped.join('\n* ')}
 
 </details>
@@ -719,7 +721,8 @@ ${
   // post the review
   await commenter.submitReview(
     context.payload.pull_request.number,
-    commits[commits.length - 1].sha
+    commits[commits.length - 1].sha,
+    statusMsg
   )
 }