Partial implementation of qs options. For hapijs#2623, hapijs#2622

hueniverse · hueniverse · commit 7410b137259d · 2015-06-28T22:24:28.000-07:00
diff --git a/API.md b/API.md
@@ -1,4 +1,4 @@
-# 8.5.x API Reference
+# 8.8.x API Reference
 
 - [Server](#server)
     - [`new Server([options])`](#new-serveroptions)
@@ -148,6 +148,10 @@ Creates a new `Server` object where:
            which is used to store configuration values and `connection.plugins` which is meant for
            storing run-time state.
 
+        - `query` - incoming request query component parsing options:
+            - `qs` - optional URI parsing [options](https://www.npmjs.com/package/qs#parsing-objects).
+              Defaults to the **qs** module parsing defaults.
+
         - <a name="connection.config.router"></a>`router` - controls how incoming request URIs are
           matched against the routing table:
             - `isCaseSensitive` - determines whether the paths '/example' and '/EXAMPLE' are
@@ -2730,7 +2734,8 @@ Changes the request URI before the router begins processing the request where:
  - `url` - the new request path value.
  - `stripTrailingSlash` - if `true`, strip the trailing slash from the path. Defaults to `false`.
  - `parserOptions` - optional URI parsing [options](https://www.npmjs.com/package/qs#parsing-objects).
-   Defaults to the **qs** module parsing defaults.
+   Defaults to the route connection `query.qs` settings if present, otherwise the **qs** module
+   parsing defaults.
 
 ```js
 var Hapi = require('hapi');
diff --git a/lib/connection.js b/lib/connection.js
@@ -54,6 +54,8 @@ exports = module.exports = internals.Connection = function (server, options) {
     Hoek.assert(this.settings.autoListen || !this.settings.port, 'Cannot specify port when autoListen is false');
     Hoek.assert(this.settings.autoListen || !this.settings.address, 'Cannot specify address when autoListen is false');
 
+    this.settings.query = this.settings.query || {};
+
     // Connection facilities
 
     this._started = false;
diff --git a/lib/request.js b/lib/request.js
@@ -206,9 +206,9 @@ Hoek.inherits(internals.Request, Events.EventEmitter);
 internals.Request.prototype._setUrl = function (url, stripTrailingSlash, parserOptions) {
 
     this.url = Url.parse(url, false);
-    this.url.query = Qs.parse(this.url.query, parserOptions);     // Override parsed value
+    this.url.query = Qs.parse(this.url.query, this.connection.settings.query.qs || parserOptions);      // Override parsed value
     this.query = this.url.query;
-    this.path = this.url.pathname || '';                // pathname excludes query
+    this.path = this.url.pathname || '';                                                            // pathname excludes query
 
     if (stripTrailingSlash &&
         this.path.length > 1 &&
diff --git a/lib/schema.js b/lib/schema.js
@@ -95,7 +95,8 @@ internals.routeBase = Joi.object({
         maxBytes: Joi.number(),
         uploads: Joi.string(),
         failAction: Joi.string().valid('error', 'log', 'ignore'),
-        timeout: Joi.number().integer().positive().allow(false)
+        timeout: Joi.number().integer().positive().allow(false),
+        qs: Joi.object()
     }),
     plugins: Joi.object(),
     response: Joi.object({
@@ -156,6 +157,9 @@ internals.connectionBase = Joi.object({
     app: Joi.object().allow(null),
     load: Joi.object(),
     plugins: Joi.object(),
+    query: Joi.object({
+        qs: Joi.object()
+    }),
     router: Joi.object({
         isCaseSensitive: Joi.boolean(),
         stripTrailingSlash: Joi.boolean()
diff --git a/npm-shrinkwrap.json b/npm-shrinkwrap.json
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "hapi",
   "description": "HTTP Server framework",
   "homepage": "http://hapijs.com",
-  "version": "8.7.0",
+  "version": "8.8.0",
   "repository": {
     "type": "git",
     "url": "git://github.com/hapijs/hapi"
@@ -35,7 +35,7 @@
     "kilt": "^1.1.x",
     "mimos": "2.x.x",
     "peekaboo": "1.x.x",
-    "qs": "2.x.x",
+    "qs": "3.x.x",
     "shot": "1.x.x",
     "statehood": "2.x.x",
     "subtext": "1.x.x",
diff --git a/test/request.js b/test/request.js
@@ -836,6 +836,35 @@ describe('Request', function () {
                 done();
             });
         });
+
+        it('overrides qs settings', function (done) {
+
+            var server = new Hapi.Server();
+            server.connection({
+                query: {
+                    qs: {
+                        parseArrays: false
+                    }
+                }
+            });
+
+            server.route({
+                method: 'GET',
+                path: '/',
+                config: {
+                    handler: function (request, reply) {
+
+                        return reply(request.query);
+                    }
+                }
+            });
+
+            server.inject('/?a[0]=b&a[1]=c', function (res) {
+
+                expect(res.result).to.equal({ a: { 0: 'b', 1: 'c' } });
+                done();
+            });
+        });
     });
 
     describe('log()', { parallel: false }, function () {
diff --git a/test/route.js b/test/route.js
@@ -371,4 +371,31 @@ describe('Route', function () {
         }).to.not.throw();
         done();
     });
+
+    it('overrides qs settings', function (done) {
+
+        var server = new Hapi.Server();
+        server.connection();
+        server.route({
+            method: 'POST',
+            path: '/',
+            config: {
+                payload: {
+                    qs: {
+                        parseArrays: false
+                    }
+                },
+                handler: function (request, reply) {
+
+                    return reply(request.payload);
+                }
+            }
+        });
+
+        server.inject({ method: 'POST', url: '/', payload: 'a[0]=b&a[1]=c', headers: { 'content-type': 'application/x-www-form-urlencoded' } }, function (res) {
+
+            expect(res.result).to.deep.equal({ a: { 0: 'b', 1: 'c' } });
+            done();
+        });
+    });
 });
