fix: 🐛 Modify the business logic of chat room creation (#180)

* fix: presigned_url_property_factory 불필요한 builder 제거

* refactor: property 추상 클래스를 사용한 자원 생성 전략 수정

* fix: presigned-url 발급을 위한 validator 수정

* fix: query param chat_id, feed_id 삭제

* test: storage_controller_test 수정

* test: factory test 수정

* fix: factory 생성 전략 수정

* fix: object_key_type에서 필수로 변경되어야 할 아이디 리스트 제공 메서드 추가

* fix: 변경할 아이디 전달 객체 생성하여 반영

* fix: aws_adapter 파라미터 수정

* test: url_generator test 수정

* fix: pending chatroom entity 및 비지니스 로직 제거

* test: chat_room create controller unit test 수정

* fix: chat_room_controller pend 경로 제거 및 dto 통합

* docs: 채팅방 생성 스웨거 수정

* test: 채팅방 생성 통합 테스트 기대값 수정

* fix: chat_room_req password 유효성 검사를 위한 필드 타입 수정 및 null 분기 조건 추가

* fix: 채팅방 생성 비지니스 로직 수정

* rename: actual_id_provider 모호함을 유발할 수 있는 주석 수정

Author: psychology50

pennyway-app-external-api/src/main/java/kr/co/pennyway/api/apis/chat/api/ChatRoomApi.java

@@ -9,25 +9,15 @@
 import io.swagger.v3.oas.annotations.tags.Tag;
 import kr.co.pennyway.api.apis.chat.dto.ChatRoomReq;
 import kr.co.pennyway.api.apis.chat.dto.ChatRoomRes;
-import kr.co.pennyway.api.common.annotation.ApiExceptionExplanation;
-import kr.co.pennyway.api.common.annotation.ApiResponseExplanations;
 import kr.co.pennyway.api.common.security.authentication.SecurityUserDetails;
-import kr.co.pennyway.domain.common.redis.chatroom.PendedChatRoomErrorCode;
 import org.springframework.http.ResponseEntity;
 import org.springframework.security.core.annotation.AuthenticationPrincipal;
 import org.springframework.web.bind.annotation.RequestBody;
 
 @Tag(name = "[채팅방 API]")
 public interface ChatRoomApi {
-    @Operation(summary = "[1] 채팅방 생성 대기 요청", method = "POST", description = "채팅방 배경 이미지를 제외한 모든 정보를 서버에 저장하기 위한 API. 성공 시, 채팅방 아이디를 반환하며, 5분 후에 저장된 자동 삭제된다.")
-    @ApiResponse(responseCode = "200", description = "채팅방 생성 대기 요청 성공", content = @Content(schemaProperties = @SchemaProperty(name = "chatRoomId", schema = @Schema(implementation = Long.class))))
-    ResponseEntity<?> postChatRoom(@RequestBody ChatRoomReq.Pend request, @AuthenticationPrincipal SecurityUserDetails user);
-
-    @Operation(summary = "[2] 채팅방 생성", method = "POST", description = "채팅방 배경 이미지를 전달하여 `[1] 채팅방 생성 대기 요청`의 요청을 확정짓는다. 저장된 채팅방 정보를 반환한다.")
+    @Operation(summary = "채팅방 생성", method = "POST", description = "채팅방 생성에 성공하면 생성된 채팅방의 상세 정보를 반환한다.")
     @ApiResponse(responseCode = "200", description = "채팅방 생성 성공", content = @Content(schemaProperties = @SchemaProperty(name = "chatRoom", schema = @Schema(implementation = ChatRoomRes.Detail.class))))
-    @ApiResponseExplanations(errors = {
-            @ApiExceptionExplanation(value = PendedChatRoomErrorCode.class, constant = "NOT_FOUND", name = "채팅방 정보 탐색 실패", description = "사용자가 생성한 채팅방 정보가 존재하지 않는 경우 발생하며, 이 경우 채팅방 생성 요청은 재시도 없이 실패 처리해야 한다.")
-    })
     ResponseEntity<?> createChatRoom(@RequestBody ChatRoomReq.Create request, @AuthenticationPrincipal SecurityUserDetails user);
 
     @Operation(summary = "가입한 채팅방 목록 조회", method = "GET", description = "사용자가 가입한 채팅방 목록을 조회하며, 정렬 순서는 보장하지 않는다. 최근 활성화된 채팅방의 순서를 지정할 방법에 대해 추가 개선이 필요한 API이므로, 추후 기능이 일부 수정될 수도 있다.")

pennyway-app-external-api/src/main/java/kr/co/pennyway/api/apis/chat/controller/ChatRoomController.java

@@ -10,29 +10,22 @@
 import org.springframework.http.ResponseEntity;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.security.core.annotation.AuthenticationPrincipal;
+import org.springframework.validation.annotation.Validated;
 import org.springframework.web.bind.annotation.*;
 
 @Slf4j
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("/v2/chat-rooms")
 public class ChatRoomController implements ChatRoomApi {
-    private static final String CHAT_ROOM_ID = "chatRoomId";
     private static final String CHAT_ROOM = "chatRoom";
     private static final String CHAT_ROOMS = "chatRooms";
     private final ChatRoomUseCase chatRoomUseCase;
 
-    @Override
-    @PostMapping("/pend")
-    @PreAuthorize("isAuthenticated()")
-    public ResponseEntity<?> postChatRoom(@RequestBody ChatRoomReq.Pend request, @AuthenticationPrincipal SecurityUserDetails user) {
-        return ResponseEntity.ok(SuccessResponse.from(CHAT_ROOM_ID, chatRoomUseCase.pendChatRoom(request, user.getUserId())));
-    }
-
     @Override
     @PostMapping("")
     @PreAuthorize("isAuthenticated()")
-    public ResponseEntity<?> createChatRoom(@RequestBody ChatRoomReq.Create request, @AuthenticationPrincipal SecurityUserDetails user) {
+    public ResponseEntity<?> createChatRoom(@Validated @RequestBody ChatRoomReq.Create request, @AuthenticationPrincipal SecurityUserDetails user) {
         return ResponseEntity.ok(SuccessResponse.from(CHAT_ROOM, chatRoomUseCase.createChatRoom(request, user.getUserId())));
     }
 

pennyway-app-external-api/src/main/java/kr/co/pennyway/api/apis/chat/dto/ChatRoomReq.java

@@ -4,11 +4,11 @@
 import jakarta.validation.constraints.NotBlank;
 import jakarta.validation.constraints.Pattern;
 import jakarta.validation.constraints.Size;
-import kr.co.pennyway.domain.common.redis.chatroom.PendedChatRoom;
+import kr.co.pennyway.domain.domains.chatroom.domain.ChatRoom;
 
 public final class ChatRoomReq {
-    @Schema(title = "채팅방 생성 요청 - 대기")
-    public record Pend(
+    @Schema(title = "채팅방 생성 요청 DTO")
+    public record Create(
             @NotBlank
             @Size(min = 1, max = 50)
             @Schema(description = "채팅방 제목. NULL 혹은 공백은 허용하지 않으며, 1~50자 이내의 문자열이어야 한다.", example = "페니웨이")
@@ -17,19 +17,20 @@ public record Pend(
             @Schema(description = "채팅방 설명. NULL을 허용하며, 문자가 존재할 시 공백 허용 없이 1~100자 이내의 문자열이어야 한다.", example = "페니웨이 채팅방입니다.")
             String description,
             @Schema(description = "채팅방 비밀번호. NULL을 허용한다. 비밀번호는 6자리 정수만 허용", example = "123456")
-            @Size(min = 6, max = 6)
-            Integer password
-    ) {
-        public PendedChatRoom toEntity(Long id, Long userId) {
-            return PendedChatRoom.of(id, userId, title, description, password);
-        }
-    }
-
-    @Schema(title = "채팅방 생성 요청 - 확정")
-    public record Create(
+            @Pattern(regexp = "^[0-9]{6}$", message = "채팅방 비밀번호는 6자리 정수여야 합니다.")
+            String password,
             @Schema(description = "채팅방 배경 이미지 URL. NULL을 허용한다.", example = "delete/chatroom/{chatroom_id}/{uuid}_{timestamp}.{ext}")
             @Pattern(regexp = "^delete/.*", message = "채팅방 배경 이미지 URL은 delete/로 시작해야 합니다.")
             String backgroundImageUrl
     ) {
+        public ChatRoom toEntity(long chatRoomId, String originImageUrl) {
+            return ChatRoom.builder()
+                    .id(chatRoomId)
+                    .title(title)
+                    .description(description)
+                    .password(password != null ? Integer.valueOf(password) : null)
+                    .backgroundImageUrl(originImageUrl)
+                    .build();
+        }
     }
 }

pennyway-app-external-api/src/main/java/kr/co/pennyway/api/apis/chat/service/ChatRoomSaveService.java

@@ -2,10 +2,6 @@
 
 import kr.co.pennyway.api.apis.chat.dto.ChatRoomReq;
 import kr.co.pennyway.api.common.storage.AwsS3Adapter;
-import kr.co.pennyway.domain.common.redis.chatroom.PendedChatRoom;
-import kr.co.pennyway.domain.common.redis.chatroom.PendedChatRoomErrorCode;
-import kr.co.pennyway.domain.common.redis.chatroom.PendedChatRoomErrorException;
-import kr.co.pennyway.domain.common.redis.chatroom.PendedChatRoomService;
 import kr.co.pennyway.domain.domains.chatroom.domain.ChatRoom;
 import kr.co.pennyway.domain.domains.chatroom.service.ChatRoomService;
 import kr.co.pennyway.domain.domains.member.domain.ChatMember;
@@ -15,7 +11,7 @@
 import kr.co.pennyway.domain.domains.user.exception.UserErrorCode;
 import kr.co.pennyway.domain.domains.user.exception.UserErrorException;
 import kr.co.pennyway.domain.domains.user.service.UserService;
-import kr.co.pennyway.infra.client.aws.s3.ObjectKeyType;
+import kr.co.pennyway.infra.client.aws.s3.ActualIdProvider;
 import kr.co.pennyway.infra.client.guid.IdGenerator;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
@@ -29,44 +25,19 @@ public class ChatRoomSaveService {
     private final UserService userService;
     private final ChatRoomService chatRoomService;
     private final ChatMemberService chatMemberService;
-    private final PendedChatRoomService pendedChatRoomService;
 
     private final AwsS3Adapter awsS3Adapter;
     private final IdGenerator<Long> idGenerator;
 
-    /**
-     * 채팅방 생성 정보를 캐싱한다.
-     * 해당 요청은 {@link #createChatRoom(ChatRoomReq.Create, Long)}를 통해 채팅방을 확정할 수 있다.
-     *
-     * @return 캐싱된 채팅방의 ID
-     */
-    @Transactional
-    public Long pendChatRoom(ChatRoomReq.Pend request, Long userId) {
-        Long chatRoomId = idGenerator.generate();
-        log.info("Chat room ID: {}", chatRoomId);
-        PendedChatRoom info = pendedChatRoomService.create(request.toEntity(chatRoomId, userId));
-        log.info("Pended chat room: {}", info);
-
-        return chatRoomId;
-    }
-
-    /**
-     * 캐싱된 채팅방을 확정하고 채팅방을 생성한다.
-     * 채팅방을 생성한 사용자는 채팅방의 관리자로 설정된다.
-     *
-     * @throws PendedChatRoomErrorException: {@link PendedChatRoomErrorCode#NOT_FOUND} - 캐싱된 채팅방이 존재하지 않을 경우
-     */
     @Transactional
     public ChatRoom createChatRoom(ChatRoomReq.Create request, Long userId) {
-        PendedChatRoom pendedChatRoom = pendedChatRoomService.readByUserId(userId)
-                .orElseThrow(() -> new PendedChatRoomErrorException(PendedChatRoomErrorCode.NOT_FOUND));
+        Long chatRoomId = idGenerator.generate();
 
         String originImageUrl = null;
         if (request.backgroundImageUrl() != null) {
-            originImageUrl = awsS3Adapter.saveImage(request.backgroundImageUrl(), ObjectKeyType.CHAT_PROFILE);
+            originImageUrl = awsS3Adapter.saveImage(request.backgroundImageUrl(), ActualIdProvider.createInstanceOfChatroomProfile(chatRoomId));
         }
-
-        ChatRoom chatRoom = chatRoomService.create(pendedChatRoom.toChatRoom(originImageUrl));
+        ChatRoom chatRoom = chatRoomService.create(request.toEntity(chatRoomId, originImageUrl));
 
         User user = userService.readUser(userId).orElseThrow(() -> new UserErrorException(UserErrorCode.NOT_FOUND));
         ChatMember member = ChatMember.of(user.getName(), user, chatRoom, ChatMemberRole.ADMIN);

pennyway-app-external-api/src/main/java/kr/co/pennyway/api/apis/chat/usecase/ChatRoomUseCase.java

@@ -18,10 +18,6 @@ public class ChatRoomUseCase {
     private final ChatRoomSaveService chatRoomSaveService;
     private final ChatRoomSearchService chatRoomSearchService;
 
-    public Long pendChatRoom(ChatRoomReq.Pend request, Long userId) {
-        return chatRoomSaveService.pendChatRoom(request, userId);
-    }
-
     public ChatRoomRes.Detail createChatRoom(ChatRoomReq.Create request, Long userId) {
         ChatRoom chatRoom = chatRoomSaveService.createChatRoom(request, userId);
 

pennyway-app-external-api/src/main/java/kr/co/pennyway/api/apis/storage/adapter/PresignedUrlGenerateAdapter.java

@@ -16,12 +16,7 @@ public class PresignedUrlGenerateAdapter {
     private final AwsS3Provider awsS3Provider;
 
     public URI execute(Long userId, PresignedUrlDto.Req request) {
-        PresignedUrlPropertyFactory factory = PresignedUrlPropertyFactory.create(request.ext(), request.type())
-                .userId(userId)
-                .chatroomId(request.chatroomId())
-                .chatId(request.chatId())
-                .feedId(request.feedId())
-                .build();
+        PresignedUrlPropertyFactory factory = PresignedUrlPropertyFactory.createInstance(request.ext(), request.type(), userId, request.chatroomId());
 
         return awsS3Provider.generatedPresignedUrl(factory);
     }

pennyway-app-external-api/src/main/java/kr/co/pennyway/api/apis/storage/api/StorageApi.java

@@ -36,8 +36,6 @@ public interface StorageApi {
                     @ExampleObject(value = "jpeg", name = "jpeg")
             }),
             @Parameter(name = "chatroomId", description = "채팅방 ID", in = ParameterIn.QUERY, example = "123456789"),
-            @Parameter(name = "chatId", description = "채팅 ID", in = ParameterIn.QUERY, example = "123456789"),
-            @Parameter(name = "feedId", description = "피드 ID", in = ParameterIn.QUERY, example = "123456789"),
             @Parameter(name = "request", hidden = true)
     })
     @ApiResponse(responseCode = "200", content = @Content(schema = @Schema(implementation = PresignedUrlDto.Res.class)))

pennyway-app-external-api/src/main/java/kr/co/pennyway/api/apis/storage/dto/PresignedUrlDto.java

@@ -15,9 +15,7 @@ public record Req(
             @NotBlank(message = "파일 확장자는 필수입니다.")
             @Pattern(regexp = "^(jpg|png|jpeg)$", message = "파일 확장자는 jpg, png, jpeg 중 하나여야 합니다.")
             String ext,
-            Long chatroomId,
-            Long chatId,
-            Long feedId
+            Long chatroomId
     ) {
     }
 

pennyway-app-external-api/src/main/java/kr/co/pennyway/api/apis/users/usecase/UserAccountUseCase.java

@@ -12,7 +12,7 @@
 import kr.co.pennyway.domain.domains.oauth.domain.Oauth;
 import kr.co.pennyway.domain.domains.user.domain.NotifySetting;
 import kr.co.pennyway.domain.domains.user.domain.User;
-import kr.co.pennyway.infra.client.aws.s3.ObjectKeyType;
+import kr.co.pennyway.infra.client.aws.s3.ActualIdProvider;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.transaction.annotation.Transactional;
@@ -69,7 +69,7 @@ public void updatePassword(Long userId, String oldPassword, String newPassword)
     }
 
     public String updateProfileImage(Long userId, UserProfileUpdateDto.ProfileImageReq request) {
-        String originImageUrl = awsS3Adapter.saveImage(request.profileImageUrl(), ObjectKeyType.PROFILE);
+        String originImageUrl = awsS3Adapter.saveImage(request.profileImageUrl(), ActualIdProvider.createInstanceOfProfile());
         String oldImageUrl = userProfileUpdateService.updateProfileImage(userId, originImageUrl);
 
         if (oldImageUrl != null) {

pennyway-app-external-api/src/main/java/kr/co/pennyway/api/common/storage/AwsS3Adapter.java

@@ -1,8 +1,8 @@
 package kr.co.pennyway.api.common.storage;
 
 import kr.co.pennyway.common.annotation.Adapter;
+import kr.co.pennyway.infra.client.aws.s3.ActualIdProvider;
 import kr.co.pennyway.infra.client.aws.s3.AwsS3Provider;
-import kr.co.pennyway.infra.client.aws.s3.ObjectKeyType;
 import kr.co.pennyway.infra.common.exception.StorageErrorCode;
 import kr.co.pennyway.infra.common.exception.StorageException;
 import lombok.RequiredArgsConstructor;
@@ -17,12 +17,12 @@ public class AwsS3Adapter {
     /**
      * 임시 저장 경로에서 원본 저장 경로로 사진을 복사하고, 원본이 저장된 키를 반환합니다.
      *
-     * @param deleteImageUrl 임시 저장 이미지 URL
-     * @param type           프로필 이미지 타입 {@link ObjectKeyType}
+     * @param deleteImageUrl String : 임시 저장 이미지 URL
+     * @param type           {@link ActualIdProvider} : 실제 ID를 제공하는 클래스
      * @return 프로필 이미지 원본이 저장된 key
      * @throws StorageException 프로필 이미지 URL이 유효하지 않을 때
      */
-    public String saveImage(String deleteImageUrl, ObjectKeyType type) {
+    public String saveImage(String deleteImageUrl, ActualIdProvider type) {
         if (!awsS3Provider.isObjectExist(deleteImageUrl)) {
             log.info("프로필 이미지 URL이 유효하지 않습니다.");
             throw new StorageException(StorageErrorCode.NOT_FOUND);