Expose web server express application to plugins

docs/plugins.md

@@ -66,6 +66,7 @@ The first and only argument to the plugin function is an object with the followi
 | `logs` | An object with functions to get attachment URLs/files and manage log storage types |
 | `hooks` | An object with functions to add *hooks* that are called at specific times, e.g. before a new thread is created |
 | `formats` | An object with functions that allow you to replace the default functions used for formatting messages and logs |
+| `webserver` | An [Express Application object](https://expressjs.com/en/api.html#app) that functions as the bot's web server |
 
 See the auto-generated [Plugin API](plugin-api.md) page for details.
 

src/main.js

@@ -21,7 +21,7 @@ const logs = require("./modules/logs");
 const move = require("./modules/move");
 const block = require("./modules/block");
 const suspend = require("./modules/suspend");
-const webserver = require("./modules/webserver");
+const { plugin: webserver } = require("./modules/webserver");
 const greeting = require("./modules/greeting");
 const typingProxy = require("./modules/typingProxy");
 const version = require("./modules/version");

src/modules/webserver.js

@@ -54,16 +54,19 @@ function serveAttachments(req, res) {
   })
 }
 
-module.exports = () => {
+const server = express();
-  const server = express();
+server.use(helmet());
-  server.use(helmet());
 
-  server.get("/logs/:threadId", serveLogs);
+server.get("/logs/:threadId", serveLogs);
-  server.get("/logs/:attachmentId/:filename", serveAttachments);
+server.get("/logs/:attachmentId/:filename", serveAttachments);
 
-  server.on("error", err => {
+server.on("error", err => {
   console.log("[WARN] Web server error:", err.message);
-  });
+});
 
+module.exports = {
+  server,
+  plugin() {
     server.listen(config.port);
+  },
 };

src/pluginApi.js

@@ -1,3 +1,4 @@
+const express = require("express");
 const { CommandManager } = require("knub-command-manager");
 const { Client } = require("eris");
 const Knex = require("knex");
@@ -12,6 +13,7 @@ const Knex = require("knex");
  * @property {PluginLogsAPI} logs
  * @property {PluginHooksAPI} hooks
  * @property {FormattersExport} formats
+ * @property {express.Application} webserver
  */
 
 /**

src/plugins.js

@@ -3,6 +3,7 @@ const logs = require("./data/logs");
 const { beforeNewThread } = require("./hooks/beforeNewThread");
 const { afterThreadClose } = require("./hooks/afterThreadClose");
 const formats = require("./formatters");
+const { server: webserver } = require("./modules/webserver");
 
 module.exports = {
   /**
@@ -40,6 +41,7 @@ module.exports = {
         afterThreadClose,
       },
       formats,
+      webserver,
     };
   },