Stream backpressure concept in Node.js - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is stream backpressure in Node.js?

Stream backpressure is a mechanism that controls the flow of data between a readable stream and a writable stream to prevent the writable stream from being overwhelmed.

beginner

Why is backpressure important when working with streams?

Backpressure helps avoid memory overload and data loss by making sure the writable stream processes data at a pace it can handle before receiving more data.

intermediate

How does Node.js signal backpressure in writable streams?

When a writable stream's internal buffer is full, its write() method returns false, signaling the readable stream to pause sending more data.

intermediate

What event should you listen to on a writable stream to resume writing after backpressure?

You should listen to the 'drain' event, which tells you the writable stream has emptied its buffer and is ready to receive more data.

beginner

Describe a real-life analogy for stream backpressure.

Imagine a water pipe filling a bucket. If the bucket is full, you stop the water flow until some water is used. This pause and resume is like backpressure controlling data flow.

What does it mean when a writable stream's write() method returns false?

A The readable stream has no more data to send.

B The writable stream has finished writing all data.

C The writable stream's buffer is full and it needs to pause receiving data.

D The writable stream encountered an error.

When write() returns false, it signals backpressure, meaning the writable stream's buffer is full and it needs to pause data flow.

Which event indicates a writable stream is ready to receive more data after backpressure?

A error

B drain

C finish

D close

The 'drain' event signals that the writable stream's buffer has been emptied and it can accept more data.

What is the main goal of backpressure in streams?

A To speed up data transfer as fast as possible.

B To convert streams into buffers.

C To close the stream immediately after writing.

D To prevent the writable stream from being overwhelmed with data.

Backpressure prevents the writable stream from being overwhelmed by controlling data flow.

In Node.js streams, who controls the pace of data flow during backpressure?

A Both readable and writable streams coordinate.

B Only the writable stream.

C Only the readable stream.

D Neither stream controls the pace.

Both streams coordinate: writable signals when to pause, readable pauses and resumes accordingly.

Which method should you check to handle backpressure properly?

A write()

B end()

C pipe()

D read()

The write() method returns false when backpressure occurs, so checking its return value is key.

Explain in your own words what stream backpressure is and why it matters in Node.js.

Think about how data flows between two connected streams and what happens if one is slower.

Describe how you would handle backpressure when writing data to a writable stream.

Focus on the signals and events that help manage the flow.

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