@vbarbarosh/node-helpers 3.37.1 → 3.38.0

package/package.json

@@ -2,7 +2,7 @@
     "author": "Vladimir Barbarosh <vladimir.barbarosh@gmail.com>",
     "license": "MIT",
     "name": "@vbarbarosh/node-helpers",
-    "version": "3.37.1",
+    "version": "3.38.0",
     "description": "A set of helpers for JavaScript/Node.js",
     "files": [
         "src"

package/src/fastdl.js

@@ -1,6 +1,6 @@
 const UserFriendlyError = require('./errors/UserFriendlyError');
 const format_bytes = require('./format_bytes');
-const format_progress = require('./format_progress');
+const format_progress_bytes = require('./format_progress_bytes');
 const format_thousands = require('./format_thousands');
 const fs = require('fs');
 const fs_path_basename = require('./fs_path_basename');
@@ -40,7 +40,7 @@ async function fastdl({file, read_stream_with_range, concurrency = 60, user_frie
     const timer = setInterval(tick, 1000);
     function tick() {
         progress.refresh();
-        user_friendly_status(`${format_progress(progress)} connections=${connections}`);
+        user_friendly_status(`${format_progress_bytes(progress)} connections=${connections}`);
     }
 
     user_friendly_status(`${format_bytes(total)} [${format_thousands(total)} bytes] to download`);

package/src/format_bytes.test.js

@@ -16,7 +16,7 @@ const items = [
 describe('format_bytes', function () {
     items.forEach(function ([input, expected]) {
         it(`${input} → ${expected}`, function () {
-            assert.strictEqual(expected, format_bytes(input));
+            assert.strictEqual(format_bytes(input), expected);
         });
     });
 });

package/src/format_kilo.js

@@ -0,0 +1,17 @@
+function format_kilo(num)
+{
+    const sizes = ['', 'K', 'M', 'G', 'T', 'P'];
+    if (typeof num !== 'number' || Number.isNaN(num)) {
+        return 'n/a';
+    }
+    if (!num) {
+        return '0';
+    }
+    if (num < 1000) {
+        return num.toString();
+    }
+    const i = parseInt(Math.floor(Math.log(num) / Math.log(1000)), 10);
+    return `${(num / (1000 ** i)).toFixed(2)}`.replace(/0$/, '').replace(/\.0$/, '') + sizes[i];
+}
+
+module.exports = format_kilo;

package/src/format_kilo.test.js

@@ -0,0 +1,23 @@
+const assert = require('assert');
+const format_kilo = require('./format_kilo');
+
+const items = [
+    ['', 'n/a'],
+    [null, 'n/a'],
+    [undefined, 'n/a'],
+    [0, '0'],
+    [1, '1'],
+    [900, '900'],
+    [1500, '1.5K'],
+    [2000, '2K'],
+    [35.45*1000*1000, '35.45M'],
+    [3.92*1000*1000*1000, '3.92G'],
+];
+
+describe('format_kilo', function () {
+    items.forEach(function ([input, expected]) {
+        it(`${input} → ${expected}`, function () {
+            assert.strictEqual(format_kilo(input), expected);
+        });
+    });
+});

package/src/format_percents.test.js

@@ -16,7 +16,7 @@ const items = [
 describe('format_percents', function () {
     items.forEach(function ([input, expected]) {
         it(`${input} → ${expected}`, function () {
-            assert.strictEqual(expected, format_percents(input));
+            assert.strictEqual(format_percents(input), expected);
         });
     });
 });

package/src/{format_progress.js → format_progress_bytes.js}

@@ -3,7 +3,7 @@ const format_percents = require('./format_percents');
 const format_seconds = require('./format_seconds');
 const is_number_gt = require('./is_number_gt');
 
-function format_progress({percents, total, done, rate, eta, duration})
+function format_progress_bytes({percents, total, done, rate, eta, duration})
 {
     const bps = is_number_gt(rate, 0) ? `${format_bytes(rate)}/s` : '~';
     if (done > total) {
@@ -22,4 +22,4 @@ function format_progress({percents, total, done, rate, eta, duration})
     return '~';
 }
 
-module.exports = format_progress;
+module.exports = format_progress_bytes;

package/src/{format_progress.test.js → format_progress_bytes.test.js}

@@ -1,5 +1,5 @@
 const assert = require('assert');
-const format_progress = require('./format_progress');
+const format_progress_bytes = require('./format_progress_bytes');
 
 const items = [
     ['~', {percents: 0, total: 0, done: 0, rate: 0, eta: 0, duration: 0}],
@@ -10,10 +10,10 @@ const items = [
     ['15.0MB at 10.0MB/s duration=00:00:01', {percents: 5.2525, total: 5*1024*1024, done: 15*1024*1024, rate: 10*1024*1024, eta: 5, duration: 1}],
 ];
 
-describe('format_progress', function () {
+describe('format_progress_bytes', function () {
     items.forEach(function ([expected, input]) {
         it(expected, function () {
-            assert.strictEqual(format_progress(input), expected);
+            assert.strictEqual(format_progress_bytes(input), expected);
         });
     });
 });

package/src/format_progress_kilo.js

@@ -0,0 +1,25 @@
+const format_kilo = require('./format_kilo');
+const format_percents = require('./format_percents');
+const format_seconds = require('./format_seconds');
+const is_number_gt = require('./is_number_gt');
+
+function format_progress_kilo({percents, total, done, rate, eta, duration})
+{
+    const speed = is_number_gt(rate, 0) ? `${format_kilo(rate)}/s` : '~';
+    if (done > total) {
+        return `${format_kilo(done)} at ${speed} duration=${format_seconds(duration)}`;
+    }
+    if (is_number_gt(total, 0)) {
+        const eta_str = is_number_gt(eta, 0) ? format_seconds(eta) : '~';
+        return `${format_percents(percents)} | ${format_kilo(done)} of ${format_kilo(total)} at ${speed} ETA ${eta_str} duration=${format_seconds(duration)}`;
+    }
+    if (is_number_gt(done, 0)) {
+        return `${format_kilo(done)} of ~ at ${speed} duration=${format_seconds(duration)}`;
+    }
+    if (is_number_gt(duration, 0)) {
+        return `~ duration=${format_seconds(duration)}`;
+    }
+    return '~';
+}
+
+module.exports = format_progress_kilo;

package/src/format_progress_kilo.test.js

@@ -0,0 +1,19 @@
+const assert = require('assert');
+const format_progress_kilo = require('./format_progress_kilo');
+
+const items = [
+    ['~', {percents: 0, total: 0, done: 0, rate: 0, eta: 0, duration: 0}],
+    ['~ duration=00:00:01', {percents: 0, total: 0, done: 0, rate: 0, eta: 0, duration: 1}],
+    ['25.25% | 5M of 15M at ~ ETA ~ duration=00:00:01', {percents: 0.2525, total: 15*1000*1000, done: 5*1000*1000, rate: 0, eta: 0, duration: 1}],
+    ['25.25% | 5M of 15M at 10M/s ETA 00:00:05 duration=00:00:01', {percents: 0.2525, total: 15*1000*1000, done: 5*1000*1000, rate: 10*1000*1000, eta: 5, duration: 1}],
+    // edge case: done > total
+    ['15M at 10M/s duration=00:00:01', {percents: 5.2525, total: 5*1000*1000, done: 15*1000*1000, rate: 10*1000*1000, eta: 5, duration: 1}],
+];
+
+describe('format_progress_kilo', function () {
+    items.forEach(function ([expected, input]) {
+        it(expected, function () {
+            assert.strictEqual(format_progress_kilo(input), expected);
+        });
+    });
+});

package/src/format_seconds.test.js

@@ -36,7 +36,7 @@ const items = [
 describe('format_seconds', function () {
     items.forEach(function ([expected, ...args]) {
         it(`${args} → ${expected}`, function () {
-            assert.strictEqual(expected, format_seconds(...args));
+            assert.strictEqual(format_seconds(...args), expected);
         });
     });
 });

package/src/format_thousands.test.js

@@ -22,7 +22,7 @@ const items = [
 describe('format_thousands', function () {
     items.forEach(function ([expected, ...args]) {
         it(`${args} → ${expected}`, function () {
-            assert.strictEqual(expected, format_thousands(...args));
+            assert.strictEqual(format_thousands(...args), expected);
         });
     });
 });

package/src/stream_progress.js

@@ -1,4 +1,4 @@
-const format_progress = require('./format_progress');
+const format_progress_bytes = require('./format_progress_bytes');
 const make_progress = require('./make_progress');
 const stream = require('stream');
 
@@ -33,7 +33,7 @@ function stream_progress({objectMode = false, total, user_friendly_status = s =>
     });
     function tick() {
         progress.update(done);
-        user_friendly_status(format_progress(progress));
+        user_friendly_status(format_progress_bytes(progress));
     }
 }