Compression and security headers in NestJS

Introduction

Compression makes your app faster by shrinking data sent to users. Security headers protect your app from common web attacks.

When you want your NestJS app to load faster by sending smaller files.

When you want to stop hackers from doing bad things like stealing data or running harmful scripts.

When you want to improve your website's safety and user trust.

When you want to follow best practices for web app performance and security.

When you want to control how browsers handle your app's content.

Syntax

NestJS

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import * as compression from 'compression';
import * as helmet from 'helmet';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);

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

  // Enable security headers middleware
  app.use(helmet());

  await app.listen(3000);
}
bootstrap();

Use compression() to reduce response size and speed up loading.

Use helmet() to add many security headers easily.

Examples

This adds gzip compression to all responses, making data smaller.

NestJS

app.use(compression());

This adds default security headers like Content-Security-Policy and X-Frame-Options.

NestJS

app.use(helmet());

This customizes the Content Security Policy header to allow scripts only from your site and trusted.com.

NestJS

app.use(helmet.contentSecurityPolicy({
  directives: {
    defaultSrc: ["'self'"],
    scriptSrc: ["'self'", 'trusted.com'],
  },
}));

Sample Program

This simple NestJS app uses compression to speed up responses and helmet to add security headers. When you visit http://localhost:3000, it returns a JSON message with compression and security headers applied.

NestJS

import { NestFactory } from '@nestjs/core';
import { Module, Controller, Get } from '@nestjs/common';
import * as compression from 'compression';
import * as helmet from 'helmet';

@Controller()
class AppController {
  @Get()
  getHello() {
    return { message: 'Hello, world!' };
  }
}

@Module({
  controllers: [AppController],
})
class AppModule {}

async function bootstrap() {
  const app = await NestFactory.create(AppModule);

  // Enable compression
  app.use(compression());

  // Enable security headers
  app.use(helmet());

  await app.listen(3000);
  console.log('App running on http://localhost:3000');
}
bootstrap();

Important Notes

Compression works best for text data like JSON, HTML, and CSS.

Helmet sets many headers by default, but you can customize or disable parts if needed.

Test your app in browser DevTools Network tab to see compressed responses and security headers.

Summary

Compression makes your app faster by shrinking data sent to users.

Security headers protect your app from common web attacks.

In NestJS, use compression and helmet middleware to add these features easily.

Practice

1. What is the main purpose of using compression middleware in a NestJS application?

easy

A. To reduce the size of response data sent to clients

B. To add security headers to HTTP responses

C. To log incoming requests for debugging

D. To handle database connections efficiently

Solution

1. Step 1: Understand what compression middleware does

   The compression middleware compresses HTTP response bodies to reduce their size.

2. Step 2: Identify the effect on client-server communication

   Smaller response sizes mean faster data transfer and improved app speed.

3. Final Answer:

   To reduce the size of response data sent to clients -> Option A

4. Quick Check:

   Compression = smaller response size [OK]

Hint: Compression shrinks data sent to users for speed [OK]

Common Mistakes:

• Confusing compression with security features
• Thinking compression logs requests
• Assuming compression manages databases

2. Which of the following is the correct way to apply helmet middleware in a NestJS main.ts file?

easy

A. app.apply(helmet);

B. app.helmet();

C. helmet(app);

D. app.use(helmet());

Solution

1. Step 1: Recall the NestJS middleware usage pattern

   Middleware is applied using app.use() with the middleware function as argument.

2. Step 2: Check the syntax for helmet middleware

   The correct syntax is app.use(helmet()); to apply helmet with default settings.

3. Final Answer:

   app.use(helmet()); -> Option D

4. Quick Check:

   Middleware applied with app.use() [OK]

Hint: Use app.use() to add middleware like helmet [OK]

Common Mistakes:

• Calling helmet as a method on app
• Passing app as argument to helmet
• Using app.apply() which is invalid

3. Given this NestJS setup in main.ts:

import * as compression from 'compression';
import * as helmet from 'helmet';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  app.use(compression());
  app.use(helmet());
  await app.listen(3000);
}

What will be the effect on HTTP responses?

medium

A. No effect; middleware is not applied correctly

B. Responses will be compressed and have security headers added

C. Responses will only have security headers, no compression

D. Responses will only be compressed, no security headers

Solution

1. Step 1: Analyze middleware usage in the code

   Both compression() and helmet() are applied using app.use(), which is correct.

2. Step 2: Understand middleware effects

   Compression middleware compresses responses; helmet adds security headers.

3. Final Answer:

   Responses will be compressed and have security headers added -> Option B

4. Quick Check:

   Both compression and helmet applied = compressed + secure headers [OK]

Hint: Both middlewares applied means both effects present [OK]

Common Mistakes:

• Thinking only one middleware works at a time
• Assuming middleware needs special chaining
• Believing middleware is ignored without extra config

4. Identify the error in this NestJS main.ts snippet:

import helmet from 'helmet';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  app.use(helmet);
  await app.listen(3000);
}

medium

A. helmet is not called as a function before passing to app.use

B. helmet should be imported with * as helmet from 'helmet'

C. app.listen should be called before app.use

D. NestFactory.create requires an options object

Solution

1. Step 1: Check how helmet middleware is passed

   Middleware functions must be called to return a function; here helmet is passed without parentheses.

2. Step 2: Confirm correct usage

   The correct usage is app.use(helmet()); to apply helmet middleware.

3. Final Answer:

   helmet is not called as a function before passing to app.use -> Option A

4. Quick Check:

   Middleware must be called: helmet() [OK]

Hint: Always call middleware functions before app.use [OK]

Common Mistakes:

• Passing middleware reference without calling it
• Importing helmet incorrectly but that still works with default export
• Calling app.listen before middleware setup

5. You want to add compression and security headers in a NestJS app but only compress responses larger than 1KB and disable the X-Powered-By header. Which setup achieves this?

hard

A. app.use(compression({ minSize: 1024 })); app.use(helmet({ hidePoweredBy: true }));

B. app.use(compression({ threshold: 1024 })); app.use(helmet.hidePoweredBy());

C. app.use(compression({ threshold: 1024 })); app.use(helmet({ hidePoweredBy: true }));

D. app.use(compression()); app.use(helmet({ disablePoweredBy: true }));

Solution

1. Step 1: Configure compression threshold correctly

   The compression middleware option to set minimum size is threshold, so { threshold: 1024 } means compress responses over 1KB.

2. Step 2: Disable X-Powered-By header using helmet option

   Helmet's option to hide this header is hidePoweredBy: true.

3. Final Answer:

   app.use(compression({ threshold: 1024 })); app.use(helmet({ hidePoweredBy: true })); -> Option C

4. Quick Check:

   Compression threshold + hidePoweredBy option [OK]

Hint: Use compression threshold and helmet hidePoweredBy option [OK]

Common Mistakes:

• Using wrong option name like minSize or disablePoweredBy
• Calling helmet.hidePoweredBy() which does not exist
• Not setting threshold causing all responses compressed