Handling child process errors in Node.js - Mini Project: Build & Apply

Handling child process errors in Node.js

📖 Scenario: You are building a Node.js script that runs a child process to execute a system command. You want to handle errors properly if the child process fails to spawn.

🎯 Goal: Create a Node.js script that spawns a child process to run the nonexistent command. Handle the error event to catch and log the error message.

📋 What You'll Learn

Use the child_process module's spawn function

Spawn a child process to run nonexistent

Add an error event listener to handle child process errors

Log the error message when an error occurs

💡 Why This Matters

🌍 Real World

Running system commands from Node.js scripts is common for automation, deployment, or tooling. Handling errors ensures your script can respond gracefully to failures.

💼 Career

Understanding child process error handling is important for backend developers, DevOps engineers, and anyone writing Node.js scripts that interact with the system.

1

Import spawn from child_process and create the child process

Write code to import spawn from the child_process module. Then create a child process called child that runs the command nonexistent.

Node.js

const { spawn } = require('child_process');
// Your code here

Hint

Use require('child_process') to import spawn. Then call spawn('nonexistent', []) to create the child process.

2

Create a variable to hold the error message

Create a variable called errorMessage and set it to an empty string ''. This will store the error message from the child process.

Node.js

const { spawn } = require('child_process');
const child = spawn('nonexistent', []);

// Your code here

Hint

Declare let errorMessage = '' to hold the error text.

3

Add an error event listener to the child process

Add an error event listener to the child process. The listener should take an error parameter and set errorMessage to error.message.

Node.js

const { spawn } = require('child_process');
const child = spawn('nonexistent', []);

let errorMessage = '';

// Your code here

Hint

Use child.on('error', (error) => { ... }) to listen for errors and assign error.message to errorMessage.

4

Log the error message when the child process exits

Add an exit event listener to the child process. Inside the listener, if errorMessage is not empty, log it using console.error.

Node.js

const { spawn } = require('child_process');
const child = spawn('nonexistent', []);

let errorMessage = '';

child.on('error', (error) => {
    errorMessage = error.message;
});

// Your code here

Hint

Use child.on('exit', () => { if (errorMessage !== '') console.error(errorMessage); }) to log errors after the process ends.

Practice

1. What is the main reason to listen for the 'error' event when using Node.js child processes?

easy

A. To catch errors that happen when starting or running the child process

B. To get the output data from the child process

C. To close the child process manually

D. To restart the child process automatically

Solution

1. Step 1: Understand the purpose of the 'error' event

   The 'error' event is triggered if the child process fails to start or encounters a problem during execution.

2. Step 2: Differentiate from other events

   The 'exit' event tells when the process ends, but 'error' specifically catches startup or runtime errors.

3. Final Answer:

   To catch errors that happen when starting or running the child process -> Option A

4. Quick Check:

   'error' event = catch process startup/runtime errors [OK]

Hint: Remember: 'error' means process failed to start or crashed [OK]

Common Mistakes:

• Confusing 'error' with 'exit' event
• Thinking 'error' gives output data
• Assuming 'error' restarts the process

2. Which of the following is the correct way to listen for errors on a child process created with spawn?

easy

A. child.on('error', (err) => { console.error(err); });

B. child.error((err) => { console.error(err); });

C. child.on('exit', (code) => { console.log(code); });

D. child.catch('error', (err) => { console.error(err); });

Solution

1. Step 1: Recall the correct event listener syntax

   Node.js child processes use on method to listen for events like 'error'.

2. Step 2: Identify the correct event and method

   child.on('error', (err) => { console.error(err); }); uses child.on('error', callback), which is the proper syntax to catch errors.

3. Final Answer:

   child.on('error', (err) => { console.error(err); }); -> Option A

4. Quick Check:

   Use on('error') to catch errors [OK]

Hint: Use child.on('error', callback) to catch errors [OK]

Common Mistakes:

• Using wrong method like .error() or .catch()
• Listening to 'exit' instead of 'error' for errors
• Missing parentheses or wrong event name

3. Consider this code snippet:

const { spawn } = require('child_process');
const child = spawn('node', ['-e', "process.exit(1)"]);
child.on('exit', (code) => {
  console.log('Exit code:', code);
});
child.on('error', (err) => {
  console.error('Error:', err);
});

What will be printed when this runs?

medium

A. Exit code: 0

B. Error: Error message

C. Exit code: 1

D. No output

Solution

1. Step 1: Understand the child process command

   The child runs a Node.js command that immediately exits with code 1 using process.exit(1).

2. Step 2: Check which event triggers

   The process exits normally with code 1, so the 'exit' event fires with code 1; no 'error' event occurs.

3. Final Answer:

   Exit code: 1 -> Option C

4. Quick Check:

   process.exit(1) triggers 'exit' with code 1 [OK]

Hint: process.exit(n) triggers 'exit' with code n, no 'error' [OK]

Common Mistakes:

• Thinking exit code 1 triggers 'error' event
• Expecting 'Exit code: 0' by default
• Ignoring the 'exit' event output

4. You wrote this code to handle errors:

const { exec } = require('child_process');
const child = exec('invalidcommand');
child.on('exit', (code) => {
  if (code !== 0) console.log('Process failed');
});

Why might this code fail to detect the error properly?

medium

A. Because 'exit' event does not fire on errors

B. Because 'error' event should be used to catch command not found errors

C. Because exec does not emit any events

D. Because the callback function is missing

Solution

1. Step 1: Understand exec error handling

   When a command is invalid, exec emits an 'error' event, not just an 'exit' event with a code.

2. Step 2: Identify missing error listener

   The code listens only to 'exit', so it misses errors like 'command not found' which trigger 'error' event.

3. Final Answer:

   Because 'error' event should be used to catch command not found errors -> Option B

4. Quick Check:

   Use 'error' event to catch exec command failures [OK]

Hint: Listen to 'error' event for exec command failures [OK]

Common Mistakes:

• Assuming 'exit' event catches all errors
• Not adding 'error' event listener
• Confusing exec with spawn error handling

5. You want to run a child process and handle both startup errors and non-zero exit codes. Which code snippet correctly handles both cases?

hard

A. const child = spawn('mycmd');
child.on('close', (code) => console.log('Process closed with code', code));

B. const child = spawn('mycmd');
child.on('exit', (code) => {
if (code !== 0) console.error('Startup error:', code);
});

C. const child = spawn('mycmd');
child.on('error', (err) => console.log('Exit code:', err));

D. const child = spawn('mycmd');
child.on('error', (err) => console.error('Startup error:', err));
child.on('exit', (code) => {
if (code !== 0) console.log('Exit code:', code);
});

Solution

1. Step 1: Handle startup errors with 'error' event

   Listening to 'error' catches problems starting the process, like command not found.

2. Step 2: Handle non-zero exit codes with 'exit' event

   The 'exit' event provides the exit code; checking if it's not zero indicates failure.

3. Step 3: Verify option correctness

   const child = spawn('mycmd'); child.on('error', (err) => console.error('Startup error:', err)); child.on('exit', (code) => { if (code !== 0) console.log('Exit code:', code); }); listens to both 'error' and 'exit' properly and logs appropriate messages.

4. Final Answer:

   const child = spawn('mycmd'); child.on('error', (err) => console.error('Startup error:', err)); child.on('exit', (code) => { if (code !== 0) console.log('Exit code:', code); }); -> Option D

5. Quick Check:

   Use 'error' for startup, 'exit' for exit codes [OK]

Hint: Use both 'error' and 'exit' events to cover all errors [OK]

Common Mistakes:

• Ignoring 'error' event for startup failures
• Logging exit code as startup error
• Using only 'close' event without error handling