feat: better stream handling (#140)

.gitignore

@@ -31,5 +31,5 @@ build
 # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
 node_modules
 
-lib
 dist
+docs

.travis.yml

@@ -2,7 +2,7 @@ sudo: false
 language: node_js
 node_js:
   - 4
-  - 5
+  - 6
   - stable
 
 # Make sure we have new NPM.

README.md

@@ -27,10 +27,10 @@ npm install --save ipfsd-ctl
 
 ## Usage
 
-IPFS daemons are already easy to start and stop, but this module is here to do it from javascript itself.
+IPFS daemons are already easy to start and stop, but this module is here to do it from JavaScript itself.
 
 ```js
-// start a disposable node, and get access to the api
+// Start a disposable node, and get access to the api
 // print the node id, and kill the temporary daemon
 
 // IPFS_PATH will point to /tmp/ipfs_***** and will be
@@ -41,13 +41,15 @@ var ipfsd = require('ipfsd-ctl')
 ipfsd.disposableApi(function (err, ipfs) {
   ipfs.id(function (err, id) {
     console.log(id)
-    process.kill()
+    process.exit()
   })
 })
 ```
 
 If you need want to use an existing ipfs installation you can set `$IPFS_EXEC=/path/to/ipfs` to ensure it uses that.
 
+For more details see https://ipfs.github.io/js-ipfsd-ctl/.
+
 ## Contribute
 
 Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfsd-ctl/issues)!

example.js

@@ -0,0 +1,17 @@
+'use strict'
+
+// Start a disposable node, and get access to the api
+// print the node id, and kill the temporary daemon
+
+// IPFS_PATH will point to /tmp/ipfs_***** and will be
+// cleaned up when the process exits.
+
+const ipfsd = require('ipfsd-ctl')
+
+ipfsd.disposableApi((err, ipfs) => {
+  if (err) throw err
+  ipfs.id((err, id) => {
+    if (err) throw err
+    console.log(id)
+  })
+})

package.json

@@ -2,16 +2,15 @@
   "name": "ipfsd-ctl",
   "version": "0.17.0",
   "description": "simple controls for an ipfs node",
-  "main": "lib/index.js",
-  "jsxnext:main": "src/index.js",
+  "main": "src/index.js",
   "scripts": {
     "lint": "aegir-lint",
     "coverage": "aegir-coverage",
     "test": "aegir-test --env node",
-    "build": "aegir-build --env node",
-    "release": "aegir-release --env node",
-    "release-minor": "aegir-release --type minor --env node",
-    "release-major": "aegir-release --type major --env node",
+    "docs": "aegir-docs",
+    "release": "aegir-release --env node --docs",
+    "release-minor": "aegir-release --type minor --env node --docs",
+    "release-major": "aegir-release --type major --env node --docs",
     "coverage-publish": "aegir-coverage publish"
   },
   "engines": {
@@ -45,20 +44,22 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "bl": "^1.1.2",
+    "async": "^2.1.4",
     "go-ipfs-dep": "0.4.4",
-    "ipfs-api": "^12.0.3",
-    "multiaddr": "^2.1.0",
+    "ipfs-api": "^12.1.2",
+    "multiaddr": "^2.1.1",
     "once": "^1.4.0",
     "rimraf": "^2.5.4",
-    "run-series": "^1.1.4",
     "shutdown": "^0.2.4",
     "subcomandante": "^1.0.5"
   },
   "devDependencies": {
-    "aegir": "^9.2.1",
+    "aegir": "^9.3.0",
+    "chai": "^3.5.0",
+    "is-running": "^2.1.0",
     "mkdirp": "^0.5.1",
-    "pre-commit": "^1.2.1"
+    "multihashes": "^0.3.1",
+    "pre-commit": "^1.2.2"
   },
   "repository": {
     "type": "git",
@@ -72,4 +73,4 @@
     "example": "examples",
     "test": "test"
   }
-}
+}

src/exec.js

@@ -0,0 +1,66 @@
+'use strict'
+
+const run = require('subcomandante')
+const once = require('once')
+
+function exec (cmd, args, opts, handlers) {
+  opts = opts || {}
+  let err = ''
+  let result = ''
+  let callback
+
+  // Handy method if we just want the result and err returned in a callback
+  if (typeof handlers === 'function') {
+    callback = once(handlers)
+    handlers = {
+      error: callback,
+      data (data) {
+        result += data
+      },
+      done () {
+        if (err) {
+          return callback(new Error(err))
+        }
+        callback(null, result.trim())
+      }
+    }
+  }
+
+  // The listeners that will actually be set on the process
+  const listeners = {
+    data: handlers.data,
+    error (data) {
+      err += data
+    },
+    done: once((code) => {
+      if (typeof code === 'number' && code !== 0) {
+        return handlers.error(
+          new Error(`non-zero exit code ${code}\n
+            while running: ${cmd} ${args.join(' ')}\n\n
+            ${err}`)
+        )
+      }
+      if (handlers.done) {
+        handlers.done()
+      }
+    })
+  }
+
+  const command = run(cmd, args, opts)
+
+  if (listeners.data) {
+    command.stdout.on('data', listeners.data)
+  }
+
+  command.stderr.on('data', listeners.error)
+
+  // If command fails to execute return directly to the handler
+  command.on('error', handlers.error)
+
+  command.on('close', listeners.done)
+  command.on('exit', listeners.done)
+
+  return command
+}
+
+module.exports = exec

src/index.js

@@ -5,66 +5,111 @@ const join = require('path').join
 
 const Node = require('./node')
 
+const defaultOptions = {
+  'Addresses.Swarm': ['/ip4/0.0.0.0/tcp/0'],
+  'Addresses.Gateway': '',
+  'Addresses.API': '/ip4/127.0.0.1/tcp/0',
+  disposable: true,
+  init: true
+}
+
 function tempDir () {
   return join(os.tmpdir(), `ipfs_${String(Math.random()).substr(2)}`)
 }
 
-module.exports = {
-  version (done) {
-    (new Node()).version(done)
+/**
+ * Control go-ipfs nodes directly from JavaScript.
+ *
+ * @namespace IpfsDaemonController
+ */
+const IpfsDaemonController = {
+  /**
+   * Get the version of the currently used go-ipfs binary.
+   *
+   * @memberof IpfsDaemonController
+   * @param {function(Error, string)} callback
+   * @returns {undefined}
+   */
+  version (callback) {
+    (new Node()).version(callback)
   },
-  local (path, opts, done) {
+  /**
+   * Create a new local node.
+   *
+   * @memberof IpfsDaemonController
+   * @param {string} [path] - Location of the repo. Defaults to `$IPFS_PATH`, or `$HOME/.ipfs`, or `$USER_PROFILE/.ipfs`.
+   * @param {Object} [opts={}]
+   * @param {function(Error, Node)} callback
+   * @returns {undefined}
+   */
+  local (path, opts, callback) {
     if (typeof opts === 'function') {
-      done = opts
+      callback = opts
       opts = {}
     }
-    if (!done) {
-      done = path
+    if (!callback) {
+      callback = path
       path = process.env.IPFS_PATH ||
         join(process.env.HOME ||
              process.env.USERPROFILE, '.ipfs')
     }
     process.nextTick(() => {
-      done(null, new Node(path, opts))
+      callback(null, new Node(path, opts))
     })
   },
-  disposableApi (opts, done) {
+  /**
+   * Create a new disposable node and already start the daemon.
+   *
+   * @memberof IpfsDaemonController
+   * @param {Object} [opts={}]
+   * @param {function(Error, Node)} callback
+   * @returns {undefined}
+   */
+  disposableApi (opts, callback) {
     if (typeof opts === 'function') {
-      done = opts
+      callback = opts
       opts = {}
     }
     this.disposable(opts, (err, node) => {
-      if (err) return done(err)
-      node.startDaemon(done)
+      if (err) {
+        return callback(err)
+      }
+
+      node.startDaemon(callback)
     })
   },
-  disposable (opts, done) {
+  /**
+   * Create a new disposable node.
+   * This means the repo is created in a temporary location and cleaned up on process exit.
+   *
+   * @memberof IpfsDaemonController
+   * @param {Object} [opts={}]
+   * @param {function(Error, Node)} callback
+   * @returns {undefined}
+   */
+  disposable (opts, callback) {
     if (typeof opts === 'function') {
-      done = opts
+      callback = opts
       opts = {}
     }
-    opts['Addresses.Swarm'] = ['/ip4/0.0.0.0/tcp/0']
-    opts['Addresses.Gateway'] = ''
-    opts['Addresses.API'] = '/ip4/127.0.0.1/tcp/0'
 
-    if (opts.apiAddr) {
-      opts['Addresses.API'] = opts.apiAddr
-    }
+    let options = {}
+    Object.assign(options, defaultOptions, opts || {})
 
-    if (opts.gatewayAddr) {
-      opts['Addresses.Gateway'] = opts.gatewayAddr
-    }
+    const repoPath = options.repoPath || tempDir()
+    const disposable = options.disposable
+    delete options.disposable
+    delete options.repoPath
 
-    const node = new Node(opts.repoPath || tempDir(), opts, true)
+    const node = new Node(repoPath, options, disposable)
 
-    if (typeof opts.init === 'boolean' && opts.init === false) {
-      process.nextTick(() => {
-        done(null, node)
-      })
+    if (typeof options.init === 'boolean' &&
+        options.init === false) {
+      process.nextTick(() => callback(null, node))
     } else {
-      node.init((err) => {
-        done(err, node)
-      })
+      node.init((err) => callback(err, node))
     }
   }
 }
+
+module.exports = IpfsDaemonController