refactor: convert addFromFs

License: MIT
Signed-off-by: Alan Shaw <alan.shaw@protocol.ai>

Author: Alan Shaw

package.json

@@ -19,7 +19,8 @@
     "fs": false,
     "stream": "readable-stream",
     "ky-universal": "ky/umd",
-    "./src/add/form-data.js": "./src/add/form-data.browser.js"
+    "./src/add/form-data.js": "./src/add/form-data.browser.js",
+    "./src/add-from-fs/index.js": "./src/add-from-fs/index.browser.js"
   },
   "repository": "github:ipfs/js-ipfs-http-client",
   "scripts": {
@@ -61,6 +62,7 @@
     "is-stream": "^2.0.0",
     "iso-stream-http": "~0.1.2",
     "iso-url": "~0.4.6",
+    "it-pushable": "^1.2.1",
     "it-to-stream": "^0.1.1",
     "iterable-ndjson": "^1.1.0",
     "just-kebab-case": "^1.1.0",

src/add-from-fs/glob-source.js

@@ -0,0 +1,94 @@
+'use strict'
+
+const Fs = require('fs')
+const Path = require('path')
+const glob = require('glob')
+const pushable = require('it-pushable')
+const errCode = require('err-code')
+
+/**
+* Create an AsyncIterable that can be passed to ipfs.add for the
+* provided file paths.
+*
+* @param {String} ...paths File system path(s) to glob from
+* @param {Object} [options] Optional options
+* @param {Boolean} [options.recursive] Recursively glob all paths in directories
+* @param {Boolean} [options.hidden] Include .dot files in matched paths
+* @param {Array<String>} [options.ignore] Glob paths to ignore
+* @param {Boolean} [options.followSymlinks] follow symlinks
+* @returns {AsyncIterable}
+*/
+module.exports = (...args) => (async function * () {
+  const options = typeof args[args.length - 1] === 'string' ? {} : args.pop()
+  const paths = args
+
+  const globSourceOptions = {
+    recursive: options.recursive,
+    glob: {
+      dot: Boolean(options.hidden),
+      ignore: Array.isArray(options.ignore) ? options.ignore : [],
+      follow: options.followSymlinks != null ? options.followSymlinks : true
+    }
+  }
+
+  // Check the input paths comply with options.recursive and convert to glob sources
+  const results = await Promise.all(paths.map(pathAndType))
+  const globSources = results.map(r => toGlobSource(r, globSourceOptions))
+
+  for (const globSource of globSources) {
+    for await (const { path, contentPath } of globSource) {
+      yield { path, content: Fs.createReadStream(contentPath) }
+    }
+  }
+})()
+
+function toGlobSource ({ path, type }, options) {
+  return (async function * () {
+    options = options || {}
+
+    const baseName = Path.basename(path)
+
+    if (type === 'file') {
+      yield { path: baseName, contentPath: path }
+      return
+    }
+
+    if (type === 'dir' && !options.recursive) {
+      throw errCode(
+        new Error(`'${path}' is a directory and recursive option not set`),
+        'ERR_DIR_NON_RECURSIVE',
+        { path }
+      )
+    }
+
+    const globOptions = Object.assign({}, options.glob, {
+      cwd: path,
+      nodir: true,
+      realpath: false,
+      absolute: false
+    })
+
+    // TODO: want to use pull-glob but it doesn't have the features...
+    const pusher = pushable()
+
+    glob('**/*', globOptions)
+      .on('match', m => pusher.push(m))
+      .on('end', () => pusher.end())
+      .on('abort', () => pusher.end())
+      .on('error', err => pusher.end(err))
+
+    for await (const p of pusher) {
+      yield {
+        path: `${baseName}/${toPosix(p)}`,
+        contentPath: Path.join(path, p)
+      }
+    }
+  })()
+}
+
+async function pathAndType (path) {
+  const stat = await Fs.promises.stat(path)
+  return { path, type: stat.isDirectory() ? 'dir' : 'file' }
+}
+
+const toPosix = path => path.replace(/\\/g, '/')

src/add-from-fs/index.browser.js

@@ -0,0 +1,3 @@
+'use strict'
+
+module.exports = () => { throw new Error('unavailable in the browser') }

src/add-from-fs/index.js

@@ -0,0 +1,9 @@
+'use strict'
+
+const configure = require('../lib/configure')
+const globSource = require('./glob-source')
+
+module.exports = configure(({ ky }) => {
+  const add = require('../add')({ ky })
+  return (path, options) => add(globSource(path, options), options)
+})

src/files-regular/add-from-fs.js

@@ -24,8 +24,16 @@ function requireCommands () {
       const add = require('../add')(config)
       return pullify.transform(add)
     },
-    // TODO: convert
-    addFromFs: require('../files-regular/add-from-fs'),
+    addFromFs: (_, config) => {
+      const addFromFs = collectify(require('../add-from-fs')(config))
+      return (path, options, callback) => {
+        if (typeof options === 'function') {
+          callback = options
+          options = {}
+        }
+        return nodeify(addFromFs(path, options), callback)
+      }
+    },
     addFromURL: (_, config) => {
       const addFromURL = collectify(require('../add-from-url')(config))
       return (url, options, callback) => {