slower 1.1.8 → 1.1.10

package/lib/router.js

@@ -1,6 +1,6 @@
 const http = require('http');
 const fs = require('fs');
-const { noop, slugify, isSparseEqual, last, renderDynamicHTML } = require('./utils');
+const { noop, slugify, isSparseEqual, last, renderDynamicHTML, setSocketLocals } = require('./utils');
 
 class Route {
     constructor (path, type, callback) {
@@ -270,7 +270,17 @@ class SlowerRouter {
         return this.allowedMethods;
     }
 
-    start = function (port = 8080, callback) {
+    // Starts the server - listening at <host>:<port>
+    /**
+     * @category Router
+     * @param {Number} port The port number the server will listen to.
+     * @param {String} host The host's network interface address the server will listen into (use a falsy value or '0.0.0.0' for listening on all).
+     * @param {Function} methods The methods that are allowed by the application. Methods that do not conform with standards are ignored.
+     * @returns {Object} The AllowedMethods Array object.
+     * @example <caption> Allowing only GET and POST:</caption>
+     * app.setAllowedMethods(['GET', 'POST']);
+    */
+    start = function (port = 8080, host = undefined, callback = () => {}) {
         let routes = this.routes;
         let middle = this.middleware;
         let fallback = this.fallback;
@@ -279,6 +289,8 @@ class SlowerRouter {
 
         let server = http.createServer(function (req, res) {
             try {
+                // Sets local req.session object
+                setSocketLocals(req);
                 // Runs all middlewares
                 for (let i = 0; i < middle.length; i++) { middle[i](req, res); }
                 // Only respond to allowed methods with callbacks, else, use the default empty response.
@@ -307,7 +319,8 @@ class SlowerRouter {
             }
         });
         callback(server);
-        return server.listen(port);
+        if (!host) host = undefined; // Turn falsy values into undefined, for default behaviour
+        return server.listen(port, host);
     }
 }
 

package/lib/utils.js

@@ -69,6 +69,23 @@ const renderDynamicHTML = (html, patterns) => {
     return template;
 }
 
+const setSocketLocals = (socket) => {
+    socket.session = {};
+    socket.session.port = socket.socket.localPort;
+    socket.session.rport = socket.socket.remotePort;
+    socket.session.host = (
+        socket.socket.localAddress.startsWith('::') ? 
+        socket.socket.localAddress.substring(
+            socket.socketlocalAddress.indexOf(':',2)+1
+        ) : socket.socket.localAddress);
+        socket.session.rhost = (
+        socket.socket.remoteAddress.startsWith('::') ? 
+        socket.socket.remoteAddress.substring(
+            socket.socket.remoteAddress.indexOf(':',2)+1
+        ) : socket.socket.remoteAddress);
+    return socket;
+}
+
 const toBool = [() => true, () => false];
 
-module.exports = { noop, slugify, isSparseEqual, toBool, last, renderDynamicHTML };
+module.exports = { noop, slugify, isSparseEqual, toBool, last, renderDynamicHTML, setSocketLocals };

package/package.json

@@ -1,10 +1,9 @@
 {
   "name": "slower",
-  "version": "1.1.8",
+  "version": "1.1.10",
   "description": "",
   "main": "index.js",
   "directories": {
-    "doc": "doc",
     "lib": "lib"
   },
   "scripts": {

package/readme.md

@@ -41,8 +41,26 @@ app.setFallback((req, res) => {
     res.end();
 });
 
-app.start(port, () => {
+// Start app listening on all interfaces (0.0.0.0)
+app.start(port, null, () => {
     console.log(`Running on localhost:${port}`);
     console.log(app);
 });
-```
+```
+### API modifications on 'net.Socket' instances:
+ - The API modifies every ```net.Socket``` instance BEFORE it is passed 
+to ```app.connectionListener```. This means that all events receiving 
+a socket will receive the modified socket instead.
+ - The modifications adds the following properties to the socket instance:
+```
+ <socket>.session: Object           => A container for persistent data appended to sockets
+ <socket>.session.port: Number      => The local port number
+ <socket>.session.rport: Number     => The remote port number
+ <socket>.session.host: String      => The local host interface address
+ <socket>.session.rhost: String     => The remote host interface address
+```
+- It is possible to use the ```socket.session``` object to append data that will persist 
+during the lifetime of a single connection. Useful for keeping short-life local variables.
+
+- In HTTP ```http.IncomingMessage``` instances, the 'socket' instance is found over 'request'.
+So, considering the common callback of ```(req, res)```, the session container will be ```req.session```