wuffle 0.73.3 → 0.74.0

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) {
 

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

@@ -11,14 +11,13 @@ function isInternalError(error) {
  *
  * @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 = (
@@ -101,18 +100,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 +130,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,
@@ -465,7 +398,7 @@ We automatically synchronize all repositories you granted us access to via the G
     log.info('start');
 
     try {
-      const installations = await githubApp.getInstallations();
+      const installations = await backgroundSyncBackend.getInstallations();
 
       await doSync(installations);
 

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/{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 ]
+};

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

@@ -28,6 +28,7 @@ const RequiredEvents = [
 
 /**
  * @typedef {import('./types.js').Installation} Installation
+ * @typedef {import('../../types.js').Octokit} Octokit
  */
 
 /**
@@ -53,8 +54,19 @@ export default function GithubApp(config, app, logger, injector) {
 
   // cached data //////////////////
 
+  /**
+   * @type {Promise<Installation[]> | null}
+   */
   let installations = null;
+
+  /**
+   * @type {Promise<Record<string, Installation>> | null}
+   */
   let installationsByLogin = null;
+
+  /**
+   * @type {Promise<Record<string, Installation>> | null}
+   */
   let installationsById = null;
 
   // reactivity ////////////////////
@@ -71,12 +83,17 @@ export default function GithubApp(config, app, logger, injector) {
   // functionality /////////////////
 
   /**
-   * @return {Promise<import('../../types.js').Octokit>}
+   * @return {Promise<Octokit>}
    */
   function getAppScopedClient() {
     return app.auth();
   }
 
+  /**
+   * Return installations
+   *
+   * @return {Promise<Installation[]>}
+   */
   function getInstallations() {
     installations = installations || fetchInstallations().then(installations => {
 
@@ -90,6 +107,11 @@ export default function GithubApp(config, app, logger, injector) {
     return installations;
   }
 
+  /**
+   * Return installations by ID
+   *
+   * @return {Promise<Record<string, Installation>>}
+   */
   function getInstallationsById() {
 
     installationsById = installationsById || getInstallations().then(
@@ -106,9 +128,9 @@ 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?>}
+   * @return {Promise<Installation | undefined>}
    */
   function getInstallationById(id) {
     return getInstallationsById().then(byId => {
@@ -119,7 +141,7 @@ export default function GithubApp(config, app, logger, injector) {
   /**
    * Return map of installations, grouped by org / login.
    *
-   * @return {Promise<Object<String, Installation>>}
+   * @return {Promise<Record<string, Installation>>}
    */
   function getInstallationsByLogin() {
 
@@ -155,6 +177,13 @@ export default function GithubApp(config, app, logger, injector) {
     });
   }
 
+  /**
+   * Return true if installation is enabled.
+   *
+   * @param {Installation} installation
+   *
+   * @return {Promise<boolean>}
+   */
   function isInstallationEnabled(installation) {
 
     const {
@@ -240,10 +269,10 @@ export default function GithubApp(config, app, logger, injector) {
   /**
    * Fetch active installations.
    *
-   * @return {Promise<Array<Installation>>} installations
+   * @return {Promise<Installation[]>} installations
    */
   function fetchInstallations() {
-    return /** @type Promise<Array<Installation>> */ (getAppScopedClient().then(
+    return /** @type Promise<Installation[]> */ (getAppScopedClient().then(
       octokit => octokit.paginate(
         octokit.rest.apps.listInstallations,
         { per_page: 100 }
@@ -253,13 +282,47 @@ export default function GithubApp(config, app, logger, injector) {
 
   // api ///////////////////
 
+  /**
+   * Return an application-scoped octokit client.
+   *
+   * @return {Promise<Octokit>}
+   */
   this.getAppScopedClient = getAppScopedClient;
 
+  /**
+   * Return true if installation is enabled.
+   *
+   * @param {Installation} installation
+   *
+   * @return {Promise<boolean>}
+   */
   this.isInstallationEnabled = isInstallationEnabled;
 
+  /**
+   * Get an installation for the given login.
+   *
+   * This method throws if an installation for the given login does not exist.
+   *
+   * @param {string} login
+   *
+   * @return {Promise<Installation>}
+   */
   this.getInstallationByLogin = getInstallationByLogin;
+
+  /**
+   * Get an installation for the given id.
+   *
+   * @param {string} id
+   *
+   * @return {Promise<Installation | undefined>}
+   */
   this.getInstallationById = getInstallationById;
 
+  /**
+   * Return installations
+   *
+   * @return {Promise<Installation[]>}
+   */
   this.getInstallations = getInstallations;
 
 }

package/lib/apps/log-events.js

@@ -27,18 +27,18 @@ export default function LogEvents(logger, webhookEvents) {
 
   log.info('dumping webhook events to %s', path.resolve(eventsDir));
 
-  function write(event, payload) {
+  function write(name, payload) {
 
     const {
       action
     } = payload;
 
-    const name = action ? `${event}.${action}` : event;
+    const eventName = action ? `${name}.${action}` : name;
 
-    const data = JSON.stringify({ event, payload }, null, '  ');
+    const data = JSON.stringify({ name, payload }, null, '  ');
 
     return fs.mkdir(eventsDir, { recursive: true }).then(() => {
-      const fileName = path.join(eventsDir, `${Date.now()}-${counter++}-${name}.json`);
+      const fileName = path.join(eventsDir, `${Date.now()}-${counter++}-${eventName}.json`);
 
       return fs.writeFile(fileName, data, 'utf8');
     });

package/lib/apps/{reindex-store.js → reindex-store/ReindexStore.js}

@@ -1,16 +1,16 @@
 import {
   getPackageVersion,
   hash
-} from '../util/index.js';
+} from '../../util/index.js';
 
 
 /**
  * @constructor
  *
  * @param {any} config
- * @param {import('../types.js').Logger} logger
- * @param {import('../events.js').default} events
- * @param {import('../store.js').default} store
+ * @param {import('../../types.js').Logger} logger
+ * @param {import('../../events.js').default} events
+ * @param {import('../../store.js').default} store
  */
 export default function ReindexStore(config, logger, events, store) {
 
@@ -48,6 +48,8 @@ export default function ReindexStore(config, logger, events, store) {
       log.info('config changed');
 
       await reindexStore();
+    } else {
+      log.debug('config unchanged - skipping reindexing');
     }
   });
 

package/lib/apps/reindex-store/index.js

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

package/lib/index.js

@@ -11,7 +11,7 @@ const appModules = [
       ? import('./apps/dump-store/s3/index.js')
       : import('./apps/dump-store/local/index.js')
   ),
-  import('./apps/events-sync.js'),
+  import('./apps/events-sync/index.js'),
   import('./apps/github-app/index.js'),
   import('./apps/github-issues/index.js'),
   import('./apps/github-comments/index.js'),
@@ -24,11 +24,11 @@ const appModules = [
   import('./apps/user-access/index.js'),
   import('./apps/search/index.js'),
   import('./apps/background-sync/index.js'),
-  import('./apps/automatic-dev-flow.js'),
+  import('./apps/automatic-dev-flow/index.js'),
   import('./apps/auth-routes/index.js'),
   import('./apps/board-api-routes/index.js'),
   import('./apps/board-routes.js'),
-  import('./apps/reindex-store.js')
+  import('./apps/reindex-store/index.js')
 ];
 
 import loadConfig from './load-config.js';
@@ -78,17 +78,25 @@ export default function Wuffle(app, { getRouter }) {
     });
 
     const coreModule = {
-      'app': [ 'value', app ],
       'config': [ 'value', config ],
-      'router': [ 'value', router ],
       'logger': [ 'value', logger ],
       'columns': [ 'type', Columns ],
       'store': [ 'type', Store ],
       'events': [ 'value', events ]
     };
 
+    const webModule = {
+      'router': [ 'value', router ]
+    };
+
+    const probotModule = {
+      'app': [ 'value', app ],
+    };
+
     const injector = new AsyncInjector([
       coreModule,
+      probotModule,
+      webModule,
       ...modules
     ]);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wuffle",
-  "version": "0.73.3",
+  "version": "0.74.0",
   "description": "A multi-repository task board for GitHub issues",
   "author": {
     "name": "Nico Rehwaldt",
@@ -35,7 +35,7 @@
     "all": "run-s lint test",
     "dev": "nodemon",
     "start": "NODE_ENV=production node ./bin/wuffle",
-    "test": "mocha 'test/**/*.js' --exit",
+    "test": "mocha -r test/helpers/globals.js 'test/**/*.js' --exit",
     "lint": "run-s lint:*",
     "lint:eslint": "eslint .",
     "lint:types": "tsc --pretty",
@@ -61,13 +61,14 @@
     "@types/compression": "^1.8.1",
     "@types/express-session": "^1.19.0",
     "@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",
     "nodemon": "^3.1.14",
     "npm-run-all2": "^8.0.4",
-    "sinon": "^21.1.2",
+    "sinon": "^22.0.0",
     "sinon-chai": "^4.0.0",
     "typescript": "^5.9.3"
   },
@@ -82,5 +83,5 @@
     "index.js",
     "wuffle.config.example.js"
   ],
-  "gitHead": "1d7cdf09524102d300d6230b840959cdd1479e3e"
+  "gitHead": "ea9ac74526b02f9834b5e926df0e8e82536eba07"
 }