Stream backpressure concept in Node.js - Mini Project: Build & Apply

Understanding Stream Backpressure in Node.js

📖 Scenario: You are building a simple Node.js program that reads data from a file and writes it to another file using streams. This helps handle large files efficiently without loading everything into memory at once.To keep the program smooth and avoid memory overload, you will learn how to manage stream backpressure. This means controlling the flow of data so the writable stream is not overwhelmed by the readable stream.

🎯 Goal: Create a Node.js script that reads from input.txt and writes to output.txt using streams. Implement backpressure handling by checking the return value of write() and pausing/resuming the readable stream accordingly.

📋 What You'll Learn

Create a readable stream from input.txt

Create a writable stream to output.txt

Use a variable to track if the writable stream buffer is full

Implement logic to pause the readable stream when the writable stream buffer is full

Resume the readable stream when the writable stream drains

💡 Why This Matters

🌍 Real World

Handling large files or data streams efficiently without crashing or using too much memory is important in real-world Node.js applications like file servers, video streaming, or data processing.

💼 Career

Understanding stream backpressure is essential for backend developers working with Node.js to build scalable and performant applications that handle data streams smoothly.

1

Create readable and writable streams

Create a readable stream called readStream from the file input.txt using fs.createReadStream. Also create a writable stream called writeStream to the file output.txt using fs.createWriteStream. Import the fs module at the top.

Node.js

const fs = require('fs');

// Your code here

Hint

Use require('fs') to import the file system module. Then use fs.createReadStream('input.txt') and fs.createWriteStream('output.txt') to create the streams.

2

Add a variable to track backpressure state

Create a variable called canWrite and set it to true. This will track if the writable stream buffer can accept more data.

Node.js

const fs = require('fs');

const readStream = fs.createReadStream('input.txt');
const writeStream = fs.createWriteStream('output.txt');

// Your code here

Hint

Use let canWrite = true; to create the variable that tracks if writing is possible.

3

Implement backpressure logic in data event

Add a data event listener on readStream. Inside it, write the chunk to writeStream using writeStream.write(chunk). Assign the return value to canWrite. If canWrite is false, pause readStream using readStream.pause().

Node.js

const fs = require('fs');

const readStream = fs.createReadStream('input.txt');
const writeStream = fs.createWriteStream('output.txt');

let canWrite = true;

// Your code here

Hint

Listen for 'data' events on readStream. Write each chunk to writeStream and check if writing is possible. Pause reading if not.

4

Resume reading on drain event

Add a 'drain' event listener on writeStream. Inside it, set canWrite to true and call readStream.resume() to continue reading data.

Node.js

const fs = require('fs');

const readStream = fs.createReadStream('input.txt');
const writeStream = fs.createWriteStream('output.txt');

let canWrite = true;

readStream.on('data', (chunk) => {
    canWrite = writeStream.write(chunk);
    if (!canWrite) {
        readStream.pause();
    }
});

// Your code here

Hint

Listen for the 'drain' event on writeStream. When it fires, set canWrite to true and resume the readStream.

Practice

1. What is the main purpose of backpressure in Node.js streams?

easy

A. To speed up data transfer between streams

B. To control the flow of data and prevent writable streams from being overwhelmed

C. To close streams automatically after data transfer

D. To convert data formats between streams

Solution

1. Step 1: Understand stream data flow

   Streams send data from readable to writable. If writable is slow, data can pile up.

2. Step 2: Role of backpressure

   Backpressure pauses the readable stream to avoid overwhelming the writable stream.

3. Final Answer:

   To control the flow of data and prevent writable streams from being overwhelmed -> Option B

4. Quick Check:

   Backpressure controls flow = A [OK]

Hint: Backpressure means controlling data flow to avoid overload [OK]

Common Mistakes:

• Thinking backpressure speeds up data
• Confusing backpressure with stream closing
• Assuming backpressure changes data format

2. Which of the following is the correct way to listen for the 'drain' event on a writable stream in Node.js?

easy

A. writable.on('drain', () => { /* handle drain */ });

B. writable.emit('drain', () => { /* handle drain */ });

C. writable.listen('drain', () => { /* handle drain */ });

D. writable.addEventListener('drain', () => { /* handle drain */ });

Solution

1. Step 1: Recall event listening syntax in Node.js streams

   Streams use the .on() method to listen for events.

2. Step 2: Identify correct method for 'drain' event

   The 'drain' event is listened to with writable.on('drain', callback).

3. Final Answer:

   writable.on('drain', () => { /* handle drain */ }); -> Option A

4. Quick Check:

   Use .on() to listen to events = D [OK]

Hint: Use .on() to listen for stream events like 'drain' [OK]

Common Mistakes:

• Using emit() instead of on() to listen
• Using browser event methods like addEventListener
• Using non-existent listen() method

3. Consider this code snippet:

const readable = getReadableStreamSomehow();
const writable = getWritableStreamSomehow();

readable.on('data', chunk => {
  const canWrite = writable.write(chunk);
  if (!canWrite) {
    readable.pause();
  }
});

writable.on('drain', () => {
  readable.resume();
});

readable.on('end', () => {
  writable.end();
});

What will happen if the writable stream's internal buffer is full?

medium

A. The writable stream will discard new data chunks

B. The readable stream will continue sending data without pause

C. The program will throw an error and crash

D. The readable stream will pause until the writable stream drains

Solution

1. Step 1: Analyze writable.write() return value

   When writable.write() returns false, it means the buffer is full and cannot accept more data now.

2. Step 2: Check how readable reacts

   On false, readable.pause() is called to stop sending data temporarily.

3. Step 3: Understand 'drain' event handling

   When writable drains, it emits 'drain', triggering readable.resume() to continue data flow.

4. Final Answer:

   The readable stream will pause until the writable stream drains -> Option D

5. Quick Check:

   Writable full -> readable pauses -> resumes on drain = C [OK]

Hint: Writable.write false means pause readable until drain event [OK]

Common Mistakes:

• Assuming readable never pauses
• Thinking writable discards data silently
• Expecting program crash on full buffer

4. You wrote this code to handle backpressure but the readable stream never resumes after pausing:

readable.on('data', chunk => {
  if (!writable.write(chunk)) {
    readable.pause();
  }
});

// Missing 'drain' event listener on writable

readable.on('end', () => {
  writable.end();
});

What is the main problem causing the readable stream to stay paused?

medium

A. The 'drain' event listener is missing, so readable never resumes

B. The writable stream should not use write() inside 'data' event

C. The readable stream should call end() instead of pause()

D. The 'end' event should be listened on writable, not readable

Solution

1. Step 1: Identify missing event listener

   The code pauses readable when writable.write returns false but never listens for 'drain'.

2. Step 2: Understand consequence of missing 'drain'

   Without 'drain' listener calling readable.resume(), readable stays paused indefinitely.

3. Final Answer:

   The 'drain' event listener is missing, so readable never resumes -> Option A

4. Quick Check:

   Missing drain listener -> readable stuck paused = B [OK]

Hint: Always listen for 'drain' to resume paused readable streams [OK]

Common Mistakes:

• Thinking pause() should be replaced by end()
• Ignoring the need for 'drain' event
• Confusing 'end' event on readable vs writable

5. You want to implement backpressure handling manually without using pipe(). Which sequence correctly manages backpressure between a readable and writable stream?

hard

A. On 'data', pause readable; write chunk; on writable 'error', resume readable

B. On 'data', write chunk; always resume readable immediately; on writable 'finish', pause readable

C. On 'data', write chunk; if write returns false, pause readable; on writable 'drain', resume readable

D. On 'data', write chunk; if write returns true, pause readable; on writable 'close', resume readable

Solution

1. Step 1: Understand backpressure manual handling

   When writable.write returns false, it signals buffer full, so readable must pause.

2. Step 2: Resume readable on 'drain' event

   Writable emits 'drain' when ready for more data, so readable resumes then.

3. Step 3: Verify option correctness

   On 'data', write chunk; if write returns false, pause readable; on writable 'drain', resume readable matches this correct sequence; others misuse pause/resume or wrong events.

4. Final Answer:

   On 'data', write chunk; if write returns false, pause readable; on writable 'drain', resume readable -> Option C

5. Quick Check:

   Pause on false write, resume on drain = A [OK]

Hint: Pause readable if write returns false; resume on writable 'drain' [OK]

Common Mistakes:

• Resuming readable immediately without pause
• Pausing readable on true write return
• Using wrong events like 'finish' or 'close' for resume