wuffle 0.57.0 → 0.59.0

package/lib/probot/apps/setup.js

@@ -1,23 +1,26 @@
-const bodyParser = require('body-parser');
-const updateDotenv = require('update-dotenv');
+import bodyParser from 'body-parser';
+import updateDotenv from 'update-dotenv';
 
-const { ManifestCreation } = require('probot/lib/manifest-creation');
+import { ManifestCreation } from 'probot/lib/manifest-creation.js';
+import { getLoggingMiddleware } from 'probot/lib/server/logging-middleware.js';
+import { getLog } from 'probot/lib/helpers/get-log.js';
+import { importView } from 'probot/lib/views/import.js';
+import { setupView } from 'probot/lib/views/setup.js';
 
-const { getLoggingMiddleware } = require('probot/lib/server/logging-middleware');
+import { randomString } from '../../util/index.js';
 
-const { getLog } = require('probot/lib/helpers/get-log');
-
-const { randomString } = require('../../util');
-
-
-function setupAppFactory(host, port) {
+export function setupAppFactory(host, port) {
 
   return async function setupApp(app, { getRouter }) {
     const setup = new ManifestCreation();
 
     const log = getLog().child({ name: 'wuffle:setup' });
 
-    if (process.env.NODE_ENV !== 'production' && !process.env.WEBHOOK_PROXY_URL) {
+    if (!(
+      process.env.NODE_ENV === 'production' ||
+      process.env.WEBHOOK_PROXY_URL ||
+      process.env.NO_SMEE_SETUP === 'true'
+    )) {
       await setup.createWebhookChannel();
     }
 
@@ -32,55 +35,113 @@ function setupAppFactory(host, port) {
     route.use(getLoggingMiddleware(app.log));
 
     route.get('/probot', async (req, res) => {
-      const baseUrl = getBaseUrl(req);
+      const baseUrl = process.env.BASE_URL || getBaseUrl(req);
       const pkg = setup.pkg;
       const manifest = setup.getManifest(pkg, baseUrl);
       const createAppUrl = setup.createAppUrl;
 
+      await setup.updateEnv({
+        BASE_URL: baseUrl
+      });
+
       // Pass the manifest to be POST'd
-      res.render('setup.hbs', { pkg, createAppUrl, manifest });
+      res.writeHead(200, { 'content-type': 'text/html' }).end(setupView({
+        name: pkg.name || 'Wuffle',
+        version: pkg.version,
+        description: pkg.description,
+        createAppUrl,
+        manifest
+      }));
     });
 
     route.get('/probot/setup', async (req, res) => {
       const { code } = req.query;
-      const app_url = await setup.createAppFromCode(code);
 
-      log.info('Setup completed, please start the app');
+      if (!code || typeof code !== 'string' || code.length === 0) {
+        return res
+          .writeHead(400, { 'content-type': 'text/plain' })
+          .end('code missing or invalid');
+      }
+
+      const response = await setup.createAppFromCode(code, {
+        request: app.state.request
+      });
+
+      const appUrl = app.state.appUrl = `${response}/installations/new`;
+
+      log.warn('Setup completed, please restart the app');
+
+      log.info(`Visit ${appUrl} to connect GitHub repositories`);
+
+      const location = '/probot/success';
 
-      res.send(renderSuccess(app_url + '/installations/new'));
+      return res
+        .writeHead(302, {
+          'content-type': 'text/plain',
+          location
+        })
+        .end(`Redirecting to ${ location }`);
     });
 
     route.get('/probot/import', async (_req, res) => {
+
+      const pkg = setup.pkg;
       const { WEBHOOK_PROXY_URL, GHE_HOST } = process.env;
       const GH_HOST = `https://${GHE_HOST ?? 'github.com'}`;
-      res.render('import.hbs', { WEBHOOK_PROXY_URL, GH_HOST });
+
+      return res
+        .writeHead(200, {
+          'content-type': 'text/html'
+        })
+        .end(importView({
+          name: pkg.name || 'Wuffle',
+          WEBHOOK_PROXY_URL,
+          GH_HOST
+        }));
     });
 
     route.post('/probot/import', bodyParser.json(), async (req, res) => {
       const { appId, pem, webhook_secret } = req.body;
       if (!appId || !pem || !webhook_secret) {
-        res.status(400).send('appId and/or pem and/or webhook_secret missing');
-        return;
+        return res
+          .writeHead(400, {
+            'content-type': 'text/plain'
+          })
+          .end('appId and/or pem and/or webhook_secret missing');
       }
+
       await updateDotenv({
         APP_ID: appId,
         PRIVATE_KEY: `"${pem}"`,
         WEBHOOK_SECRET: webhook_secret
       });
 
-      log.info('Setup completed, please start the app');
+      log.warn('Setup completed, please restart the app.');
 
-      res.send(renderSuccess());
+      return res.redirect('/probot/success');
     });
 
-    route.get('/', (req, res, next) => res.redirect('/probot'));
+    route.get('/probot/success', (_req, res) => {
+      const pkg = setup.pkg;
+
+      const appUrl = app.state.appUrl;
+
+      return res
+        .writeHead(200, { 'content-type': 'text/html' })
+        .end(successView({
+          name: pkg.name || 'Wuffle',
+          appUrl
+        }));
+    });
+
+    route.get('/', (_req, res) => {
+      return res
+        .writeHead(302, { 'content-type': 'text/plain', location: '/probot' })
+        .end();
+    });
   };
 }
 
-module.exports = {
-  setupAppFactory
-};
-
 function getBaseUrl(req) {
   const protocols = req.headers['x-forwarded-proto'] || req.protocol;
   const protocol =
@@ -90,40 +151,40 @@ function getBaseUrl(req) {
   return baseUrl;
 }
 
-
-function renderSuccess(appUrl = null) {
+function successView({ name, appUrl }) {
 
   return `
-<!DOCTYPE html>
-<html lang="en" class="height-full">
-  <head>
-    <meta charset="UTF-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <meta http-equiv="X-UA-Compatible" content="ie=edge">
-    <title>Setup Wuffle App | built with Probot</title>
-    <link rel="icon" href="/probot/static/probot-head.png">
-    <link rel="stylesheet" href="/probot/static/primer.css">
-  </head>
-  <body class="height-full bg-gray-light">
-    <div class="d-flex flex-column flex-justify-center flex-items-center text-center height-full">
-      <img src="/probot/static/robot.svg" alt="Probot Logo" width="100" class="mb-6">
-      <div class="box-shadow rounded-2 border p-6 bg-white">
-        <div class="text-center">
-          <h1 class="alt-h2 mb-4">Congrats! You have successfully installed your app!</h1>
-
-          <p class="alt-h3 mb-2">
-            You can now ${ appUrl ? `<a href="${appUrl}" target="_blank" rel="no-opener">` : ''}
-              connect GitHub repositories
-            ${appUrl ? '</a>' : ''} to your board.
-          </p>
-
-          <p class="alt-h3">
-            Please restart the server to complete the setup.
-          </p>
+  <!DOCTYPE html>
+  <html lang="en" class="height-full" data-color-mode="auto" data-light-theme="light" data-dark-theme="dark">
+    <head>
+      <meta charset="UTF-8">
+      <meta name="viewport" content="width=device-width, initial-scale=1.0">
+      <meta http-equiv="X-UA-Compatible" content="ie=edge">
+      <title>${ name } Setup complete</title>
+      <link rel="icon" href="/probot/static/probot-head.png">
+      <link rel="stylesheet" href="/probot/static/primer.css">
+    </head>
+    <body class="height-full bg-gray-light">
+      <div class="d-flex flex-column flex-justify-center flex-items-center text-center height-full">
+        <img src="/probot/static/robot.svg" alt="Probot Logo" width="100" class="mb-6">
+        <div class="box-shadow rounded-2 border p-6 bg-white">
+          <div class="text-center">
+            <h1 class="alt-h3 mb-2">You completed your ${name} setup!</h1>
+
+            <p class="mb-2">
+              Go ahead and ${ appUrl ? `<a href="${appUrl}" target="_blank" rel="no-opener">` : ''}
+                connect GitHub repositories
+              ${appUrl ? '</a>' : ''} to your board.
+            </p>
+
+            <p>
+              Please restart the server to complete the setup.
+            </p>
+
+          </div>
         </div>
       </div>
-    </div>
-  </body>
-</html>`;
-
+    </body>
+  </html>
+  `;
 }

package/lib/probot/index.js

@@ -1 +1 @@
-module.exports.CustomProbot = require('./CustomProbot');
+export * from './CustomProbot.js';

package/lib/store.js

@@ -1,30 +1,20 @@
-const {
-  groupBy
-} = require('min-dash');
-
-const pDefer = require('p-defer');
-
-const {
-  issueIdent
-} = require('./util');
-
-const {
-  findLinks
-} = require('./util/links');
-
-const { Links } = require('./links');
+import { groupBy } from 'min-dash';
+import pDefer from 'p-defer';
+import { issueIdent } from './util/index.js';
+import { findLinks } from './util/links.js';
+import { Links } from './links.js';
 
 
 /**
  * The store that holds all board data
  * and makes it accessible.
  */
-class Store {
+export default class Store {
 
   /**
-   * @param {import('./columns')} columns
-   * @param {import('./types').Logger} logger
-   * @param {import('./events')} events
+   * @param {import('./columns.js').default} columns
+   * @param {import('./types.js').Logger} logger
+   * @param {import('./events.js').default} events
    *
    * @constructor
    */
@@ -1020,6 +1010,4 @@ class Updates {
     return updates;
   }
 
-}
-
-module.exports = Store;
+}

package/lib/util/cache.js

@@ -1,5 +1,4 @@
-
-class Cache {
+export class Cache {
 
   constructor(ttl) {
     this.ttl = ttl;
@@ -62,10 +61,8 @@ class Cache {
 
 }
 
-module.exports.Cache = Cache;
-
 
-class KeepAliveCache extends Cache {
+export class KeepAliveCache extends Cache {
 
   get(key, defaultValue) {
 
@@ -79,10 +76,8 @@ class KeepAliveCache extends Cache {
   }
 }
 
-module.exports.KeepAliveCache = KeepAliveCache;
-
 
-class NoopCache {
+export class NoopCache {
 
   evict() { }
 
@@ -95,6 +90,4 @@ class NoopCache {
 
     return value;
   }
-}
-
-module.exports.NoopCache = NoopCache;
+}

package/lib/util/index.js

@@ -1,44 +1,44 @@
-const {
-  Cache,
-  NoopCache
-} = require('./cache');
+import crypto from 'node:crypto';
+import fs from 'node:fs';
 
-const {
-  findLinks,
-  linkTypes
-} = require('./links');
+export { Cache, NoopCache } from './cache.js';
 
-const {
-  parseSearch,
-  parseTemporalFilter
-} = require('./search');
+export { findLinks, linkTypes } from './links.js';
 
-const preExit = require('prexit');
+export { parseSearch, parseTemporalFilter } from './search.js';
 
-const {
-  repoAndOwner,
-  issueIdent
-} = require('./meta');
+export { default as preExit } from 'prexit';
 
-const crypto = require('crypto');
+export { repoAndOwner, issueIdent } from './meta.js';
 
-module.exports.randomString = function randomString(length = 64) {
+export function randomString(length = 64) {
   return crypto.randomBytes(length).toString('base64');
-};
-
-module.exports.preExit = preExit;
-
-module.exports.Cache = Cache;
-
-module.exports.NoopCache = NoopCache;
-
-module.exports.findLinks = findLinks;
-
-module.exports.linkTypes = linkTypes;
-
-module.exports.parseSearch = parseSearch;
-module.exports.parseTemporalFilter = parseTemporalFilter;
-
-module.exports.repoAndOwner = repoAndOwner;
-
-module.exports.issueIdent = issueIdent;
+}
+
+/**
+ * @param {string} str
+ *
+ * @return {string}
+ */
+export function hash(str) {
+  return crypto.createHash('md5').update(str).digest('hex');
+}
+
+/**
+ * @param {string|URL} path
+ * @param {string|URL} baseUrl
+ *
+ * @return {URL}
+ */
+export function relativePath(path, baseUrl) {
+  return new URL(path, baseUrl);
+}
+
+export function getPackageVersion() {
+
+  const { version } = JSON.parse(
+    fs.readFileSync(relativePath('../../package.json', import.meta.url), 'utf8')
+  );
+
+  return version;
+}

package/lib/util/links.js

@@ -28,7 +28,7 @@ const phrasesToTypes = {
   'related to': LINKED_TO
 };
 
-const linkTypes = {
+export const linkTypes = {
   CHILD_OF,
   PARENT_OF,
   DEPENDS_ON,
@@ -38,7 +38,7 @@ const linkTypes = {
 };
 
 
-function findLinks(issue, types) {
+export function findLinks(issue, types) {
 
   const {
     title,
@@ -161,8 +161,4 @@ function filterLinks(links, filterMap) {
   }
 
   return links.filter(l => l.type in filterMap);
-}
-
-module.exports.findLinks = findLinks;
-
-module.exports.linkTypes = linkTypes;
+}

package/lib/util/meta.js

@@ -1,4 +1,21 @@
-function repoAndOwner(issue) {
+/**
+ * @typedef { {
+ *   number: number,
+ *   repository: {
+ *     name: string,
+ *     owner: {
+ *       login: string
+ *     }
+ *   }
+ * } } Issue
+ */
+
+/**
+ * @param { Issue } issue
+ *
+ * @return { { repo: string, owner: string } }
+ */
+export function repoAndOwner(issue) {
   const {
     repository
   } = issue;
@@ -13,15 +30,15 @@ function repoAndOwner(issue) {
   };
 }
 
-module.exports.repoAndOwner = repoAndOwner;
-
-
-function issueIdent(issue) {
+/**
+ * @param { Issue } issue
+ *
+ * @return { string }
+ */
+export function issueIdent(issue) {
   const { owner, repo } = repoAndOwner(issue);
 
   const { number } = issue;
 
   return `${owner}/${repo}#${number}`;
 }
-
-module.exports.issueIdent = issueIdent;

package/lib/util/search.js

@@ -1,5 +1,4 @@
-
-function parseTemporalFilter(str) {
+export function parseTemporalFilter(str) {
 
   const regexp = /^(?:(>|>=|<|<=)?(\d{4}-\d{1,2}-\d{1,2})|@(today|last_week|last_month))$/;
 
@@ -42,8 +41,6 @@ function parseTemporalFilter(str) {
   };
 }
 
-module.exports.parseTemporalFilter = parseTemporalFilter;
-
 /**
  * @param {number} time
  *
@@ -67,7 +64,7 @@ function startOfDay(time) {
  *   negated?: boolean
  * }[] }
  */
-function parseSearch(str) {
+export function parseSearch(str) {
 
   const regexp = /(?:([\w#/&]+)|"([\w#/&\s-.]+)"|([-!]?)([\w]+):(?:([\w-#/&@<>=.]+)|"([\w-#/&@:.,; ]+)")?)(?:\s|$)/g;
 
@@ -111,6 +108,4 @@ function parseSearch(str) {
   }
 
   return terms;
-}
-
-module.exports.parseSearch = parseSearch;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wuffle",
-  "version": "0.57.0",
+  "version": "0.59.0",
   "description": "A multi-repository task board for GitHub issues",
   "author": {
     "name": "Nico Rehwaldt",
@@ -9,6 +9,12 @@
   "bin": {
     "wuffle": "./bin/wuffle"
   },
+  "exports": {
+    ".": "./index.js",
+    "./package.json": "./package.json",
+    "./lib/*.js": "./lib/*.js"
+  },
+  "type": "module",
   "license": "MIT",
   "homepage": "https://github.com/nikku/wuffle",
   "repository": {
@@ -26,7 +32,7 @@
     "project management"
   ],
   "scripts": {
-    "all": "run-s lint lint:types test",
+    "all": "run-s lint test",
     "dev": "nodemon",
     "start": "NODE_ENV=production node ./bin/wuffle",
     "test": "mocha 'test/**/*.js' --exit",
@@ -36,31 +42,32 @@
     "auto-test": "npm test -- --watch"
   },
   "dependencies": {
-    "@aws-sdk/client-s3": "^3.110.0",
+    "@aws-sdk/client-s3": "^3.503.1",
     "async-didi": "^0.3.1",
     "body-parser": "^1.20.0",
     "compression": "^1.7.4",
-    "express-session": "^1.17.3",
-    "fake-tag": "^3.0.0",
+    "express-session": "^1.18.0",
+    "fake-tag": "^5.0.0",
     "memorystore": "^1.6.7",
     "min-dash": "^4.1.1",
     "mkdirp": "^3.0.1",
-    "p-defer": "^3.0.0",
-    "prexit": "0.0.5",
-    "probot": "^12.2.4",
-    "smee-client": "^1.2.5"
+    "p-defer": "^4.0.0",
+    "prexit": "^2.2.0",
+    "probot": "^13.0.1",
+    "smee-client": "^2.0.0"
   },
   "devDependencies": {
     "@graphql-eslint/eslint-plugin": "^3.20.1",
-    "@octokit/graphql-schema": "^12.10.0",
+    "@octokit/graphql-schema": "^14.53.0",
     "@types/compression": "^1.7.2",
-    "@types/express-session": "^1.17.4",
-    "chai": "^4.4.0",
+    "@types/express-session": "^1.17.10",
+    "@types/mocha": "^10.0.6",
+    "chai": "^4",
     "graphql": "^16.6.0",
     "mocha": "^10.2.0",
-    "nock": "^13.4.0",
-    "nodemon": "^3.0.2",
-    "npm-run-all": "^4.1.5",
+    "nock": "^13.5.1",
+    "nodemon": "^3.0.3",
+    "npm-run-all2": "^6.0.0",
     "sinon": "^17.0.1",
     "sinon-chai": "^3.7.0",
     "typescript": "^5.3.3"
@@ -91,5 +98,5 @@
     "index.js",
     "wuffle.config.example.js"
   ],
-  "gitHead": "a0da3b97298f95e04c09f87a99dfb4bcf45cba76"
+  "gitHead": "e517056bec193a96a9989c17533f9fcb93db12d4"
 }