roster-server 1.8.2 → 1.8.6

package/README.md

@@ -162,6 +162,31 @@ When creating a new `RosterServer` instance, you can pass the following options:
 - `wwwPath` (string): Path to your `www` directory containing your sites.
 - `greenlockStorePath` (string): Directory for Greenlock configuration.
 - `staging` (boolean): Set to `true` to use Let's Encrypt's staging environment (for testing).
+- `local` (boolean): Set to `true` to run in local development mode.
+
+## 🏠 Local Development Mode
+
+For local development and testing, you can run RosterServer in local mode by setting `local: true`. This mode is perfect for development environments where you don't need SSL certificates or production features.
+
+When `{ local: true }` is enabled, RosterServer **Skips SSL/HTTPS**: Runs pure HTTP servers instead of HTTPS.
+
+### Setting Up Local Mode
+
+```javascript
+const server = new Roster({
+    wwwPath: '/srv/www',
+    local: true  // Enable local development mode
+});
+server.start();
+```
+
+### Port Assignment
+
+In local mode, domains are automatically assigned ports starting from 3000:
+
+- `example.com` → `http://localhost:3000`
+- `api.example.com` → `http://localhost:3001`  
+- And so on...
 
 ## 🧂 A Touch of Magic
 

package/demo/package-lock.json

@@ -0,0 +1,252 @@
+{
+  "name": "demo",
+  "version": "1.0.0",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "demo",
+      "version": "1.0.0",
+      "license": "ISC",
+      "dependencies": {
+        "socket.io": "^4.8.1"
+      }
+    },
+    "node_modules/@socket.io/component-emitter": {
+      "version": "3.1.2",
+      "resolved": "https://registry.npmjs.org/@socket.io/component-emitter/-/component-emitter-3.1.2.tgz",
+      "integrity": "sha512-9BCxFwvbGg/RsZK9tjXd8s4UcwR0MWeFQ1XEKIQVVvAGJyINdrqKMcTRyLoK8Rse1GjzLV9cwjWV1olXRWEXVA==",
+      "license": "MIT"
+    },
+    "node_modules/@types/cors": {
+      "version": "2.8.19",
+      "resolved": "https://registry.npmjs.org/@types/cors/-/cors-2.8.19.tgz",
+      "integrity": "sha512-mFNylyeyqN93lfe/9CSxOGREz8cpzAhH+E93xJ4xWQf62V8sQ/24reV2nyzUWM6H6Xji+GGHpkbLe7pVoUEskg==",
+      "license": "MIT",
+      "dependencies": {
+        "@types/node": "*"
+      }
+    },
+    "node_modules/@types/node": {
+      "version": "24.10.2",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-24.10.2.tgz",
+      "integrity": "sha512-WOhQTZ4G8xZ1tjJTvKOpyEVSGgOTvJAfDK3FNFgELyaTpzhdgHVHeqW8V+UJvzF5BT+/B54T/1S2K6gd9c7bbA==",
+      "license": "MIT",
+      "dependencies": {
+        "undici-types": "~7.16.0"
+      }
+    },
+    "node_modules/accepts": {
+      "version": "1.3.8",
+      "resolved": "https://registry.npmjs.org/accepts/-/accepts-1.3.8.tgz",
+      "integrity": "sha512-PYAthTa2m2VKxuvSD3DPC/Gy+U+sOA1LAuT8mkmRuvw+NACSaeXEQ+NHcVF7rONl6qcaxV3Uuemwawk+7+SJLw==",
+      "license": "MIT",
+      "dependencies": {
+        "mime-types": "~2.1.34",
+        "negotiator": "0.6.3"
+      },
+      "engines": {
+        "node": ">= 0.6"
+      }
+    },
+    "node_modules/base64id": {
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/base64id/-/base64id-2.0.0.tgz",
+      "integrity": "sha512-lGe34o6EHj9y3Kts9R4ZYs/Gr+6N7MCaMlIFA3F1R2O5/m7K06AxfSeO5530PEERE6/WyEg3lsuyw4GHlPZHog==",
+      "license": "MIT",
+      "engines": {
+        "node": "^4.5.0 || >= 5.9"
+      }
+    },
+    "node_modules/cookie": {
+      "version": "0.7.2",
+      "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.7.2.tgz",
+      "integrity": "sha512-yki5XnKuf750l50uGTllt6kKILY4nQ1eNIQatoXEByZ5dWgnKqbnqmTrBE5B4N7lrMJKQ2ytWMiTO2o0v6Ew/w==",
+      "license": "MIT",
+      "engines": {
+        "node": ">= 0.6"
+      }
+    },
+    "node_modules/cors": {
+      "version": "2.8.5",
+      "resolved": "https://registry.npmjs.org/cors/-/cors-2.8.5.tgz",
+      "integrity": "sha512-KIHbLJqu73RGr/hnbrO9uBeixNGuvSQjul/jdFvS/KFSIH1hWVd1ng7zOHx+YrEfInLG7q4n6GHQ9cDtxv/P6g==",
+      "license": "MIT",
+      "dependencies": {
+        "object-assign": "^4",
+        "vary": "^1"
+      },
+      "engines": {
+        "node": ">= 0.10"
+      }
+    },
+    "node_modules/debug": {
+      "version": "4.3.7",
+      "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.7.tgz",
+      "integrity": "sha512-Er2nc/H7RrMXZBFCEim6TCmMk02Z8vLC2Rbi1KEBggpo0fS6l0S1nnapwmIi3yW/+GOJap1Krg4w0Hg80oCqgQ==",
+      "license": "MIT",
+      "dependencies": {
+        "ms": "^2.1.3"
+      },
+      "engines": {
+        "node": ">=6.0"
+      },
+      "peerDependenciesMeta": {
+        "supports-color": {
+          "optional": true
+        }
+      }
+    },
+    "node_modules/engine.io": {
+      "version": "6.6.4",
+      "resolved": "https://registry.npmjs.org/engine.io/-/engine.io-6.6.4.tgz",
+      "integrity": "sha512-ZCkIjSYNDyGn0R6ewHDtXgns/Zre/NT6Agvq1/WobF7JXgFff4SeDroKiCO3fNJreU9YG429Sc81o4w5ok/W5g==",
+      "license": "MIT",
+      "dependencies": {
+        "@types/cors": "^2.8.12",
+        "@types/node": ">=10.0.0",
+        "accepts": "~1.3.4",
+        "base64id": "2.0.0",
+        "cookie": "~0.7.2",
+        "cors": "~2.8.5",
+        "debug": "~4.3.1",
+        "engine.io-parser": "~5.2.1",
+        "ws": "~8.17.1"
+      },
+      "engines": {
+        "node": ">=10.2.0"
+      }
+    },
+    "node_modules/engine.io-parser": {
+      "version": "5.2.3",
+      "resolved": "https://registry.npmjs.org/engine.io-parser/-/engine.io-parser-5.2.3.tgz",
+      "integrity": "sha512-HqD3yTBfnBxIrbnM1DoD6Pcq8NECnh8d4As1Qgh0z5Gg3jRRIqijury0CL3ghu/edArpUYiYqQiDUQBIs4np3Q==",
+      "license": "MIT",
+      "engines": {
+        "node": ">=10.0.0"
+      }
+    },
+    "node_modules/mime-db": {
+      "version": "1.52.0",
+      "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz",
+      "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==",
+      "license": "MIT",
+      "engines": {
+        "node": ">= 0.6"
+      }
+    },
+    "node_modules/mime-types": {
+      "version": "2.1.35",
+      "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz",
+      "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==",
+      "license": "MIT",
+      "dependencies": {
+        "mime-db": "1.52.0"
+      },
+      "engines": {
+        "node": ">= 0.6"
+      }
+    },
+    "node_modules/ms": {
+      "version": "2.1.3",
+      "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz",
+      "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==",
+      "license": "MIT"
+    },
+    "node_modules/negotiator": {
+      "version": "0.6.3",
+      "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.3.tgz",
+      "integrity": "sha512-+EUsqGPLsM+j/zdChZjsnX51g4XrHFOIXwfnCVPGlQk/k5giakcKsuxCObBRu6DSm9opw/O6slWbJdghQM4bBg==",
+      "license": "MIT",
+      "engines": {
+        "node": ">= 0.6"
+      }
+    },
+    "node_modules/object-assign": {
+      "version": "4.1.1",
+      "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz",
+      "integrity": "sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg==",
+      "license": "MIT",
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
+    "node_modules/socket.io": {
+      "version": "4.8.1",
+      "resolved": "https://registry.npmjs.org/socket.io/-/socket.io-4.8.1.tgz",
+      "integrity": "sha512-oZ7iUCxph8WYRHHcjBEc9unw3adt5CmSNlppj/5Q4k2RIrhl8Z5yY2Xr4j9zj0+wzVZ0bxmYoGSzKJnRl6A4yg==",
+      "license": "MIT",
+      "dependencies": {
+        "accepts": "~1.3.4",
+        "base64id": "~2.0.0",
+        "cors": "~2.8.5",
+        "debug": "~4.3.2",
+        "engine.io": "~6.6.0",
+        "socket.io-adapter": "~2.5.2",
+        "socket.io-parser": "~4.2.4"
+      },
+      "engines": {
+        "node": ">=10.2.0"
+      }
+    },
+    "node_modules/socket.io-adapter": {
+      "version": "2.5.5",
+      "resolved": "https://registry.npmjs.org/socket.io-adapter/-/socket.io-adapter-2.5.5.tgz",
+      "integrity": "sha512-eLDQas5dzPgOWCk9GuuJC2lBqItuhKI4uxGgo9aIV7MYbk2h9Q6uULEh8WBzThoI7l+qU9Ast9fVUmkqPP9wYg==",
+      "license": "MIT",
+      "dependencies": {
+        "debug": "~4.3.4",
+        "ws": "~8.17.1"
+      }
+    },
+    "node_modules/socket.io-parser": {
+      "version": "4.2.4",
+      "resolved": "https://registry.npmjs.org/socket.io-parser/-/socket.io-parser-4.2.4.tgz",
+      "integrity": "sha512-/GbIKmo8ioc+NIWIhwdecY0ge+qVBSMdgxGygevmdHj24bsfgtCmcUUcQ5ZzcylGFHsN3k4HB4Cgkl96KVnuew==",
+      "license": "MIT",
+      "dependencies": {
+        "@socket.io/component-emitter": "~3.1.0",
+        "debug": "~4.3.1"
+      },
+      "engines": {
+        "node": ">=10.0.0"
+      }
+    },
+    "node_modules/undici-types": {
+      "version": "7.16.0",
+      "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-7.16.0.tgz",
+      "integrity": "sha512-Zz+aZWSj8LE6zoxD+xrjh4VfkIG8Ya6LvYkZqtUQGJPZjYl53ypCaUwWqo7eI0x66KBGeRo+mlBEkMSeSZ38Nw==",
+      "license": "MIT"
+    },
+    "node_modules/vary": {
+      "version": "1.1.2",
+      "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz",
+      "integrity": "sha512-BNGbWLfd0eUPabhkXUVm0j8uuvREyTh5ovRa/dyow/BqAbZJyC+5fU+IzQOzmAKzYqYRAISoRhdQr3eIZ/PXqg==",
+      "license": "MIT",
+      "engines": {
+        "node": ">= 0.8"
+      }
+    },
+    "node_modules/ws": {
+      "version": "8.17.1",
+      "resolved": "https://registry.npmjs.org/ws/-/ws-8.17.1.tgz",
+      "integrity": "sha512-6XQFvXTkbfUOZOKKILFG1PDK2NDQs4azKQl26T0YS5CxqWLgXajbPZ+h4gZekJyRqFU8pvnbAbbs/3TgRPy+GQ==",
+      "license": "MIT",
+      "engines": {
+        "node": ">=10.0.0"
+      },
+      "peerDependencies": {
+        "bufferutil": "^4.0.1",
+        "utf-8-validate": ">=5.0.2"
+      },
+      "peerDependenciesMeta": {
+        "bufferutil": {
+          "optional": true
+        },
+        "utf-8-validate": {
+          "optional": true
+        }
+      }
+    }
+  }
+}

package/demo/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "demo",
+  "version": "1.0.0",
+  "description": "",
+  "license": "ISC",
+  "author": "",
+  "type": "commonjs",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "socket.io": "^4.8.1"
+  }
+}

package/demo/socketio.js

@@ -0,0 +1,28 @@
+const Roster = require('../index.js');
+const { Server } = require('socket.io');
+
+const roster = new Roster({ local: true });
+
+roster.register('example.com', (httpsServer) => {
+    const io = new Server(httpsServer);
+
+    io.on('connection', (socket) => {
+        console.log('A user connected');
+
+        socket.on('chat:message', (msg) => {
+            console.log('Message received:', msg);
+            io.emit('chat:message', msg);
+        });
+
+        socket.on('disconnect', () => {
+            console.log('User disconnected');
+        });
+    });
+
+    return (req, res) => {
+        res.writeHead(404);
+        res.end('Not found');
+    };
+});
+
+roster.start();

package/index.js

@@ -5,6 +5,7 @@ const https = require('https');
 const tls = require('tls');
 const { EventEmitter } = require('events');
 const Greenlock = require('greenlock-express');
+const log = require('lemonlog')('roster');
 
 // Virtual Server that completely isolates applications
 class VirtualServer extends EventEmitter {
@@ -66,8 +67,31 @@ class VirtualServer extends EventEmitter {
     
     // Process request with this virtual server's listeners
     processRequest(req, res) {
+        let handled = false;
+        
+        // Track if response was handled
+        const originalEnd = res.end;
+        res.end = function(...args) {
+            handled = true;
+            return originalEnd.apply(this, args);
+        };
+        
+        // Try all listeners
         for (const listener of this.requestListeners) {
-            listener(req, res);
+            if (!handled) {
+                listener(req, res);
+            }
+        }
+        
+        // Restore original end method
+        res.end = originalEnd;
+        
+        // If no listener handled the request, try fallback handler
+        if (!handled && this.fallbackHandler) {
+            this.fallbackHandler(req, res);
+        } else if (!handled) {
+            res.writeHead(404);
+            res.end('No handler found');
         }
     }
 }
@@ -80,7 +104,7 @@ class Roster {
         this.greenlockStorePath = options.greenlockStorePath || path.join(basePath, 'greenlock.d');
         this.staging = options.staging || false;
         this.cluster = options.cluster || false;
-        this.local = options.local || false; // New local mode option
+        this.local = options.local || false;
         this.domains = [];
         this.sites = {};
         this.domainServers = {}; // Store separate servers for each domain
@@ -98,7 +122,7 @@ class Roster {
     async loadSites() {
         // Check if wwwPath exists
         if (!fs.existsSync(this.wwwPath)) {
-            console.warn(`⚠️  WWW path does not exist: ${this.wwwPath}`);
+            log.warn(`⚠️  WWW path does not exist: ${this.wwwPath}`);
             return;
         }
 
@@ -125,7 +149,7 @@ class Roster {
                         siteApp = siteApp.default || siteApp;
                         break;
                     } catch (err) {
-                        console.warn(`⚠️  Error loading ${indexPath}:`, err);
+                        log.warn(`⚠️  Error loading ${indexPath}:`, err);
                     }
                 }
             }
@@ -137,9 +161,9 @@ class Roster {
                     this.sites[d] = siteApp;
                 });
 
-                console.log(`✅  Loaded site: ${domain}`);
+                log.info(`(✔) Loaded site: https://${domain}`);
             } else {
-                console.warn(`⚠️  No index file (js/mjs/cjs) found in ${domainPath}`);
+                log.warn(`⚠️  No index file (js/mjs/cjs) found in ${domainPath}`);
             }
         }
     }
@@ -217,16 +241,16 @@ class Roster {
             const currentConfigContentFormatted = JSON.stringify(currentConfig, null, 2);
 
             if (newConfigContent === currentConfigContentFormatted) {
-                console.log('ℹ️  Configuration has not changed. config.json will not be overwritten.');
+                log.info('ℹ️  Configuration has not changed. config.json will not be overwritten.');
                 return;
             }
-            console.log('🔄  Configuration has changed. config.json will be updated.');
+            log.info('🔄  Configuration has changed. config.json will be updated.');
         } else {
-            console.log('🆕  config.json does not exist. A new one will be created.');
+            log.info('🆕  config.json does not exist. A new one will be created.');
         }
 
         fs.writeFileSync(configPath, JSON.stringify(newConfig, null, 2));
-        console.log(`📁  config.json generated at ${configPath}`);
+        log.info(`📁  config.json generated at ${configPath}`);
     }
 
     handleRequest(req, res) {
@@ -270,7 +294,7 @@ class Roster {
             this.sites[domainKey] = requestHandler;
         });
 
-        console.log(`✅  Registered site: ${domain}${port !== this.defaultPort ? ':' + port : ''}`);
+        log.info(`(✔) Registered site: ${domain}${port !== this.defaultPort ? ':' + port : ''}`);
         return this;
     }
 
@@ -334,6 +358,9 @@ class Roster {
             
             // Create simple dispatcher for this domain
             const dispatcher = (req, res) => {
+                // Set fallback handler on virtual server for non-Socket.IO requests
+                virtualServer.fallbackHandler = appHandler;
+                
                 if (virtualServer.requestListeners.length > 0) {
                     virtualServer.processRequest(req, res);
                 } else if (appHandler) {
@@ -349,17 +376,17 @@ class Roster {
             this.portServers[port] = httpServer;
             
             httpServer.listen(port, 'localhost', () => {
-                console.log(`🌐 ${domain} → http://localhost:${port}`);
+                log.info(`🌐 ${domain} → http://localhost:${port}`);
             });
             
             httpServer.on('error', (error) => {
-                console.error(`❌ Error on port ${port} for ${domain}:`, error.message);
+                log.error(`❌ Error on port ${port} for ${domain}:`, error.message);
             });
             
             currentPort++;
         }
         
-        console.log(`✅ Started ${currentPort - startPort} sites in local mode`);
+        log.info(`(✔) Started ${currentPort - startPort} sites in local mode`);
         return Promise.resolve();
     }
 
@@ -431,6 +458,8 @@ class Roster {
                     const appHandler = portData.appHandlers[domain];
                     
                     if (virtualServer && virtualServer.requestListeners.length > 0) {
+                        // Set fallback handler on virtual server for non-Socket.IO requests
+                        virtualServer.fallbackHandler = appHandler;
                         // App registered listeners on virtual server - use them
                         virtualServer.processRequest(req, res);
                     } else if (appHandler) {
@@ -444,7 +473,7 @@ class Roster {
             };
 
             httpServer.listen(80, this.hostname, () => {
-                console.log('HTTP server listening on port 80');
+                log.info('HTTP server listening on port 80');
             });
 
             // Handle different port types
@@ -458,7 +487,7 @@ class Roster {
                     this.portServers[portNum] = httpsServer;
                     
                     httpsServer.listen(portNum, this.hostname, () => {
-                        console.log(`HTTPS server listening on port ${portNum}`);
+                        log.info(`HTTPS server listening on port ${portNum}`);
                     });
                 } else {
                     // Create HTTPS server for custom ports using Greenlock certificates
@@ -492,13 +521,13 @@ class Roster {
                     const httpsServer = https.createServer(httpsOptions, dispatcher);
                     
                     httpsServer.on('error', (error) => {
-                        console.error(`HTTPS server error on port ${portNum}:`, error.message);
+                        log.error(`HTTPS server error on port ${portNum}:`, error.message);
                     });
                     
                     httpsServer.on('tlsClientError', (error) => {
                         // Suppress HTTP request errors to avoid log spam
                         if (!error.message.includes('http request')) {
-                            console.error(`TLS error on port ${portNum}:`, error.message);
+                            log.error(`TLS error on port ${portNum}:`, error.message);
                         }
                     });
                     
@@ -506,9 +535,9 @@ class Roster {
                     
                     httpsServer.listen(portNum, this.hostname, (error) => {
                         if (error) {
-                            console.error(`Failed to start HTTPS server on port ${portNum}:`, error.message);
+                            log.error(`Failed to start HTTPS server on port ${portNum}:`, error.message);
                         } else {
-                            console.log(`HTTPS server listening on port ${portNum}`);
+                            log.info(`HTTPS server listening on port ${portNum}`);
                         }
                     });
                 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "roster-server",
-    "version": "1.8.2",
+    "version": "1.8.6",
     "description": "👾 RosterServer - A domain host router to host multiple HTTPS.",
     "main": "index.js",
     "scripts": {
@@ -34,6 +34,7 @@
     },
     "homepage": "https://github.com/clasen/RosterServer#readme",
     "dependencies": {
-        "greenlock-express": "^4.0.3"
+        "greenlock-express": "^4.0.3",
+        "lemonlog": "^1.2.0"
     }
 }