Skip to main content

Use Redis Cache In NestJS Application

Redis Cache:

Redis is an open-source in-memory data structure store, used as a database cache. It supports data structures such as strings, hashes, lists, sets, sorted sets with range queries, etc.

Caching can significantly improve application performance and its scalability by reducing the workload to generate the content. If our server application runs on multiple servers then it is easy to share the Redis Cache between them.

Setup Redis Docker Image Container:

For this sample to use Redis instance locally we will use Docker. If you don't have any prior knowledge of docker, not a problem just follow the steps below. Click here for a video session on Redis docker setup
Note:
Skip this section if you already have redis direct instance or azure or any cloud provider that have redis
Step1:
Download docker into our local system "https://docs.docker.com/desktop/". Docker was available for all desktop operating systems.
Step2:
After downloading the docker installer, then install it. Now to run any docker containers(eg: Redis, MongoDB, PostgreSQL, etc) this docker instance we just installed should be active(should be running).
Step3:
Now we need to pull the docker Redis image from the docker hub "https://hub.docker.com/_/redis".
Command To Pull Redis Image:
docker pull redis
Step4:
The final step to run the docker Redis image container by mapping our local system port. By default, the Redis instance runs with the '6379' default port inside of the docker container. So to access the Redis we need to port mapping on starting off the container.
Command To Start Redis Container:
docker run --name your_containerName -p your_PortNumber:6379 -d redis
The '--name your_containerName' flag to specify the Redis container name. The '-p your_PortNumber:6379' mapping the Redis port '6379' to our local machine port all our application will use local machine port to communicate with Redis. The '-d' flag represents to run the container in the detached mode which means run in the background. At the last of the command 'redis' to specify the image to run in our container.
Step5:
After creating a docker container, it will be stored in our local machine so to start again the container any time run the following command
docker start your_container_name

Step6:(Optional Step)
Let test our Redis instance

Command To Use Redis CLI
docker exec -it your_docker_container_name redis-cli

Create A Sample NestJS Application:

Let's understand step by step implementation authentication in NestJs application, so let's begin our journey by creating a sample application.
Command To Install CLI:
npm i -g @nestjs/cli
Command To Create NestJS App:
nest new your_project_name

Install Cache Npm Packages:

NestJS Cache NPM Packages:
npm install cache-manager
npm install -D @types/cache-manager
npm install cache-manager-redis-store --save

Redis Store Configurations:

Now let's register the CacheModule with the Redis Store configurations in AppModule.
src/app.module.ts:
import { Module, CacheModule } from '@nestjs/common';
import * as redisStore from 'cache-manager-redis-store';
// code hidden for display purpose
@Module({
  imports: [CacheModule.register({
    store:redisStore,
    host: 'localhost',
    port: 5003
  })]
})
export class AppModule {}
  • Imported 'CacheModule' that loads from '@nestjs/common' library. 
  • The 'register' method of CacheModule takes our Redis Store configuration for communication. 
  • The 'store' property assigned with 'redisStore' variable that represents the 'cache-manager-redis-store' library. 
  • The 'host' property must assign our Redis store value since here I'm using a local Redis instance my hostname will be 'localhost'. 
  • The 'post' property contains the Redis store running the port.

Inject CacheManager:

Now in our controllers to communicate with the Redis store we need to inject the CacheManager.
import { Controller, Get, Inject, CACHE_MANAGER } from '@nestjs/common';
import {Cache} from 'cache-manager';

@Controller()
export class AppController {
  constructor(@Inject(CACHE_MANAGER) private cacheManager: Cache) {}
}
  • The 'Cache' type is generic that works with any cache store and provides default methods for cache communication. The 'CACHE_MANAGER' is a lookup for the provider to be injected which means it will inject the cache-store that is registered by the CacheModule, in our sample, it will inject Redis cache-store.

Get And Set Methods:

The 'Set' method is to store our data in the Redis store. The 'Get' method to fetch data from the Redis store.

Let's store a simple string and fetch it from the Redis store by creating a sample endpoint.
src/app.controller.cs:
import { Controller, Get, Inject, CACHE_MANAGER } from '@nestjs/common';
import {Cache} from 'cache-manager';

@Controller()
export class AppController {
  fakeString = "my name is naveen"
  constructor(@Inject(CACHE_MANAGER) private cacheManager: Cache) {}
  @Get("simple-string-fetch")
  async setGetSimpleString(){
    var value = await this.cacheManager.get('my-string');
    if(value){
      return {
        data: value,
        loadsFrom: 'redis cache'
      }
    }
    await this.cacheManager.set('my-string', this.fakeString,{ttl:300});
    return{
      data:this.fakeString,
      loadsFrom:'fake database'
    }
  }
}
  • (Line: 6) The 'fakeString' variable will be used to store and fetch from the Redis store.
  • (Line: 10) Here first we are trying to fetch the data from the Redis store by using the key 'my-string'.
  • (Line: 11-16) If data exist in the Redis store then returns it as the output of the endpoint.
  • (Line: 17) If data did not exist in the Redis store then we have to store it in the Redis store using my key 'my-string'. The property 'ttl'(Time To Live) set to 300sec(5minutes) as expiration.
  • (Line: 18) Returns the data from the database(Here I'm using the constant variable in real application data needs to be loaded from the database) for the first request.
In the above example, we saved and fetched the simple string from the Redis store. But in the real-time application, we need to store the complex data and fetch it from the Redis store. Our 'Get' and 'Set' method has the capability to save and fetch type objects into the Redis store. Redis stores only the string of data, so if we try to save object data then implicit serialization will be carried out by the 'Set' and 'Get' methods.

Let's create an object that we want to store its data in the Redis store.
src/shared/model/profile.ts:
export interface Profile {
    name:string,
    email:string
}
Let's create a new endpoint that stores the object in the Redis store.
src/app.controller.ts:
import { Controller, Get, Inject, CACHE_MANAGER } from '@nestjs/common';
import {Cache} from 'cache-manager';
import { Profile } from './shared/models/profile';

@Controller()
export class AppController {
  fakeData:Profile = {
    name:'naveen',
    email:'naveen@gmail.com'
  }
  constructor(@Inject(CACHE_MANAGER) private cacheManager: Cache) {}

  @Get("fetch-object-cache")
  async getCache(){
    var data = await this.cacheManager.get<Profile>('my-object');
    if(data){
      return {
        data:data,
        loadsFrom: 'cache'
      };
    }

    await this.cacheManager.set<Profile>('my-object', this.fakeData, {ttl: 300});
    return{
      data:this.fakeData,
      loadFrom:'fake data base'
    }
  }
}

Del And Reset Methods Of Cache-Store:

The cache store provides the method 'del('key')'  used to delete the record from the cache.
await this.cacheManager.del('your_key_to_delte');
The cache store provides the method 'reset()' used to clear the entire Redis store cache. 
await this.cacheManager.reset()

Auto Cache Using Interceptor:

Using 'CacheInterceptor' we can enable auto cache on the controller which will affect all 'Get' action methods inside of the controller. In the auto cache, the 'key' value for storing cache will use the route value as key.

Let's update the AppModule to import the 'CacheInterceptor' provider and also need to configure the expiration globally that will be used by the auto cache.
src/app.module.ts:
import { Module, CacheModule, CacheInterceptor } from '@nestjs/common';
import * as redisStore from 'cache-manager-redis-store';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import {APP_INTERCEPTOR} from '@nestjs/core';

@Module({
  imports: [CacheModule.register({
    store:redisStore,
    host: 'localhost',
    port: 5003,
    ttl:300
  })],
  controllers: [AppController],
  providers: [
    {
      provide:APP_INTERCEPTOR,
      useClass: CacheInterceptor
    },
    AppService
  ],
})
export class AppModule {}
  • The 'CacheInterceptor' will enables the auto cache to the application. Its loads from the '@nestjs/common' library. To enable it we need to import it into the provider's array.
  • (Line: 12)Cache expiration time set globally using 'ttl' property. So this expiration will be utilized by the auto cache as well.
Now add the 'UseInterceptors' decorator on top of the controller and passing 'CacheInterceptor' as input which will trigger auto cache for all 'Get' endpoint inside the controller.
src/app.controller.cs:
import { Controller, Get, UseInterceptors, CacheInterceptor } from '@nestjs/common';

import { Profile } from './shared/models/profile';

@Controller()
@UseInterceptors(CacheInterceptor)
export class AppController {
  fakeData:Profile = {
    name:'naen',
    email:'naveen@gmail.com'
  }
  constructor() {}

  @Get("auto-cache")
  get(){
    return this.fakeData;
  }
}


Now to test that auto cache saved to our Redis store, I'm going to check for the 'key' value using the Redis CLI.

Override Auto Cache Key Name And Expiration:

An auto cache by default uses the endpoint rout value as 'key' to store into Redis store and uses the global configuration 'ttl' property for expiration. But we can override them by using decorator like '@CacheKey' to give our own 'key' to store data in the Redis store and '@CacheTTL' to set the expiration time which will override the global expiration.

Let's update our endpoint to use '@CacheKey', '@CacheTTL' decorators.
src/app.controller.cs:
import { Controller, 
Get, UseInterceptors, 
CacheInterceptor, CacheKey, CacheTTL } from '@nestjs/common';
import { Profile } from './shared/models/profile';

@Controller()
@UseInterceptors(CacheInterceptor)
export class AppController {
  fakeData:Profile = {
    name:'naen',
    email:'naveen@gmail.com'
  }
  constructor() {}

  @Get("auto-cache")
  @CacheKey('myCustomKey')
  @CacheTTL(300)
  get(){
    return this.fakeData;
  }
}
  • (Line: 16) The '@CacheKey' decorator to give a custom 'key' name for the auto cache.
  • (Line: 17) The '@CacheTTL' overrides the global expiration and can set the expiration for the action method level.
That's all about the implementation of the Redis store into the NestJS application.

Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

Hopefully, I think this article delivered some useful information on Redis Store in the NestJS application. I love to have your feedback, suggestions, and better techniques in the comment section below.

Refer:

Follow Me:

Labels:

Comments

  1. KiranimeApril 27, 2022 at 2:04 AM

    thank you. This helped me to understand how redis work with nestjs.

    ReplyDelete

Post a Comment

Popular posts from this blog

Angular 14 Reactive Forms Example

In this article, we will explore the Angular(14) reactive forms with an example. Reactive Forms: Angular reactive forms support model-driven techniques to handle the form's input values. The reactive forms state is immutable, any form filed change creates a new state for the form. Reactive forms are built around observable streams, where form inputs and values are provided as streams of input values, which can be accessed synchronously. Some key notations that involve in reactive forms are like: FormControl - each input element in the form is 'FormControl'. The 'FormControl' tracks the value and validation status of form fields. FormGroup - Track the value and validate the state of the group of 'FormControl'. FormBuilder - Angular service which can be used to create the 'FormGroup' or FormControl instance quickly. Form Array - That can hold infinite form control, this helps to create dynamic forms. Create An Angular(14) Application: Let'
3 comments
Read more

.NET 7 Web API CRUD Using Entity Framework Core

In this article, we are going to implement a sample .NET 7 Web API CRUD using the Entity Framework Core. Web API: Web API is a framework for building HTTP services that can be accessed from any client like browser, mobile devices, and desktop apps. In simple terminology API(Application Programming Interface) means an interface module that contains programming functions that can be requested via HTTP calls either to fetch or update data for their respective clients. Some of the Key Characteristics of API: Supports HTTP verbs like 'GET', 'POST', 'PUT', 'DELETE', etc. Supports default responses like 'XML' and 'JSON'. Also can define custom responses. Supports self-hosting or individual hosting, so that all different kinds of apps can consume it. Authentication and Authorization are easy to implement. The ideal platform to build the REST full services. Install The SQL Server And SQL Management Studio: Let's install the SQL server on our l
3 comments
Read more

ReactJS(v18) JWT Authentication Using HTTP Only Cookie

In this article, we will implement the ReactJS application authentication using the HTTP-only cookie. HTTP Only Cookie: In a SPA(Single Page Application) Authentication JWT token either can be stored in browser 'LocalStorage' or in 'Cookie'. Storing the JWT token inside of the cookie then the cookie should be HTTP Only. The HTTP-ONly cookie nature is that it will be only accessible by the server application. Client apps like javascript-based apps can't access the HTTP-Only cookie. So if we use the authentication with HTTP-only JWT cookie then we no need to implement the custom logic like adding authorization header or storing token data, etc at our client application. Because once the user authenticated cookie will be automatically sent to the server by the browser on every API call. Authentication API: To authenticate our client application with JWT HTTP-only cookie, I developed a NetJS(which is a node) Mock API. Check the GitHub link and read the document on G
3 comments
Read more

.NET6 Web API CRUD Operation With Entity Framework Core

In this article, we are going to do a small demo on AspNetCore 6 Web API CRUD operations. What Is Web API: Web API is a framework for building HTTP services that can be accessed from any client like browser, mobile devices, desktop apps. In simple terminology API(Application Programming Interface) means an interface module that contains a programming function that can be requested via HTTP calls to save or fetch the data for their respective clients. Some of the key characteristics of API: Supports HTTP verbs like 'GET', 'POST', 'PUT', 'DELETE', etc. Supports default responses like 'XML' and 'JSON'. Also can define custom responses. Supports self-hosting or individual hosting, so that all different kinds of apps can consume it. Authentication and Authorization are easy to implement. The ideal platform to build REST full services. Create A .NET6 Web API Application: Let's create a .Net6 Web API sample application to accomplish our
6 comments
Read more

Angular 14 State Management CRUD Example With NgRx(14)

In this article, we are going to implement the Angular(14) state management CRUD example with NgRx(14) NgRx Store For State Management: In an angular application to share consistent data between multiple components, we use NgRx state management. Using NgRx state helps to avoid unwanted API calls, easy to maintain consistent data, etc. The main building blocks for the NgRx store are: Actions - NgRx actions represents event to trigger the reducers to save the data into the stores. Reducer - Reducer's pure function, which is used to create a new state on data change. Store - The store is the model or entity that holds the data. Selector - Selector to fetch the slices of data from the store to angular components. Effects - Effects deals with external network calls like API. The effect gets executed based the action performed Ngrx State Management flow: The angular component needs data for binding.  So angular component calls an action that is responsible for invoking the API call.  Aft
8 comments
Read more

Angular 14 Crud Example

In this article, we will implement CRUD operation in the Angular 14 application. Angular: Angular is a framework that can be used to build a single-page application. Angular applications are built with components that make our code simple and clean. Angular components compose of 3 files like TypeScript File(*.ts), Html File(*.html), CSS File(*.cs) Components typescript file and HTML file support 2-way binding which means data flow is bi-directional Component typescript file listens for all HTML events from the HTML file. Create Angular(14) Application: Let's create an Angular(14) application to begin our sample. Make sure to install the Angular CLI tool into our local machine because it provides easy CLI commands to play with the angular application. Command To Install Angular CLI npm install -g @angular/cli Run the below command to create the angular application. Command To Create Angular Application ng new name_of_your_app Note: While creating the app, you will see a noti
5 comments
Read more

Unit Testing Asp.NetCore Web API Using xUnit[.NET6]

In this article, we are going to write test cases to an Asp.NetCore Web API(.NET6) application using the xUnit. xUnit For .NET: The xUnit for .Net is a free, open-source, community-focused unit testing tool for .NET applications. By default .Net also provides a xUnit project template to implement test cases. Unit test cases build upon the 'AAA' formula that means 'Arrange', 'Act' and 'Assert' Arrange - Declaring variables, objects, instantiating mocks, etc. Act - Calling or invoking the method that needs to be tested. Assert - The assert ensures that code behaves as expected means yielding expected output. Create An API And Unit Test Projects: Let's create a .Net6 Web API and xUnit sample applications to accomplish our demo. We can use either Visual Studio 2022 or Visual Studio Code(using .NET CLI commands) to create any.Net6 application. For this demo, I'm using the 'Visual Studio Code'(using the .NET CLI command) editor. Create a fo
7 comments
Read more

Part-1 Angular JWT Authentication Using HTTP Only Cookie[Angular V13]

In this article, we are going to implement a sample angular application authentication using HTTP only cookie that contains a JWT token. HTTP Only JWT Cookie: In a SPA(Single Page Application) Authentication JWT token either can be stored in browser 'LocalStorage' or in 'Cookie'. Storing JWT token inside of the cookie then the cookie should be HTTP Only. The HTTP-Only cookie nature is that it will be only accessible by the server application. Client apps like javascript-based apps can't access the HTTP-Only cookie. So if we use authentication with HTTP only JWT cookie then we no need to implement custom logic like adding authorization header or storing token data, etc at our client application. Because once the user authenticated cookie will be automatically sent to the server by the browser on every API call. Authentication API: To implement JWT cookie authentication we need to set up an API. For that, I had created a mock authentication API(Using the NestJS Se
Post a Comment
Read more

ReactJS(v18) Authentication With JWT AccessToken And Refresh Token

In this article, we are going to do ReactJS(v18) application authentication using the JWT Access Token and Refresh Token. JSON Web Token(JWT): JSON Web Token is a digitally signed and secured token for user validation. The JWT is constructed with 3 important parts: Header Payload Signature Create ReactJS Application: Let's create a ReactJS application to accomplish our demo. npx create-react-app name-of-your-app Configure React Bootstrap Library: Let's install the React Bootstrap library npm install react-bootstrap bootstrap Now add the bootstrap CSS reference in 'index.js'. src/index.js: import 'bootstrap/dist/css/bootstrap.min.css' Create A React Component 'Layout': Let's add a React component like 'Layout' in 'components/shared' folders(new folders). src/components/shared/Layout.js: import Navbar from "react-bootstrap/Navbar"; import { Container } from "react-bootstrap"; import Nav from "react-boot
Post a Comment
Read more

A Small Guide On NestJS Queues

NestJS Application Queues helps to deal with application scaling and performance challenges. When To Use Queues?: API request that mostly involves in time taking operations like CPU bound operation, doing them synchronously which will result in thread blocking. So to avoid these issues, it is an appropriate way to make the CPU-bound operation separate background job.  In nestjs one of the best solutions for these kinds of tasks is to implement the Queues. For queueing mechanism in the nestjs application most recommended library is '@nestjs/bull'(Bull is nodejs queue library). The 'Bull' depends on Redis cache for data storage like a job. So in this queueing technique, we will create services like 'Producer' and 'Consumer'. The 'Producer' is used to push our jobs into the Redis stores. The consumer will read those jobs(eg: CPU Bound Operations) and process them. So by using this queues technique user requests processed very fastly because actually
8 comments
Read more