fix: better handling of nested arrays when options.multiples (#621)

Author: isaakengineer

CHANGELOG.md

@@ -25,6 +25,8 @@
  * fix: exposing file writable stream errors ([#520](https://github.com/node-formidable/node-formidable/pull/520), [#316](https://github.com/node-formidable/node-formidable/pull/316), [#469](https://github.com/node-formidable/node-formidable/pull/469), [#470](https://github.com/node-formidable/node-formidable/pull/470))
  * feat: custom file (re)naming, thru options.filename ([#591](https://github.com/node-formidable/node-formidable/pull/591), [#84](https://github.com/node-formidable/node-formidable/issues/84), [#86](https://github.com/node-formidable/node-formidable/issues/86), [#94](https://github.com/node-formidable/node-formidable/issues/94), [#154](https://github.com/node-formidable/node-formidable/issues/154), [#158](https://github.com/node-formidable/node-formidable/issues/158), [#488](https://github.com/node-formidable/node-formidable/issues/488), [#595](https://github.com/node-formidable/node-formidable/issues/595))
  * fix: make opts.filename from #591 work with opts.keepExtensions ([#597](https://github.com/node-formidable/node-formidable/pull/597))
+ * fix: better handling of nested arrays when options.multiples ([#621](https://github.com/node-formidable/node-formidable/pull/621))
+ 
 ### v1.2.1 (2018-03-20)
 
  * `maxFileSize` option with default of 200MB (Charlike Mike Reagent, Nima Shahri)

package.json

@@ -33,7 +33,8 @@
   "dependencies": {
     "dezalgo": "1.0.3",
     "hexoid": "1.0.0",
-    "once": "1.4.0"
+    "once": "1.4.0",
+    "qs": "^6.9.3"
   },
   "devDependencies": {
     "@commitlint/cli": "8.3.5",

src/Formidable.js

@@ -11,6 +11,7 @@ const once = require('once');
 const dezalgo = require('dezalgo');
 const { EventEmitter } = require('events');
 const { StringDecoder } = require('string_decoder');
+const qs = require('qs');
 
 const toHexoId = hexoid(25);
 const DEFAULT_OPTIONS = {
@@ -133,20 +134,13 @@ class IncomingForm extends EventEmitter {
     if (cb) {
       const callback = once(dezalgo(cb));
       const fields = {};
+      let mockFields = '';
       const files = {};
-
+      
       this.on('field', (name, value) => {
-        // TODO: too much nesting
-        if (this.options.multiples && name.slice(-2) === '[]') {
-          const realName = name.slice(0, name.length - 2);
-          if (hasOwnProp(fields, realName)) {
-            if (!Array.isArray(fields[realName])) {
-              fields[realName] = [fields[realName]];
-            }
-          } else {
-            fields[realName] = [];
-          }
-          fields[realName].push(value);
+        if (this.options.multiples) {
+          let mObj = { [name] : value };
+          mockFields = mockFields + '&' + qs.stringify(mObj);
         } else {
           fields[name] = value;
         }
@@ -170,6 +164,9 @@ class IncomingForm extends EventEmitter {
         callback(err, fields, files);
       });
       this.on('end', () => {
+        if (this.options.multiples) {
+          Object.assign(fields, qs.parse(mockFields));
+        }
         callback(null, fields, files);
       });
     }

test/unit/formidable.test.js

@@ -104,11 +104,58 @@ function makeHeader(filename) {
     req.headers = 'content-type: json; content-length:8';
     form.parse(req, (error, fields) => {
       expect(Array.isArray(fields.a)).toBe(true);
-      expect(fields.a[0]).toBe(1);
-      expect(fields.a[1]).toBe(2);
+      expect(fields.a[0]).toBe('1');
+      expect(fields.a[1]).toBe('2');
     });
-    form.emit('field', 'a[]', 1);
-    form.emit('field', 'a[]', 2);
+    form.emit('field', 'a[]', '1');
+    form.emit('field', 'a[]', '2');
+    form.emit('end');
+  });
+
+  test(`${name}#_Nested array parameters support`, () => {
+    const form = getForm(name, { multiples: true });
+
+    const req = new Request();
+    req.headers = 'content-type: json; content-length:8';
+    form.parse(req, (error, fields) => {
+      expect(Array.isArray(fields.a)).toBe(true);
+      expect(fields.a[0][0]).toBe('a');
+      expect(fields.a[0][1]).toBe('b');
+      expect(fields.a[1][0]).toBe('c');
+    });
+    form.emit('field', 'a[0][]', 'a');
+    form.emit('field', 'a[0][]', 'b');
+    form.emit('field', 'a[1][]', 'c');
+    form.emit('end');
+  });
+
+  test(`${name}#_Object parameters support`, () => {
+    const form = getForm(name, { multiples: true });
+
+    const req = new Request();
+    req.headers = 'content-type: json; content-length:8';
+    form.parse(req, (error, fields) => {
+      expect(fields.a.x).toBe('1');
+      expect(fields.a.y).toBe('2');
+    });
+    form.emit('field', 'a[x]', '1');
+    form.emit('field', 'a[y]', '2');
+    form.emit('end');
+  });
+
+  test(`${name}#_Nested object parameters support`, () => {
+    const form = getForm(name, { multiples: true });
+
+    const req = new Request();
+    req.headers = 'content-type: json; content-length:8';
+    form.parse(req, (error, fields) => {
+      expect(fields.a.l1.k1).toBe('2');
+      expect(fields.a.l1.k2).toBe('3');
+      expect(fields.a.l2.k3).toBe('5');
+    });
+    form.emit('field', 'a[l1][k1]', '2');
+    form.emit('field', 'a[l1][k2]', '3');
+    form.emit('field', 'a[l2][k3]', '5');
     form.emit('end');
   });
 

yarn.lock

@@ -4810,7 +4810,7 @@ qs@6.7.0:
   resolved "https://registry.yarnpkg.com/qs/-/qs-6.7.0.tgz#41dc1a015e3d581f1621776be31afb2876a9b1bc"
   integrity sha512-VCdBRNFTX1fyE7Nb6FYoURo/SPe62QCaAyzJvUjwRaIsc+NePBEniHlvxFmmX56+HZphIGtV0XeCirBtpDrTyQ==
 
-qs@^6.5.1:
+qs@^6.5.1, qs@^6.9.3:
   version "6.9.3"
   resolved "https://registry.yarnpkg.com/qs/-/qs-6.9.3.tgz#bfadcd296c2d549f1dffa560619132c977f5008e"
   integrity sha512-EbZYNarm6138UKKq46tdx08Yo/q9ZhFoAXAI1meAFd2GtbRDhbZY2WQSICskT0c5q99aFzLG1D4nvTk9tqfXIw==