feat: adds caching to costly endpoints

package.json

@@ -36,6 +36,7 @@
   },
   "dependencies": {
     "@aeternity/aepp-sdk": "^13.3.2",
+    "@nestjs/cache-manager": "^2.2.2",
     "@nestjs/common": "^10.3.3",
     "@nestjs/core": "^10.3.3",
     "@nestjs/platform-express": "^10.3.3",

src/api/pair-liquidity-info-history/pair-liquidity-info-history.controller.spec.ts

@@ -1,3 +1,4 @@
+import { CacheModule } from '@nestjs/cache-manager';
 import { INestApplication } from '@nestjs/common';
 import { Test, TestingModule } from '@nestjs/testing';
 import { Pair, PairLiquidityInfoHistory } from '@prisma/client';
@@ -29,6 +30,11 @@ describe('PairLiquidityInfoHistoryController', () => {
           useValue: mockPairLiquidityInfoHistoryService,
         },
       ],
+      imports: [
+        CacheModule.register({
+          isGlobal: true,
+        }),
+      ],
     }).compile();
 
     app = module.createNestApplication();

src/api/pair-liquidity-info-history/pair-liquidity-info-history.controller.ts

@@ -1,9 +1,11 @@
+import { CacheInterceptor, CacheTTL } from '@nestjs/cache-manager';
 import {
   Controller,
   Get,
   ParseEnumPipe,
   ParseIntPipe,
   Query,
+  UseInterceptors,
 } from '@nestjs/common';
 import { ApiOperation, ApiQuery, ApiResponse } from '@nestjs/swagger';
 import BigNumber from 'bignumber.js';
@@ -15,6 +17,7 @@ import { ContractAddress } from '@/clients/sdk-client.model';
 import { calculateUsdValue } from '@/lib/utils';
 
 @Controller('history')
+@UseInterceptors(CacheInterceptor)
 export class PairLiquidityInfoHistoryController {
   constructor(
     private readonly pairLiquidityInfoHistoryService: PairLiquidityInfoHistoryService,
@@ -76,6 +79,7 @@ export class PairLiquidityInfoHistoryController {
     required: false,
   })
   @ApiResponse({ status: 200, type: [PairLiquidityInfoHistoryEntry] })
+  @CacheTTL(24 * 60 * 60 * 1000)
   async findAll(
     @Query('limit', new ParseIntPipe({ optional: true })) limit: number = 100,
     @Query('offset', new ParseIntPipe({ optional: true })) offset: number = 0,

src/api/pairs/pairs.controller.ts

@@ -1,9 +1,11 @@
+import { CacheInterceptor, CacheTTL } from '@nestjs/cache-manager';
 import {
   Controller,
   Get,
   NotFoundException,
   Param,
   Query,
+  UseInterceptors,
 } from '@nestjs/common';
 import { ApiOperation, ApiParam, ApiQuery, ApiResponse } from '@nestjs/swagger';
 import * as prisma from '@prisma/client';
@@ -45,6 +47,7 @@ const toLiquidityInfoDto = (
 ): dto.LiquidityInfo | undefined =>
   liquidityInfo ? removeId(liquidityInfo) : undefined;
 
+@UseInterceptors(CacheInterceptor)
 @Controller('pairs')
 export class PairsController {
   constructor(private readonly pairsService: PairsService) {}
@@ -70,6 +73,7 @@ for this purpose use the individual \`pairs/:address\` route`,
     required: false,
   })
   @ApiResponse({ status: 200, type: [dto.PairWithUsd] })
+  @CacheTTL(24 * 60 * 60 * 1000)
   async getAllPairs(
     @Query('only-listed') onlyListedStr?: string, // false | true
     @Query('token') token?: ContractAddress,

src/api/tokens/tokens.controller.ts

@@ -1,3 +1,4 @@
+import { CacheInterceptor, CacheTTL } from '@nestjs/cache-manager';
 import {
   Controller,
   Delete,
@@ -7,6 +8,7 @@ import {
   Param,
   Post,
   UnauthorizedException,
+  UseInterceptors,
 } from '@nestjs/common';
 import {
   ApiHeaders,
@@ -43,6 +45,8 @@ const toDtoToken = ({
   id, // eslint-disable-line @typescript-eslint/no-unused-vars
   ...tail
 }: prisma.Token) => tail;
+
+@UseInterceptors(CacheInterceptor)
 @Controller('tokens')
 export class TokensController {
   constructor(private readonly tokensService: TokensService) {}
@@ -53,6 +57,7 @@ export class TokensController {
     description: `All the tokens no matter if are officially supported by the DEX (listed=true) or not will be retrieved`,
   })
   @ApiResponse({ status: 200, type: [dto.TokenWithUsd] })
+  @CacheTTL(24 * 60 * 60 * 1000)
   async getAllTokens(): Promise<dto.TokenWithUsd[]> {
     return this.tokensService.getAllTokensWithAggregation();
   }

src/app.module.ts

@@ -1,3 +1,4 @@
+import { CacheModule } from '@nestjs/cache-manager';
 import { Module } from '@nestjs/common';
 
 import { ApiModule } from '@/api/api.module';
@@ -13,7 +14,15 @@ import { PairSyncService } from '@/tasks/pair-sync/pair-sync.service';
 import { TasksModule } from '@/tasks/tasks.module';
 
 @Module({
-  imports: [ApiModule, ClientsModule, DatabaseModule, TasksModule],
+  imports: [
+    ApiModule,
+    ClientsModule,
+    DatabaseModule,
+    TasksModule,
+    CacheModule.register({
+      isGlobal: true,
+    }),
+  ],
   controllers: [AppController],
   providers: [
     MdwWsClientService,

src/tasks/pair-liquidity-info-history-importer/pair-liquidity-info-history-importer.service.spec.ts

@@ -7,6 +7,8 @@ import { PairLiquidityInfoHistoryDbService } from '@/database/pair-liquidity-inf
 import { bigIntToDecimal } from '@/lib/utils';
 import { PairLiquidityInfoHistoryImporterService } from '@/tasks/pair-liquidity-info-history-importer/pair-liquidity-info-history-importer.service';
 import resetAllMocks = jest.resetAllMocks;
+import { CacheModule } from '@nestjs/cache-manager';
+
 import { CoinmarketcapClientService } from '@/clients/coinmarketcap-client.service';
 import { PairLiquidityInfoHistoryErrorDbService } from '@/database/pair-liquidity-info-history-error/pair-liquidity-info-history-error-db.service';
 import {
@@ -73,6 +75,11 @@ describe('PairLiquidityInfoHistoryImporterService', () => {
           useValue: mockCoinmarketcapClient,
         },
       ],
+      imports: [
+        CacheModule.register({
+          isGlobal: true,
+        }),
+      ],
     }).compile();
     service = module.get<PairLiquidityInfoHistoryImporterService>(
       PairLiquidityInfoHistoryImporterService,

src/tasks/pair-liquidity-info-history-importer/pair-liquidity-info-history-importer.service.ts

@@ -1,3 +1,4 @@
+import { Cache } from '@nestjs/cache-manager';
 import { Injectable, Logger } from '@nestjs/common';
 import { orderBy } from 'lodash';
 
@@ -41,6 +42,7 @@ export class PairLiquidityInfoHistoryImporterService {
     private mdwClient: MdwHttpClientService,
     private sdkClient: SdkClientService,
     private coinmarketcapClient: CoinmarketcapClientService,
+    private cacheManager: Cache,
   ) {}
 
   readonly logger = new Logger(PairLiquidityInfoHistoryImporterService.name);
@@ -265,6 +267,7 @@ export class PairLiquidityInfoHistoryImporterService {
         }
 
         if (numUpserted > 0) {
+          await this.cacheManager.reset();
           this.logger.log(
             `Completed sync for pair ${pairWithTokens.id} ${pairWithTokens.address}. Synced ${numUpserted} log(s).`,
           );

src/tasks/pair-path-calculator/pair-path-calculator.service.ts

@@ -1,3 +1,4 @@
+import { Cache } from '@nestjs/cache-manager';
 import { Injectable, Logger } from '@nestjs/common';
 import { Decimal } from '@prisma/client/runtime/library';
 import BigNumber from 'bignumber.js';
@@ -11,6 +12,7 @@ export class PairPathCalculatorService {
   constructor(
     private pairLiquidityInfoHistoryDb: PairLiquidityInfoHistoryDbService,
     private tokenDb: TokenDbService,
+    private cacheManager: Cache,
   ) {}
 
   readonly logger = new Logger(PairPathCalculatorService.name);
@@ -27,6 +29,8 @@ export class PairPathCalculatorService {
       throw new Error('WAE token not found in db');
     }
 
+    let updates = 0;
+
     for (const entry of entries) {
       this.logger.debug(`Processing entry ${entry.id}`);
       // for each entry get the timestamp and use the info history db service to fetch the graph at the time
@@ -127,6 +131,11 @@ export class PairPathCalculatorService {
             ? new Decimal(aePrices[1].toString())
             : new Decimal(-1),
       });
+      updates += 1;
+    }
+    if (updates > 0) {
+      this.logger.debug(`Updated tokenAePrice in ${updates} entries`);
+      await this.cacheManager.reset();
     }
   }
 }

src/tasks/tasks.service.spec.ts

@@ -1,3 +1,4 @@
+import { CacheModule } from '@nestjs/cache-manager';
 import { Test, TestingModule } from '@nestjs/testing';
 
 import { CoinmarketcapClientService } from '@/clients/coinmarketcap-client.service';
@@ -36,6 +37,11 @@ describe('TasksService', () => {
         TokenDbService,
         PairPathCalculatorService,
       ],
+      imports: [
+        CacheModule.register({
+          isGlobal: true,
+        }),
+      ],
     }).compile();
 
     tasksService = module.get<TasksService>(TasksService);