wuffle 0.41.5 → 0.43.0

package/bin/run.js

@@ -156,7 +156,7 @@ async function validate() {
     }
   }
 
-  function checkEnv(key, isError=false) {
+  function checkEnv(key, isError = false) {
 
     if (!process.env[key]) {
       return (isError ? error : warning)(

package/lib/apps/auth-routes/AuthRoutes.js

@@ -23,9 +23,11 @@ const {
  * Under the hood, it uses GitHub's APIs to perform user authentication
  * via OAuth.
  *
- * @param {import("../../types").Logger} logger
- * @param {import("../../types").Router} router
- * @param {import("../security-context/SecurityContext")} securityContext
+ * @constructor
+ *
+ * @param {import('../../types').Logger} logger
+ * @param {import('../../types').Router} router
+ * @param {import('../security-context/SecurityContext')} securityContext
  */
 function AuthRoutes(logger, router, securityContext) {
 

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

@@ -9,6 +9,8 @@ const IN_REVIEW = 'IN_REVIEW';
  * across the board, as long as the user adheres to a specified
  * dev flow.
  *
+ * @constructor
+ *
  * @param {import('./webhook-events/WebhookEvents')} webhookEvents
  * @param {import('./github-issues/GithubIssues')} githubIssues
  * @param {import('../columns')} columns

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

@@ -15,12 +15,14 @@ function isInternalError(error) {
 /**
  * This component performs a periodic background sync of a project.
  *
- * @param {import("../../types").Logger} logger
+ * @constructor
+ *
+ * @param {import('../../types').Logger} logger
  * @param {Object} config
- * @param {import("../../store")} store
- * @param {import("../github-client/GithubClient")} githubClient
- * @param {import("../github-app/GithubApp")} githubApp
- * @param {import("../../events")} events
+ * @param {import('../../store')} store
+ * @param {import('../github-client/GithubClient')} githubClient
+ * @param {import('../github-app/GithubApp')} githubApp
+ * @param {import('../../events')} events
  */
 function BackgroundSync(logger, config, store, githubClient, githubApp, events) {
 
@@ -140,8 +142,8 @@ We automatically synchronize all repositories you granted us access to via the G
           }, 'processing');
 
           const params = {
-            sort: 'updated',
-            direction: 'desc',
+            sort: /** @type { 'updated' } */ ('updated'),
+            direction: /** @type { 'desc' } */ ('desc'),
             per_page: 100,
             owner,
             repo
@@ -161,7 +163,7 @@ We automatically synchronize all repositories you granted us access to via the G
                 ...params,
                 state: 'open'
               },
-              response => response.data.filter(issue => !issue.pull_request)
+              response => response.data.filter(issue => !('pull_request' in issue))
             ),
 
             // closed issues, updated last 30 days
@@ -172,7 +174,7 @@ We automatically synchronize all repositories you granted us access to via the G
                 state: 'closed',
                 since: new Date(syncClosedSince).toISOString()
               },
-              response => response.data.filter(issue => !issue.pull_request)
+              response => response.data.filter(issue => !('pull_request' in issue))
             ),
 
             // open pulls

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

@@ -13,9 +13,9 @@ const {
  * This component provides the board API routes.
  *
  * @param {Object} config
- * @param {import("../store")} store
- * @param {import("../types").Router} router
- * @param {import("../types").Logger} logger
+ * @param {import('../store')} store
+ * @param {import('../types').Router} router
+ * @param {import('../types').Logger} logger
  * @param {import('./github-client/GithubClient')} githubClient
  * @param {import('./auth-routes/AuthRoutes')} authRoutes
  * @param {import('./user-access/UserAccess')} userAccess

package/lib/apps/board-routes.js

@@ -6,7 +6,7 @@ const path = require('path');
 /**
  * This component provides the publicly accessible board routes.
  *
- * @param {import("express").Router} router
+ * @param {import('express').Router} router
  */
 module.exports = async (router) => {
 

package/lib/apps/dump-store/local/DumpStoreLocal.js

@@ -8,9 +8,11 @@ const mkdirp = require('mkdirp');
  * This component restores a store dump on startup and periodically
  * persists the store to disc.
  *
- * @param {import("../../../types").Logger} logger
- * @param {import("../../../store")} store
- * @param {import("../../../events")} events
+ * @constructor
+ *
+ * @param {import('../../../types').Logger} logger
+ * @param {import('../../../store')} store
+ * @param {import('../../../events')} events
  */
 function DumpStoreLocal(logger, store, events) {
 

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

@@ -5,9 +5,11 @@ const S3 = require('./S3');
  * This component restores a store dump on startup and periodically
  * persists the store to disc.
  *
- * @param  {import("../../../types").Logger} logger
- * @param  {import("../../../store")} store
- * @param  {import("../../../events")} events
+ * @constructor
+ *
+ * @param {import('../../../types').Logger} logger
+ * @param {import('../../../store')} store
+ * @param {import('../../../events')} events
  */
 function DumpStoreS3(logger, store, events) {
 

package/lib/apps/events-sync.js

@@ -11,11 +11,13 @@ const {
 /**
  * This component updates the stored issues based on GitHub events.
  *
- * @param {import("./webhook-events/WebhookEvents")} webhookEvents
- * @param {import("../store")} store
- * @param {import("../types").Logger} logger
+ * @constructor
+ *
+ * @param {import('./webhook-events/WebhookEvents')} webhookEvents
+ * @param {import('../store')} store
+ * @param {import('../types').Logger} logger
  */
-module.exports = function EventsSync(webhookEvents, store, logger) {
+function EventsSync(webhookEvents, store, logger) {
 
   const log = logger.child({
     name: 'wuffle:user-access'
@@ -71,6 +73,25 @@ module.exports = function EventsSync(webhookEvents, store, logger) {
     return store.removeIssueById(id);
   });
 
+  // issue_comment ///////////////////////
+
+  // https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/webhook-events-and-payloads#issue_comment
+
+  webhookEvents.on([
+    'issue_comment.created',
+    'issue_comment.edited'
+  ], async ({ payload }) => {
+
+    const {
+      issue,
+      repository
+    } = payload;
+
+    // necro bump issue on comment
+    return store.updateIssue(filterIssueOrPull(issue, repository));
+  });
+
+
   // pull requests //////////////////
 
   webhookEvents.on([
@@ -203,19 +224,6 @@ module.exports = function EventsSync(webhookEvents, store, logger) {
   });
 
 
-  // issue_comment ///////////////////////
-
-  // https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/webhook-events-and-payloads#issue_comment
-
-  webhookEvents.on([
-    'issue_comment.created',
-    'issue_comment.edited'
-  ], async ({ payload }) => {
-
-    // necro bump issue
-  });
-
-
   // issues ///////////////////////////////
 
   // https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/webhook-events-and-payloads#issues
@@ -265,4 +273,6 @@ module.exports = function EventsSync(webhookEvents, store, logger) {
     return store.removeIssueById(storedIssue.id);
   });
 
-};
+}
+
+module.exports = EventsSync;

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

@@ -34,10 +34,12 @@ const RequiredEvents = [
  * This component validates and exposes
  * installations of the GitHub app.
  *
+ * @constructor
+ *
  * @param {Object} config
- * @param {import("../../types").ProbotApp} app
- * @param {import("../../types").Logger} logger
- * @param {import("../../types").Injector} injector
+ * @param {import('../../types').ProbotApp} app
+ * @param {import('../../types').Logger} logger
+ * @param {import('../../types').Injector} injector
  */
 function GithubApp(config, app, logger, injector) {
 
@@ -68,6 +70,9 @@ function GithubApp(config, app, logger, injector) {
 
   // functionality /////////////////
 
+  /**
+   * @return {Promise<import('../../types').Octokit>}
+   */
   function getAppScopedClient() {
     return app.auth();
   }
@@ -159,6 +164,11 @@ function GithubApp(config, app, logger, injector) {
     return getInstallationById(installation_id).then(installation => !!installation);
   }
 
+  /**
+   * @param {string} login
+   *
+   * @return {boolean}
+   */
   function isLoginEnabled(login) {
     if (allowedOrgs) {
       return allowedOrgs.some(org => org === login);
@@ -167,6 +177,12 @@ function GithubApp(config, app, logger, injector) {
     return true;
   }
 
+  /**
+   * @param {string} requested
+   * @param {string} actual
+   *
+   * @return {boolean}
+   */
   function isRequiredLevel(requested, actual) {
     return PermissionLevels[requested] <= PermissionLevels[actual || 'none'];
   }

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

@@ -6,10 +6,12 @@ const {
 /**
  * This component updates the stored issues based on GitHub events.
  *
- * @param {import("../webhook-events/WebhookEvents")} webhookEvents
- * @param {import("../../events")} events
- * @param {import("../github-client/GithubClient")} githubClient
- * @param {import("../../store")} store
+ * @constructor
+ *
+ * @param {import('../webhook-events/WebhookEvents')} webhookEvents
+ * @param {import('../../events')} events
+ * @param {import('../github-client/GithubClient')} githubClient
+ * @param {import('../../store')} store
  */
 module.exports = function GithubChecks(webhookEvents, events, githubClient, store) {
 

package/lib/apps/github-client/GithubClient.js

@@ -10,7 +10,20 @@ const {
 // 15 minutes
 const TTL = 1000 * 60 * 15;
 
-
+/**
+ * @typedef { import('../../types').Octokit } Octokit
+ * @typedef { { [x: string]: Promise<Octokit> } } LoginCache
+ */
+
+/**
+ * @constructor
+ *
+ * @param {import('../../types').ProbotApp} app
+ * @param {import('../webhook-events/WebhookEvents')} webhookEvents
+ * @param {import('../../types').Logger} logger
+ * @param {import('../github-app/GithubApp')} githubApp
+ * @param {import('../../events')} events
+ */
 function GitHubClient(app, webhookEvents, logger, githubApp, events) {
 
   const log = logger.child({
@@ -21,7 +34,7 @@ function GitHubClient(app, webhookEvents, logger, githubApp, events) {
 
   // cached data ///////////////////
 
-  let authByLogin = {};
+  let authByLogin = /** @type { LoginCache } */ ({});
 
 
   // reactivity ////////////////////
@@ -33,10 +46,20 @@ function GitHubClient(app, webhookEvents, logger, githubApp, events) {
 
   // functionality /////////////////
 
+  /**
+   * @param {number} id
+   *
+   * @return {Promise<Octokit>}
+   */
   function getInstallationScoped(id) {
     return app.auth(id);
   }
 
+  /**
+   * @param {string} login
+   *
+   * @return {Promise<Octokit>}
+   */
   function getOrgScoped(login) {
 
     let auth = authByLogin[login];
@@ -50,7 +73,7 @@ function GitHubClient(app, webhookEvents, logger, githubApp, events) {
     auth = authByLogin[login] =
       githubApp.getInstallationByLogin(login)
         .then(
-          installation => this.getInstallationScoped(installation.id),
+          installation => getInstallationScoped(installation.id),
           err => {
             log.error({
               err,
@@ -64,6 +87,13 @@ function GitHubClient(app, webhookEvents, logger, githubApp, events) {
     return auth;
   }
 
+  /**
+   * Return user scoped octokit instance.
+   *
+   * @param {string|{ access_token: string }} user
+   *
+   * @return {Promise<Octokit>}
+   */
   function getUserScoped(user) {
 
     const access_token = typeof user === 'string' ? user : user.access_token;

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

@@ -0,0 +1,205 @@
+const {
+  repoAndOwner
+} = require('../../util');
+
+const {
+  filterUser,
+  filterIssue
+} = require('../../filters');
+
+const gql = require('fake-tag');
+
+
+/**
+ * This component updates the stored issues based on GitHub events.
+ *
+ * @constructor
+ *
+ * @param {import('../webhook-events/WebhookEvents')} webhookEvents
+ * @param {import('../../events')} events
+ * @param {import('../github-client/GithubClient')} githubClient
+ * @param {import('../../store')} store
+ */
+function GithubComments(webhookEvents, events, githubClient, store) {
+
+  // issues /////////////////////
+
+  events.on('backgroundSync.sync', async (event) => {
+
+    const {
+      issue
+    } = event;
+
+    const {
+      id,
+      number
+    } = 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)
+    );
+
+    await store.queueUpdate({
+      id,
+      comments: comments.map(filterComment)
+    });
+  });
+
+  webhookEvents.on([
+    'issue_comment'
+  ], async ({ payload }) => {
+    const {
+      action,
+      comment: _comment,
+      issue: _issue,
+      repository
+    } = payload;
+
+    const commentedIssue = filterIssue(_issue, repository);
+    const comment = filterComment(_comment);
+
+    const {
+      id
+    } = commentedIssue;
+
+    const issue = await store.getIssueById(id);
+
+    let comments = Array.isArray(issue.comments)
+      ? issue.comments
+      : [];
+
+    if (action === 'created') {
+      comments = [
+        ...comments,
+        comment
+      ];
+    }
+
+    if (action === 'deleted') {
+      const index = comments.findIndex(c => c.id === comment.id);
+
+      if (index !== -1) {
+        comments = [
+          ...comments.slice(0, index),
+          ...comments.slice(index + 1)
+        ];
+      }
+    }
+
+    if (action === 'edited') {
+
+      const index = comments.findIndex(c => c.id === comment.id);
+
+      if (index !== -1) {
+        comments = [
+          ...comments.slice(0, index),
+          comment,
+          ...comments.slice(index + 1)
+        ];
+      } else {
+        comments = [
+          ...comments,
+          comment
+        ];
+      }
+    }
+
+    await store.updateIssue({
+      ...commentedIssue,
+      comments
+    });
+  });
+
+}
+
+module.exports = GithubComments;
+
+
+function filterComment(comment) {
+
+  const {
+    id,
+    node_id,
+    body,
+    created_at,
+    html_url,
+    user
+  } = comment;
+
+  return {
+    id,
+    node_id,
+    body,
+    created_at,
+    html_url,
+    user: filterUser(user)
+  };
+}

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

@@ -0,0 +1,6 @@
+const GithubComments = require('./GithubComments');
+
+module.exports = {
+  __init__: [ 'githubComments' ],
+  githubComments: [ 'type', GithubComments ]
+};