feat: allow custom comment delete delay

so they can be skipped in subsequent runs

CHANGELOG.md

@@ -1,5 +1,23 @@
 ### Changelog
 
+#### [v1.3.2](https://git.w33ble.com/w33ble/gh-action-bot/compare/v1.3.1...v1.3.2) (25 October 2018)
+- fix: correct month in log output [`07288be`](https://git.w33ble.com/w33ble/gh-action-bot/commit/07288bee33d6861aa53e88e856174868f37b1fd5)
+
+#### [v1.3.1](https://git.w33ble.com/w33ble/gh-action-bot/compare/v1.2.1...v1.3.1) (23 October 2018)
+- feat: add a clean command [`f3773f7`](https://git.w33ble.com/w33ble/gh-action-bot/commit/f3773f7ee7c0de42997a5b19cc5ee215da3f06ec)
+- feat: track processed, comments [`31b55fc`](https://git.w33ble.com/w33ble/gh-action-bot/commit/31b55fc7c2d7042e428a12f04124e1c4cd63fd28)
+- docs: add clean script to readme [`b728b8e`](https://git.w33ble.com/w33ble/gh-action-bot/commit/b728b8ef50ee1a9b79f79ccc6b27f4acaf669d15)
+
+#### [v1.2.1](https://git.w33ble.com/w33ble/gh-action-bot/compare/v1.2.0...v1.2.1) (23 October 2018)
+- feat: add more debugging output [`3db973f`](https://git.w33ble.com/w33ble/gh-action-bot/commit/3db973febc5387605279f7855976a4ec431f0362)
+- fix: correctly handle errors in logger.error [`c70e8e4`](https://git.w33ble.com/w33ble/gh-action-bot/commit/c70e8e49ecb9041b22a8f4b92398339d45871ca1)
+- fix: correctly check for pr author [`f4c3e02`](https://git.w33ble.com/w33ble/gh-action-bot/commit/f4c3e02c1a31aea89a565f5685dd3b879bd38b14)
+
+#### [v1.2.0](https://git.w33ble.com/w33ble/gh-action-bot/compare/v1.1.0...v1.2.0) (23 October 2018)
+- feat: add debugging output to script [`0dce327`](https://git.w33ble.com/w33ble/gh-action-bot/commit/0dce32781b0f8c138d7f8b28382289d67be730dd)
+- feat: debug logging and better timestamps [`08799b4`](https://git.w33ble.com/w33ble/gh-action-bot/commit/08799b48d74d12266d5ebb85811f5d3fa046b086)
+- docs: add note about using DEBUG=1 output [`872d9c7`](https://git.w33ble.com/w33ble/gh-action-bot/commit/872d9c790fc723f1b255536225be60f547cf5196)
+
 #### [v1.1.0](https://git.w33ble.com/w33ble/gh-action-bot/compare/v1.0.1...v1.1.0) (22 October 2018)
 - feat: add timestamp to log output [`725638e`](https://git.w33ble.com/w33ble/gh-action-bot/commit/725638ee6b7fbb816518239f5524f6c37056da2e)
 

README.md

@@ -11,12 +11,18 @@ Action bot for Github. Checks a repo's event stream and leaves a ghost comment w
 
 `yarn run force owner/repo pr_number`: force a comment on a specific pr, by number
 
+`yanr run clean owner/repo pr_number`: removed any comments that match the owner and body requirements
+
 You'll need to set some environment flags. Check `sample-env` for what is available, and you can copy the file to `.env` in the root and add your settings there as well.
 
 ### Personal Access Token
 
 You will need to provide a Github [Personal Access Token](https://github.com/settings/tokens/new). It will need `write:org` access in order to create comments.
 
+### Debugging
+
+If the script isn't doing what you expect, you can get more output from it by prepending the script with `DEBUG=1`.
+
 #### License
 
 MIT © [w33ble](https://github.com/w33ble)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gh-action-bot",
-  "version": "1.1.0",
+  "version": "1.3.2",
   "private": true,
   "description": "Action bot for Github",
   "main": "index",
@@ -10,7 +10,8 @@
     "precommit": "lint-staged",
     "version": "auto-changelog -p && auto-authors && git add CHANGELOG.md AUTHORS.md",
     "start": "node .",
-    "force": "node -r esm src/force.mjs"
+    "force": "node -r esm src/force.mjs",
+    "clean": "node -r esm src/clean.mjs"
   },
   "repository": {
     "type": "git",

src/clean.mjs

@@ -0,0 +1,28 @@
+import dotenv from 'dotenv';
+import logger from './lib/logger.mjs';
+import createRepo from './lib/create_repo.mjs';
+import getPullComments from './lib/get_pull_comments.mjs';
+import { deleteComment } from './lib/comments.mjs';
+
+dotenv.config();
+
+async function forceRetest() {
+  const [ownerRepo, prNumber] = process.argv.splice(2);
+  const { COMMENT_BODY_REGEXP, COMMENT_BODY_REGEXP_FLAGS, COMMENT_ACTOR } = process.env;
+
+  if (!ownerRepo || !prNumber) {
+    throw new Error('You must specify an owner/repo combo and a pull request number');
+  }
+
+  const repo = createRepo(ownerRepo);
+
+  const comments = await getPullComments(repo, prNumber);
+  const bodyRegexp = new RegExp(COMMENT_BODY_REGEXP, COMMENT_BODY_REGEXP_FLAGS);
+  comments
+    .filter(comment => bodyRegexp.test(comment.body) && comment.owner === COMMENT_ACTOR)
+    .forEach(async comment => {
+      await deleteComment(repo, comment.id);
+    });
+}
+
+forceRetest().catch(err => logger.error(err));

src/force.mjs

@@ -1,6 +1,7 @@
 import dotenv from 'dotenv';
+import logger from './lib/logger.mjs';
 import createRepo from './lib/create_repo.mjs';
-import { createComment, deleteComment } from './lib/comments.mjs';
+import createPullComment from './lib/create_pull_comment.mjs';
 
 dotenv.config();
 
@@ -13,8 +14,7 @@ async function forceRetest() {
   }
 
   const repo = createRepo(ownerRepo);
-  const comment = await createComment(repo, prNumber, PULL_RETEST_BODY);
+  await createPullComment(repo, prNumber, PULL_RETEST_BODY, { delete: true });
-  await deleteComment(repo, comment.id);
 }
 
-forceRetest().catch(err => console.error(err));
+forceRetest().catch(err => logger.error(err));

src/index.mjs

@@ -5,7 +5,7 @@ import getComments from './lib/get_comments.mjs';
 import getPull from './lib/get_pull.mjs';
 import getCommits from './lib/get_commits.mjs';
 import getCommitStatus from './lib/get_commit_status.mjs';
-import { createComment, deleteComment } from './lib/comments.mjs';
+import createPullComment from './lib/create_pull_comment.mjs';
 import History from './lib/history.mjs';
 
 // load env vars from .env file
@@ -31,16 +31,30 @@ async function ghActionBot() {
   const comments = (await getComments(repo, {
     body: new RegExp(COMMENT_BODY_REGEXP, COMMENT_BODY_REGEXP_FLAGS),
     actor: COMMENT_ACTOR,
-  })).filter(comment => !history.get(comment.id));
+  })).filter(comment => !history.get(comment.id)); // skip comments already processed
+
+  if (comments.length) logger.debug(`Found ${comments.length} comments to process`);
 
   // read pull data
   const pulls = (await Promise.all(
     comments.map(async comment => {
+      // keep track of comments that have been processed
+      history.add(comment);
+
       const pull = await getPull(repo, comment.number);
 
-      if (pull.state !== 'open') return false; // filter out any closed pulls
+      if (pull.state !== 'open') {
-      if (PULL_AUTHOR_FILTER && !pull.owner !== PULL_AUTHOR_FILTER) return false; // filter on owner
+        logger.debug(`SKIP #${pull.number}: state is ${pull.state}`);
-      if (PULL_LABEL_FILTER && !pull.labels.includes(PULL_LABEL_FILTER)) return false; // filter on label
+        return false; // filter out any closed pulls
+      }
+      if (PULL_AUTHOR_FILTER && pull.owner !== PULL_AUTHOR_FILTER) {
+        logger.debug(`SKIP #${pull.number}: author is ${pull.owner}`);
+        return false; // filter on owner
+      }
+      if (PULL_LABEL_FILTER && !pull.labels.includes(PULL_LABEL_FILTER)) {
+        logger.debug(`SKIP #${pull.number}: labels are ${pull.labels.join(',')}`);
+        return false; // filter on label
+      }
 
       return { comment, pull };
     })
@@ -51,20 +65,24 @@ async function ghActionBot() {
       const commit = await getCommits(repo, pull.number, true);
       const buildStatus = await getCommitStatus(repo, commit.sha);
       // do nothing if the build has not started, or is pending or successful
-      if (!buildStatus || buildStatus.state === 'pending' || buildStatus.state === 'success')
+      if (!buildStatus || buildStatus.state === 'pending' || buildStatus.state === 'success') {
+        logger.debug(`SKIP #${pull.number}: build status is ${buildStatus.state}`);
         return false;
+      }
       return { comment, pull, commit, buildStatus };
     })
   )).filter(Boolean);
 
+  if (records.length) {
     logger.log(`Found ${records.length} outstanding failures`);
+  } else {
+    logger.debug(`Found ${records.length} outstanding failures`);
+  }
 
   await Promise.all(
-    records.map(async record => {
+    records.map(record =>
-      logger.log(`Re-testing PR #${record.pull.number}`);
+      createPullComment(repo, record.pull.number, PULL_RETEST_BODY, { delete: true })
-      const comment = await createComment(repo, records[0].pull.number, PULL_RETEST_BODY);
+    )
-      await deleteComment(repo, comment.id);
-    })
   );
 }
 

src/lib/comments.mjs

@@ -1,7 +1,12 @@
+import logger from './logger.mjs';
+
 export async function createComment(repo, issueId, body) {
   return repo.issues(issueId).comments.create({ body });
 }
 
 export async function deleteComment(repo, commentId) {
-  return repo.issues.comments(commentId).remove();
+  const res = await repo.issues.comments(commentId).remove();
+  if (res) logger.debug(`Comment ${commentId} deleted`);
+  else logger.error(new Error(`Failed to remove comment ${commentId}`));
+  return res;
 }

src/lib/create_pull_comment.mjs

@@ -0,0 +1,19 @@
+import logger from './logger.mjs';
+import { createComment, deleteComment } from './comments.mjs';
+
+const sleep = async ms => new Promise(resolve => setTimeout(resolve, ms));
+
+export default async function createPullComment(repo, number, body, opts = {}) {
+  logger.log(`Adding comment to PR #${number}`);
+  const comment = await createComment(repo, number, body);
+  logger.debug(`Created comment id ${comment.id}`);
+
+  const options = Object.assign({ delete: false, delay: 250 }, opts);
+
+  if (options.delete) {
+    await sleep(options.delay);
+    await deleteComment(repo, comment.id);
+  }
+
+  return comment.id;
+}

src/lib/get_comments.mjs

@@ -1,3 +1,5 @@
+import logger from './logger.mjs';
+
 export default async function getEvents(repo, { body, actor } = {}) {
   const events = await repo.events.fetch();
 
@@ -13,11 +15,30 @@ export default async function getEvents(repo, { body, actor } = {}) {
 
   return items
     .map(comment => {
-      // only comments created by specific user
+      let skip = false;
-      if (comment.type !== 'IssueCommentEvent') return false;
+      const isComment = comment.type === 'IssueCommentEvent';
-      if (comment.payload.action !== 'created') return false;
+      const bodyMatch = isComment && (!body || body.test(comment.payload.comment.body));
-      if (comment.actor.login !== actor) return false;
+      const isActor = comment.actor.login === actor;
-      if (body && !body.test(comment.payload.comment.body)) return false;
+
+      // skip events that don't match the criteria
+      if (!isComment) skip = true;
+      if (comment.payload.action !== 'created') skip = true;
+      if (!isActor) skip = true;
+      if (isComment && !bodyMatch) skip = true;
+
+      if (skip) {
+        if (isActor) {
+          logger.debug(
+            `SKIP EVENT ${isComment ? `#${comment.payload.issue.number}` : comment.id}: ${
+              comment.type
+            } ${comment.payload.action} by ${comment.actor.login}`,
+            isComment && !bodyMatch && `(${comment.payload.comment.body.slice(0, 30)})`
+          );
+        }
+        return false;
+      }
+
+      logger.debug(`PROCESS #${comment.payload.issue.number}`);
 
       return {
         id: comment.id,

src/lib/get_pull_comments.mjs

@@ -0,0 +1,9 @@
+export default async function getPull(repo, id) {
+  const { items } = await repo.issues(id).comments.fetch();
+
+  return items.map(item => ({
+    id: item.id,
+    owner: item.user.login,
+    body: item.body,
+  }));
+}

src/lib/logger.mjs

@@ -1,5 +1,24 @@
 /* eslint no-console: 0 */
-const wrapMessage = msg => `${new Date()}: ${msg.join(' ')}`;
+const zeroPad = (str, len) => {
+  let output = `${str}`;
+  if (!len || len <= output.length) return str;
+
+  while (output.length < len) {
+    output = `0${output}`;
+  }
+  return output;
+};
+
+const getTimestamp = () => {
+  const d = new Date();
+  return `${[d.getFullYear(), zeroPad(d.getMonth() + 1, 2), zeroPad(d.getDate(), 2)].join('/')} ${[
+    zeroPad(d.getHours(), 2),
+    zeroPad(d.getMinutes(), 2),
+    zeroPad(d.getSeconds(), 2),
+  ].join(':')}`;
+};
+
+const wrapMessage = msg => `[${getTimestamp()}]: ${msg.join(' ')}`;
 
 const logger = {
   log(...args) {
@@ -9,8 +28,16 @@ const logger = {
     console.warn(wrapMessage(args));
   },
   error(...args) {
+    if (args[0] instanceof Error) {
+      console.error(getTimestamp(), args[0].stack);
+      return;
+    }
     console.error(wrapMessage(args));
   },
+  debug(...args) {
+    if (!process.env.DEBUG) return;
+    console.log(wrapMessage(args));
+  },
 };
 
 export default logger;