fixed #125 MaxListenersExceededWarning was triggered by gracefulExit …

…handlers added in v3.11.0
npkgz · May 15, 2022 · 33ef015 · 33ef015
1 parent 31692f2
commit 33ef015
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 11 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,9 @@
 ## Branch 3.x ##
 
+### 3.11.1 ###
+
+* Bugfix: `MaxListenersExceededWarning` was triggered by `gracefulExit` handlers added in `v3.11.0` - thanks to [TychoTheTaco on GitHub](https://github.com/npkgz/cli-progress/pull/125)
+
 ### 3.11.0 ###
 
 * Added: `log()` convenience method the multibar to enable custom logging output on top of the progress bars during operation

diff --git a/lib/multi-bar.js b/lib/multi-bar.js
@@ -33,11 +33,8 @@ module.exports = class MultiBar extends _EventEmitter{
         // logging output buffer
         this.loggingBuffer = [];
 
-        // add handler to restore cursor settings (stop the bar) on SIGINT/SIGTERM ?
-        if (this.options.gracefulExit){
-            process.once('SIGINT', this.stop.bind(this));
-            process.once('SIGTERM', this.stop.bind(this));
-        }
+        // callback used for gracefulExit
+        this.sigintCallback = null;
     }
 
     // add a new bar to the stack
@@ -52,6 +49,13 @@ module.exports = class MultiBar extends _EventEmitter{
         if (this.options.noTTYOutput === false && this.terminal.isTTY() === false){
             return bar;
         }
+
+        // add handler to restore cursor settings (stop the bar) on SIGINT/SIGTERM ?
+        if (this.sigintCallback === null && this.options.gracefulExit){
+            this.sigintCallback = this.stop.bind(this);
+            process.once('SIGINT', this.sigintCallback);
+            process.once('SIGTERM', this.sigintCallback);
+        }
 
         // multiprogress already active ?
         if (!this.isActive){
@@ -170,6 +174,12 @@ module.exports = class MultiBar extends _EventEmitter{
         clearTimeout(this.timer);
         this.timer = null;
 
+        // remove sigint listener
+        if (this.sigintCallback){
+            process.removeListener('SIGINT', this.sigintCallback);
+            process.removeListener('SIGTERM', this.sigintCallback);
+        }
+
         // set flag
         this.isActive = false;
 

diff --git a/lib/single-bar.js b/lib/single-bar.js
@@ -18,11 +18,8 @@ module.exports = class SingleBar extends _GenericBar{
         // update interval
         this.schedulingRate = (this.terminal.isTTY() ? this.options.throttleTime : this.options.notTTYSchedule);
 
-        // add handler to restore cursor settings (stop the bar) on SIGINT/SIGTERM ?
-        if (this.options.gracefulExit){
-            process.once('SIGINT', this.stop.bind(this));
-            process.once('SIGTERM', this.stop.bind(this));
-        }
+        // callback used for gracefulExit
+        this.sigintCallback = null;
     }
 
     // internal render function
@@ -68,6 +65,13 @@ module.exports = class SingleBar extends _GenericBar{
             return;
         }
 
+        // add handler to restore cursor settings (stop the bar) on SIGINT/SIGTERM ?
+        if (this.sigintCallback === null && this.options.gracefulExit){
+            this.sigintCallback = this.stop.bind(this);
+            process.once('SIGINT', this.sigintCallback);
+            process.once('SIGTERM', this.sigintCallback);
+        }
+
         // save current cursor settings
         this.terminal.cursorSave();
 
@@ -94,6 +98,12 @@ module.exports = class SingleBar extends _GenericBar{
         if (!this.timer) {
             return;
         }
+
+        // remove sigint listener
+        if (this.sigintCallback){
+            process.removeListener('SIGINT', this.sigintCallback);
+            process.removeListener('SIGTERM', this.sigintCallback);
+        }
 
         // trigger final rendering
         this.render();

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "cli-progress",
-    "version": "3.11.0",
+    "version": "3.11.1",
     "description": "easy to use progress-bar for command-line/terminal applications",
     "keywords": [
         "cli",