wuffle 0.70.1 → 0.72.0

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,12 @@ 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
+ *
+ * @typedef { (issue: any) => boolean } FilterFn
  */
 
 /**
@@ -26,6 +31,10 @@ export default function Search(config, logger, store) {
     name: 'wuffle:search'
   });
 
+  const {
+    treatBotsAsReviewers = false
+  } = config;
+
   function filterNoop(issue) {
     return true;
   }
@@ -62,12 +71,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 = {
@@ -153,6 +196,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;
       }
@@ -281,7 +328,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) {
@@ -318,71 +387,82 @@ export default function Search(config, logger, store) {
     };
   }
 
-  function buildFilterFns(search, user) {
-
-    const terms = search ? parseSearch(search) : [];
-
-    return terms.map(term => {
-      let {
-        qualifier,
-        value,
-        negated,
-        exact
-      } = term;
+  /**
+   * @param {SearchTerm} term
+   * @param {any} user
+   *
+   * @return {FilterFn}
+   */
+  function buildTermFn(term, user) {
+    let {
+      qualifier,
+      value,
+      negated,
+      exact
+    } = term;
+
+    const wrap = (fn) => negated ? ((issue) => !fn(issue)) : fn;
+
+    if (!value) {
+      return noopFilter();
+    }
 
-      if (!value) {
-        return noopFilter();
+    if (value === '@me') {
+      if (!user) {
+        return noneFilter();
       }
 
-      if (value === '@me') {
-        if (!user) {
-          return noneFilter();
-        }
+      value = user.login;
+      exact = true;
+    }
 
-        value = user.login;
-        exact = true;
-      }
+    const factoryFn = filters[qualifier];
 
-      const factoryFn = filters[qualifier];
+    if (!factoryFn) {
+      return noopFilter();
+    }
 
-      if (!factoryFn) {
-        return noopFilter();
-      }
+    return wrap(factoryFn(value, exact, user));
+  }
 
-      const fn = factoryFn(value, exact);
+  function buildFilterFn(search, user) {
 
-      if (negated) {
-        return function(arg) {
-          return !fn(arg);
-        };
-      }
+    const term = search && parseSearch(search);
+
+    if (!term) {
+      return null;
+    }
 
-      return fn;
-    });
+    return buildTermFn(term);
   }
 
   /**
    * Retrieve a filter function from the given search string.
    *
    * @param {string} search
-   * @param {import('../../types.js').GitHubUser} [user]
+   * @param {GitHubUser} [user]
    *
-   * @return {Function}
+   * @return {FilterFn}
    */
   function getSearchFilter(search, user) {
 
-    const filterFns = buildFilterFns(search, user);
+    const filterFn = buildFilterFn(search, user);
 
-    const ignoreFilterFns = buildFilterFns(config.defaultFilter, user);
+    const ignoreFilterFn = buildFilterFn(config.defaultFilter, user);
 
     return function(issue) {
       try {
-        if (filterFns.length) {
-          return filterFns.every(fn => fn(issue));
-        } else {
+        if (filterFn) {
+          return filterFn(issue);
+        }
 
-          return ignoreFilterFns.every(fn => fn(issue));
+        if (ignoreFilterFn) {
+          return ignoreFilterFn(issue);
         }
+
+        // no user search, no ignore filter,
+        // show all issues
+        return true;
       } catch (err) {
         log.warn({ issue: issueIdent(issue), err }, 'filter failed');
 

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/util/search.js

@@ -54,58 +54,149 @@ function startOfDay(time) {
   return date.getTime();
 }
 
+/**
+ * @typedef { {
+ *   qualifier: string,
+ *   exact?: boolean,
+ *   negated?: boolean,
+ *   value?: string|SearchTerm[],
+ * } } SearchTerm
+ */
+
 /**
  * @param {string} str
  *
- * @return { {
- *   qualifier: string,
- *   value: string|undefined,
- *   exact: boolean,
- *   negated?: boolean
- * }[] }
+ * @return {SearchTerm}
  */
 export function parseSearch(str) {
 
-  const regexp = /(?:([\w#/&]+)|"([\w#/&\s-.]+)"|([-!]?)([\w]+):(?:([\w-#/&@<>=.]+)|"([\w-#/&@:.,; ]+)")?)(?:\s|$)/g;
+  const regexp = /(\()|(\))|(OR)\s*|(AND)\s|([-!]|NOT\s+)?(?:"([^"]+)"|([\w#/&]+)(?:(:)(?:([\w-#/&@<>=.]+)|"([^"]+)")?)?)/g;
 
-  const terms = [];
+  const stack = [ {
+    qualifier: 'and',
+    value: /** @type {SearchTerm[]} */ ([])
+  } ];
 
   let match;
 
   while ((match = regexp.exec(str))) {
 
+    const term = stack[stack.length - 1];
+
     const [
       _,
-      text,
-      textEscaped,
+      openGroup,
+      closeGroup,
+      or,
+      and,
       negated,
+      textEscaped,
+      text,
       qualifier,
       qualifierText,
       qualifierTextEscaped
     ] = match;
 
+    if (openGroup) {
+      const groupTerm = {
+        qualifier: 'and',
+        value: [],
+        group: true
+      };
 
-    const textValue = text || textEscaped;
+      stack.push(groupTerm);
+      term.value.push(groupTerm);
 
-    if (textValue) {
-      terms.push({
-        qualifier: 'text',
-        value: textValue,
-        exact: !!textEscaped
-      });
+      continue;
+    }
+
+    if (closeGroup) {
+
+      let lastTerm;
+
+      do {
+        lastTerm = stack.pop();
+      } while (!lastTerm.group);
+
+      continue;
+    }
+
+    if (and) {
+
+      // default semantics
+      continue;
+    }
+
+    if (or) {
+      const nextTerm = {
+        qualifier: 'and',
+        value: []
+      };
+
+      const groupTerm = {
+        qualifier: 'or',
+        value: [
+          {
+            qualifier: 'and',
+            value: term.value.slice()
+          },
+          nextTerm
+        ]
+      };
+
+      // replace existing terms with <OR> term
+      term.value.length = 0;
+      term.value.push(groupTerm);
+
+      stack.push(nextTerm);
+
+      continue;
     }
 
+    const textValue = text || textEscaped;
     const qualifierValue = qualifierText || qualifierTextEscaped;
 
     if (qualifier) {
-      terms.push({
-        qualifier,
+      term.value.push({
+        qualifier: textValue,
         value: qualifierValue,
         negated: !!negated,
         exact: !!qualifierTextEscaped
       });
+    } else {
+      term.value.push({
+        qualifier: 'text',
+        value: textValue,
+        exact: !!textEscaped,
+        negated: !!negated
+      });
     }
   }
 
-  return terms;
+  return collapseSearch(stack[0]);
+}
+
+/**
+ * @param {SearchTerm} term
+ *
+ * @return {SearchTerm}
+ */
+export function collapseSearch(term) {
+
+  if (![ 'and', 'or' ].includes(term.qualifier)) {
+    return term;
+  }
+
+  const nestedTerms = /** @type {SearchTerm[]} */ (term.value);
+
+  const nestedTermsCollapsed = nestedTerms.map(collapseSearch);
+
+  if (term.qualifier === 'and' && nestedTermsCollapsed.length === 1) {
+    return nestedTermsCollapsed[0];
+  }
+
+  return {
+    ...term,
+    value: nestedTermsCollapsed
+  };
 }

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "wuffle",
-  "version": "0.70.1",
+  "version": "0.72.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": [
@@ -42,13 +42,13 @@
     "auto-test": "npm test -- --watch"
   },
   "dependencies": {
-    "@aws-sdk/client-s3": "^3.1014.0",
+    "@aws-sdk/client-s3": "^3.1037.0",
     "async-didi": "^1.0.0",
     "body-parser": "^2.2.2",
     "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",
@@ -59,15 +59,15 @@
     "@graphql-eslint/eslint-plugin": "^4.4.0",
     "@octokit/graphql-schema": "^15.25.0",
     "@types/compression": "^1.8.1",
-    "@types/express-session": "^1.18.2",
+    "@types/express-session": "^1.19.0",
     "@types/mocha": "^10.0.10",
     "chai": "^6.2.2",
-    "graphql": "^16.13.1",
+    "graphql": "^16.13.2",
     "mocha": "^11.7.5",
-    "nock": "^14.0.11",
+    "nock": "^14.0.13",
     "nodemon": "^3.1.14",
     "npm-run-all2": "^8.0.4",
-    "sinon": "^21.0.3",
+    "sinon": "^21.1.2",
     "sinon-chai": "^4.0.0",
     "typescript": "^5.9.3"
   },
@@ -82,5 +82,5 @@
     "index.js",
     "wuffle.config.example.js"
   ],
-  "gitHead": "e3234b1499bb1c75e3bf40c15b0c105bedeba70c"
+  "gitHead": "f42a56e87fb1f6d3f06ef5e9215c5e0b91544c0b"
 }