Skip to main content

NestJS In-Memory Cache

In this article, we are going to explore the steps to implement the In-Memory Cache in the NestJS application.

Caching can significantly improve application performance and its scalability by reducing the workload to generate the content. In-Memory cache creates within the server application memory. Since it uses application memory it delivers content more fastly. But if our application runs on multiple nodes or multiple servers then the in-memory cache can't be shared between the nodes or server each will maintains its own in-memory cache.

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

Register CacheModule:

Now let's register the CacheModule in the AppModule file.
src/app.module.ts:
import { Module,  CacheModule } from '@nestjs/common';
// existing code hidden for display purpose

@Module({
  imports: [CacheModule.register()]
})
export class AppModule {}
  • Register the 'CacheModule' with empty configuration that means its automatically uses the In-memory cache.If we want to use external cache store like redis then we have to pass configuration values to the 'register()' method. The 'CacheModule' loads from the '@nestjs/common'.

Inject CacheManager:

Now to communicate with the cache store or memory we need to inject into our controller.
src/app.controller.ts:
import { Controller, Inject, CACHE_MANAGER } from '@nestjs/common';
import {Cache} from 'cache-manager';

@Controller()
export class AppController {
  constructor(@Inject(CACHE_MANAGER) private cacheManager: Cache) {}
}
  • The 'Cache' is the type of our cache store that loads from the 'cache-manager' library. The 'CACHE_MANAGER' is lookup key for the provider to be injected and this loads from the '@nestjs/common' library.

Get And Set Methods Of Cache Store:

The 'Set' method to save the data into our In-memory cache. The 'Get' method is to fetch data from the In-memory cache.

Let's create sample endpoint that saves and fetches the simple string from the In-Memory cache store.
src/app.controller.cs:
import { Controller, Get, Inject, CACHE_MANAGER } from '@nestjs/common';
import {Cache} from 'cache-manager';
@Controller()
export class AppController {

  myfakeDB:string ="naveen";

  constructor(@Inject(CACHE_MANAGER) private cacheManager: Cache) {}

  @Get('in-memory')
  async getFromMemoryCache(){
    let value = await this.cacheManager.get('name');
    if(value){
      return{
        dataFrom: 'In-memory Cache',
        name: value
      }
    }
    await this.cacheManager.set('name', this.myfakeDB, {ttl: 300} );
    return {
      dataFrom: 'Fake Database',
      name: this.myfakeDB
    }
  }
}
  • (Line: 6) The 'myfakeDB' variable let's assume like fetching the value from the database.
  • (Line: 12) The 'get()' method fetches the data saved in the In-memory cache store with respect to the 'key' passed to it. So here we are to check whether our data is available in the In-Memory cache or not.
  • (Line: 13-18) Return the response data from the In-memory cache.
  • (Line: 19) The 'set()' method to save the data from our application to the In-memory cache-store. While saving data we are passing our data expiration time as 300sec(5 minutes).
  • (Line: 20-23) Return the response data from the database(in our sample a fake data).
In the previous example, we stored simple string, but in real-time application mostly we have to store complex data. Our 'set' and 'get' methods support storing complex objects as well.
src/shared/models/Person.ts:
export interface Person {
  name: string;
  email: string;
}
Now let's update the endpoint to save the object type data into the In-Memory cache.
src/app.controller.ts:
import { Controller, Get, Inject, CACHE_MANAGER } from '@nestjs/common';
import {Cache} from 'cache-manager';
import { Person } from './shared/models/person';

@Controller()
export class AppController {

  myfakeDB:Person = {
    name:"naveen",
    email:"naveen@gmail.com"
  };

  constructor(@Inject(CACHE_MANAGER) private cacheManager: Cache) {}

  @Get('in-memory')
   async getFromMemoryCache(){
    let value = await this.cacheManager.get<Person>('user-info');
    if(value){
      return {
        dataFrom: 'From Cache',
        userInfo: value
      }
    }

    await this.cacheManager.set<Person>('user-info',this.myfakeDB, {ttl: 300});
    return {
      dataFrom: 'My Fake Database',
      userInfo: this.myfakeDB
    }
  }
}
Here we can observe the saving of complex objects into the In-Memory cache.

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 In-Memory cache.
await this.cacheManager.reset()
That's all about some core features to implement an In-Memory cache in the NestJS application.

Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

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

Follow Me:

Comments

  1. Thanks a lot. saved me a big time

    ReplyDelete
  2. Thanks for the article interesting I am implementing nestjs in our organization and found your article useful I do have an issue and hoping you could help i am getting a promise object returned when I do a get after a set

    ReplyDelete

Post a Comment

Popular posts from this blog

Endpoint Routing In Asp.Net Core

How Routing Works In  Core 2.1 And Below Versions?: In Asp.Net Core routing is configured using app.UseRouter() or app.UseMvc() middleware. app.UseMvc(routes => { routes.MapRoute( name: "default", template: "{controller=Home}/{action=Index}/{id?}"); }); Here in Dotnet Core version 2.1 or below versions on the execution of route middleware request will be navigated appropriate controller matched to the route. An operation or functionality which is dependent on route URL or route values and that need to be implemented before the execution of route middleware can be done by accessing the route path from the current request context as below app.Use(async (context, next) => { if(context.Request.Path.Value.IndexOf("oldvehicle") != -1) { context.Response.Redirect("vehicle"); } else { await next(); } }); app.UseMvc(routes => { routes.MapRoute( name: "vehicleRoute", template: "vehicle", defaul

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

Asp.Net Core MVC Form Validation Techniques

Introduction: Form validations in any applications are like assures that a valid data is storing on servers. All programing frameworks have their own individual implementations for form validations. In Dotnet Core MVC application server-side validations carried on by the models with the help of Data Annotations and the client-side validations carried by the plugin jQuery Unobtrusive Validation. jQuery Unobtrusive Validation is a custom library developed by Microsoft based on the popular library  jQuery Validate . In this article, we are going to learn how the model validation and client-side validation works in Asp.Net Core MVC Application with sample examples. Getting Started: Let's create an Asp.Net Core MVC application project using preferred editors like Microsoft Visual Studio or Microsoft Visual Studio Code. Here I'm using Visual Studio. Let's create an MVC controller and name it as 'PersonController.cs' and add an action method as bel

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

.NET Core MVC Application File Upload To Physical Location With Buffered Technique

Buffering Technique In File Upload: The server will use its Memory(RAM) or Disk Storage to save the files on receiving a file upload request from the client.  Usage of Memory(RAM) or Disk depends on the number of file requests and the size of the file.  Any single buffered file exceeding 64KB is moved from Memory to a temp file on disk.  If an application receives heavy traffic of uploading files there might be a chance of out of Disk or RAM memory which leads to crash application. So this Buffer technique used for small files uploading. In the following article, we create a sample for the file uploading using .NET Core MVC application. Create The .NET Core MVC Project: Let's create a .NET Core MVC project, here for this sample I'm using Visual Studio Code as below.   Check the link to use the Visual Studio Code for .NET Core Application . IFormFile: Microsoft.AspNetCore.Http.IFormFile used for file upload with buffered technique. On uploading files f

Ionic Picker Sample Code In Angular

Introduction: Ionic Picker(ion-picker) is a popup slides up from the bottom of the device screen, which contains rows with selectable column separated items. The main building block of ion-picker as follows: PickerController PickerOptions PickerController: PickerController object helps in creating an ion-picker overlay. create(opts?: Opts): Promise<Overlay> PickerController create method helps in create the picker overlay with the picker options PickerOptions: PickerOptions is a configuration object used by PickerController to display ion-picker. Single Column Ionic Picker: single.item.picker.ts: import { Component } from "@angular/core"; import { PickerController } from "@ionic/angular"; import { PickerOptions } from "@ionic/core"; @Component({ selector: "single-column-picker", templateUrl:"single.item.picker.html" }) export class SingleItemPicker { animals: string[] = ["Tiger&quo

.Net Core HttpClient JSON Extension Methods Using System.Net.Http.Json Package

.Net Core 3.0 onwards Microsoft brought up a new package called System.Net.Http.Json. This new package provides JSON extension methods for HttpClient. These JSON extension methods will have a prebuild mechanism for serializing or deserializing response data or payload of HttpClient call. System.Net.Http.Json extension methods that are provided to HttpClient, few of them are mentioned below. GetFromJsonAsync PostAsJsonAsync PutAsJsonAsync ReadFromJsonAsync In this article, we understand System.Net.Http.Json package by implementing the HttpClient samples by with and without JSON extension methods and compare them. Create A .Net Core Web API Sample Application: Let's create a .Net Core sample Web API application, from this application we will consume another Web API by implementing HttpClient calls. We can create a Web API sample application using IDE like Visual Studio 2019(Supports .Net Core 3.0 plus) or  Visual Studio Code . Create A Typed Client: In .Net Core using the Http

GraphQL API Integration In Asp.Net Core Application

Introduction: GraphQL is a query language for your API and a server-side runtime for executing queries by using a type system you define for your data. GraphQL can be integrated into any framework like ASP.NET, Java, NestJs, etc and it isn't tied to any specific database or storage engine and is instead backed by your existing code and data. How GraphQL API Different From Rest API: GraphQL exposes a single end-point or route for the entire application, regardless of its responses or actions. HTTP-POST is the only Http verb recommended by the GraphQL. The client applications (consumers of API) can give instructions to GraphQL API about what type of properties to be returned in the response. Building Blocks Of GraphQL API: The main building blocks of GraphQL API is Schemas and Types.  A 'Schema' in GrpahQL API describes the functionality available to the clients connect to API. Schema mostly consists of GraphQL Object Types, Queries, Mutations, etc. T

ASP.NET Core Web API Versioning

Introduction: An iteration and evolutionary changes of an ASP.NET Core Web API is handled by Versioning. Versioning of an API gives confidence to the clients which consumes API for a long time. Any changes or development of an API will be accessible using the new version and it won't cause issues to the clients consuming the old version of API. When To Use Versioning: Any API response changes. Developing an API by implementing testing levels like 'Alpha', 'Beta', and 'RC' versions before releasing Production. Deprecating an API which means API going to be removed or upgraded by a version within a short period. Versioning Types: Query String Versioning Url Path Versioning Media Type Versioning API Version Nuget: To Configure versioning to AspNet Core Web API Microsoft provided a library(Microsoft.AspNetCore.Mvc.Versioning). So to use the versioning library please install NuGet below.              Install-Package Microsoft.A

Blazor Server CRUD Operations

Introduction: Blazor Server is a web framework to develop server-side single-page applications. Blazor is made up of components with the combinations on C#, Html, CSS.  Blazor Server is production-ready from the .Net Core 3.0.  Blazor Server Working Mechanism: Blazor Server is a very light-weight web development framework.  In Blazor Server, not all code gets downloaded to the client browsers. Blazor Server made of components these components can be a block of code or page with respective navigation.  Blazor server application communicates with the server with a SignalR background connection which is inbuilt functionality. Application click,  form submission, change events, application page navigation every operation is carried out by the SignalR connection by communicating with the server.  Blazor updates the Html DOM very gently on every data update without any overhead. Blazor Server application maintains a nice intelligent tree structure to update the required inform