wuffle 0.72.0 → 0.73.0

package/lib/apps/search/Search.js

@@ -8,7 +8,11 @@ const CHILD_LINK_TYPES = {
 };
 
 /**
- * @typedef { { defaultFilter?: string, treatBotsAsReviewers?: boolean } } SearchConfig
+ * @typedef { {
+ *   defaultFilter?: string,
+ *   treatBotsAsReviewers?: boolean
+ * } } SearchConfig
+ *
  * @typedef { import('../../util/search.js').SearchTerm } SearchTerm
  *
  * @typedef { import('../../types.js').GitHubUser } GitHubUser
@@ -32,7 +36,8 @@ export default function Search(config, logger, store) {
   });
 
   const {
-    treatBotsAsReviewers = false
+    treatBotsAsReviewers = false,
+    defaultFilter
   } = config;
 
   function filterNoop(issue) {
@@ -446,9 +451,11 @@ export default function Search(config, logger, store) {
    */
   function getSearchFilter(search, user) {
 
-    const filterFn = buildFilterFn(search, user);
+    if (!search) {
+      search = defaultFilter;
+    }
 
-    const ignoreFilterFn = buildFilterFn(config.defaultFilter, user);
+    const filterFn = buildFilterFn(search, user);
 
     return function(issue) {
       try {
@@ -456,12 +463,7 @@ export default function Search(config, logger, store) {
           return filterFn(issue);
         }
 
-        if (ignoreFilterFn) {
-          return ignoreFilterFn(issue);
-        }
-
-        // no user search, no ignore filter,
-        // show all issues
+        // no search, show all issues
         return true;
       } catch (err) {
         log.warn({ issue: issueIdent(issue), err }, 'filter failed');
@@ -475,4 +477,6 @@ export default function Search(config, logger, store) {
   // api ///////////////////////
 
   this.getSearchFilter = getSearchFilter;
+
+  this.buildFilterFn = buildFilterFn;
 }

package/lib/apps/store-filter.js

@@ -0,0 +1,31 @@
+/**
+ * @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');
+    }
+  }
+
+}

package/lib/index.js

@@ -27,7 +27,8 @@ 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/reindex-store.js'),
+  import('./apps/store-filter.js')
 ];
 
 import loadConfig from './load-config.js';

package/lib/store.js

@@ -4,6 +4,9 @@ import { issueIdent } from './util/index.js';
 import { findLinks } from './util/links.js';
 import { Links } from './links.js';
 
+/**
+ * @typedef { import('./apps/search/Search.js').FilterFn } FilterFn
+ */
 
 /**
  * The store that holds all board data
@@ -39,6 +42,10 @@ export default class Store {
     this.updateContext = null;
     this.queuedUpdates = [];
 
+    /**
+     * @type { FilterFn }
+     */
+    this.ignoreFilter = (issue) => false;
 
     this.on('updateIssue', async event => {
 
@@ -303,7 +310,9 @@ export default class Store {
   /**
    * Update issue, tagging it as updated.
    *
-   * @return {Promise<Object>} promise to updated issue
+   * If issue matches the ignore filter it will be removed as part of the update.
+   *
+   * @return {Promise<Object|undefined>} a promise to the updated issue or undefined in case the update triggered issue deletion
    */
   updateIssue(update) {
 
@@ -374,6 +383,14 @@ export default class Store {
 
     const ident = issueIdent(updatedIssue);
 
+    if (this.ignoreFilter(updatedIssue)) {
+      this.log.debug({ issue: ident }, 'issue matching ignore filter');
+
+      await this.removeIssueById(id);
+
+      return null;
+    }
+
     this.log.debug({
       issue: ident
     }, 'process update');
@@ -861,6 +878,13 @@ export default class Store {
     }, 'load JSON complete');
   }
 
+  /**
+   * @param { FilterFn } ignoreFilter
+   */
+  setIgnoreFilter(ignoreFilter) {
+    this.ignoreFilter = ignoreFilter;
+  }
+
 }
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wuffle",
-  "version": "0.72.0",
+  "version": "0.73.0",
   "description": "A multi-repository task board for GitHub issues",
   "author": {
     "name": "Nico Rehwaldt",
@@ -82,5 +82,5 @@
     "index.js",
     "wuffle.config.example.js"
   ],
-  "gitHead": "f42a56e87fb1f6d3f06ef5e9215c5e0b91544c0b"
+  "gitHead": "a58cc7fcd73db7a1dc7babc25b97bb590119b69d"
 }

package/wuffle.config.example.js

@@ -1,47 +1,36 @@
 /**
  * This defines board specific configuration.
- *
- * ### Name
- *
- * The name of your board, displayed in the board header.
- *
- *
- * ### Description
- *
- * Optional description of the board, will be served with the board front-end
- * for SEO purposes.
- *
- *
- * ### Columns
- *
- * Valid fields for columns are
- *
- *  * name       - unique name
- *  * label      - label, if present on a GitHub issue column will be set
- *  * closed     - if the column issues must be closed
- *  * sorting    - true if column cards should be sorted
- *                 incrementally based on links
- *  * fifo       - true to turn the default column ordering from
- *                 last in first out to first in first out
- *  * states     - a list of board states to map to this column
- *
- * The default column is the column that holds open issues without
- * any label constraints (Inbox in the example below).
- *
- *
- * ### Search Config
- *
- * You may define a default filter to apply to the board if
- * there is no user-defined search query.
- *
- * You may also configure whether bots are counted as
- * legitimate reviewers (for both review and approval).
  */
 export default {
 
+  /**
+   * The name of your board, displayed in the board header.
+   */
   name: 'My Wuffle Board',
+
+  /**
+   * (Optional) description of the board, will be served with the board
+   * front-end for SEO purposes.
+   */
   description: 'This board organizes all my tasks',
 
+  /**
+   * Definitions of columns to display on the board, and their state.
+   *
+   * Valid fields for columns are
+   *
+   *  * name       - unique name
+   *  * label      - label, if present on a GitHub issue column will be set
+   *  * closed     - if the column issues must be closed
+   *  * sorting    - true if column cards should be sorted
+   *                 incrementally based on links
+   *  * fifo       - true to turn the default column ordering from
+   *                 last in first out to first in first out
+   *  * states     - a list of board states to map to this column
+   *
+   * The default column is the column that holds open issues without
+   * any label constraints (Inbox in the example below).
+   */
   columns: [
     { name: 'Inbox', label: null },
     { name: 'Backlog', label: 'backlog', sorting: true },
@@ -51,7 +40,23 @@ export default {
     { name: 'Done', label: null, closed: true }
   ],
 
+  /**
+   * (Optional) default filter to apply to the board if there is no
+   * user-defined search query.
+   */
   defaultFilter: '!repo:"some/ignored-repository"',
 
+  /**
+   * (Optional) Filter matching issues that shall not be saved.
+   *
+   * Matching issues will not be added. If they were previously on the board
+   * they will be removed as part of an update.
+   */
+  ignoreFilter: 'label:"invalid"',
+
+  /**
+   * Whether or not bots are treated as legitimate reviewers, for review and
+   * approval queries. Defaults to `false`.
+   */
   treatBotsAsReviewers: false
 };