wuffle 0.57.0 → 0.59.0

package/bin/run.js

@@ -1,52 +1,55 @@
 #!/usr/bin/env node
 
-require('dotenv').config();
+import dotenv from 'dotenv';
 
-const { CustomProbot } = require('../lib/probot');
+dotenv.config();
 
-const IS_PROD = CustomProbot.isProduction();
+import * as CustomProbot from '../lib/probot/index.js';
 
-const IS_SETUP = !IS_PROD && !CustomProbot.isSetup();
+import fs from 'node:fs';
+import path from 'node:path';
 
-const fs = require('fs');
-const path = require('path');
+import { getLog } from 'probot/lib/helpers/get-log.js';
 
-const { getLog } = require('probot/lib/helpers/get-log');
+import {
+  getPackageVersion,
+  relativePath
+} from '../lib/util/index.js';
 
-const log = getLog().child({
-  name: 'wuffle:run'
-});
+import Columns from '../lib/columns.js';
 
-const Columns = require('../lib/columns');
+const version = getPackageVersion();
 
-const { version } = require('../package');
+const IS_PROD = CustomProbot.isProduction();
 
-// shim
+const IS_SETUP = !IS_PROD && !CustomProbot.isSetup();
 
-if (typeof Array.prototype.flat !== 'function') {
-  Array.prototype.flat = function() {
-    return [].concat(...this);
-  };
-}
+const log = getLog().child({
+  name: 'wuffle:run'
+});
 
 async function validate() {
 
   log.info('Validating configuration');
 
-  const problems = [
-    !IS_PROD ? warning('Not running in production mode') : null,
-    checkEnv('APP_ID', IS_PROD),
-    checkEnv('BASE_URL', IS_PROD),
-    checkEnv('GITHUB_CLIENT_ID', IS_PROD),
-    checkEnv('GITHUB_CLIENT_SECRET', IS_PROD),
-    checkEnv([ 'PRIVATE_KEY', 'PRIVATE_KEY_PATH' ], IS_PROD),
-    checkEnv('SESSION_SECRET', IS_PROD),
-    checkEnv('WEBHOOK_SECRET', IS_PROD),
-    checkDumpConfig(),
-    checkConfig(),
-    checkBoardAssets(),
-    checkBaseUrl()
-  ].flat().filter(problem => problem);
+  const problems = await Promise.all(
+    [
+      !IS_PROD ? warning('Not running in production mode') : null,
+      checkEnv('APP_ID', IS_PROD),
+      checkEnv('BASE_URL', IS_PROD),
+      checkEnv('GITHUB_CLIENT_ID', IS_PROD),
+      checkEnv('GITHUB_CLIENT_SECRET', IS_PROD),
+      checkEnv([ 'PRIVATE_KEY', 'PRIVATE_KEY_PATH' ], IS_PROD),
+      checkEnv('SESSION_SECRET', IS_PROD),
+      checkEnv('WEBHOOK_SECRET', IS_PROD),
+      checkDumpConfig(),
+      checkConfig(),
+      checkBoardAssets(),
+      checkBaseUrl()
+    ]
+  ).then(
+    results => results.flat().filter(problem => problem)
+  );
 
   function isFatal(problem) {
     return problem.type === 'ERROR';
@@ -110,12 +113,12 @@ async function validate() {
   function checkBoardAssets() {
     const problem = IS_PROD ? error : warning;
 
-    if (!fs.existsSync(path.join(__dirname, '../public/index.html'))) {
+    if (!fs.existsSync(projectPath('../public/index.html'))) {
       return problem('board assets not found, please compile them via npm run build');
     }
   }
 
-  function checkConfig() {
+  async function checkConfig() {
 
     const problem = IS_PROD ? error : warning;
 
@@ -133,8 +136,11 @@ async function validate() {
       const configPath = path.resolve('wuffle.config.js');
 
       try {
-        config = require(configPath);
+        config = await import(configPath);
+
+        config = config.default || config;
       } catch (err) {
+        console.error(err);
         return problem('Board not configured via env.BOARD_CONFIG or wuffle.config.js');
       }
     }
@@ -205,12 +211,12 @@ async function validate() {
 
 async function performSetup() {
 
-  log.info('Running first time setup');
+  log.warn('Running first time setup');
 
   const configPath = path.resolve('wuffle.config.js');
 
   if (!process.env.BOARD_CONFIG && !fs.existsSync(configPath)) {
-    fs.copyFileSync(path.join(__dirname, '../wuffle.config.example.js'), configPath);
+    fs.copyFileSync(projectPath('../wuffle.config.example.js'), configPath);
 
     log.info('Created board config: wuffle.config.js');
   }
@@ -218,7 +224,7 @@ async function performSetup() {
   const manifestPath = path.resolve('app.yml');
 
   if (!fs.existsSync(manifestPath)) {
-    fs.copyFileSync(path.join(__dirname, '../app.yml'), manifestPath);
+    fs.copyFileSync(projectPath('../app.yml'), manifestPath);
 
     log.info('Created GitHub App manifest: app.yml');
   }
@@ -232,7 +238,7 @@ async function performSetup() {
       log.error(error.message);
     }
 
-    log.error('Please correct above errors and restart');
+    log.warn('Please correct above errors and restart');
 
     process.exit(1);
   }
@@ -240,7 +246,7 @@ async function performSetup() {
 
 async function start() {
 
-  const app = require('../');
+  const { default: app } = await import('../index.js');
 
   const {
     expressApp
@@ -256,7 +262,8 @@ async function open() {
   const url = process.env.BASE_URL || 'http://localhost:3000';
 
   if (IS_SETUP) {
-    log.warn(`Visit ${url} to create a GitHub App that connects us to GitHub`);
+    log.warn('GitHub App is not configured yet');
+    log.warn(`Visit ${url} to continue the setup`);
   } else {
     log.info(`Wuffle started on ${url}`);
   }
@@ -275,6 +282,10 @@ async function run() {
   await open();
 }
 
+function projectPath(file) {
+  return relativePath(file, import.meta.url);
+}
+
 run().catch(err => {
   log.error(err);
 

package/bin/wuffle

@@ -1,3 +1,3 @@
 #!/usr/bin/env node
 
-require('./run');
+import './run.js';

package/index.js

@@ -1 +1 @@
-module.exports = require('./lib');
+export { default } from './lib/index.js';

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

@@ -1,19 +1,12 @@
-const { URLSearchParams } = require('url');
-
-const fetch = require('node-fetch').default;
-
-const {
-  withSession
-} = require('../../middleware');
-
-const {
-  randomString
-} = require('../../util');
+import { URLSearchParams } from 'url';
+import fetch from 'node-fetch';
+import { withSession } from '../../middleware/index.js';
+import { randomString } from '../../util/index.js';
 
 /**
- * @typedef {import('../../types').Session} WuffleSession
+ * @typedef {import('../../types.js').Session} WuffleSession
  * @typedef {import('express').Request} Request
- * @typedef {import('../../types').GitHubUser} GitHubUser
+ * @typedef {import('../../types.js').GitHubUser} GitHubUser
  */
 
 /**
@@ -25,11 +18,11 @@ const {
  *
  * @constructor
  *
- * @param {import('../../types').Logger} logger
- * @param {import('../../types').Router} router
- * @param {import('../security-context/SecurityContext')} securityContext
+ * @param {import('../../types.js').Logger} logger
+ * @param {import('../../types.js').Router} router
+ * @param {import('../security-context/SecurityContext.js').default} securityContext
  */
-function AuthRoutes(logger, router, securityContext) {
+export default function AuthRoutes(logger, router, securityContext) {
 
   const middlewares = [
     withSession
@@ -254,9 +247,6 @@ function AuthRoutes(logger, router, securityContext) {
 }
 
 
-module.exports = AuthRoutes;
-
-
 // helpers ///////////////////////
 
 function getBaseUrl() {

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

@@ -1,6 +1,6 @@
-const AuthRoutes = require('./AuthRoutes');
+import AuthRoutes from './AuthRoutes.js';
 
-module.exports = {
+export default {
   __init__: [ 'authRoutes' ],
   authRoutes: [ 'type', AuthRoutes ]
 };

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

@@ -12,11 +12,11 @@ const CHANGES_REQUESTED = 'changes_requested';
  *
  * @constructor
  *
- * @param {import('./webhook-events/WebhookEvents')} webhookEvents
- * @param {import('./github-issues/GithubIssues')} githubIssues
- * @param {import('../columns')} columns
+ * @param {import('./webhook-events/WebhookEvents.js').default} webhookEvents
+ * @param {import('./github-issues/GithubIssues.js').default} githubIssues
+ * @param {import('../columns.js').default} columns
  */
-module.exports = function(webhookEvents, githubIssues, columns) {
+export default function(webhookEvents, githubIssues, columns) {
 
   webhookEvents.on([
     'issues.closed',
@@ -177,7 +177,7 @@ module.exports = function(webhookEvents, githubIssues, columns) {
     );
   });
 
-};
+}
 
 
 // helpers //////////////////////

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

@@ -1,11 +1,5 @@
-const {
-  filterIssueOrPull,
-  filterRepository
-} = require('../../filters');
-
-const {
-  issueIdent
-} = require('../../util');
+import { filterIssueOrPull, filterRepository } from '../../filters.js';
+import { issueIdent } from '../../util/index.js';
 
 function isInternalError(error) {
   return 'status' in error && error.status === 500;
@@ -17,14 +11,14 @@ function isInternalError(error) {
  *
  * @constructor
  *
- * @param {import('../../types').Logger} logger
+ * @param {import('../../types.js').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.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
  */
-function BackgroundSync(logger, config, store, githubClient, githubApp, events) {
+export default function BackgroundSync(logger, config, store, githubClient, githubApp, events) {
 
   // 30 days
   const syncClosedLookback = (
@@ -529,6 +523,4 @@ We automatically synchronize all repositories you granted us access to via the G
     }
   });
 
-}
-
-module.exports = BackgroundSync;
+}

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

@@ -1,6 +1,6 @@
-const BackgroundSync = require('./BackgroundSync');
+import BackgroundSync from './BackgroundSync.js';
 
-module.exports = {
+export default {
   __init__: [ 'backgroundSync' ],
   backgroundSync: [ 'type', BackgroundSync ]
 };

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

@@ -1,4 +1,4 @@
-function filterIssueOrPull(issueOrPull) {
+export function filterIssueOrPull(issueOrPull) {
 
   if (issueOrPull.pull_request) {
     return filterPull(issueOrPull);
@@ -7,8 +7,6 @@ function filterIssueOrPull(issueOrPull) {
   }
 }
 
-module.exports.filterIssueOrPull = filterIssueOrPull;
-
 
 function filterCheckRun(checkRun) {
   const {
@@ -44,7 +42,7 @@ function filterStatus(status) {
 }
 
 
-function filterRepository(repository) {
+export function filterRepository(repository) {
 
   const {
     name,
@@ -59,10 +57,8 @@ function filterRepository(repository) {
   };
 }
 
-module.exports.filterRepository = filterRepository;
-
 
-function filterUser(user) {
+export function filterUser(user) {
 
   const {
     login,
@@ -77,10 +73,8 @@ function filterUser(user) {
   };
 }
 
-module.exports.filterUser = filterUser;
-
 
-function filterComment(comment) {
+export function filterComment(comment) {
 
   const {
     user,
@@ -93,10 +87,8 @@ function filterComment(comment) {
   };
 }
 
-module.exports.filterComment = filterComment;
 
-
-function filterLabel(githubLabel) {
+export function filterLabel(githubLabel) {
 
   const {
     name,
@@ -111,8 +103,6 @@ function filterLabel(githubLabel) {
   };
 }
 
-module.exports.filterLabel = filterLabel;
-
 function filterLink(link) {
   const {
     type,
@@ -127,7 +117,7 @@ function filterLink(link) {
   };
 }
 
-function filterMilestone(githubMilestone) {
+export function filterMilestone(githubMilestone) {
 
   const {
     number,
@@ -142,10 +132,8 @@ function filterMilestone(githubMilestone) {
   };
 }
 
-module.exports.filterMilestone = filterMilestone;
 
-
-function filterReview(review) {
+export function filterReview(review) {
 
   const {
     state,
@@ -160,10 +148,8 @@ function filterReview(review) {
   };
 }
 
-module.exports.filterReview = filterReview;
-
 
-function filterPull(pullRequest) {
+export function filterPull(pullRequest) {
 
   const {
     id,
@@ -216,10 +202,8 @@ function filterPull(pullRequest) {
   };
 }
 
-module.exports.filterPull = filterPull;
-
 
-function filterIssue(issue) {
+export function filterIssue(issue) {
 
   const {
     id,
@@ -261,6 +245,4 @@ function filterIssue(issue) {
     column
   };
 
-}
-
-module.exports.filterIssue = filterIssue;
+}

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

@@ -1,40 +1,30 @@
-const bodyParser = require('body-parser').text();
-
-const {
-  withSession
-} = require('../../middleware');
-
-const {
-  repoAndOwner
-} = require('../../util');
-
-
-const {
-  filterIssueOrPull: _filterIssueOrPull
-} = require('./board-api-filters');
+import bodyParser from 'body-parser';
 
+import { withSession } from '../../middleware/index.js';
+import { repoAndOwner } from '../../util/index.js';
+import { filterIssueOrPull as _filterIssueOrPull } from './board-api-filters.js';
 
 /**
  * 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('../github-client/GithubClient')} githubClient
- * @param {import('../auth-routes/AuthRoutes')} authRoutes
- * @param {import('../user-access/UserAccess')} userAccess
- * @param {import('../github-issues/GithubIssues')} githubIssues
- * @param {import('../search/Search')} search
- * @param {import('../../columns')} columns
+ * @param {import('../../store.js').default} store
+ * @param {import('../../types.js').Router} router
+ * @param {import('../../types.js').Logger} logger
+ * @param {import('../github-client/GithubClient.js').default} githubClient
+ * @param {import('../auth-routes/AuthRoutes.js').default} authRoutes
+ * @param {import('../user-access/UserAccess.js').default} userAccess
+ * @param {import('../github-issues/GithubIssues.js').default} githubIssues
+ * @param {import('../search/Search.js').default} search
+ * @param {import('../../columns.js').default} columns
  */
-module.exports = async (
+export default async function BoardApiRoutes(
     config, store,
     router, logger,
     githubClient, authRoutes,
     userAccess, githubIssues,
     search, columns
-) => {
+) {
 
   const log = logger.child({
     name: 'wuffle:board-api-routes'
@@ -241,7 +231,7 @@ module.exports = async (
   });
 
 
-  router.post('/wuffle/board/issues/move', ...middlewares, bodyParser, async (req, res) => {
+  router.post('/wuffle/board/issues/move', ...middlewares, bodyParser.text(), async (req, res) => {
 
     const user = authRoutes.getGitHubUser(req);
 
@@ -302,4 +292,4 @@ module.exports = async (
 
   });
 
-};
+}

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

@@ -1,5 +1,5 @@
-const boardApiRoutes = require('./board-api-routes');
+import boardApiRoutes from './board-api-routes.js';
 
-module.exports = {
+export default {
   __init__: [ boardApiRoutes ]
 };

package/lib/apps/board-routes.js

@@ -1,8 +1,9 @@
-const express = require('express');
+import express from 'express';
 
-const fs = require('fs');
+import fs from 'node:fs';
 
-const path = require('path');
+import { relativePath } from '../util/index.js';
+import { fileURLToPath } from 'node:url';
 
 
 /**
@@ -10,9 +11,9 @@ const path = require('path');
  *
  * @param {import('express').Router} router
  */
-module.exports = async (config, router) => {
+export default async function BoardRoutes(config, router) {
 
-  const staticDirectory = path.join(__dirname, '..', '..', 'public');
+  const staticDirectory = relativePath('../../public/', import.meta.url);
 
   router.get('/', (req, res, next) => {
     res.redirect('/board');
@@ -44,7 +45,7 @@ module.exports = async (config, router) => {
       return indexPage;
     }
 
-    indexPage = fs.readFileSync(path.join(staticDirectory, 'index.html'), 'utf8');
+    indexPage = fs.readFileSync(relativePath('index.html', staticDirectory), 'utf8');
 
     indexPage = indexPage.replace(
       '<title>Wuffle Board</title>',
@@ -67,15 +68,25 @@ module.exports = async (config, router) => {
     res.type('html').status(200).send(getIndexPage());
   });
 
+  const robotsPath = fileURLToPath(
+    relativePath('robots.txt', staticDirectory)
+  );
+
   router.get('/robots.txt', (req, res, next) => {
-    res.sendFile(path.join(staticDirectory, 'robots.txt'));
+    res.sendFile(robotsPath);
   });
 
+  const serviceWorkerPath = fileURLToPath(
+    relativePath('service-worker.js', staticDirectory)
+  );
+
   router.get('/service-worker.js', (req, res, next) => {
-    res.sendFile(path.join(staticDirectory, 'service-worker.js'));
+    res.sendFile(serviceWorkerPath);
   });
 
   // static resources
 
-  router.use('/board', express.static(staticDirectory));
-};
+  const staticDirectoryPath = fileURLToPath(staticDirectory);
+
+  router.use('/board', express.static(staticDirectoryPath));
+}

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

@@ -1,7 +1,6 @@
-const fs = require('fs').promises;
-const path = require('path');
-
-const { mkdirp } = require('mkdirp');
+import { promises as fs } from 'node:fs';
+import path from 'node:path';
+import { mkdirp } from 'mkdirp';
 
 
 /**
@@ -10,11 +9,11 @@ const { mkdirp } = require('mkdirp');
  *
  * @constructor
  *
- * @param {import('../../../types').Logger} logger
- * @param {import('../../../store')} store
- * @param {import('../../../events')} events
+ * @param {import('../../../types.js').Logger} logger
+ * @param {import('../../../store.js').default} store
+ * @param {import('../../../events.js').default} events
  */
-function DumpStoreLocal(logger, store, events) {
+export default function DumpStoreLocal(logger, store, events) {
 
   const log = logger.child({
     name: 'wuffle:dump-store-local'
@@ -110,7 +109,4 @@ function DumpStoreLocal(logger, store, events) {
 
   this.restoreStore = restoreStore;
   this.dumpStore = dumpStore;
-
-}
-
-module.exports = DumpStoreLocal;
+}

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

@@ -1,6 +1,6 @@
-const DumpStore = require('./DumpStoreLocal');
+import DumpStore from './DumpStoreLocal.js';
 
-module.exports = {
+export default {
   __init__: [ 'dumpStore' ],
   dumpStore: [ 'type', DumpStore ]
 };

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

@@ -1,4 +1,4 @@
-const S3 = require('./S3');
+import S3 from './S3.js';
 
 
 /**
@@ -7,11 +7,11 @@ const S3 = require('./S3');
  *
  * @constructor
  *
- * @param {import('../../../types').Logger} logger
- * @param {import('../../../store')} store
- * @param {import('../../../events')} events
+ * @param {import('../../../types.js').Logger} logger
+ * @param {import('../../../store.js').default} store
+ * @param {import('../../../events.js').default} events
  */
-function DumpStoreS3(logger, store, events) {
+export default function DumpStoreS3(logger, store, events) {
 
   const log = logger.child({
     name: 'wuffle:dump-store-s3'
@@ -87,6 +87,4 @@ function DumpStoreS3(logger, store, events) {
 
   this.restoreStore = restoreStore;
   this.dumpStore = dumpStore;
-}
-
-module.exports = DumpStoreS3;
+}