wuffle 0.41.5 → 0.43.0

package/lib/apps/github-issues/GithubIssues.js

@@ -8,13 +8,19 @@ const {
 } = linkTypes;
 
 
+/**
+ * @constructor
+ *
+ * @param {import('../../types').Logger} logger
+ * @param {any} config
+ * @param {import('../../columns')} columns
+ */
 function GithubIssues(logger, config, columns) {
 
   const log = logger.child({
     name: 'wuffle:github-issues'
   });
 
-
   function getAssigneeUpdate(issue, newAssignee) {
 
     if (!newAssignee) {
@@ -49,27 +55,25 @@ function GithubIssues(logger, config, columns) {
       };
     }
 
+    return update;
+  }
+
+  function getLabelUpdate(issue, newColumn) {
+
     const issueLabels = issue.labels.map(l => l.name);
 
     const newLabel = newColumn.label;
 
-    const labelsToAdd = (!newLabel || issueLabels.includes(newLabel)) ? [] : [ newLabel ];
+    const addLabels = (!newLabel || issueLabels.includes(newLabel)) ? [] : [ newLabel ];
 
-    const labelsToRemove = columns.getAll().map(c => c.label).filter(
+    const removeLabels = columns.getAll().map(c => c.label).filter(
       label => label && label !== newLabel && issueLabels.includes(label)
     );
 
-    if (labelsToRemove.length || labelsToAdd.length) {
-      update = {
-        ...update,
-        labels: [
-          ...issueLabels.filter(l => !labelsToRemove.includes(l)),
-          ...labelsToAdd
-        ]
-      };
-    }
-
-    return update;
+    return {
+      addLabels,
+      removeLabels
+    };
   }
 
   function findIssue(context, issue_number) {
@@ -138,18 +142,67 @@ function GithubIssues(logger, config, columns) {
       ...getStateUpdate(issue, newColumn)
     };
 
-    if (!hasKeys(update)) {
-      return;
+    const {
+      addLabels,
+      removeLabels
+    } = getLabelUpdate(issue, newColumn);
+
+    const invocations = [];
+
+    if (hasKeys(addLabels)) {
+
+      const addLabelParams = context.repo({
+        issue_number,
+        labels: addLabels
+      });
+
+      log.info(addLabelParams, 'add labels');
+
+      invocations.push(
+        context.octokit.issues.addLabels(addLabelParams)
+      );
     }
 
-    const params = context.repo({
-      issue_number,
-      ...update
-    });
+    if (hasKeys(update)) {
 
-    log.info(params, 'update');
+      const params = context.repo({
+        issue_number,
+        ...update
+      });
+
+      log.info(params, 'update');
 
-    return context.octokit.issues.update(params);
+      invocations.push(
+        context.octokit.issues.update(params)
+      );
+    }
+
+    for (const label of removeLabels) {
+
+      const removeLabelParams = context.repo({
+        issue_number,
+        name: label
+      });
+
+      log.info({
+        ...removeLabelParams,
+        label
+      }, 'remove label');
+
+      invocations.push(
+        context.octokit.issues.removeLabel(removeLabelParams).catch(err => {
+
+          // gracefully handle non-existing label
+          // may have been already removed by other
+          // integrations
+          if (err.status !== 404) {
+            return Promise.reject(err);
+          }
+        })
+      );
+    }
+
+    return Promise.all(invocations);
   }
 
 
@@ -163,6 +216,8 @@ function GithubIssues(logger, config, columns) {
 
   this.getAssigneeUpdate = getAssigneeUpdate;
 
+  this.getLabelUpdate = getLabelUpdate;
+
   this.findAndMoveIssue = findAndMoveIssue;
 
 }

package/lib/apps/github-reviews/GithubReviews.js

@@ -11,7 +11,9 @@ const {
 /**
  * This component updates the stored issues based on GitHub events.
  *
- * @param {import("../webhook-events/WebhookEvents")} webhookEvents
+ * @constructor
+ *
+ * @param {import('../webhook-events/WebhookEvents')} webhookEvents
  * @param {import('../../events')} events
  * @param {import('../github-client/GithubClient')} githubClient
  * @param {import('../../store')} store
@@ -120,7 +122,8 @@ function filterReview(review) {
     commit_id,
     submitted_at,
     state,
-    user
+    user,
+    html_url
   } = review;
 
   return {
@@ -130,6 +133,7 @@ function filterReview(review) {
     commit_id,
     submitted_at,
     state: state.toLowerCase(),
-    user: filterUser(user)
+    user: filterUser(user),
+    html_url
   };
 }

package/lib/apps/github-statuses/GithubStatuses.js

@@ -11,6 +11,8 @@ const {
 /**
  * This component updates synchronizes GitHub statuses with pull requests.
  *
+ * @constructor
+ *
  * @param {import('../webhook-events/WebhookEvents')} webhookEvents
  * @param {import('../../events')} events
  * @param {import('../github-client/GithubClient')} githubClient

package/lib/apps/log-events.js

@@ -8,10 +8,12 @@ const fs = require('fs').promises;
  * This component adds the #onActive method to subscribe to events
  * for explicitly activated repositories only.
  *
- * @param {import("../types").Logger} logger
- * @param {import("./webhook-events/WebhookEvents")} webhookEvents
+ * @constructor
+ *
+ * @param {import('../types').Logger} logger
+ * @param {import('./webhook-events/WebhookEvents')} webhookEvents
  */
-module.exports = function(logger, webhookEvents) {
+function LogEvents(logger, webhookEvents) {
 
   if (process.env.NODE_ENV !== 'development' && !process.env.LOG_WEBHOOK_EVENTS) {
     return;
@@ -47,15 +49,17 @@ module.exports = function(logger, webhookEvents) {
 
   // behavior //////////////////////
 
-  webhookEvents.on('*', async context => {
+  webhookEvents.onAny(async context => {
     const {
-      event,
+      name,
       payload
     } = context;
 
-    write(event, payload).catch(err => {
+    write(name, payload).catch(err => {
       log.error(err, 'failed to log event');
     });
   });
 
-};
+}
+
+module.exports = LogEvents;

package/lib/apps/reindex-store.js

@@ -2,7 +2,16 @@ const {
   version
 } = require('../../package.json');
 
-module.exports = function ReindexStore(logger, config, events, store) {
+
+/**
+ * @constructor
+ *
+ * @param {any} logger
+ * @param {any} config
+ * @param {any} events
+ * @param {any} store
+ */
+function ReindexStore(logger, config, events, store) {
 
   const log = logger.child({
     name: 'wuffle:reindex-store'
@@ -49,7 +58,10 @@ module.exports = function ReindexStore(logger, config, events, store) {
     data.wuffleVersion = version;
   });
 
-};
+}
+
+module.exports = ReindexStore;
+
 
 // helpers //////////////////
 

package/lib/apps/route-compression.js

@@ -3,7 +3,7 @@ const compression = require('compression');
 /**
  * Enables compression for routes
  *
- * @param {import("express").Router} router
+ * @param {import('express').Router} router
  */
 module.exports = function(router) {
 

package/lib/apps/route-https.js

@@ -5,7 +5,7 @@ const {
 /**
  * Enables https redirects and strict transport security.
  *
- * @param {import("express").Router} router
+ * @param {import('express').Router} router
  */
 module.exports = function(router) {
 

package/lib/apps/search/Search.js

@@ -11,8 +11,10 @@ const {
 /**
  * This app allows you to create a search filter from a given term.
  *
- * @param {import("../../types").Logger} logger
- * @param {import("../../store")} store
+ * @constructor
+ *
+ * @param {import('../../types').Logger} logger
+ * @param {import('../../store')} store
  */
 function Search(logger, store) {
 
@@ -181,13 +183,38 @@ function Search(logger, store) {
       };
     },
 
+    commented: function commentedFilter(name) {
+
+      return function filterCommented(issue) {
+
+        const {
+          comments
+        } = issue;
+
+        // issues do not have comments attached
+        if (!Array.isArray(comments)) {
+          return false;
+        }
+
+        return (
+          comments.some(comment => fuzzyMatches(comment.user.login, name))
+        );
+      };
+    },
+
     involves: function involvesFilter(name) {
 
+      const isAssigned = filters.assignee(name);
+      const isAuthor = filters.author(name);
+      const isReviewer = filters.reviewer(name);
+      const hasCommented = filters.commented(name);
+
       return function filterInvolves(issue) {
         return (
-          filters.assignee(name)(issue) ||
-          filters.author(name)(issue) ||
-          filters.reviewer(name)(issue)
+          isAssigned(issue) ||
+          isAuthor(issue) ||
+          isReviewer(issue) ||
+          hasCommented(issue)
         );
       };
     },

package/lib/apps/security-context/SecurityContext.js

@@ -1,3 +1,8 @@
+/**
+ * @constructor
+ *
+ * @param {import('../github-client/GithubClient')} githubClient
+ */
 function SecurityContext(githubClient) {
 
   /**

package/lib/apps/user-access/UserAccess.js

@@ -8,10 +8,12 @@ const TTL = 1000 * 60 * 60 * 24 * 9;
  * This component provides the functionality to filter
  * issues based on user views.
  *
- * @param {import("../../types").Logger} logger
- * @param {import("../github-client/GithubClient")} githubClient
- * @param {import("../../events")} events
- * @param {import("../webhook-events/WebhookEvents")} webhookEvents
+ * @constructor
+ *
+ * @param {import('../../types').Logger} logger
+ * @param {import('../github-client/GithubClient')} githubClient
+ * @param {import('../../events')} events
+ * @param {import('../webhook-events/WebhookEvents')} webhookEvents
  */
 function UserAccess(logger, githubClient, events, webhookEvents) {
 

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

@@ -1,15 +1,18 @@
+/**
+ * @constructor
+ *
+ * @param {import('../../types').ProbotApp} app
+ * @param {import('../github-app/GithubApp')} githubApp
+ */
 function WebhookEvents(app, githubApp) {
 
   /**
-   * Register a event lister for a single
-   * or a number of webhook events.
-   *
-   * @param {String|Array<String>} events
-   * @param {Function} fn listener
+   * @template {Function} T
+   * @param {T} fn
    */
-  function on(events, fn) {
-    app.on(events, async context => {
+  function ifEnabled(fn) {
 
+    return async (context) => {
       const {
         payload
       } = context;
@@ -27,13 +30,34 @@ function WebhookEvents(app, githubApp) {
       }
 
       return fn(context);
-    });
+    };
+  }
+
+  /**
+   * Register a event lister for a single
+   * or a number of webhook events.
+   *
+   * @param {any|any[]} events
+   * @param {Function} fn listener
+   */
+  function on(events, fn) {
+    app.on(events, ifEnabled(fn));
+  }
+
+  /**
+   * Register an event listener for all
+   * webhook events.
+   *
+   * @param {Function} fn
+   */
+  function onAny(fn) {
+    app.onAny(ifEnabled(fn));
   }
 
   // api /////////////////
 
   this.on = on;
-
+  this.onAny = onAny;
 }
 
 module.exports = WebhookEvents;

package/lib/columns.js

@@ -14,9 +14,15 @@ const StateToNames = {
   EXTERNAL_CONTRIBUTION: 'Inbox'
 };
 
+/**
+ * @typedef { { name: string, label?: string|null, closed?: boolean } } ColumnDefinition
+ */
 
 class Columns {
 
+  /**
+   * @param { ColumnDefinition[] } columns
+   */
   constructor(columns) {
     this.columns = columns;
 
@@ -89,7 +95,11 @@ function createColumnGetter(columns) {
 
   return function(issue) {
 
-    const column = sortedColumns.find(column => {
+    const {
+      column: issueColumn
+    } = issue;
+
+    const columns = sortedColumns.filter(column => {
 
       const issueClosed = issue.state === 'closed';
 
@@ -101,14 +111,17 @@ function createColumnGetter(columns) {
         return false;
       }
 
-      if (!columnLabel) {
+      if (!columnLabel && defaultColumn !== column) {
         return true;
       }
 
       return issue.labels.find(l => l.name === columnLabel);
     });
 
-    return (column || defaultColumn);
+    // ensure that column is stable; it only changes
+    // if the given configuration doesn't match the
+    // existing column
+    return columns.find(c => c.name === issueColumn) || columns[0] || defaultColumn;
   };
 }
 

package/lib/filters.js

@@ -31,7 +31,8 @@ function filterRepository(githubRepository) {
     node_id,
     name,
     'private': isPrivate,
-    owner
+    owner,
+    html_url
   } = githubRepository;
 
   return {
@@ -39,7 +40,8 @@ function filterRepository(githubRepository) {
     node_id,
     name,
     'private': isPrivate,
-    owner: filterUser(owner)
+    owner: filterUser(owner),
+    html_url
   };
 }
 
@@ -52,14 +54,16 @@ function filterUser(githubUser) {
     id,
     node_id,
     login,
-    avatar_url
+    avatar_url,
+    html_url
   } = githubUser;
 
   return {
     id,
     node_id,
     login,
-    avatar_url
+    avatar_url,
+    html_url
   };
 }
 
@@ -112,7 +116,8 @@ function filterMilestone(githubMilestone) {
     node_id,
     number,
     title,
-    state
+    state,
+    html_url
   } = githubMilestone;
 
   return {
@@ -120,7 +125,8 @@ function filterMilestone(githubMilestone) {
     node_id,
     number,
     title,
-    state
+    state,
+    html_url
   };
 }
 
@@ -153,12 +159,11 @@ function filterPull(githubPull, githubRepository) {
     mergeable,
     mergeable_state,
     merged_by,
-    comments,
-    review_comments,
     commits,
     additions,
     deletions,
-    changed_files
+    changed_files,
+    html_url
   } = githubPull;
 
   // stable ID that is independent from GitHubs internal issue/pr distinction
@@ -192,14 +197,13 @@ function filterPull(githubPull, githubRepository) {
     mergeable,
     mergeable_state,
     merged_by,
-    comments,
-    review_comments,
     commits,
     additions,
     deletions,
     changed_files,
     pull_request: true,
-    repository: filterRepository(githubRepository)
+    repository: filterRepository(githubRepository),
+    html_url
   };
 }
 
@@ -221,8 +225,8 @@ function filterIssue(githubIssue, githubRepository) {
     assignees,
     labels,
     milestone,
-    comments,
-    pull_request
+    pull_request,
+    html_url
   } = githubIssue;
 
   // stable ID that is independent from GitHubs internal issue/pr distinction
@@ -249,9 +253,9 @@ function filterIssue(githubIssue, githubRepository) {
     assignees: assignees.map(filterUser),
     labels: labels.map(filterLabel),
     milestone: milestone ? filterMilestone(milestone) : null,
-    comments,
     repository: filterRepository(githubRepository),
-    pull_request: !!pull_request
+    pull_request: !!pull_request,
+    html_url
   };
 
 }

package/lib/index.js

@@ -15,6 +15,7 @@ const apps = [
   require('./apps/events-sync'),
   require('./apps/github-app'),
   require('./apps/github-issues'),
+  require('./apps/github-comments'),
   require('./apps/github-client'),
   require('./apps/github-checks'),
   require('./apps/github-reviews'),

package/lib/links.js

@@ -19,6 +19,9 @@ const InverseLinkTypes = {
   LINKED_TO: LinkTypes.LINKED_BY
 };
 
+/**
+ * @typedef { { sourceId: string, targetId: string, type: string, key: string } } Link
+ */
 
 /**
  * A utility to maintain links
@@ -30,6 +33,13 @@ class Links {
     this.inverseLinks = (data && data.inverseLinks) || {};
   }
 
+  /**
+   * @param {string} sourceId
+   * @param {string} targetId
+   * @param {string} linkType
+   *
+   * @return {Link}
+   */
   createLink(sourceId, targetId, linkType) {
 
     const key = `${targetId}-${linkType}`;
@@ -47,7 +57,7 @@ class Links {
   /**
    * Establish a link between source and target with the given type.
    *
-   * @param {Object} link
+   * @param {Link} link
    */
   addLink(link) {
 
@@ -92,9 +102,9 @@ class Links {
   /**
    * Get all links that have the issue as the source.
    *
-   * @param {number} sourceId
+   * @param {string} sourceId
    *
-   * @return {Array<Object>} links
+   * @return {Link[]} links
    */
   getBySource(sourceId) {
     const links = this.getDirect(sourceId);
@@ -118,9 +128,9 @@ class Links {
   /**
    * Remove primary links that have the issue as the source.
    *
-   * @param {number} sourceId
+   * @param {string} sourceId
    *
-   * @return {Object} removedLinks
+   * @return {Link[]} removedLinks
    */
   removeBySource(sourceId) {
 

package/lib/probot/apps/setup.js

@@ -91,7 +91,7 @@ function getBaseUrl(req) {
 }
 
 
-function renderSuccess(appUrl=null) {
+function renderSuccess(appUrl = null) {
 
   return `
 <!DOCTYPE html>

package/lib/probot/manifest-creation.js

@@ -17,7 +17,7 @@ class ManifestCreation extends ProbotManifestCreation {
     const options = {
       code,
       mediaType: {
-        previews: ['fury'] // needed for GHES 2.20 and older
+        previews: [ 'fury' ] // needed for GHES 2.20 and older
       },
       ...(process.env.GHE_HOST && {
         baseUrl: `${process.env.GHE_PROTOCOL || 'https'}://${

package/lib/store.js

@@ -15,8 +15,19 @@ const {
 const { Links } = require('./links');
 
 
+/**
+ * The store that holds all board data
+ * and makes it accessible.
+ */
 class Store {
 
+  /**
+   * @param {import('./columns')} columns
+   * @param {import('./types').Logger} logger
+   * @param {import('./events')} events
+   *
+   * @constructor
+   */
   constructor(columns, logger, events) {
     this.log = logger.child({
       name: 'wuffle:store'