wuffle 0.73.3 → 0.75.0

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.js → automatic-dev-flow/AutomaticDevFlow.js}

@@ -12,11 +12,11 @@ const CHANGES_REQUESTED = 'changes_requested';
  *
  * @constructor
  *
- * @param {import('./webhook-events/WebhookEvents.js').default} webhookEvents
- * @param {import('./github-issues/GithubIssues.js').default} githubIssues
- * @param {import('../columns.js').default} columns
- * @param {import('./issue-filter/IssueFilter.js').default} issueFilter
- * @param {import('../types.js').Logger } logger
+ * @param {import('../webhook-events/WebhookEvents.js').default} webhookEvents
+ * @param {import('../github-issues/GithubIssues.js').default} githubIssues
+ * @param {import('../../columns.js').default} columns
+ * @param {import('../issue-filter/IssueFilter.js').default} issueFilter
+ * @param {import('../../types.js').Logger } logger
  */
 export default function(webhookEvents, githubIssues, columns, issueFilter, logger) {
 
@@ -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/automatic-dev-flow/index.js

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

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

@@ -9,38 +9,48 @@ 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 {import('../../types.js').Logger} logger
  * @param {Object} config
+ * @param {import('../../types.js').Logger} logger
  * @param {import('../../store.js').default} store
- * @param {import('../github-client/GithubClient.js').default} githubClient
- * @param {import('../github-app/GithubApp.js').default} githubApp
  * @param {import('../../events.js').default} events
+ * @param {import('./BackgroundSyncBackend.js').default} backgroundSyncBackend
  */
-export default function BackgroundSync(logger, config, store, githubClient, githubApp, events) {
+export default function BackgroundSync(config, logger, store, events, backgroundSyncBackend) {
 
   // 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
   );
 
@@ -101,18 +111,14 @@ We automatically synchronize all repositories you granted us access to via the G
     log.debug({ installation: owner }, 'processing');
 
     try {
-      const octokit = await githubClient.getOrgScoped(owner);
-
-      const repositories = await octokit.paginate(
-        octokit.rest.apps.listReposAccessibleToInstallation,
-        {
-          per_page: 100
-        }
-      );
+      const repositories = await backgroundSyncBackend.getInstallationRepositories(installation);
 
       for (const repository of repositories) {
 
-        const owner = repository.owner.login;
+        if (repository.owner.login !== owner) {
+          throw new Error('repository.owner !== installation.owner');
+        }
+
         const repo = repository.name;
 
         // log found repository
@@ -135,74 +141,12 @@ We automatically synchronize all repositories you granted us access to via the G
             repo
           }, 'processing');
 
-          const params = {
-            sort: /** @type { 'updated' } */ ('updated'),
-            direction: /** @type { 'desc' } */ ('desc'),
-            per_page: 100,
-            owner,
-            repo
-          };
-
-          const [
+          const {
             open_issues,
             closed_issues,
             open_pull_requests,
             closed_pull_requests
-          ] = await Promise.all([
-
-            // open issues
-            octokit.paginate(
-              octokit.rest.issues.listForRepo,
-              {
-                ...params,
-                state: 'open'
-              },
-              response => response.data.filter(issue => !('pull_request' in issue))
-            ),
-
-            // closed issues, updated last 30 days
-            octokit.paginate(
-              octokit.rest.issues.listForRepo,
-              {
-                ...params,
-                state: 'closed',
-                since: new Date(syncClosedSince).toISOString()
-              },
-              response => response.data.filter(issue => !('pull_request' in issue))
-            ),
-
-            // open pulls, all
-            octokit.paginate(
-              octokit.rest.pulls.list,
-              {
-                ...params,
-                state: 'open'
-              }
-            ),
-
-            // closed pulls, updated last 30 days
-            octokit.paginate(
-              octokit.rest.pulls.list,
-              {
-                ...params,
-                state: 'closed'
-              },
-              (response, done) => {
-
-                const pulls = response.data;
-
-                const filtered = pulls.filter(
-                  pull => new Date(pull.updated_at).getTime() > syncClosedSince
-                );
-
-                if (filtered.length !== pulls.length) {
-                  done();
-                }
-
-                return filtered;
-              }
-            )
-          ]);
+          } = await backgroundSyncBackend.getRepositoryIssuesAndPulls(repository, syncClosedSince);
 
           for (const issueOrPull of [
             ...open_issues,
@@ -460,12 +404,19 @@ 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');
 
     try {
-      const installations = await githubApp.getInstallations();
+      const installations = await backgroundSyncBackend.getInstallations();
 
       await doSync(installations);
 
@@ -477,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
@@ -509,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/background-sync/BackgroundSyncBackend.js

@@ -0,0 +1,140 @@
+/**
+ * @typedef { import('../github-app/types.js').Installation } Installation
+ */
+
+/**
+ * This component fetches GitHub data required for background synchronization.
+ *
+ * @constructor
+ *
+ * @param {import('../github-client/GithubClient.js').default} githubClient
+ * @param {import('../github-app/GithubApp.js').default} githubApp
+ */
+export default function BackgroundSyncBackend(githubClient, githubApp) {
+
+  /**
+   * Return available installations.
+   *
+   * @return {Promise<Installation[]>}
+   */
+  async function getInstallations(installation) {
+    return githubApp.getInstallations();
+  }
+
+  /**
+   * Return repositories accessible to a GitHub app installation.
+   *
+   * @param {Installation} installation
+   *
+   * @return {Promise<Array>}
+   */
+  async function getInstallationRepositories(installation) {
+    const owner = installation.account.login;
+    const octokit = await githubClient.getOrgScoped(owner);
+
+    return octokit.paginate(
+      octokit.rest.apps.listReposAccessibleToInstallation,
+      { per_page: 100 }
+    );
+  }
+
+  /**
+   * Fetch issues and pull requests for a repository.
+   *
+   * @param {{ owner: { login: string }, name: string }} repository
+   * @param {number} syncClosedSince
+   *
+   * @return {Promise<{ open_issues: Array, closed_issues: Array, open_pull_requests: Array, closed_pull_requests: Array }>}
+   */
+  async function getRepositoryIssuesAndPulls(repository, syncClosedSince) {
+    const owner = repository.owner.login;
+    const octokit = await githubClient.getOrgScoped(owner);
+
+    const repo = repository.name;
+
+    const params = {
+      sort: /** @type { 'updated' } */ ('updated'),
+      direction: /** @type { 'desc' } */ ('desc'),
+      per_page: 100,
+      owner,
+      repo
+    };
+
+    const [
+      open_issues,
+      closed_issues,
+      open_pull_requests,
+      closed_pull_requests
+    ] = await Promise.all([
+
+      // open issues
+      octokit.paginate(
+        octokit.rest.issues.listForRepo,
+        {
+          ...params,
+          state: 'open'
+        },
+        response => response.data.filter(issue => !('pull_request' in issue))
+      ),
+
+      // closed issues, updated since syncClosedSince
+      octokit.paginate(
+        octokit.rest.issues.listForRepo,
+        {
+          ...params,
+          state: 'closed',
+          since: new Date(syncClosedSince).toISOString()
+        },
+        response => response.data.filter(issue => !('pull_request' in issue))
+      ),
+
+      // open pulls, all
+      octokit.paginate(
+        octokit.rest.pulls.list,
+        {
+          ...params,
+          state: 'open'
+        }
+      ),
+
+      // closed pulls, updated since syncClosedSince
+      octokit.paginate(
+        octokit.rest.pulls.list,
+        {
+          ...params,
+          state: 'closed'
+        },
+        (response, done) => {
+
+          const pulls = response.data;
+
+          const filtered = pulls.filter(
+            pull => new Date(pull.updated_at).getTime() > syncClosedSince
+          );
+
+          if (filtered.length !== pulls.length) {
+            done();
+          }
+
+          return filtered;
+        }
+      )
+    ]);
+
+    return {
+      open_issues,
+      closed_issues,
+      open_pull_requests,
+      closed_pull_requests
+    };
+  }
+
+
+  // api ///////////////////
+
+  this.getInstallations = getInstallations;
+
+  this.getInstallationRepositories = getInstallationRepositories;
+
+  this.getRepositoryIssuesAndPulls = getRepositoryIssuesAndPulls;
+}

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

@@ -1,6 +1,8 @@
 import BackgroundSync from './BackgroundSync.js';
+import BackgroundSyncBackend from './BackgroundSyncBackend.js';
 
 export default {
   __init__: [ 'backgroundSync' ],
-  backgroundSync: [ 'type', BackgroundSync ]
+  backgroundSync: [ 'type', BackgroundSync ],
+  backgroundSyncBackend: [ 'type', BackgroundSyncBackend ]
 };

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

@@ -172,7 +172,7 @@ export default async function BoardApiRoutes(
     const items = store.getBoard();
     const cursor = store.getUpdateCursor();
 
-    return filterBoardItems(req, items).then(filteredItems => {
+    filterBoardItems(req, items).then(filteredItems => {
 
       return res.type('json').json({
         items: filteredItems,
@@ -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;
 
@@ -236,7 +236,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 +253,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 +271,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 +288,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');
+    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.js → events-sync/EventsSync.js}

@@ -5,7 +5,7 @@ import {
   filterRepository,
   getIdentifier,
   getKey
-} from '../filters.js';
+} from '../../filters.js';
 
 
 /**
@@ -13,14 +13,14 @@ import {
  *
  * @constructor
  *
- * @param {import('./webhook-events/WebhookEvents.js').default} webhookEvents
- * @param {import('../store.js').default} store
- * @param {import('../types.js').Logger} logger
+ * @param {import('../webhook-events/WebhookEvents.js').default} webhookEvents
+ * @param {import('../../store.js').default} store
+ * @param {import('../../types.js').Logger} logger
  */
 export default function EventsSync(webhookEvents, store, logger) {
 
   const log = logger.child({
-    name: 'wuffle:user-access'
+    name: 'wuffle:events-sync'
   });
 
   // issues /////////////////////
@@ -104,6 +104,8 @@ export default function EventsSync(webhookEvents, store, logger) {
     'pull_request.converted_to_draft',
     'pull_request.assigned',
     'pull_request.unassigned',
+    'pull_request.milestoned',
+    'pull_request.demilestoned',
     'pull_request.synchronize',
     'pull_request.closed',
     'pull_request.review_requested',

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

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