replace byte convert utils with bytes package, change config to use a single property for allocation, some cleanup, add tests for utils

Author: Gordon Hall

bin/storjshare-logs.js

@@ -8,6 +8,7 @@ const utils = require('../lib/utils');
 const {Tail} = require('tail');
 const colors = require('colors/safe');
 const storjshare_logs = require('commander');
+const fs = require('fs');
 
 storjshare_logs
   .description('tails the logs for the given share id')
@@ -45,6 +46,21 @@ sock.on('remote', function(rpc) {
 
     let logTail = new Tail(logFilePath);
 
+    function getLastLines(filename, lines, callback) {
+      let chunk = '';
+      let size = Math.max(0, fs.statSync(filename).size - (lines * 200));
+
+      fs.createReadStream(filename, { start: size })
+        .on('data', function(data) {
+          chunk += data.toString();
+        })
+        .on('end', function() {
+          chunk = chunk.split('\n').slice(-(lines + 1));
+          chunk.pop();
+          callback(chunk);
+        });
+    }
+
     function prettyLog(line) {
       var output = ' ';
 
@@ -80,7 +96,7 @@ sock.on('remote', function(rpc) {
                    parseInt(storjshare_logs.lines) :
                    20;
 
-    utils.getLastLines(logFilePath, numLines, (lines) => {
+    getLastLines(logFilePath, numLines, (lines) => {
       lines.forEach((line) => prettyLog(line));
       logTail.on('line', (line) => prettyLog(line));
     });

bin/storjshare-start.js

@@ -18,7 +18,9 @@ if (!storjshare_start.config) {
   process.exit(1);
 }
 
-const configPath = path.join(process.cwd(), storjshare_start.config);
+const configPath = storjshare_start.config[0] === '/' ?
+                   storjshare_start.config :
+                   path.join(process.cwd(), storjshare_start.config);
 const sock = dnode.connect(config.daemonRpcPort);
 
 sock.on('remote', function(rpc) {

example/farmer.config.json

@@ -56,10 +56,9 @@
   "loggerOutputFile": "",
   // Directory path to store contracts and shards
   "storagePath": "",
-  // Amount of space to lease to the network, measured by storageAllocationUnit
-  "storageAllocationSize": 2,
-  // Valid options are B, KB, MB, GB, TB
-  "storageAllocationUnit": "GB",
+  // Amount of space to lease to the network, as human readable string
+  // Valid units are B, KB, MB, GB, TB
+  "storageAllocation": "2GB",
   // Periodically report your used and free capacity to Storj Labs to improve 
   // the network - no personally identifiable information is sent
   "enableTelemetryReporting": true

lib/config/farmer.js

@@ -39,8 +39,7 @@ const config = require('rc')('storjfarmer', {
   loggerVerbosity: 3,
   loggerOutputFile: null,
   storagePath: null,
-  storageAllocationUnit: 'GB',
-  storageAllocationSize: 2,
+  storageAllocation: '2GB',
   enableTelemetryReporting: true
 });
 

lib/utils.js

@@ -4,18 +4,19 @@
 
 'use strict';
 
-var fs = require('fs');
-var storj = require('storj-lib');
-var bitcore = storj.deps.bitcore;
-var du = require('du');
-var diskspace = require('fd-diskspace').diskSpace;
-var assert = require('assert');
+const fs = require('fs');
+const storj = require('storj-lib');
+const {bitcore} = storj.deps;
+const du = require('du');
+const diskspace = require('fd-diskspace').diskSpace;
+const assert = require('assert');
+const bytes = require('bytes');
 
 /**
  * Validate the given payout address
  * @param {String} address
  */
-module.exports._isValidPayoutAddress = function(address) {
+exports._isValidPayoutAddress = function(address) {
   return bitcore.Address.isValid(address) ||
          bitcore.Address.isValid(address, bitcore.Networks.testnet);
 };
@@ -24,33 +25,28 @@ module.exports._isValidPayoutAddress = function(address) {
  * Validate the given dataserv directory
  * @param {String} directory
  */
-module.exports._isValidDirectory = function(directory) {
+exports._isValidDirectory = function(directory) {
   return this.existsSync(directory);
 };
 
 /**
  * Validate the given size
  * @param {String} size
  */
-module.exports._isValidSize = function(size) {
+exports._isValidSize = function(size) {
   return Number(size) > 0 && typeof size !== 'undefined';
 };
 
 /**
  * Validates a given tab config
  * @param {Object} config
  */
-module.exports.validate = function(config) {
+exports.validate = function(config) {
   assert(this._isValidPayoutAddress(config.paymentAddress),
          'Invalid payout address');
   assert(this._isValidDirectory(config.storagePath), 'Invalid directory');
-  assert(this._isValidSize(config.storageAllocationSize),
+  assert(this._isValidSize(bytes.parse(config.storageAllocation)),
          'Invalid storage size');
-
-  if (!this.existsSync(config.storagePath)) {
-    fs.mkdirSync(config.storagePath);
-  }
-
   assert(this._isValidDirectory(config.storagePath),
          'Could not create Shard Directory');
 };
@@ -59,21 +55,18 @@ module.exports.validate = function(config) {
  * Validates the space being allocated exists
  * @param {Object} config
  */
-module.exports.validateAllocation = function(conf, callback) {
+exports.validateAllocation = function(conf, callback) {
   const self = this;
 
   self.getFreeSpace(conf.storagePath, function(err, free) {
-    var allocatedSpace = self.manualConvert({
-      size: conf.storageAllocationSize,
-      unit: conf.storageAllocationUnit
-    }, 'B', 0);
+    var allocatedSpace = bytes.parse(conf.storageAllocation);
 
     self.getDirectorySize(conf.storagePath, function(err, usedSpaceBytes) {
       if (err) {
         return callback(err);
       }
 
-      if (allocatedSpace.size > free + usedSpaceBytes) {
+      if (allocatedSpace > free + usedSpaceBytes) {
         return callback(new Error('Invalid storage size'));
       }
 
@@ -86,7 +79,7 @@ module.exports.validateAllocation = function(conf, callback) {
  * Check if file exists
  * @param {String} file - Path to file
  */
-module.exports.existsSync = function(file) {
+exports.existsSync = function(file) {
   try {
     fs.statSync(file);
   } catch(err) {
@@ -96,84 +89,13 @@ module.exports.existsSync = function(file) {
   return true;
 };
 
-/**
- * Converts to a reasonable unit of bytes
- * @param {Object} bytes
- * @param {Number} precision
- */
-module.exports.autoConvert = function(object, precision) {
-  /*jshint maxcomplexity:10 */
-  var kilobyte = 1000;
-  var megabyte = kilobyte * 1000;
-  var gigabyte = megabyte * 1000;
-  var terabyte = gigabyte * 1000;
-
-  var byteobject = (this.manualConvert(object, 'B'));
-  var bytes = byteobject.size;
-
-  if ((bytes >= kilobyte) && (bytes < megabyte)) {
-    return this.manualConvert(byteobject, 'KB', (precision || 1));
-  } else if ((bytes >= megabyte) && (bytes < gigabyte)) {
-    return this.manualConvert(byteobject, 'MB', (precision || 2));
-  } else if ((bytes >= gigabyte) && (bytes < terabyte)) {
-    return this.manualConvert(byteobject, 'GB', (precision || 3));
-  } else if (bytes >= terabyte) {
-    return this.manualConvert(byteobject, 'TB', (precision || 4));
-  }
-
-  return byteobject;
-};
-
-/**
- * Converts units of bytes to other units
- * @param {Object} object to be converted
- * @param {String} Unit Object will be converted to
- */
-module.exports.manualConvert = function(object, unit, precision) {
-  const table = {
-    'B': 0,
-    'KB': 1,
-    'MB': 2,
-    'GB': 3,
-    'TB': 4
-  };
-
-  precision = (!precision) ? (table[unit] ? table[unit] : 6) : precision;
-  let diff = table[object.unit] - table[unit];
-
-  if (diff < 0) {
-    return {
-      size: (object.size / Math.pow(1000, Math.abs(diff))).toFixed(precision),
-      unit: unit
-    };
-  } else if (diff > 0) {
-    return {
-      size: (object.size * Math.pow(1000, Math.abs(diff))).toFixed(precision),
-      unit: unit
-    };
-  } else {
-    return object;
-  }
-};
-
-/**
- * find the difference between two file sizes
- * @param {Object} object
- * @param {Object} object
- */
-module.exports.subtract = function(object1, object2) {
-  const bytes1 = this.manualConvert(object1, 'B');
-  const bytes2 = this.manualConvert(object2, 'B');
-  let difference = bytes1.size - bytes2.size;
-  return this.autoConvert({ size: difference, unit: 'B' });
-};
-
 /**
  * Recursively determines the size of a directory
  * @param {String} dir - Directory to traverse
  * @param {Function} callback
  */
-module.exports.getDirectorySize = function(dir, callback) {
+exports.getDirectorySize = function(dir, callback) {
+  /* istanbul ignore next */
   du(dir, {
     filter: function(f) {
       return f.indexOf('contracts.db') !== -1 ||
@@ -183,35 +105,35 @@ module.exports.getDirectorySize = function(dir, callback) {
 };
 
 /**
- * get free space on disk of path
+ * Get free space on disk of path
  * @param {String} path
  */
-module.exports.getFreeSpace = function(path, callback) {
-  var self = this;
-
-  if (!this.existsSync(path)) {
+/* istanbul ignore next */
+exports.getFreeSpace = function(path, callback) {
+  if (!exports.existsSync(path)) {
     return callback(null, 0);
   }
 
   diskspace(function(err, result) {
-    /*jshint maxcomplexity:10 */
+    /* jshint maxcomplexity:10 */
     if (err) {
       return callback(err);
     }
 
-    var free = 0;
+    let free = 0;
 
-    for (var disk in result.disks) {
-      var diskDrive = disk;
+    for (let disk in result.disks) {
+      let diskDrive = disk;
 
+      /* istanbul ignore if */
       if (process.platform === 'win32') {
         diskDrive += ':\\';
       }
 
-      if (self.existsSync(diskDrive)) {
+      if (exports.existsSync(diskDrive)) {
         if (fs.statSync(path).dev === fs.statSync(diskDrive).dev) {
-          // The `df` command on linux returns KB by default, so we need to
-          // convert to bytes.
+          // NB: The `df` command on gnu+linux returns KB by default
+          // NB: so we need to convert to bytes.
           free = process.platform === 'win32' ?
                  result.disks[disk].free :
                  result.disks[disk].free * 1000;
@@ -223,17 +145,3 @@ module.exports.getFreeSpace = function(path, callback) {
   });
 };
 
-exports.getLastLines = function(filename, lines, callback) {
-  let chunk = '';
-  let size = Math.max(0, fs.statSync(filename).size - (lines * 200));
-
-  fs.createReadStream(filename, { start: size })
-    .on('data', function(data) {
-      chunk += data.toString();
-    })
-    .on('end', function() {
-      chunk = chunk.split('\n').slice(-(lines + 1));
-      chunk.pop();
-      callback(chunk);
-    });
-};

package.json

@@ -40,6 +40,7 @@
   },
   "homepage": "https://github.com/storj/storjshare-daemon#readme",
   "dependencies": {
+    "bytes": "^2.4.0",
     "cli-table": "^0.3.1",
     "colors": "^1.1.2",
     "commander": "^2.9.0",

script/farmer.js

@@ -6,11 +6,9 @@ const utils = require('../lib/utils');
 const storj = require('storj-lib');
 const Logger = require('kad-logger-json');
 const config = JSON.parse(JSON.stringify(require('../lib/config/farmer')));
+const bytes = require('bytes');
 
-let spaceAllocation = storj.utils.toNumberBytes(
-  config.storageAllocationSize,
-  config.storageAllocationUnit
-);
+let spaceAllocation = bytes.parse(config.storageAllocation);
 let farmerState = {
   percentUsed: '...',
   totalPeers: 0,