wuffle 0.73.1 → 0.73.3

package/lib/apps/automatic-dev-flow.js

@@ -15,13 +15,21 @@ const CHANGES_REQUESTED = 'changes_requested';
  * @param {import('./webhook-events/WebhookEvents.js').default} webhookEvents
  * @param {import('./github-issues/GithubIssues.js').default} githubIssues
  * @param {import('../columns.js').default} columns
+ * @param {import('./issue-filter/IssueFilter.js').default} issueFilter
+ * @param {import('../types.js').Logger } logger
  */
-export default function(webhookEvents, githubIssues, columns) {
+export default function(webhookEvents, githubIssues, columns, issueFilter, logger) {
+
+  const log = logger.child({
+    name: 'wuffle:automatic-dev-flow'
+  });
+
+  const ifEnabled = issueFilter.createWebhookFilter(log);
 
   webhookEvents.on([
     'issues.closed',
     'pull_request.closed'
-  ], async (context) => {
+  ], ifEnabled(async (context) => {
 
     const {
       pull_request,
@@ -31,9 +39,9 @@ export default function(webhookEvents, githubIssues, columns) {
     const column = columns.getByState(DONE);
 
     await githubIssues.moveIssue(context, issue || pull_request, column);
-  });
+  }));
 
-  webhookEvents.on('pull_request.converted_to_draft', async (context) => {
+  webhookEvents.on('pull_request.converted_to_draft', ifEnabled(async (context) => {
 
     const {
       pull_request
@@ -47,12 +55,12 @@ export default function(webhookEvents, githubIssues, columns) {
       githubIssues.moveIssue(context, pull_request, column),
       githubIssues.moveReferencedIssues(context, pull_request, column)
     ]);
-  });
+  }));
 
   webhookEvents.on([
     'pull_request.ready_for_review',
     'pull_request.review_requested'
-  ], async (context) => {
+  ], ifEnabled(async (context) => {
 
     const {
       pull_request,
@@ -73,12 +81,12 @@ export default function(webhookEvents, githubIssues, columns) {
       githubIssues.moveIssue(context, pull_request, column),
       githubIssues.moveReferencedIssues(context, pull_request, column)
     ]);
-  });
+  }));
 
   webhookEvents.on([
     'pull_request.opened',
     'pull_request.reopened'
-  ], async (context) => {
+  ], ifEnabled(async (context) => {
 
     const {
       pull_request
@@ -105,9 +113,9 @@ export default function(webhookEvents, githubIssues, columns) {
       githubIssues.moveIssue(context, pull_request, column, newAssignee),
       githubIssues.moveReferencedIssues(context, pull_request, column, newAssignee)
     ]);
-  });
+  }));
 
-  webhookEvents.on('pull_request.edited', async (context) => {
+  webhookEvents.on('pull_request.edited', ifEnabled(async (context) => {
 
     const {
       pull_request
@@ -116,9 +124,9 @@ export default function(webhookEvents, githubIssues, columns) {
     const column = columns.getIssueColumn(pull_request);
 
     await githubIssues.moveReferencedIssues(context, pull_request, column);
-  });
+  }));
 
-  webhookEvents.on('pull_request_review.submitted', async (context) => {
+  webhookEvents.on('pull_request_review.submitted', ifEnabled(async (context) => {
 
     const {
       pull_request,
@@ -141,7 +149,7 @@ export default function(webhookEvents, githubIssues, columns) {
       githubIssues.moveIssue(context, pull_request, column),
       githubIssues.moveReferencedIssues(context, pull_request, column)
     ]);
-  });
+  }));
 
   webhookEvents.on('create', async (context) => {
 

package/lib/apps/background-sync/BackgroundSync.js

@@ -217,25 +217,11 @@ We automatically synchronize all repositories you granted us access to via the G
 
               const update = filterIssueOrPull(issueOrPull, repository);
 
-              const {
-                id
-              } = update;
+              foundIssues[update.id] = update;
 
-              const existingIssue = await store.getIssueById(id);
-
-              if (existingIssue && existingIssue.updated_at >= update.updated_at) {
-                foundIssues[id] = null;
-
-                log.debug({
-                  [type]: `${owner}/${repo}#${issueOrPull.number}`
-                }, 'skipping, as up-to-date');
-              } else {
-                foundIssues[id] = update;
-
-                log.debug({
-                  [type]: `${owner}/${repo}#${issueOrPull.number}`
-                }, 'scheduled for update');
-              }
+              log.debug({
+                [type]: `${owner}/${repo}#${issueOrPull.number}`
+              }, 'scheduled for update');
             } catch (err) {
               log.error({
                 err,
@@ -395,12 +381,21 @@ We automatically synchronize all repositories you granted us access to via the G
 
     // update changed issues
 
-    await Promise.all(pendingUpdates.map(update => store.updateIssue(update)));
+    const updateTasks = pendingUpdates.map(
+      update => store.updateIssue(update)
+    );
+
+    // returns the update for updated issues or undefined
+    // where issues were not stored (filtered out) - we only filter
+    // for actual updated issues
+    const updatedIssues = await Promise.all(updateTasks).then(updates => {
+      return updates.filter(update => update);
+    });
 
-    // emit background sync event for all found issues
+    // emit background sync event for all updated issues
 
     await syncDetails(
-      Object.keys(foundIssues),
+      updatedIssues,
       getSyncClosedDetailsSince(),
       getSyncOpenDetailsSince()
     );
@@ -437,10 +432,12 @@ We automatically synchronize all repositories you granted us access to via the G
     );
   }
 
-  function syncDetails(issueIds, syncClosedSince, syncOpenSince) {
+  function syncDetails(updatedIssues, syncClosedSince, syncOpenSince) {
+
+    const jobs = updatedIssues.map(async updatedIssue => {
 
-    const jobs = issueIds.map(async id => {
-      const issue = await store.getIssueById(id);
+      // ensure we fetch latest version of issue (to prevent de-sync)
+      const issue = await store.getIssueById(updatedIssue.id);
 
       if (!issue) {
         return;

package/lib/apps/github-comments/GithubComments.js

@@ -12,8 +12,16 @@ import gql from 'fake-tag';
  * @param {import('../../events.js').default} events
  * @param {import('../github-client/GithubClient.js').default} githubClient
  * @param {import('../../store.js').default} store
+ * @param {import('../issue-filter/IssueFilter.js').default} issueFilter
+ * @param {import('../../types.js').Logger } logger
  */
-export default function GithubComments(webhookEvents, events, githubClient, store) {
+export default function GithubComments(webhookEvents, events, githubClient, store, issueFilter, logger) {
+
+  const log = logger.child({
+    name: 'wuffle:github-comments'
+  });
+
+  const ifEnabled = issueFilter.createWebhookFilter(log);
 
   // issues /////////////////////
 
@@ -108,7 +116,7 @@ export default function GithubComments(webhookEvents, events, githubClient, stor
 
   webhookEvents.on([
     'issue_comment'
-  ], async ({ payload }) => {
+  ], ifEnabled(async ({ payload }) => {
     const {
       action,
       comment: _comment,
@@ -169,7 +177,7 @@ export default function GithubComments(webhookEvents, events, githubClient, stor
       ...commentedIssue,
       comments
     });
-  });
+  }));
 
 }
 

package/lib/apps/github-reviews/GithubReviews.js

@@ -11,8 +11,16 @@ import { filterUser, filterPull } from '../../filters.js';
  * @param {import('../../events.js').default} events
  * @param {import('../github-client/GithubClient.js').default} githubClient
  * @param {import('../../store.js').default} store
+ * @param {import('../issue-filter/IssueFilter.js').default} issueFilter
+ * @param {import('../../types.js').Logger } logger
  */
-export default function GithubReviews(webhookEvents, events, githubClient, store) {
+export default function GithubReviews(webhookEvents, events, githubClient, store, issueFilter, logger) {
+
+  const log = logger.child({
+    name: 'wuffle:github-reviews'
+  });
+
+  const ifEnabled = issueFilter.createWebhookFilter(log);
 
   // issues /////////////////////
 
@@ -54,7 +62,7 @@ export default function GithubReviews(webhookEvents, events, githubClient, store
 
   webhookEvents.on([
     'pull_request_review'
-  ], async ({ payload }) => {
+  ], ifEnabled(async ({ payload }) => {
     const {
       action,
       review: _review,
@@ -102,7 +110,7 @@ export default function GithubReviews(webhookEvents, events, githubClient, store
       ...pull_request,
       reviews
     });
-  });
+  }));
 
 }
 

package/lib/apps/github-statuses/GithubStatuses.js

@@ -11,8 +11,16 @@ import { filterPull } from '../../filters.js';
  * @param {import('../../events.js').default} events
  * @param {import('../github-client/GithubClient.js').default} githubClient
  * @param {import('../../store.js').default} store
+ * @param {import('../issue-filter/IssueFilter.js').default} issueFilter
+ * @param {import('../../types.js').Logger } logger
  */
-export default function GithubStates(webhookEvents, events, githubClient, store) {
+export default function GithubStatuses(webhookEvents, events, githubClient, store, issueFilter, logger) {
+
+  const log = logger.child({
+    name: 'wuffle:github-statuses'
+  });
+
+  const ifEnabled = issueFilter.createWebhookFilter(log);
 
   // issues /////////////////////
 
@@ -89,7 +97,7 @@ export default function GithubStates(webhookEvents, events, githubClient, store)
   webhookEvents.on([
     'pull_request.opened',
     'pull_request.synchronize'
-  ], async ({ payload }) => {
+  ], ifEnabled(async ({ payload }) => {
 
     const {
       pull_request: _pull_request,
@@ -108,7 +116,7 @@ export default function GithubStates(webhookEvents, events, githubClient, store)
       id,
       statuses
     });
-  });
+  }));
 
   webhookEvents.on([
     'status'

package/lib/apps/issue-filter/IssueFilter.js

@@ -0,0 +1,85 @@
+/**
+ * @typedef { { ignoreFilter?: string } } StoreFilterConfig
+ */
+
+import { filterIssueOrPull } from '../../filters.js';
+import { issueIdent } from '../../util/meta.js';
+
+/**
+ * An component that configures the store to filter certain elements,
+ * effectively making them invisible to the board and its users.
+ *
+ * @param { StoreFilterConfig } config
+ * @param { import('../../store.js').default } store
+ * @param { import('../search/Search.js').default } search
+ * @param { import('../../types.js').Logger } logger
+ */
+export default function IssueFilter(config, store, search, logger) {
+
+  const log = logger.child({
+    name: 'wuffle:issue-filter'
+  });
+
+  /**
+   * @type { import('../search/Search.js').FilterFn }
+   */
+  let isIgnored = (issue) => false;
+
+
+  if ('ignoreFilter' in config) {
+    const ignoreFilterFn = search.buildFilterFn(config.ignoreFilter);
+
+    if (ignoreFilterFn) {
+      isIgnored = ignoreFilterFn;
+
+      store.setIgnoreFilter(isIgnored);
+    } else {
+      log.warn('unparseable <ignoreFilter> - please correct your board configuration');
+    }
+  }
+
+  /**
+   * @param {import('../../types.js').Logger } log
+   *
+   * @return { (filterFn) => (any) => any }
+   */
+  function createWebhookFilter(log) {
+
+    return function ifEnabled(webhookHandlerFn) {
+
+      return (context) => {
+
+        const payload = context.payload;
+
+        const issueOrPull = filterIssueOrPull(
+          payload.issue || payload.pull_request,
+          payload.repository
+        );
+
+        if (isIgnored(issueOrPull)) {
+          log.debug({ issue: issueIdent(issueOrPull) }, 'issue matching ignore filter');
+
+          return;
+        }
+
+        return webhookHandlerFn(context);
+      };
+    };
+  };
+
+  /**
+   * Figure whether the issue shall be ignored (by ignore filter rules)
+   *
+   * @param {any} issue
+   *
+   * @return {boolean} true, if issue shall be ignored
+   */
+  this.isIgnored = isIgnored;
+
+  /**
+   * @param {import('../../types.js').Logger } log
+   *
+   * @return { (filterFn) => (any) => any }
+   */
+  this.createWebhookFilter = createWebhookFilter;
+}

package/lib/apps/issue-filter/index.js

@@ -0,0 +1,5 @@
+import IssueFilter from './IssueFilter.js';
+
+export default {
+  issueFilter: [ 'type', IssueFilter ]
+};

package/lib/index.js

@@ -19,6 +19,7 @@ const appModules = [
   import('./apps/github-checks/index.js'),
   import('./apps/github-reviews/index.js'),
   import('./apps/github-statuses/index.js'),
+  import('./apps/issue-filter/index.js'),
   import('./apps/security-context/index.js'),
   import('./apps/user-access/index.js'),
   import('./apps/search/index.js'),
@@ -27,8 +28,7 @@ const appModules = [
   import('./apps/auth-routes/index.js'),
   import('./apps/board-api-routes/index.js'),
   import('./apps/board-routes.js'),
-  import('./apps/reindex-store.js'),
-  import('./apps/store-filter.js')
+  import('./apps/reindex-store.js')
 ];
 
 import loadConfig from './load-config.js';

package/lib/store.js

@@ -44,6 +44,8 @@ export default class Store {
 
     /**
      * @type { FilterFn }
+     *
+     * @private
      */
     this.ignoreFilter = (issue) => false;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wuffle",
-  "version": "0.73.1",
+  "version": "0.73.3",
   "description": "A multi-repository task board for GitHub issues",
   "author": {
     "name": "Nico Rehwaldt",
@@ -82,5 +82,5 @@
     "index.js",
     "wuffle.config.example.js"
   ],
-  "gitHead": "914903ed50d90df9a312a96c47ac66bf002604a9"
+  "gitHead": "1d7cdf09524102d300d6230b840959cdd1479e3e"
 }

package/lib/apps/store-filter.js

@@ -1,31 +0,0 @@
-/**
- * @typedef { { ignoreFilter?: string } } StoreFilterConfig
- */
-
-/**
- * An component that configures the store to filter certain elements,
- * effectively making them invisible to the board and its users.
- *
- * @param { StoreFilterConfig } config
- *
- * @param { import('../store.js').default } store
- * @param { import('./search/Search.js').default } search
- * @param { import('../types.js').Logger } logger
- */
-export default function StoreFilter(config, store, search, logger) {
-
-  const log = logger.child({
-    name: 'wuffle:store-filter'
-  });
-
-  if ('ignoreFilter' in config) {
-    const ignoreFilterFn = search.buildFilterFn(config.ignoreFilter);
-
-    if (ignoreFilterFn) {
-      store.setIgnoreFilter(ignoreFilterFn);
-    } else {
-      log.warn('unparseable <ignoreFilter> - please correct your board configuration');
-    }
-  }
-
-}