wuffle 0.71.0 → 0.73.0

package/LICENSE

@@ -0,0 +1,21 @@
+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/board-api-routes/board-api-filters.js

@@ -63,13 +63,15 @@ export function filterUser(user) {
   const {
     login,
     avatar_url,
-    html_url
+    html_url,
+    type
   } = user;
 
   return {
     login,
     avatar_url,
-    html_url
+    html_url,
+    type
   };
 }
 
@@ -138,13 +140,15 @@ export function filterReview(review) {
   const {
     state,
     user,
-    html_url
+    html_url,
+    author_association
   } = review;
 
   return {
     state,
     html_url,
-    user: filterUser(user)
+    user: filterUser(user),
+    author_association
   };
 }
 
@@ -173,7 +177,8 @@ export function filterPull(pullRequest) {
     order,
     column,
     check_runs = [],
-    statuses = []
+    statuses = [],
+    author_association
   } = pullRequest;
 
   return {
@@ -198,7 +203,8 @@ export function filterPull(pullRequest) {
     order,
     column,
     statuses: statuses.map(filterStatus),
-    check_runs: check_runs.map(filterCheckRun)
+    check_runs: check_runs.map(filterCheckRun),
+    author_association
   };
 }
 
@@ -222,7 +228,8 @@ export function filterIssue(issue) {
     comments = [],
     links = [],
     order,
-    column
+    column,
+    author_association
   } = issue;
 
   return {
@@ -242,7 +249,8 @@ export function filterIssue(issue) {
     html_url,
     links: links.map(filterLink),
     order,
-    column
+    column,
+    author_association
   };
 
 }

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

@@ -117,7 +117,8 @@ function filterReview(review) {
     submitted_at,
     state,
     user,
-    html_url
+    html_url,
+    author_association
   } = review;
 
   return {
@@ -128,6 +129,7 @@ function filterReview(review) {
     submitted_at,
     state: state.toLowerCase(),
     user: filterUser(user),
-    html_url
+    html_url,
+    author_association
   };
 }

package/lib/apps/search/Search.js

@@ -8,7 +8,11 @@ const CHILD_LINK_TYPES = {
 };
 
 /**
- * @typedef { { defaultFilter?: string } } SearchConfig
+ * @typedef { {
+ *   defaultFilter?: string,
+ *   treatBotsAsReviewers?: boolean
+ * } } SearchConfig
+ *
  * @typedef { import('../../util/search.js').SearchTerm } SearchTerm
  *
  * @typedef { import('../../types.js').GitHubUser } GitHubUser
@@ -31,6 +35,11 @@ export default function Search(config, logger, store) {
     name: 'wuffle:search'
   });
 
+  const {
+    treatBotsAsReviewers = false,
+    defaultFilter
+  } = config;
+
   function filterNoop(issue) {
     return true;
   }
@@ -67,12 +76,46 @@ export default function Search(config, logger, store) {
     return issue.pull_request;
   }
 
+  function isValidReview(review) {
+
+    const {
+      user,
+      author_association
+    } = review;
+
+    if (!user) {
+      return false;
+    }
+
+    if (user.type === 'Bot') {
+      return treatBotsAsReviewers;
+    }
+
+    // backwards compatibility - we did not have that
+    // data stored previously
+    return author_association ? [ 'COLLABORATOR', 'MEMBER', 'OWNER' ].includes(author_association) : true;
+  }
+
+  function getEffectiveReviews(reviews) {
+    const byReviewer = new Map();
+
+    for (const review of reviews) {
+      if (review.state === 'commented' || !isValidReview(review)) continue;
+
+      byReviewer.set(review.user?.login, review);
+    }
+
+    return [ ...byReviewer.values() ];
+  }
+
   function isApproved(issue) {
-    return (issue.reviews || []).some(r => r.state === 'approved');
+    return getEffectiveReviews(issue.reviews || []).some(
+      r => r.state === 'approved'
+    );
   }
 
   function isReviewed(issue) {
-    return (issue.reviews || []).length > 0;
+    return getEffectiveReviews(issue.reviews || []).length > 0;
   }
 
   const filters = {
@@ -158,6 +201,10 @@ export default function Search(config, logger, store) {
 
           return !links || !links.some(link => CHILD_LINK_TYPES[link.type]);
         };
+      case 'referenced':
+        return function filterReferenced(issue) {
+          return (issue.links || []).length > 0;
+        };
       default:
         return filterNoop;
       }
@@ -286,7 +333,29 @@ export default function Search(config, logger, store) {
       return function filterCreated(issue) {
         return matchTemporal(issue.updated_at);
       };
-    })
+    }),
+
+    'or': function orFilter(value, _exact, user) {
+
+      const childTerms = /** @type {SearchTerm[]} */ (value);
+
+      const filterFns = childTerms.map(childTerm => buildTermFn(childTerm, user));
+
+      return (issue) => filterFns.some(
+        filterFn => filterFn(issue)
+      );
+    },
+
+    'and': function andFilter(value, _exact, user) {
+
+      const childTerms = /** @type {SearchTerm[]} */ (value);
+
+      const filterFns = childTerms.map(childTerm => buildTermFn(childTerm, user));
+
+      return (issue) => filterFns.every(
+        filterFn => filterFn(issue)
+      );
+    }
   };
 
   function temporalFilter(fn) {
@@ -339,19 +408,6 @@ export default function Search(config, logger, store) {
 
     const wrap = (fn) => negated ? ((issue) => !fn(issue)) : fn;
 
-    if ([ 'or', 'and' ].includes(qualifier)) {
-
-      const childTerms = /** @type {SearchTerm[]} */ (value);
-
-      const filterFns = childTerms.map(childTerm => buildTermFn(childTerm, user));
-
-      return wrap(
-        (issue) => filterFns[qualifier === 'or' ? 'some' : 'every'](
-          filterFn => filterFn(issue)
-        )
-      );
-    }
-
     if (!value) {
       return noopFilter();
     }
@@ -371,7 +427,7 @@ export default function Search(config, logger, store) {
       return noopFilter();
     }
 
-    return wrap(factoryFn(value, exact));
+    return wrap(factoryFn(value, exact, user));
   }
 
   function buildFilterFn(search, user) {
@@ -395,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 {
@@ -405,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');
@@ -424,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/filters.js

@@ -47,7 +47,8 @@ export function filterUser(githubUser) {
     node_id,
     login,
     avatar_url,
-    html_url
+    html_url,
+    type
   } = githubUser;
 
   return {
@@ -55,7 +56,8 @@ export function filterUser(githubUser) {
     node_id,
     login,
     avatar_url,
-    html_url
+    html_url,
+    type
   };
 }
 
@@ -147,7 +149,8 @@ export function filterPull(githubPull, githubRepository) {
     additions,
     deletions,
     changed_files,
-    html_url
+    html_url,
+    author_association
   } = githubPull;
 
   // stable ID that is independent from GitHubs internal issue/pr distinction
@@ -187,7 +190,8 @@ export function filterPull(githubPull, githubRepository) {
     changed_files,
     pull_request: true,
     repository: filterRepository(githubRepository),
-    html_url
+    html_url,
+    author_association
   };
 }
 
@@ -209,7 +213,8 @@ export function filterIssue(githubIssue, githubRepository) {
     labels,
     milestone,
     pull_request,
-    html_url
+    html_url,
+    author_association
   } = githubIssue;
 
   // stable ID that is independent from GitHubs internal issue/pr distinction
@@ -239,7 +244,8 @@ export function filterIssue(githubIssue, githubRepository) {
     milestone: milestone ? filterMilestone(milestone) : null,
     repository: filterRepository(githubRepository),
     pull_request: !!pull_request,
-    html_url
+    html_url,
+    author_association
   };
 
 }

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,13 +1,13 @@
 {
   "name": "wuffle",
-  "version": "0.71.0",
+  "version": "0.73.0",
   "description": "A multi-repository task board for GitHub issues",
   "author": {
     "name": "Nico Rehwaldt",
     "url": "https://github.com/nikku"
   },
   "bin": {
-    "wuffle": "./bin/wuffle"
+    "wuffle": "bin/wuffle"
   },
   "exports": {
     ".": "./index.js",
@@ -19,7 +19,7 @@
   "homepage": "https://github.com/nikku/wuffle",
   "repository": {
     "type": "git",
-    "url": "https://github.com/nikku/wuffle.git",
+    "url": "git+https://github.com/nikku/wuffle.git",
     "directory": "packages/app"
   },
   "keywords": [
@@ -48,7 +48,7 @@
     "compression": "^1.8.1",
     "express-session": "^1.19.0",
     "fake-tag": "^5.0.0",
-    "memorystore": "^1.6.7",
+    "memorystore": "^1.6.8",
     "min-dash": "^5.0.0",
     "p-defer": "^4.0.1",
     "prexit": "^2.3.0",
@@ -81,5 +81,6 @@
     "app.yml",
     "index.js",
     "wuffle.config.example.js"
-  ]
+  ],
+  "gitHead": "a58cc7fcd73db7a1dc7babc25b97bb590119b69d"
 }