Merge pull request #710 from WesCossick/fix-sigint-listeners

Fix issues with adding/removing SIGINT listeners
listr2 · Mar 29, 2024 · 5f4bd66 · 5f4bd66
2 parents cc812f0 + 0d30480
commit 5f4bd66
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 3 deletions.
diff --git a/packages/listr2/src/listr.ts b/packages/listr2/src/listr.ts
@@ -34,6 +34,7 @@ export class Listr<
   public rendererClass: ListrRendererFactory
   public rendererClassOptions: ListrGetRendererOptions<ListrGetRendererClassFromValue<Renderer> | ListrGetRendererClassFromValue<FallbackRenderer>>
   public rendererSelection: ListrRendererSelection
+  public boundSignalHandler: () => void
 
   private concurrency: Concurrency
   private renderer: ListrRenderer
@@ -100,7 +101,8 @@ export class Listr<
     // Graceful interrupt for render cleanup
     /* istanbul ignore if */
     if (this.options.registerSignalListeners) {
-      process.once('SIGINT', this.signalHandler.bind(this)).setMaxListeners(0)
+      this.boundSignalHandler = this.signalHandler.bind(this)
+      process.once('SIGINT', this.boundSignalHandler).setMaxListeners(0)
     }
 
     /* istanbul ignore if */
@@ -139,12 +141,12 @@ export class Listr<
 
       this.renderer.end()
 
-      process.removeAllListeners('SIGINT')
+      process.removeListener('SIGINT', this.boundSignalHandler)
     } catch (err: any) {
       if (this.options.exitOnError !== false) {
         this.renderer.end(err)
 
-        process.removeAllListeners('SIGINT')
+        process.removeListener('SIGINT', this.boundSignalHandler)
 
         // Do not exit when explicitly set to `false`
         throw err

diff --git a/packages/listr2/tests/signal-handler.e2e-spec.ts b/packages/listr2/tests/signal-handler.e2e-spec.ts
@@ -80,4 +80,25 @@ describe('signal handlers', () => {
 
     expectProcessOutputToMatchSnapshot(output, 'ACxcRBILlHsqiSxYArjASFdofVqLaUyE')
   })
+
+  it('should not clear other SIGINT listeners', async () => {
+    process.addListener('SIGINT', function doNotRemove () {})
+    expect(process.listeners('SIGINT').map((listener) => listener.name)).toContain('doNotRemove')
+
+    await new Listr(
+      [
+        {
+          title: 'a task',
+          task: async (): Promise<void> => {}
+        }
+      ],
+      {
+        concurrent: false,
+        renderer: 'test',
+        registerSignalListeners: true
+      }
+    ).run()
+
+    expect(process.listeners('SIGINT').map((listener) => listener.name)).toContain('doNotRemove')
+  })
 })