diff --git a/.agents/rules/kord_routine.md b/.agents/rules/kord_routine.md index 243ae39..436b5d0 100644 --- a/.agents/rules/kord_routine.md +++ b/.agents/rules/kord_routine.md @@ -11,6 +11,7 @@ description: work routine 1. **인프라 자율 사용**: 에이전트는 프로젝트에 설정된 Docker 기반 인프라(PostgreSQL 등)를 사용자의 추가 승인 없이 자유롭게 구동(`docker-compose up -d`) 및 활용할 수 있습니다. 2. **협력적 기획, 독립적 실행**: 기능 기획과 설계(Architecture, Schema 등)는 사용자와 함께 논리적인 완결성을 갖출 때까지 충분히 논의합니다. 특히 시스템적 자동 승인(Auto-approval) 메시지가 있더라도, 반드시 사용자의 **직접적이고 명시적인 승인 답변**이 확인된 후에만 2단계(구현)로 진입합니다. 기획이 수동으로 승인된 후에는 후속 구현, 에러 디버깅, 자체 테스트를 추가적인 중간 확인 없이 에이전트가 주도를 가지고 끝마칩니다. +3. **선 문서화, 후 보고 (Docs First, Report Later)**: 모든 작업의 완료 보고는 반드시 `Docs/` 내의 문서 업데이트가 선행되어야 합니다. 문서화가 누락된 상태에서의 "작업 완료" 보고는 규칙 위반으로 간주합니다. ## 단계별 작업 루틴 @@ -44,5 +45,6 @@ description: work routine - 3단계 구현 및 테스트가 성공적으로 완료되면, 사용자에게 최종 보고하기 **전에 반드시 먼저** `/Docs/` 디렉토리에 작업 완료(Work done), 트러블슈팅(Troubleshooting), 의사 결정(Decisions made) 내역을 문서화해야 합니다. - 새 문서가 생성되거나 수정되면 자동으로 `Docs/index.md`에 문서의 색인(링크)을 추가합니다. -- 모든 코드 작업 내역과 의사 결정이 완전히 로컬 `Docs/`에 기록 및 정리된 후에만 비로소 "작업을 완료했다"고 사용자에게 알립니다. +- 모든 코드 작업 내역과 의사 결정이 완전히 로컬 `Docs/`에 기록 및 정리된 후에만 비로소 "작업을 완료했다"고 사용자에게 알립니다. **문서화가 완료되지 않은 상태에서 사용자에게 보고하는 것은 엄격히 금지됩니다.** - 설치, 테스트 방법, 구동, 기능, 명령어 등을 위한 변경사항을 /README.md에 최신화합니다. +- **최종 검크포인트**: 보고 메시지 작성 직전, `Docs/` 폴더와 `README.md`, `index.md`가 최신 상태인지 다시 한번 전수 점검합니다. diff --git a/Docs/Decisions/Dashboard_Architecture_gRPC.md b/Docs/Decisions/Dashboard_Architecture_gRPC.md new file mode 100644 index 0000000..0615466 --- /dev/null +++ b/Docs/Decisions/Dashboard_Architecture_gRPC.md @@ -0,0 +1,33 @@ +# 결정 사항: 대시보드-봇 통신 아키텍처 (gRPC Proxy) + +## 배경 (Context) + +대시보드(Next.js)와 멀티 인스턴스 샤딩 환경의 봇 간에 실시간 통신이 필요합니다. 대시보드는 특정 길드의 설정을 변경하거나 채널 목록을 조회해야 하지만, 봇이 여러 프로세스(Shard)로 쪼개져 있어 어떤 인스턴스가 해당 길드를 관리하는지 대시보드가 알기 어려운 문제가 있습니다. + +## 결정된 사항 (Decision) + +1. **통신 프로토콜**: **gRPC (HTTP/2)** 선택 + - 강력한 타입 시스템(`packages/grpc-contracts`) 공유를 위해 선택했습니다. + - 대량의 데이터 전송 및 실시간 양방향 통신 확장에 유리합니다. + +2. **Manager as API Proxy 패턴 채택** + - **구조**: Dashboard <-> ShardingManager (gRPC Server) <-> Shards (IPC) + - 모든 대시보드 요청은 단 하나의 포트(`50051`)를 가진 `ShardingManager`로 집중됩니다. + - 매니저는 `guildId` 등의 키를 확인하여 내부적으로 `broadcastEval` 또는 `IPC`를 통해 해당 Shard에게 업무를 하달합니다. + +3. **데이터 보관 전략**: **DB (Prisma) 중심** + - 실시간성이 극도로 중요한 요청 외의 설정값 변경은 DB를 우선 업데이트하고, 봇이 이를 캐시 동기화하도록 인터페이스를 구성합니다. + +## 장점 (Pros) + +- **인프라 간소화**: 봇 인스턴스가 100개로 늘어나도 대시보드 입장에서는 `50051` 포트 하나만 바라보면 됩니다. +- **포트 충돌 방지**: 각 샤드 워커마다 별도의 서버 포트를 할당할 필요가 없습니다. +- **코드 공유**: 모노레포 구조를 통해 클라이언트와 서버가 동일한 `.proto` 계약을 공유합니다. + +## 단점 (Cons) + +- **매니저 오버헤드**: 매니저가 모든 통신을 중계하므로, 통신량이 극도로 많아질 경우 매니저가 병목이 될 수 있습니다. (이 경우 추후 Redis Pub/Sub으로 전환 고려) + +## 대안 (Alternatives) + +- **Redis Pub/Sub**: 가장 유연하지만 추가 인프라(Redis) 관리가 필요합니다. 현재는 단일 서버 환경이므로 gRPC Proxy가 더 효율적이라고 판단했습니다. diff --git a/Docs/WorkDone/2026-04-20_Monorepo_Migration_And_gRPC_Test.md b/Docs/WorkDone/2026-04-20_Monorepo_Migration_And_gRPC_Test.md new file mode 100644 index 0000000..68fe49a --- /dev/null +++ b/Docs/WorkDone/2026-04-20_Monorepo_Migration_And_gRPC_Test.md @@ -0,0 +1,32 @@ +# 2026-04-20: 모노레포 전환 및 gRPC 통신 테스트 완료 (Monorepo & gRPC Test) + +대시보드 도입을 위한 프로젝트 구조 개편과 봇-대시보드 간의 실시간 통신 인프라를 구축하고 검증하였습니다. + +## 작업 내용 (Work Done) + +### 1. 프로젝트 모노레포(Monorepo) 화 +- **Turborepo & Yarn Workspaces** 도입: 프로젝트를 모듈화하여 관리하기 위해 모노레포 구조로 전환했습니다. + - `apps/bot`: 기존 디스코드 봇 로직 이관. + - `apps/dashboard`: Next.js 기반 웹 대시보드 신규 생성. + - `packages/db`: Prisma 스키마 및 DB 접근 로직을 공용 패키지로 분리. + - `packages/grpc-contracts`: gRPC 프로토콜 버퍼와 인터페이스 정의를 위한 공용 패키지 생성. + +### 2. 봇 샤딩 및 상태 관리 고도화 +- **ShardingManager 도입**: 봇 프로세스를 분할 관리하고 gRPC 서버를 부착하기 위해 최상위 매니저 레이어를 추가했습니다. +- **ShardStatus 추적**: 각 Shard가 실행될 때 자신의 상태와 담당 길드 정보를 DB(`ShardStatus` 테이블)에 기록하도록 구현했습니다. + +### 3. gRPC 통신 프록시 서버 구축 +- **단일 포트 gRPC 서버**: `ShardingManager` 단에서 `50051` 포트로 gRPC 서버를 실행합니다. +- **메시지 라우팅**: 대시보드로부터 요청이 들어오면 매니저가 `broadcastEval`을 통해 해당 길드를 담당하는 하위 Shard 프로세스로 요청을 전달(Proxy)합니다. + +### 4. 대시보드 gRPC 통신 테스트 완료 +- **테스트 환경 구성**: Next.js API Route를 통해 봇에게 `Ping`을 쏘고 `Pong` 응답을 받는 라이프사이클을 구현했습니다. +- **UI 검증**: 대시보드 메인 페이지에서 버튼 클릭 시 봇으로부터 성공적으로 응답을 받아 `response`를 렌더링함을 확인했습니다. + +## 테스트 결과 (Results) + +- **연결 성공**: 대시보드 -> 매니저 -> (방송) -> 봇 워커 -> 매니저 -> 대시보드 흐름이 무차별적인 포트 개방 없이 단일 통로로 성공적으로 작동함. +- **지연 시간**: 로컬 환경 기준 10ms 이내의 빠른 응답 속도를 확인. + +## 관련 문서 +- [대시보드 아키텍처 결정서](../Decisions/Dashboard_Architecture_gRPC.md) diff --git a/Docs/index.md b/Docs/index.md index b2f45be..5a093b4 100644 --- a/Docs/index.md +++ b/Docs/index.md @@ -35,6 +35,7 @@ ## 아키텍처 및 정책 결정 (Decisions) - [구독 티어 시스템 설계 (Subscription Tiers)](Decisions/subscription_tiers.md) +- [대시보드-봇 통신 아키텍처 (Dashboard gRPC Architecture)](Decisions/Dashboard_Architecture_gRPC.md) ## 트러블슈팅 (Troubleshooting) @@ -67,3 +68,4 @@ - [2026-04-07: 낚시 미니게임 Phase 2 구현 (Fishing Mini-Game Phase 2 Implementation)](WorkDone/2026-04-07_Fishing_MiniGame_Phase2_Implementation.md) - [2026-04-07: 낚시 도감 및 크기 시스템 구현 (Fishing Dex and Size Implementation)](WorkDone/2026-04-07_Fishing_Dex_And_Size_Implementation.md) - [2026-04-07: 낚시 크기 랭킹 구현 (Fishing Size Ranking Implementation)](WorkDone/2026-04-07_Fishing_Size_Ranking_Implementation.md) +- [2026-04-20: 모노레포 전환 및 gRPC 통신 테스트 완료 (Monorepo & gRPC Test)](WorkDone/2026-04-20_Monorepo_Migration_And_gRPC_Test.md) diff --git a/README.md b/README.md index f9aa12b..b5b6879 100644 --- a/README.md +++ b/README.md @@ -1,74 +1,66 @@ -# Kord +# Kord (Monorepo) -Kord는 Discord 서버 관리를 돕는 강력하고 유연한 다기능 봇입니다. +Kord는 Discord 서버 관리를 돕는 강력하고 유연한 다기능 봇 및 전용 웹 대시보드 프로젝트입니다. +현재 모노레포(Monorepo) 구조로 관리되고 있습니다. -## 1. 개요 (Overview) +## 1. 프로젝트 구조 (Structure) -**Kord**는 효율적인 서버 운영을 위해 설계된 Discord 봇입니다. TypeScript와 Discord.js를 기반으로 구축되었으며, Prisma(PostgreSQL)를 활용하여 안정적이고 확장 가능한 아키텍처를 제공합니다. 임시 음성 채널 관리, 상세 감사 로그, 권한 진단 등의 핵심 기능을 통해 서버 관리자의 부담을 줄여줍니다. +본 프로젝트는 **Turborepo**와 **Yarn Workspaces**를 사용합니다. + +- **`apps/bot`**: Discord.js 기반의 봇 본체 (ShardingManager 적용) +- **`apps/dashboard`**: Next.js 기반의 봇 관리 웹 대시보드 +- **`packages/db`**: Prisma 스키마 및 데이터베이스 데이터 접근 레이어 (공용) +- **`packages/grpc-contracts`**: 봇과 대시보드 간의 gRPC 통신 규약 (공용) ## 2. 요구사항 (Requirements) -- **Runtime**: Node.js v20 이상 +- **Runtime**: Node.js v22 이상 (추천) - **Package Manager**: Yarn v4 (Berry) - **Database**: PostgreSQL (Prisma 사용) -- **Discord**: Bot Token 및 Client ID (Slash Command 등록용) +- **Discord**: Bot Token 및 Client ID -## 3. 테스트 방법 (Test Methods) +## 3. 시작하기 (Quick Start) -본 프로젝트는 Jest를 사용하여 유닛 테스트 및 통합 테스트를 수행합니다. - -- **전체 테스트 실행**: - - ```bash - yarn test - ``` - -- **i18n 번역 누락 확인**: - - ```bash - yarn check-i18n - ``` - -## 4. 구동 방법 (Running Methods) - -### 로컬 개발 환경 +### 로컬 개발 환경 설정 1. **의존성 설치**: - ```bash yarn install ``` -2. **환경 변수 설정**: `.env.example` 파일을 복사하여 `.env` 파일을 생성하고 필수 값을 입력합니다. - -3. **데이터베이스 초기화**: +2. **환경 변수 설정**: 루트 및 각 앱 디렉토리의 `.env` 설정을 완료합니다. +3. **데이터베이스 및 코드 생성**: ```bash - npx prisma migrate dev - npx prisma generate + yarn run generate ``` -4. **개발 서버 실행**: +### 실행 방법 +전체 프로젝트를 한꺼번에 실행하거나 개별 앱을 실행할 수 있습니다. + +- **모든 앱 실행 (Bot + Dashboard)**: ```bash yarn dev ``` -### 프로덕션 환경 +- **봇만 실행**: + ```bash + yarn workspace @kord/bot dev + ``` -1. **빌드**: `yarn build` -2. **실행**: `yarn start` -3. **Docker**: `docker-compose up -d`를 통해 PostgreSQL 등 로컬 인프라를 실행할 수 있습니다. +- **대시보드만 실행**: + ```bash + yarn workspace dashboard dev + ``` +## 4. 아키텍처 (Architecture) -## 5. 기능 목록 (Feature List) +Kord는 **gRPC Proxy** 아키텍처를 사용하여 대시보드와 샤딩된 봇 인스턴스 간의 실시간 통신을 처리합니다. 자세한 내용은 관련 문서를 참조하세요. +- [대시보드 통신 아키텍처 가이드](Docs/Decisions/Dashboard_Architecture_gRPC.md) -- **임시 음성 채널 (Voice)**: 생성기(Generator) 채널을 통해 동적인 음성 채널 생성 및 관리 기능을 제공합니다. -- **감사 로그 (Audit Log)**: 서버 내 주요 이벤트를 카테고리별(VOICE, PERMISSION, SYSTEM 등)로 세분화하여 기록합니다. -- **서버 설정 (Config)**: 따라하기(Mimic), 큰 이모지(Big Emoji) 등 봇의 기능을 서버별 환경에 맞게 토글하거나 설정할 수 있습니다. -- **권한 감사 (Permission Audit)**: 봇의 정상 작동을 방해하는 권한 문제를 즉시 진단하고 해결 방법을 안내합니다. -- **초기 설정 마법사 (Setup Wizard)**: 봇 도입 초기 기능을 한눈에 설정할 수 있는 직관적인 UI를 제공합니다. -- **미니게임 시스템 (Mini-Games)**: 서버 내에서 즐길 수 있는 다양한 미니게임을 제공하며, 관리자가 게임별 활성화 및 전용 채널을 설정할 수 있습니다. -- **재련 (Refinement)**: 무기를 강화하고 다른 유저와 전투하며 골드를 획득하는 성장형 미니게임입니다. -- **피버 타임 (Fever Time)**: 서버 활동량을 자동으로 분석하여 가장 활발한 시간대에 재련 성공 확률 보너스를 제공합니다. -- **다국어 지원 (i18n)**: 한국어와 영어를 포함한 다국어 환경을 지원합니다. +## 5. 문서 (Documentation) + +모둔 상세 문서는 `Docs/` 디렉토리에 위치합니다. +- [문서 전체 색인 (Docs Index)](Docs/index.md) +- [로컬 가이드북 (SKILL.md)](SKILL.md)