wuffle 0.70.1 → 0.71.0

package/lib/apps/search/Search.js

@@ -9,6 +9,11 @@ const CHILD_LINK_TYPES = {
 
 /**
  * @typedef { { defaultFilter?: string } } SearchConfig
+ * @typedef { import('../../util/search.js').SearchTerm } SearchTerm
+ *
+ * @typedef { import('../../types.js').GitHubUser } GitHubUser
+ *
+ * @typedef { (issue: any) => boolean } FilterFn
  */
 
 /**
@@ -318,71 +323,95 @@ export default function Search(config, logger, store) {
     };
   }
 
-  function buildFilterFns(search, user) {
+  /**
+   * @param {SearchTerm} term
+   * @param {any} user
+   *
+   * @return {FilterFn}
+   */
+  function buildTermFn(term, user) {
+    let {
+      qualifier,
+      value,
+      negated,
+      exact
+    } = term;
 
-    const terms = search ? parseSearch(search) : [];
+    const wrap = (fn) => negated ? ((issue) => !fn(issue)) : fn;
 
-    return terms.map(term => {
-      let {
-        qualifier,
-        value,
-        negated,
-        exact
-      } = term;
+    if ([ 'or', 'and' ].includes(qualifier)) {
 
-      if (!value) {
-        return noopFilter();
-      }
+      const childTerms = /** @type {SearchTerm[]} */ (value);
 
-      if (value === '@me') {
-        if (!user) {
-          return noneFilter();
-        }
+      const filterFns = childTerms.map(childTerm => buildTermFn(childTerm, user));
 
-        value = user.login;
-        exact = true;
-      }
+      return wrap(
+        (issue) => filterFns[qualifier === 'or' ? 'some' : 'every'](
+          filterFn => filterFn(issue)
+        )
+      );
+    }
 
-      const factoryFn = filters[qualifier];
+    if (!value) {
+      return noopFilter();
+    }
 
-      if (!factoryFn) {
-        return noopFilter();
+    if (value === '@me') {
+      if (!user) {
+        return noneFilter();
       }
 
-      const fn = factoryFn(value, exact);
+      value = user.login;
+      exact = true;
+    }
 
-      if (negated) {
-        return function(arg) {
-          return !fn(arg);
-        };
-      }
+    const factoryFn = filters[qualifier];
+
+    if (!factoryFn) {
+      return noopFilter();
+    }
 
-      return fn;
-    });
+    return wrap(factoryFn(value, exact));
+  }
+
+  function buildFilterFn(search, user) {
+
+    const term = search && parseSearch(search);
+
+    if (!term) {
+      return null;
+    }
+
+    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/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,6 +1,6 @@
 {
   "name": "wuffle",
-  "version": "0.70.1",
+  "version": "0.71.0",
   "description": "A multi-repository task board for GitHub issues",
   "author": {
     "name": "Nico Rehwaldt",
@@ -42,7 +42,7 @@
     "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",
@@ -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"
   },
@@ -81,6 +81,5 @@
     "app.yml",
     "index.js",
     "wuffle.config.example.js"
-  ],
-  "gitHead": "e3234b1499bb1c75e3bf40c15b0c105bedeba70c"
+  ]
 }