test: add test for kill child processes on error

Author: iiroj

lib/resolveTaskFn.js

@@ -62,8 +62,10 @@ const interruptExecutionOnError = (ctx, execaChildProcess) => {
     if (ctx.errors.size > 0) {
       clearInterval(loopIntervalId)
 
-      const ids = await pidTree(execaChildProcess.pid)
-      ids.forEach((id) => process.kill(id))
+      const childPids = await pidTree(execaChildProcess.pid)
+      for (const pid of childPids) {
+        process.kill(pid)
+      }
 
       // The execa process is killed separately in order
       // to get the `KILLED` status.

test/resolveTaskFn.spec.js

@@ -1,14 +1,19 @@
 import execa from 'execa'
+import pidTree from 'pidtree'
 
 import { resolveTaskFn } from '../lib/resolveTaskFn'
 import { getInitialState } from '../lib/state'
 import { TaskError } from '../lib/symbols'
 
 import { createExecaReturnValue } from './utils/createExecaReturnValue'
 
+jest.useFakeTimers()
+
+jest.mock('pidtree', () => jest.fn(async () => []))
+
 const defaultOpts = { files: ['test.js'] }
 
-function mockExecaImplementationOnce(value) {
+const mockExecaImplementationOnce = (value) => {
   execa.mockImplementationOnce(() => createExecaReturnValue(value))
 }
 
@@ -350,6 +355,52 @@ describe('resolveTaskFn', () => {
 
     context.errors.add({})
 
+    jest.runAllTimers()
+
     await expect(taskPromise).rejects.toThrowErrorMatchingInlineSnapshot(`"node [KILLED]"`)
   })
+
+  it('should also kill child processes of killed execa processes', async () => {
+    expect.assertions(3)
+
+    execa.mockImplementationOnce(() =>
+      createExecaReturnValue(
+        {
+          stdout: 'a-ok',
+          stderr: '',
+          code: 0,
+          cmd: 'mock cmd',
+          failed: false,
+          killed: false,
+          signal: null,
+        },
+        1000
+      )
+    )
+
+    const realKill = process.kill
+    const mockKill = jest.fn()
+    Object.defineProperty(process, 'kill', {
+      value: mockKill,
+    })
+
+    pidTree.mockImplementationOnce(() => ['1234'])
+
+    const taskFn = resolveTaskFn({ command: 'node' })
+
+    const context = getInitialState()
+    const taskPromise = taskFn(context)
+
+    context.errors.add({})
+    jest.runAllTimers()
+
+    await expect(taskPromise).rejects.toThrowErrorMatchingInlineSnapshot(`"node [KILLED]"`)
+
+    expect(mockKill).toHaveBeenCalledTimes(1)
+    expect(mockKill).toHaveBeenCalledWith('1234')
+
+    Object.defineProperty(process, 'kill', {
+      value: realKill,
+    })
+  })
 })