feat(be): caching REST endpoints

Author: krystxf

backend-nest/src/app.module.ts

@@ -1,4 +1,5 @@
 import { ApolloDriver, type ApolloDriverConfig } from "@nestjs/apollo";
+import { CacheModule } from "@nestjs/cache-manager";
 import { Module } from "@nestjs/common";
 import { ConfigModule } from "@nestjs/config";
 import { GraphQLModule } from "@nestjs/graphql";
@@ -13,13 +14,17 @@ import { StopModule } from "src/modules/stop/stop.module";
 
 @Module({
     imports: [
-        PrismaModule,
         PlatformModule,
         DepartureModule,
         ImportModule,
         StopModule,
+
+        PrismaModule,
         ConfigModule.forRoot(),
         ScheduleModule.forRoot(),
+        CacheModule.register({
+            isGlobal: true,
+        }),
         GraphQLModule.forRoot<ApolloDriverConfig>({
             driver: ApolloDriver,
             playground: true,

backend-nest/src/constants/swagger.const.ts

@@ -1,7 +1,7 @@
 import { GRAPHQL_API_ROOT } from "src/constants/graphql.const";
 
 export const SWAGGER_API_ROOT = "/";
-export const SWAGGER_JSON_URL = "swagger-json";
+export const SWAGGER_JSON_URL = "/swagger-json";
 
 export const SWAGGER_TITLE = "Metro Now API";
 export const SWAGGER_VERSION = "1.0";

backend-nest/src/interceptors/http-cache.interceptor.ts

@@ -0,0 +1,32 @@
+import { CacheInterceptor } from "@nestjs/cache-manager";
+import { ExecutionContext, Injectable } from "@nestjs/common";
+
+import { GRAPHQL_API_ROOT } from "src/constants/graphql.const";
+import {
+    SWAGGER_API_ROOT,
+    SWAGGER_JSON_URL,
+} from "src/constants/swagger.const";
+
+@Injectable()
+export class HttpCacheInterceptor extends CacheInterceptor {
+    trackBy(context: ExecutionContext): string | undefined {
+        const request = context.switchToHttp().getRequest();
+        const { httpAdapter } = this.httpAdapterHost;
+
+        const isGetRequest = httpAdapter.getRequestMethod(request) === "GET";
+        const excludePaths: string[] = [
+            GRAPHQL_API_ROOT,
+            SWAGGER_JSON_URL,
+            SWAGGER_API_ROOT,
+        ];
+
+        if (!isGetRequest) {
+            return undefined;
+        }
+        if (excludePaths.includes(httpAdapter.getRequestUrl(request))) {
+            return undefined;
+        }
+
+        return httpAdapter.getRequestUrl(request);
+    }
+}

backend-nest/src/modules/platform/platform.controller.ts

@@ -1,9 +1,11 @@
+import { CacheInterceptor } from "@nestjs/cache-manager";
 import {
     Controller,
     Get,
     HttpException,
     HttpStatus,
     Query,
+    UseInterceptors,
 } from "@nestjs/common";
 import { ApiQuery, ApiTags } from "@nestjs/swagger";
 import { z } from "zod";
@@ -29,6 +31,7 @@ import {
 
 @ApiTags("platform")
 @Controller("platform")
+@UseInterceptors(CacheInterceptor)
 export class PlatformController {
     constructor(private readonly platformService: PlatformService) {}
 

backend-nest/src/modules/stop/stop.controller.ts

@@ -1,11 +1,13 @@
-import { Controller, Get, Query } from "@nestjs/common";
+import { CacheInterceptor } from "@nestjs/cache-manager";
+import { Controller, Get, Query, UseInterceptors } from "@nestjs/common";
 import { ApiQuery, ApiTags } from "@nestjs/swagger";
 
 import { StopService } from "src/modules/stop/stop.service";
 import { metroOnlyQuery } from "src/swagger/query.swagger";
 
 @ApiTags("stop")
 @Controller("stop")
+@UseInterceptors(CacheInterceptor)
 export class StopController {
     constructor(private readonly stopService: StopService) {}
 
@@ -15,6 +17,7 @@ export class StopController {
         @Query("metroOnly")
         metroOnlyQuery: unknown,
     ) {
+        console.log("Fetching all stops");
         const metroOnly: boolean = metroOnlyQuery === "true";
         const stops = await this.stopService.getAll({ metroOnly });