wuffle 0.73.3 → 0.75.0

package/lib/apps/issue-filter/IssueFilter.js

@@ -1,5 +1,7 @@
 /**
  * @typedef { { ignoreFilter?: string } } StoreFilterConfig
+ *
+ * @typedef { Extract<import('@octokit/webhooks').EmitterWebhookEventName, 'issues' | `issues.${string}` | 'issue_comment' | `issue_comment.${string}` | 'pull_request' | `pull_request.${string}` | 'pull_request_review' | `pull_request_review.${string}` | 'pull_request_review_comment' | `pull_request_review_comment.${string}` | 'pull_request_review_thread' | `pull_request_review_thread.${string}`> } IssueOrPullWebhookEventName
  */
 
 import { filterIssueOrPull } from '../../filters.js';
@@ -41,7 +43,7 @@ export default function IssueFilter(config, store, search, logger) {
   /**
    * @param {import('../../types.js').Logger } log
    *
-   * @return { (filterFn) => (any) => any }
+   * @return {<E extends IssueOrPullWebhookEventName>(fn: (context: import('probot').Context<E>) => any) => (context: import('probot').Context<E>) => any}
    */
   function createWebhookFilter(log) {
 
@@ -49,7 +51,7 @@ export default function IssueFilter(config, store, search, logger) {
 
       return (context) => {
 
-        const payload = context.payload;
+        const payload = /** @type {any} */ (context.payload);
 
         const issueOrPull = filterIssueOrPull(
           payload.issue || payload.pull_request,
@@ -79,7 +81,7 @@ export default function IssueFilter(config, store, search, logger) {
   /**
    * @param {import('../../types.js').Logger } log
    *
-   * @return { (filterFn) => (any) => any }
+   * @return {<E extends IssueOrPullWebhookEventName>(fn: (context: import('probot').Context<E>) => any) => (context: import('probot').Context<E>) => any}
    */
   this.createWebhookFilter = createWebhookFilter;
 }

package/lib/apps/log-events.js

@@ -27,18 +27,18 @@ export default function LogEvents(logger, webhookEvents) {
 
   log.info('dumping webhook events to %s', path.resolve(eventsDir));
 
-  function write(event, payload) {
+  function write(name, payload) {
 
     const {
       action
     } = payload;
 
-    const name = action ? `${event}.${action}` : event;
+    const eventName = action ? `${name}.${action}` : name;
 
-    const data = JSON.stringify({ event, payload }, null, '  ');
+    const data = JSON.stringify({ name, payload }, null, '  ');
 
     return fs.mkdir(eventsDir, { recursive: true }).then(() => {
-      const fileName = path.join(eventsDir, `${Date.now()}-${counter++}-${name}.json`);
+      const fileName = path.join(eventsDir, `${Date.now()}-${counter++}-${eventName}.json`);
 
       return fs.writeFile(fileName, data, 'utf8');
     });

package/lib/apps/{reindex-store.js → reindex-store/ReindexStore.js}

@@ -1,16 +1,16 @@
 import {
   getPackageVersion,
   hash
-} from '../util/index.js';
+} from '../../util/index.js';
 
 
 /**
  * @constructor
  *
  * @param {any} config
- * @param {import('../types.js').Logger} logger
- * @param {import('../events.js').default} events
- * @param {import('../store.js').default} store
+ * @param {import('../../types.js').Logger} logger
+ * @param {import('../../events.js').default} events
+ * @param {import('../../store.js').default} store
  */
 export default function ReindexStore(config, logger, events, store) {
 
@@ -48,6 +48,8 @@ export default function ReindexStore(config, logger, events, store) {
       log.info('config changed');
 
       await reindexStore();
+    } else {
+      log.debug('config unchanged - skipping reindexing');
     }
   });
 

package/lib/apps/reindex-store/index.js

@@ -0,0 +1,6 @@
+import ReindexStore from './ReindexStore.js';
+
+export default {
+  __init__: [ 'reindexStore' ],
+  reindexStore: [ 'type', ReindexStore ]
+};

package/lib/apps/search/Search.js

@@ -37,7 +37,7 @@ export default function Search(config, logger, store) {
 
   const {
     treatBotsAsReviewers = false,
-    defaultFilter
+    defaultFilter = ''
   } = config;
 
   function filterNoop(issue) {
@@ -63,13 +63,17 @@ export default function Search(config, logger, store) {
    *
    * @return { boolean }
    */
-  function includes(actual, pattern, exact) {
+  function includes(actual, pattern, exact = false) {
+
+    if (!pattern) {
+      return false;
+    }
 
     if (exact) {
-      return pattern && actual === pattern;
+      return actual === pattern;
     }
 
-    return pattern && actual.toLowerCase().includes(pattern.toLowerCase());
+    return actual.toLowerCase().includes(pattern.toLowerCase());
   }
 
   function isPull(issue) {
@@ -445,7 +449,7 @@ export default function Search(config, logger, store) {
    * Retrieve a filter function from the given search string.
    *
    * @param {string} search
-   * @param {GitHubUser} [user]
+   * @param {GitHubUser|null} [user]
    *
    * @return {FilterFn}
    */

package/lib/apps/webhook-events/WebhookEvents.js

@@ -1,4 +1,11 @@
 /**
+ * @typedef { import('probot').Probot } Probot
+ * @typedef { import('@octokit/webhooks').EmitterWebhookEventName } WebhookEventName
+ */
+
+/**
+ * A lightweight wrapper around {@link Probot#on} and {@link Probot#onAny}.
+ *
  * @constructor
  *
  * @param {import('../../types.js').ProbotApp} app
@@ -7,8 +14,7 @@
 export default function WebhookEvents(app, githubApp) {
 
   /**
-   * @template {Function} T
-   * @param {T} fn
+   * @param {(context: import('probot').Context) => any} fn
    */
   function ifEnabled(fn) {
 
@@ -37,8 +43,9 @@ export default function WebhookEvents(app, githubApp) {
    * Register a event lister for a single
    * or a number of webhook events.
    *
-   * @param {any|any[]} events
-   * @param {Function} fn listener
+   * @template {WebhookEventName} E
+   * @param {E | E[]} events
+   * @param {(context: import('probot').Context<E>) => any} fn listener
    */
   function on(events, fn) {
     app.on(events, ifEnabled(fn));
@@ -48,7 +55,7 @@ export default function WebhookEvents(app, githubApp) {
    * Register an event listener for all
    * webhook events.
    *
-   * @param {Function} fn
+   * @param {(context: import('probot').Context) => any} fn
    */
   function onAny(fn) {
     app.onAny(ifEnabled(fn));

package/lib/events.js

@@ -139,8 +139,8 @@ Events.prototype.createEvent = function(data) {
  * @param {Object} [data] the event object
  * @param {...Object} additionalArgs to be passed to the callback functions
  *
- * @return {Promise<boolean>} the events return value, if specified or false if the
- *                            default action was prevented by listeners
+ * @return {Promise<boolean|undefined|any>} the events return value, if
+ *    specified or false if the default action was prevented by listeners
  */
 Events.prototype.emit = async function(type, data, ...additionalArgs) {
 

package/lib/index.js

@@ -11,7 +11,7 @@ const appModules = [
       ? import('./apps/dump-store/s3/index.js')
       : import('./apps/dump-store/local/index.js')
   ),
-  import('./apps/events-sync.js'),
+  import('./apps/events-sync/index.js'),
   import('./apps/github-app/index.js'),
   import('./apps/github-issues/index.js'),
   import('./apps/github-comments/index.js'),
@@ -24,11 +24,11 @@ const appModules = [
   import('./apps/user-access/index.js'),
   import('./apps/search/index.js'),
   import('./apps/background-sync/index.js'),
-  import('./apps/automatic-dev-flow.js'),
+  import('./apps/automatic-dev-flow/index.js'),
   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/index.js')
 ];
 
 import loadConfig from './load-config.js';
@@ -78,17 +78,25 @@ export default function Wuffle(app, { getRouter }) {
     });
 
     const coreModule = {
-      'app': [ 'value', app ],
       'config': [ 'value', config ],
-      'router': [ 'value', router ],
       'logger': [ 'value', logger ],
       'columns': [ 'type', Columns ],
       'store': [ 'type', Store ],
       'events': [ 'value', events ]
     };
 
+    const webModule = {
+      'router': [ 'value', router ]
+    };
+
+    const probotModule = {
+      'app': [ 'value', app ],
+    };
+
     const injector = new AsyncInjector([
       coreModule,
+      probotModule,
+      webModule,
       ...modules
     ]);
 

package/lib/probot/CustomProbot.js

@@ -103,7 +103,8 @@ function validateSetup() {
 
   const setup = new ManifestCreation();
 
-  const manifest = JSON.parse(setup.getManifest(setup.pkg, process.env.BASE_URL));
+  // TODO(nikku): process.env.BASE_URL may not be defined here
+  const manifest = JSON.parse(setup.getManifest(setup.pkg, /** @type { string } */ (process.env.BASE_URL)));
 
   return [
     !manifest.url && new Error('No <url> configured in app.yml'),

package/lib/util/search.js

@@ -116,7 +116,7 @@ export function parseSearch(str) {
 
       do {
         lastTerm = stack.pop();
-      } while (!lastTerm.group);
+      } while (lastTerm && !lastTerm.group);
 
       continue;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wuffle",
-  "version": "0.73.3",
+  "version": "0.75.0",
   "description": "A multi-repository task board for GitHub issues",
   "author": {
     "name": "Nico Rehwaldt",
@@ -35,7 +35,7 @@
     "all": "run-s lint test",
     "dev": "nodemon",
     "start": "NODE_ENV=production node ./bin/wuffle",
-    "test": "mocha 'test/**/*.js' --exit",
+    "test": "mocha -r test/helpers/globals.js 'test/**/*.js' --exit",
     "lint": "run-s lint:*",
     "lint:eslint": "eslint .",
     "lint:types": "tsc --pretty",
@@ -61,13 +61,14 @@
     "@types/compression": "^1.8.1",
     "@types/express-session": "^1.19.0",
     "@types/mocha": "^10.0.10",
+    "@types/sinon": "^21.0.1",
     "chai": "^6.2.2",
-    "graphql": "^16.13.2",
+    "graphql": "^16.14.0",
     "mocha": "^11.7.5",
     "nock": "^14.0.13",
     "nodemon": "^3.1.14",
     "npm-run-all2": "^8.0.4",
-    "sinon": "^21.1.2",
+    "sinon": "^22.0.0",
     "sinon-chai": "^4.0.0",
     "typescript": "^5.9.3"
   },
@@ -82,5 +83,5 @@
     "index.js",
     "wuffle.config.example.js"
   ],
-  "gitHead": "1d7cdf09524102d300d6230b840959cdd1479e3e"
+  "gitHead": "132f68f8372f71a15c4e34b0fd9db837ccc02b6b"
 }