v1.4.0

must match all labels to pass

CHANGELOG.md

@@ -1,5 +1,19 @@
 ### Changelog
 
+#### [v1.4.0](https://git.w33ble.com/w33ble/gh-action-bot/compare/v1.3.2...v1.4.0) (1 March 2019)
+- feat: make comment page count configurable [`ad3ebec`](https://git.w33ble.com/w33ble/gh-action-bot/commit/ad3ebecb6271037283b74686adbb49767f020988)
+- feat: check for pending status after comment [`1863239`](https://git.w33ble.com/w33ble/gh-action-bot/commit/1863239c062de3a730adb6dad67208699056f630)
+- feat: enhance history module [`5e94621`](https://git.w33ble.com/w33ble/gh-action-bot/commit/5e946213ba3968b6f8d4aacd078c145f9e225038)
+- feat: add 'exec and check' helper [`de77cd3`](https://git.w33ble.com/w33ble/gh-action-bot/commit/de77cd381bc74a53ee0f90ed9675ba1b0b200e68)
+- feat: support skipping based on labels [`08bd36c`](https://git.w33ble.com/w33ble/gh-action-bot/commit/08bd36c133a4f79d32af199ab829f305a599e06a)
+- fix: don't truncate all history when max is hit [`bd42c4c`](https://git.w33ble.com/w33ble/gh-action-bot/commit/bd42c4c415cfd15d48a957fa8d64f6dd8c2227c5)
+- fix: remove comment delete delay [`d19ab86`](https://git.w33ble.com/w33ble/gh-action-bot/commit/d19ab86a68483813947f2cd21d61d9c15dbef125)
+- feat: allow custom comment delete delay [`5c842ec`](https://git.w33ble.com/w33ble/gh-action-bot/commit/5c842eccff1fe29c07f774b1a76c3c35a4bd9aa8)
+- feat: allow customizing history json filename [`7bf6ff3`](https://git.w33ble.com/w33ble/gh-action-bot/commit/7bf6ff373d315f506e4823b9bfa78ce980731dfa)
+- feat: add slight delay before removing pull comment [`0147ab1`](https://git.w33ble.com/w33ble/gh-action-bot/commit/0147ab1d9da3a4fe3a194bf08be0a112bfbfd402)
+- fix: hide debugging output when value is '0' [`8bdab1f`](https://git.w33ble.com/w33ble/gh-action-bot/commit/8bdab1f9dbac3ad4c0933f5c859cc968d3d47a29)
+- feat: support multiple matching labels [`e8959ee`](https://git.w33ble.com/w33ble/gh-action-bot/commit/e8959eea141ba523a96a538d6f32b0f8c8cccbd6)
+
 #### [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)
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gh-action-bot",
-  "version": "1.3.2",
+  "version": "1.4.0",
   "private": true,
   "description": "Action bot for Github",
   "main": "index",

src/index.mjs

@@ -6,11 +6,14 @@ import getPull from './lib/get_pull.mjs';
 import getCommits from './lib/get_commits.mjs';
 import getCommitStatus from './lib/get_commit_status.mjs';
 import createPullComment from './lib/create_pull_comment.mjs';
+import execAndCheck from './lib/exec_and_check.mjs';
 import History from './lib/history.mjs';
 
 // load env vars from .env file
 dotenv.config();
 
+const sleep = async ms => new Promise(resolve => setTimeout(resolve, ms));
+
 async function ghActionBot() {
   // parse repo name from cli and create repo instance
   const repo = createRepo(process.argv.splice(2)[0]);
@@ -20,8 +23,10 @@ async function ghActionBot() {
     COMMENT_BODY_REGEXP_FLAGS,
     COMMENT_ACTOR,
     PULL_LABEL_FILTER,
+    PULL_LABEL_EXCLUDE,
     PULL_AUTHOR_FILTER,
     PULL_RETEST_BODY,
+    ACTION_RETRY_DELAY = 3000,
   } = process.env;
 
   // load the history module
@@ -58,7 +63,7 @@ async function ghActionBot() {
       }
 
       // filter on label
-      if (PULL_LABEL_FILTER && !pull.labels.includes(PULL_LABEL_FILTER)) {
+      if (!PULL_LABEL_FILTER.split(',').every(label => pull.labels.includes(label))) {
         logger.debug(
           `SKIP PULL #${
             pull.number
@@ -67,6 +72,17 @@ async function ghActionBot() {
         return false;
       }
 
+      // filter out matching exclusion tags
+      if (PULL_LABEL_EXCLUDE) {
+        const exclude = PULL_LABEL_EXCLUDE.split(',').some(label => pull.labels.includes(label));
+        if (exclude) {
+          logger.debug(
+            `SKIP PULL #${pull.number}: label matches exclusion labels '${PULL_LABEL_EXCLUDE}'`
+          );
+          return false;
+        }
+      }
+
       return { comment, pull };
     })
   )).filter(Boolean);
@@ -90,7 +106,23 @@ async function ghActionBot() {
 
   await Promise.all(
     records.map(record =>
-      createPullComment(repo, record.pull.number, PULL_RETEST_BODY, { delete: true })
+      execAndCheck(
+        () => createPullComment(repo, record.pull.number, PULL_RETEST_BODY, { delete: true }),
+        async () => {
+          logger.debug(`CHECK #${record.pull.number}: verify state change`);
+
+          // wait for the ci to restart
+          await sleep(ACTION_RETRY_DELAY);
+
+          // check that the commit status is now pending
+          const buildStatus = await getCommitStatus(repo, record.commit.sha);
+          return buildStatus.state === 'pending';
+        },
+        () => {
+          history.remove(record.comment);
+          logger.error(`Pull comment failed to trigger action on pull #${record.pull.number}`);
+        }
+      )
     )
   );
 }

src/lib/exec_and_check.mjs

@@ -1,4 +1,4 @@
-export default async function execAndCheck(fn, test, onFailure = () => {}, opts = { tries: 3 }) {
+export default async function execAndCheck(fn, test, onFailure = () => {}) {
   let count = 0;
 
   const tryExec = async () => {
@@ -9,9 +9,11 @@ export default async function execAndCheck(fn, test, onFailure = () => {}, opts
     const res = await test();
     if (res) return;
 
+    const { ACTION_RETRY_COUNT = 3 } = process.env;
+
     // if retry limit is hit, call failure function
     count += 1;
-    if (count >= opts.tries) return onFailure(); // eslint-disable-line consistent-return
+    if (count >= ACTION_RETRY_COUNT) return onFailure(); // eslint-disable-line consistent-return
 
     // retry the function and retest the results
     return tryExec(); // eslint-disable-line consistent-return

src/lib/get_comments.mjs

@@ -5,20 +5,30 @@ function truncate(str, len = 26) {
   return `${str.slice(0, len)}...`;
 }
 
-export default async function getEvents(repo, { body, actor } = {}) {
-  const events = await repo.events.fetch();
+const getCommentEvents = async (repo, lastEvents) => {
+  // just fetch and return the results
+  if (lastEvents == null) return repo.events.fetch();
 
-  const items = await (async () => {
-    // process 2 pages of events
-    if (events.nextPage) {
-      const moreEvents = await events.nextPage.fetch();
-      return [...events.items, ...moreEvents.items];
-    }
+  // if there is no next page, just return the passed in object
+  if (!lastEvents.nextPage) return lastEvents;
 
-    return events.items;
-  })();
+  // fetch next items and append previous ones
+  const newEvents = await lastEvents.nextPage.fetch();
+  newEvents.items = [...lastEvents.items, ...newEvents.items];
+  return newEvents;
+};
 
-  return items
+export default async function getEvents(repo, { body, actor, pages = 4 } = {}) {
+  // create a task array that we can reduce into a promise chain
+  const chain = [];
+  while (chain.length < pages) chain.push('page');
+
+  const events = await chain.reduce(
+    acc => acc.then(res => getCommentEvents(repo, res)),
+    Promise.resolve()
+  );
+
+  return events.items
     .map(comment => {
       let skip = false;
       const isComment = comment.type === 'IssueCommentEvent';

src/lib/history.mjs

@@ -5,8 +5,8 @@ const MAX_ITEMS = 1000; // max entries in history
 const TRUNCATE_AMOUNT = 200; // count of entries to remove when max is hit
 
 export default class History {
-  constructor() {
-    this.filePath = path.resolve('data', 'history.json');
+  constructor(filename = 'history.json') {
+    this.filePath = path.resolve('data', filename);
     try {
       const data = fs.readFileSync(this.filePath);
       this.db = data.length === 0 ? [] : JSON.parse(data);

src/lib/logger.mjs

@@ -35,7 +35,7 @@ const logger = {
     console.error(wrapMessage(args));
   },
   debug(...args) {
-    if (!process.env.DEBUG) return;
+    if (process.env.DEBUG === '0' || !process.env.DEBUG) return;
     console.log(wrapMessage(args));
   },
 };