pixl-server-web 1.3.20 → 1.3.21

package/README.md

@@ -518,6 +518,26 @@ When this boolean is set to `true`, [Custom URI Handlers](#custom-uri-handlers)
 }
 ```
 
+## http_flatten_query
+
+By default, we use the Node.js core [Query String](https://nodejs.org/api/querystring.html) module to parse query strings.  This module handles duplicate query params by converting them to arrays.  For example, an incoming URI such as `/something?foo=bar1&foo=bar2&name=joe` would produce the following `args.query` object:
+
+```js
+{
+	"foo": ["bar1", "bar2"],
+	"name": "joe"
+}
+```
+
+However, if you set `http_flatten_query` to `true` in your configuration, the web server will "flatten" query string parameters, so that duplicate keys will be combined into one, with the latter prevailing.  Example:
+
+```js
+{
+	"foo": "bar2",
+	"name": "joe"
+}
+```
+
 ## http_req_max_dump_enabled
 
 When this boolean is set to `true`, the [Request Max Dump](#request-max-dump) system is enabled.  This will produce a JSON dump file when the web server is maxed out on requests.
@@ -876,6 +896,8 @@ Duplicate query params become an array.  For example, an incoming URI such as `/
 }
 ```
 
+See [http_flatten_query](#http_flatten_query) if you would rather the query string be flattened.
+
 ### args.params
 
 If the request was a HTTP POST, this will contain all the post parameters as key/value pairs.  This will take one of three forms, depending on the request's `Content-Type` header:

package/lib/request.js

@@ -175,6 +175,13 @@ module.exports = class Request {
 			query = Querystring.parse( RegExp.$1 );
 		}
 		
+		// optionally flatten query (latter prevails)
+		if (this.config.get('http_flatten_query')) {
+			for (var key in query) {
+				if (typeof(query[key]) == 'object') query[key] = query[key].pop();
+			}
+		}
+		
 		// determine how to process request body
 		var params = {};
 		var files = {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "pixl-server-web",
-	"version": "1.3.20",
+	"version": "1.3.21",
 	"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

@@ -208,7 +208,7 @@ module.exports = {
 		// query string
 		function testQueryString(test) {
 			// test simple HTTP GET request with query string
-			request.json( 'http://127.0.0.1:3020/json?foo=bar1234&baz=bop%20pog', false,
+			request.json( 'http://127.0.0.1:3020/json?foo=bar1234&baz=bop%20pog&animal=frog&animal=dog', false,
 				{
 					headers: {
 						'X-Test': "Test"
@@ -228,6 +228,12 @@ module.exports = {
 					test.ok( json.query.foo == "bar1234", "Query contains correct foo key" );
 					test.ok( json.query.baz == "bop pog", "Query contains correct baz key (URL encoding)" );
 					
+					// dupes should become array by default
+					test.ok( typeof(json.query.animal) == 'object', "Query param animal is an object" );
+					test.ok( json.query.animal.length == 2, "Query param animal has length 2" );
+					test.ok( json.query.animal[0] === 'frog', "First animal is frog" );
+					test.ok( json.query.animal[1] === 'dog', "Second animal is dog" );
+					
 					// 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" );
@@ -237,6 +243,46 @@ module.exports = {
 			);
 		},
 		
+		function testQueryStringFlatten(test) {
+			// test simple HTTP GET request with query string dupes flattened
+			var web = this.web_server;
+			web.config.set('http_flatten_query', true);
+			
+			request.json( 'http://127.0.0.1:3020/json?foo=bar1234&baz=bop%20pog&animal=frog&animal=dog', 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 );
+					
+					test.ok( !!json.query, "Found query object in JSON response" );
+					test.ok( json.query.foo == "bar1234", "Query contains correct foo key" );
+					test.ok( json.query.baz == "bop pog", "Query contains correct baz key (URL encoding)" );
+					
+					test.ok( typeof(json.query.animal) == 'string', "Query param animal is a string" );
+					test.ok( json.query.animal === 'dog', "Animal is dog" );
+					
+					// 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" );
+					
+					// revert our hot config change
+					web.config.set('http_flatten_query', false);
+					
+					test.done();
+				} 
+			);
+		},
+		
 		// Cookies in request
 		function testCookieRequest(test) {
 			// test simple HTTP GET request with cookies

package/web_server.js

@@ -60,6 +60,7 @@ module.exports = Class({
 		"http_clean_headers": false,
 		"http_log_socket_errors": true,
 		"http_full_uri_match": false,
+		"http_flatten_query": false,
 		"http_request_timeout": 0,
 		"http_req_max_dump_enabled": false,
 		"http_req_max_dump_dir": "",