feat : 서버에러 슬랙 알림 추가

DuDoong-Api/build.gradle

@@ -14,7 +14,6 @@ dependencies {
     implementation 'org.springframework.boot:spring-boot-starter-validation'
     implementation 'org.springdoc:springdoc-openapi-ui:1.6.12'
     implementation 'org.springframework.boot:spring-boot-starter-security'
-
     implementation project(':DuDoong-Domain')
     implementation project(':DuDoong-Common')
     implementation project(':DuDoong-Infrastructure')

DuDoong-Api/src/main/java/band/gosrock/api/config/response/GlobalExceptionHandler.java

@@ -1,6 +1,8 @@
 package band.gosrock.api.config.response;
 
 
+import band.gosrock.api.config.security.SecurityUtils;
+import band.gosrock.api.config.slack.SlackApiProvider;
 import band.gosrock.common.dto.ErrorReason;
 import band.gosrock.common.dto.ErrorResponse;
 import band.gosrock.common.exception.BaseErrorCode;
@@ -37,6 +39,7 @@
 @RequiredArgsConstructor
 public class GlobalExceptionHandler extends ResponseEntityExceptionHandler {
 
+    private final SlackApiProvider slackApiProvider;
     //    /** Json 날짜 형식 파싱에 대한 에러 핸들러 */
     //    @ExceptionHandler({ InvalidFormatException.class, DateTimeParseException.class})
     //    public ResponseEntity<ErrorResponse> JsonParseExceptionHandler(
@@ -163,6 +166,7 @@ public ResponseEntity<ErrorResponse> DuDoongDynamicExceptionHandler(
     protected ResponseEntity<ErrorResponse> handleException(Exception e, HttpServletRequest request)
             throws IOException {
         final ContentCachingRequestWrapper cachingRequest = (ContentCachingRequestWrapper) request;
+        final Long userId = SecurityUtils.getCurrentUserId();
         String url =
                 UriComponentsBuilder.fromHttpRequest(new ServletServerHttpRequest(request))
                         .build()
@@ -176,8 +180,8 @@ protected ResponseEntity<ErrorResponse> handleException(Exception e, HttpServlet
                         internalServerError.getCode(),
                         internalServerError.getReason(),
                         url);
-        // TODO : 슬랙 오류 발송
-        //        slackProvider.sendError(url, cachingRequest, e);
+
+        slackApiProvider.sendError(cachingRequest, e, userId);
         return ResponseEntity.status(HttpStatus.valueOf(internalServerError.getStatus()))
                 .body(errorResponse);
     }

DuDoong-Api/src/main/java/band/gosrock/api/config/slack/SlackApiProvider.java

@@ -0,0 +1,109 @@
+package band.gosrock.api.config.slack;
+
+import static com.slack.api.model.block.Blocks.divider;
+import static com.slack.api.model.block.Blocks.section;
+import static com.slack.api.model.block.composition.BlockCompositions.plainText;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.slack.api.methods.MethodsClient;
+import com.slack.api.methods.SlackApiException;
+import com.slack.api.methods.request.chat.ChatPostMessageRequest;
+import com.slack.api.model.block.Blocks;
+import com.slack.api.model.block.LayoutBlock;
+import com.slack.api.model.block.composition.MarkdownTextObject;
+import com.slack.api.model.block.composition.TextObject;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.scheduling.annotation.Async;
+import org.springframework.stereotype.Component;
+import org.springframework.web.util.ContentCachingRequestWrapper;
+
+@Component
+@RequiredArgsConstructor
+@Slf4j
+public class SlackApiProvider {
+    private final MethodsClient methodsClient;
+    private final ObjectMapper objectMapper;
+
+    @Value("${spring.profiles.active}")
+    private String ACTIVE_PROFILE;
+
+    @Value("${slack.webhook.id}")
+    private String CHANNEL_ID;
+
+    private final int MAX_LEN = 500;
+
+    @Async
+    public void sendError(ContentCachingRequestWrapper cachingRequest, Exception e, Long userId)
+            throws IOException {
+        if (Arrays.asList("staging", "prod").contains(ACTIVE_PROFILE)) {
+            executeSendError(cachingRequest, e, userId);
+        }
+    }
+
+    private void executeSendError(
+            ContentCachingRequestWrapper cachingRequest, Exception e, Long userId)
+            throws IOException {
+        final String url = cachingRequest.getRequestURL().toString();
+        final String method = cachingRequest.getMethod();
+        final String body =
+                objectMapper.readTree(cachingRequest.getContentAsByteArray()).toString();
+        final String exceptionAsString = Arrays.toString(e.getStackTrace());
+        final int cutLength = Math.min(exceptionAsString.length(), MAX_LEN);
+
+        final String errorMessage = e.getMessage();
+        final String errorStack = exceptionAsString.substring(0, cutLength);
+        final String errorUserIP = cachingRequest.getRemoteAddr();
+
+        List<LayoutBlock> layoutBlocks = new ArrayList<>();
+        layoutBlocks.add(
+                Blocks.header(
+                        headerBlockBuilder ->
+                                headerBlockBuilder.text(plainText("Error Detection"))));
+        layoutBlocks.add(divider());
+
+        MarkdownTextObject errorUserIdMarkdown =
+                MarkdownTextObject.builder().text("* User Id :*\n" + userId).build();
+        MarkdownTextObject errorUserIpMarkdown =
+                MarkdownTextObject.builder().text("* User IP :*\n" + errorUserIP).build();
+        layoutBlocks.add(
+                section(
+                        section ->
+                                section.fields(List.of(errorUserIdMarkdown, errorUserIpMarkdown))));
+
+        MarkdownTextObject methodMarkdown =
+                MarkdownTextObject.builder()
+                        .text("* Request Addr :*\n" + method + " : " + url)
+                        .build();
+        MarkdownTextObject bodyMarkdown =
+                MarkdownTextObject.builder().text("* Request Body :*\n" + body).build();
+        List<TextObject> fields = List.of(methodMarkdown, bodyMarkdown);
+        layoutBlocks.add(section(section -> section.fields(fields)));
+
+        layoutBlocks.add(divider());
+
+        MarkdownTextObject errorNameMarkdown =
+                MarkdownTextObject.builder().text("* Message :*\n" + errorMessage).build();
+        MarkdownTextObject errorStackMarkdown =
+                MarkdownTextObject.builder().text("* Stack Trace :*\n" + errorStack).build();
+        layoutBlocks.add(
+                section(section -> section.fields(List.of(errorNameMarkdown, errorStackMarkdown))));
+
+        ChatPostMessageRequest chatPostMessageRequest =
+                ChatPostMessageRequest.builder()
+                        .channel(CHANNEL_ID)
+                        .text("")
+                        .blocks(layoutBlocks)
+                        .build();
+        try {
+            methodsClient.chatPostMessage(chatPostMessageRequest);
+        } catch (SlackApiException slackApiException) {
+            log.error(slackApiException.toString());
+        }
+    }
+}

DuDoong-Api/src/main/resources/application.yml

@@ -17,6 +17,11 @@ server:
   servlet:
     context-path: /api
   forward-headers-strategy: framework
+
+
+slack:
+  webhook:
+    id: ${SLACK_WEBHOOK_ID}
 ---
 spring:
   config:

DuDoong-Infrastructure/src/main/java/band/gosrock/infrastructure/config/slack/SlackApiConfig.java

@@ -0,0 +1,21 @@
+package band.gosrock.infrastructure.config.slack;
+
+
+import com.slack.api.Slack;
+import com.slack.api.methods.MethodsClient;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class SlackApiConfig {
+
+    @Value("${slack.webhook.token}")
+    private String token;
+
+    @Bean
+    public MethodsClient getClient() {
+        Slack slackClient = Slack.getInstance();
+        return slackClient.methods(token);
+    }
+}

DuDoong-Infrastructure/src/main/resources/application-infrastructure.yml

@@ -12,6 +12,9 @@ spring:
     port: ${REDIS_PORT:6379}
     password: ${REDIS_PASSWORD:}
 
+slack:
+  webhook:
+    token: ${SLACK_WEBHOOK_TOKEN}
 ---
 spring:
   config: