Compression middleware in Node.js

Introduction

Compression middleware makes your web app send smaller files to users. This helps pages load faster and saves internet data.

When you want your website to load faster for visitors.

When your server sends large files like HTML, CSS, or JSON.

When users have slow internet connections and need smaller downloads.

When you want to reduce bandwidth costs by sending less data.

When building APIs that send lots of data to clients.

Syntax

Node.js

import compression from 'compression';
import express from 'express';

const app = express();

app.use(compression());

Use app.use(compression()) before your routes to compress all responses.

You can pass options to compression() to control how compression works.

Examples

This adds compression with default settings to all responses.

Node.js

app.use(compression());

This compresses all responses, even very small ones.

Node.js

app.use(compression({ threshold: 0 }));

This skips compression if the request has a special header.

Node.js

app.use(compression({ filter: (req, res) => {
  return req.headers['x-no-compression'] ? false : compression.filter(req, res);
}}));

Sample Program

This simple Express server uses compression middleware. When you visit the homepage, it sends a large repeated text. Compression makes this response smaller and faster to load.

Node.js

import express from 'express';
import compression from 'compression';

const app = express();

// Use compression middleware
app.use(compression());

app.get('/', (req, res) => {
  const bigText = 'Hello! '.repeat(1000); // Large response
  res.send(bigText);
});

app.listen(3000, () => {
  console.log('Server running on http://localhost:3000');
});

Important Notes

Compression works best on text-based responses like HTML, CSS, JavaScript, and JSON.

Binary files like images or videos usually should not be compressed again by middleware.

Use browser DevTools Network tab to see if responses are compressed (look for content-encoding: gzip header).

Summary

Compression middleware makes server responses smaller to speed up loading.

It is easy to add with app.use(compression()) in Express apps.

Check your app's responses in browser tools to confirm compression is working.

Practice

1. What is the main purpose of using compression middleware in a Node.js Express app?

easy

A. To parse JSON data from client requests

B. To add security headers to HTTP responses

C. To log all incoming requests to the server

D. To reduce the size of server responses and speed up loading times

Solution

1. Step 1: Understand what compression middleware does

   Compression middleware compresses the data sent from the server to the client to reduce its size.

2. Step 2: Identify the benefit of compression

   Smaller response sizes mean faster loading times for users because less data travels over the network.

3. Final Answer:

   To reduce the size of server responses and speed up loading times -> Option D

4. Quick Check:

   Compression = smaller responses = faster loading [OK]

Hint: Compression shrinks response size to speed up loading [OK]

Common Mistakes:

• Confusing compression with security or logging
• Thinking compression parses request data
• Assuming compression adds headers unrelated to size

2. Which of the following is the correct way to add compression middleware in an Express app?

easy

A. app.use('compression');

B. app.use(compression);

C. app.use(compression());

D. app.use(compress());

Solution

1. Step 1: Recall the syntax for middleware usage in Express

   Middleware functions are passed as functions, so you must call compression() to get the middleware function.

2. Step 2: Identify the correct syntax

   app.use(compression()); correctly calls the compression function and passes the middleware to Express.

3. Final Answer:

   app.use(compression()); -> Option C

4. Quick Check:

   Middleware needs function call syntax () [OK]

Hint: Middleware must be called as a function with () [OK]

Common Mistakes:

• Forgetting parentheses after compression
• Passing string instead of function
• Using wrong function name like compress

3. Given this Express code snippet, what will be the effect on the response?

import express from 'express';
import compression from 'compression';

const app = express();
app.use(compression());

app.get('/', (req, res) => {
  res.send('Hello World!');
});

app.listen(3000);

medium

A. The response will be compressed if the client supports it

B. The response will always be sent uncompressed

C. The server will throw an error because compression is not configured

D. The response will be compressed only for POST requests

Solution

1. Step 1: Understand compression middleware behavior

   Compression middleware compresses responses only if the client sends an Accept-Encoding header that supports compression (like gzip).

2. Step 2: Analyze the code snippet

   The middleware is applied globally with app.use(compression()), so all responses, including GET '/', will be compressed if the client supports it.

3. Final Answer:

   The response will be compressed if the client supports it -> Option A

4. Quick Check:

   Compression depends on client support [OK]

Hint: Compression works only if client accepts it [OK]

Common Mistakes:

• Assuming compression always compresses regardless of client
• Thinking compression only works on POST
• Believing compression requires extra config to avoid errors

4. What is wrong with this code snippet that tries to add compression middleware?

const express = require('express');
const compression = require('compression');

const app = express();
app.use(compression);

app.get('/', (req, res) => {
  res.send('Hello');
});

app.listen(3000);

medium

A. The route handler is missing a next() call

B. Compression middleware is not called as a function

C. Express app is not created correctly

D. Compression middleware must be added after routes

Solution

1. Step 1: Check how compression middleware is added

   The code uses app.use(compression); which passes the compression function itself, not the middleware returned by calling it.

2. Step 2: Identify correct usage

   Compression middleware must be called as compression() to return the middleware function, so it should be app.use(compression());.

3. Final Answer:

   Compression middleware is not called as a function -> Option B

4. Quick Check:

   Middleware must be called with () [OK]

Hint: Always call middleware functions with () when adding [OK]

Common Mistakes:

• Passing middleware function without calling it
• Thinking middleware order doesn't matter here
• Confusing route handler requirements with middleware

5. You want to compress only responses larger than 1KB in your Express app. Which code snippet correctly applies this condition using compression middleware?

hard

A. app.use(compression({ threshold: 1024 }));

B. app.use(compression({ minSize: 1024 }));

C. app.use(compression({ sizeLimit: 1024 }));

D. app.use(compression({ compressAbove: 1024 }));

Solution

1. Step 1: Recall compression middleware options

   The official compression middleware option to set minimum response size for compression is threshold, which accepts bytes.

2. Step 2: Match the correct option name and value

   Setting threshold: 1024 means compress responses only if size is greater than 1024 bytes (1KB).

3. Final Answer:

   app.use(compression({ threshold: 1024 })); -> Option A

4. Quick Check:

   Use threshold option to set minimum size [OK]

Hint: Use threshold option to set minimum compression size [OK]

Common Mistakes:

• Using incorrect option names like minSize or sizeLimit
• Not specifying size in bytes
• Assuming compression applies to all sizes by default