Skip to main content

Use Azure Cache For Redis In NestJS Application

In this article, we are going to do a small demo on the integration of Azure Redis Cache into the 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, stored sets with range queries, etc.
Let's understand the flow of Redis cache in a web application:
  • Users request a page from the web application.
  • Web application queries the Redis store, if the data exists, then fetches the data and returns the response directly to the user.
  • If no data is in the Redis store, the application queries the database and fetches the data, next save the same data into the Redis store so that subsequent user request can consume the data from the Redis store directly, finally returns the response to the users.

Create A Azure Redis Cache:

Step:1
Create and sign-in into the Azure portal(https://portal.azure.com/)

Step:2
On the Azure portal home page click on 'Create a resource'.
Step:3
On the 'Create a resource' page select the 'Databases' and then select 'Azure Cache for Redis'.
Step4:
(1)On the 'New Redis Cache' page, enter the project details.
  • Subscription- Choose your subscription plan from the dropdown.
  • Resource group - Either create a new resource group or select an existing group from the drop-down.
  • DNS name- Enter the name of your Redis instance subdomain name.
  • Location- Choose your server location from the dropdown.
  • Cache type- Select pricing plans for Redis usage. no free plans on it.
(2)Choose your type of 'Network Connectivity'.
(3)In the 'Advanced' tab you can choose the version of the Redis instance.
(4)The 'Tags', name/value pairs is an optional section.
(5)Finally, select 'Review+ Create', on successful validation, select 'create', on success in a few minutes our Redis instance will be ready.

Create A NestJS Sample Application:

Let's create a sample NestJS application to accomplish our demo.
Command To Install NestJS 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

Azure Redis ConnectionString:

(1)On the Azure portal home page click on 'Resource groups'.
(2) On the 'Resource groups' page, select the resource group that has our Azure cache for Redis.
(3) Now click 'Azure Cache for Redis' instance.
(4) Now under 'Settings' select 'Access Keys', then copy the connection string either primary or secondary connection string.

In the connection string, we have to identify like 'Host Name', 'Port Number', 'Password'.

Redis Store Configuration:

Now let's register the CacheModule with the Redis Store configuration in AppModule.
src/app.module.ts:
import { Module, CacheModule } from '@nestjs/common';
import * as redisStore from 'cache-manager-redis-store';

// existing code hidden for display purpose

@Module({
  imports: [CacheModule.register({
    store: redisStore,
    port:6380,
    auth_pass:"your_azure_redis_password",
    host:"your_azure_redis_host_name",
    tls:{
      host:"your_azure_redis_host_name"
    },
    
  })]
})
export class AppModule {}
  • (Line: 1) The 'CacheModule' loads from the '@nestjs/common'.
  • (Line: 2) Importing the 'cache-manager-redis-store' library.
  • (Line: 7-16) Registered the 'CahceModule' with Redis configurations. The 'store' define type of cache, 'port' is our Azure Redis cache running port number, 'auth_pass' is our Azure Redis cache password, 'host' is our Azure Redis hostname, 'tls' means Transport Layer Security that is by default enabled by the Azure Redis cache so it is mandatory to define the 'tls' configuration and inside of it we have to specify our Redis hostname again.

Inject CacheManager:

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

@Controller()
export class AppController {
  constructor(@Inject(CACHE_MANAGER) private cacheManager: Cache) {}
}
  • The 'Cache' type is generic and 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.

Create A Sample Response Model:

Now let's create a sample API response model like 'car.ts'.
src/car.ts:
export interface Car {
  id: number;
  manufacturer: string;
  model: string;
  year: number;
}
Now in 'app.controller.ts' for demo purposes let's add a variable that contains mock data or test data of type 'Car'. In a real application, data need to be fetched from the database, for demo purposes just storing in a variable.
src/app.controller.ts:
// existing code hidden for display purpose
export class AppController {
  fakeDatabase: Car[] = [
    {
      id: 1,
      manufacturer: 'Honda',
      model: 'Civic',
      year: 2021,
    },
    {
      id: 2,
      manufacturer: 'Hundyi',
      model: 'Venue',
      year: 2022,
    },
  ];
}

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 sample string and fetch it from the Redis store by creating a sample endpoint.
src/app.controller.ts:
@Get()
async getCars() {
	var carsFromRedis = await this.cacheManager.get<Car[]>('cars-store');

	if (carsFromRedis && carsFromRedis.length > 0) {
	  return { loadedFromRedis: true, data: carsFromRedis };
	}

	await this.cacheManager.set<Car[]>("cars-store", this.fakeDatabase)
	return { loadedFromRedis: false, data: this.fakeDatabase };
}
  • (Line: 3) Using 'get<Car[]>()' method of cache manager trying to fetch data from the Redis store.
  • (Line: 5-7) If Redis store returns the property data then we will return it as a response to our endpoint. Here for understanding, I have added property like 'loadedFromRedis' to the response(don't add a property like this for real applications).
  • (Line: 9) If the Redis store doesn't have data then this gets executed. Here using the 'set<Car[]>()' method we are saving the data to the Redis store with an appropriate key.
Now run the application, for the first request we can observe no data in Redis.
Now from the 2nd request data gets loads from the Redis server.

Cache Expiration:

It is always recommended to specify the expiration value for the cache. So we have to approach to define cache values like 'Global Level', 'Endpoint Level'.

Defining Global level expiration sets the same expiration value for all the data that we stored in the Redis store.
src/app.module.ts:
CacheModule.register({
    store: redisStore,
    port:6380,
    auth_pass:"your_azure_redis_password",
    host:"your_azure_redis_host",
    tls:{
      host:"your_azure_redis_host"
    },
    ttl: 300 // define time in seconds
}
  • Here the 'ttl' property contains time seconds for expiration. So here I define expiration like all Redis cache store data will be expired after 300 seconds.
Defining Endpoint level expiration sets individual expiration values for each endpoint. This can be done by using a decorator like '@CacheTTL(specify_expiration_in_seconds)'. The '@CacheTTL()' overrides the Global expiration that we defined above.
src/app.controller.cs:
@Get()
@CacheTTL(50)
async getCars() {
	var carsFromRedis = await this.cacheManager.get<Car[]>('cars-store');
	if (carsFromRedis && carsFromRedis.length > 0) {
	  return { loadedFromRedis: true, data: carsFromRedis };
	}

	await this.cacheManager.set<Car[]>("cars-store", this.fakeDatabase)
	return { loadedFromRedis: false, data: this.fakeDatabase };
}
  • (Line: 2) Used endpoint level expiration on a method by decorating with '@CacheTTL()'

Del And Reset Methods:

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()

Support Me!
Buy Me A Coffee PayPal Me

Video Session:

Wrapping Up:

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

Follow Me:

Comments

Popular posts from this blog

.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

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

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

Usage Of CancellationToken In Asp.Net Core Applications

When To Use CancellationToken?: In a web application request abortion or orphan, requests are quite common. On users disconnected by network interruption or navigating between multiple pages before proper response or closing of the browser, tabs make the request aborted or orphan. An orphan request can't deliver a response to the client, but it will execute all steps(like database calls, HTTP calls, etc) at the server. Complete execution of an orphan request at the server might not be a problem generally if at all requests need to work on time taking a job at the server in those cases might be nice to terminate the execution immediately. So CancellationToken can be used to terminate a request execution at the server immediately once the request is aborted or orphan. Here we are going to see some sample code snippets about implementing a CancellationToken for Entity FrameworkCore, Dapper ORM, and HttpClient calls in Asp.NetCore MVC application. Note: The sample codes I will show in

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

Blazor WebAssembly Custom Authentication From Scratch

In this article, we are going to explore and implement custom authentication from the scratch. In this sample, we will use JWT authentication for user authentication. Main Building Blocks Of Blazor WebAssembly Authentication: The core concepts of blazor webassembly authentication are: AuthenticationStateProvider Service AuthorizeView Component Task<AuthenticationState> Cascading Property CascadingAuthenticationState Component AuthorizeRouteView Component AuthenticationStateProvider Service - this provider holds the authentication information about the login user. The 'GetAuthenticationStateAsync()' method in the Authentication state provider returns user AuthenticationState. The 'NotifyAuthenticationStateChaged()' to notify the latest user information within the components which using this AuthenticationStateProvider. AuthorizeView Component - displays different content depending on the user authorization state. This component uses the AuthenticationStateProvider

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'

How Response Caching Works In Asp.Net Core

What Is Response Caching?: Response Caching means storing of response output and using stored response until it's under it's the expiration time. Response Caching approach cuts down some requests to the server and also reduces some workload on the server. Response Caching Headers: Response Caching carried out by the few Http based headers information between client and server. Main Response Caching Headers are like below Cache-Control Pragma Vary Cache-Control Header: Cache-Control header is the main header type for the response caching. Cache-Control will be decorated with the following directives. public - this directive indicates any cache may store the response. private - this directive allows to store response with respect to a single user and can't be stored with shared cache stores. max-age - this directive represents a time to hold a response in the cache. no-cache - this directive represents no storing of response and always fetch the fr

Different HttpClient Techniques To Consume API Calls In Minimal API[.NET6]

In this article, we are going to implement different HttpClient techniques to consume API calls in minimal API. The different HttpClient techniques that we are going to explore are like: Register HttpClient Object Explicitly In DI(Dependency Injection Service) Named Client Type Client HttpRequestMessage Object Create A .NET6 Minimal API Project: Let's create a .Net6 Minimal API sample project 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. CLI command For Minimal API Project dotnet new webapi -minimal -o Your_Project_Name Create A Third Party API Response Model: Here I'm going to use a free third-party rest API that is "https://jsonplaceholder.typicode.com/posts". So to receive the response let's create a response model like 'Post.cs'. Program.cs:(Add Post.cs c

.Net5 Web API Managing Files Using Azure Blob Storage

In this article, we are going to understand the different file operations like uploading, reading, downloading, and deleting in .Net5 Web API application using Azure Blob Storage. Azure Blob Storage: Azure blob storage is Microsoft cloud storage. Blob storage can store a massive amount of file data as unstructured data. The unstructured data means not belong to any specific type, which means text or binary data. So something like images or pdf or videos to store in the cloud, then the most recommended is to use the blob store. The key component to creating azure blob storage resource: Storage Account:- A Storage account gives a unique namespace in Azure for all the data we will save. Every object that we store in Azure Storage has an address. The address is nothing but the unique name of our Storage Account name. The combination of the account name and the Azure Storage blob endpoint forms the base address for each object in our Storage account. For example, if our Storage Account is n