Fix(@inquirer/core): Add SIGINT handler to make sure the prompt throw an exit error. Fixes #1741 (#1744)

Author: SBoudrias

packages/core/core.test.ts

@@ -492,32 +492,26 @@ describe('createPrompt()', () => {
 
   it('clear timeout when force closing', { timeout: 1000 }, async () => {
     const exitSpy = vi.fn();
-    const prompt = createPrompt(
-      (config: { message: string }, done: (value: string) => void) => {
-        const timeout = useRef<NodeJS.Timeout | undefined>();
-        const cleaned = useRef(false);
-        useKeypress(() => {
-          if (cleaned.current) {
-            expect.unreachable('once cleaned up keypress should not be called');
-          }
-          clearTimeout(timeout.current);
-          timeout.current = setTimeout(() => {}, 1000);
-        });
-
-        exitSpy.mockImplementation(() => {
-          clearTimeout(timeout.current);
-          cleaned.current = true;
-          // We call done explicitly, as onSignalExit is not triggered in this case
-          // But, CTRL+C will trigger rl.close, which should call this effect
-          // This way we can have the promise resolve
-          done('closed');
-        });
-
-        useEffect(() => exitSpy, []);
-
-        return config.message;
-      },
-    );
+    const prompt = createPrompt((config: { message: string }) => {
+      const timeout = useRef<NodeJS.Timeout | undefined>();
+      const cleaned = useRef(false);
+      useKeypress(() => {
+        if (cleaned.current) {
+          expect.unreachable('once cleaned up keypress should not be called');
+        }
+        clearTimeout(timeout.current);
+        timeout.current = setTimeout(() => {}, 1000);
+      });
+
+      exitSpy.mockImplementation(() => {
+        clearTimeout(timeout.current);
+        cleaned.current = true;
+      });
+
+      useEffect(() => exitSpy, []);
+
+      return config.message;
+    });
 
     const { answer, events } = await render(prompt, { message: 'Question' });
 
@@ -526,7 +520,8 @@ describe('createPrompt()', () => {
     // This closes the readline
     events.keypress({ ctrl: true, name: 'c' });
 
-    await expect(answer).resolves.toBe('closed');
+    await expect(answer).rejects.toThrow('User force closed the prompt with SIGINT');
+
     expect(exitSpy).toHaveBeenCalledTimes(1);
   });
 

packages/core/src/lib/create-prompt.ts

@@ -76,6 +76,14 @@ export function createPrompt<Value, Config>(
       }),
     );
 
+    // SIGINT must be explicitly handled by the prompt so the ExitPromptError can be handled.
+    // Otherwise, the prompt will stop and in some scenarios never resolve.
+    // Ref issue #1741
+    const sigint = () =>
+      reject(new ExitPromptError(`User force closed the prompt with SIGINT`));
+    rl.on('SIGINT', sigint);
+    cleanups.add(() => rl.removeListener('SIGINT', sigint));
+
     // Re-renders only happen when the state change; but the readline cursor could change position
     // and that also requires a re-render (and a manual one because we mute the streams).
     // We set the listener after the initial workLoop to avoid a double render if render triggered