[FEAT] 디스코드 알림 로직 추가 #126

coli-geonwoo · 2025-03-21T03:10:16Z

🚩 연관 이슈

closed #121

🗣️ 리뷰 요구사항 (선택)

jda를 활용한 notifier 구현
aop를 통해 에러 반환시 알림 보내도록 설정

@unifolio0

이거 하나만 인정해.. 콜리식 일처리는 일정잡고 미루는게 아니란걸..

github-actions · 2025-03-21T03:12:19Z

Test Results

115 files 115 suites 11s ⏱️
233 tests 233 ✅ 0 💤 0 ❌
245 runs 245 ✅ 0 💤 0 ❌

Results for commit 97e577e.

♻️ This comment has been updated with latest results.

github-actions · 2025-03-21T03:12:27Z

📝 Test Coverage Report

Overall Project	76.13% `-1.98%`	❌
Files changed	39.29%	❌

File	Coverage
DiscordProperties.java	100%	🍏
InitializationErrorCode.java	100%	🍏
GlobalExceptionHandler.java	21.67% `-6.67%`	❌
DiscordNotifier.java	6.25% `-93.75%`	❌

coli-geonwoo · 2025-03-21T07:06:50Z

/noti

멋있게 하루만에 완성하고 올리는건데, 오히려 이도저도 아니게되었네요..
오류 부분들 잡고 개선 완료했음다.

unifolio0

/noti

@coli-geonwoo 사소한 질문 1개랑 컨벤션 리뷰 1개 남기고 approve했습니다.

unifolio0 · 2025-03-21T11:25:59Z

src/main/java/com/debatetimer/client/DiscordNotifier.java

+@EnableConfigurationProperties(DiscordProperties.class)
+public class DiscordNotifier {
+    private static final String NOTIFICATION_PREFIX = ":rotating_light:  [**Error 발생!**]\n```\n";


개행 컨벤션 맞춰주세요

✅ 반영완료

unifolio0 · 2025-03-21T11:30:26Z

src/main/java/com/debatetimer/client/DiscordNotifier.java

+        return Arrays.stream(throwable.getStackTrace())
+                .map(StackTraceElement::toString)
+                .limit(STACK_TRACE_LENGTH)
+                .collect(Collectors.joining(System.lineSeparator()));


10줄로 정한 이유가 있나요?

jda(java discord api) 발송 제한이 2000줄

10줄 넘어로 stack trace 많이 본 적이 없어서요.

leegwichan

/noti @coli-geonwoo

개인적으로는 Discord Bot이 전반적으로 어떻게 돌아가는지 추가적으로 설명해 주었으면 좋겠어요.
현재 디스코드 알림은 500 에러 상황에서만 던지기로 했던 것 같은데, 확인 부탁드릴께요 (Aspect 안 쓰고 ExceptionHandler에서 DiscordNotifier 주입받아서 사용하면 될 것 같은데...)
이전 테스크 중에 로그 남기는 것이 있었는데, 현재 잘 작동하고 있나요?

leegwichan · 2025-03-21T11:40:04Z

src/main/java/com/debatetimer/client/DiscordProperties.java

+@Getter
+@ConfigurationProperties(prefix = "discord")
+public class DiscordProperties {
+
+    private final String token;
+    private final String channelId;
+
+    public DiscordProperties(String token, String channelId) {
+        validate(token);
+        validate(channelId);
+        this.token = token;
+        this.channelId = channelId;
+    }


o? application.yml 추가해야 하는 거 아닌가요?

dev와 prod에 업데이트 해놓았습니다.

file changes 에 안 뜨는 데, 다시 한 번 확인 부탁드릴께요! (해당 브랜치에 체크아웃해서 봐도 디스코드 관련 내용이 없네요;;)

token 값 탈취당하면 저희 토큰 활용해서 디도스 보낼 수 있어서 당연히 secret 파일에 업데이트 해놓았슴다.

leegwichan · 2025-03-21T11:42:01Z

src/main/java/com/debatetimer/aop/exception/ExceptionNotificationAspect.java

+    @AfterThrowing(pointcut = "restControllers()", throwing = "exception")
+    public void sendDiscordNotification(JoinPoint joinPoint, Exception exception) {
+        discordNotifier.sendErrorMessage(exception);
+    }


아니 이렇게 되면 400 에러도 예외 던지잖아요! 500 에러 일때만 알림 줘야죠!

아... 맞네요.. error 로 로깅되는 것들을 발송한다! 라고 착각하고 있었네요.

aspect 없애고, globalexceptionhandler에서 ServerException이나 Exception(핸들링 되지 않은 예외) 올 때만 발송하도록 하였습니다.

leegwichan · 2025-03-21T11:43:12Z

src/main/java/com/debatetimer/client/DiscordNotifier.java

+    private JDA initializeJda(String token) {
+        try {
+            return JDABuilder.createDefault(token).build().awaitReady();
+        } catch (InterruptedException e) {
+            throw new DTInitializationException(InitializationErrorCode.JDA_INITIALIZATION_FAIL);
+        }
+    }


JDA가 뭐죠?

Java로 래핑한 Discord API 입니다.
특정 봇 토큰 발급 후, API를 발송한 봇 토큰을 넣어 초기화한 후, 발송할 channel ID를 대상으로 메시지 발송 및 수신을 도와주는 라이브러리에요. 자세한 작동원리는 저도 공부하는 중이라 문서화 해놓겠습니다.

coli-geonwoo · 2025-03-23T09:17:33Z

src/main/java/com/debatetimer/client/ChannelNotifier.java

+public interface ChannelNotifier {
+
+    void sendErrorMessage(Throwable throwable);
+}


[조언 부탁]

이거 interface화 한 이유

DiscordNotifier 생성자에서 JDA를 초기화하고 있음

여기서 JDA 초기화란 Discord bot의 토큰을 넣어 Discord API를 JAVA 로 래핑하는 라이브러리인 JDA를 생성함을 의미함.

그러나, JDA에 들어가는 토큰은 실제 유효한 토큰만 가능함(null 값이나 임의 String을 넣으면 터짐)
=> 여기서 문제가 발생함

test에서 Notifier는 모킹되어야 함(아니면 실제 채널에 폭탄 메시지감<- 이미 한번 갔던 것 처럼)

모킹은 특정 객체의 상속객체를 만듦으로서 생성됨 즉, 구현체인 DiscordNotifier가 먼저 생성되어야 함

그런데 앞서 말했듯 DiscordNotifier의 JDA는 무조건 유효한 token만으로 초기화됨, 따라서 properties에 Null이나 "testToken" 같은 값을 넣으면 Jda초기화가 안되어 모킹자체가 안됨
=> test context 자체가 bean creation 단계에서 터져서 테스트가 다 터짐

내가 할 수 있었던 선택

1안 : Profile로 "dev" ,"prod"에서만 사용하자

-> DiscordNotifier가 붙인 GlobalExceptionHandler도 연쇄적으로 Profile을 분리해주어야 함
-> Profile 명시적으로 선언하는 것은 테스트를 의식한 것 같아 싫음

2안: 인터페이스 분리해서 test에서 모킹가능하도록 하자

->그래, 이게 상대적으로 낫다...

마음에 들진 않으므로 대안 있으면 제발 주세요...이거만 1시간째 고민중..

해당 이유라면 인터페이스를 도입하는 것이 좋을 것 같아요. 그리고 Local 환경에서도 알림 안가게 할 꺼면 그냥 2개 객체 만들고 사용해도 좋을 것 같네요. 최근 영한님 강의에서 본 코드 공유해드려요.

@Slf4j @Configuration public class PayConfig { @Bean @Profile({"local", "test"}) public LocalPayClient localPayClient() { return new LocalPayClient(); } @Bean @Profile({"prod", "dev"}) public TossPayClient tossPayClient() { return new TossPayClient(); } }

위와 같이 적은 후에, Test 환경의 application.yml에서는 기본 값으로 test 프로파일로 실행하게 하면 될 듯!

그리고 클래스 네이밍 자체가 좀 그래;;
ChannelNotifier 인터페이스와 DiscordNotifier 구현체라고 하면, "채널이 뭐지? 왜 알리지?", "그러면 디스코드 채널 말고 다른 알림이 있나?"라는 생각이 들 것 같음

그러면 차라리 ErrorNotifier 와 구현체로 DiscordNotifier, ConsoleNotifier를 구현체로 하고, 각각 프로파일 상황에 맞춰 사용하면 좋을 듯!

coli-geonwoo · 2025-03-23T09:21:09Z

/noti

한번 개선해보았습니당. 천천히 확인해주세요!

leegwichan

/noti @coli-geonwoo
수정된 내용 바탕으로 리뷰 남겼습니다! 리뷰 반영해주세요!

이게 실제 알람갔을 때 보여지는 예시 한 번만 공유해주세요!

leegwichan · 2025-03-23T10:33:42Z

src/test/resources/application.yml

+
+discord:
+  channel-id: testChannelId
+  token: testToken


이거 flyway랑 동일하게 추가할 것이면 차라리 --- 위로 올려 적는 편이 좋겠죠?

아니다. 어짜피 ErrorNotifier 구현체가 2개로 생길꺼니까 그냥 제거 되겠네요.

leegwichan · 2025-03-23T10:37:27Z

src/main/java/com/debatetimer/client/ChannelNotifier.java

+public interface ChannelNotifier {
+
+    void sendErrorMessage(Throwable throwable);
+}


해당 이유라면 인터페이스를 도입하는 것이 좋을 것 같아요. 그리고 Local 환경에서도 알림 안가게 할 꺼면 그냥 2개 객체 만들고 사용해도 좋을 것 같네요. 최근 영한님 강의에서 본 코드 공유해드려요.

@Slf4j @Configuration public class PayConfig { @Bean @Profile({"local", "test"}) public LocalPayClient localPayClient() { return new LocalPayClient(); } @Bean @Profile({"prod", "dev"}) public TossPayClient tossPayClient() { return new TossPayClient(); } }

위와 같이 적은 후에, Test 환경의 application.yml에서는 기본 값으로 test 프로파일로 실행하게 하면 될 듯!

leegwichan · 2025-03-23T10:43:10Z

src/main/java/com/debatetimer/client/ChannelNotifier.java

+public interface ChannelNotifier {
+
+    void sendErrorMessage(Throwable throwable);
+}


그리고 클래스 네이밍 자체가 좀 그래;;
ChannelNotifier 인터페이스와 DiscordNotifier 구현체라고 하면, "채널이 뭐지? 왜 알리지?", "그러면 디스코드 채널 말고 다른 알림이 있나?"라는 생각이 들 것 같음

그러면 차라리 ErrorNotifier 와 구현체로 DiscordNotifier, ConsoleNotifier를 구현체로 하고, 각각 프로파일 상황에 맞춰 사용하면 좋을 듯!

leegwichan · 2025-03-23T10:45:17Z

src/main/java/com/debatetimer/exception/handler/GlobalExceptionHandler.java

    @ExceptionHandler(DTServerErrorException.class)
    public ResponseEntity<ErrorResponse> handleServerException(DTServerErrorException exception) {
        log.error("message: {}", exception.getMessage());
+        channelNotifier.sendErrorMessage(exception);
        return toResponse(exception.getHttpStatus(), exception.getMessage());
    }


[선택] channelNotifier.sendErrorMessage(exception) 실행 중에 에러 나면 어떻게 해야 되려나...
일단 써보고 문제 생기면 바꿔도 상관 없을 듯?

leegwichan · 2025-03-23T10:45:59Z

src/test/java/com/debatetimer/DatabaseSchemaManagerTest.java

+    @MockitoBean
+    private ChannelNotifier channelNotifier;
+


아까전에 위에서 한 이야기 반영되면 빼도 될 것 같아요!
BaseControllerTest와 BaseDocumentTest, BaseServiceTest 포함해서요!

unifolio0 · 2025-03-23T11:01:45Z

/noti
바뀐거 확인해봤지만 커찬이 단 리뷰외에 더 언급할 건 없습니다.

coli-geonwoo added 4 commits March 21, 2025 12:05

chore: discord bot 의존성 추가

Verified

This commit was signed with the committer’s verified signature.

scala-steward Scala Steward

GPG key ID: 7FE176635A140508

Verified
Learn about vigilant mode

1861f1a

feat: discord properties 구현

d27aeb1

feat: discord notifier 구현

1da6066

feat: discord notification aop 작성

Loading
Loading status checks…

a9c2954

unifolio0 requested a review from leegwichan March 21, 2025 03:10

unifolio0 added the refactor label Mar 21, 2025

unifolio0 self-assigned this Mar 21, 2025

unifolio0 assigned coli-geonwoo and unassigned unifolio0 Mar 21, 2025

unifolio0 self-requested a review March 21, 2025 03:32

coli-geonwoo added 3 commits March 21, 2025 14:56

fix: discord 에러 픽스

e66a393

feat: 디스코드 알림 기능 구현

Loading
Loading status checks…

1035ea2

style: 개행 추가

Loading
Loading status checks…

e84d4d3

coli-geonwoo added feat and removed refactor labels Mar 21, 2025

unifolio0 approved these changes Mar 21, 2025

View reviewed changes

leegwichan requested changes Mar 21, 2025

View reviewed changes

coli-geonwoo added 4 commits March 23, 2025 17:55

chore: 테스트용 yml 파일 수정

1cedd98

refactor: channelNotifier 인터페이스화

06da828

test: 테스트에 controller mocking

Loading
Loading status checks…

073962d

test: channelNotifier 모킹

Loading
Loading status checks…

97e577e

coli-geonwoo commented Mar 23, 2025

View reviewed changes

leegwichan requested changes Mar 23, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FEAT] 디스코드 알림 로직 추가 #126

[FEAT] 디스코드 알림 로직 추가 #126

coli-geonwoo commented Mar 21, 2025

github-actions bot commented Mar 21, 2025 •

edited

Loading

github-actions bot commented Mar 21, 2025 •

edited

Loading

coli-geonwoo commented Mar 21, 2025

unifolio0 left a comment

unifolio0 Mar 21, 2025

coli-geonwoo Mar 23, 2025

unifolio0 Mar 21, 2025

coli-geonwoo Mar 23, 2025

leegwichan left a comment

leegwichan Mar 21, 2025

coli-geonwoo Mar 23, 2025

leegwichan Mar 23, 2025

coli-geonwoo Mar 23, 2025

leegwichan Mar 21, 2025

coli-geonwoo Mar 23, 2025

leegwichan Mar 21, 2025

coli-geonwoo Mar 23, 2025

coli-geonwoo Mar 23, 2025 •

edited

Loading

leegwichan Mar 23, 2025

leegwichan Mar 23, 2025

coli-geonwoo commented Mar 23, 2025

leegwichan left a comment •

edited

Loading

leegwichan Mar 23, 2025

leegwichan Mar 23, 2025

leegwichan Mar 23, 2025

leegwichan Mar 23, 2025

leegwichan Mar 23, 2025

leegwichan Mar 23, 2025

unifolio0 commented Mar 23, 2025

[FEAT] 디스코드 알림 로직 추가 #126

Are you sure you want to change the base?

[FEAT] 디스코드 알림 로직 추가 #126

Conversation

coli-geonwoo commented Mar 21, 2025

🚩 연관 이슈

🗣️ 리뷰 요구사항 (선택)

github-actions bot commented Mar 21, 2025 • edited Loading

Test Results

github-actions bot commented Mar 21, 2025 • edited Loading

📝 Test Coverage Report

coli-geonwoo commented Mar 21, 2025

unifolio0 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

leegwichan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coli-geonwoo Mar 23, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coli-geonwoo commented Mar 23, 2025

leegwichan left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

unifolio0 commented Mar 23, 2025

github-actions bot commented Mar 21, 2025 •

edited

Loading

github-actions bot commented Mar 21, 2025 •

edited

Loading

coli-geonwoo Mar 23, 2025 •

edited

Loading

leegwichan left a comment •

edited

Loading