wuffle 0.74.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/auth-routes/AuthRoutes.js

@@ -60,7 +60,7 @@ export default function AuthRoutes(logger, router, securityContext) {
     };
 
     const params = new URLSearchParams();
-    params.append('client_id', process.env.GITHUB_CLIENT_ID);
+    params.append('client_id', /** @type {string} */ (process.env.GITHUB_CLIENT_ID));
     params.append('state', state);
     params.append('redirect_uri', appUrl('/wuffle/login/callback'));
 
@@ -81,10 +81,9 @@ export default function AuthRoutes(logger, router, securityContext) {
 
     log.debug({ session_id }, 'logging out');
 
-    return req.session.destroy(function(err) {
-      return res.redirect(redirectTo);
-    }) && null;
-
+    req.session.destroy(function(err) {
+      res.redirect(redirectTo);
+    });
   });
 
 
@@ -128,8 +127,8 @@ export default function AuthRoutes(logger, router, securityContext) {
     const params = new URLSearchParams();
     params.append('code', /** @type {string} */ (code));
     params.append('state', /** @type {string} */ (state));
-    params.append('client_id', process.env.GITHUB_CLIENT_ID);
-    params.append('client_secret', process.env.GITHUB_CLIENT_SECRET);
+    params.append('client_id', /** @type {string} */ (process.env.GITHUB_CLIENT_ID));
+    params.append('client_secret', /** @type {string} */ (process.env.GITHUB_CLIENT_SECRET));
     params.append('redirect_uri', appUrl('/wuffle/login/callback'));
 
     const {
@@ -185,7 +184,9 @@ export default function AuthRoutes(logger, router, securityContext) {
     } = session;
 
     if (!githubUser) {
-      return res.type('json').json(null) && null;
+      res.type('json').json(null);
+
+      return;
     }
 
     const {
@@ -216,17 +217,18 @@ export default function AuthRoutes(logger, router, securityContext) {
         }, 'failed to check GitHub authentication');
 
         // access is not granted anymore, clear current session
-        return req.session.destroy(function(err) {
-          return res.type('json').json(null);
-        }) && null;
+        req.session.destroy(function(err) {
+          res.type('json').json(null);
+        });
+
+        return;
       }
     }
 
-    return res.type('json').json({
+    res.type('json').json({
       login,
       avatar_url
-    }) && null;
-
+    });
   });
 
 

package/lib/apps/automatic-dev-flow/AutomaticDevFlow.js

@@ -31,14 +31,13 @@ export default function(webhookEvents, githubIssues, columns, issueFilter, logge
     'pull_request.closed'
   ], ifEnabled(async (context) => {
 
-    const {
-      pull_request,
-      issue
-    } = context.payload;
-
     const column = columns.getByState(DONE);
 
-    await githubIssues.moveIssue(context, issue || pull_request, column);
+    const issueOrPull = 'issue' in context.payload
+      ? context.payload.issue
+      : context.payload.pull_request;
+
+    await githubIssues.moveIssue(context, issueOrPull, column);
   }));
 
   webhookEvents.on('pull_request.converted_to_draft', ifEnabled(async (context) => {
@@ -107,7 +106,7 @@ export default function(webhookEvents, githubIssues, columns, issueFilter, logge
     const newAssignee = (
       process.env.AUTO_ASSIGN_PULLS && !external &&
       author && author.type === 'User' && author.login
-    );
+    ) || null;
 
     await Promise.all([
       githubIssues.moveIssue(context, pull_request, column, newAssignee),
@@ -172,7 +171,7 @@ export default function(webhookEvents, githubIssues, columns, issueFilter, logge
       return;
     }
 
-    const issue_number = match[1];
+    const issue_number = parseInt(match[1], 10);
 
     const column = columns.getByState(IN_PROGRESS);
 

package/lib/apps/background-sync/BackgroundSync.js

@@ -9,6 +9,17 @@ function isInternalError(error) {
 /**
  * This component performs a periodic background sync of a project.
  *
+ * Unless disabled via `process.env.DISABLE_BACKGROUND_SYNC` it will
+ * register a recurring check.
+ *
+ * Background check performs various optimizations to ensure only relevant
+ * data is stored on the board:
+ *
+ *   * Closed issues/PRs on the board will be thrashed
+ *   * Closed issues/PRs wiil not be synchronized from GitHub
+ *   * Open but stale issues/PRs will not be synchronized to the board
+ *   * Open issue/PR details will only be synchronized for recent issues
+ *
  * @constructor
  *
  * @param {Object} config
@@ -21,25 +32,25 @@ export default function BackgroundSync(config, logger, store, events, background
 
   // 30 days
   const syncClosedLookback = (
-    parseInt(process.env.BACKGROUND_SYNC_SYNC_CLOSED_LOOKBACK, 10) ||
+    parseInt(process.env.BACKGROUND_SYNC_SYNC_CLOSED_LOOKBACK || '', 10) ||
     1000 * 60 * 60 * 24 * 30
   );
 
   // 4 hours
   const syncClosedDetailsLookback = (
-    parseInt(process.env.BACKGROUND_SYNC_SYNC_CLOSED_DETAILS_LOOKBACK, 10) ||
+    parseInt(process.env.BACKGROUND_SYNC_SYNC_CLOSED_DETAILS_LOOKBACK || '', 10) ||
     1000 * 60 * 60 * 4
   );
 
   // 1 day
   const syncOpenDetailsLookback = (
-    parseInt(process.env.BACKGROUND_SYNC_SYNC_OPEN_DETAILS_LOOKBACK, 10) ||
+    parseInt(process.env.BACKGROUND_SYNC_SYNC_OPEN_DETAILS_LOOKBACK || '', 10) ||
     1000 * 60 * 60 * 24
   );
 
   // 60 days
   const removeClosedLookback = (
-    parseInt(process.env.BACKGROUND_SYNC_REMOVE_CLOSED_LOOKBACK, 10) ||
+    parseInt(process.env.BACKGROUND_SYNC_REMOVE_CLOSED_LOOKBACK || '', 10) ||
     1000 * 60 * 60 * 24 * 60
   );
 
@@ -393,6 +404,13 @@ We automatically synchronize all repositories you granted us access to via the G
     return Promise.all(jobs);
   }
 
+  /**
+   * Trigger background synchronization for all connected repositories.
+   *
+   * This ensures that data out-of-sync with the board is fetched from remote.
+   *
+   * @return {Promise<void>}
+   */
   async function backgroundSync() {
 
     log.info('start');
@@ -410,7 +428,7 @@ We automatically synchronize all repositories you granted us access to via the G
   }
 
   const syncInterval = (
-    parseInt(process.env.BACKGROUND_SYNC_SYNC_INTERVAL, 10) || (
+    parseInt(process.env.BACKGROUND_SYNC_SYNC_INTERVAL || '', 10) || (
       process.env.NODE_ENV !== 'production'
 
         // five minutes
@@ -442,6 +460,13 @@ We automatically synchronize all repositories you granted us access to via the G
 
   // api ///////////////////
 
+  /**
+   * Trigger background synchronization for all connected repositories.
+   *
+   * This ensures that data out-of-sync with the board is fetched from remote.
+   *
+   * @return {Promise<void>}
+   */
   this.backgroundSync = backgroundSync;
 
 

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

@@ -174,17 +174,17 @@ export default async function BoardApiRoutes(
 
     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 });
     });
   });
 
@@ -196,7 +196,7 @@ export default async function BoardApiRoutes(
       name
     } = config;
 
-    return res.type('json').json({
+    res.type('json').json({
       columns: columns.map(c => {
         const { name, collapsed } = c;
 
@@ -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 });
+    });
   });
 
 
@@ -236,7 +234,9 @@ export default async function BoardApiRoutes(
     const user = authRoutes.getGitHubUser(req);
 
     if (!user) {
-      return res.status(401).json({}) && null;
+      res.status(401).json({});
+
+      return;
     }
 
     const body = JSON.parse(req.body);
@@ -251,13 +251,17 @@ export default async function BoardApiRoutes(
     const issue = await store.getIssueById(id);
 
     if (!issue) {
-      return res.status(404).json({}) && null;
+      res.status(404).json({});
+
+      return;
     }
 
     const column = columns.getByName(columnName);
 
     if (!column) {
-      return res.status(404).json({}) && null;
+      res.status(404).json({});
+
+      return;
     }
 
     const repo = repoAndOwner(issue);
@@ -265,7 +269,9 @@ export default async function BoardApiRoutes(
     const canWrite = await userAccess.canWrite(user, repo);
 
     if (!canWrite) {
-      return res.status(403).json({}) && null;
+      res.status(403).json({});
+
+      return;
     }
 
     const octokit = await githubClient.getUserScoped(user);
@@ -280,15 +286,13 @@ export default async function BoardApiRoutes(
       }
     };
 
-    return (
-      moveIssue(context, issue, column, { before, after }).then(() => {
-        res.type('json').json({});
-      }).catch(err => {
-        log.error(err, 'failed to move issue');
+    return moveIssue(context, issue, column, { before, after }).then(() => {
+      res.type('json').json({});
+    }).catch(err => {
+      log.error(err, 'failed to move issue');
 
-        res.status(500).json({ error : true });
-      })
-    ) && null;
+      res.status(500).json({ error : true });
+    });
 
   });
 

package/lib/apps/dump-store/s3/S3.js

@@ -16,6 +16,18 @@ export default function S3() {
     S3_ENDPOINT: endpoint
   } = process.env;
 
+  if (!accessKeyId) {
+    throw new Error('process.env.AWS_ACCESS_KEY_ID required');
+  }
+
+  if (!secretAccessKey) {
+    throw new Error('process.env.AWS_SECRET_ACCESS_KEY required');
+  }
+
+  if (!bucket) {
+    throw new Error('process.env.S3_BUCKET required');
+  }
+
   const s3client = new S3Client({
     region,
     endpoint,

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.
    *
@@ -312,7 +340,7 @@ export default function GithubApp(config, app, logger, injector) {
   /**
    * Get an installation for the given id.
    *
-   * @param {string} id
+   * @param {string|number} id
    *
    * @return {Promise<Installation | undefined>}
    */

package/lib/apps/github-checks/GithubChecks.js

@@ -3,6 +3,8 @@ import { repoAndOwner, Cache } from '../../util/index.js';
 /**
  * This component updates the stored issues based on GitHub events.
  *
+ * It also hooks into `BackgroundSync` to fetch checks for a PR.
+ *
  * @constructor
  *
  * @param {import('../webhook-events/WebhookEvents.js').default} webhookEvents

package/lib/apps/github-comments/GithubComments.js

@@ -1,21 +1,21 @@
-import { repoAndOwner } from '../../util/index.js';
 import { filterUser, filterIssue } from '../../filters.js';
-import gql from 'fake-tag';
 
 
 /**
  * This component updates the stored issues based on GitHub events.
  *
+ * It also hooks into `BackgroundSync` to fetch comments for issues/PRs.
+ *
  * @constructor
  *
  * @param {import('../webhook-events/WebhookEvents.js').default} webhookEvents
  * @param {import('../../events.js').default} events
- * @param {import('../github-client/GithubClient.js').default} githubClient
  * @param {import('../../store.js').default} store
  * @param {import('../issue-filter/IssueFilter.js').default} issueFilter
  * @param {import('../../types.js').Logger } logger
+ * @param {import('./GithubCommentsBackend.js').default} githubCommentsBackend
  */
-export default function GithubComments(webhookEvents, events, githubClient, store, issueFilter, logger) {
+export default function GithubComments(webhookEvents, events, store, issueFilter, logger, githubCommentsBackend) {
 
   const log = logger.child({
     name: 'wuffle:github-comments'
@@ -32,81 +32,10 @@ export default function GithubComments(webhookEvents, events, githubClient, stor
     } = event;
 
     const {
-      id,
-      number
+      id
     } = issue;
 
-    const {
-      repo,
-      owner
-    } = repoAndOwner(issue);
-
-    const github = await githubClient.getOrgScoped(owner);
-
-    const result = await github.graphql(gql`
-
-      fragment CommentInfo on IssueComment {
-        id: databaseId
-        node_id: id
-        body: bodyText
-        created_at: publishedAt
-        authorAssociation,
-        html_url: url,
-        user: author {
-          login
-          avatar_url: avatarUrl,
-          html_url: url
-        }
-      }
-
-      query FetchComments(
-        $repo: String!,
-        $owner: String!,
-        $issue_number: Int!,
-        $after: String
-      ) {
-        repository(name: $repo, owner: $owner) {
-          issueOrPullRequest(number: $issue_number) {
-            ...on Issue {
-              comments(first: 100, after: $after) {
-                edges {
-                  node {
-                    ...CommentInfo
-                  }
-                }
-                pageInfo {
-                  endCursor
-                  hasNextPage
-                }
-                totalCount
-              }
-            }
-            ...on PullRequest {
-              comments(first: 100, after: $after) {
-                edges {
-                  node {
-                    ...CommentInfo
-                  }
-                }
-                pageInfo {
-                  endCursor
-                  hasNextPage
-                }
-                totalCount
-              }
-            }
-          }
-        }
-      }`,
-    {
-      owner,
-      repo,
-      issue_number: number
-    });
-
-    const comments = (
-      result.repository.issueOrPullRequest.comments.edges.map(e => e.node)
-    );
+    const comments = await githubCommentsBackend.getIssueComments(issue);
 
     await store.queueUpdate({
       id,
@@ -115,7 +44,9 @@ export default function GithubComments(webhookEvents, events, githubClient, stor
   });
 
   webhookEvents.on([
-    'issue_comment'
+    'issue_comment.created',
+    'issue_comment.edited',
+    'issue_comment.deleted'
   ], ifEnabled(async ({ payload }) => {
     const {
       action,