From 3d10fb38c2ba1ba1ad3fd6b7a6ab11a62de39b21 Mon Sep 17 00:00:00 2001
From: Tomoya Kashifuku <tnyo43@gmail.com>
Date: Thu, 21 Mar 2024 00:11:29 +0900
Subject: [PATCH] fix comment debug (#23)

* show comment info if recommending comment has already been posted

* update to show existing comment url

* show debug comment on console.log than in message by summary

* fix to set message after post a message

* remove unused properties

* fix logic
---
 dist/index.js                         | 85 +++++++++++++--------------
 src/comments/getCommentContent.ts     | 22 +++----
 src/comments/getExistingCommentUrl.ts |  9 +++
 src/comments/isAlreadyCommented.ts    |  8 ---
 src/comments/postComment.ts           | 34 +++++------
 src/comments/types.ts                 |  4 +-
 src/main.ts                           | 10 ++--
 7 files changed, 83 insertions(+), 89 deletions(-)
 create mode 100644 src/comments/getExistingCommentUrl.ts
 delete mode 100644 src/comments/isAlreadyCommented.ts

diff --git a/dist/index.js b/dist/index.js
index 1919d0c..ed7b971 100644
--- a/dist/index.js
+++ b/dist/index.js
@@ -28996,15 +28996,17 @@ exports.ACTION_IDENTIFY_TEXT = '<!-- a sentence for identifying bot recommend-mo
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.getCommentContent = void 0;
 const getLoginNames_1 = __nccwpck_require__(40);
-const isAlreadyCommented_1 = __nccwpck_require__(8484);
-async function getCommentContent(octokit, octokitContext, args) {
+const getExistingCommentUrl_1 = __nccwpck_require__(8231);
+async function getCommentContent(octokit, octokitContext, threshold) {
     const { owner, repo, prNumber } = octokitContext;
     const comments = (await octokit.rest.issues.listComments({
         owner,
         repo,
         issue_number: prNumber,
     })).data;
-    if ((0, isAlreadyCommented_1.isAlreadyCommented)(comments)) {
+    const existingCommentUrl = (0, getExistingCommentUrl_1.getExistingCommentUrl)(comments);
+    if (existingCommentUrl) {
+        console.log('a recommending comment has already been posted: ', existingCommentUrl);
         return null;
     }
     const reviewComments = (await octokit.rest.pulls.listReviewComments({
@@ -29013,7 +29015,9 @@ async function getCommentContent(octokit, octokitContext, args) {
         pull_number: prNumber,
     })).data;
     const numberOfComments = comments.length + reviewComments.length;
-    if (numberOfComments < args.threshold) {
+    console.log('number of the obtained comments is ', numberOfComments);
+    if (numberOfComments < threshold) {
+        console.log("It's not necessary to send a recommending comment yet.");
         return null;
     }
     const users1 = comments
@@ -29025,13 +29029,28 @@ async function getCommentContent(octokit, octokitContext, args) {
     const logins = (0, getLoginNames_1.getLoginNames)(users1.concat(users2));
     return {
         logins,
-        numberOfComments,
-        threshold: args.threshold,
     };
 }
 exports.getCommentContent = getCommentContent;
 
 
+/***/ }),
+
+/***/ 8231:
+/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.getExistingCommentUrl = void 0;
+const constants_1 = __nccwpck_require__(1435);
+function getExistingCommentUrl(comments) {
+    const comment = comments.find((comment) => comment.body?.startsWith(constants_1.ACTION_IDENTIFY_TEXT));
+    return comment?.html_url;
+}
+exports.getExistingCommentUrl = getExistingCommentUrl;
+
+
 /***/ }),
 
 /***/ 40:
@@ -29062,22 +29081,6 @@ function getLoginNames(users) {
 exports.getLoginNames = getLoginNames;
 
 
-/***/ }),
-
-/***/ 8484:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.isAlreadyCommented = void 0;
-const constants_1 = __nccwpck_require__(1435);
-function isAlreadyCommented(comments) {
-    return comments.some((comment) => comment.body?.startsWith(constants_1.ACTION_IDENTIFY_TEXT));
-}
-exports.isAlreadyCommented = isAlreadyCommented;
-
-
 /***/ }),
 
 /***/ 7942:
@@ -29087,6 +29090,7 @@ exports.isAlreadyCommented = isAlreadyCommented;
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.postComment = void 0;
+const core_1 = __nccwpck_require__(9093);
 const constants_1 = __nccwpck_require__(1435);
 function MainText(content) {
     return `
@@ -29095,31 +29099,27 @@ Hey ${content.logins.map((login) => '@' + login).join(', ')}!
 It seems the discussion is dragging on. Perhaps instead of text communication, you could try having a conversation via face-to-face or video call, or even try mob programming?
 `;
 }
-function debugText(content) {
-    return `
-<details>
-<summary>number of comments</summary>
-the number of the comments is ${content.numberOfComments}
-threshold: ${content.threshold}
-</details>
-`;
-}
 function getText(content) {
     return `${constants_1.ACTION_IDENTIFY_TEXT}
 
 ${MainText(content)}
-
-${debugText(content)}
 `;
 }
 async function postComment(octokit, octokitContext, content) {
     const { owner, repo, prNumber } = octokitContext;
-    await octokit.rest.issues.createComment({
-        owner,
-        repo,
-        issue_number: prNumber,
-        body: getText(content),
-    });
+    try {
+        const result = await octokit.rest.issues.createComment({
+            owner,
+            repo,
+            issue_number: prNumber,
+            body: getText(content),
+        });
+        console.log('a recommending comment has been posted: ', result.data.html_url);
+    }
+    catch (error) {
+        console.error(error);
+        (0, core_1.setFailed)('failed to post comment');
+    }
 }
 exports.postComment = postComment;
 
@@ -29169,17 +29169,12 @@ async function run() {
     try {
         const { token, prNumber, threshold } = (0, option_1.getOption)();
         const octokit = (0, github_1.getOctokit)(token);
-        const owner = github_1.context.repo.owner;
-        const repo = github_1.context.repo.repo;
         const octokitContext = {
             owner: github_1.context.repo.owner,
             repo: github_1.context.repo.repo,
             prNumber,
         };
-        core.debug(`owner: ${owner}, repo: ${repo}, PR #${prNumber}`);
-        const commentContent = await (0, getCommentContent_1.getCommentContent)(octokit, octokitContext, {
-            threshold,
-        });
+        const commentContent = await (0, getCommentContent_1.getCommentContent)(octokit, octokitContext, threshold);
         if (commentContent) {
             await (0, postComment_1.postComment)(octokit, octokitContext, commentContent);
         }
diff --git a/src/comments/getCommentContent.ts b/src/comments/getCommentContent.ts
index 0308380..406bf96 100644
--- a/src/comments/getCommentContent.ts
+++ b/src/comments/getCommentContent.ts
@@ -5,16 +5,12 @@ import {
   type User,
 } from './types';
 import { getLoginNames } from './getLoginNames';
-import { isAlreadyCommented } from './isAlreadyCommented';
-
-type Args = {
-  threshold: number;
-};
+import { getExistingCommentUrl } from './getExistingCommentUrl';
 
 export async function getCommentContent(
   octokit: Octokit,
   octokitContext: OctokitContext,
-  args: Args,
+  threshold: number,
 ): Promise<CommentContent | null> {
   const { owner, repo, prNumber } = octokitContext;
 
@@ -26,7 +22,12 @@ export async function getCommentContent(
     })
   ).data;
 
-  if (isAlreadyCommented(comments)) {
+  const existingCommentUrl = getExistingCommentUrl(comments);
+  if (existingCommentUrl) {
+    console.log(
+      'a recommending comment has already been posted: ',
+      existingCommentUrl,
+    );
     return null;
   }
 
@@ -39,7 +40,10 @@ export async function getCommentContent(
   ).data;
 
   const numberOfComments = comments.length + reviewComments.length;
-  if (numberOfComments < args.threshold) {
+  console.log('number of the obtained comments is ', numberOfComments);
+
+  if (numberOfComments < threshold) {
+    console.log("It's not necessary to send a recommending comment yet.");
     return null;
   }
 
@@ -54,7 +58,5 @@ export async function getCommentContent(
 
   return {
     logins,
-    numberOfComments,
-    threshold: args.threshold,
   };
 }
diff --git a/src/comments/getExistingCommentUrl.ts b/src/comments/getExistingCommentUrl.ts
new file mode 100644
index 0000000..b8ec11c
--- /dev/null
+++ b/src/comments/getExistingCommentUrl.ts
@@ -0,0 +1,9 @@
+import { type Comment } from './types';
+import { ACTION_IDENTIFY_TEXT } from './constants';
+
+export function getExistingCommentUrl(comments: Comment[]): string | undefined {
+  const comment = comments.find((comment) =>
+    comment.body?.startsWith(ACTION_IDENTIFY_TEXT),
+  );
+  return comment?.html_url;
+}
diff --git a/src/comments/isAlreadyCommented.ts b/src/comments/isAlreadyCommented.ts
deleted file mode 100644
index f4550a4..0000000
--- a/src/comments/isAlreadyCommented.ts
+++ /dev/null
@@ -1,8 +0,0 @@
-import { type Comment } from './types';
-import { ACTION_IDENTIFY_TEXT } from './constants';
-
-export function isAlreadyCommented(comments: Comment[]): boolean {
-  return comments.some((comment) =>
-    comment.body?.startsWith(ACTION_IDENTIFY_TEXT),
-  );
-}
diff --git a/src/comments/postComment.ts b/src/comments/postComment.ts
index 02329fd..c75ae4a 100644
--- a/src/comments/postComment.ts
+++ b/src/comments/postComment.ts
@@ -1,3 +1,4 @@
+import { setFailed } from '@actions/core';
 import { ACTION_IDENTIFY_TEXT } from './constants';
 import {
   type CommentContent,
@@ -12,22 +13,11 @@ Hey ${content.logins.map((login) => '@' + login).join(', ')}!
 It seems the discussion is dragging on. Perhaps instead of text communication, you could try having a conversation via face-to-face or video call, or even try mob programming?
 `;
 }
-function debugText(content: CommentContent) {
-  return `
-<details>
-<summary>number of comments</summary>
-the number of the comments is ${content.numberOfComments}
-threshold: ${content.threshold}
-</details>
-`;
-}
 
 function getText(content: CommentContent) {
   return `${ACTION_IDENTIFY_TEXT}
 
 ${MainText(content)}
-
-${debugText(content)}
 `;
 }
 
@@ -38,10 +28,20 @@ export async function postComment(
 ) {
   const { owner, repo, prNumber } = octokitContext;
 
-  await octokit.rest.issues.createComment({
-    owner,
-    repo,
-    issue_number: prNumber,
-    body: getText(content),
-  });
+  try {
+    const result = await octokit.rest.issues.createComment({
+      owner,
+      repo,
+      issue_number: prNumber,
+      body: getText(content),
+    });
+
+    console.log(
+      'a recommending comment has been posted: ',
+      result.data.html_url,
+    );
+  } catch (error) {
+    console.error(error);
+    setFailed('failed to post comment');
+  }
 }
diff --git a/src/comments/types.ts b/src/comments/types.ts
index b56e009..0c05ce4 100644
--- a/src/comments/types.ts
+++ b/src/comments/types.ts
@@ -19,11 +19,9 @@ export type User = {
 export type Comment = {
   user: User | null;
   body?: string;
+  html_url: string;
 };
 
 export type CommentContent = {
   logins: string[];
-
-  numberOfComments: number;
-  threshold: number;
 };
diff --git a/src/main.ts b/src/main.ts
index 39233a7..8026810 100644
--- a/src/main.ts
+++ b/src/main.ts
@@ -13,19 +13,17 @@ export async function run(): Promise<void> {
     const { token, prNumber, threshold } = getOption();
 
     const octokit = getOctokit(token);
-    const owner = context.repo.owner;
-    const repo = context.repo.repo;
     const octokitContext: OctokitContext = {
       owner: context.repo.owner,
       repo: context.repo.repo,
       prNumber,
     };
 
-    core.debug(`owner: ${owner}, repo: ${repo}, PR #${prNumber}`);
-
-    const commentContent = await getCommentContent(octokit, octokitContext, {
+    const commentContent = await getCommentContent(
+      octokit,
+      octokitContext,
       threshold,
-    });
+    );
 
     if (commentContent) {
       await postComment(octokit, octokitContext, commentContent);