redweb 0.7.2 → 0.7.4

package/src/http/BaseHttpServer.js

@@ -1,105 +1,105 @@
-const express = require('express');
-const bodyParser = require('body-parser');
-const path = require('path');
-const cors = require('cors');
-const fs = require('fs');
-const HtmxRenderer = require('../htmx/HtmxRenderer'); // Import the HtmxRenderer module
-
-/**
- * @typedef {'json' | 'urlencoded'} RedWebEncoding
- */
-
-/**
- * RedWeb options object.
- * @typedef {Object} RedWebOptions
- * @property {number} [port=80] - The port number to bind the server.
- * @property {string} [bind='0.0.0.0'] - The bind address for the server.
- * @property {string[]} [publicPaths=['./public']] - An array of paths to serve static files from.
- * @property {Array<{serviceName: string, method: string, function: Function}>} [services=[]] - An array of services with their endpoints and handlers.
- * @property {Function} [listenCallback] - Callback function to execute once the server starts listening.
- * @property {RedWebEncoding} [encoding='json'] - The encoding type for the request bodies ('json' or 'urlencoded').
- * @property {Object} [ssl] - SSL configuration for HTTPS server.
- * @property {string} [ssl.key] - Path to the SSL key file.
- * @property {string} [ssl.cert] - Path to the SSL certificate file.
- * @property {import('express').Application} [server] - Whether to automatically start listening.
- * @property {import('cors').CorsOptions} [corsOptions] - The CORS Options.
- * @property {boolean} [enableHtmxRendering=false] - Enable dynamic HTMX file rendering.
- */
-
-const ENCODINGS = { json: 'json', urlencoded: 'urlencoded' };
-const HTTP_OPTIONS = {
-    port: 80,
-    bind: '0.0.0.0',
-    publicPaths: ['./public'],
-    services: [],
-    listenCallback: undefined,
-    encoding: ENCODINGS.json,
-    ssl: null,
-    server: undefined,
-    corsOptions: undefined,
-    enableHtmxRendering: false, // New option for HTMX rendering
-};
-
-/**
- * Base HTTP Server
- * @param {RedWebOptions} options - Configuration options for RedWeb.
- * @return {Object} Express application instance.
- */
-function BaseHttpServer(options = {}) {
-    this.options = { ...HTTP_OPTIONS, ...options };
-    this.app = express() || this.options.server;
-    Object.assign(this, this.options);
-
-    // Middleware to parse request bodies based on the specified encoding
-    if (this.encoding === ENCODINGS.json) {
-        this.app.use(bodyParser.json());
-    } else if (this.encoding === ENCODINGS.urlencoded) {
-        this.app.use(bodyParser.urlencoded({ extended: true }));
-    }
-
-    this.app.use(cors(this.options.corsOptions));
-
-    // Enable HTMX rendering if the flag is set
-    if (this.enableHtmxRendering) {
-        this.app.get('*.htmx', (req, res) => {
-            // Find the file in one of the publicPaths
-            const filePath = this.publicPaths
-                .map(publicPath => path.join(process.cwd(), publicPath, req.path))
-                .find(fullPath => fs.existsSync(fullPath)); // Check if the file exists
-    
-            if (!filePath) {
-                return res.status(404).send(`Error rendering HTMX file: Template file not found: ${req.path}`);
-            }
-    
-            try {
-                const renderedContent = HtmxRenderer.render(filePath);
-                res.type('html').send(renderedContent);
-            } catch (error) {
-                res.status(500).send(`Error rendering HTMX file: ${error.message}`);
-            }
-        });
-    }
-    
-
-    // Serve static files from public paths
-    this.publicPaths.forEach((publicPath) =>
-        this.app.use(express.static(path.join(process.cwd(), publicPath)))
-    );
-
-    const catchAll = this.services.find((service) => service.serviceName === '*');
-    if (catchAll) this.services.splice(this.services.indexOf(catchAll), 1);
-    this.services.forEach((service) =>
-        this.app[service.method](service.serviceName, service.function)
-    );
-    if (catchAll) this.app[catchAll.method](catchAll.serviceName, catchAll.function);
-
-    return this;
-}
-
-
-module.exports = {
-    BaseHttpServer,
-    ENCODINGS,
-    HTTP_OPTIONS,
-    METHODS: { GET: 'get', POST: 'post', PUT: 'put', DELETE: 'delete' },
-};
+const express = require('express');
+const bodyParser = require('body-parser');
+const path = require('path');
+const cors = require('cors');
+const fs = require('fs');
+const HtmxRenderer = require('../htmx/HtmxRenderer'); // Import the HtmxRenderer module
+
+/**
+ * @typedef {'json' | 'urlencoded'} RedWebEncoding
+ */
+
+/**
+ * RedWeb options object.
+ * @typedef {Object} RedWebOptions
+ * @property {number} [port=80] - The port number to bind the server.
+ * @property {string} [bind='0.0.0.0'] - The bind address for the server.
+ * @property {string[]} [publicPaths=['./public']] - An array of paths to serve static files from.
+ * @property {Array<{serviceName: string, method: string, function: Function}>} [services=[]] - An array of services with their endpoints and handlers.
+ * @property {Function} [listenCallback] - Callback function to execute once the server starts listening.
+ * @property {RedWebEncoding} [encoding='json'] - The encoding type for the request bodies ('json' or 'urlencoded').
+ * @property {Object} [ssl] - SSL configuration for HTTPS server.
+ * @property {string} [ssl.key] - Path to the SSL key file.
+ * @property {string} [ssl.cert] - Path to the SSL certificate file.
+ * @property {import('express').Application} [server] - Whether to automatically start listening.
+ * @property {import('cors').CorsOptions} [corsOptions] - The CORS Options.
+ * @property {boolean} [enableHtmxRendering=false] - Enable dynamic HTMX file rendering.
+ */
+
+const ENCODINGS = { json: 'json', urlencoded: 'urlencoded' };
+const HTTP_OPTIONS = {
+    port: 80,
+    bind: '0.0.0.0',
+    publicPaths: ['./public'],
+    services: [],
+    listenCallback: undefined,
+    encoding: ENCODINGS.json,
+    ssl: null,
+    server: undefined,
+    corsOptions: undefined,
+    enableHtmxRendering: false, // New option for HTMX rendering
+};
+
+/**
+ * Base HTTP Server
+ * @param {RedWebOptions} options - Configuration options for RedWeb.
+ * @return {Object} Express application instance.
+ */
+function BaseHttpServer(options = {}) {
+    this.options = { ...HTTP_OPTIONS, ...options };
+    this.app = express() || this.options.server;
+    Object.assign(this, this.options);
+
+    // Middleware to parse request bodies based on the specified encoding
+    if (this.encoding === ENCODINGS.json) {
+        this.app.use(bodyParser.json());
+    } else if (this.encoding === ENCODINGS.urlencoded) {
+        this.app.use(bodyParser.urlencoded({ extended: true }));
+    }
+
+    this.app.use(cors(this.options.corsOptions));
+
+    // Enable HTMX rendering if the flag is set
+    if (this.enableHtmxRendering) {
+        this.app.get('*.htmx', (req, res) => {
+            // Find the file in one of the publicPaths
+            const filePath = this.publicPaths
+                .map(publicPath => path.join(process.cwd(), publicPath, req.path))
+                .find(fullPath => fs.existsSync(fullPath)); // Check if the file exists
+    
+            if (!filePath) {
+                return res.status(404).send(`Error rendering HTMX file: Template file not found: ${req.path}`);
+            }
+    
+            try {
+                const renderedContent = HtmxRenderer.render(filePath);
+                res.type('html').send(renderedContent);
+            } catch (error) {
+                res.status(500).send(`Error rendering HTMX file: ${error.message}`);
+            }
+        });
+    }
+    
+
+    // Serve static files from public paths
+    this.publicPaths.forEach((publicPath) =>
+        this.app.use(express.static(path.join(process.cwd(), publicPath)))
+    );
+
+    const catchAll = this.services.find((service) => service.serviceName === '*');
+    if (catchAll) this.services.splice(this.services.indexOf(catchAll), 1);
+    this.services.forEach((service) =>
+        this.app[service.method](service.serviceName, service.function)
+    );
+    if (catchAll) this.app[catchAll.method](catchAll.serviceName, catchAll.function);
+
+    return this;
+}
+
+
+module.exports = {
+    BaseHttpServer,
+    ENCODINGS,
+    HTTP_OPTIONS,
+    METHODS: { GET: 'get', POST: 'post', PUT: 'put', DELETE: 'delete' },
+};

package/src/http/HttpServer.js

@@ -1,14 +1,14 @@
-const { BaseHttpServer } = require('./BaseHttpServer');
-
-/**
- * HTTP Server
- * @param {RedWebOptions} options - Configuration options for RedWeb.
- * @return {Object} Express application instance.
- */
-function HttpServer(options = {}) {
-    BaseHttpServer.call(this, options);
-    this.server = this.app.listen(this.port, this.listenCallback ? this.listenCallback : () => console.log(`RedWeb HttpServer listening on port ${this.port}`));
-    return this;
-}
-
-module.exports = HttpServer;
+const { BaseHttpServer } = require('./BaseHttpServer');
+
+/**
+ * HTTP Server
+ * @param {RedWebOptions} options - Configuration options for RedWeb.
+ * @return {Object} Express application instance.
+ */
+function HttpServer(options = {}) {
+    BaseHttpServer.call(this, options);
+    this.server = this.app.listen(this.port, this.listenCallback ? this.listenCallback : () => console.log(`RedWeb HttpServer listening on port ${this.port}`));
+    return this;
+}
+
+module.exports = HttpServer;

package/src/http/HttpsServer.js

@@ -1,17 +1,17 @@
-const https = require('https');
-const { BaseHttpServer } = require('./BaseHttpServer');
-const loadSslConfig = require('../sslConfig');
-
-/**
- * HTTPS Server
- * @param {RedWebOptions} options - Configuration options for RedWeb.
- * @return {Object} Express application instance.
- */
-function HttpsServer(options = {}) {
-    BaseHttpServer.call(this, options);
-    const sslOptions = loadSslConfig(this.ssl);
-    https.createServer(sslOptions, this.app).listen(this.port, this.listenCallback ? this.listenCallback : () => console.log(`RedWeb HttpsServer listening on port ${this.port}`));
-    return this;
-}
-
-module.exports = HttpsServer;
+const https = require('https');
+const { BaseHttpServer } = require('./BaseHttpServer');
+const loadSslConfig = require('../sslConfig');
+
+/**
+ * HTTPS Server
+ * @param {RedWebOptions} options - Configuration options for RedWeb.
+ * @return {Object} Express application instance.
+ */
+function HttpsServer(options = {}) {
+    BaseHttpServer.call(this, options);
+    const sslOptions = loadSslConfig(this.ssl);
+    https.createServer(sslOptions, this.app).listen(this.port, this.listenCallback ? this.listenCallback : () => console.log(`RedWeb HttpsServer listening on port ${this.port}`));
+    return this;
+}
+
+module.exports = HttpsServer;

package/src/http/index.js

@@ -1,2 +1,2 @@
-const { METHODS } = require('./BaseHttpServer');
+const { METHODS } = require('./BaseHttpServer');
 module.exports = { HttpServer: require('./HttpServer'), HttpsServer: require('./HttpsServer'), METHODS}

package/src/sslConfig.js

@@ -1,20 +1,20 @@
-const fs = require('fs');
-
-/**
- * Load SSL configuration
- * @param {Object} sslOptions - The SSL options object containing the paths to key and cert files.
- * @param {string} sslOptions.key - Path to the SSL key file.
- * @param {string} sslOptions.cert - Path to the SSL certificate file.
- * @return {Object} - The loaded SSL options containing key and cert.
- */
-function loadSslConfig(sslOptions) {
-    if (!sslOptions || !sslOptions.key || !sslOptions.cert) {
-        throw new Error('SSL key and certificate paths must be provided');
-    }
-    return {
-        key: fs.readFileSync(sslOptions.key),
-        cert: fs.readFileSync(sslOptions.cert)
-    };
-}
-
-module.exports = loadSslConfig;
+const fs = require('fs');
+
+/**
+ * Load SSL configuration
+ * @param {Object} sslOptions - The SSL options object containing the paths to key and cert files.
+ * @param {string} sslOptions.key - Path to the SSL key file.
+ * @param {string} sslOptions.cert - Path to the SSL certificate file.
+ * @return {Object} - The loaded SSL options containing key and cert.
+ */
+function loadSslConfig(sslOptions) {
+    if (!sslOptions || !sslOptions.key || !sslOptions.cert) {
+        throw new Error('SSL key and certificate paths must be provided');
+    }
+    return {
+        key: fs.readFileSync(sslOptions.key),
+        cert: fs.readFileSync(sslOptions.cert)
+    };
+}
+
+module.exports = loadSslConfig;

package/src/ws/BaseHandler.js

@@ -1,39 +1,39 @@
-/**
- * Represents the base class for a WebSocket message handler.
- */
-class BaseHandler {
-    /**
-     * Creates a new handler instance.
-     * @param {string} name - The name of the Handler, used in the client 'type' arg of request e.g {"type": "<handler-name>", ...}
-     */
-    constructor(name) {
-        /**
-         * he name of the Handler, used in the client 'type' arg of request e.g {"type": "<handler-name>", ...}.
-         * @type {string}
-         */
-        this.name = name;
-    }
-    /**
-     * Handles an incoming message and routes it to the appropriate handler function.
-     * @param {WebSocket & {sendJson: (message: Object) => void, broadcast: (message: Object) => void}} socket - The WebSocket connection that sent the message.
-     * @param {any} message - The incoming message in parsed JSON.
-     */
-    handleMessage(socket, message) {
-        this.onMessage(socket, message);
-    }
-
-    /**
-     * Method to be overriden to process messages.
-     * @param {WebSocket} socket - The WebSocket connection that sent the message.
-     * @param {any} message - The incoming message in parsed JSON.
-     */
-    onMessage(socket, message) {
-        throw "Not yet implemented!";
-    }
-
-    onInitialContact(socket) {
-
-    }
-}
-
-module.exports = { BaseHandler };
+/**
+ * Represents the base class for a WebSocket message handler.
+ */
+class BaseHandler {
+    /**
+     * Creates a new handler instance.
+     * @param {string} name - The name of the Handler, used in the client 'type' arg of request e.g {"type": "<handler-name>", ...}
+     */
+    constructor(name) {
+        /**
+         * he name of the Handler, used in the client 'type' arg of request e.g {"type": "<handler-name>", ...}.
+         * @type {string}
+         */
+        this.name = name;
+    }
+    /**
+     * Handles an incoming message and routes it to the appropriate handler function.
+     * @param {WebSocket & {sendJson: (message: Object) => void, broadcast: (message: Object) => void}} socket - The WebSocket connection that sent the message.
+     * @param {any} message - The incoming message in parsed JSON.
+     */
+    handleMessage(socket, message) {
+        this.onMessage(socket, message);
+    }
+
+    /**
+     * Method to be overriden to process messages.
+     * @param {WebSocket} socket - The WebSocket connection that sent the message.
+     * @param {any} message - The incoming message in parsed JSON.
+     */
+    onMessage(socket, message) {
+        throw "Not yet implemented!";
+    }
+
+    onInitialContact(socket) {
+
+    }
+}
+
+module.exports = { BaseHandler };

package/src/ws/BaseSocketServer.js

@@ -1,62 +1,76 @@
-/**
- * @typedef {Object} SocketServerOptions
- * @property {import('http').Server} [server]                    HTTP server to bind to
- * @property {number}              [port=3000]                  Port to listen on
- * @property {Array<new () => import('./SocketRoute').SocketRoute>} [routes]
- */
-
-const DefaultRoute = require('./DefaultRoute');
-
-const SOCKET_OPTIONS = {
-  port: 3000,
-  ssl:  null,
-  routes: []
-};
-
-/**
- * Base WebSocket server
- */
-class BaseSocketServer {
-  /**
-   * @param {import('http').Server} server
-   * @param {SocketServerOptions}  [options]
-   */
-  constructor(server, options = {}) {
-    this.clients = new Map();
-    Object.assign(this, { ...SOCKET_OPTIONS, ...options });
-    this.server = server;
-
-    /* ─── ROUTE INITIALISATION ─────────────────────────── */
-    if (!options.routes?.length) options.routes = [DefaultRoute];
-    this.routes = options.routes.map(RouteClass => new RouteClass(server));
-
-    this.server.on('upgrade', this.handleUpgrade.bind(this));
-  }
-
-  handleUpgrade(req, sock, head) {
-    const route = this.routes.find(r => r.path === req.url);
-    if (!route) return sock.destroy();
-
-    route.server.handleUpgrade(req, sock, head, (s, r) =>
-      route.server.emit('connection', s, r)
-    );
-  }
-
-  /**
-   * Dynamically attach a new route at runtime
-   * @param {new () => import('./SocketRoute').SocketRoute} RouteClass
-   */
-  addRoute(RouteClass) {
-    this.routes.push(new RouteClass(this.server));
-  }
-
-  /**
-   * Gracefully tear down all routes (and their services)
-   */
-  shutdown() {
-    this.routes.forEach(route => route.shutdown?.());
-    this.server.close();
-  }
-}
-
-module.exports = { BaseSocketServer, SOCKET_OPTIONS };
+/**
+ * @typedef {Object} SocketServerOptions
+ * @property {import('http').Server} [server]                    HTTP server to bind to
+ * @property {number}              [port=3000]                  Port to listen on
+ * @property {Array<new () => import('./SocketRoute').SocketRoute>} [routes]
+ */
+
+const DefaultRoute = require('./DefaultRoute');
+
+const SOCKET_OPTIONS = {
+  port: 3000,
+  ssl:  null,
+  routes: []
+};
+
+/**
+ * Base WebSocket server
+ */
+class BaseSocketServer {
+  /**
+   * @param {import('http').Server} server
+   * @param {SocketServerOptions}  [options]
+   */
+  constructor(server, options = {}) {
+    this.clients = new Map();
+    Object.assign(this, { ...SOCKET_OPTIONS, ...options });
+    this.server = server;
+
+    /* ─── ROUTE INITIALISATION ─────────────────────────── */
+    if (!options.routes?.length) options.routes = [DefaultRoute];
+    this.routes = options.routes.map(RouteClass => new RouteClass(server));
+
+    this.server.on('upgrade', this.handleUpgrade.bind(this));
+  }
+
+  handleUpgrade(req, sock, head) {
+    // Some websocket clients (e.g., certain UE plugins) are finicky about the
+    // HTTP upgrade path they send. Normalise the path and fall back to a default
+    // route so we can still complete the upgrade instead of tearing the socket down.
+    const path = (() => {
+      try {
+        return new URL(req.url, `http://${req.headers.host || 'localhost'}`).pathname;
+      } catch {
+        return req.url;
+      }
+    })();
+
+    const route =
+      this.routes.find(r => r.path === path) ||
+      this.routes.find(r => r.path === '/');
+
+    if (!route) return sock.destroy();
+
+    route.server.handleUpgrade(req, sock, head, (s, r) =>
+      route.server.emit('connection', s, r)
+    );
+  }
+
+  /**
+   * Dynamically attach a new route at runtime
+   * @param {new () => import('./SocketRoute').SocketRoute} RouteClass
+   */
+  addRoute(RouteClass) {
+    this.routes.push(new RouteClass(this.server));
+  }
+
+  /**
+   * Gracefully tear down all routes (and their services)
+   */
+  shutdown() {
+    this.routes.forEach(route => route.shutdown?.());
+    this.server.close();
+  }
+}
+
+module.exports = { BaseSocketServer, SOCKET_OPTIONS };

package/src/ws/DefaultHandler.js

@@ -1,14 +1,14 @@
-const { BaseHandler } = require("./BaseHandler");
-const { sendJson } = require("./util");
-
-class DefaultHandler extends BaseHandler {
-    constructor() {
-        super("DefaultHandler");
-    }
-
-    onMessage(socket, message) {
-        socket.send(sendJson(`I got your message of ${JSON.stringify(message)}`));
-    }
-}
-
+const { BaseHandler } = require("./BaseHandler");
+const { sendJson } = require("./util");
+
+class DefaultHandler extends BaseHandler {
+    constructor() {
+        super("DefaultHandler");
+    }
+
+    onMessage(socket, message) {
+        socket.send(sendJson(`I got your message of ${JSON.stringify(message)}`));
+    }
+}
+
 module.exports = DefaultHandler;

package/src/ws/DefaultRoute.js

@@ -1,14 +1,14 @@
-const SocketRoute  = require("./SocketRoute");
-const DefaultHandler = require('./DefaultHandler');
-
-class DefaultRoute extends SocketRoute {
-    constructor(server) {
-        super({
-            server,
-            path: "/",
-            handlers: [DefaultHandler]
-        })
-    }
-}
-
+const SocketRoute  = require("./SocketRoute");
+const DefaultHandler = require('./DefaultHandler');
+
+class DefaultRoute extends SocketRoute {
+    constructor(server) {
+        super({
+            server,
+            path: "/",
+            handlers: [DefaultHandler]
+        })
+    }
+}
+
 module.exports = DefaultRoute;

package/src/ws/SecureSocketServer.js

@@ -1,20 +1,20 @@
-const https = require('https');
-const loadSslConfig = require('../sslConfig');
-const { BaseSocketServer } = require('./BaseSocketServer');
-
-/**
- * Secure WebSocket Server
- * @param {SocketServerOptions} options - Configuration options for SecureSocketServer.
- * @return {Object} WebSocket server instance.
- */
-class SecureSocketServer extends BaseSocketServer {
-    constructor(options = {}) {
-        const sslOptions = loadSslConfig(options.ssl);
-        const server = https.createServer(sslOptions);
-        super(server, options);
-        server.listen(this.port, () => console.log(`RedWeb SecureSocketServer listening on port ${this.port}`));
-        return this;
-    }
-}
-
-module.exports = SecureSocketServer;
+const https = require('https');
+const loadSslConfig = require('../sslConfig');
+const { BaseSocketServer } = require('./BaseSocketServer');
+
+/**
+ * Secure WebSocket Server
+ * @param {SocketServerOptions} options - Configuration options for SecureSocketServer.
+ * @return {Object} WebSocket server instance.
+ */
+class SecureSocketServer extends BaseSocketServer {
+    constructor(options = {}) {
+        const sslOptions = loadSslConfig(options.ssl);
+        const server = https.createServer(sslOptions);
+        super(server, options);
+        server.listen(this.port, () => console.log(`RedWeb SecureSocketServer listening on port ${this.port}`));
+        return this;
+    }
+}
+
+module.exports = SecureSocketServer;