How cluster module works in Node.js - Try It Yourself

How cluster module works

📖 Scenario: You want to create a simple Node.js server that uses the cluster module to run multiple worker processes. This helps your server handle more requests by using all CPU cores.

🎯 Goal: Build a Node.js script that uses the cluster module to create worker processes equal to the number of CPU cores. Each worker runs a simple HTTP server that responds with 'Hello from worker'.

📋 What You'll Learn

Create a variable to import the cluster module

Create a variable to import the http module

Create a variable to import the os module

Use cluster.isMaster to check if the current process is the master

In the master process, fork workers equal to the number of CPU cores

In each worker process, create an HTTP server that responds with 'Hello from worker'

Listen on port 8000 in each worker

💡 Why This Matters

🌍 Real World

Using the cluster module helps Node.js servers use all CPU cores, improving performance and handling more users at the same time.

💼 Career

Understanding clustering is important for backend developers to build scalable and efficient Node.js applications.

1

Import required modules

Create three variables called cluster, http, and os. Import the Node.js modules cluster, http, and os respectively using require.

Node.js

# Import the cluster, http, and os modules
# Your code here

Hint

Use const cluster = require('cluster'); to import the cluster module.

2

Check if current process is master

Add an if statement that checks if cluster.isMaster is true. This will help you run code only in the master process.

Node.js

const cluster = require('cluster');
const http = require('http');
const os = require('os');

// Check if current process is master
# Your code here

Hint

Use if (cluster.isMaster) { } to check the master process.

3

Fork workers for each CPU core

Inside the if (cluster.isMaster) block, create a for loop that runs from 0 to os.cpus().length. Inside the loop, call cluster.fork() to create worker processes.

Node.js

const cluster = require('cluster');
const http = require('http');
const os = require('os');

if (cluster.isMaster) {
  // Fork workers equal to CPU cores
  # Your code here
}

Hint

Use for (let i = 0; i < os.cpus().length; i++) { cluster.fork(); } inside the master block.

4

Create HTTP server in worker processes

Add an else block after the if (cluster.isMaster). Inside the else, create an HTTP server using http.createServer() that responds with 'Hello from worker'. Make the server listen on port 8000.

Node.js

const cluster = require('cluster');
const http = require('http');
const os = require('os');

if (cluster.isMaster) {
  for (let i = 0; i < os.cpus().length; i++) {
    cluster.fork();
  }
} else {
  // Create HTTP server in worker
  # Your code here
}

Hint

Use http.createServer((req, res) => { res.end('Hello from worker'); }).listen(8000); inside the else block.

Practice

1. What is the main purpose of the cluster module in Node.js?

easy

A. To provide a graphical user interface for Node.js apps

B. To manage database connections efficiently

C. To handle file system operations asynchronously

D. To create multiple worker processes to use all CPU cores

Solution

1. Step 1: Understand the cluster module role

   The cluster module allows Node.js to create multiple worker processes.

2. Step 2: Recognize the benefit

   These workers use all CPU cores to improve performance by handling requests in parallel.

3. Final Answer:

   To create multiple worker processes to use all CPU cores -> Option D

4. Quick Check:

   cluster module = multiple workers for CPU cores [OK]

Hint: Cluster = multiple processes for CPU cores [OK]

Common Mistakes:

• Confusing cluster with database or file system modules
• Thinking cluster manages UI or frontend
• Assuming cluster runs code in a single process

2. Which of the following is the correct way to check if the current process is the master in a cluster setup?

easy

A. if (cluster.isMaster) { ... }

B. if (cluster.isPrimary) { ... }

C. if (cluster.isWorker) { ... }

D. if (cluster.isMain) { ... }

Solution

1. Step 1: Recall the updated property name

   In recent Node.js versions, cluster.isPrimary replaces cluster.isMaster.

2. Step 2: Identify the correct syntax

   Using cluster.isPrimary correctly checks if the process is the primary (master) process.

3. Final Answer:

   if (cluster.isPrimary) { ... } -> Option B

4. Quick Check:

   Primary process check = cluster.isPrimary [OK]

Hint: Use cluster.isPrimary, not isMaster [OK]

Common Mistakes:

• Using deprecated cluster.isMaster instead of cluster.isPrimary
• Confusing isWorker with isPrimary
• Using non-existent properties like isMain

3. Consider this Node.js cluster code snippet:

const cluster = require('cluster');
const http = require('http');

if (cluster.isPrimary) {
  cluster.fork();
  cluster.fork();
} else {
  http.createServer((req, res) => {
    res.end('Worker ' + process.pid);
  }).listen(8000);
}

What will happen when you visit http://localhost:8000 multiple times?

medium

A. You will see responses from different worker process IDs

B. Only one worker will handle all requests

C. The server will crash because of multiple forks

D. You will get a syntax error on startup

Solution

1. Step 1: Understand cluster.fork creates workers

   Two workers are created, each running the HTTP server on port 8000.

2. Step 2: Recognize load balancing behavior

   Requests are distributed between workers, so responses show different process IDs.

3. Final Answer:

   You will see responses from different worker process IDs -> Option A

4. Quick Check:

   Multiple workers share port, respond with different PIDs [OK]

Hint: Multiple forks = multiple workers respond differently [OK]

Common Mistakes:

• Thinking only one worker handles all requests
• Assuming server crashes due to multiple forks
• Expecting syntax errors from this code

4. What is wrong with this cluster code snippet?

const cluster = require('cluster');
if (cluster.isPrimary) {
  cluster.fork();
} else {
  console.log('Worker running');
}

medium

A. cluster.isPrimary is deprecated, should use isMaster

B. No call to cluster.fork in the worker process

C. Missing server code inside worker

D. No error, code works fine

Solution

1. Step 1: Check cluster usage

   The primary forks one worker, which only logs a message but does not start a server.

2. Step 2: Identify missing functionality

   Without server code, the worker does not handle requests, so the cluster setup is incomplete.

3. Final Answer:

   Missing server code inside worker -> Option C

4. Quick Check:

   Worker must run server code to handle requests [OK]

Hint: Workers need server code to handle requests [OK]

Common Mistakes:

• Confusing isPrimary with deprecated isMaster
• Expecting cluster.fork in worker process
• Assuming code runs without server in worker

5. You want to create a cluster that automatically restarts a worker if it crashes. Which approach correctly implements this behavior?

hard

A. Listen to the 'exit' event on cluster and fork a new worker inside the handler

B. Use setInterval to fork new workers every second

C. Call cluster.fork() only once at startup and never again

D. Use cluster.disconnect() inside the worker to restart itself

Solution

1. Step 1: Understand worker crash handling

   The primary process can listen to the 'exit' event when a worker dies.

2. Step 2: Restart worker on exit

   Inside the 'exit' event handler, calling cluster.fork() creates a new worker to replace the crashed one.

3. Final Answer:

   Listen to the 'exit' event on cluster and fork a new worker inside the handler -> Option A

4. Quick Check:

   Restart crashed workers by handling 'exit' event [OK]

Hint: Use 'exit' event to restart workers automatically [OK]

Common Mistakes:

• Forking workers repeatedly with setInterval causes overload
• Not restarting workers after crash leads to downtime
• Using cluster.disconnect() inside worker does not restart it