Procesos secundarios de Node.js: todo lo que necesita saber

Cómo usar spawn (), exec (), execFile () y fork ()

Actualización: este artículo ahora es parte de mi libro "Node.js más allá de lo básico".

Lea la versión actualizada de este contenido y más sobre Node en jscomplete.com/node-beyond-basics .

El rendimiento sin bloqueo de un solo subproceso en Node.js funciona muy bien para un solo proceso. Pero eventualmente, un proceso en una CPU no será suficiente para manejar la creciente carga de trabajo de su aplicación.

No importa cuán poderoso sea su servidor, un solo hilo solo puede soportar una carga limitada.

El hecho de que Node.js se ejecute en un solo hilo no significa que no podamos aprovechar varios procesos y, por supuesto, también varias máquinas.

El uso de varios procesos es la mejor manera de escalar una aplicación de nodo. Node.js está diseñado para crear aplicaciones distribuidas con muchos nodos. Por eso se llama Node . La escalabilidad está integrada en la plataforma y no es algo en lo que empiece a pensar más adelante en la vida útil de una aplicación.

Este artículo es una reseña de parte de mi curso Pluralsight sobre Node.js. Allí cubro contenido similar en formato de video.

Tenga en cuenta que necesitará una buena comprensión de los eventos y transmisiones de Node.js antes de leer este artículo. Si aún no lo ha hecho, le recomiendo que lea estos otros dos artículos antes de leer este:

Comprensión de la arquitectura basada en eventos de Node.js

La mayoría de los objetos de Node, como solicitudes, respuestas y flujos HTTP, implementan el módulo EventEmitter para que puedan ...

Streams: todo lo que necesita saber

Las transmisiones de Node.js tienen la reputación de ser difíciles de trabajar e incluso más difíciles de entender. Bueno, tengo buenas noticias ...

El módulo de procesos secundarios

Podemos girar fácilmente un proceso hijo usando el child_processmódulo de Node y esos procesos hijo pueden comunicarse fácilmente entre sí con un sistema de mensajería.

El child_processmódulo nos permite acceder a las funcionalidades del sistema operativo ejecutando cualquier comando del sistema dentro de un proceso hijo.

Podemos controlar ese flujo de entrada del proceso hijo y escuchar su flujo de salida. También podemos controlar los argumentos que se pasarán al comando del sistema operativo subyacente, y podemos hacer lo que queramos con la salida de ese comando. Podemos, por ejemplo, canalizar la salida de un comando como entrada a otro (al igual que lo hacemos en Linux) ya que todas las entradas y salidas de estos comandos se nos pueden presentar usando flujos de Node.js.

Tenga en cuenta que los ejemplos que utilizaré en este artículo están basados ​​en Linux. En Windows, debe cambiar los comandos que uso con sus alternativas de Windows.

Hay cuatro maneras diferentes para crear un proceso hijo en el Nodo: spawn(), fork(), exec(), y execFile().

Veremos las diferencias entre estas cuatro funciones y cuándo usar cada una.

Procesos secundarios generados

La spawnfunción lanza un comando en un nuevo proceso y podemos usarlo para pasar ese comando cualquier argumento. Por ejemplo, aquí hay un código para generar un nuevo proceso que ejecutará el pwdcomando.

const { spawn } = require('child_process'); const child = spawn('pwd');

Simplemente desestructuramos la spawnfunción fuera del child_processmódulo y la ejecutamos con el comando del sistema operativo como primer argumento.

El resultado de ejecutar la spawnfunción (el childobjeto de arriba) es una ChildProcessinstancia, que implementa la API EventEmitter. Esto significa que podemos registrar controladores para eventos en este objeto hijo directamente. Por ejemplo, podemos hacer algo cuando el proceso hijo finaliza registrando un controlador para el exitevento:

child.on('exit', function (code, signal) { console.log('child process exited with ' + `code ${code} and signal ${signal}`); });

El controlador anterior nos da la salida codepara el proceso hijo y signal, si lo hay, que se usó para terminar el proceso hijo. Esta signalvariable es nula cuando el proceso hijo sale normalmente.

Los otros eventos que podemos registrar manejadores de los ChildProcesscasos son disconnect, error, close, y message.

  • El disconnectevento se emite cuando el proceso padre llama manualmente a la child.disconnectfunción.
  • El errorevento se emite si el proceso no se pudo generar o eliminar.
  • El closeevento se emite cuando stdiose cierran los flujos de un proceso hijo.
  • El messageevento es el más importante. Se emite cuando el proceso hijo usa la process.send()función para enviar mensajes. Así es como los procesos padre / hijo pueden comunicarse entre sí. Veremos un ejemplo de esto a continuación.

Cada proceso hijo también recibe los tres estándares stdiocorrientes, las cuales podemos acceder a través de child.stdin, child.stdouty child.stderr.

Cuando esos flujos se cierran, el proceso hijo que los estaba usando emitirá el closeevento. Este closeevento es diferente del exitevento porque varios procesos secundarios pueden compartir las mismas stdiosecuencias, por lo que la salida de un proceso secundario no significa que las secuencias se hayan cerrado.

Dado que todos los flujos son emisores de eventos, podemos escuchar diferentes eventos en esos stdioflujos que están adjuntos a cada proceso hijo. Sin embargo, a diferencia de un proceso normal, en un proceso hijo, stdout/ stderrstreams son streams legibles mientras que el stdinstream es de escritura. Este es básicamente el inverso de los tipos que se encuentran en un proceso principal. Los eventos que podemos usar para esos flujos son los estándar. Lo más importante es que en los flujos legibles, podemos escuchar el dataevento, que tendrá la salida del comando o cualquier error encontrado al ejecutar el comando:

child.stdout.on('data', (data) => { console.log(`child stdout:\n${data}`); }); child.stderr.on('data', (data) => { console.error(`child stderr:\n${data}`); });

Los dos controladores anteriores registrarán ambos casos en el proceso principal stdouty stderr. Cuando ejecutamos la spawnfunción anterior, la salida del pwdcomando se imprime y el proceso hijo sale con código 0, lo que significa que no ocurrió ningún error.

Podemos pasar argumentos al comando que ejecuta la spawnfunción utilizando el segundo argumento de la spawnfunción, que es una matriz de todos los argumentos que se pasarán al comando. Por ejemplo, para ejecutar el findcomando en el directorio actual con un -type fargumento (solo para listar archivos), podemos hacer:

const child = spawn('find', ['.', '-type', 'f']);

Si ocurre un error durante la ejecución del comando, por ejemplo, si damos encontrar un destino no válido arriba, el child.stderrdatacontrolador de eventos se activará y el exitcontrolador de eventos informará un código de salida de 1, lo que significa que se ha producido un error. Los valores de error en realidad dependen del sistema operativo host y del tipo de error.

Un proceso hijo stdines una secuencia de escritura. Podemos usarlo para enviar un comando a alguna entrada. Al igual que con cualquier flujo de escritura, la forma más sencilla de consumirlo es utilizando la pipefunción. Simplemente canalizamos una secuencia legible a una secuencia de escritura. Dado que el proceso principal stdines un flujo legible, podemos canalizarlo a un stdinflujo de proceso secundario . Por ejemplo:

const { spawn } = require('child_process'); const child = spawn('wc'); process.stdin.pipe(child.stdin) child.stdout.on('data', (data) => { console.log(`child stdout:\n${data}`); });

In the example above, the child process invokes the wc command, which counts lines, words, and characters in Linux. We then pipe the main process stdin (which is a readable stream) into the child process stdin (which is a writable stream). The result of this combination is that we get a standard input mode where we can type something and when we hit Ctrl+D, what we typed will be used as the input of the wc command.

We can also pipe the standard input/output of multiple processes on each other, just like we can do with Linux commands. For example, we can pipe the stdout of the find command to the stdin of the wc command to count all the files in the current directory:

const { spawn } = require('child_process'); const find = spawn('find', ['.', '-type', 'f']); const wc = spawn('wc', ['-l']); find.stdout.pipe(wc.stdin); wc.stdout.on('data', (data) => { console.log(`Number of files ${data}`); });

I added the -l argument to the wc command to make it count only the lines. When executed, the code above will output a count of all files in all directories under the current one.

Shell Syntax and the exec function

By default, the spawn function does not create a shell to execute the command we pass into it. This makes it slightly more efficient than the exec function, which does create a shell. The exec function has one other major difference. It buffers the command’s generated output and passes the whole output value to a callback function (instead of using streams, which is what spawn does).

Here’s the previous find | wc example implemented with an exec function.

const { exec } = require('child_process'); exec('find . -type f | wc -l', (err, stdout, stderr) => { if (err) { console.error(`exec error: ${err}`); return; } console.log(`Number of files ${stdout}`); });

Since the exec function uses a shell to execute the command, we can use the shell syntax directly here making use of the shell pipe feature.

Note that using the shell syntax comes at a security risk if you’re executing any kind of dynamic input provided externally. A user can simply do a command injection attack using shell syntax characters like ; and $ (for example, command + ’; rm -rf ~’ )

The exec function buffers the output and passes it to the callback function (the second argument to exec) as the stdout argument there. This stdout argument is the command’s output that we want to print out.

The exec function is a good choice if you need to use the shell syntax and if the size of the data expected from the command is small. (Remember, exec will buffer the whole data in memory before returning it.)

The spawn function is a much better choice when the size of the data expected from the command is large, because that data will be streamed with the standard IO objects.

We can make the spawned child process inherit the standard IO objects of its parents if we want to, but also, more importantly, we can make the spawn function use the shell syntax as well. Here’s the same find | wc command implemented with the spawn function:

const child = spawn('find . -type f | wc -l', { stdio: 'inherit', shell: true });

Because of the stdio: 'inherit' option above, when we execute the code, the child process inherits the main process stdin, stdout, and stderr. This causes the child process data events handlers to be triggered on the main process.stdout stream, making the script output the result right away.

Because of the shell: true option above, we were able to use the shell syntax in the passed command, just like we did with exec. But with this code, we still get the advantage of the streaming of data that the spawn function gives us. This is really the best of both worlds.

There are a few other good options we can use in the last argument to the child_process functions besides shell and stdio. We can, for example, use the cwd option to change the working directory of the script. For example, here’s the same count-all-files example done with a spawn function using a shell and with a working directory set to my Downloads folder. The cwd option here will make the script count all files I have in ~/Downloads:

const child = spawn('find . -type f | wc -l', { stdio: 'inherit', shell: true, cwd: '/Users/samer/Downloads' });

Another option we can use is the env option to specify the environment variables that will be visible to the new child process. The default for this option is process.env which gives any command access to the current process environment. If we want to override that behavior, we can simply pass an empty object as the env option or new values there to be considered as the only environment variables:

const child = spawn('echo $ANSWER', { stdio: 'inherit', shell: true, env: { ANSWER: 42 }, });

The echo command above does not have access to the parent process’s environment variables. It can’t, for example, access $HOME, but it can access $ANSWER because it was passed as a custom environment variable through the env option.

One last important child process option to explain here is the detached option, which makes the child process run independently of its parent process.

Assuming we have a file timer.js that keeps the event loop busy:

setTimeout(() => { // keep the event loop busy }, 20000);

We can execute it in the background using the detached option:

const { spawn } = require('child_process'); const child = spawn('node', ['timer.js'], { detached: true, stdio: 'ignore' }); child.unref();

The exact behavior of detached child processes depends on the OS. On Windows, the detached child process will have its own console window while on Linux the detached child process will be made the leader of a new process group and session.

If the unref function is called on the detached process, the parent process can exit independently of the child. This can be useful if the child is executing a long-running process, but to keep it running in the background the child’s stdio configurations also have to be independent of the parent.

The example above will run a node script (timer.js) in the background by detaching and also ignoring its parent stdio file descriptors so that the parent can terminate while the child keeps running in the background.

The execFile function

If you need to execute a file without using a shell, the execFile function is what you need. It behaves exactly like the exec function, but does not use a shell, which makes it a bit more efficient. On Windows, some files cannot be executed on their own, like .bat or .cmd files. Those files cannot be executed with execFile and either exec or spawn with shell set to true is required to execute them.

The *Sync function

The functions spawn, exec, and execFile from the child_process module also have synchronous blocking versions that will wait until the child process exits.

const { spawnSync, execSync, execFileSync, } = require('child_process');

Those synchronous versions are potentially useful when trying to simplify scripting tasks or any startup processing tasks, but they should be avoided otherwise.

The fork() function

The fork function is a variation of the spawn function for spawning node processes. The biggest difference between spawn and fork is that a communication channel is established to the child process when using fork, so we can use the send function on the forked process along with the global process object itself to exchange messages between the parent and forked processes. We do this through the EventEmitter module interface. Here’s an example:

The parent file, parent.js:

const { fork } = require('child_process'); const forked = fork('child.js'); forked.on('message', (msg) => { console.log('Message from child', msg); }); forked.send({ hello: 'world' });

The child file, child.js:

process.on('message', (msg) => { console.log('Message from parent:', msg); }); let counter = 0; setInterval(() => { process.send({ counter: counter++ }); }, 1000);

In the parent file above, we fork child.js (which will execute the file with the node command) and then we listen for the message event. The message event will be emitted whenever the child uses process.send, which we’re doing every second.

To pass down messages from the parent to the child, we can execute the send function on the forked object itself, and then, in the child script, we can listen to the message event on the global process object.

When executing the parent.js file above, it’ll first send down the { hello: 'world' } object to be printed by the forked child process and then the forked child process will send an incremented counter value every second to be printed by the parent process.

Let’s do a more practical example about the fork function.

Let’s say we have an http server that handles two endpoints. One of these endpoints (/compute below) is computationally expensive and will take a few seconds to complete. We can use a long for loop to simulate that:

const http = require('http'); const longComputation = () => { let sum = 0; for (let i = 0; i  { if (req.url === '/compute') { const sum = longComputation(); return res.end(`Sum is ${sum}`); } else { res.end('Ok') } }); server.listen(3000);

This program has a big problem; when the the /compute endpoint is requested, the server will not be able to handle any other requests because the event loop is busy with the long for loop operation.

There are a few ways with which we can solve this problem depending on the nature of the long operation but one solution that works for all operations is to just move the computational operation into another process using fork.

We first move the whole longComputation function into its own file and make it invoke that function when instructed via a message from the main process:

In a new compute.js file:

const longComputation = () => { let sum = 0; for (let i = 0; i  { const sum = longComputation(); process.send(sum); });

Now, instead of doing the long operation in the main process event loop, we can fork the compute.js file and use the messages interface to communicate messages between the server and the forked process.

const http = require('http'); const { fork } = require('child_process'); const server = http.createServer(); server.on('request', (req, res) => { if (req.url === '/compute') { const compute = fork('compute.js'); compute.send('start'); compute.on('message', sum => { res.end(`Sum is ${sum}`); }); } else { res.end('Ok') } }); server.listen(3000);

When a request to /compute happens now with the above code, we simply send a message to the forked process to start executing the long operation. The main process’s event loop will not be blocked.

Once the forked process is done with that long operation, it can send its result back to the parent process using process.send.

In the parent process, we listen to the message event on the forked child process itself. When we get that event, we’ll have a sum value ready for us to send to the requesting user over http.

The code above is, of course, limited by the number of processes we can fork, but when we execute it and request the long computation endpoint over http, the main server is not blocked at all and can take further requests.

Node’s cluster module, which is the topic of my next article, is based on this idea of child process forking and load balancing the requests among the many forks that we can create on any system.

That’s all I have for this topic. Thanks for reading! Until next time!

Learning React or Node? Checkout my books:

  • Learn React.js by Building Games
  • Node.js Beyond the Basics