Merge pull request #287 from JiHongKim98/feature/user-inquiries

회원 1:1 문의하기 기능 추가

.env.example

@@ -16,3 +16,6 @@ S3_ACCESS_KEY=
 S3_SECRET_KEY=
 S3_REGION=ap-northeast-2
 S3_IMAGE_URL=
+
+# DISCORD
+DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/1234567890987654/abcdefg1234567890

src/main/java/com/example/daobe/common/config/DiscordConfig.java

@@ -0,0 +1,25 @@
+package com.example.daobe.common.config;
+
+import com.example.daobe.user.infrastructure.discord.DiscordApiClient;
+import com.example.daobe.user.infrastructure.discord.DiscordProperties;
+import lombok.RequiredArgsConstructor;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.client.RestClient;
+import org.springframework.web.client.support.RestClientAdapter;
+import org.springframework.web.service.invoker.HttpServiceProxyFactory;
+
+@Configuration
+@RequiredArgsConstructor
+public class DiscordConfig {
+
+    private final DiscordProperties discordProperties;
+
+    @Bean
+    public DiscordApiClient createHttpInterface() {
+        RestClient restClient = RestClient.builder().baseUrl(discordProperties.webhookUrl()).build();
+        RestClientAdapter adapter = RestClientAdapter.create(restClient);
+        HttpServiceProxyFactory factory = HttpServiceProxyFactory.builderFor(adapter).build();
+        return factory.createClient(DiscordApiClient.class);
+    }
+}

src/main/java/com/example/daobe/user/application/UserExternalEventAlert.java

@@ -0,0 +1,8 @@
+package com.example.daobe.user.application;
+
+import com.example.daobe.user.domain.event.UserInquiriesEvent;
+
+public interface UserExternalEventAlert {
+
+    void execute(UserInquiriesEvent event);
+}

src/main/java/com/example/daobe/user/application/UserExternalEventListener.java

@@ -0,0 +1,21 @@
+package com.example.daobe.user.application;
+
+import com.example.daobe.user.domain.event.UserInquiriesEvent;
+import lombok.RequiredArgsConstructor;
+import org.springframework.scheduling.annotation.Async;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.event.TransactionPhase;
+import org.springframework.transaction.event.TransactionalEventListener;
+
+@Service
+@RequiredArgsConstructor
+public class UserExternalEventListener {
+
+    private final UserExternalEventAlert userExternalEventAlert;
+
+    @Async
+    @TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT)
+    public void listenInquiriesEvent(UserInquiriesEvent event) {
+        userExternalEventAlert.execute(event);
+    }
+}

src/main/java/com/example/daobe/user/application/UserService.java

@@ -7,10 +7,12 @@
 import com.example.daobe.user.application.dto.UpdateProfileRequestDto;
 import com.example.daobe.user.application.dto.UpdateProfileResponseDto;
 import com.example.daobe.user.application.dto.UserInfoResponseDto;
+import com.example.daobe.user.application.dto.UserInquiriesRequestDto;
 import com.example.daobe.user.application.dto.UserPokeRequestDto;
 import com.example.daobe.user.application.dto.UserWithdrawRequestDto;
 import com.example.daobe.user.domain.User;
 import com.example.daobe.user.domain.event.UserCreateEvent;
+import com.example.daobe.user.domain.event.UserInquiriesEvent;
 import com.example.daobe.user.domain.event.UserPokeEvent;
 import com.example.daobe.user.domain.event.UserUpdateEvent;
 import com.example.daobe.user.domain.repository.UserRepository;
@@ -29,6 +31,8 @@
 @RequiredArgsConstructor
 public class UserService {
 
+    // TODO: 리팩토링
+
     private static final int DEFAULT_VIEW_LIMIT_SIZE = 10;
     private static final int DEFAULT_EXECUTE_LIMIT_SIZE = DEFAULT_VIEW_LIMIT_SIZE + 1;
 
@@ -108,6 +112,18 @@ public void withdraw(Long userId, UserWithdrawRequestDto request) {
         userRepository.save(findUser);
     }
 
+    public void inquiries(Long userId, UserInquiriesRequestDto request) {
+        User findUser = userRepository.findById(userId)
+                .orElseThrow(() -> new UserException(NOT_EXIST_USER));
+        UserInquiriesEvent event = new UserInquiriesEvent(
+                userId,
+                findUser.getNickname(),
+                request.email(),
+                request.contents()
+        );
+        eventPublisher.publishEvent(event);
+    }
+
     // External Service
     public User getUserById(Long userId) {
         return userRepository.findById(userId)

src/main/java/com/example/daobe/user/application/dto/UserInquiriesRequestDto.java

@@ -0,0 +1,7 @@
+package com.example.daobe.user.application.dto;
+
+public record UserInquiriesRequestDto(
+        String email,
+        String contents
+) {
+}

src/main/java/com/example/daobe/user/domain/event/UserInquiriesEvent.java

@@ -0,0 +1,9 @@
+package com.example.daobe.user.domain.event;
+
+public record UserInquiriesEvent(
+        Long userId,
+        String nickname,
+        String email,
+        String contents
+) {
+}

src/main/java/com/example/daobe/user/infrastructure/discord/DiscordApiClient.java

@@ -0,0 +1,11 @@
+package com.example.daobe.user.infrastructure.discord;
+
+import com.example.daobe.user.infrastructure.discord.dto.DiscordAlertPayloadDto;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.service.annotation.PostExchange;
+
+public interface DiscordApiClient {
+
+    @PostExchange
+    void execute(@RequestBody DiscordAlertPayloadDto payload);
+}

src/main/java/com/example/daobe/user/infrastructure/discord/DiscordProperties.java

@@ -0,0 +1,10 @@
+package com.example.daobe.user.infrastructure.discord;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+@ConfigurationProperties(prefix = "discord")
+public record DiscordProperties(
+        String webhookUrl,
+        String messageFormat
+) {
+}

src/main/java/com/example/daobe/user/infrastructure/discord/DiscordUserExternalEventAlert.java

@@ -0,0 +1,35 @@
+package com.example.daobe.user.infrastructure.discord;
+
+import com.example.daobe.user.application.UserExternalEventAlert;
+import com.example.daobe.user.domain.event.UserInquiriesEvent;
+import com.example.daobe.user.infrastructure.discord.dto.DiscordAlertPayloadDto;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Component;
+
+@Component
+@RequiredArgsConstructor
+public class DiscordUserExternalEventAlert implements UserExternalEventAlert {
+
+    private static final String DISCORD_MESSAGE_TITLE = "💬 1:1 문의하기";
+    private static final String DISCORD_MESSAGE_CONTENTS = "## 🚀 새로운 문의가 도착했습니다!";
+
+    private final DiscordApiClient discordApiClient;
+    private final DiscordProperties discordProperties;
+
+    @Override
+    public void execute(UserInquiriesEvent event) {
+        String description = String.format(
+                discordProperties.messageFormat(),
+                event.userId(),
+                event.nickname(),
+                event.email(),
+                event.contents()
+        );
+        DiscordAlertPayloadDto payload = DiscordAlertPayloadDto.of(
+                DISCORD_MESSAGE_CONTENTS,
+                DISCORD_MESSAGE_TITLE,
+                description
+        );
+        discordApiClient.execute(payload);
+    }
+}

src/main/java/com/example/daobe/user/infrastructure/discord/dto/DiscordAlertPayloadDto.java

@@ -0,0 +1,20 @@
+package com.example.daobe.user.infrastructure.discord.dto;
+
+import java.util.List;
+
+public record DiscordAlertPayloadDto(
+        String content,
+        List<Embeds> embeds
+) {
+
+    public static DiscordAlertPayloadDto of(String content, String title, String description) {
+        return new DiscordAlertPayloadDto(content, List.of(new Embeds(title, description)));
+    }
+
+    // Nested
+    public record Embeds(
+            String title,
+            String description
+    ) {
+    }
+}

src/main/java/com/example/daobe/user/presentation/UserController.java

@@ -7,6 +7,7 @@
 import com.example.daobe.user.application.dto.UpdateProfileRequestDto;
 import com.example.daobe.user.application.dto.UpdateProfileResponseDto;
 import com.example.daobe.user.application.dto.UserInfoResponseDto;
+import com.example.daobe.user.application.dto.UserInquiriesRequestDto;
 import com.example.daobe.user.application.dto.UserPokeRequestDto;
 import com.example.daobe.user.application.dto.UserWithdrawRequestDto;
 import lombok.RequiredArgsConstructor;
@@ -102,4 +103,17 @@ public ResponseEntity<ApiResponse<Void>> poke(
                 null
         ));
     }
+
+    @RateLimited(name = "userInquiries", capacity = 1, refillSeconds = 30)
+    @PostMapping("/inquiries")
+    public ResponseEntity<ApiResponse<Void>> inquiries(
+            @AuthenticationPrincipal Long userId,
+            @RequestBody UserInquiriesRequestDto request
+    ) {
+        userService.inquiries(userId, request);
+        return ResponseEntity.ok(new ApiResponse<>(
+                "INQUIRIES_SUCCESS",
+                null
+        ));
+    }
 }

src/main/resources/application-local.yml

@@ -1,10 +1,10 @@
-management:
-  endpoints:
-    web:
-      exposure:
-        include: "prometheus,health"
+server:
+  shutdown: graceful
 
 spring:
+  lifecycle:
+    timeout-per-shutdown-phase: 5s
+
   jackson:
     property-naming-strategy: SNAKE_CASE
 
@@ -83,6 +83,27 @@ spring:
     password: actuator
     role: ACTUATOR
 
+management:
+  endpoints:
+    web:
+      exposure:
+        include: "prometheus,health"
+
+discord:
+  webhook-url: ${DISCORD_WEBHOOK_URL}
+  message-format: |
+    ### 👥 사용자 정보
+    
+    식별자 : `%s`
+    닉네임 : `%s`
+    이메일 : `%s`
+    
+    ### 🖋 문의 내용
+    
+    ```
+    %s
+    ```
+
 security:
   jwt:
     secret-key: afdakfjlkasjfaioefjklasfmakl;fjaklfmakl;dfaklfadsflka