Common memory leak patterns in Node.js

Introduction

Memory leaks make your Node.js app slow or crash by using too much memory over time.

When your app gets slower after running for a while.

When your server crashes with 'out of memory' errors.

When you want to keep your app stable and fast.

When debugging performance issues in long-running Node.js processes.

Syntax

Node.js

No specific syntax, but common patterns include:

1. Global variables holding large data.
2. Closures capturing large objects.
3. Event listeners not removed.
4. Caches growing without limits.
5. Timers or intervals not cleared.

Memory leaks happen when your code keeps references to data you no longer need.

Node.js does automatic memory cleanup, but your code can stop it by holding references.

Examples

This global array keeps growing and never frees memory.

Node.js

// 1. Global variable holding data
const bigData = [];
function addData(item) {
  bigData.push(item); // keeps growing forever
}

The inner function keeps the large object alive even if not needed.

Node.js

// 2. Closure capturing large object
function createHandler() {
  const largeObject = { data: new Array(1000000).fill('x') };
  return function() {
    console.log(largeObject.data.length);
  };
}
const handler = createHandler();

Listeners stay attached and keep references, causing leaks.

Node.js

// 3. Event listener not removed
const EventEmitter = require('events');
const emitter = new EventEmitter();
function onData() {
  // do something
}
emitter.on('data', onData);
// never call emitter.removeListener('data', onData);

Cache grows forever if you don't remove old entries.

Node.js

// 4. Cache growing without limit
const cache = new Map();
function cacheData(key, value) {
  cache.set(key, value); // no limit or cleanup
}

Sample Program

This program adds a new event listener every second but never removes them. The listener count grows, causing a memory leak.

Node.js

const EventEmitter = require('events');

// Memory leak example: event listeners not removed
const emitter = new EventEmitter();

function leakListener() {
  console.log('Event received');
}

// Add listener every second without removing
setInterval(() => {
  emitter.on('data', leakListener);
  emitter.emit('data');
  console.log('Listener count:', emitter.listenerCount('data'));
}, 1000);

Important Notes

Use tools like Node.js built-in --inspect flag and Chrome DevTools to find leaks.

Always remove event listeners when no longer needed with removeListener or off.

Limit cache size or use weak references to avoid leaks.

Summary

Memory leaks happen when your code keeps data it no longer needs.

Common leaks include global variables, closures, event listeners, and caches.

Fix leaks by removing listeners, clearing caches, and avoiding unnecessary references.

Practice

1. Which of the following is a common cause of memory leaks in Node.js applications?

easy

A. Keeping references to objects that are no longer needed

B. Using asynchronous functions

C. Writing synchronous code

D. Using the latest Node.js version

Solution

1. Step 1: Understand what causes memory leaks

   Memory leaks happen when your program holds onto data it no longer needs, preventing the system from freeing memory.

2. Step 2: Identify the correct cause among options

   Keeping references to unused objects prevents garbage collection, causing leaks. Other options do not inherently cause leaks.

3. Final Answer:

   Keeping references to objects that are no longer needed -> Option A

4. Quick Check:

   Memory leaks = unused references [OK]

Hint: Memory leaks happen when unused data is still referenced [OK]

Common Mistakes:

• Thinking async code always causes leaks
• Confusing synchronous code with leaks
• Assuming Node.js version causes leaks

2. Which syntax correctly removes an event listener in Node.js to help prevent memory leaks?

easy

A. emitter.deleteListener('event', callback);

B. emitter.off('event');

C. emitter.remove('event', callback);

D. emitter.removeListener('event', callback);

Solution

1. Step 1: Recall Node.js event listener removal syntax

   The correct method to remove a specific listener is removeListener(event, callback).

2. Step 2: Check each option's validity

   emitter.removeListener('event', callback); uses the correct method. emitter.off('event'); removes all listeners but omits the specific callback. Options A and C are not valid methods.

3. Final Answer:

   emitter.removeListener('event', callback); -> Option D

4. Quick Check:

   Correct method = removeListener(event, callback) [OK]

Hint: Use removeListener with event and callback to remove listeners [OK]

Common Mistakes:

• Using emitter.off without callback
• Using non-existent methods like remove or deleteListener
• Omitting the callback function

3. Consider this code snippet:

const cache = {};
function addToCache(key, value) {
  cache[key] = value;
}
addToCache('user1', {name: 'Alice'});
addToCache('user2', {name: 'Bob'});
console.log(Object.keys(cache).length);

What will be the output and what memory issue might this cause if keys are never removed?

medium

A. 0; No memory leak because cache is empty

B. 2; Memory leak due to unbounded cache growth

C. Error; Syntax error in code

D. Undefined; cache is not defined

Solution

1. Step 1: Analyze the code output

   The cache object stores two keys: 'user1' and 'user2'. Object.keys(cache).length returns 2.

2. Step 2: Identify memory issue

   Since keys are never removed, cache grows indefinitely, causing a memory leak.

3. Final Answer:

   2; Memory leak due to unbounded cache growth -> Option B

4. Quick Check:

   Cache size = 2, leak if keys never removed [OK]

Hint: Uncleared caches cause leaks; count keys to check size [OK]

Common Mistakes:

• Thinking cache is empty initially
• Assuming syntax error without checking code
• Confusing undefined with empty object

4. You have this code causing a memory leak:

const listeners = [];
function addListener(emitter, callback) {
  emitter.on('data', callback);
  listeners.push({emitter, callback});
}
// Later you forget to remove listeners

What is the best fix to prevent the leak?

medium

A. Remove listeners with emitter.removeListener and clear the listeners array

B. Do nothing; Node.js cleans up automatically

C. Replace emitter.on with emitter.once

D. Use global variables instead of arrays

Solution

1. Step 1: Identify cause of leak

   Listeners are added and stored in an array but never removed, causing memory to stay used.

2. Step 2: Apply fix to remove listeners and clear references

   Use emitter.removeListener with stored callbacks and clear the listeners array to free memory.

3. Final Answer:

   Remove listeners with emitter.removeListener and clear the listeners array -> Option A

4. Quick Check:

   Remove listeners + clear refs = fix leak [OK]

Hint: Always remove event listeners and clear stored references [OK]

Common Mistakes:

• Assuming Node.js auto-cleans listeners
• Using emitter.once without removing listeners
• Using global variables increases leaks

5. You have a Node.js app caching user sessions in a global object. Over time, memory usage grows unexpectedly. Which combined approach best prevents this memory leak?

hard

A. Use global variables for caching without cleanup

B. Store all sessions indefinitely to avoid losing data

C. Implement session expiration and remove expired sessions from cache regularly

D. Avoid using any caching to prevent leaks

Solution

1. Step 1: Understand the problem with indefinite caching

   Storing sessions forever causes the cache to grow without limit, leading to memory leaks.

2. Step 2: Apply session expiration and cleanup

   Removing expired sessions regularly frees memory and prevents leaks while keeping useful data.

3. Final Answer:

   Implement session expiration and remove expired sessions from cache regularly -> Option C

4. Quick Check:

   Expire and clean cache to prevent leaks [OK]

Hint: Expire and clear cached data regularly to avoid leaks [OK]

Common Mistakes:

• Keeping all data forever causes leaks
• Avoiding caching is not practical
• Using globals without cleanup worsens leaks