디스코드봇 이벤트, 명령어, 리스너 로드 및 등록 방식 개선

[hye-on]

🔗 관련 이슈

resolves #5

📝 작업 내용

• DiscoveryService와 Reflector를 활용하여 CommandHandler, ButtonHandler, EventListener 자동 탐색 및 등록 방식 적용
• @command, @button, @eventlistener 데코레이터를 활용하여 명령어 및 버튼 인터랙션을 메타데이터 기반으로 자동 등록 가능하도록 구현
• 기존 discord 및 discord-event 폴더를 interactions(사용자 능동적인 액션 중심)과 events(시스템 이벤트 중심)로 재구성하여 책임 분리
• @catchError 데코레이터가 기존 메서드의 메타데이터를 보존하도록 개선
  • @catchError가 @Cron을 덮어쓰면서 메타데이터 손실 문제 발생
  • 원인은 @catchError 데코레이터가 원본 메서드를 감싸면서, 기존의 메타데이터를 보존하지 않고 덮어쓰는 방식이었기 때문
    (@Cron은 내부적으로 reflect-metadata를 사용하기 때문)
  • 해결법: Reflect.getMetadataKeys()를 활용하여 기존 메서드의 모든 메타데이터를 보존한 후, 새로운 래핑 함수에 다시 적용하는 방식으로 개선

🍇 고민한 부분

1. 기존 구조의 문제점

핸들러 등록 방식의 일관성 부족

기존에는 명령어와 버튼을 추가할 때, ButtonHandler와 CommandHandler를 직접 수정해야 했습니다.
핸들러를 등록하는 방식으로 fs.readdirSync를 활용해 특정 경로(const commandsPath = path.join(__dirname, '..', 'slash/implementations');)에서 파일을 읽어 명령어를 동적으로 로드하는 방식은 폴더 구조를 리팩토링할 경우, 해당 경로가 변경되면 핸들러가 정상적으로 등록되지 않아 계속 수정해줘야 해서 유지보수가 어렵다는 문제가 있었습니다.

---

구조 개선을 위한 여러 접근 방식 검토

💫 선택: Discovery 기반 자동 등록

DiscoveryService를 활용하여 명령어, 버튼, 이벤트 리스너를 자동으로 탐색하고 등록하도록 변경했습니다.
이제 클래스에 @Command, @Button, @EventListener등의 데코레이터를 추가하여 메타데이터 기반 자동 등록 가능하도록 개선하였습니다. 이를 통해 새로운 명령어 추가 시 변경사항의 영향범위를 줄였습니다.

Function Composition + Decorator Hybrid

이 방식은 특정 시간대에만 문제 풀이 가능하도록 제한하거나, 사용자별 문제 풀이 횟수를 제한하는 등의 요구사항이 생겼을 때,
기존 코드 수정 없이 미들웨어를 추가하는 것만으로 기능을 확장할 수 있다는 장점이 있었습니다.
FP 패러다임에 대한 이해가 부족한 상황에서 이를 도입할 경우 디버깅이 어려울 것 같아 개발 속도가 느려질 것 같아 반려했습니다.

Factory 패턴 기반 등록

DI 컨테이너를 거치지 않고 독립적인 Factory를 사용하면 테스트가 용이하지만, NestJS의 의존성 주입을 활용할 수 없다는 단점이 있습니다.

EventEmitter

명령어 실행 컨텍스트를 유지하는 것이 어려워 명령어 실행 중 특정 데이터를 유지해야 하는 경우 쉽게 전달하기 어렵다는 단점이 있습니다.

Dynamic Module + Factory Provider

Dynamic Module을 활용하면 런타임에 새로운 명령어 타입을 등록하고 DI 컨테이너를 사용할 수 있지만, 모듈 초기화 후 providers 배열이 고정되어 명령어 추가 시 전체 모듈을 재초기화해야 하며, 인스턴스 생성 방식으로 인해 성능 저하 및 메모리 관리의 어려움이 있어 선택하지 않았습니다.

NestJS RouterModule

NestJS의 RouterModule은 HTTP 요청 라우팅에 최적화된 방식으로, Discord 봇의 이벤트 기반 구조와 맞지 않아 제외했습니다.