New: race option (fixes #42)

mysticatea · mysticatea · commit c24d1718eca3 · 2016-06-25T23:34:16.000+09:00
diff --git a/docs/node-api.md b/docs/node-api.md
@@ -58,6 +58,10 @@ Run npm-scripts.
   - **options.printName** `boolean` --
     Set the flag to print the task name before running each task.
     Default is `false`.
+  - **options.race** `boolean` --
+    Set the flag to kill all npm-scripts when a npm-script finished with zero.
+    This option is valid only with `options.parallel` option.
+    Default is `false`.
   - **options.silent** `boolean` --
     The flag to set `silent` to the log level of npm.
     Default is `false`.
diff --git a/docs/npm-run-all.md b/docs/npm-run-all.md
@@ -44,6 +44,9 @@ Options:
     -p, --parallel <tasks>   - Run a group of tasks in parallel.
                                e.g. 'npm-run-all -p foo bar' is similar to
                                     'npm run foo & npm run bar'.
+    -r, --race   - - - - - - - Set the flag to kill all tasks when a task
+                               finished with zero. This option is valid only
+                               with 'parallel' option.
     -s, --sequential <tasks> - Run a group of tasks sequentially.
         --serial <tasks>       e.g. 'npm-run-all -s foo bar' is similar to
                                     'npm run foo && npm run bar'.
diff --git a/docs/run-p.md b/docs/run-p.md
@@ -40,6 +40,8 @@ Options:
                                coloring their output if this option was given.
     -n, --print-name   - - - - Set the flag to print the task name before
                                running each task.
+    -r, --race   - - - - - - - Set the flag to kill all tasks when a task
+                               finished with zero.
     -s, --silent   - - - - - - Set 'silent' to the log level of npm.
 
     Shorthand aliases can be combined.
diff --git a/src/bin/common/parse-cli-args.js b/src/bin/common/parse-cli-args.js
@@ -19,7 +19,7 @@ const assign = require("object-assign")
 
 const OVERWRITE_OPTION = /^--([^:]+?):([^=]+?)(?:=(.+))?$/
 const CONFIG_PATTERN = /^npm_package_config_(.+)$/
-const CONCAT_OPTIONS = /^-[clnps]+$/
+const CONCAT_OPTIONS = /^-[clnprs]+$/
 
 /**
  * Overwrites a specified package config.
@@ -86,6 +86,7 @@ class ArgumentSet {
         this.groups = []
         this.printLabel = false
         this.printName = false
+        this.race = false
         this.rest = []
         this.silent = process.env.npm_config_loglevel === "silent"
         this.singleMode = Boolean(options.singleMode)
@@ -100,6 +101,13 @@ class ArgumentSet {
     get lastGroup() {
         return this.groups[this.groups.length - 1]
     }
+
+    /**
+     * Gets "parallel" flag.
+     */
+    get parallel() {
+        return this.groups.some(g => g.parallel)
+    }
 }
 
 /**
@@ -134,6 +142,11 @@ function parseCLIArgsCore(set, args) {    // eslint-disable-line complexity
                 set.printName = true
                 break
 
+            case "-r":
+            case "--race":
+                set.race = true
+                break
+
             case "--silent":
                 set.silent = true
                 break
@@ -192,6 +205,12 @@ function parseCLIArgsCore(set, args) {    // eslint-disable-line complexity
         }
     }
 
+    if (!set.parallel && set.race) {
+        throw new Error(`Invalid Option: ${
+            args.indexOf("--race") !== -1 ? "race" : "r"
+        } (without parallel)`)
+    }
+
     return set
 }
 
diff --git a/src/bin/npm-run-all/help.js b/src/bin/npm-run-all/help.js
@@ -45,6 +45,9 @@ Options:
     -p, --parallel <tasks>   - Run a group of tasks in parallel.
                                e.g. 'npm-run-all -p foo bar' is similar to
                                     'npm run foo & npm run bar'.
+    -r, --race   - - - - - - - Set the flag to kill all tasks when a task
+                               finished with zero. This option is valid only
+                               with 'parallel' option.
     -s, --sequential <tasks> - Run a group of tasks sequentially.
         --serial <tasks>       e.g. 'npm-run-all -s foo bar' is similar to
                                     'npm run foo && npm run bar'.
diff --git a/src/bin/npm-run-all/main.js b/src/bin/npm-run-all/main.js
@@ -36,6 +36,7 @@ module.exports = function npmRunAll(args, stdout, stderr) {
             printLabel,
             printName,
             silent,
+            race,
             rest,
         } = parseCLIArgs(args)
 
@@ -57,6 +58,7 @@ module.exports = function npmRunAll(args, stdout, stderr) {
                         packageConfig,
                         silent,
                         arguments: rest,
+                        race,
                     }
                 ))
             },
diff --git a/src/bin/run-p/help.js b/src/bin/run-p/help.js
@@ -42,6 +42,8 @@ Options:
                                coloring their output if this option was given.
     -n, --print-name   - - - - Set the flag to print the task name before
                                running each task.
+    -r, --race   - - - - - - - Set the flag to kill all tasks when a task
+                               finished with zero.
     -s, --silent   - - - - - - Set 'silent' to the log level of npm.
 
     Shorthand aliases can be combined.
diff --git a/src/bin/run-p/main.js b/src/bin/run-p/main.js
@@ -36,6 +36,7 @@ module.exports = function npmRunAll(args, stdout, stderr) {
             printLabel,
             printName,
             silent,
+            race,
             rest,
         } = parseCLIArgs(args, {parallel: true}, {singleMode: true})
 
@@ -56,6 +57,7 @@ module.exports = function npmRunAll(args, stdout, stderr) {
                 packageConfig,
                 silent,
                 arguments: rest,
+                race,
             }
         )
     }
diff --git a/src/lib/index.js b/src/lib/index.js
@@ -186,6 +186,7 @@ module.exports = function npmRunAll(
         printLabel = false,
         printName = false,
         arguments: args = [],
+        race = false,
     } = {}
 ) {
     try {
@@ -232,6 +233,7 @@ module.exports = function npmRunAll(
                     },
                     printName,
                     packageInfo,
+                    race,
                 })
             })
     }
diff --git a/src/lib/run-tasks-in-parallel.js b/src/lib/run-tasks-in-parallel.js
@@ -38,30 +38,41 @@ module.exports = function runTasksInParallel(tasks, options) {
      * @returns {void}
      */
     function abortTasks() {
-        if (!aborted && !options.continueOnError) {
-            aborted = true
-            taskPromises.forEach(t => t.abort())
-        }
+        aborted = true
+        taskPromises.forEach(t => t.abort())
     }
 
     // When one of tasks exited with non-zero, abort all tasks.
     // And wait for all tasks exit.
     let errorResult = null
     const parallelPromise = Promise.all(taskPromises.map((promise, index) =>
         promise.then(result => {
-            // Save the result.
-            if (!aborted) {
-                results[index].code = result.code
+            if (aborted) {
+                return
             }
 
+            // Save the result.
+            results[index].code = result.code
+
             // Aborts all tasks if it's an error.
             if (errorResult == null && result.code) {
                 errorResult = errorResult || result
+                if (!options.continueOnError) {
+                    abortTasks()
+                }
+            }
+
+            // Aborts all tasks if options.race is true.
+            if (options.race && !result.code) {
                 abortTasks()
             }
         })
     ))
-    parallelPromise.catch(abortTasks)
+    parallelPromise.catch(() => {
+        if (!aborted && !options.continueOnError) {
+            abortTasks()
+        }
+    })
 
     // Make fail if there are tasks that exited non-zero.
     return parallelPromise.then(() => {
diff --git a/test-workspace/package.json b/test-workspace/package.json
@@ -18,6 +18,7 @@
     "test-task:append:a:c": "node tasks/append.js ac",
     "test-task:append:a:d": "node tasks/append.js ad",
     "test-task:append:b": "node tasks/append.js b",
+    "test-task:append1": "node tasks/append1.js",
     "test-task:append2": "node tasks/append2.js",
     "test-task:error": "node tasks/error.js",
     "test-task:stdout": "node tasks/stdout.js > test.txt",
diff --git a/test-workspace/tasks/append1.js b/test-workspace/tasks/append1.js
@@ -0,0 +1,5 @@
+"use strict"
+
+var appendResult = require("./lib/util").appendResult
+
+appendResult(process.argv[2])
diff --git a/test/fail.js b/test/fail.js
@@ -49,6 +49,11 @@ describe("[fail] it should fail", () => {
         it("npm-run-all command", () => shouldFail(runAll(["--invalid"])))
         it("run-s command", () => shouldFail(runSeq(["--parallel"])))
         it("run-p command", () => shouldFail(runPar(["--sequential"])))
+
+        it("npm-run-all command with --race without --parallel", () => shouldFail(runAll(["--race"])))
+        it("npm-run-all command with --r without --parallel", () => shouldFail(runAll(["--r"])))
+        it("run-s command with --race", () => shouldFail(runSeq(["--race"])))
+        it("run-s command with --r", () => shouldFail(runSeq(["--r"])))
     })
 
     describe("if invalid `options.taskList` is given.", () => {
diff --git a/test/parallel.js b/test/parallel.js
@@ -259,4 +259,41 @@ describe("[parallel]", () => {
                 )
         )
     })
+
+    describe("should abort other tasks when a task finished, when --race option was specified:", () => {
+        it("Node API", () =>
+            nodeApi(["test-task:append1 a", "test-task:append2 b"], {parallel: true, race: true})
+                .then(() => {
+                    assert(result() === "a" || result() === "ab" || result() === "ba")
+                })
+        )
+
+        it("npm-run-all command (--race)", () =>
+            runAll(["--race", "--parallel", "test-task:append1 a", "test-task:append2 b"])
+                .then(() => {
+                    assert(result() === "a" || result() === "ab" || result() === "ba")
+                })
+        )
+
+        it("npm-run-all command (-r)", () =>
+            runAll(["-rp", "test-task:append1 a", "test-task:append2 b"])
+                .then(() => {
+                    assert(result() === "a" || result() === "ab" || result() === "ba")
+                })
+        )
+
+        it("run-p command (--race)", () =>
+            runPar(["--race", "test-task:append1 a", "test-task:append2 b"])
+                .then(() => {
+                    assert(result() === "a" || result() === "ab" || result() === "ba")
+                })
+        )
+
+        it("run-p command (-r)", () =>
+            runPar(["-r", "test-task:append1 a", "test-task:append2 b"])
+                .then(() => {
+                    assert(result() === "a" || result() === "ab" || result() === "ba")
+                })
+        )
+    })
 })

Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,7 @@ module.exports = function npmRunAll(args, stdout, stderr) {`
`36`	`36`	`printLabel,`
`37`	`37`	`printName,`
`38`	`38`	`silent,`
	`39`	`+ race,`
`39`	`40`	`rest,`
`40`	`41`	`} = parseCLIArgs(args, {parallel: true}, {singleMode: true})`
`41`	`42`
`@@ -56,6 +57,7 @@ module.exports = function npmRunAll(args, stdout, stderr) {`
`56`	`57`	`packageConfig,`
`57`	`58`	`silent,`
`58`	`59`	`arguments: rest,`
	`60`	`+ race,`
`59`	`61`	`}`
`60`	`62`	`)`
`61`	`63`	`}`