🐛 fix signal handling (#171)

Author: wyattjoh

lib/run-task.js

@@ -189,9 +189,9 @@ module.exports = function runTask(task, options) {
             cp = null
             reject(err)
         })
-        cp.on("close", (code) => {
+        cp.on("close", (code, signal) => {
             cp = null
-            resolve({ task, code })
+            resolve({ task, code, signal })
         })
     })
 

lib/run-tasks.js

@@ -32,6 +32,39 @@ function remove(array, x) {
     }
 }
 
+const signals = {
+    SIGABRT: 6,
+    SIGALRM: 14,
+    SIGBUS: 10,
+    SIGCHLD: 20,
+    SIGCONT: 19,
+    SIGFPE: 8,
+    SIGHUP: 1,
+    SIGILL: 4,
+    SIGINT: 2,
+    SIGKILL: 9,
+    SIGPIPE: 13,
+    SIGQUIT: 3,
+    SIGSEGV: 11,
+    SIGSTOP: 17,
+    SIGTERM: 15,
+    SIGTRAP: 5,
+    SIGTSTP: 18,
+    SIGTTIN: 21,
+    SIGTTOU: 22,
+    SIGUSR1: 30,
+    SIGUSR2: 31,
+}
+
+/**
+ * Converts a signal name to a number.
+ * @param {string} signal - the signal name to convert into a number
+ * @returns {number} - the return code for the signal
+ */
+function convert(signal) {
+    return signals[signal] || 0
+}
+
 //------------------------------------------------------------------------------
 // Public Interface
 //------------------------------------------------------------------------------
@@ -133,6 +166,15 @@ module.exports = function runTasks(tasks, options) {
                         originalOutputStream.write(writer.toString())
                     }
 
+                    // Check if the task failed as a result of a signal, and
+                    // amend the exit code as a result.
+                    if (result.code === null && result.signal !== null) {
+                        // An exit caused by a signal must return a status code
+                        // of 128 plus the value of the signal code.
+                        // Ref: https://nodejs.org/api/process.html#process_exit_codes
+                        result.code = 128 + convert(result.signal)
+                    }
+
                     // Save the result.
                     results[task.index].code = result.code
 

test-workspace/package.json

@@ -26,6 +26,7 @@
     "test-task:append:b": "node tasks/append2.js b",
     "test-task:append1": "node tasks/append1.js",
     "test-task:append2": "node tasks/append2.js",
+    "test-task:abort": "node tasks/abort.js",
     "test-task:error": "node tasks/error.js",
     "test-task:stdout": "node tasks/stdout.js > test.txt",
     "test-task:stderr": "node tasks/stderr.js 2> test.txt",

test-workspace/tasks/abort.js

@@ -0,0 +1,5 @@
+"use strict"
+
+setTimeout(() => {
+    process.abort()
+}, 500)

test/fail.js

@@ -101,4 +101,20 @@ describe("[fail] it should fail", () => {
         it("run-s command", () => shouldFail(runSeq(["test-task:error"])))
         it("run-p command", () => shouldFail(runPar(["test-task:error"])))
     })
+
+    describe("if tasks exited via a signal:", () => {
+        it("Node API", () => shouldFail(nodeApi("test-task:abort")))
+        it("npm-run-all command", () => shouldFail(runAll(["test-task:abort"])))
+        it("run-s command", () => shouldFail(runSeq(["test-task:abort"])))
+        it("run-p command", () => shouldFail(runPar(["test-task:abort"])))
+        it("with correct exit code", () => nodeApi("test-task:abort").then(() =>
+            assert(false, "should fail")
+        ).catch(err => {
+            // In NodeJS versions > 6, the child process correctly sends back
+            // the signal + code of null. In NodeJS versions <= 6, the child
+            // process does not set the signal, and sets the code to 1.
+            const code = Number(process.version.match(/^v(\d+)/)[1]) > 6 ? 134 : 1
+            assert(err.code === code, "should have correct exit code")
+        }))
+    })
 })