wuffle 0.57.0 → 0.58.0

package/bin/run.js

@@ -205,7 +205,7 @@ 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');
 
@@ -232,7 +232,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);
   }
@@ -256,7 +256,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}`);
   }

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

@@ -98,9 +98,20 @@ function GitHubClient(app, webhookEvents, logger, githubApp, events) {
 
     const access_token = typeof user === 'string' ? user : user.access_token;
 
+    const log = logger.child({ name: 'github:user-auth' });
+
     return cache.get(`user_scoped=${access_token}`, () => {
       return new ProbotOctokit({
-        log: logger.child({ name: 'github:user-auth' }),
+
+        // fallout from Probot@13 migration
+        //
+        // see https://github.com/probot/probot/pull/1874#issuecomment-1837779069
+        log: {
+          debug: log.debug.bind(log),
+          info: log.info.bind(log),
+          warn: log.warn.bind(log),
+          error: log.error.bind(log)
+        },
         auth: {
           token: access_token
         }

package/lib/probot/CustomProbot.js

@@ -3,39 +3,60 @@ const { Server, Probot } = require('probot');
 const { getLog } = require('probot/lib/helpers/get-log');
 const { setupAppFactory } = require('./apps/setup');
 
+const { isProduction } = require('probot/lib/helpers/is-production');
+
 const { ManifestCreation } = require('probot/lib/manifest-creation');
 
+const { readEnvOptions } = require('probot/lib/bin/read-env-options');
+
 const { getErrorHandler } = require('probot/lib/helpers/get-error-handler');
-const { getPrivateKey } = require('@probot/get-private-key');
 
 
-async function run(appFn) {
+async function run(appFn, additionalOptions) {
+
+  const {
 
-  const appId = parseInt(process.env.APP_ID, 10);
-  const host = process.env.HOST;
-  const port = parseInt(process.env.PORT || '3000', 10);
-  const privateKey = getPrivateKey() || undefined;
+    // log options
+    logLevel: level, logFormat, logLevelInString, logMessageKey, sentryDsn,
 
-  const log = getLog();
+    // server options
+    host, port, webhookPath, webhookProxy,
+
+    // probot options
+    appId, privateKey, redisConfig, secret, baseUrl
+
+  } = readEnvOptions(additionalOptions?.env);
+
+  const logOptions = {
+    level,
+    logFormat,
+    logLevelInString,
+    logMessageKey,
+    sentryDsn
+  };
+
+  const log = getLog(logOptions);
 
   const serverOptions = {
     host,
-    log: log.child({ name: 'server' }),
     port,
-    webhookPath: process.env.WEBHOOK_PATH,
-    webhookProxy: process.env.WEBHOOK_PROXY_URL
+    webhookPath,
+    webhookProxy,
+    log: log.child({ name: 'server' })
   };
 
   let probotOptions = {
     appId,
-    log: log.child({ name: 'probot' }),
     privateKey,
-    secret: process.env.WEBHOOK_SECRET
+    redisConfig,
+    secret,
+    baseUrl,
+    log: log.child({ name: 'probot' })
   };
 
   // use probots own setup app if the probot app
   // is not configured yet
-  if (!isProduction() && !isSetup()) {
+  if (!isProduction() && !isSetup(probotOptions)) {
 
     // Workaround for setup (probot/probot#1512)
     // When probot is started for the first time, it gets into a setup mode
@@ -72,22 +93,20 @@ async function run(appFn) {
   return server;
 }
 
-function isSetup() {
-  const appId = parseInt(process.env.APP_ID, 10);
-  const privateKey = getPrivateKey() || undefined;
+function isSetup(options) {
+  const {
+    appId,
+    privateKey
+  } = options || readEnvOptions(process.env);
 
   return !!(appId && privateKey);
 }
 
-function isProduction() {
-  return process.env.NODE_ENV === 'production';
-}
-
 function validateSetup() {
 
   const setup = new ManifestCreation();
 
-  const manifest = JSON.parse(setup.getManifest(setup.pkg));
+  const manifest = JSON.parse(setup.getManifest(setup.pkg, process.env.BASE_URL));
 
   return [
     !manifest.url && new Error('No <url> configured in app.yml'),

package/lib/probot/apps/setup.js

@@ -9,6 +9,8 @@ const { getLog } = require('probot/lib/helpers/get-log');
 
 const { randomString } = require('../../util');
 
+const { importView } = require('probot/lib/views/import');
+const { setupView } = require('probot/lib/views/setup');
 
 function setupAppFactory(host, port) {
 
@@ -17,7 +19,11 @@ function setupAppFactory(host, port) {
 
     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,48 +38,110 @@ 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
+      });
 
-      res.send(renderSuccess(app_url + '/installations/new'));
+      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';
+
+      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();
+    });
   };
 }
 
@@ -90,40 +158,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wuffle",
-  "version": "0.57.0",
+  "version": "0.58.0",
   "description": "A multi-repository task board for GitHub issues",
   "author": {
     "name": "Nico Rehwaldt",
@@ -36,30 +36,30 @@
     "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",
+    "express-session": "^1.18.0",
     "fake-tag": "^3.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"
+    "prexit": "^1.0.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",
+    "chai": "^4.4.1",
     "graphql": "^16.6.0",
     "mocha": "^10.2.0",
-    "nock": "^13.4.0",
-    "nodemon": "^3.0.2",
+    "nock": "^13.5.1",
+    "nodemon": "^3.0.3",
     "npm-run-all": "^4.1.5",
     "sinon": "^17.0.1",
     "sinon-chai": "^3.7.0",
@@ -91,5 +91,5 @@
     "index.js",
     "wuffle.config.example.js"
   ],
-  "gitHead": "a0da3b97298f95e04c09f87a99dfb4bcf45cba76"
+  "gitHead": "07336a53705a1ba55405e6817cafa574aeefbe10"
 }