1.3.0

also show error when comment isn't deleted

CHANGELOG.md

@@ -1,5 +1,15 @@
 ### Changelog
 
+#### [v1.3.0](https://git.w33ble.com/w33ble/gh-action-bot/compare/v1.2.1...v1.3.0) (23 October 2018)
+- feat: add a clean command [`e8e252f`](https://git.w33ble.com/w33ble/gh-action-bot/commit/e8e252f73c315663a6cc79336c914615bdfe1ad5)
+- chroe: user logger on force errors [`41d7905`](https://git.w33ble.com/w33ble/gh-action-bot/commit/41d79051f8550f428ea41505ab4740caa0509e93)
+- docs: add clean script to readme [`a8800d1`](https://git.w33ble.com/w33ble/gh-action-bot/commit/a8800d1593f5cbd4fb5a90a895bcc88aa004e892)
+
+#### [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)

README.md

@@ -11,6 +11,8 @@ 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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gh-action-bot",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "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,30 @@
+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 => {
+      const res = await deleteComment(repo, comment.id);
+      if (res) logger.debug(`Comment ${comment.id} deleted`);
+      else logger.error(new Error(`Failed to remove comment ${comment.id}`));
+    });
+}
+
+forceRetest().catch(err => logger.error(err));

src/force.mjs

@@ -1,4 +1,5 @@
 import dotenv from 'dotenv';
+import logger from './lib/logger.mjs';
 import createRepo from './lib/create_repo.mjs';
 import { createComment, deleteComment } from './lib/comments.mjs';
 
@@ -14,7 +15,9 @@ async function forceRetest() {
 
   const repo = createRepo(ownerRepo);
   const comment = await createComment(repo, prNumber, PULL_RETEST_BODY);
-  await deleteComment(repo, comment.id);
+  const res = await deleteComment(repo, comment.id);
+  if (res) logger.debug(`Comment ${comment.id} deleted`);
+  else logger.error(new Error(`Failed to remove comment ${comment.id}`));
 }
 
-forceRetest().catch(err => console.error(err));
+forceRetest().catch(err => logger.error(err));

src/index.mjs

@@ -42,7 +42,7 @@ async function ghActionBot() {
         logger.debug(`SKIP #${pull.number}: state is ${pull.state}`);
         return false; // filter out any closed pulls
       }
-      if (PULL_AUTHOR_FILTER && !pull.owner !== PULL_AUTHOR_FILTER) {
+      if (PULL_AUTHOR_FILTER && pull.owner !== PULL_AUTHOR_FILTER) {
         logger.debug(`SKIP #${pull.number}: author is ${pull.owner}`);
         return false; // filter on owner
       }

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

@@ -9,16 +9,17 @@ const zeroPad = (str, len) => {
   return output;
 };
 
-const wrapMessage = msg => {
+const getTimestamp = () => {
   const d = new Date();
-  const timestamp = `${[d.getFullYear(), zeroPad(d.getMonth(), 2), zeroPad(d.getDate(), 2)].join(
+  return `${[d.getFullYear(), zeroPad(d.getMonth(), 2), zeroPad(d.getDate(), 2)].join('/')} ${[
-    '/'
+    zeroPad(d.getHours(), 2),
-  )} ${[zeroPad(d.getHours(), 2), zeroPad(d.getMinutes(), 2), zeroPad(d.getSeconds(), 2)].join(
+    zeroPad(d.getMinutes(), 2),
-    ':'
+    zeroPad(d.getSeconds(), 2),
-  )}`;
+  ].join(':')}`;
-  return `[${timestamp}]: ${msg.join(' ')}`;
 };
 
+const wrapMessage = msg => `[${getTimestamp()}]: ${msg.join(' ')}`;
+
 const logger = {
   log(...args) {
     console.log(wrapMessage(args));
@@ -27,6 +28,10 @@ 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) {