어드민 기능 강화 스프린트 배포

.github/workflows/prod2025.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - prod-2025
+  workflow_dispatch:
 
 permissions:
   contents: read

package.json

@@ -20,10 +20,10 @@
     "db:init:local": "docker-compose --env-file .local.env -f docker-compose.db.yml up -d",
     "db:save:local": "dotenv -e .local.env -- yarn prisma migrate dev",
     "db:save:dev": "dotenv -e .dev.env -- yarn prisma migrate dev",
-    "deploy:local": "dotenv -e .local.env -- node dist/main.js",
-    "deploy:dev": "dotenv -e .dev.env -- node dist/main.js",
-    "deploy:prod": "dotenv -e .prod.env -- node dist/main.js",
-    "deploy:prod2025": "dotenv -e .prod2025.env -- node dist/main.js",
+    "deploy:local": "dotenv -e .local.env -- node dist/src/main.js",
+    "deploy:dev": "dotenv -e .dev.env -- node dist/src/main.js",
+    "deploy:prod": "dotenv -e .prod.env -- node dist/src/main.js",
+    "deploy:prod2025": "dotenv -e .prod2025.env -- node dist/src/main.js",
     "seed:studyroom:local": "dotenv -e .local.env -- npx ts-node ./prisma/seeds/insert-studyrooms.ts",
     "seed:studyroom:dev": "dotenv -e .dev.env -- npx ts-node ./prisma/seeds/insert-studyrooms.ts",
     "seed:course:local": "dotenv -e .local.env -- npx ts-node ./prisma/seeds/insert-courses.ts",

parser/parse.py

@@ -0,0 +1,39 @@
+import pandas as pd
+import json
+
+FILE_NAME = 'lectures_2025-1'
+INVALID_SCHOOLS = ['유형2', '-', '대학', '연계전공']
+
+
+raw_lectures = pd.read_excel(f'{FILE_NAME}.xlsx')
+schools = [school for school in raw_lectures['개설대학'].unique() if school not in INVALID_SCHOOLS]
+
+lectures = dict()
+
+for _, row in raw_lectures.iterrows():
+    if row['학수번호'] not in lectures:
+        if row['개설대학'] in INVALID_SCHOOLS:
+            school = '기타'
+        else:
+            school = row['개설대학']
+
+        lectures[row['학수번호']] = {
+            'id': row['학수번호'],
+            'school': school,
+            'name': row['교과목명'],
+        }
+    else:
+        if lectures[row['학수번호']]['school'] == '기타':
+            if row['개설대학'] not in INVALID_SCHOOLS:
+                lectures[row['학수번호']]['school'] = row['개설대학']
+
+
+result = [x for x in lectures.values()]
+
+
+with open(f'{FILE_NAME}.json', 'w', encoding='utf-8') as f:
+    json.dump(result, f, ensure_ascii=False)
+
+
+
+

prisma/migrations/20250122110201_add_is_active_to_studyroom/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "studyroom" ADD COLUMN     "is_active" BOOLEAN NOT NULL DEFAULT true;

prisma/schema/studyroom/studyroom.prisma

@@ -6,6 +6,7 @@ model Studyroom {
     minUsers       Int                    @map("min_users")
     maxUsers       Int                    @map("max_users")
     isCinema       Boolean                @map("is_cinema")
+    isActive       Boolean                @default(true) @map("is_active")
     createdAt      DateTime               @default(now()) @map("created_at")
     updatedAt      DateTime               @updatedAt @map("updated_at")
     deletedAt      DateTime?              @map("deleted_at")

src/app/app.module.ts

@@ -11,6 +11,7 @@ import { UserModule } from 'src/user/user.module';
 import { AppController } from './app.controller';
 import { AppService } from './app.service';
 import { configModule } from './modules/config.module';
+import { BatchModule } from 'src/batch/batch.module';
 
 @Module({
   imports: [
@@ -23,6 +24,7 @@ import { configModule } from './modules/config.module';
     RestaurantModule,
     GodokModule,
     NoticeModule,
+    BatchModule,
   ],
   controllers: [AppController],
   providers: [AppService],

src/attendance/attendance.controller.ts

@@ -24,6 +24,9 @@ import { AssignmentAttendanceListDto } from './dto/assignment-attendance.dto';
 import { CourseAttendanceListDto } from './dto/course-attendace-list.dto';
 import { CourseAttendanceDto } from './dto/course-attendance.dto';
 import { LectureAttendanceListDto } from './dto/lecture-attendance.dto';
+import { LectureListDto } from './dto/lecture-list.dto';
+
+import * as LECTURES from '../../parser/lectures_2025-1.json';
 
 @ApiTags('출석 API')
 @Controller('attendance')
@@ -93,4 +96,12 @@ export class AttendanceController {
   ): Promise<AssignmentAttendanceListDto> {
     return this.attendanceService.getAssignmentAttendance(user);
   }
+
+  @Version('1')
+  @Get('lecture/list')
+  @ApiOperation({ summary: '강의 목록' })
+  @ApiCreatedResponse({ type: LectureListDto })
+  async getLectureList(): Promise<LectureListDto> {
+    return LectureListDto.from(LECTURES);
+  }
 }

src/attendance/dto/lecture-list.dto.ts

@@ -0,0 +1,44 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { LectureInfo } from '../types/lecture-info';
+
+export class LectureDto {
+  @ApiProperty({
+    description: '학수번호',
+    type: String,
+  })
+  id!: string;
+
+  @ApiProperty({
+    description: '강의명',
+    type: String,
+  })
+  name!: string;
+
+  @ApiProperty({
+    description: '주관 학과',
+    type: String,
+  })
+  school!: string;
+
+  static from(lecture: LectureInfo) {
+    return {
+      id: lecture.id,
+      name: lecture.name,
+      school: lecture.school,
+    };
+  }
+}
+
+export class LectureListDto {
+  @ApiProperty({
+    description: '강의 목록',
+    type: [LectureDto],
+  })
+  lectures!: LectureDto[];
+
+  static from(lectures: LectureInfo[]) {
+    return {
+      lectures: lectures.map((lecture) => LectureDto.from(lecture)),
+    };
+  }
+}

src/attendance/types/lecture-info.d.ts

@@ -0,0 +1,5 @@
+export type LectureInfo = {
+  id: string;
+  name: string;
+  school: string;
+};

src/batch/batch.controller.ts

@@ -0,0 +1,103 @@
+import { Body, Controller, Get, Post, UseGuards, Version } from '@nestjs/common';
+import { ApiHeader, ApiOkResponse, ApiOperation, ApiTags } from '@nestjs/swagger';
+import { BatchService } from './batch.service';
+import { StudyroomBatchInfoDto } from './dto/studyroomBatchInfo.dto';
+import { CronTimePayload } from './payload/cron-time.payload';
+import { AdminApiGuard } from 'src/auth/guard/admin.guard';
+
+@ApiTags('배치 API')
+@Controller('batch')
+export class BatchController {
+  constructor(private readonly batchService: BatchService) {}
+
+  @Version('1')
+  @ApiOperation({
+    summary: '[어드민] 스터디룸 슬롯 크롤러 배치 정보 조회 API',
+  })
+  @ApiOkResponse({ type: StudyroomBatchInfoDto })
+  @UseGuards(AdminApiGuard)
+  @ApiHeader({
+    name: 'admin-api-key',
+    description: 'API key for admin access',
+    required: true,
+  })
+  @Get('studyroom')
+  async getStudyroom() {
+    return this.batchService.getStudyroomBatchInfo();
+  }
+
+  @Version('1')
+  @ApiOperation({
+    summary: '[어드민] 스터디룸 슬롯 크롤러 배치 활성화 API',
+  })
+  @UseGuards(AdminApiGuard)
+  @ApiHeader({
+    name: 'admin-api-key',
+    description: 'API key for admin access',
+    required: true,
+  })
+  @Post('studyroom/activate')
+  async activateStudyroomSlotCrawler() {
+    return this.batchService.activateStudyroomSlotCrawler();
+  }
+
+  @Version('1')
+  @ApiOperation({
+    summary: '[어드민] 스터디룸 슬롯 크롤러 배치 비활성화 API',
+  })
+  @UseGuards(AdminApiGuard)
+  @ApiHeader({
+    name: 'admin-api-key',
+    description: 'API key for admin access',
+    required: true,
+  })
+  @Post('studyroom/deactivate')
+  async deactivateStudyroomSlotCrawler() {
+    return this.batchService.deactivateStudyroomSlotCrawler();
+  }
+
+  @Version('1')
+  @ApiOperation({
+    summary: '[어드민] 스터디룸 슬롯 크롤러 배치 헬스 체크 활성화 API',
+  })
+  @UseGuards(AdminApiGuard)
+  @ApiHeader({
+    name: 'admin-api-key',
+    description: 'API key for admin access',
+    required: true,
+  })
+  @Post('studyroom/health-check/activate')
+  async activateStudyroomSlotCrawlerHealthCheck() {
+    return this.batchService.activateStudyroomSlotCrawlerHealthCheck();
+  }
+
+  @Version('1')
+  @ApiOperation({
+    summary: '[어드민] 스터디룸 슬롯 크롤러 배치 헬스 체크 비활성화 API',
+  })
+  @UseGuards(AdminApiGuard)
+  @ApiHeader({
+    name: 'admin-api-key',
+    description: 'API key for admin access',
+    required: true,
+  })
+  @Post('studyroom/health-check/deactivate')
+  async deactivateStudyroomSlotCrawlerHealthCheck() {
+    return this.batchService.deactivateStudyroomSlotCrawlerHealthCheck();
+  }
+
+  @Version('1')
+  @ApiOperation({
+    summary: '[어드민] 스터디룸 슬롯 크롤러 배치 크론 시간 변경 API',
+  })
+  @UseGuards(AdminApiGuard)
+  @ApiHeader({
+    name: 'admin-api-key',
+    description: 'API key for admin access',
+    required: true,
+  })
+  @Post('studyroom/cron-time')
+  async changeStudyroomSlotCrawlerCronTime(@Body() body: CronTimePayload) {
+    return this.batchService.changeStudyroomSlotCrawlerCronTime(body.cronTime);
+  }
+}

src/batch/batch.module.ts

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+import { BatchController } from './batch.controller';
+import { BatchService } from './batch.service';
+import { AuthModule } from 'src/auth/auth.module';
+
+@Module({
+  imports: [AuthModule],
+  controllers: [BatchController],
+  providers: [BatchService]
+})
+export class BatchModule {}

src/batch/batch.service.ts

@@ -0,0 +1,71 @@
+import { Injectable } from '@nestjs/common';
+import { SchedulerRegistry } from '@nestjs/schedule';
+import { StudyroomBatchInfoDto } from './dto/studyroomBatchInfo.dto';
+import { CronTime } from 'cron';
+
+@Injectable()
+export class BatchService {
+    constructor(private schedulerRegistry: SchedulerRegistry) {}
+
+    async getStudyroomBatchInfo(): Promise<StudyroomBatchInfoDto> {
+        const cronJob = this.schedulerRegistry.getCronJob(
+            'studyroomSlotCrawler'
+        );
+
+        return {
+            isRunning: cronJob.running,
+            cronTime: cronJob.cronTime.source.toString(),
+            lastFiredAt: cronJob.lastDate(),
+        };
+    }
+
+    async activateStudyroomSlotCrawler() {
+        const cronJob = this.schedulerRegistry.getCronJob(
+            'studyroomSlotCrawler'
+        );
+        const healthCheckJob = this.schedulerRegistry.getCronJob(
+            'studyroomSlotCrawlerHealthCheck'
+        );
+
+        cronJob.start();
+        healthCheckJob.start();
+    }
+
+    async deactivateStudyroomSlotCrawler() {
+        const cronJob = this.schedulerRegistry.getCronJob(
+            'studyroomSlotCrawler'
+        );
+        const healthCheckJob = this.schedulerRegistry.getCronJob(
+            'studyroomSlotCrawlerHealthCheck'
+        );
+
+        cronJob.stop();
+        healthCheckJob.stop();
+    }
+
+    async activateStudyroomSlotCrawlerHealthCheck() {
+        const healthCheckJob = this.schedulerRegistry.getCronJob(
+            'studyroomSlotCrawlerHealthCheck'
+        );
+
+        healthCheckJob.start();
+    }
+
+    async deactivateStudyroomSlotCrawlerHealthCheck() {
+        const healthCheckJob = this.schedulerRegistry.getCronJob(
+            'studyroomSlotCrawlerHealthCheck'
+        );
+
+        healthCheckJob.stop();
+    }
+
+    async changeStudyroomSlotCrawlerCronTime(rawCronTime: string) {
+        const cronJob = this.schedulerRegistry.getCronJob(
+            'studyroomSlotCrawler'
+        );
+
+        const cronTime = new CronTime(rawCronTime);
+
+        cronJob.setTime(cronTime);
+    }
+}

src/batch/dto/studyroomBatchInfo.dto.ts

@@ -0,0 +1,22 @@
+import { ApiProperty } from "@nestjs/swagger";
+import { StudyroomInfoListDto } from "src/studyroom/dto/studyroom-infp.dto";
+
+export class StudyroomBatchInfoDto {
+  @ApiProperty({
+    description: '배치 실행 여부',
+    type: Boolean,
+  })
+  isRunning: boolean;
+
+  @ApiProperty({
+    description: '배치 Cron 표현식',
+    type: String,
+  })
+  cronTime: string;
+
+  @ApiProperty({
+    description: '배치 실행 시간',
+    type: Date,
+  })
+  lastFiredAt: Date;
+}

src/batch/payload/cron-time.payload.ts

@@ -0,0 +1,12 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsNotEmpty, IsString } from 'class-validator';
+
+export class CronTimePayload {
+  @IsString()
+  @IsNotEmpty()
+  @ApiProperty({
+    description: 'Cron 표현식',
+    example: '*/2 * * * * *',
+  })
+  cronTime: string;
+}