wuffle 0.73.1 → 0.73.2

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

@@ -1,3 +1,6 @@
+import { filterIssueOrPull } from '../filters.js';
+import { issueIdent } from '../util/meta.js';
+
 const DONE = 'DONE';
 const EXTERNAL_CONTRIBUTION = 'EXTERNAL_CONTRIBUTION';
 const IN_PROGRESS = 'IN_PROGRESS';
@@ -15,13 +18,40 @@ 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'
+  });
+
+  function ifEnabled(webhookHandlerFn) {
+
+    return (context) => {
+
+      const payload = context.payload;
+
+      const issueOrPull = filterIssueOrPull(
+        payload.issue || payload.pull_request,
+        payload.repository
+      );
+
+      if (issueFilter.isIgnored(issueOrPull)) {
+        log.debug({ issue: issueIdent(issueOrPull) }, 'issue matching ignore filter');
+
+        return;
+      }
+
+      return webhookHandlerFn(context);
+    };
+  }
 
   webhookEvents.on([
     'issues.closed',
     'pull_request.closed'
-  ], async (context) => {
+  ], ifEnabled(async (context) => {
 
     const {
       pull_request,
@@ -31,9 +61,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 +77,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 +103,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 +135,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 +146,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 +171,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/issue-filter/IssueFilter.js

@@ -0,0 +1,50 @@
+/**
+ * @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 IssueFilter(config, store, search, logger) {
+
+  const log = logger.child({
+    name: 'wuffle:issue-filter'
+  });
+
+  /**
+   * @type { import('../search/Search.js').FilterFn }
+   */
+  let ignoreFilter = (issue) => false;
+
+
+  if ('ignoreFilter' in config) {
+    const ignoreFilterFn = search.buildFilterFn(config.ignoreFilter);
+
+    if (ignoreFilterFn) {
+      ignoreFilter = ignoreFilterFn;
+
+      store.setIgnoreFilter(ignoreFilter);
+    } else {
+      log.warn('unparseable <ignoreFilter> - please correct your board configuration');
+    }
+  }
+
+  /**
+   * Figure whether the issue shall be ignored (by ignore filter rules)
+   *
+   * @param {any} issue
+   *
+   * @return {boolean} true, if issue shall be ignored
+   */
+  this.isIgnored = function(issue) {
+    return ignoreFilter(issue);
+  };
+
+}

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.2",
   "description": "A multi-repository task board for GitHub issues",
   "author": {
     "name": "Nico Rehwaldt",
@@ -81,6 +81,5 @@
     "app.yml",
     "index.js",
     "wuffle.config.example.js"
-  ],
-  "gitHead": "914903ed50d90df9a312a96c47ac66bf002604a9"
+  ]
 }

package/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2019-present Nico Rehwaldt
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
-of the Software, and to permit persons to whom the Software is furnished to do
-so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

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');
-    }
-  }
-
-}