fix: set the FileResultStreamConverter explicitly

vmx · daviddias · commit dfad55e9279c · 2018-03-14T14:30:28.000Z
The `SendFilesStream` used to run the `FileResultStreamConverter` automatically. With making it an option to use a converter, `SendFilesStream` can be used outside of the Files API, e.g. for the DAG API. Closes ipfs-inactive#696.
diff --git a/src/files/add-pull-stream.js b/src/files/add-pull-stream.js
@@ -1,6 +1,13 @@
 'use strict'
 
 const SendFilesStream = require('../utils/send-files-stream')
+const FileResultStreamConverter = require('../utils/file-result-stream-converter')
 const toPull = require('stream-to-pull-stream')
 
-module.exports = (send) => (options) => toPull(SendFilesStream(send, 'add')(options))
+module.exports = (send) => {
+  return (options) => {
+    options = options || {}
+    options.converter = FileResultStreamConverter
+    return toPull(SendFilesStream(send, 'add')(options))
+  }
+}
diff --git a/src/files/add-readable-stream.js b/src/files/add-readable-stream.js
@@ -1,5 +1,12 @@
 'use strict'
 
 const SendFilesStream = require('../utils/send-files-stream')
+const FileResultStreamConverter = require('../utils/file-result-stream-converter')
 
-module.exports = (send) => SendFilesStream(send, 'add')
+module.exports = (send) => {
+  return (options) => {
+    options = options || {}
+    options.converter = FileResultStreamConverter
+    return SendFilesStream(send, 'add')(options)
+  }
+}
diff --git a/src/files/add.js b/src/files/add.js
@@ -5,6 +5,7 @@ const ConcatStream = require('concat-stream')
 const once = require('once')
 const isStream = require('is-stream')
 const OtherBuffer = require('buffer').Buffer
+const FileResultStreamConverter = require('../utils/file-result-stream-converter')
 const SendFilesStream = require('../utils/send-files-stream')
 
 module.exports = (send) => {
@@ -21,6 +22,7 @@ module.exports = (send) => {
     if (!options) {
       options = {}
     }
+    options.converter = FileResultStreamConverter
 
     const ok = Buffer.isBuffer(_files) ||
                isStream.readable(_files) ||
diff --git a/src/files/write.js b/src/files/write.js
@@ -3,6 +3,7 @@
 const promisify = require('promisify-es6')
 const concatStream = require('concat-stream')
 const once = require('once')
+const FileResultStreamConverter = require('../utils/file-result-stream-converter')
 const SendFilesStream = require('../utils/send-files-stream')
 
 module.exports = (send) => {
@@ -28,7 +29,8 @@ module.exports = (send) => {
 
     const options = {
       args: pathDst,
-      qs: opts
+      qs: opts,
+      converter: FileResultStreamConverter
     }
 
     const stream = sendFilesStream(options)
diff --git a/src/util/fs-add.js b/src/util/fs-add.js
@@ -4,6 +4,7 @@ const isNode = require('detect-node')
 const promisify = require('promisify-es6')
 const moduleConfig = require('../utils/module-config')
 const SendOneFile = require('../utils/send-one-file-multiple-results')
+const FileResultStreamConverter = require('../utils/file-result-stream-converter')
 
 module.exports = (arg) => {
   const sendOneFile = SendOneFile(moduleConfig(arg), 'add')
@@ -31,6 +32,10 @@ module.exports = (arg) => {
       return callback(new Error('"path" must be a string'))
     }
 
-    sendOneFile(path, { qs: opts }, callback)
+    const requestOpts = {
+      qs: opts,
+      converter: FileResultStreamConverter
+    }
+    sendOneFile(path, requestOpts, callback)
   })
 }
diff --git a/src/util/url-add.js b/src/util/url-add.js
@@ -5,6 +5,7 @@ const parseUrl = require('url').parse
 const request = require('../utils/request')
 const moduleConfig = require('../utils/module-config')
 const SendOneFile = require('../utils/send-one-file-multiple-results')
+const FileResultStreamConverter = require('../utils/file-result-stream-converter')
 
 module.exports = (arg) => {
   const sendOneFile = SendOneFile(moduleConfig(arg), 'add')
@@ -49,7 +50,11 @@ const requestWithRedirect = (url, opts, sendOneFile, callback) => {
       }
       requestWithRedirect(redirection, opts, sendOneFile, callback)
     } else {
-      sendOneFile(res, { qs: opts }, callback)
+      const requestOpts = {
+        qs: opts,
+        converter: FileResultStreamConverter
+      }
+      sendOneFile(res, requestOpts, callback)
     }
   }).end()
 }
diff --git a/src/utils/file-result-stream-converter.js b/src/utils/file-result-stream-converter.js
@@ -6,7 +6,7 @@ const TransformStream = require('readable-stream').Transform
   Transforms a stream of {Name, Hash} objects to include size
   of the DAG object.
 
-  Usage: inputStream.pipe(new Converter())
+  Usage: inputStream.pipe(new FileResultStreamConverter())
 
   Input object format:
   {
@@ -22,7 +22,7 @@ const TransformStream = require('readable-stream').Transform
     size: 20
   }
 */
-class ConverterStream extends TransformStream {
+class FileResultStreamConverter extends TransformStream {
   constructor (options) {
     const opts = Object.assign({}, options || {}, { objectMode: true })
     super(opts)
@@ -41,4 +41,4 @@ class ConverterStream extends TransformStream {
   }
 }
 
-module.exports = ConverterStream
+module.exports = FileResultStreamConverter
diff --git a/src/utils/send-files-stream.js b/src/utils/send-files-stream.js
@@ -6,7 +6,6 @@ const isStream = require('is-stream')
 const once = require('once')
 const prepareFile = require('./prepare-file')
 const Multipart = require('./multipart')
-const Converter = require('./converter')
 
 function headers (file) {
   const name = file.path
@@ -127,15 +126,27 @@ module.exports = (send, path) => {
 
       response.on('error', (err) => retStream.emit('error', err))
 
-      response.on('data', (d) => {
-        if (d.Bytes && options.progress) {
-          options.progress(d.Bytes)
-        }
-      })
-      const convertedResponse = new Converter()
-      convertedResponse.once('end', () => retStream.push(null))
-      convertedResponse.on('data', (d) => retStream.push(d))
-      response.pipe(convertedResponse)
+      if (options.converter) {
+        response.on('data', (d) => {
+          if (d.Bytes && options.progress) {
+            options.progress(d.Bytes)
+          }
+        })
+
+        const Converter = options.converter
+        const convertedResponse = new Converter()
+        convertedResponse.once('end', () => retStream.push(null))
+        convertedResponse.on('data', (d) => retStream.push(d))
+        response.pipe(convertedResponse)
+      } else {
+        response.on('data', (d) => {
+          if (d.Bytes && options.progress) {
+            options.progress(d.Bytes)
+          }
+          retStream.push(d)
+        })
+        response.once('end', () => retStream.push(null))
+      }
     })
 
     // signal the multipart that the underlying stream has drained and that

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ const parseUrl = require('url').parse`
`5`	`5`	`const request = require('../utils/request')`
`6`	`6`	`const moduleConfig = require('../utils/module-config')`
`7`	`7`	`const SendOneFile = require('../utils/send-one-file-multiple-results')`
	`8`	`+const FileResultStreamConverter = require('../utils/file-result-stream-converter')`
`8`	`9`
`9`	`10`	`module.exports = (arg) => {`
`10`	`11`	`const sendOneFile = SendOneFile(moduleConfig(arg), 'add')`
`@@ -49,7 +50,11 @@ const requestWithRedirect = (url, opts, sendOneFile, callback) => {`
`49`	`50`	`}`
`50`	`51`	`requestWithRedirect(redirection, opts, sendOneFile, callback)`
`51`	`52`	`} else {`
`52`		`- sendOneFile(res, { qs: opts }, callback)`
	`53`	`+ const requestOpts = {`
	`54`	`+ qs: opts,`
	`55`	`+ converter: FileResultStreamConverter`
	`56`	`+ }`
	`57`	`+ sendOneFile(res, requestOpts, callback)`
`53`	`58`	`}`
`54`	`59`	`}).end()`
`55`	`60`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ const TransformStream = require('readable-stream').Transform`
`6`	`6`	`Transforms a stream of {Name, Hash} objects to include size`
`7`	`7`	`of the DAG object.`
`8`	`8`
`9`		`- Usage: inputStream.pipe(new Converter())`
	`9`	`+ Usage: inputStream.pipe(new FileResultStreamConverter())`
`10`	`10`
`11`	`11`	`Input object format:`
`12`	`12`	`{`
`@@ -22,7 +22,7 @@ const TransformStream = require('readable-stream').Transform`
`22`	`22`	`size: 20`
`23`	`23`	`}`
`24`	`24`	`*/`
`25`		`-class ConverterStream extends TransformStream {`
	`25`	`+class FileResultStreamConverter extends TransformStream {`
`26`	`26`	`constructor (options) {`
`27`	`27`	`const opts = Object.assign({}, options \|\| {}, { objectMode: true })`
`28`	`28`	`super(opts)`
`@@ -41,4 +41,4 @@ class ConverterStream extends TransformStream {`
`41`	`41`	`}`
`42`	`42`	`}`
`43`	`43`
`44`		`-module.exports = ConverterStream`
	`44`	`+module.exports = FileResultStreamConverter`