pixl-server-web 1.3.26 → 1.3.27

package/README.md

@@ -35,6 +35,8 @@ This module is a component for use in [pixl-server](https://www.github.com/jhuck
 	* [http_brotli_opts](#http_brotli_opts)
 	* [http_default_acl](#http_default_acl)
 	* [http_log_requests](#http_log_requests)
+	* [http_log_request_details](#http_log_request_details)
+	* [http_log_body_max](#http_log_body_max)
 	* [http_regex_log](#http_regex_log)
 	* [http_log_perf](#http_log_perf)
 	* [http_perf_threshold_ms](#http_perf_threshold_ms)
@@ -88,6 +90,7 @@ This module is a component for use in [pixl-server](https://www.github.com/jhuck
 		+ [args.id](#argsid)
 	* [Request Filters](#request-filters)
 - [Transaction Logging](#transaction-logging)
+	* [Request Detail Logging](#request-detail-logging)
 	* [Performance Threshold Logging](#performance-threshold-logging)
 		+ [Including Diagnostic Reports](#including-diagnostic-reports)
 	* [Including Custom Metrics](#including-custom-metrics)
@@ -426,6 +429,14 @@ This boolean allows you to enable transaction logging in the web server.  It def
 
 This boolean adds verbose detail in the transaction log.  It defaults to `false` (disabled).  See [Transaction Logging](#transaction-logging) below for details.
 
+**Note:** This property only has effect if [http_log_requests](#http_log_requests) is enabled.
+
+## http_log_body_max
+
+This property sets the maximum allowed request and response body length that can be logged, when [http_log_request_details](#http_log_request_details) is enabled.  If the request or response body length exceeds this amount, they will not be included in the transaction log.
+
+**Note:** This property only has effect if [http_log_request_details](#http_log_request_details) is enabled.
+
 ## http_regex_log
 
 If [http_log_requests](#http_log_requests) is enabled, this allows you to specify a regular expression to match against incoming request URIs.  Only requests that match will be logged.  It defaults to match all URIs (`.+`).  See [Transaction Logging](#transaction-logging) below for details.
@@ -1172,7 +1183,6 @@ If you set both the [http_log_requests](#http_log_requests) and [http_log_reques
 			"content-type": "application/json",
 			"x-joetest": "9876",
 			"server": "Test Server 1.0",
-			"x-200": "YUP BRO",
 			"content-length": "261",
 			"content-encoding": "gzip"
 		},

package/lib/response.js

@@ -346,35 +346,40 @@ module.exports = class Response {
 				data.query = args.query || {};
 				data.params = Object.assign( {}, args.params || {} );
 				
+				// special handling for raw request body
 				if (data.params.raw && data.params.raw.buffer && data.params.raw.toString) {
-					if (args.request.headers['content-type'] && args.request.headers['content-type'].match(/(text|javascript|json|xml)/)) {
+					if (args.request.headers['content-type'] && args.request.headers['content-type'].match(/(text|javascript|json|xml)/) && (data.params.raw.length <= this.logRequestBodyMax)) {
 						data.params.raw = data.params.raw.toString('utf8');
 					}
-					else data.params.raw = '(Binary Buffer)';
+					else data.params.raw = '(Buffer)';
 				}
 				
+				// include details on response as well
 				data.response = {
 					code: args.http_code,
 					status: args.http_status,
 					headers: {}
 				};
 				
+				// convert header keys to lower-case
 				if (args.resp_headers) {
 					for (var key in args.resp_headers) {
 						data.response.headers[ key.toLowerCase() ] = args.resp_headers[key];
 					}
 				}
 				
+				// special handling for stream and buffer responses
 				if (args.resp_body && args.resp_body.pipe) {
 					data.response.raw = '(Stream)';
 				}
 				else if (args.resp_body && args.resp_body.buffer && args.resp_body.toString) {
-					if (data.response.headers && data.response.headers['content-type'] && data.response.headers['content-type'].match(/(text|javascript|json|xml)/)) {
+					if (data.response.headers && data.response.headers['content-type'] && data.response.headers['content-type'].match(/(text|javascript|json|xml)/) && (args.resp_body.length <= this.logRequestBodyMax)) {
 						data.response.raw = args.resp_body.toString('utf8');
 					}
-					else data.response.raw = '(Binary Buffer)';
+					else data.response.raw = '(Buffer)';
 				}
 				
+				// cleanup
 				delete args.resp_body;
 				delete args.resp_headers;
 			}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "pixl-server-web",
-	"version": "1.3.26",
+	"version": "1.3.27",
 	"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/web_server.js

@@ -48,6 +48,7 @@ module.exports = Class({
 		"http_default_acl": ['127.0.0.1', '10.0.0.0/8', '172.16.0.0/12', '192.168.0.0/16', '::1/128', 'fd00::/8', '169.254.0.0/16', 'fe80::/10'],
 		"http_log_requests": false,
 		"http_log_request_details": false,
+		"http_log_body_max": 32768,
 		"http_log_perf": false,
 		"http_perf_threshold_ms": 100,
 		"http_perf_report": false,
@@ -104,6 +105,7 @@ class WebServer extends Component {
 		this.regexJSONContent = new RegExp( this.config.get('http_regex_json'), "i" );
 		this.logRequests = this.config.get('http_log_requests');
 		this.logRequestDetails = this.config.get('http_log_request_details');
+		this.logRequestBodyMax = this.config.get('http_log_body_max');
 		this.regexLogRequests = this.logRequests ? (new RegExp( this.config.get('http_regex_log') || '.+' )) : null;
 		this.logPerfEnabled = this.config.get('http_log_perf');
 		this.logPerfThreshold = this.config.get('http_perf_threshold_ms');