Merge pull request #72 from boostcampwm-2024/chore/redis-env-be

📦 chore: redis 환경 구축

Author: Jo-Minseok

.github/workflows/deploy.yml

@@ -36,6 +36,10 @@ jobs:
             echo "DB_PORT=${{ secrets.PRODUCT_DB_PORT }}" >> configs/.env.db.production
             echo "DB_USERNAME=${{ secrets.PRODUCT_DB_USERNAME }}" >> configs/.env.db.production
             echo "DB_PASSWORD=${{ secrets.PRODUCT_DB_PASSWORD }}" >> configs/.env.db.production
+            echo "REDIS_HOST=${{secrets.REDIS_HOST }}" >> configs/.env.db.production
+            echo "REDIS_PORT=${{secrets.REDIS_PORT}}" >> configs/.env.db.production
+            echo "REDIS_USERNAME=${{secrets.REDIS_USERNAME}}" >> configs/.env.db.production
+            echo "REDIS_PASSWORD=${{secrets.REDIS_PASSWORD}}" >> configs/.env.db.production
 
             npm ci
             npm run build

server/package-lock.json

@@ -28,6 +28,7 @@
     "@nestjs/swagger": "^8.0.1",
     "@nestjs/typeorm": "^10.0.2",
     "cross-env": "^7.0.3",
+    "ioredis": "^5.4.1",
     "mysql2": "^3.11.3",
     "nest-winston": "^1.9.7",
     "pm2": "^5.4.2",
@@ -50,6 +51,7 @@
     "eslint": "^9.0.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-prettier": "^5.0.0",
+    "ioredis-mock": "^8.9.0",
     "jest": "^29.5.0",
     "prettier": "^3.0.0",
     "source-map-support": "^0.5.21",

server/package.json

@@ -3,6 +3,7 @@ import { winstonModule } from './common/logger/logger.module';
 import { TypeOrmModule } from '@nestjs/typeorm';
 import { ConfigModule, ConfigService } from '@nestjs/config';
 import { loadDBSetting } from './common/database/load.config';
+import { RedisModule } from './redis/redis.module';
 
 @Module({
   imports: [
@@ -19,6 +20,7 @@ import { loadDBSetting } from './common/database/load.config';
       useFactory: (configService: ConfigService) =>
         loadDBSetting(configService),
     }),
+    RedisModule,
   ],
   controllers: [],
   providers: [],

server/src/app.module.ts

@@ -3,7 +3,7 @@ import { ConfigService } from '@nestjs/config';
 export function loadDBSetting(configService: ConfigService) {
   const type = configService.get<'mysql' | 'sqlite'>('DB_TYPE');
   const database = configService.get<string>('DB_DATABASE');
-  const host = configService.get<string | null>('DB_HOST');
+  const host = configService.get<string>('DB_HOST');
   const port = configService.get<number>('DB_PORT');
   const username = configService.get<string>('DB_USERNAME');
   const password = configService.get<string>('DB_PASSWORD');

server/src/common/database/load.config.ts

@@ -0,0 +1,34 @@
+import { Global, Module } from '@nestjs/common';
+import { ConfigModule, ConfigService } from '@nestjs/config';
+import { RedisService } from './redis.service';
+import Redis from 'ioredis';
+import Redis_Mock from 'ioredis-mock';
+
+@Global()
+@Module({
+  imports: [ConfigModule],
+  providers: [
+    {
+      provide: 'REDIS_CLIENT',
+      inject: [ConfigService],
+      useFactory: async (configService: ConfigService) => {
+        const envType = process.env.NODE_ENV;
+        let redis: Redis;
+        if (envType === 'test') {
+          redis = new Redis_Mock();
+        } else {
+          redis = new Redis({
+            host: configService.get<string>('REDIS_HOST'),
+            port: configService.get<number>('REDIS_PORT'),
+            username: configService.get<string>('REDIS_USERNAME'),
+            password: configService.get<string>('REDIS_PASSWORD'),
+          });
+        }
+        return redis;
+      },
+    },
+    RedisService,
+  ],
+  exports: ['REDIS_CLIENT'],
+})
+export class RedisModule {}

server/src/redis/redis.module.ts

@@ -0,0 +1,9 @@
+import { Inject, Injectable } from '@nestjs/common';
+import Redis from 'ioredis';
+
+@Injectable()
+export class RedisService extends Redis {
+  constructor(@Inject('REDIS_CLIENT') private readonly redisClient: Redis) {
+    super(redisClient.options);
+  }
+}