fix: handle script terminations using e.g. ctrl + c (#127)

Author: tobiasbueschel

cli.test.js

@@ -19,6 +19,19 @@ vi.mock('meow', () => ({
   }))
 }))
 
+// Ensure process.exit is mocked to prevent accidental exits during CLI import
+let exitSpy
+
+beforeEach(() => {
+  exitSpy = vi.spyOn(process, 'exit').mockImplementation((code) => {
+    throw new Error(`process.exit unexpectedly called with "${code}"`)
+  })
+})
+
+afterEach(() => {
+  exitSpy.mockRestore()
+})
+
 describe('CLI', () => {
   beforeEach(() => {
     vi.resetModules()

index.js

@@ -3,7 +3,9 @@ import chalk from 'chalk'
 import open from 'open'
 import branch from 'git-branch'
 import GitUrlParse from 'git-url-parse'
-import { exec, which } from 'shelljs'
+import shell from 'shelljs'
+
+const { exec, which } = shell
 const { exit } = process
 const { log } = console
 
@@ -65,6 +67,26 @@ async function gitPushPR(options) {
 
   const child = exec(gitPushStr, { async: true, silent: true })
 
+  // Accumulate stderr so we can parse a PR URL for unknown git hosts
+  let stderrBuffer = ''
+
+  // Gracefully handle user aborts (e.g., Ctrl+C)
+  let aborted = false
+  const handleAbort = () => {
+    if (aborted) return
+    aborted = true
+    try {
+      if (child && typeof child.kill === 'function') {
+        child.kill('SIGINT')
+      }
+    } catch {
+      // Best-effort kill; ignore errors here
+    }
+  }
+  process.once('SIGINT', handleAbort)
+  process.once('SIGTERM', handleAbort)
+  process.once('SIGHUP', handleAbort)
+
   // Stream stdout in real-time
   child.stdout.on('data', (data) => {
     if (!options.silent && spinner) {
@@ -76,6 +98,7 @@ async function gitPushPR(options) {
 
   // Stream stderr in real-time
   child.stderr.on('data', (data) => {
+    stderrBuffer += data.toString()
     if (!options.silent && spinner) {
       spinner.clear()
       log(data.toString().trimEnd())
@@ -84,6 +107,22 @@ async function gitPushPR(options) {
   })
 
   child.on('exit', async (code) => {
+    // Clean up listeners on any exit
+    process.off('SIGINT', handleAbort)
+    process.off('SIGTERM', handleAbort)
+    process.off('SIGHUP', handleAbort)
+
+    // If user aborted, show a friendly message and exit
+    if (aborted) {
+      if (!options.silent && spinner) {
+        spinner.fail(chalk.yellow('[git-push-pr]: aborted by user'))
+      } else {
+        log(chalk.yellow('[git-push-pr]: aborted by user'))
+      }
+      // Do not forcefully exit; allow Node to exit naturally after cleanup
+      return
+    }
+
     // 6. Stop if git push failed for some reason
     if (code !== 0) {
       if (!options.silent && spinner) {
@@ -108,7 +147,7 @@ async function gitPushPR(options) {
 
     // 9. Create a Pull Request
     const { stdout: remoteUrl } = exec(`git remote get-url ${options.remote}`, { silent: true })
-    const pullRequestUrl = getPullRequestUrl(remoteUrl, currentBranch, child.stderr || '')
+    const pullRequestUrl = getPullRequestUrl(remoteUrl, currentBranch, stderrBuffer)
     await open(pullRequestUrl)
 
     // 10. Mark PR creation as successful

index.test.js

@@ -17,43 +17,54 @@ vi.mock('open', () => ({
 }))
 
 vi.mock('shelljs', () => ({
-  exec: vi.fn().mockImplementation((cmd, options, callback) => {
-    if (cmd.includes('git remote get-url')) {
-      return { stdout: 'https://github.com/user/repo.git' }
-    }
+  default: {
+    exec: vi.fn().mockImplementation((cmd, options, callback) => {
+      if (cmd.includes('git remote get-url')) {
+        return { stdout: 'https://github.com/user/repo.git' }
+      }
 
-    // Handle async exec for git push
-    if (options && options.async) {
-      const mockChild = {
-        stdout: {
+      // Handle async exec for git push
+      if (options && options.async) {
+        // Create a mock child process that can be killed and emits exit afterwards
+        let killed = false
+        const listeners = { exit: [] }
+        const mockChild = {
+          stdout: {
+            on: vi.fn((event, handler) => {
+              if (event === 'data') {
+                setTimeout(() => handler(Buffer.from('Everything up-to-date\n')), 10)
+              }
+            })
+          },
+          stderr: {
+            on: vi.fn((event, handler) => {
+              // no stderr by default
+            })
+          },
           on: vi.fn((event, handler) => {
-            if (event === 'data') {
-              // Simulate some stdout data
-              setTimeout(() => handler(Buffer.from('Everything up-to-date\n')), 10)
+            if (event === 'exit') {
+              listeners.exit.push(handler)
+              // Simulate successful exit after a short delay unless killed
+              setTimeout(() => {
+                const code = killed ? 1 : 0
+                listeners.exit.forEach((cb) => cb(code))
+              }, 20)
             }
+          }),
+          kill: vi.fn(() => {
+            killed = true
           })
-        },
-        stderr: {
-          on: vi.fn((event, handler) => {
-            // No stderr by default
-          })
-        },
-        on: vi.fn((event, handler) => {
-          if (event === 'exit') {
-            // Simulate successful exit
-            setTimeout(() => handler(0), 20)
-          }
-        })
+        }
+        return mockChild
       }
-      return mockChild
-    }
 
-    if (callback) {
-      callback(0, 'success', '')
-    }
-    return { code: 0, stdout: 'success', stderr: '' }
-  }),
-  which: vi.fn().mockReturnValue(true)
+      if (callback) {
+        callback(0, 'success', '')
+      }
+      return { code: 0, stdout: 'success', stderr: '' }
+    }),
+    which: vi.fn().mockReturnValue(true)
+  }
 }))
 
 vi.mock('git-branch', () => ({
@@ -66,7 +77,8 @@ console.log = vi.fn()
 import ora from 'ora'
 import open from 'open'
 import gitPushPR, { getPullRequestUrl } from './index.js'
-import { exec, which } from 'shelljs'
+import shell from 'shelljs'
+const { exec, which } = shell
 import branch from 'git-branch'
 
 let exitSpy
@@ -161,6 +173,21 @@ describe('gitPushPR', () => {
     await promise
   })
 
+  it('should gracefully abort on SIGINT (Ctrl+C)', async () => {
+    // Start the process
+    const promise = gitPushPR({ remote: 'origin' })
+
+    // Emit SIGINT shortly after to simulate Ctrl+C
+    setTimeout(() => process.emit('SIGINT'), 5)
+
+    // Wait to allow the mocked child to exit and our handler to run
+    await new Promise((resolve) => setTimeout(resolve, 200))
+
+    // Since we no longer call process.exit on abort, just assert no PR was opened and spinner failed path was taken
+    expect(open).not.toHaveBeenCalled()
+    await promise
+  })
+
   const expectExitWithError = async (fn) => {
     let error
     try {