| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394 |
1×
1×
1×
1×
1×
11×
11×
11×
77×
11×
11×
11×
11×
11×
11×
11×
11×
11×
11×
11×
11×
11×
11×
11×
11×
11×
11×
11×
11×
11×
11×
11×
11×
15×
11×
11×
11×
11×
11×
11×
3×
3×
3×
3×
11×
4×
4×
4×
4×
4×
4×
3×
1×
4×
11×
11×
33×
11×
11×
11×
11×
11×
11×
11×
11×
11×
11×
11×
11×
11×
11×
11×
1×
1×
1×
1×
| // [](https://circleci.com/gh/mayanklahiri/node-superchild)
// [](https://github.com/mayanklahiri/node-superchild/issues)
// [](https://github.com/mayanklahiri/node-superchild/stargazers)
// [](https://raw.githubusercontent.com/mayanklahiri/node-superchild/master/LICENSE)
// [](https://badge.fury.io/js/superchild)
// [](https://david-dm.org/mayanklahiri/node-superchild.svg)
// [](https://www.bithound.io/github/mayanklahiri/node-superchild)
// [](https://www.bithound.io/github/mayanklahiri/node-superchild)
// [](https://twitter.com/intent/tweet?text=Wow:&url=%5Bobject%20Object%5D)
//
// **Superchild** is a POSIX-only (e.g., Linux, Mac OS X) wrapper around
// node.js's built-in `child_process` module, which requires a lot of
// care and attention to use correctly.
//
// Links:
//
// * [Annotated source code](http://mayanklahiri.github.io/node-superchild/superchild.html)
// * [Current test coverage](http://mayanklahiri.github.io/node-superchild/coverage/lib/index.html)
// * [Github page](https://github.com/mayanklahiri/node-superchild)
// * [NPM page](https://www.npmjs.com/package/superchild)
//
// The purpose of Superchild is to allow large node.js programs
// to be split into independent processes (and sub-processes, resulting
// in **process trees**), while handling the tedious parts of process
// management and communication.
//
// Superchild aims to be **compatible** with any program
// that reads from and writes to their `stdin`, `stdout`, and `stderr`
// streams, regardless of what language the program is written in.
// This allows interesting hacks like using `ssh` to execute a
// module on a remote host, written in another language, over an
// encrypted link, while using the near-universal format of
// line-delimited JSON messages over `stdio`.
//
// **Features** that make Superchild different from node's built-in
// `child_process` module include the following (many of these
// are currently possible only due to restricting focus to POSIX
// platforms, i.e., not Windows):
//
// 1. A single function to replace `fork()`, `exec()`,
// and `spawn()` from the built-in `child_process` module.
//
// 2. Waits for `stdout` and `stderr` streams to end before
// emitting an `exit` event, unlike `child_process.ChildProcess`.
//
// 3. Handles isolating child process and its children in a
// separate, __detached process group__ that can be terminated
// as a subtree using the POSIX `kill` command. This means
// that calling `close()` on a Superchild instance will kill
// not just the child process, but all _its_ child processes
// and so on (i.e., the entire process group lead by the child).
// Note that if any processes in the sub-tree detach themselves
// into a new process group, they will not be part of our
// child's process group, and will not be killed.
//
// 4. Handles __graceful termination__ of child's entire process group
// using `SIGTERM` -> `SIGKILL` signals with a configurable timeout.
//
// 5. Handles __unexpected termination__ of the *current* process by
// killing the child's entire process group immediately with `SIGKILL`.
//
// 6. Automatically serializes and deserializes __line-delimited JSON__
// values (LD-JSON) sent to and received from child, intermixed
// with `stdout`. `stderr` is passed through unbuffered. Effectively,
// this means that the child's `stdout` stream is demultiplexed
// into the child streams `stdout_line` (parsed raw text lines),
// `json_object` (parsed JSON objects), and `json_array` (parsed JSON
// arrays). Regular processes have 3 I/O streams (stdin, stdout,
// stderr); Superchildren have 6 streams (stdin, stdout, stderr,
// stdout_line, json_object, json_array).
//
// ## Install
//
// npm install superchild
//
// ## Usage
//
// ##### Run a shell command
//
// Get a directory listing line-by-line using `ls`.
//
// var superchild = require('superchild');
// var child = superchild('ls -lh');
// child.on('stdout_line', function(line) {
// console.log('[stdout]: ', line);
// });
//
// ##### Spawn and communicate with a module
//
// Spawn a node.js module in another process and communicate with it.
// Note that the child uses the `superchild.unlogger` helper function
// to parse its standard input for LD-JSON arrays and objects.
//
// _master.js_
//
// var assert = require('assert');
// var superchild = require('superchild');
// var child = superchild('node echo.js');
// child.send({
// some: 'data',
// });
// child.on('json_object', function(jsonObj) {
// assert.equal(jsonObj.some, 'data');
// });
//
// _echo.js_
//
// var unlogger = require('superchild').unlogger;
// unlogger().on('json_object', function(jsonObj) {
// // Echo JSON object from parent back to parent.
// console.log(JSON.stringify(jsonObj));
// });
//
//
// ## Events emitted
//
// Superchild is an EventEmitter. The following events can be listened for
// using `child.on()` and `child.once()` functions.
//
// | Event | Arguments | Description |
// | ---------------| -------------------------|---------------------------------------------------------|
// | `exit` | `code`, `signal` | Child process exited, identical to `child_process.exit` |
// | `stderr_data` | `dataStr` | Received unbuffered data on child's `stderr` stream. |
// | `stdout_line` | `lineStr` | Received a full line of text from the child process. |
// | `json_object` | `jsonObj` | Parsed a line-delimited JSON object from child's `stdout` stream. |
// | `json_array` | `jsonArr` | Parsed a line-delimited JSON array from child's `stdout` stream. |
//
// ## Methods
//
// | Method | Description |
// | ----------------| -------------------------------------------------------------------------------|
// | `send(jsonVal)` | Serialize and send a JSON-serializable object or array to the child as LD-JSON.|
// | `close(cb)` | Gracefully terminate the child, invoking the callback when the child has died. |
//
// ## Requirements
//
// * `node.js` version 0.11.13 or higher, due to the use of `spawnSync`.
// * POSIX-compliant platform, such as Linux or Mac OS.
//
// ## Source Code
//
// The full annotated source code of `superchild.js` follows, generated
// automatically by Docco.
//
/** @license The MIT License, Copyright (c) 2016 Mayank Lahiri <mayank@iceroad.io> */
var events = require('events')
, fmt = require('util').format
, fs = require('fs')
, spawn = require('./respawn').spawn
, spawnSync = require('./respawn').spawnSync
, JSONSieve = require('./json-sieve')
;
var NODE_MAJOR = parseInt(process.version.replace(/\..+/, '').substr(1), 10);
var LEGACY_NODE = NODE_MAJOR < 5;
var CLEANUP_PROCESSES = {};
function superchild(commandLine, options) {
Iif (!commandLine) throw new Error('Superchild: empty commandLine provided.');
options = (typeof options == 'object' ? options : {});
var opt = {}, setDefault = function(key, defaultVal) {
opt[key] = (key in options) ? options[key] : defaultVal;
};
// #### Default options
//
// * **`stringEncoding`**: character encoding to use while communicating
// with the child. This is required to make node.js return strings instead
// of raw buffers. Defaults to **utf-8**.
setDefault('stringEncoding', 'utf-8');
// * **`killOnExit`**: kill child process group when our own process
// exits, if the child is still running. Defaults to **true**.
setDefault('killOnExit', true);
// * **`cleanupTimeoutMs`**: amount of walltime to wait for child process
// to exit after `close()` is called, before sending it SIGTERM. Defaults
// to **500ms**.
setDefault('cleanupTimeoutMs', 500);
// * **`shell`**: run the command line through a system shell, defaults
// to **true**.
setDefault('shell', true);
// * **`cwd`**: working directory to execute child process in, defaults
// to **process.cwd()**.
setDefault('cwd', process.cwd());
// * **`detached`**: makes the process the leader of its own process group.
setDefault('detached', true);
// * **`env`**: environment variables to pass to child.
setDefault('env', undefined);
// Construct an `EventEmitter` instance to return to the caller. This
// is a proxy emitter for the child process so that we can
// re-order events received from the child process if necessary.
var emitter = new events.EventEmitter();
// #### Spawning the child process
//
// Spawn a child process with the `detached` option makes it
// the leader of its own process group. This allows us to
// terminate all its descendant processes (if we need to) by running
// `kill -$PGID` (negation of the child's process group id).
//
var child;
var hasExited = false, stdoutEnded = false, stderrEnded = false;
try {
var spawnOpt = {
detached: opt.detached,
shell: opt.shell,
cwd: opt.cwd,
stdio: 'pipe',
env: opt.env,
};
// Use `respawn.spawn()` to spawn the child process.
child = spawn(commandLine, spawnOpt);
child.stdout.setEncoding(opt.stringEncoding);
child.stderr.setEncoding(opt.stringEncoding);
// Node 4 (LTS) and below: no setDefaultEncoding() function.
Eif (child.stdin.setDefaultEncoding) {
child.stdin.setDefaultEncoding(opt.stringEncoding);
}
Iif (LEGACY_NODE) {
// Node 4 (LTS) and below: `child.pid` is not immediately populated, and
// `child_process.spawnSync` does not support the `detached` option. So
// the best we can do if `child.pid` is undefined is some exponential
// backoff polling that is not guaranteed to succeed.
var pollIntervalMs = 1;
(function pollFn() {
if (child.pid) {
// Successfully have child's pid
emitter.pid = child.pid;
if (opt.killOnExit) {
CLEANUP_PROCESSES[child.pid] = true;
}
} else {
if (pollIntervalMs < 100) {
setTimeout(pollFn, pollIntervalMs);
pollIntervalMs *= 2;
}
}
})();
} else {
// Node 5+ natively returns child.pid set.
emitter.pid = child.pid;
Eif (opt.killOnExit) {
CLEANUP_PROCESSES[child.pid] = true;
}
}
} catch(e) {
throw new Error(fmt(
'superchild: cannot spawn() child process, reason=%s, stack=%s',
e.message, e.stack));
}
// #### Reading from the child
//
// Read from the child process by parsing out complete lines and
// line-delimited JSON objects and arrays from its `stdout` stream using
// `JSONSieve`.
var sieve = new JSONSieve();
var sieveClosed = false;
child.stdout.on('data', function(dataStr) {
sieve.observe(dataStr);
});
sieve.on('json_object', emitter.emit.bind(emitter, 'json_object'));
sieve.on('json_array', emitter.emit.bind(emitter, 'json_array'));
sieve.on('stdout_line', emitter.emit.bind(emitter, 'stdout_line'));
child.stderr.on('data', emitter.emit.bind(emitter, 'stderr_data'));
child.stdout.on('data', emitter.emit.bind(emitter, 'stdout'));
// #### Writing to the child: `send()`
//
emitter.send = function(jsonVal) {
try {
var serData = JSON.stringify(jsonVal) + '\n';
child.stdin.write(serData, opt.stringEncoding);
return {
bytesWritten: serData.length,
prefix: serData.substr(0, 100),
};
} catch(e) {
throw new Error('Unable to write to process: ' + e.message);
}
};
// #### Terminating the child: `close()`
//
// Kill the child's process group gracefully. This involves the following
// steps:
//
// 1. Send a `SIGTERM` signal to the child process group, allowing all
// processes in the group to die gracefully.
// 2. Wait for `opt.cleanupTimeoutMs` milliseconds.
// 3. If the child process has not exited, send a `SIGKILL` to the
// process group.
//
// This method is a public method that is offered
// via the return value of the `superchild()` call.
//
// Note that we wait for the proxy emitter's `exit` event before invoking
// the callback rather than the underlying node.js child process's `exit`
// event. This is in order to wait for all output streams to flush before
// actually emitting the `exit` event, which is not guaranteed with
// node's underlying child_process implementation.
//
emitter.close = function(cb) {
cb = cb || function() {};
Iif (!child || !child.pid) throw new Error('superchild: child is not running.');
var termGroupCmdLine = fmt('/bin/kill -s SIGTERM -- -%d', child.pid);
var killGroupCmdLine = fmt('/bin/kill -s SIGKILL -- -%d', child.pid);
spawnSync(termGroupCmdLine, {shell: true, stdio: 'inherit'});
setTimeout(function() {
if (!sieveClosed) {
spawnSync(killGroupCmdLine, {shell: true, stdio: 'inherit'});
}
}, opt.cleanupTimeoutMs);
emitter.once('exit', cb);
};
// #### Cleaning up the child process
//
// If the `killOnExit` option is specified, then when our own
// current process exits, kill the child's process group using
// the POSIX `kill` command with the child's process group ID,
// which is the negation of its process id, since it is the leader
// of its own process group.
//
// If the child exits, then we need to wait for its streams to
// close as well, and then flush the JSON sieve before emitting
// the 'exit' event through the proxy emitter.
var exitCode, exitSignal;
var cleanupFn = function() {
if (hasExited && stdoutEnded && stderrEnded && !sieveClosed) {
sieve.close(function() {
emitter.emit('exit', exitCode, exitSignal);
emitter.removeAllListeners();
});
sieveClosed = true;
}
};
var onStdoutEnd = function() { stdoutEnded = true; cleanupFn(); };
var onStderrEnd = function() { stderrEnded = true; cleanupFn(); };
child.stdout.once('close', onStdoutEnd);
child.stderr.once('close', onStderrEnd);
child.once('exit', function(code, signal) {
hasExited = true;
exitCode = code;
exitSignal = signal;
delete CLEANUP_PROCESSES[child.pid];
cleanupFn();
});
// #### Return value
//
// The `superchild()` call returns a proxy `EventEmitter` with two
// additional methods that are used to control the child process:
// `close()` and `send()`.
return emitter;
}
process.once('exit', function() {
Object.keys(CLEANUP_PROCESSES).forEach(function(pid) {
var killCmdLine = fmt('/bin/kill -s SIGTERM -- -%d', pid);
spawnSync(killCmdLine, {stdio: 'inherit'});
});
});
module.exports = superchild;
// #### Helper utilities
//
// * [`Class JSONSieve`](http://mayanklahiri.github.io/node-superchild/json-sieve.html),
// parses a readable stream into JSON objects and arrays, and stdout lines.
// * [`function unlogger()`](http://mayanklahiri.github.io/node-superchild/unlogger.html),
// an example of establishing bi-directional communication between a parent
// and child that can be easily ported to many other languages.
superchild.JSONSieve = require('./json-sieve');
superchild.unlogger = require('./unlogger');
|