child_process: allow promisified exec to be cancel

Using new experimental AbortController, add support for promisified exec to be cancelled.
nodejs · metcoder95 · Jul 7, 2020 · Jul 13, 2020 · Oct 23, 2020 · Oct 23, 2020
commit eed3f17252f0da5a823e6a68d6e4a1a656a2d44a
diff --git a/lib/child_process.js b/lib/child_process.js
@@ -49,13 +49,20 @@ const {
   convertToValidSignal,
   getSystemErrorName
 } = require('internal/util');
+
 const { isArrayBufferView } = require('internal/util/types');
 let debug = require('internal/util/debuglog').debuglog(
   'child_process',
   (fn) => {
     debug = fn;
   }
 );
+let DOMException;
+function lazyDOMException(message) {
+  if (DOMException === undefined)
+    DOMException = internalBinding('messaging').DOMException;
+  return new DOMException(message);
+}
 const { Buffer } = require('buffer');
 const { Pipe, constants: PipeConstants } = internalBinding('pipe_wrap');
 
@@ -183,15 +190,38 @@ function exec(command, options, callback) {
 }
 
 const customPromiseExecFunction = (orig) => {
-  return (...args) => {
+  return (file, options = {}) => {
     let resolve;
     let reject;
     const promise = new Promise((res, rej) => {
       resolve = res;
       reject = rej;
     });
 
-    promise.child = orig(...args, (err, stdout, stderr) => {
+    if (options == null || typeof options !== 'object') {
+      return Promise.reject(
+        new ERR_INVALID_ARG_TYPE(
+          'options',
+          'Object',
+          options));
+    }
+
+    const { signal } = options;
+    if (signal == null ||
+        typeof signal !== 'object' ||
+        !('aborted' in signal)) {
+      return Promise.reject(
+        new ERR_INVALID_ARG_TYPE(
+          'options.signal',
+          'AbortSignal',
+          signal));
+    }
+
+    signal.addEventListener('abort', () => {
+      reject(lazyDOMException('AbortError'));
+    }, { once: true });
+
+    promise.child = orig(file, options, (err, stdout, stderr) => {
       if (err !== null) {
         err.stdout = stdout;
         err.stderr = stderr;

diff --git a/test/parallel/test-child-process-exec-abortcontroller-promisified.js b/test/parallel/test-child-process-exec-abortcontroller-promisified.js
@@ -0,0 +1,64 @@
+// Copyright Joyent, Inc. and other Node contributors.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a
+// copy of this software and associated documentation files (the
+// "Software"), to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to permit
+// persons to whom the Software is furnished to do so, subject to the
+// following conditions:
+//
+// The above copyright notice and this permission notice shall be included
+// in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+// USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+'use strict';
+const common = require('../common');
+const assert = require('assert');
+const exec = require('child_process').exec;
+const { promisify } = require('util');
+
+let pwdcommand, dir;
+const execPromisifed = promisify(exec);
+
+if (common.isWindows) {
+  pwdcommand = 'echo %cd%';
+  dir = 'c:\\windows';
+} else {
+  pwdcommand = 'pwd';
+  dir = '/dev';
+}
+
+
+{
+  const ac = new AbortController();
+  const signal = ac.signal;
+  assert.rejects(execPromisifed(pwdcommand, { cwd: dir, signal }), /AbortError/);
+  ac.abort();
+}
+
+{
+  assert.rejects(execPromisifed(pwdcommand, { cwd: dir, signal: {} }), {
+    code: 'ERR_INVALID_ARG_TYPE',
+    name: 'TypeError',
+    message: 'The "options.signal" property must be an ' +
+             'instance of AbortSignal. Received an instance of Object'
+  });
+}
+
+{
+  function signal() {}
+  assert.rejects(execPromisifed(pwdcommand, { cwd: dir, signal }), {
+    code: 'ERR_INVALID_ARG_TYPE',
+    name: 'TypeError',
+    message: 'The "options.signal" property must be an ' +
+             'instance of AbortSignal. Received function signal'
+  });
+}