Cache interceptor in NestJS

Introduction

A cache interceptor helps save time by storing responses so the app doesn't have to redo work for the same request.

When you want to speed up responses for repeated requests.

When data doesn't change often and can be reused.

To reduce load on your server by avoiding repeated processing.

When you want to improve user experience by delivering faster results.

Syntax

NestJS

import { CacheInterceptor, ExecutionContext, Injectable } from '@nestjs/common';

@Injectable()
export class MyCacheInterceptor extends CacheInterceptor {
  trackBy(context: ExecutionContext): string | undefined {
    // custom cache key logic
    return super.trackBy(context);
  }
}

Extend CacheInterceptor to customize caching behavior.

Use trackBy method to define how cache keys are created.

Examples

This example shows using the default cache interceptor as is.

NestJS

import { CacheInterceptor } from '@nestjs/common';

// Use default cache interceptor without changes
export class DefaultCacheInterceptor extends CacheInterceptor {}

This example customizes the cache key to use the request URL.

NestJS

import { CacheInterceptor, ExecutionContext, Injectable } from '@nestjs/common';

@Injectable()
export class CustomCacheInterceptor extends CacheInterceptor {
  trackBy(context: ExecutionContext): string | undefined {
    const request = context.switchToHttp().getRequest();
    return request.url; // cache key based on URL
  }
}

Sample Program

This example shows a simple controller using the built-in CacheInterceptor. The first time you call the endpoint, it logs and returns the message. Next calls return cached data without logging.

NestJS

import { Controller, Get, UseInterceptors } from '@nestjs/common';
import { CacheInterceptor, Module } from '@nestjs/common';
import { CacheModule } from '@nestjs/cache-manager';

@Controller('hello')
@UseInterceptors(CacheInterceptor)
export class HelloController {
  @Get()
  getHello() {
    console.log('Generating response');
    return { message: 'Hello, world!' };
  }
}

@Module({
  imports: [CacheModule.register()],
  controllers: [HelloController],
  providers: [],
})
export class AppModule {}

Important Notes

Cache interceptor works best with GET requests because they are safe and idempotent.

Remember to enable CacheModule in your app to use caching.

Cached data is stored in memory by default but can be configured to use other stores.

Summary

Cache interceptor stores responses to speed up repeated requests.

Customize cache keys by extending and overriding trackBy.

Use with CacheModule and apply with @UseInterceptors(CacheInterceptor).

Practice

1. What is the main purpose of the CacheInterceptor in NestJS?

easy

A. To handle authentication and authorization

B. To store responses and speed up repeated requests

C. To log all incoming requests

D. To format response data before sending

Solution

1. Step 1: Understand the role of CacheInterceptor

   The CacheInterceptor caches HTTP responses to avoid recomputing them on repeated requests.

2. Step 2: Compare with other options

   Logging, authentication, and formatting are handled by other interceptors or middleware, not CacheInterceptor.

3. Final Answer:

   To store responses and speed up repeated requests -> Option B

4. Quick Check:

   CacheInterceptor caches responses = C [OK]

Hint: CacheInterceptor caches responses to speed up requests [OK]

Common Mistakes:

• Confusing CacheInterceptor with logging interceptors
• Thinking it handles security tasks
• Assuming it formats data

2. Which of the following is the correct way to apply the CacheInterceptor to a controller method in NestJS?

easy

A. Add CacheInterceptor in the constructor of the controller

B. @Cacheable() decorator on the method

C. @UseInterceptors(CacheInterceptor) above the method

D. Use @CacheInterceptor() as a method parameter

Solution

1. Step 1: Recall how to apply interceptors in NestJS

   Interceptors are applied using the @UseInterceptors() decorator above methods or controllers.

2. Step 2: Check each option

   Only @UseInterceptors(CacheInterceptor) above the method uses the correct decorator syntax. Options B, C, and D are invalid or do not exist in NestJS.

3. Final Answer:

   @UseInterceptors(CacheInterceptor) above the method -> Option C

4. Quick Check:

   UseInterceptors decorator = A [OK]

Hint: Use @UseInterceptors(CacheInterceptor) to apply caching [OK]

Common Mistakes:

• Using non-existent @Cacheable decorator
• Trying to inject interceptor in constructor
• Passing interceptor as method parameter

3. Given this code snippet, what will be the output on the second request to /hello?

import { Controller, Get, UseInterceptors } from '@nestjs/common';
import { CacheInterceptor } from '@nestjs/cache-manager';

@Controller()
export class HelloController {
  private count = 0;

  @UseInterceptors(CacheInterceptor)
  @Get('hello')
  getHello() {
    this.count++;
    return `Hello count: ${this.count}`;
  }
}

medium

A. "Hello count: 1" first request, "Hello count: 2" second request

B. Error because count is private

C. "Hello count: 0" on both requests

D. "Hello count: 1" on first and second request

Solution

1. Step 1: Understand CacheInterceptor behavior

   CacheInterceptor caches the response of the first request and returns it for subsequent requests without calling the method again.

2. Step 2: Analyze the count variable increment

   On the first request, count increments to 1 and returns "Hello count: 1". On the second request, the cached response is returned, so count does not increment again.

3. Final Answer:

   "Hello count: 1" on first and second request -> Option D

4. Quick Check:

   Cache returns cached response = B [OK]

Hint: CacheInterceptor returns cached response, method not re-executed [OK]

Common Mistakes:

• Assuming count increments on every request
• Thinking private variables cause errors here
• Ignoring caching effect on method execution

4. Identify the error in this NestJS CacheInterceptor usage:

import { Controller, Get, UseInterceptors } from '@nestjs/common';
import { CacheInterceptor } from '@nestjs/cache-manager';

@Controller()
export class TestController {
  @UseInterceptors(CacheInterceptor())
  @Get('test')
  test() {
    return 'Test response';
  }
}

medium

A. CacheInterceptor should not be called as a function

B. Missing CacheModule import in the controller

C. Method test must be async to use CacheInterceptor

D. CacheInterceptor must be applied globally, not per method

Solution

1. Step 1: Check how CacheInterceptor is applied

   CacheInterceptor is a class, not a function, so it should be passed without parentheses to @UseInterceptors().

2. Step 2: Verify other options

   CacheModule import is required but not shown here (not an error in this snippet). Method does not need to be async. CacheInterceptor can be applied per method.

3. Final Answer:

   CacheInterceptor should not be called as a function -> Option A

4. Quick Check:

   Use class name without () = A [OK]

Hint: Pass CacheInterceptor class, not call it as function [OK]

Common Mistakes:

• Calling CacheInterceptor with parentheses
• Assuming method must be async
• Thinking CacheModule import error here

5. You want to customize the cache key for a route in NestJS using CacheInterceptor. Which approach correctly achieves this?

hard

A. Extend CacheInterceptor and override the trackBy method to return a custom key

B. Pass a custom key string directly to @UseInterceptors(CacheInterceptor)

C. Set a custom key in the controller constructor

D. Use @CacheKey('customKey') decorator on the method

Solution

1. Step 1: Understand how to customize cache keys

   CacheInterceptor allows customization by extending it and overriding the trackBy method to define how keys are generated.

2. Step 2: Evaluate other options

   Passing a string to @UseInterceptors() is invalid. Setting keys in constructor or using @CacheKey decorator does not exist in NestJS.

3. Final Answer:

   Extend CacheInterceptor and override the trackBy method to return a custom key -> Option A

4. Quick Check:

   Override trackBy method = D [OK]

Hint: Override trackBy method in extended CacheInterceptor [OK]

Common Mistakes:

• Trying to pass key directly to decorator
• Using non-existent @CacheKey decorator
• Setting keys in constructor instead of method