fix: basicaly normalize behaviour across the 3 impls

Author: hugomrdias

src/endpoint/routes.js

@@ -61,32 +61,25 @@ module.exports = (server) => {
     path: '/spawn',
     handler: (request, reply) => {
       const payload = request.payload || {}
-
       // TODO: use the ../src/index.js so that the right Factory is picked
       const f = new FactoryDaemon({ type: payload.type })
 
-      f.spawn(payload.options, (err, ipfsd) => {
+      f.spawn(payload, (err, ipfsd) => {
         if (err) {
           return reply(boom.badRequest(err))
         }
         const id = hat()
-        const initialized = ipfsd.initialized
         nodes[id] = ipfsd
 
-        let api = null
-
-        if (nodes[id].started) {
-          api = {
-            apiAddr: nodes[id].apiAddr
-              ? nodes[id].apiAddr.toString()
-              : '',
-            gatewayAddr: nodes[id].gatewayAddr
-              ? nodes[id].gatewayAddr.toString()
-              : ''
-          }
-        }
-
-        reply({ id: id, api: api, initialized: initialized })
+        reply({
+          _id: id,
+          apiAddr: ipfsd.apiAddr ? ipfsd.apiAddr.toString() : '',
+          gatewayAddr: ipfsd.gatewayAddr ? ipfsd.gatewayAddr.toString() : '',
+          initialized: ipfsd.initialized,
+          started: ipfsd.started,
+          _env: ipfsd._env,
+          path: ipfsd.path
+        })
       })
     }
   })
@@ -131,10 +124,8 @@ module.exports = (server) => {
         }
 
         reply({
-          api: {
-            apiAddr: nodes[id].apiAddr.toString(),
-            gatewayAddr: nodes[id].gatewayAddr.toString()
-          }
+          apiAddr: nodes[id].apiAddr.toString(),
+          gatewayAddr: nodes[id].gatewayAddr ? nodes[id].gatewayAddr.toString() : null
         })
       })
     },

src/factory-client.js

@@ -1,6 +1,8 @@
 'use strict'
 
 const request = require('superagent')
+const merge = require('merge-options')
+const defaultConfig = require('./defaults/config.json')
 const DaemonClient = require('./ipfsd-client')
 
 /** @ignore @typedef {import("./index").SpawnOptions} SpawnOptions */
@@ -90,29 +92,32 @@ class FactoryClient {
       options = {}
     }
 
-    options = options || {}
-
+    const daemonOptions = merge({
+      exec: this.options.exec,
+      type: this.options.type,
+      IpfsApi: this.options.IpfsApi,
+      disposable: true,
+      start: options.disposable !== false,
+      init: options.disposable !== false,
+      config: defaultConfig
+    }, options)
+
+    if (options.defaultAddrs) {
+      delete daemonOptions.config.Addresses
+    }
     request
-      .post(`${this.baseUrl}/spawn`)
-      .send({ options: options, type: this.options.type })
+      .post(`${this.baseUrl}/spawn`, daemonOptions)
       .end((err, res) => {
         if (err) {
           return callback(new Error(err.response ? err.response.body.message : err))
         }
-
-        const apiAddr = res.body.api ? res.body.api.apiAddr : ''
-        const gatewayAddr = res.body.api ? res.body.api.gatewayAddr : ''
-
-        const ipfsd = new DaemonClient(
+        const node = new DaemonClient(
           this.baseUrl,
-          res.body.id,
-          res.body.initialized,
-          apiAddr,
-          gatewayAddr,
-          { IpfsApi: this.options.IpfsApi }
+          res.body,
+          daemonOptions
         )
 
-        callback(null, ipfsd)
+        callback(null, node)
       })
   }
 }

src/factory-daemon.js

@@ -2,7 +2,6 @@
 
 const series = require('async/series')
 const merge = require('merge-options')
-const path = require('path')
 const tmpDir = require('./utils/tmp-dir')
 const Daemon = require('./ipfsd-daemon')
 const defaultConfig = require('./defaults/config.json')
@@ -79,19 +78,15 @@ class FactoryDaemon {
       callback = options
       options = {}
     }
-    const defaultRepo = path.join(
-      process.env.HOME || process.env.USERPROFILE,
-      this.options.type === 'js' ? '.jsipfs' : '.ipfs'
-    )
+
     const daemonOptions = merge({
       exec: this.options.exec,
       type: this.options.type,
       IpfsApi: this.options.IpfsApi,
       disposable: true,
       start: options.disposable !== false,
       init: options.disposable !== false,
-      config: defaultConfig,
-      repoPath: defaultRepo
+      config: defaultConfig
     }, options)
 
     if (options.defaultAddrs) {
@@ -101,8 +96,8 @@ class FactoryDaemon {
     const node = new Daemon(daemonOptions)
 
     series([
-      daemonOptions.init && ((cb) => node.init(daemonOptions.initOptions, cb)),
-      daemonOptions.start && ((cb) => node.start(daemonOptions.args, cb))
+      daemonOptions.init && (cb => node.init(daemonOptions.initOptions, cb)),
+      daemonOptions.start && (cb => node.start(daemonOptions.args, cb))
     ].filter(Boolean),
     (err) => {
       if (err) { return callback(err) }

src/factory-in-proc.js

@@ -1,15 +1,10 @@
 'use strict'
 
-const defaults = require('lodash.defaultsdeep')
-const clone = require('lodash.clone')
 const series = require('async/series')
-const path = require('path')
-const once = require('once')
+const merge = require('merge-options')
 const tmpDir = require('./utils/tmp-dir')
-const repoUtils = require('./utils/repo/nodejs')
 const InProc = require('./ipfsd-in-proc')
 const defaultConfig = require('./defaults/config.json')
-const defaultOptions = require('./defaults/options.json')
 
 /** @ignore @typedef {import("./index").SpawnOptions} SpawnOptions */
 
@@ -38,7 +33,6 @@ class FactoryInProc {
    *
    * @param {string} type - the type of the node
    * @param {function(Error, string): void} callback
-   * @returns {void}
    */
   tmpDir (type, callback) {
     callback(null, tmpDir(true))
@@ -49,7 +43,6 @@ class FactoryInProc {
    *
    * @param {Object} [options={}]
    * @param {function(Error, string): void} callback
-   * @returns {void}
    */
   version (options, callback) {
     if (typeof options === 'function') {
@@ -58,79 +51,51 @@ class FactoryInProc {
     }
 
     const node = new InProc(options)
-    node.once('ready', () => {
-      node.version(callback)
-    })
+    node.version(callback)
   }
 
   /**
    * Spawn JSIPFS instances
    *
-   * @param {SpawnOptions} [opts={}] - various config options and ipfs config parameters
+   * @param {SpawnOptions} [options={}] - various config options and ipfs config parameters
    * @param {function(Error, InProc): void} callback - a callback that receives an array with an `ipfs-instance` attached to the node and a `Node`
    * @returns {void}
    */
-  spawn (opts, callback) {
-    if (typeof opts === 'function') {
-      callback = opts
-      opts = defaultOptions
+  spawn (options, callback) {
+    if (typeof options === 'function') {
+      callback = options
+      options = {}
     }
 
-    const options = defaults({}, opts, defaultOptions)
-    options.init = typeof options.init !== 'undefined'
-      ? options.init
-      : true
-
-    if (options.disposable) {
-      options.config = defaults({}, options.config, defaultConfig)
-    } else {
-      const nonDisposableConfig = clone(defaultConfig)
-      options.init = false
-      options.start = false
-
-      const defaultRepo = path.join(
-        process.env.HOME || process.env.USERPROFILE || '',
-        options.isJs ? '.jsipfs' : '.ipfs'
-      )
-
-      options.repoPath = options.repoPath || (process.env.IPFS_PATH || defaultRepo)
-      options.config = defaults({}, options.config, nonDisposableConfig)
-    }
+    const daemonOptions = merge({
+      exec: this.options.exec,
+      type: this.options.type,
+      IpfsApi: this.options.IpfsApi,
+      disposable: true,
+      start: options.disposable !== false,
+      init: options.disposable !== false,
+      config: defaultConfig
+    }, options)
 
     if (options.defaultAddrs) {
-      delete options.config.Addresses
+      delete daemonOptions.config.Addresses
     }
 
-    options.type = this.options.type
-    options.exec = options.exec || this.options.exec
-
-    if (typeof options.exec !== 'function') {
+    if (typeof this.options.exec !== 'function') {
       return callback(new Error(`'type' proc requires 'exec' to be a coderef`))
     }
 
-    const node = new InProc(options)
-    const callbackOnce = once((err) => {
-      if (err) {
-        return callback(err)
-      }
-      callback(null, node)
-    })
-    node.once('error', callbackOnce)
+    const node = new InProc(daemonOptions)
 
     series([
-      (cb) => node.once('ready', cb),
-      (cb) => repoUtils.repoExists(node.path, (err, initialized) => {
-        if (err) { return cb(err) }
-        node.initialized = initialized
-        cb()
-      }),
-      (cb) => options.init
-        ? node.init(cb)
-        : cb(),
-      (cb) => options.start
-        ? node.start(options.args, cb)
-        : cb()
-    ], callbackOnce)
+      daemonOptions.init && (cb => node.init(daemonOptions.initOptions, cb)),
+      daemonOptions.start && (cb => node.start(daemonOptions.args, cb))
+    ].filter(Boolean),
+    (err) => {
+      if (err) { return callback(err) }
+
+      callback(null, node)
+    })
   }
 }