Skip to content

Commit 70ad9bb

Browse files
bmeckbnoordhuis
authored andcommitted
child_process: make fork() execPath configurable
Allows for arbitrary path to executable spawned using `fork`. This fixes some issues around running multiple versions of node with workers and allows arbitrary IPC with compatible executables. Fixes #3248.
1 parent 3f76419 commit 70ad9bb

File tree

3 files changed

+67
-1
lines changed

3 files changed

+67
-1
lines changed

doc/api/child_process.markdown

+7
Original file line numberDiff line numberDiff line change
@@ -516,6 +516,7 @@ leaner than `child_process.exec`. It has the same options.
516516
* `cwd` {String} Current working directory of the child process
517517
* `env` {Object} Environment key-value pairs
518518
* `encoding` {String} (Default: 'utf8')
519+
* `execPath` {String} Executable used to create the child process
519520
* Return: ChildProcess object
520521

521522
This is a special case of the `spawn()` functionality for spawning Node
@@ -534,4 +535,10 @@ These child Nodes are still whole new instances of V8. Assume at least 30ms
534535
startup and 10mb memory for each new Node. That is, you cannot create many
535536
thousands of them.
536537

538+
The `execPath` property in the `options` object allows for a process to be
539+
created for the child rather than the current `node` executable. This should be
540+
done with care and by default will talk over the fd represented an
541+
environmental variable `NODE_CHANNEL_FD` on the child process. The input and
542+
output on this fd is expected to be line delimited JSON objects.
543+
537544
[EventEmitter]: events.html#events_class_events_eventemitter

lib/child_process.js

+3-1
Original file line numberDiff line numberDiff line change
@@ -441,7 +441,9 @@ exports.fork = function(modulePath /*, args, options*/) {
441441
options.stdio = options.silent ? ['pipe', 'pipe', 'pipe', 'ipc'] :
442442
[0, 1, 2, 'ipc'];
443443

444-
return spawn(process.execPath, args, options);
444+
options.execPath = options.execPath || process.execPath;
445+
446+
return spawn(options.execPath, args, options);
445447
};
446448

447449

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
// Copyright Joyent, Inc. and other Node contributors.
2+
//
3+
// Permission is hereby granted, free of charge, to any person obtaining a
4+
// copy of this software and associated documentation files (the
5+
// "Software"), to deal in the Software without restriction, including
6+
// without limitation the rights to use, copy, modify, merge, publish,
7+
// distribute, sublicense, and/or sell copies of the Software, and to permit
8+
// persons to whom the Software is furnished to do so, subject to the
9+
// following conditions:
10+
//
11+
// The above copyright notice and this permission notice shall be included
12+
// in all copies or substantial portions of the Software.
13+
//
14+
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15+
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16+
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
17+
// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18+
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
19+
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20+
// USE OR OTHER DEALINGS IN THE SOFTWARE.
21+
22+
var assert = require('assert');
23+
var cp = require('child_process');
24+
var fs = require('fs');
25+
var path = require('path');
26+
var common = require('../common');
27+
var msg = {test: 'this'};
28+
var nodePath = process.execPath;
29+
var symlinkPath = path.join(common.tmpDir, 'node-symlink');
30+
31+
if (process.env.FORK) {
32+
assert(process.send);
33+
assert.equal(process.argv[0], symlinkPath);
34+
process.send(msg);
35+
process.exit();
36+
}
37+
else {
38+
try {
39+
fs.unlinkSync(symlinkPath);
40+
}
41+
catch (e) {
42+
if (e.code !== 'ENOENT') throw e;
43+
}
44+
fs.symlinkSync(nodePath, symlinkPath);
45+
46+
var child = require('child_process').fork(__filename, {
47+
execPath: symlinkPath,
48+
env: { FORK: 'true' }
49+
});
50+
child.on('message', common.mustCall(function(recv) {
51+
assert.deepEqual(msg, recv);
52+
}));
53+
child.on('exit', common.mustCall(function(code) {
54+
fs.unlinkSync(symlinkPath);
55+
assert.equal(code, 0);
56+
}));
57+
}

0 commit comments

Comments
 (0)