child_process: support Symbol.dispose

PR-URL: #48551 Reviewed-By: Robert Nagy <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
nodejs · Jul 13, 2023 · 4e08160 · 4e08160
1 parent e2d0195
commit 4e08160
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 0 deletions.
diff --git a/doc/api/child_process.md b/doc/api/child_process.md
@@ -1402,6 +1402,16 @@ setTimeout(() => {
 }, 2000);
 ```
 
+### `subprocess[Symbol.dispose]()`
+
+<!-- YAML
+added: REPLACEME
+-->
+
+> Stability: 1 - Experimental
+
+Calls [`subprocess.kill()`][] with `'SIGTERM'`.
+
 ### `subprocess.killed`
 
 <!-- YAML

diff --git a/lib/internal/child_process.js b/lib/internal/child_process.js
@@ -12,6 +12,7 @@ const {
   ReflectApply,
   StringPrototypeSlice,
   Symbol,
+  SymbolDispose,
   Uint8Array,
 } = primordials;
 
@@ -516,6 +517,12 @@ ChildProcess.prototype.kill = function(sig) {
   return false;
 };
 
+ChildProcess.prototype[SymbolDispose] = function() {
+  if (!this.killed) {
+    this.kill();
+  }
+};
+
 
 ChildProcess.prototype.ref = function() {
   if (this._handle) this._handle.ref();

diff --git a/test/parallel/test-child-process-destroy.js b/test/parallel/test-child-process-destroy.js
@@ -0,0 +1,25 @@
+'use strict';
+const common = require('../common');
+const assert = require('assert');
+const spawn = require('child_process').spawn;
+const cat = spawn(common.isWindows ? 'cmd' : 'cat');
+
+cat.stdout.on('end', common.mustCall());
+cat.stderr.on('data', common.mustNotCall());
+cat.stderr.on('end', common.mustCall());
+
+cat.on('exit', common.mustCall((code, signal) => {
+  assert.strictEqual(code, null);
+  assert.strictEqual(signal, 'SIGTERM');
+  assert.strictEqual(cat.signalCode, 'SIGTERM');
+}));
+cat.on('exit', common.mustCall((code, signal) => {
+  assert.strictEqual(code, null);
+  assert.strictEqual(signal, 'SIGTERM');
+  assert.strictEqual(cat.signalCode, 'SIGTERM');
+}));
+
+assert.strictEqual(cat.signalCode, null);
+assert.strictEqual(cat.killed, false);
+cat[Symbol.dispose]();
+assert.strictEqual(cat.killed, true);