wuffle 0.74.0 → 0.76.0

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

@@ -0,0 +1,132 @@
+import { repoAndOwner } from '../../util/index.js';
+
+import gql from 'fake-tag';
+
+/**
+ * @typedef { {
+ *   id: number,
+ *   node_id: string,
+ *   body: string,
+ *   created_at: string,
+ *   authorAssociation: string,
+ *   html_url: string,
+ *   user: {
+ *     id: number,
+ *     node_id: string,
+ *     login: string,
+ *     avatar_url: string,
+ *     html_url: string,
+ *     type: string
+ *   }
+ * } } GithubComment
+ *
+ * @typedef { import('../../util/meta.js').Issue } Issue
+ */
+
+
+/**
+ * This component fetches GitHub comments data required for background synchronization.
+ *
+ * @constructor
+ *
+ * @param {import('../github-client/GithubClient.js').default} githubClient
+ */
+export default function GithubCommentsBackend(githubClient) {
+
+  /**
+   * Return comments for given issue.
+   *
+   * @param {Issue} issue
+   *
+   * @return {Promise<GithubComment[]>}
+   */
+  this.getIssueComments = async function(issue) {
+
+    const {
+      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,
+          type: __typename
+          ... on User {
+            id: databaseId
+            node_id: id
+          }
+          ... on Bot {
+            id: databaseId
+            node_id: id
+          }
+        }
+      }
+
+      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 = /** @type { GithubComment[] } */ (
+      result.repository.issueOrPullRequest.comments.edges.map(e => e.node)
+    );
+
+    return comments;
+  };
+}

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

@@ -1,6 +1,8 @@
 import GithubComments from './GithubComments.js';
+import GithubCommentsBackend from './GithubCommentsBackend.js';
 
 export default {
   __init__: [ 'githubComments' ],
-  githubComments: [ 'type', GithubComments ]
+  githubComments: [ 'type', GithubComments ],
+  githubCommentsBackend: [ 'type', GithubCommentsBackend ]
 };

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

@@ -4,8 +4,17 @@ const {
   CLOSES
 } = linkTypes;
 
+/**
+ * @typedef { import('probot').Context } ProbotContext
+ *
+ * @typedef { import('../../columns.js').ColumnDefinition } ColumnDefinition
+ */
 
 /**
+ * Moves GitHub issues between board columns by applying the
+ * corresponding state (open/closed), label, and assignee changes
+ * via the GitHub API.
+ *
  * @constructor
  *
  * @param {any} config
@@ -18,6 +27,16 @@ export default function GithubIssues(config, logger, columns) {
     name: 'wuffle:github-issues'
   });
 
+  /**
+   * Return the assignee update required to add `newAssignee` to the
+   * issue, or an empty object if the assignee is already set or not
+   * provided.
+   *
+   * @param {Object} issue
+   * @param {string|null} newAssignee
+   *
+   * @return {{ assignees?: string[] }}
+   */
   function getAssigneeUpdate(issue, newAssignee) {
 
     if (!newAssignee) {
@@ -39,6 +58,15 @@ export default function GithubIssues(config, logger, columns) {
 
   }
 
+  /**
+   * Return the state update (`open` / `closed`) required to reflect
+   * the new column, or an empty object if no change is needed.
+   *
+   * @param {Object} issue
+   * @param {ColumnDefinition} newColumn
+   *
+   * @return {{ state?: 'open'|'closed' }}
+   */
   function getStateUpdate(issue, newColumn) {
 
     let update = {};
@@ -55,16 +83,29 @@ export default function GithubIssues(config, logger, columns) {
     return update;
   }
 
+  /**
+   * Return the label changes required to reflect the new column:
+   * the column label to add and any other column labels to remove.
+   *
+   * @param {Object} issue
+   * @param {ColumnDefinition} newColumn
+   *
+   * @return {{ addLabels: string[], removeLabels: string[] }}
+   */
   function getLabelUpdate(issue, newColumn) {
 
-    const issueLabels = issue.labels.map(l => l.name);
+    const issueLabels = /** @type { string[] } */ (
+      issue.labels.map(l => l.name)
+    );
 
     const newLabel = newColumn.label;
 
     const addLabels = (!newLabel || issueLabels.includes(newLabel)) ? [] : [ newLabel ];
 
-    const removeLabels = columns.getAll().map(c => c.label).filter(
-      label => label && label !== newLabel && issueLabels.includes(label)
+    const removeLabels = /** @type { string[] } */ (
+      columns.getAll().map(c => c.label).filter(
+        label => label && label !== newLabel && issueLabels.includes(label)
+      )
     );
 
     return {
@@ -73,6 +114,10 @@ export default function GithubIssues(config, logger, columns) {
     };
   }
 
+  /**
+   * @param {ProbotContext} context
+   * @param {number} issue_number
+   */
   function findIssue(context, issue_number) {
 
     const params = context.repo({ issue_number });
@@ -88,12 +133,43 @@ export default function GithubIssues(config, logger, columns) {
       });
   }
 
-  function findAndMoveIssue(context, number, newColumn, newAssignee, test = (issue) => true) {
-    return findIssue(context, number)
-      .then((issue) => issue && test(issue) && moveIssue(context, issue, newColumn, newAssignee));
+  /**
+   * Fetch an issue by number and move it to a new column if the
+   * optional predicate passes. Resolves to `false` if the issue is
+   * not found or the predicate rejects it.
+   *
+   * @param {ProbotContext} context
+   * @param {number} number
+   * @param {ColumnDefinition} newColumn
+   * @param {string|null} newAssignee
+   * @param {(issue: Object) => boolean} [test]
+   *
+   * @return {Promise<void|false>}
+   */
+  async function findAndMoveIssue(context, number, newColumn, newAssignee, test = (issue) => true) {
+    const issue = await findIssue(context, number);
+
+    if (!issue || !test(issue)) {
+      return false;
+    }
+
+    return moveIssue(context, issue, newColumn, newAssignee);
   }
 
-  async function moveReferencedIssues(context, issue, newColumn, newAssignee) {
+  /**
+   * Move all issues referenced via `closes` links in the given issue
+   * or pull request body to a new column.
+   *
+   * Only issues within the same repository are moved.
+   *
+   * @param {ProbotContext} context
+   * @param {Object} issue
+   * @param {ColumnDefinition} newColumn
+   * @param {string|null} [newAssignee=null]
+   *
+   * @return {Promise<(void|false)[]>}
+   */
+  async function moveReferencedIssues(context, issue, newColumn, newAssignee = null) {
 
     // TODO(nikku): do that lazily, i.e. react to PR label changes?
     // would slower the movement but support manual moving-issue with PR
@@ -128,7 +204,18 @@ export default function GithubIssues(config, logger, columns) {
     }));
   }
 
-  function moveIssue(context, issue, newColumn, newAssignee) {
+  /**
+   * Move an issue to a new column, applying state, label, and
+   * assignee updates via the GitHub API.
+   *
+   * @param {ProbotContext} context
+   * @param {Object} issue
+   * @param {ColumnDefinition} newColumn
+   * @param {string|null} [newAssignee=null]
+   *
+   * @return {Promise<void>}
+   */
+  function moveIssue(context, issue, newColumn, newAssignee = null) {
 
     const {
       number: issue_number
@@ -199,22 +286,87 @@ export default function GithubIssues(config, logger, columns) {
       );
     }
 
-    return Promise.all(invocations);
+    return Promise.all(invocations).then(() => {});
   }
 
 
   // api /////////////////////////////
 
+  /**
+   * Move an issue to a new column, applying state, label, and
+   * assignee updates via the GitHub API.
+   *
+   * @param {ProbotContext} context
+   * @param {Object} issue
+   * @param {ColumnDefinition} newColumn
+   * @param {string} [newAssignee]
+   *
+   * @return {Promise<void>}
+   */
   this.moveIssue = moveIssue;
 
+  /**
+   * Move all issues referenced via `closes` links in the given issue
+   * or pull request body to a new column.
+   *
+   * Only issues within the same repository are moved.
+   *
+   * @param {ProbotContext} context
+   * @param {Object} issue
+   * @param {ColumnDefinition} newColumn
+   * @param {string|null} [newAssignee=null]
+   *
+   * @return {Promise<(void|false)[]>}
+   */
   this.moveReferencedIssues = moveReferencedIssues;
 
+  /**
+   * Return the state update (`open` / `closed`) required to reflect
+   * the new column, or an empty object if no change is needed.
+   *
+   * @param {Object} issue
+   * @param {ColumnDefinition} newColumn
+   *
+   * @return {{ state?: 'open'|'closed' }}
+   */
   this.getStateUpdate = getStateUpdate;
 
+  /**
+   * Return the assignee update required to add `newAssignee` to the
+   * issue, or an empty object if the assignee is already set or not
+   * provided.
+   *
+   * @param {Object} issue
+   * @param {string} [newAssignee]
+   *
+   * @return {{ assignees?: string[] }}
+   */
   this.getAssigneeUpdate = getAssigneeUpdate;
 
+  /**
+   * Return the label changes required to reflect the new column:
+   * the column label to add and any other column labels to remove.
+   *
+   * @param {Object} issue
+   * @param {ColumnDefinition} newColumn
+   *
+   * @return {{ addLabels: string[], removeLabels: string[] }}
+   */
   this.getLabelUpdate = getLabelUpdate;
 
+  /**
+   * Fetch an issue by number and move it to a new column if the
+   * optional predicate passes. Resolves to `false` if the issue is
+   * not found or the predicate rejects it.
+   *
+   * @param {ProbotContext} context
+   * @param {number} number
+   * @param {ColumnDefinition} newColumn
+   * @param {string|null} newAssignee
+   * @param {(issue: Object) => boolean} [test]
+   *
+   * @return {Promise<void|false>}
+   */
   this.findAndMoveIssue = findAndMoveIssue;
 
 }

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

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

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

@@ -5,6 +5,8 @@ import { filterPull } from '../../filters.js';
 /**
  * This component updates synchronizes GitHub statuses with pull requests.
  *
+ * It also hooks into `BackgroundSync` to fetch statuses for a PR.
+ *
  * @constructor
  *
  * @param {import('../webhook-events/WebhookEvents.js').default} webhookEvents

package/lib/apps/issue-filter/IssueFilter.js

@@ -1,5 +1,7 @@
 /**
  * @typedef { { ignoreFilter?: string } } StoreFilterConfig
+ *
+ * @typedef { Extract<import('@octokit/webhooks').EmitterWebhookEventName, 'issues' | `issues.${string}` | 'issue_comment' | `issue_comment.${string}` | 'pull_request' | `pull_request.${string}` | 'pull_request_review' | `pull_request_review.${string}` | 'pull_request_review_comment' | `pull_request_review_comment.${string}` | 'pull_request_review_thread' | `pull_request_review_thread.${string}`> } IssueOrPullWebhookEventName
  */
 
 import { filterIssueOrPull } from '../../filters.js';
@@ -41,7 +43,7 @@ export default function IssueFilter(config, store, search, logger) {
   /**
    * @param {import('../../types.js').Logger } log
    *
-   * @return { (filterFn) => (any) => any }
+   * @return {<E extends IssueOrPullWebhookEventName>(fn: (context: import('probot').Context<E>) => any) => (context: import('probot').Context<E>) => any}
    */
   function createWebhookFilter(log) {
 
@@ -49,7 +51,7 @@ export default function IssueFilter(config, store, search, logger) {
 
       return (context) => {
 
-        const payload = context.payload;
+        const payload = /** @type {any} */ (context.payload);
 
         const issueOrPull = filterIssueOrPull(
           payload.issue || payload.pull_request,
@@ -79,7 +81,7 @@ export default function IssueFilter(config, store, search, logger) {
   /**
    * @param {import('../../types.js').Logger } log
    *
-   * @return { (filterFn) => (any) => any }
+   * @return {<E extends IssueOrPullWebhookEventName>(fn: (context: import('probot').Context<E>) => any) => (context: import('probot').Context<E>) => any}
    */
   this.createWebhookFilter = createWebhookFilter;
 }

package/lib/apps/search/Search.js

@@ -37,7 +37,7 @@ export default function Search(config, logger, store) {
 
   const {
     treatBotsAsReviewers = false,
-    defaultFilter
+    defaultFilter = ''
   } = config;
 
   function filterNoop(issue) {
@@ -63,13 +63,17 @@ export default function Search(config, logger, store) {
    *
    * @return { boolean }
    */
-  function includes(actual, pattern, exact) {
+  function includes(actual, pattern, exact = false) {
+
+    if (!pattern) {
+      return false;
+    }
 
     if (exact) {
-      return pattern && actual === pattern;
+      return actual === pattern;
     }
 
-    return pattern && actual.toLowerCase().includes(pattern.toLowerCase());
+    return actual.toLowerCase().includes(pattern.toLowerCase());
   }
 
   function isPull(issue) {
@@ -445,7 +449,7 @@ export default function Search(config, logger, store) {
    * Retrieve a filter function from the given search string.
    *
    * @param {string} search
-   * @param {GitHubUser} [user]
+   * @param {GitHubUser|null} [user]
    *
    * @return {FilterFn}
    */

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

@@ -1,4 +1,11 @@
 /**
+ * @typedef { import('probot').Probot } Probot
+ * @typedef { import('@octokit/webhooks').EmitterWebhookEventName } WebhookEventName
+ */
+
+/**
+ * A lightweight wrapper around {@link Probot#on} and {@link Probot#onAny}.
+ *
  * @constructor
  *
  * @param {import('../../types.js').ProbotApp} app
@@ -7,8 +14,7 @@
 export default function WebhookEvents(app, githubApp) {
 
   /**
-   * @template {Function} T
-   * @param {T} fn
+   * @param {(context: import('probot').Context) => any} fn
    */
   function ifEnabled(fn) {
 
@@ -37,8 +43,9 @@ export default function WebhookEvents(app, githubApp) {
    * Register a event lister for a single
    * or a number of webhook events.
    *
-   * @param {any|any[]} events
-   * @param {Function} fn listener
+   * @template {WebhookEventName} E
+   * @param {E | E[]} events
+   * @param {(context: import('probot').Context<E>) => any} fn listener
    */
   function on(events, fn) {
     app.on(events, ifEnabled(fn));
@@ -48,7 +55,7 @@ export default function WebhookEvents(app, githubApp) {
    * Register an event listener for all
    * webhook events.
    *
-   * @param {Function} fn
+   * @param {(context: import('probot').Context) => any} fn
    */
   function onAny(fn) {
     app.onAny(ifEnabled(fn));

package/lib/events.js

@@ -139,8 +139,8 @@ Events.prototype.createEvent = function(data) {
  * @param {Object} [data] the event object
  * @param {...Object} additionalArgs to be passed to the callback functions
  *
- * @return {Promise<boolean>} the events return value, if specified or false if the
- *                            default action was prevented by listeners
+ * @return {Promise<boolean|undefined|any>} the events return value, if
+ *    specified or false if the default action was prevented by listeners
  */
 Events.prototype.emit = async function(type, data, ...additionalArgs) {
 

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/probot/CustomProbot.js

@@ -103,7 +103,8 @@ function validateSetup() {
 
   const setup = new ManifestCreation();
 
-  const manifest = JSON.parse(setup.getManifest(setup.pkg, process.env.BASE_URL));
+  // TODO(nikku): process.env.BASE_URL may not be defined here
+  const manifest = JSON.parse(setup.getManifest(setup.pkg, /** @type { string } */ (process.env.BASE_URL)));
 
   return [
     !manifest.url && new Error('No <url> configured in app.yml'),

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/lib/util/search.js

@@ -116,7 +116,7 @@ export function parseSearch(str) {
 
       do {
         lastTerm = stack.pop();
-      } while (!lastTerm.group);
+      } while (lastTerm && !lastTerm.group);
 
       continue;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wuffle",
-  "version": "0.74.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.13.2",
-    "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": "ea9ac74526b02f9834b5e926df0e8e82536eba07"
+  "gitHead": "3a21cf84280395b89d369422bbaf16f2b63c20dd"
 }