wuffle 0.75.0 → 0.76.0

package/app.yml

@@ -46,6 +46,7 @@ default_events:
 # - team
 # - team_add
 # - watch
+- sub_issues
 
 # The set of permissions needed by the GitHub App. The format of the object uses
 # the permission name for the key (for example, issues) and the access type for

package/lib/apps/board-api-routes/board-api-routes.js

@@ -172,19 +172,19 @@ export default async function BoardApiRoutes(
     const items = store.getBoard();
     const cursor = store.getUpdateCursor();
 
-    filterBoardItems(req, items).then(filteredItems => {
+    return filterBoardItems(req, items).then(filteredItems => {
 
-      return res.type('json').json({
+      res.type('json').json({
         items: filteredItems,
         cursor
-      }) && null;
+      });
     }).catch(err => {
       log.error({
         err,
         cursor
       }, 'failed to retrieve cards');
 
-      return res.status(500).json({ error : true }) && null;
+      res.status(500).json({ error : true });
     });
   });
 
@@ -206,7 +206,7 @@ export default async function BoardApiRoutes(
         };
       }),
       name: name || 'Wuffle Board'
-    }) && null;
+    });
 
   });
 
@@ -216,18 +216,16 @@ export default async function BoardApiRoutes(
 
     const updates = cursor ? store.getUpdates(cursor) : [];
 
-    return (
-      filterUpdates(req, updates).then(filteredUpdates => {
-        res.type('json').json(filteredUpdates);
-      }).catch(err => {
-        log.error({
-          err,
-          cursor
-        }, 'failed to retrieve card updates');
-
-        res.status(500).json({ error : true });
-      })
-    );
+    return filterUpdates(req, updates).then(filteredUpdates => {
+      res.type('json').json(filteredUpdates);
+    }).catch(err => {
+      log.error({
+        err,
+        cursor
+      }, 'failed to retrieve card updates');
+
+      res.status(500).json({ error : true });
+    });
   });
 
 
@@ -288,7 +286,7 @@ export default async function BoardApiRoutes(
       }
     };
 
-    moveIssue(context, issue, column, { before, after }).then(() => {
+    return moveIssue(context, issue, column, { before, after }).then(() => {
       res.type('json').json({});
     }).catch(err => {
       log.error(err, 'failed to move issue');

package/lib/apps/events-sync/EventsSync.js

@@ -227,12 +227,29 @@ export default function EventsSync(webhookEvents, store, logger) {
   });
 
 
-  // issues ///////////////////////////////
+  // sub-issues /////////////////////
 
-  // https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/webhook-events-and-payloads#issues
 
-  // issue transfer is mapped to the following GitHub events
+  // https://docs.github.com/en/webhooks/webhook-events-and-payloads#sub_issues
+  //
+  // update sub-issues on change - updating parent <> child relationship
+  webhookEvents.on(
+    /** @type {any} */ ([ 'sub_issues.sub_issue_added', 'sub_issues.sub_issue_removed' ]),
+    async ({ payload }) => {
+
+      const {
+        sub_issue,
+        repository
+      } = /** @type {any} */ (payload);
+
+      return store.updateIssue(filterIssue(sub_issue, repository));
+    }
+  );
+
+
+  // https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/webhook-events-and-payloads#issues
   //
+  // issue transfer is mapped to the following GitHub events:
   // -> issues.opened (new issue is being opened by GitHub)
   // -> issues.transferred (old issue was deleted by GitHub)
   //

package/lib/apps/github-app/GithubApp.js

@@ -19,11 +19,13 @@ const RequiredEvents = [
   'issues',
   'issue_comment',
   'label',
+  'member',
   'milestone',
   'pull_request',
   'pull_request_review',
   'repository',
-  'status'
+  'status',
+  'sub_issues'
 ];
 
 /**
@@ -41,8 +43,9 @@ const RequiredEvents = [
  * @param {import('../../types.js').ProbotApp} app
  * @param {import('../../types.js').Logger} logger
  * @param {import('../../types.js').Injector} injector
+ * @param {import('../../events.js').default} events
  */
-export default function GithubApp(config, app, logger, injector) {
+export default function GithubApp(config, app, logger, injector, events) {
 
   const log = logger.child({
     name: 'wuffle:github-app'
@@ -266,6 +269,31 @@ export default function GithubApp(config, app, logger, injector) {
     log.debug('validated installations');
   }
 
+  async function validateApp() {
+    const octokit = await getAppScopedClient();
+    const { data: app } = await octokit.rest.apps.getAuthenticated();
+
+    // app may not be configured yet
+    if (!app) {
+      return;
+    }
+
+    const missingEvents = RequiredEvents.filter(
+      event => !app.events.includes(event)
+    );
+
+    if (missingEvents.length) {
+      log.error({
+        missingEvents,
+        events: app.events
+      }, 'app is missing required event subscriptions; update app settings on GitHub');
+    }
+  }
+
+  events.once('wuffle.start', async function() {
+    await validateApp().catch(err => log.warn({ err }, 'failed to validate app configuration'));
+  });
+
   /**
    * Fetch active installations.
    *

package/lib/filters.js

@@ -214,7 +214,8 @@ export function filterIssue(githubIssue, githubRepository) {
     milestone,
     pull_request,
     html_url,
-    author_association
+    author_association,
+    parent_issue_url
   } = githubIssue;
 
   // stable ID that is independent from GitHubs internal issue/pr distinction
@@ -245,7 +246,8 @@ export function filterIssue(githubIssue, githubRepository) {
     repository: filterRepository(githubRepository),
     pull_request: !!pull_request,
     html_url,
-    author_association
+    author_association,
+    parent_issue_url: parent_issue_url || null
   };
 
 }

package/lib/util/links.js

@@ -145,6 +145,22 @@ export function findLinks(issue, types) {
     links.push(link);
   }
 
+  // add CHILD_OF link from parent_issue_url (GitHub sub-issues)
+  const { parent_issue_url } = issue;
+
+  if (parent_issue_url) {
+    const parentMatch = parent_issue_url.match(/\/repos\/([^/]+)\/([^/]+)\/issues\/(\d+)/);
+
+    if (parentMatch) {
+      links.push({
+        type: CHILD_OF,
+        owner: parentMatch[1],
+        repo: parentMatch[2],
+        number: parseInt(parentMatch[3], 10)
+      });
+    }
+  }
+
   if (typeof types !== 'undefined') {
     return filterLinks(links, types);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wuffle",
-  "version": "0.75.0",
+  "version": "0.76.0",
   "description": "A multi-repository task board for GitHub issues",
   "author": {
     "name": "Nico Rehwaldt",
@@ -44,7 +44,7 @@
   "dependencies": {
     "@aws-sdk/client-s3": "^3.1037.0",
     "async-didi": "^1.0.0",
-    "body-parser": "^2.2.2",
+    "body-parser": "^2.3.0",
     "compression": "^1.8.1",
     "express-session": "^1.19.0",
     "fake-tag": "^5.0.0",
@@ -63,11 +63,11 @@
     "@types/mocha": "^10.0.10",
     "@types/sinon": "^21.0.1",
     "chai": "^6.2.2",
-    "graphql": "^16.14.0",
-    "mocha": "^11.7.5",
-    "nock": "^14.0.13",
+    "graphql": "^17.0.0",
+    "mocha": "^11.7.6",
+    "nock": "^14.0.15",
     "nodemon": "^3.1.14",
-    "npm-run-all2": "^8.0.4",
+    "npm-run-all2": "^9.0.2",
     "sinon": "^22.0.0",
     "sinon-chai": "^4.0.0",
     "typescript": "^5.9.3"
@@ -83,5 +83,5 @@
     "index.js",
     "wuffle.config.example.js"
   ],
-  "gitHead": "132f68f8372f71a15c4e34b0fd9db837ccc02b6b"
+  "gitHead": "3a21cf84280395b89d369422bbaf16f2b63c20dd"
 }