pixl-server-web 1.3.21 → 1.3.22

package/README.md

@@ -8,6 +8,7 @@ This module is a component for use in [pixl-server](https://www.github.com/jhuck
 - [Usage](#usage)
 - [Configuration](#configuration)
 	* [http_port](#http_port)
+	* [http_alt_ports](#http_alt_ports)
 	* [http_bind_address](#http_bind_address)
 	* [http_htdocs_dir](#http_htdocs_dir)
 	* [http_max_upload_size](#http_max_upload_size)
@@ -47,12 +48,14 @@ This module is a component for use in [pixl-server](https://www.github.com/jhuck
 	* [http_clean_headers](#http_clean_headers)
 	* [http_log_socket_errors](#http_log_socket_errors)
 	* [http_full_uri_match](#http_full_uri_match)
+	* [http_flatten_query](#http_flatten_query)
 	* [http_req_max_dump_enabled](#http_req_max_dump_enabled)
 	* [http_req_max_dump_dir](#http_req_max_dump_dir)
 	* [http_req_max_dump_debounce](#http_req_max_dump_debounce)
 	* [http_public_ip_offset](#http_public_ip_offset)
 	* [https](#https)
 	* [https_port](#https_port)
+	* [https_alt_ports](#https_alt_ports)
 	* [https_cert_file](#https_cert_file)
 	* [https_key_file](#https_key_file)
 	* [https_ca_file](#https_ca_file)
@@ -167,11 +170,22 @@ The configuration for this component is set by passing in a `WebServer` key in t
 
 ## http_port
 
-This is the port to listen on.  The standard web port is 80, but note that only the root user can listen on ports below 1024.
+This is the main port to listen on.  The standard web port is 80, but note that only the root user can listen on ports below 1024.
+
+## http_alt_ports
+
+If you would like to have the server listen on additional ports, add them here as an array.  Example:
+
+```js
+{
+	"http_port": 80,
+	"http_alt_ports": [ 3000, 8080 ]
+}
+```
 
 ## http_bind_address
 
-Optionally specify an exact local IP address to bind the listener to.  By default this binds to all available addresses on the machine.  Example:
+Optionally specify an exact local IP address to bind the listeners to.  By default this binds to all available addresses on the machine.  Example:
 
 ```js
 {
@@ -571,6 +585,17 @@ This boolean allows you to enable HTTPS (SSL) support in the web server.  It def
 
 If HTTPS mode is enabled, this is the port to listen on for secure requests.  The standard HTTPS port is 443.
 
+## https_alt_ports
+
+If you would like to have the server listen on additional HTTPS ports, add them here as an array.  Example:
+
+```js
+{
+	"https_port": 443,
+	"https_alt_ports": [ 9000, 9001 ]
+}
+```
+
 ## https_cert_file
 
 If HTTPS mode is enabled, this should point to your SSL certificate file on disk.  The certificate file typically has a `.crt` filename extension, or possibly `cert.pem` if using [Let's Encrypt](https://letsencrypt.org/).

package/lib/http.js

@@ -8,10 +8,9 @@ const Perf = require('pixl-perf');
 
 module.exports = class HTTP {
 	
-	startHTTP(callback) {
+	startHTTP(port, callback) {
 		// start http server
 		var self = this;
-		var port = this.config.get('http_port');
 		var bind_addr = this.config.get('http_bind_address') || '';
 		var max_conns = this.config.get('http_max_connections') || 0;
 		var https_force = self.config.get('https_force') || false;
@@ -52,14 +51,14 @@ module.exports = class HTTP {
 			}
 		};
 		
-		this.http = require('http').createServer( handler );
+		var listener = require('http').createServer( handler );
 		
-		this.http.on('connection', function(socket) {
+		listener.on('connection', function(socket) {
 			var ip = socket.remoteAddress || '';
 			
 			if (max_conns && (self.numConns >= max_conns)) {
 				// reached maximum concurrent connections, abort new ones
-				self.logError('maxconns', "Maximum concurrent connections reached, denying connection from: " + ip, { ip: ip, max: max_conns });
+				self.logError('maxconns', "Maximum concurrent connections reached, denying connection from: " + ip, { ip: ip, port: port, max: max_conns });
 				socket.end();
 				socket.unref();
 				socket.destroy(); // hard close
@@ -68,7 +67,7 @@ module.exports = class HTTP {
 			}
 			if (self.server.shut) {
 				// server is shutting down, abort new connections
-				self.logError('shutdown', "Server is shutting down, denying connection from: " + ip, { ip: ip });
+				self.logError('shutdown', "Server is shutting down, denying connection from: " + ip, { ip: ip, port: port });
 				socket.end();
 				socket.unref();
 				socket.destroy(); // hard close
@@ -78,7 +77,7 @@ module.exports = class HTTP {
 			var id = self.getNextId('c');
 			self.conns[ id ] = socket;
 			self.numConns++;
-			self.logDebug(8, "New incoming HTTP connection: " + id, { ip: ip, num_conns: self.numConns });
+			self.logDebug(8, "New incoming HTTP connection: " + id, { ip: ip, port: port, num_conns: self.numConns });
 			
 			// Disable the Nagle algorithm.
 			socket.setNoDelay( true );
@@ -86,6 +85,7 @@ module.exports = class HTTP {
 			// add our own metadata to socket
 			socket._pixl_data = {
 				id: id,
+				port: port,
 				proto: 'http',
 				port: port,
 				time_start: (new Date()).getTime(),
@@ -101,6 +101,7 @@ module.exports = class HTTP {
 					var msg = "Socket preliminary timeout waiting for initial request (" + socket_prelim_timeout + " seconds)";
 					var err_args = {
 						ip: ip,
+						port: port,
 						pending: self.queue.length(),
 						active: self.queue.running(),
 						sockets: self.numConns
@@ -132,6 +133,7 @@ module.exports = class HTTP {
 					self.logError(err.code || 'socket', "Socket error: " + id + ": " + msg, {
 						ip: ip,
 						ips: args.ips,
+						port: port,
 						state: args.state,
 						method: args.request.method,
 						uri: args.request.url,
@@ -156,6 +158,7 @@ module.exports = class HTTP {
 				var now = (new Date()).getTime();
 				self.logDebug(8, "HTTP connection has closed: " + id, {
 					ip: ip,
+					port: port,
 					total_elapsed: now - socket._pixl_data.time_start,
 					num_requests: socket._pixl_data.num_requests,
 					bytes_in: socket._pixl_data.bytes_in,
@@ -167,7 +170,7 @@ module.exports = class HTTP {
 			} );
 		} );
 		
-		this.http.on('clientError', function(err, socket) {
+		listener.on('clientError', function(err, socket) {
 			// https://nodejs.org/api/http.html#http_event_clienterror
 			if (!socket._pixl_data) socket._pixl_data = {};
 			var args = socket._pixl_data.current || { request: {}, id: 'n/a' };
@@ -181,6 +184,7 @@ module.exports = class HTTP {
 				id: args.id,
 				ip: socket.remoteAddress,
 				ips: args.ips,
+				port: port,
 				state: args.state,
 				method: args.request.method,
 				uri: args.request.url,
@@ -208,36 +212,37 @@ module.exports = class HTTP {
 			}
 		});
 		
-		this.http.once('error', function(err) {
+		listener.once('error', function(err) {
 			// fatal startup error on HTTP server, probably EADDRINUSE
-			self.logError('startup', "Failed to start HTTP listener: " + err.message);
+			self.logError('startup', "Failed to start HTTP listener on port: " + port + ": " + err.message);
 			return callback(err);
 		} );
 		
 		var listen_opts = { port: port };
 		if (bind_addr) listen_opts.host = bind_addr;
 		
-		this.http.listen( listen_opts, function(err) {
+		listener.listen( listen_opts, function(err) {
 			if (err) {
-				self.logError('startup', "Failed to start HTTP listener: " + err.message);
+				self.logError('startup', "Failed to start HTTP listener on port: " + port + ": " + err.message);
 				return callback(err);
 			}
-			var info = self.http.address();
+			var info = listener.address();
 			self.logDebug(3, "Now listening for HTTP connections", info);
 			if (!port) {
 				port = info.port;
 				self.config.set('http_port', port);
 				self.logDebug(3, "Actual HTTP listener port chosen: " + port);
 			}
+			self.listeners.push(listener);
 			callback();
 		} );
 		
 		// set idle socket timeout
 		if (this.config.get('http_timeout')) {
-			this.http.setTimeout( this.config.get('http_timeout') * 1000 );
+			listener.setTimeout( this.config.get('http_timeout') * 1000 );
 		}
 		if (this.config.get('http_keep_alive_timeout')) {
-			this.http.keepAliveTimeout = this.config.get('http_keep_alive_timeout') * 1000;
+			listener.keepAliveTimeout = this.config.get('http_keep_alive_timeout') * 1000;
 		}
 	}
 	

package/lib/https.js

@@ -18,10 +18,9 @@ const ACL = require('pixl-acl');
 
 module.exports = class HTTP2 {
 	
-	startHTTPS(callback) {
+	startHTTPS(port, callback) {
 		// start https server
 		var self = this;
-		var port = this.config.get('https_port');
 		var bind_addr = this.config.get('https_bind_address') || this.config.get('http_bind_address') || '';
 		var max_conns = this.config.get('https_max_connections') || this.config.get('http_max_connections') || 0;
 		var socket_prelim_timeout = self.config.get('https_socket_prelim_timeout') || self.config.get('http_socket_prelim_timeout') || 0;
@@ -50,14 +49,14 @@ module.exports = class HTTP2 {
 			// optional chain.pem or the like
 			opts.ca = fs.readFileSync( this.config.get('https_ca_file') );
 		}
-		this.https = require('https').createServer( opts, handler );
+		var listener = require('https').createServer( opts, handler );
 		
-		this.https.on('secureConnection', function(socket) {
+		listener.on('secureConnection', function(socket) {
 			var ip = socket.remoteAddress || '';
 			
 			if (max_conns && (self.numConns >= max_conns)) {
 				// reached maximum concurrent connections, abort new ones
-				self.logError('maxconns', "Maximum concurrent connections reached, denying request from: " + ip, { ip: ip, max: max_conns });
+				self.logError('maxconns', "Maximum concurrent connections reached, denying request from: " + ip, { ip: ip, port: port, max: max_conns });
 				socket.end();
 				socket.unref();
 				socket.destroy(); // hard close
@@ -66,7 +65,7 @@ module.exports = class HTTP2 {
 			}
 			if (self.server.shut) {
 				// server is shutting down, abort new connections
-				self.logError('shutdown', "Server is shutting down, denying connection from: " + ip, { ip: ip });
+				self.logError('shutdown', "Server is shutting down, denying connection from: " + ip, { ip: ip, port: port});
 				socket.end();
 				socket.unref();
 				socket.destroy(); // hard close
@@ -76,7 +75,7 @@ module.exports = class HTTP2 {
 			var id = self.getNextId('cs');
 			self.conns[ id ] = socket;
 			self.numConns++;
-			self.logDebug(8, "New incoming HTTPS (SSL) connection: " + id, { ip: ip, num_conns: self.numConns });
+			self.logDebug(8, "New incoming HTTPS (SSL) connection: " + id, { ip: ip, port: port, num_conns: self.numConns });
 			
 			// Disable the Nagle algorithm.
 			socket.setNoDelay( true );
@@ -84,6 +83,7 @@ module.exports = class HTTP2 {
 			// add our own metadata to socket
 			socket._pixl_data = {
 				id: id,
+				port: port,
 				proto: 'https',
 				port: port,
 				time_start: (new Date()).getTime(),
@@ -99,6 +99,7 @@ module.exports = class HTTP2 {
 					var msg = "Socket preliminary timeout waiting for initial request (" + socket_prelim_timeout + " seconds)";
 					var err_args = {
 						ip: ip,
+						port: port,
 						pending: self.queue.length(),
 						active: self.queue.running(),
 						sockets: self.numConns
@@ -130,6 +131,7 @@ module.exports = class HTTP2 {
 					self.logError(err.code || 'socket', "Socket error: " + id + ": " + msg, {
 						ip: ip,
 						ips: args.ips,
+						port: port,
 						state: args.state,
 						method: args.request.method,
 						uri: args.request.url,
@@ -154,6 +156,7 @@ module.exports = class HTTP2 {
 				var now = (new Date()).getTime();
 				self.logDebug(8, "HTTPS (SSL) connection has closed: " + id, {
 					ip: ip,
+					port: port,
 					total_elapsed: now - socket._pixl_data.time_start,
 					num_requests: socket._pixl_data.num_requests,
 					bytes_in: socket._pixl_data.bytes_in,
@@ -165,7 +168,7 @@ module.exports = class HTTP2 {
 			} );
 		} );
 		
-		this.https.on('clientError', function(err, socket) {
+		listener.on('clientError', function(err, socket) {
 			// https://nodejs.org/api/http.html#http_event_clienterror
 			if (!socket._pixl_data) socket._pixl_data = {};
 			var args = socket._pixl_data.current || { request: {}, id: 'n/a' };
@@ -179,6 +182,7 @@ module.exports = class HTTP2 {
 				id: args.id,
 				ip: socket.remoteAddress,
 				ips: args.ips,
+				port: port,
 				state: args.state,
 				method: args.request.method,
 				uri: args.request.url,
@@ -206,40 +210,41 @@ module.exports = class HTTP2 {
 			}
 		});
 		
-		this.https.once('error', function(err) {
+		listener.once('error', function(err) {
 			// fatal startup error on HTTPS server, probably EADDRINUSE
-			self.logError('startup', "Failed to start HTTPS listener: " + err.message);
+			self.logError('startup', "Failed to start HTTPS listener on port: " + port + ": " + err.message);
 			return callback(err);
 		} );
 		
 		var listen_opts = { port: port };
 		if (bind_addr) listen_opts.host = bind_addr;
 		
-		this.https.listen( listen_opts, function(err) {
+		listener.listen( listen_opts, function(err) {
 			if (err) {
-				self.logError('startup', "Failed to start HTTPS listener: " + err.message);
+				self.logError('startup', "Failed to start HTTPS listener on port: " + port + ": " + err.message);
 				return callback(err);
 			}
-			var info = self.https.address();
+			var info = listener.address();
 			self.logDebug(3, "Now listening for HTTPS connections", info);
 			if (!port) {
 				port = info.port;
 				self.config.set('https_port', port);
 				self.logDebug(3, "Actual HTTPS listener port chosen: " + port);
 			}
+			self.listeners.push(listener);
 			callback();
 		} );
 		
 		// set idle socket timeout
 		var timeout_sec = this.config.get('https_timeout') || this.config.get('http_timeout') || 0;
 		if (timeout_sec) {
-			this.https.setTimeout( timeout_sec * 1000 );
+			listener.setTimeout( timeout_sec * 1000 );
 		}
 		if (this.config.get('https_keep_alive_timeout')) {
-			this.https.keepAliveTimeout = this.config.get('https_keep_alive_timeout') * 1000;
+			listener.keepAliveTimeout = this.config.get('https_keep_alive_timeout') * 1000;
 		}
 		else if (this.config.get('http_keep_alive_timeout')) {
-			this.https.keepAliveTimeout = this.config.get('http_keep_alive_timeout') * 1000;
+			listener.keepAliveTimeout = this.config.get('http_keep_alive_timeout') * 1000;
 		}
 	}
 	

package/lib/response.js

@@ -326,6 +326,8 @@ module.exports = class Response {
 				id: args.id,
 				proto: args.request.headers['ssl'] ? 'https' : socket_data.proto,
 				ips: args.ips,
+				port: socket_data.port,
+				socket: socket_data.id,
 				host: args.request.headers['host'] || '',
 				ua: args.request.headers['user-agent'] || '',
 				perf: metrics

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "pixl-server-web",
-	"version": "1.3.21",
+	"version": "1.3.22",
 	"description": "A web server component for the pixl-server framework.",
 	"author": "Joseph Huckaby <jhuckaby@gmail.com>",
 	"homepage": "https://github.com/jhuckaby/pixl-server-web",

package/test/test.js

@@ -33,6 +33,7 @@ var server = new PixlServer({
 		
 		"WebServer": {
 			"http_port": 3020,
+			"http_alt_ports": [3120],
 			"http_htdocs_dir": __dirname,
 			"http_max_upload_size": 1024 * 10,
 			"http_static_ttl": 3600,
@@ -53,6 +54,7 @@ var server = new PixlServer({
 			
 			"https": 1,
 			"https_port": 3021,
+			"https_alt_ports": [3121],
 			"https_cert_file": "ssl.crt",
 			"https_key_file": "ssl.key",
 			"https_force": 0,
@@ -191,6 +193,33 @@ module.exports = {
 			);
 		},
 		
+		function testHTTPAltPort(test) {
+			// test simple HTTP GET request to webserver backend, alternate port
+			request.json( 'http://127.0.0.1:3120/json', false,
+				{
+					headers: {
+						'X-Test': "Test"
+					}
+				},
+				function(err, resp, json, perf) {
+					test.ok( !err, "No error from PixlRequest: " + err );
+					test.ok( !!resp, "Got resp from PixlRequest" );
+					test.ok( resp.statusCode == 200, "Got 200 response: " + resp.statusCode );
+					test.ok( resp.headers['via'] == "WebServerTest 1.0", "Correct Via header: " + resp.headers['via'] );
+					test.ok( !!json, "Got JSON in response" );
+					test.ok( json.code == 0, "Correct code in JSON response: " + json.code );
+					test.ok( !!json.user, "Found user object in JSON response" );
+					test.ok( json.user.Name == "Joe", "Correct user name in JSON response: " + json.user.Name );
+					
+					// request headers will be echoed back
+					test.ok( !!json.headers, "Found headers echoed in JSON response" );
+					test.ok( json.headers['x-test'] == "Test", "Found Test header echoed in JSON response" );
+					
+					test.done();
+				} 
+			);
+		},
+		
 		function testBadRequest(test) {
 			// test bad HTTP GET request to webserver backend
 			// this still resolves to the root dir index due to the ../
@@ -1576,6 +1605,35 @@ module.exports = {
 			);
 		},
 		
+		function testHTTPSAltPort(test) {
+			// test HTTPS GET request to webserver backend on alt port
+			request.json( 'https://127.0.0.1:3121/json', false,
+				{
+					rejectUnauthorized: false, // self-signed cert
+					headers: {
+						'X-Test': "Test"
+					}
+				},
+				function(err, resp, json, perf) {
+					test.ok( !err, "No error from PixlRequest: " + err );
+					test.ok( !!resp, "Got resp from PixlRequest" );
+					test.ok( resp.statusCode == 200, "Got 200 response: " + resp.statusCode );
+					test.ok( resp.headers['via'] == "WebServerTest 1.0", "Correct Via header: " + resp.headers['via'] );
+					test.ok( !!json, "Got JSON in response" );
+					test.ok( json.code == 0, "Correct code in JSON response: " + json.code );
+					test.ok( !!json.user, "Found user object in JSON response" );
+					test.ok( json.user.Name == "Joe", "Correct user name in JSON response: " + json.user.Name );
+					
+					// request headers will be echoed back
+					test.ok( !!json.headers, "Found headers echoed in JSON response" );
+					test.ok( json.headers['x-test'] == "Test", "Found Test header echoed in JSON response" );
+					test.ok( !!json.headers.ssl, "SSL pseudo-header present in echo" );
+					
+					test.done();
+				} 
+			);
+		},
+		
 		function testHTTPSPost(test) {
 			request.post( 'https://127.0.0.1:3021/json',
 				{

package/web_server.js

@@ -91,6 +91,7 @@ class WebServer extends Component {
 		this.logDebug(2, "pixl-server-web v" + this.version + " starting up");
 		
 		// setup connections and handlers
+		this.listeners = [];
 		this.conns = {};
 		this.requests = {};
 		this.uriFilters = [];
@@ -194,16 +195,41 @@ class WebServer extends Component {
 		// listen for tick events to swap stat buffers
 		this.server.on( 'tick', this.tick.bind(this) );
 		
-		// start listeners
-		this.startHTTP( function(err) {
-			if (err) return callback(err);
-			
-			// also start HTTPS listener?
-			if (self.config.get('https')) {
-				self.startHTTPS( callback );
-			}
-			else callback(err);
+		this.startAll(callback);
+	}
+	
+	startAll(callback) {
+		// start all HTTP(s) listeners
+		var self = this;
+		var tasks = [];
+		
+		// always start plain HTTP on base port
+		tasks.push([ this.config.get('http_port'), 'startHTTP' ]);
+		
+		// optional additional ports
+		(this.config.get('http_alt_ports') || []).forEach( function(port) {
+			tasks.push([ port, 'startHTTP' ]);
 		} );
+		
+		// optional HTTPS
+		if (this.config.get('https')) {
+			tasks.push([ this.config.get('https_port'), 'startHTTPS' ]);
+			
+			// optional additional ports
+			(this.config.get('https_alt_ports') || []).forEach( function(port) {
+				tasks.push([ port, 'startHTTPS' ]);
+			} );
+		}
+		
+		// start all listeners in parallel
+		async.each( tasks,
+			function(task, callback) {
+				var port = task[0];
+				var func = task[1];
+				self[func](port, callback);
+			},
+			callback
+		);
 	}
 	
 	dumpAllRequests(callback) {
@@ -263,12 +289,13 @@ class WebServer extends Component {
 	getStats() {
 		// get current stats, merged with live socket and request info
 		var socket_info = {};
-		var listener_info = {};
+		var listener_info = [];
 		var now = (new Date()).getTime();
 		var num_sockets = 0;
 		
-		if (this.http) listener_info.http = this.http.address();
-		if (this.https) listener_info.https = this.https.address();
+		listener_info = this.listeners.map( function(listener) {
+			return listener.address();
+		} );
 		
 		for (var key in this.conns) {
 			var socket = this.conns[key];
@@ -432,7 +459,7 @@ class WebServer extends Component {
 		// shutdown http server
 		var self = this;
 		
-		if (this.http) {
+		if (this.listeners.length) {
 			this.logDebug(2, "Shutting down HTTP server");
 			
 			for (var id in this.requests) {
@@ -461,12 +488,11 @@ class WebServer extends Component {
 				this.numConns--;
 			} // foreach conn
 			
-			this.http.close( function() { self.logDebug(3, "HTTP server has shut down."); } );
-			
-			if (this.https) {
-				this.https.close( function() { self.logDebug(3, "HTTPS server has shut down."); } );
-			}
-			// delete this.http;
+			// close all listeners
+			this.listeners.forEach( function(listener) {
+				var info = listener.address() || { port: 'n/a' };
+				listener.close( function() { self.logDebug(3, "HTTP server on port " + info.port + " has shut down.", info); } );
+			} );
 			
 			this.requests = {};
 			this.queue.kill();