fix: coding against native FormData and form-data

erunion · erunion · commit ce5f27706895 · 2020-08-05T16:08:55.000-07:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -81,7 +81,8 @@
     "chalk": "^1.1.1",
     "commander": "^2.9.0",
     "debug": "^2.2.0",
-    "formdata-polyfill": "^3.0.20",
+    "event-stream": "^4.0.1",
+    "form-data": "^3.0.0",
     "fs-readfile-promise": "^2.0.1",
     "fs-writefile-promise": "^1.0.3",
     "har-validator": "^5.0.0",
diff --git a/src/index.js b/src/index.js
@@ -2,9 +2,9 @@
 
 'use strict'
 
-require('formdata-polyfill')
-
 var debug = require('debug')('httpsnippet')
+var es = require('event-stream')
+var MultiPartForm = require('form-data')
 var qs = require('querystring')
 var reducer = require('./helpers/reducer')
 var targets = require('./targets')
@@ -106,21 +106,49 @@ HTTPSnippet.prototype.prepare = function (request) {
       request.postData.mimeType = 'multipart/form-data'
 
       if (request.postData.params) {
-        var form = new FormData()
+        var form = new MultiPartForm()
+
+        // The `form-data` module returns one of two things: a native FormData object, or its own polyfill. Since this
+        // polyfill support the full API of the native FormData object, when this library is running in a browser
+        // environment it'll fail on two things:
+        //
+        //  - The API for `form.append()` has three arguments and the third should only be present when the second is a
+        //    Blob or USVString.
+        //  - `FormData.pipe()` isn't a function.
+        //
+        // Since the native FormData object is iterable, we easily detect what version of `form-data` we're working
+        // with here to allow `multipart/form-data` requests to be compiled under both browser and Node environments.
+        // This hack sucks yeah, but it's the only way we can use this library in the browser as if we code this against
+        // just the native FormData object, we can't polyfill it back into Node because Blob and File objects, which
+        // something like `formdata-polyfill` requires, don't exist there.
+        const isNativeFormData = (typeof form[Symbol.iterator] === 'function');
 
         // easter egg
         const boundary = '---011000010111000001101001'
 
         request.postData.params.forEach(function (param) {
-          if (isBlob(param.value)) {
-            form.append(param.name, param.value || '', param.fileName || null)
+          if (isNativeFormData) {
+            if (isBlob(param.value)) {
+              form.append(param.name, param.value || '', param.fileName || null)
+            } else {
+              form.append(param.name, param.value || '')
+            }
           } else {
-            form.append(param.name, param.value || '')
+            form.append(param.name, param.value || '', {
+              filename: param.fileName || null,
+              contentType: param.contentType || null
+            })
           }
         })
 
-        for (var data of formDataIterator(form, boundary)) {
-          request.postData.text += data
+        if (isNativeFormData) {
+          for (var data of formDataIterator(form, boundary)) {
+            request.postData.text += data
+          }
+        } else {
+          form.pipe(es.map(function (data, cb) {
+            request.postData.text += data
+          }))
         }
 
         request.postData.boundary = boundary
diff --git a/src/targets/index.js b/src/targets/index.js
@@ -1,21 +1,21 @@
 'use strict'
 
 module.exports = {
-//   c: require('./c'),
-//   clojure: require('./clojure'),
-//   csharp: require('./csharp'),
-//   go: require('./go'),
-//   http: require('./http'),
-//   java: require('./java'),
-//   javascript: require('./javascript'),
-//   node: require('./node'),
-//   objc: require('./objc'),
-//   ocaml: require('./ocaml'),
-//   php: require('./php'),
-//   powershell: require('./powershell'),
-//   python: require('./python'),
-//   r: require('./r'),
-//   ruby: require('./ruby'),
+  c: require('./c'),
+  clojure: require('./clojure'),
+  csharp: require('./csharp'),
+  go: require('./go'),
+  http: require('./http'),
+  java: require('./java'),
+  javascript: require('./javascript'),
+  node: require('./node'),
+  objc: require('./objc'),
+  ocaml: require('./ocaml'),
+  php: require('./php'),
+  powershell: require('./powershell'),
+  python: require('./python'),
+  r: require('./r'),
+  ruby: require('./ruby'),
   shell: require('./shell'),
-//   swift: require('./swift')
+  swift: require('./swift')
 }
diff --git a/src/targets/shell/index.js b/src/targets/shell/index.js
@@ -9,6 +9,6 @@ module.exports = {
   },
 
   curl: require('./curl'),
-  // httpie: require('./httpie'),
-  // wget: require('./wget')
+  httpie: require('./httpie'),
+  wget: require('./wget')
 }
diff --git a/test/targets.js b/test/targets.js
@@ -50,7 +50,7 @@ const skipMe = {
     '*': [
       'multipart-data',
       'multipart-file',
-      // 'multipart-form-data'
+      'multipart-form-data'
     ]
   }
 }
@@ -88,15 +88,15 @@ var itShouldGenerateOutput = function (request, path, target, client) {
   })
 }
 
-/* describe('Available Targets', function () {
+describe('Available Targets', function () {
   HTTPSnippet.availableTargets().forEach(function (target) {
     it('available-targets.json should include ' + target.title, function () {
       fixtures['available-targets'].should.containEql(target)
     })
   })
-}) */
+})
 
-/* describe('Custom targets', function () {
+describe('Custom targets', function () {
   describe('Adding a custom target', function () {
     it('should throw if the target does has no info object', function () {
       (function () {
@@ -186,7 +186,7 @@ var itShouldGenerateOutput = function (request, path, target, client) {
       })
     })
   })
-}) */
+})
 
 // test all the things!
 describe('Targets', function () {

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,6 @@ module.exports = {`
`9`	`9`	`},`
`10`	`10`
`11`	`11`	`curl: require('./curl'),`
`12`		`- // httpie: require('./httpie'),`
`13`		`- // wget: require('./wget')`
	`12`	`+ httpie: require('./httpie'),`
	`13`	`+ wget: require('./wget')`
`14`	`14`	`}`