more options in storjshare-create, add --all flag to restart, extend time to wait for daemon, update readme

Gordon Hall · Gordon Hall · commit c0bf156988da · 2017-01-12T12:12:03.000-05:00
diff --git a/README.md b/README.md
@@ -14,7 +14,7 @@ use or inclusion in other packages.
 Make sure you have the following prerequisites installed:
 
 * Git
-* Node.js LTS
+* Node.js LTS (6.9.x)
 * NPM
 * Python 2.7
 * GCC/G++/Make
@@ -109,15 +109,25 @@ You can also get more detailed help for a specific command.
 ```
 storjshare help create
 
-Usage: storjshare-create [options]
+  Usage: storjshare-create [options]
+
+  generates a new share configuration
 
   Options:
 
     -h, --help                 output usage information
-    -a, --sjcx <addr>          specify the sjcx address (required)
-    -s, --storage <path>       specify the storage path
-    -l, --logfile <path>       specify the logfile path
-    -k, --privkey <privkey>    specify the private key
+    --sjcx <addr>              specify the sjcx address (required)
+    --key <privkey>            specify the private key
+    --storage <path>           specify the storage path
+    --size <maxsize>           specify share size (ex: 10GB, 1TB)
+    --rpcport <port>           specify the rpc port number
+    --rpcaddress <addr>        specify the rpc address
+    --maxtunnels <tunnels>     specify the max tunnels
+    --tunnelportmin <port>     specify min gateway port
+    --tunnelportmax <port>     specify max gateway port
+    --manualforwarding         do not use nat traversal strategies
+    --logfile <path>           specify the logfile path
+    --noedit                   do not open generated config in editor
     -o, --outfile <writepath>  write config to path
 ```
 
@@ -235,7 +245,7 @@ Now that you have Storj Share installed, use the `create` command to generate
 your configuration.
 
 ```
-storjshare create -k 4154e8... -a 1K1rPg... -s <datadir> -o <writepath>
+storjshare create --key 4154e8... --sjcx 1K1rPg... --storage <datadir> -o <writepath>
 ```
 
 This will generate your configuration file given the parameters you passed in, 
diff --git a/bin/storjshare-create.js b/bin/storjshare-create.js
@@ -2,39 +2,51 @@
 
 'use strict';
 
+const blindfold = require('blindfold');
 const editor = require('editor');
 const {tmpdir, homedir} = require('os');
 const fs = require('fs');
 const storj = require('storj-lib');
 const path = require('path');
 const mkdirp = require('mkdirp');
-const config = require('../lib/config/daemon');
+const stripJsonComments = require('strip-json-comments');
 const storjshare_create = require('commander');
 
+const defaultConfig = JSON.parse(stripJsonComments(fs.readFileSync(
+  path.join(__dirname, '../example/farmer.config.json')
+).toString()));
+
 storjshare_create
   .description('generates a new share configuration')
-  .option('-a, --sjcx <addr>', 'specify the sjcx address (required)')
-  .option('-s, --storage <path>', 'specify the storage path')
-  .option('-l, --logfile <path>', 'specify the logfile path')
-  .option('-k, --privkey <privkey>', 'specify the private key')
+  .option('--sjcx <addr>', 'specify the sjcx address (required)')
+  .option('--key <privkey>', 'specify the private key')
+  .option('--storage <path>', 'specify the storage path')
+  .option('--size <maxsize>', 'specify share size (ex: 10GB, 1TB)')
+  .option('--rpcport <port>', 'specify the rpc port number')
+  .option('--rpcaddress <addr>', 'specify the rpc address')
+  .option('--maxtunnels <tunnels>', 'specify the max tunnels')
+  .option('--tunnelportmin <port>', 'specify min gateway port')
+  .option('--tunnelportmax <port>', 'specify max gateway port')
+  .option('--manualforwarding', 'do not use nat traversal strategies')
+  .option('--logfile <path>', 'specify the logfile path')
+  .option('--noedit', 'do not open generated config in editor')
   .option('-o, --outfile <writepath>', 'write config to path')
-  .option('-n, --noedit', 'do not open generated config in editor')
   .parse(process.argv);
 
 if (!storjshare_create.sjcx) {
   console.error('\n  no payment address was given, try --help');
   process.exit(1);
 }
 
-if (!storjshare_create.privkey) {
-  storjshare_create.privkey = storj.KeyPair().getPrivateKey();
+if (!storjshare_create.key) {
+  storjshare_create.key = storj.KeyPair().getPrivateKey();
 }
 
 if (!storjshare_create.storage) {
   storjshare_create.storage = path.join(
     homedir(),
     '.config/storjshare/shares',
-    storj.KeyPair(storjshare_create.privkey).getNodeID()
+    storj.KeyPair(storjshare_create.key).getNodeID()
   );
   mkdirp.sync(storjshare_create.storage);
 }
@@ -43,33 +55,72 @@ if (!storjshare_create.logfile) {
   storjshare_create.logfile = path.join(
     homedir(),
     '.config/storjshare/logs',
-    storj.KeyPair(storjshare_create.privkey).getNodeID() + '.log'
+    storj.KeyPair(storjshare_create.key).getNodeID() + '.log'
   );
 }
 
 if (!storjshare_create.outfile) {
   storjshare_create.outfile = path.join(
     tmpdir(),
-    storj.KeyPair(storjshare_create.privkey).getNodeID() + '.json'
+    storj.KeyPair(storjshare_create.key).getNodeID() + '.json'
   );
 }
 
 let exampleConfigPath = path.join(__dirname, '../example/farmer.config.json');
 let exampleConfigString = fs.readFileSync(exampleConfigPath).toString();
 
-function replaceEmptyConfig(prop, value) {
-  value = value.split('\\').join('\\\\'); // NB: Hack windows paths into JSON
+function getDefaultConfigValue(prop) {
+  return {
+    value: blindfold(defaultConfig, prop),
+    type: typeof blindfold(defaultConfig, prop)
+  };
+}
+
+function replaceDefaultConfigValue(prop, value) {
+  let defaultValue = getDefaultConfigValue(prop);
+
+  function toStringReplace(prop, value, type) {
+    switch (type) {
+      case 'string':
+        value = value.split('\\').join('\\\\'); // NB: Hack windows paths
+        return`"${prop}": "${value}"`;
+      case 'boolean':
+      case 'number':
+        return `"${prop}": ${value}`;
+      default:
+        return '';
+    }
+  }
+
+  prop = prop.split('.').pop();
   exampleConfigString = exampleConfigString.replace(
-    `"${prop}": ""`,
-    `"${prop}": "${value}"`
+    toStringReplace(prop, defaultValue.value, defaultValue.type),
+    toStringReplace(prop, value, defaultValue.type)
   );
 }
 
-replaceEmptyConfig('paymentAddress', storjshare_create.sjcx);
-replaceEmptyConfig('networkPrivateKey', storjshare_create.privkey);
-replaceEmptyConfig('storagePath', path.normalize(storjshare_create.storage));
-replaceEmptyConfig('loggerOutputFile',
-                   path.normalize(storjshare_create.logfile));
+replaceDefaultConfigValue('paymentAddress', storjshare_create.sjcx);
+replaceDefaultConfigValue('networkPrivateKey', storjshare_create.key);
+replaceDefaultConfigValue('storagePath',
+                          path.normalize(storjshare_create.storage));
+replaceDefaultConfigValue('loggerOutputFile',
+                          path.normalize(storjshare_create.logfile));
+
+const optionalReplacements = [
+  { option: storjshare_create.size, name: 'storageAllocation' },
+  { option: storjshare_create.rpcaddress, name: 'rpcAddress' },
+  { option: storjshare_create.rpcport, name: 'rpcPort' },
+  { option: storjshare_create.maxtunnels, name: 'maxTunnels' },
+  { option: storjshare_create.tunnelportmin, name: 'tunnelGatewayRange.min' },
+  { option: storjshare_create.tunnelportmax, name: 'tunnelGatewayRange.max' },
+  { option: storjshare_create.manualforwarding, name: 'doNotTraverseNat' }
+];
+
+optionalReplacements.forEach((repl) => {
+  if (repl.option) {
+    replaceDefaultConfigValue(repl.name, repl.option);
+  }
+});
 
 let outfile = path.isAbsolute(storjshare_create.outfile) ?
                 path.normalize(storjshare_create.outfile) :
diff --git a/bin/storjshare-restart.js b/bin/storjshare-restart.js
@@ -9,22 +9,33 @@ const storjshare_restart = require('commander');
 storjshare_restart
   .description('restarts the running share specified')
   .option('-i, --nodeid <nodeid>', 'id of the running share')
+  .option('-a, --all', 'restart all running shares')
   .parse(process.argv);
 
-if (!storjshare_restart.nodeid) {
+if (!storjshare_restart.nodeid && !storjshare_restart.all) {
   console.error('\n  missing node id, try --help');
   process.exit(1);
 }
 
 const sock = dnode.connect(config.daemonRpcPort);
 
 sock.on('remote', function(rpc) {
-  rpc.restart(storjshare_restart.nodeid, (err) => {
+  if (storjshare_restart.all) {
+    console.info('\n  * restarting all managed shares');
+  }
+
+  rpc.restart(storjshare_restart.nodeid || '*', (err) => {
     if (err) {
       console.error(`\n  cannot restart node, reason: ${err.message}`);
       return sock.end();
     }
-    console.info(`\n  * share ${storjshare_restart.nodeid} restarted`);
+
+    if (storjshare_restart.nodeid) {
+      console.info(`\n  * share ${storjshare_restart.nodeid} restarted`);
+    } else {
+      console.info('\n  * all shares restarted successfully');
+    }
+
     sock.end();
   });
 });
diff --git a/bin/storjshare.js b/bin/storjshare.js
@@ -26,7 +26,7 @@ if (!['daemon'].includes(process.argv[2])) {
   sock.once('error', function() {
     console.info('\n  * daemon is not running, starting...');
     fork(path.join(__dirname, 'storjshare-daemon.js'), []);
-    setTimeout(() => storjshare.parse(process.argv), 2000);
+    setTimeout(() => storjshare.parse(process.argv), 4000);
   });
 
   sock.once('connect', function() {
diff --git a/lib/api.js b/lib/api.js
@@ -1,5 +1,6 @@
 'use strict';
 
+const async = require('async');
 const storj = require('storj-lib');
 const fs = require('fs');
 const {statSync, readFileSync} = require('fs');
@@ -20,6 +21,7 @@ class RPC {
   constructor(options={}) {
     this.logger = new JsonLogger(options.logVerbosity);
     this.shares = new Map();
+    this._restarts = {};
   }
 
   /**
@@ -49,11 +51,11 @@ class RPC {
    */
   start(configPath, callback) {
     const self = this;
+    self._restarts[configPath] = self._restarts[configPath] || 0;
     let share = {
       config: null,
       meta: {
         uptimeMs: 0,
-        numRestarts: 0,
         farmerState: {}
       },
       process: null,
@@ -124,14 +126,15 @@ class RPC {
 
       // NB: Listen for exits and restart the share if not stopped manually
       share.process.on('exit', (code, signal) => {
-        let maxRestartsReached = share.meta.numRestarts >= RPC.MAX_RESTARTS;
+        let totalRestarts = self._restarts[configPath];
+        let maxRestartsReached = totalRestarts >= RPC.MAX_RESTARTS;
         share.readyState = RPC.SHARE_STOPPED;
 
         self._log(`share ${nodeId} exited with code ${code}`);
         clearInterval(uptimeCounter);
 
         if (signal !== 'SIGINT' && !maxRestartsReached) {
-          share.meta.numRestarts++;
+          self._restarts[configPath]++;
           self.restart(nodeId, () => null);
         }
       });
@@ -173,6 +176,15 @@ class RPC {
    */
   restart(nodeId, callback) {
     this._log(`attempting to restart share with node id ${nodeId}`);
+
+    if (nodeId === '*') {
+      return async.eachSeries(
+        this.shares.keys(),
+        (nodeId, next) => this.restart(nodeId, next),
+        callback
+      );
+    }
+
     this.stop(nodeId, () => {
       this.start(this.shares.get(nodeId).path, callback);
     });
@@ -187,11 +199,12 @@ class RPC {
    * @param {RPC~statusCallback}
    */
   status(callback) {
-    this._log(`got status query`);
-
-    let statuses = [];
+    const self = this;
+    const statuses = [];
 
+    this._log(`got status query`);
     this.shares.forEach((share, nodeId) => {
+      share.meta.numRestarts = self._restarts[share.path];
       statuses.push({
         id: nodeId,
         config: share.config,
@@ -234,7 +247,10 @@ class RPC {
       return callback(new Error(`share ${nodeId} is not running`));
     }
 
-    this.shares.get(nodeId).process.kill('SIGINT');
+    let share = this.shares.get(nodeId);
+    this._restarts[share.path] = 0;
+
+    share.process.kill('SIGINT');
     this.shares.delete(nodeId);
     callback(null);
   }
diff --git a/package.json b/package.json
@@ -1,10 +1,19 @@
 {
   "name": "storjshare-daemon",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "daemon + process manager for sharing space on the storj network",
   "main": "index.js",
   "bin": {
-    "storjshare": "bin/storjshare.js"
+    "storjshare": "bin/storjshare.js",
+    "storjshare-start": "bin/storjshare-start.js",
+    "storjshare-stop": "bin/storjshare-stop.js",
+    "storjshare-restart": "bin/storjshare-restart.js",
+    "storjshare-status": "bin/storjshare-status.js",
+    "storjshare-logs": "bin/storjshare-logs.js",
+    "storjshare-killall": "bin/storjshare-killall.js",
+    "storjshare-destroy": "bin/storjshare-destroy.js",
+    "storjshare-daemon": "bin/storjshare-daemon.js",
+    "storjshare-create": "bin/storjshare-create.js"
   },
   "directories": {
     "test": "test",
@@ -40,6 +49,8 @@
   },
   "homepage": "https://github.com/storj/storjshare-daemon#readme",
   "dependencies": {
+    "async": "^2.1.4",
+    "blindfold": "0.0.1",
     "bytes": "^2.4.0",
     "cli-table": "^0.3.1",
     "colors": "^1.1.2",
diff --git a/test/api.unit.js b/test/api.unit.js
