Bugifx: synchronous update may cause unexpected behaviour on multibars

CHANGES.md

@@ -1,5 +1,11 @@
 ## Branch 3.x ##
 
+### 3.3.1 ###
+
+* Bugifx: synchronous update may cause unexpected behaviour on multibars - limited to single bars
+* Changed: renamed internal eta `push()` method to `update()`
+* Changed: moved internal eta calculation call into `update()`
+
 ### 3.3.0 ###
 
 * Added: option to pass custom formatters as callback via `options.format`

README.md

@@ -216,7 +216,7 @@ The following options can be changed
 - `hideCursor` (type:boolean) - hide the cursor during progress operation; restored on complete (default: false) - pass `null` to keep terminal settings
 - `linewrap` (type:boolean) - disable line wrapping (default: false) - pass `null` to keep terminal settings; pass `true` to add linebreaks automatically (not recommended)
 - `etaBuffer` (type:int) - number of updates with which to calculate the eta; higher numbers give a more stable eta (default: 10)
-- `synchronousUpdate` (type:boolean) - trigger redraw during `update()` in case threshold time x2 is exceeded (default: true)
+- `synchronousUpdate` (type:boolean) - trigger redraw during `update()` in case threshold time x2 is exceeded (default: true) - limited to single bar usage
 - `noTTYOutput` (type:boolean) - enable scheduled output to notty streams - e.g. redirect to files (default: false)
 - `notTTYSchedule` (type:int) - set the output schedule/interval for notty output in `ms` (default: 2000ms)
 - `emptyOnZero` (type:boolean) - display progress bars with 'total' of zero(0) as empty, not full (default: false)

lib/eta.js

@@ -4,7 +4,7 @@ class ETA{
 
     constructor(length, initTime, initValue){
         // size of eta buffer
-        this.etaBufferLength = length || 10;
+        this.etaBufferLength = length || 100;
 
         // eta buffer with initial values
         this.valueBuffer = [initValue];
@@ -15,9 +15,12 @@ class ETA{
     }
 
     // add new values to calculation buffer
-    push(time, value){
+    update(time, value, total){
         this.valueBuffer.push(value);
         this.timeBuffer.push(time);
+
+        // trigger recalculation
+        this.calculate(total-value);
     }
 
     // fetch estimated time

lib/generic-bar.js

@@ -115,25 +115,15 @@ module.exports = class GenericBar{
         // update value
         this.value = current;
 
-        // add new value
-        this.eta.push(Date.now(), current);
+        // add new value; recalculate eta
+        this.eta.update(Date.now(), current, this.total);
 
         // merge payload
         const payloadData = payload || {};
         for (const key in payloadData){
             this.payload[key] = payloadData[key];
         }
 
-        // number of remaining elements required for calculation
-        this.eta.calculate(this.total-this.value);
-
-        // trigger synchronous update ?
-        // check for throttel time 
-        if (this.options.synchronousUpdate && (this.lastRedraw + this.options.throttleTime*2) < Date.now()){
-            // force update
-            this.render();
-        }
-
         // limit reached ? autostop set ?
         if (this.value >= this.getTotal() && this.options.stopOnComplete) {
             this.stop();

lib/single-bar.js

@@ -46,6 +46,13 @@ module.exports = class SingleBar extends _GenericBar{
         }
 
         super.update(current, payload);
+
+        // trigger synchronous update ?
+        // check for throttel time 
+        if (this.options.synchronousUpdate && (this.lastRedraw + this.options.throttleTime*2) < Date.now()){
+            // force update
+            this.render();
+        }
     }
 
     // start the progress bar

package.json

@@ -1,6 +1,6 @@
 {
     "name": "cli-progress",
-    "version": "3.3.0",
+    "version": "3.3.1",
     "description": "easy to use progress-bar for command-line/terminal applications",
     "keywords": [
         "cli",