fix: remove qs.parse response transformation

Author: dvinakur

examples/http2/http2.js

@@ -22,10 +22,7 @@ srv.on(
     restify.plugins.auditLogger({
         event: 'after',
         body: true,
-        log: pino(
-            { name: 'audit' },
-            process.stdout
-        )
+        log: pino({ name: 'audit' }, process.stdout)
     })
 );
 

lib/plugins/formBodyParser.js

@@ -7,7 +7,6 @@ var querystring = require('qs');
 
 var bodyReader = require('./bodyReader');
 var errors = require('restify-errors');
-var utils = require('../utils');
 
 ///--- Globals
 
@@ -43,7 +42,7 @@ function urlEncodedBodyParser(options) {
         }
 
         try {
-            var params = utils.normalizeArrays(querystring.parse(req.body));
+            var params = querystring.parse(req.body);
 
             if (opts.mapParams === true) {
                 var keys = Object.keys(params);

lib/plugins/jsonp.js

@@ -4,8 +4,6 @@
 
 var qs = require('qs');
 
-var utils = require('../utils');
-
 ///--- API
 
 /**
@@ -30,7 +28,7 @@ function jsonp() {
 
         // If the query plugin wasn't used, we need to hack it in now
         if (typeof q === 'string') {
-            req.query = utils.normalizeArrays(qs.parse(q));
+            req.query = qs.parse(q);
         }
 
         if (req.query.callback || req.query.jsonp) {

lib/plugins/query.js

@@ -5,8 +5,6 @@
 var qs = require('qs');
 var assert = require('assert-plus');
 
-var normalizeArrays = require('../utils').normalizeArrays;
-
 /**
  * Parses the HTTP query string (i.e., `/foo?id=bar&name=mark`).
  * If you use this, the parsed content will always be available in `req.query`,
@@ -55,20 +53,7 @@ function queryParser(options) {
             return next();
         }
 
-        var parsed = qs.parse(req.getQuery(), opts);
-
-        // Skip normalization when the caller explicitly opted out of array
-        // parsing, set a custom arrayLimit (respect their cap), or requested
-        // plainObjects (normalizeArrays would strip the null prototype).
-        if (
-            opts.parseArrays !== false &&
-            opts.arrayLimit === undefined &&
-            !opts.plainObjects
-        ) {
-            parsed = normalizeArrays(parsed);
-        }
-
-        req.query = parsed;
+        req.query = qs.parse(req.getQuery(), opts);
 
         if (opts.mapParams === true) {
             Object.keys(req.query).forEach(function forEach(k) {

lib/utils.js

@@ -171,38 +171,10 @@ function parseRequestUrl(rawUrl) {
 
 ///--- Exports
 
-// qs >= 6.14.1 enforces arrayLimit on bracket notation too. When the limit is
-// exceeded it returns an object with numeric string keys instead of an array.
-// Convert those objects back to arrays so callers always get an array.
-function normalizeArrays(val) {
-    if (!val || typeof val !== 'object' || Array.isArray(val)) {
-        return val;
-    }
-    var keys = Object.keys(val);
-    var isNumericSequence =
-        keys.length > 0 &&
-        keys.every((k, i) => {
-            return k === String(i);
-        });
-
-    if (isNumericSequence) {
-        return keys.map(k => {
-            return normalizeArrays(val[k]);
-        });
-    }
-
-    var result = {};
-    keys.forEach(k => {
-        result[k] = normalizeArrays(val[k]);
-    });
-    return result;
-}
-
 module.exports = {
     shallowCopy: shallowCopy,
     mergeQs: mergeQs,
     parseUrlQuery: parseUrlQuery,
     formatUrl: formatUrl,
-    parseRequestUrl: parseRequestUrl,
-    normalizeArrays: normalizeArrays
+    parseRequestUrl: parseRequestUrl
 };

test/plugins/formBodyParser.test.js

@@ -243,13 +243,14 @@ describe('form body parser', function() {
         client.end();
     });
 
-    it('should parse indexed array with > 20 items', function(done) {
+    it('should return object with 25 keys', function(done) {
         SERVER.use(restify.plugins.bodyParser());
 
         SERVER.post('/bodyurl2/:id', function(req, res, next) {
-            assert.isArray(req.body.items, 'items should be an array');
+            assert.isNotArray(req.body.items);
+            assert.isObject(req.body.items);
             assert.equal(
-                req.body.items.length,
+                Object.keys(req.body.items).length,
                 25,
                 'all 25 items should be present'
             );
@@ -278,15 +279,16 @@ describe('form body parser', function() {
         client.end();
     });
 
-    it('should parse array with more than 20 items', function(done) {
+    it('should return object with 23 keys', function(done) {
         SERVER.use(restify.plugins.bodyParser());
 
         SERVER.post('/bodyurl2/:id', function(req, res, next) {
-            assert.isArray(req.body.items, 'items should be an array');
+            assert.isNotArray(req.body.items);
+            assert.isObject(req.body.items);
             assert.equal(
-                req.body.items.length,
-                25,
-                'all 25 items should be present'
+                Object.keys(req.body.items).length,
+                23,
+                'all 23 items should be present'
             );
             res.send();
             next();
@@ -302,7 +304,7 @@ describe('form body parser', function() {
                 'Content-Type': 'application/x-www-form-urlencoded'
             }
         };
-        var items = Array.from({ length: 25 }, function(_, i) {
+        var items = Array.from({ length: 23 }, function(_, i) {
             return 'items[]=value' + i;
         });
         var client = http.request(opts, function(res) {

test/plugins/jsonp.test.js

@@ -35,48 +35,6 @@ describe('jsonp plugin', function() {
         SERVER.close(done);
     });
 
-    it('should return array for bracket notation', function(done) {
-        SERVER.use(restify.plugins.jsonp());
-
-        SERVER.get('/jsonp/array', function(req, res, next) {
-            assert.isArray(req.query.items);
-            assert.equal(req.query.items.length, 25);
-            res.send();
-            next();
-        });
-
-        var items = [];
-        for (var i = 0; i < 25; i++) {
-            items.push('items[]=' + i);
-        }
-        CLIENT.get('/jsonp/array?' + items.join('&'), function(err, _, res) {
-            assert.ifError(err);
-            assert.equal(res.statusCode, 200);
-            done();
-        });
-    });
-
-    it('should return array for indexed notation', function(done) {
-        SERVER.use(restify.plugins.jsonp());
-
-        SERVER.get('/jsonp/array', function(req, res, next) {
-            assert.isArray(req.query.items);
-            assert.equal(req.query.items.length, 25);
-            res.send();
-            next();
-        });
-
-        var items = [];
-        for (var i = 0; i < 25; i++) {
-            items.push('items[' + i + ']=' + i);
-        }
-        CLIENT.get('/jsonp/array?' + items.join('&'), function(err, _, res) {
-            assert.ifError(err);
-            assert.equal(res.statusCode, 200);
-            done();
-        });
-    });
-
     it('should set content-type', function(done) {
         SERVER.use(restify.plugins.jsonp());
 

test/plugins/query.test.js

@@ -300,12 +300,13 @@ describe('query parser', function() {
         });
     });
 
-    it('should return array for [] with < 20 items', function(done) {
+    it('should return object with 25 keys', function(done) {
         SERVER.use(restify.plugins.queryParser());
 
         SERVER.get('/query/indexed-over', function(req, res, next) {
-            assert.isArray(req.query.items);
-            assert.equal(req.query.items.length, 25);
+            assert.isNotArray(req.query.items);
+            assert.isObject(req.query.items);
+            assert.equal(Object.keys(req.query.items).length, 25);
             res.send();
             next();
         });
@@ -325,18 +326,19 @@ describe('query parser', function() {
         });
     });
 
-    it('should return array for [] with > 20 items', function(done) {
+    it('should return object with 23 keys', function(done) {
         SERVER.use(restify.plugins.queryParser());
 
         SERVER.get('/query/array', function(req, res, next) {
-            assert.isArray(req.query.items);
-            assert.equal(req.query.items.length, 25);
+            assert.isNotArray(req.query.items);
+            assert.isObject(req.query.items);
+            assert.equal(Object.keys(req.query.items).length, 23);
             res.send();
             next();
         });
 
         var items = [];
-        for (var i = 0; i < 25; i++) {
+        for (var i = 0; i < 23; i++) {
             items.push('items[]=' + i);
         }
         CLIENT.get('/query/array?' + items.join('&'), function(err, _, res) {

test/utils.test.js

@@ -5,7 +5,6 @@ var mergeQs = require('../lib/utils').mergeQs;
 var parseRequestUrl = require('../lib/utils').parseRequestUrl;
 var parseUrlQuery = require('../lib/utils').parseUrlQuery;
 var formatUrl = require('../lib/utils').formatUrl;
-var normalizeArrays = require('../lib/utils').normalizeArrays;
 
 if (require.cache[__dirname + '/lib/helper.js']) {
     delete require.cache[__dirname + '/lib/helper.js'];
@@ -168,28 +167,6 @@ test(module, 'formatUrl: array query values become repeated params', function(
     t.done();
 });
 
-// normalizeArrays
-
-test(module, 'normalizeArrays', function(t) {
-    var obj25 = {};
-    for (var i = 0; i < 25; i++) {
-        obj25[String(i)] = 'v' + i;
-    }
-    var result1 = normalizeArrays({ items: obj25 });
-    t.ok(Array.isArray(result1.items), 'items should be an array');
-    t.equal(result1.items.length, 25, 'all 25 items present');
-
-    var result2 = normalizeArrays(obj25);
-    t.ok(Array.isArray(result2), 'result should be an array');
-    t.equal(result2.items.length, 25, 'all 25 items present');
-
-    // passthrough: real arrays and plain objects are unchanged
-    t.deepEqual(normalizeArrays({ a: [1, 2, 3] }), { a: [1, 2, 3] });
-    t.deepEqual(normalizeArrays({ name: 'alex' }), { name: 'alex' });
-
-    t.done();
-});
-
 // mergeQs
 
 test(module, 'merge qs', function(t) {