feat(be): redis caching

Author: krystxf

.env.docker.example

@@ -1,7 +1,7 @@
 # get yours @ https://api.golemio.cz/api-keys/auth/sign-up
 GOLEMIO_API_KEY=
 
-
+# postgres
 POSTGRES_USER=pg_user
 POSTGRES_PASSWORD=pg_password
 POSTGRES_DB=metro-now
@@ -11,6 +11,11 @@ DB_HOST=host.docker.internal
 DB_PORT=5432
 DB_SCHEMA=public
 
+
+# redis
+REDIS_HOST=host.docker.internal
+REDIS_PORT=6379
+
 # This was inserted by `prisma init`:
 # Environment variables declared in this file are automatically made available to Prisma.
 # See the documentation for more detail: https://pris.ly/d/prisma-schema#accessing-environment-variables-from-the-schema

apps/backend/.env.local.example

@@ -1,7 +1,7 @@
 # get yours @ https://api.golemio.cz/api-keys/auth/sign-up
 GOLEMIO_API_KEY=
 
-
+# postgres
 POSTGRES_USER=pg_user
 POSTGRES_PASSWORD=pg_password
 POSTGRES_DB=metro-now
@@ -21,3 +21,6 @@ DB_SCHEMA=public
 
 DATABASE_URL="postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${DB_HOST}:${DB_PORT}/${POSTGRES_DB}?schema=${DB_SCHEMA}"
 
+# redis
+REDIS_HOST=localhost
+REDIS_PORT=6379

apps/backend/package.json

@@ -35,6 +35,7 @@
         "@nestjs/swagger": "^7.4.2",
         "@prisma/client": "5.20.0",
         "cache-manager": "^5.7.6",
+        "cache-manager-redis-yet": "^5.1.5",
         "graphql": "^16.9.0",
         "radash": "^12.1.0",
         "reflect-metadata": "^0.2.2",

apps/backend/src/app.module.ts

@@ -25,7 +25,7 @@ import { StopModule } from "src/modules/stop/stop.module";
         LoggerModule,
         ConfigModule.forRoot(configModuleConfig),
         ScheduleModule.forRoot(),
-        CacheModule.register(cacheModuleConfig),
+        CacheModule.registerAsync(cacheModuleConfig),
         GraphQLModule.forRoot<ApolloDriverConfig>({
             driver: ApolloDriver,
             playground: true,

apps/backend/src/config/cache-module.config.ts

@@ -1,5 +1,15 @@
-import type { CacheModuleOptions } from "@nestjs/cache-manager";
+import type { CacheModuleAsyncOptions } from "@nestjs/cache-manager";
+import { redisStore } from "cache-manager-redis-yet";
 
-export const cacheModuleConfig: CacheModuleOptions = {
+export const cacheModuleConfig: CacheModuleAsyncOptions = {
     isGlobal: true,
+    useFactory: async () => ({
+        store: await redisStore({
+            socket: {
+                host: process.env.REDIS_HOST || "localhost",
+                port: parseInt(process.env.REDIS_PORT || "6379"),
+            },
+        }),
+        max: 1_000,
+    }),
 };

apps/backend/src/schema/env.schema.ts

@@ -8,5 +8,9 @@ export const envSchema = z.object({
     DB_HOST: z.string(),
     DB_PORT: z.coerce.number().int().positive(),
     DB_SCHEMA: z.string(),
+    REDIS_PORT: z.coerce.number().int().positive().optional(),
+    REDIS_HOST: z.string().optional(),
     PORT: z.coerce.number().int().positive().optional(),
 });
+
+export type EnvSchema = z.infer<typeof envSchema>;

compose.yaml

@@ -19,12 +19,22 @@ services:
             timeout: 5s
             retries: 5
 
+    redis-stack:
+        image: redis/redis-stack:latest
+        container_name: redis-stack
+        restart: always
+        ports:
+            - 6379:6379
+            - 8001:8001
+        extra_hosts:
+            - "host.docker.internal:host-gateway"
+
     postgres:
         container_name: postgres
         image: postgres:16-alpine
         restart: always
         ports:
-            - 5432:${POSTGRES_PORT:-5432}
+            - 5432:5432
         volumes:
             - postgres-data:/var/lib/postgresql/data/
         env_file:
@@ -44,6 +54,7 @@ services:
                 pnpm start:prod
         depends_on:
             - postgres
+            - redis-stack
         build:
             context: .
             dockerfile: ./Dockerfile

package.json

@@ -11,7 +11,7 @@
         "precommit": "pnpm format",
         "format": "pnpm -r format && pnpm exec prettier . --write",
         "format:check": "pnpm -r format:check && pnpm exec prettier . --check",
-        "docker:db:up": "docker compose up postgres",
+        "docker:up:dev": "docker compose up postgres redis-stack",
         "docker:up": "docker compose up -d --build",
         "docker:down": "docker compose down --remove-orphans --volumes"
     },