Merge pull request #208 from utxostack/feat/cache-control

feat: cache control

backend/package.json

@@ -30,6 +30,7 @@
   },
   "dependencies": {
     "@apollo/server": "^4.11.0",
+    "@apollo/server-plugin-response-cache": "^4.1.3",
     "@as-integrations/fastify": "^2.1.1",
     "@cell-studio/mempool.js": "^2.5.3",
     "@ckb-lumos/bi": "^0.23.0",

backend/src/core/bitcoin-api/bitcoin-api.service.ts

@@ -10,7 +10,6 @@ import { ChainInfo, Transaction } from './bitcoin-api.schema';
 import { ONE_HOUR_MS, ONE_MONTH_MS, TEN_MINUTES_MS } from 'src/common/date';
 import { Cacheable } from 'src/decorators/cacheable.decorator';
 import * as Sentry from '@sentry/nestjs';
-import { PLimit } from 'src/decorators/plimit.decorator';
 
 type MethodParameters<T, K extends keyof T> = T[K] extends (...args: infer P) => any ? P : never;
 type MethodReturnType<T, K extends keyof T> = T[K] extends (...args: any[]) => infer R ? R : never;
@@ -180,7 +179,6 @@ export class BitcoinApiService {
     key: ({ address }) => `getAddress:${address}`,
     ttl: 10_000,
   })
-  @PLimit({ concurrency: 100 })
   public async getAddress({ address }: { address: string }) {
     return this.call('getAddress', { address });
   }
@@ -190,7 +188,6 @@ export class BitcoinApiService {
     key: ({ address }) => `getAddressTxsUtxo:${address}`,
     ttl: 10_000,
   })
-  @PLimit({ concurrency: 100 })
   public async getAddressTxsUtxo({ address }: { address: string }) {
     return this.call('getAddressTxsUtxo', { address });
   }
@@ -200,7 +197,6 @@ export class BitcoinApiService {
     key: ({ address, afterTxid }) => `getAddressTxs:${address}:${afterTxid}`,
     ttl: 10_000,
   })
-  @PLimit({ concurrency: 100 })
   public async getAddressTxs({ address, afterTxid }: { address: string; afterTxid?: string }) {
     return this.call('getAddressTxs', { address, afterTxid });
   }
@@ -236,7 +232,6 @@ export class BitcoinApiService {
     key: ({ txids }) => `getTransactionTimes:${txids.join(',')}`,
     ttl: 10_000,
   })
-  @PLimit({ concurrency: 100 })
   public async getTransactionTimes({ txids }: { txids: string[] }) {
     return this.call('getTransactionTimes', { txids });
   }

backend/src/core/blockchain/blockchain.service.ts

@@ -14,7 +14,6 @@ import { ONE_MONTH_MS } from 'src/common/date';
 import { CKB_MIN_SAFE_CONFIRMATIONS } from 'src/constants';
 import * as Sentry from '@sentry/nestjs';
 import { Chain } from '@prisma/client';
-import { PLimit } from 'src/decorators/plimit.decorator';
 
 class WebsocketError extends Error {
   constructor(message: string) {
@@ -249,7 +248,6 @@ export class BlockchainService {
     return BI.from(tipBlockNumber).toNumber();
   }
 
-  @PLimit({ concurrency: 100 })
   public async getTransactions(
     searchKey: SearchKey,
     order: 'asc' | 'desc',

backend/src/decorators/cache-control.decorator.ts

@@ -0,0 +1,19 @@
+import { Directive } from '@nestjs/graphql';
+
+interface CacheControlOptions {
+  maxAge?: number;
+  scope?: 'PRIVATE' | 'PUBLIC';
+  inheritMaxAge?: boolean;
+}
+
+export const CacheControl = ({ maxAge, scope = 'PUBLIC', inheritMaxAge }: CacheControlOptions) => {
+  const args = [
+    `scope: ${scope}`,
+    maxAge !== undefined ? `maxAge: ${maxAge}` : null,
+    inheritMaxAge ? `inheritMaxAge: ${inheritMaxAge}` : null,
+  ]
+    .filter(Boolean)
+    .join(', ');
+
+  return Directive(`@cacheControl(${args})`);
+};

backend/src/modules/api.module.ts

@@ -2,7 +2,7 @@ import { join } from 'node:path';
 import { ExecutionContext, Injectable, Module } from '@nestjs/common';
 import { APP_FILTER, APP_GUARD, APP_INTERCEPTOR } from '@nestjs/core';
 import { ConfigService } from '@nestjs/config';
-import { GqlExecutionContext, GraphQLModule } from '@nestjs/graphql';
+import { GqlExecutionContext, GraphQLModule, Int } from '@nestjs/graphql';
 import { DataLoaderInterceptor } from 'src/common/dataloader';
 import { Env } from 'src/env';
 import { CkbModule } from './ckb/ckb.module';
@@ -15,8 +15,12 @@ import { ComplexityPlugin } from './complexity.plugin';
 import * as Sentry from '@sentry/nestjs';
 import { ThrottlerGuard, ThrottlerModule } from '@nestjs/throttler';
 import { FastifyReply, FastifyRequest } from 'fastify';
-import { SentryGlobalGraphQLFilter } from '@sentry/nestjs/setup';
+import { ApolloServerPluginCacheControl } from '@apollo/server/plugin/cacheControl';
+import responseCachePlugin from '@apollo/server-plugin-response-cache';
 import { AllExceptionsFilter } from 'src/filters/all-exceptions.filter';
+import { DirectiveLocation, GraphQLBoolean, GraphQLDirective, GraphQLEnumType } from 'graphql';
+import { LoggingPlugin } from './logging.plugin';
+import { CACHE_MANAGER, Cache } from '@nestjs/cache-manager';
 
 @Injectable()
 export class GqlThrottlerGuard extends ThrottlerGuard {
@@ -42,16 +46,61 @@ export class GqlThrottlerGuard extends ThrottlerGuard {
     }),
     GraphQLModule.forRootAsync<ApolloDriverConfig>({
       driver: ApolloDriver,
-      inject: [ConfigService],
-      useFactory: async (configService: ConfigService<Env>) => ({
+      inject: [ConfigService, CACHE_MANAGER],
+      useFactory: async (configService: ConfigService<Env>, cacheManager: Cache) => ({
         playground: configService.get('ENABLED_GRAPHQL_PLAYGROUND'),
         installSubscriptionHandlers: true,
         introspection: true,
         graphiql: true,
         autoSchemaFile: join(process.cwd(), 'src/schema.gql'),
+        plugins: [
+          ApolloServerPluginCacheControl({
+            defaultMaxAge: 10,
+            calculateHttpHeaders: true,
+          }),
+          responseCachePlugin(),
+        ],
+        cache: {
+          async get(key: string) {
+            const val = await cacheManager.get(key);
+            return val as string | undefined;
+          },
+          async set(key: string, value: string, options?: { ttl: number | null }) {
+            const { ttl } = options || { ttl: null };
+            await cacheManager.set(key, value, ttl ? ttl * 1000 : undefined);
+          },
+          async delete(key: string) {
+            await cacheManager.del(key);
+          },
+        },
         buildSchemaOptions: {
           dateScalarMode: 'timestamp',
           fieldMiddleware: [fieldPerformanceMiddleware],
+          directives: [
+            new GraphQLDirective({
+              name: 'cacheControl',
+              args: {
+                maxAge: { type: Int },
+                scope: {
+                  type: new GraphQLEnumType({
+                    name: 'CacheControlScope',
+                    values: {
+                      PUBLIC: {},
+                      PRIVATE: {},
+                    },
+                  }),
+                },
+                inheritMaxAge: { type: GraphQLBoolean },
+              },
+              locations: [
+                DirectiveLocation.FIELD_DEFINITION,
+                DirectiveLocation.OBJECT,
+                DirectiveLocation.INTERFACE,
+                DirectiveLocation.UNION,
+                DirectiveLocation.QUERY,
+              ],
+            }),
+          ],
         },
         context: (request: FastifyRequest, reply: FastifyReply) => {
           return {
@@ -84,6 +133,7 @@ export class GqlThrottlerGuard extends ThrottlerGuard {
       useClass: AllExceptionsFilter,
     },
     ComplexityPlugin,
+    LoggingPlugin,
   ],
 })
 export class ApiModule { }

backend/src/modules/logging.plugin.ts

@@ -0,0 +1,27 @@
+import { ApolloServerPlugin, GraphQLRequestContext, GraphQLRequestListener } from '@apollo/server';
+import { Plugin } from '@nestjs/apollo';
+import { Logger } from '@nestjs/common';
+import { FastifyRequest } from 'fastify';
+
+interface Context {
+  request: FastifyRequest;
+}
+
+@Plugin()
+export class LoggingPlugin implements ApolloServerPlugin {
+  private readonly logger = new Logger(LoggingPlugin.name);
+
+  async requestDidStart(requestContext: GraphQLRequestContext<Context>): Promise<GraphQLRequestListener<any>> {
+    const { request } = requestContext.contextValue;
+    const body = request.body as { operationName: string; variables: Record<string, any>, query: string };
+    this.logger.log(`Request [${request.ip}] ${body.operationName} ${JSON.stringify(body.variables)}`);
+
+    const start = performance.now();
+    return {
+      willSendResponse: async () => {
+        const end = performance.now();
+        this.logger.log(`Response [${request.ip}] ${body.operationName} ${end - start}ms`);
+      },
+    };
+  }
+}

backend/src/schema.gql

@@ -2,6 +2,8 @@
 # THIS FILE WAS AUTOMATICALLY GENERATED (DO NOT MODIFY)
 # ------------------------------------------------------
 
+directive @cacheControl(maxAge: Int, scope: CacheControlScope, inheritMaxAge: Boolean) on FIELD_DEFINITION | OBJECT | INTERFACE | UNION | QUERY
+
 """CKB Script"""
 type CkbScript {
   codeHash: String!
@@ -362,4 +364,9 @@ enum TransactionListSortType {
   AddressCountDesc
   CreatedTimeAsc
   CreatedTimeDesc
+}
+
+enum CacheControlScope {
+  PUBLIC
+  PRIVATE
 }

frontend/src/gql/graphql.ts

@@ -137,6 +137,11 @@ export type BitcoinTransaction = {
   weight: Scalars['Float']['output'];
 };
 
+export enum CacheControlScope {
+  Private = 'PRIVATE',
+  Public = 'PUBLIC'
+}
+
 /** Cell type (XUDT, SUDT, Dobs, mNFT) */
 export enum CellType {
   Dob = 'DOB',