[#59] feat: 5xx 에러에 대한 슬랙 알림 추가

Author: hyh1016

.github/workflows/cd.yml

@@ -29,6 +29,7 @@ jobs:
           sed -i 's/${DB_USERNAME:[^}]*}/${{ secrets.DB_USERNAME }}/g' src/main/resources/application.yml
           sed -i 's/${DB_PASSWORD:[^}]*}/${{ secrets.DB_PASSWORD }}/g' src/main/resources/application.yml
           sed -i 's/${GEMINI_API_KEY:[^}]*}/${{ secrets.GEMINI_API_KEY }}/g' src/main/resources/application.yml
+          sed -i 's/${SLACK_WEBHOOK_URL:[^}]*}/${{ secrets.SLACK_WEBHOOK_URL }}/g' src/main/resources/application.yml
 
       - name: Setup Gradle cache
         uses: actions/cache@v4

build.gradle.kts

@@ -97,6 +97,9 @@ dependencies {
     implementation("org.springframework.boot:spring-boot-starter-actuator")
     implementation("io.micrometer:micrometer-registry-prometheus")
 
+    // slack
+    implementation("com.slack.api:slack-api-client:1.45.3")
+
     // restdocs-api-spec
     testImplementation("com.epages:restdocs-api-spec-mockmvc:0.19.4")
     testImplementation("org.springframework.restdocs:spring-restdocs-mockmvc")

src/main/java/com/nexters/teamace/common/application/AlertService.java

@@ -0,0 +1,7 @@
+package com.nexters.teamace.common.application;
+
+import com.nexters.teamace.common.exception.ErrorType;
+
+public interface AlertService {
+    void error(ErrorType errorType, String message);
+}

src/main/java/com/nexters/teamace/common/config/AsyncConfig.java

@@ -0,0 +1,17 @@
+package com.nexters.teamace.common.config;
+
+import java.util.concurrent.Executor;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.core.task.VirtualThreadTaskExecutor;
+import org.springframework.scheduling.annotation.AsyncConfigurer;
+import org.springframework.scheduling.annotation.EnableAsync;
+
+@Configuration
+@EnableAsync
+public class AsyncConfig implements AsyncConfigurer {
+
+    @Override
+    public Executor getAsyncExecutor() {
+        return new VirtualThreadTaskExecutor("async-");
+    }
+}

src/main/java/com/nexters/teamace/common/infrastructure/SlackAlertService.java

@@ -0,0 +1,57 @@
+package com.nexters.teamace.common.infrastructure;
+
+import com.nexters.teamace.common.application.AlertService;
+import com.nexters.teamace.common.exception.ErrorType;
+import com.slack.api.Slack;
+import com.slack.api.webhook.Payload;
+import com.slack.api.webhook.WebhookResponse;
+import io.jsonwebtoken.lang.Strings;
+import java.io.IOException;
+import java.util.Objects;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.scheduling.annotation.Async;
+import org.springframework.stereotype.Service;
+
+@Slf4j
+@Service
+public class SlackAlertService implements AlertService {
+
+    @Value("${slack.enabled:false}")
+    private boolean enabled;
+
+    @Value("${slack.webhook-url:}")
+    private String webhookUrl;
+
+    private final Slack slack = Slack.getInstance();
+
+    @Async
+    @Override
+    public void error(ErrorType errorType, String message) {
+        send("Error 발생: " + errorType.name(), message);
+    }
+
+    private void send(String title, String message) {
+        send("*%s*\n%s".formatted(title, message));
+    }
+
+    private void send(String message) {
+        if (!enabled || !Strings.hasText(webhookUrl)) {
+            log.debug("Slack alert deactivate or webhook url is empty");
+        }
+        try {
+            Payload payload = Payload.builder().text(message).build();
+            WebhookResponse response = slack.send(webhookUrl, payload);
+            if (response == null || response.getCode() != 200) {
+                log.error(
+                        "Slack webhook 비정상 응답: code={}, body={}",
+                        Objects.isNull(response) ? null : response.getCode(),
+                        Objects.isNull(response) ? null : response.getBody());
+            }
+        } catch (IOException e) {
+            log.error("Slack message sending failed: {}", e.getMessage(), e);
+        } catch (Exception e) {
+            log.error("Slack message sending failed with unexpected error: {}", e.getMessage(), e);
+        }
+    }
+}

src/main/java/com/nexters/teamace/common/presentation/GlobalExceptionHandler.java

@@ -1,11 +1,13 @@
 package com.nexters.teamace.common.presentation;
 
+import com.nexters.teamace.common.application.AlertService;
 import com.nexters.teamace.common.exception.CustomException;
 import com.nexters.teamace.common.exception.ErrorType;
 import jakarta.persistence.EntityNotFoundException;
 import jakarta.validation.ConstraintViolationException;
 import java.util.List;
 import java.util.Map;
+import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.http.ResponseEntity;
 import org.springframework.security.access.AccessDeniedException;
@@ -20,8 +22,11 @@
 
 @Slf4j
 @RestControllerAdvice
+@RequiredArgsConstructor
 public class GlobalExceptionHandler {
 
+    private final AlertService alertService;
+
     @ExceptionHandler(MethodArgumentNotValidException.class)
     public ResponseEntity<ApiResponse<Void>> handleMethodArgumentNotValid(
             MethodArgumentNotValidException e) {
@@ -149,6 +154,7 @@ public ResponseEntity<ApiResponse<Void>> handleNoSuchElement(CustomException e)
     @ExceptionHandler(Exception.class)
     public ResponseEntity<ApiResponse<Void>> handleException(Exception e) {
         log.error("Unexpected error occurred: ", e);
+        alertService.error(ErrorType.INTERNAL_SERVER_ERROR, e.getMessage());
         return new ResponseEntity<>(
                 ApiResponse.error(ErrorType.INTERNAL_SERVER_ERROR),
                 ErrorType.INTERNAL_SERVER_ERROR.getStatus());

src/main/resources/application.yml

@@ -25,6 +25,9 @@ spring:
       chat: none # 기본 모델 설정 비활성화
     openai:
       api-key: ${OPENAI_API_KEY:fake-key} # 기본 모델을 비활성화해도 필수값으로 받음.
+  threads:
+    virtual:
+      enabled: true
 
 management:
   endpoints:
@@ -49,3 +52,7 @@ jwt:
 gemini:
   api-key: ${GEMINI_API_KEY:test-api-key}
   model: gemini-2.0-flash-exp
+
+slack:
+  enabled: true
+  webhook-url: ${SLACK_WEBHOOK_URL:}

src/test/java/com/nexters/teamace/common/utils/ControllerTest.java

@@ -10,6 +10,7 @@
 import com.nexters.teamace.auth.infrastructure.security.SecurityErrorHandler;
 import com.nexters.teamace.auth.presentation.AuthUserArgumentResolver;
 import com.nexters.teamace.chat.application.ChatRoomService;
+import com.nexters.teamace.common.infrastructure.SlackAlertService;
 import com.nexters.teamace.common.presentation.GlobalExceptionHandler;
 import com.nexters.teamace.conversation.application.ConversationClient;
 import com.nexters.teamace.conversation.application.ConversationService;
@@ -45,6 +46,7 @@ public abstract class ControllerTest {
     @MockitoBean protected FairyService fairyService;
     @MockitoBean protected AuthUserArgumentResolver authUserArgumentResolver;
     @MockitoBean protected LetterService letterService;
+    @MockitoBean protected SlackAlertService slackAlertService;
 
     protected Object asParsedJson(Object obj) throws JsonProcessingException {
         String json = objectMapper.writeValueAsString(obj);

src/test/java/com/nexters/teamace/common/utils/E2ETest.java

@@ -2,11 +2,13 @@
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.navercorp.fixturemonkey.FixtureMonkey;
+import com.nexters.teamace.common.infrastructure.SlackAlertService;
 import io.restassured.RestAssured;
 import org.junit.jupiter.api.BeforeEach;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.boot.test.web.server.LocalServerPort;
+import org.springframework.test.context.bean.override.mockito.MockitoBean;
 
 @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
 public abstract class E2ETest {
@@ -15,6 +17,8 @@ public abstract class E2ETest {
 
     @Autowired protected ObjectMapper objectMapper;
 
+    @MockitoBean protected SlackAlertService slackAlertService;
+
     protected final FixtureMonkey fixtureMonkey = FixtureMonkey.create();
 
     @BeforeEach

src/test/java/com/nexters/teamace/common/utils/UseCaseIntegrationTest.java

@@ -4,6 +4,7 @@
 import com.nexters.teamace.chat.domain.ChatMessageGenerator;
 import com.nexters.teamace.common.application.DateTimeHolder;
 import com.nexters.teamace.common.application.SystemHolder;
+import com.nexters.teamace.common.infrastructure.SlackAlertService;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.test.context.bean.override.mockito.MockitoBean;
 
@@ -13,6 +14,7 @@ public abstract class UseCaseIntegrationTest {
     @MockitoBean protected SystemHolder systemHolder;
     @MockitoBean protected DateTimeHolder dateTimeHolder;
     @MockitoBean protected ChatMessageGenerator chatMessageGenerator;
+    @MockitoBean protected SlackAlertService slackAlertService;
 
     protected final FixtureMonkey fixtureMonkey = FixtureMonkey.create();
 }