Api: 🐛 Modify the business logic of chat room creation

[psychology50]

작업 이유

• 채팅방 생성 시, 채팅방 이미지 선택을 위한 Pending 절차를 제거하고, 비지니스 로직 플로우를 단순화하기 위한 수정
• 요약
  • 문제 원인: presigend url을 발급받을 때 필요한 chatroom_id는 채팅방 생성 전까지 비결정적인 요소
  • As-is: 채팅방 임시 생성 후 발급되는 chatroom_id를 통해 이미지를 저장하고, S3 저장 이후 채팅방 생성 확정 요청을 보내는 2단계로 구성
  • To-be: 임시 저장을 위한 chatroom_id는 UUID 임시 키로 생성하고, 실제 채팅방 생성 시 origin으로 복원하는 과정에서 실제 채팅방 아이디를 삽입하도록 재구성

작업 사항

1️⃣ Presigned Url 발급 로직 수정

@Tag(name = "[S3 이미지 저장을 위한 Presigned URL 발급 API]")
public interface StorageApi {
    @Operation(summary = "S3 이미지 저장을 위한 Presigned URL 발급", description = "S3에 이미지를 저장하기 위한 Presigned URL을 발급합니다.")
    @Parameters({
            @Parameter(name = "type", description = "이미지 종류", required = true, in = ParameterIn.QUERY, examples = {
                    @ExampleObject(value = "PROFILE", name = "사용자 프로필"),
                    @ExampleObject(value = "FEED", name = "피드"),
                    @ExampleObject(value = "CHATROOM_PROFILE", name = "채팅방 프로필"),
                    @ExampleObject(value = "CHAT", name = "채팅"),
                    @ExampleObject(value = "CHAT_PROFILE", name = "채팅 프로필")
            }),
            @Parameter(name = "ext", description = "파일 확장자", required = true, in = ParameterIn.QUERY, examples = {
                    @ExampleObject(value = "jpg", name = "jpg"),
                    @ExampleObject(value = "png", name = "png"),
                    @ExampleObject(value = "jpeg", name = "jpeg")
            }),
            @Parameter(name = "chatroomId", description = "채팅방 ID", in = ParameterIn.QUERY, example = "123456789"),
            @Parameter(name = "request", hidden = true)
    })
    @ApiResponse(responseCode = "200", content = @Content(schema = @Schema(implementation = PresignedUrlDto.Res.class)))
    @ApiResponseExplanations(errors = {
            @ApiExceptionExplanation(value = StorageErrorCode.class, constant = "NOT_FOUND", name = "요청한 리소스를 찾을 수 없음")
    })
    ResponseEntity<?> getPresignedUrl(@Validated PresignedUrlDto.Req req, BindingResult bindingResult, @AuthenticationPrincipal SecurityUserDetails user);
}

• Ignore: 🐛🔧 Modification and refactoring of the presigned URL creation and conversion logic #179 에서 추가했던 feed_id와 chat_id 쿼리 삭제
  • 사용자 프로필: url 생성을 위한 user_id는 값이 이미 정해져 있으므로, 사용자 아이디를 사용
  • 피드: url 생성을 위한 feed_id는 비결정적 요소이므로, UUID로 임시 키 발급
  • 채팅방: url 생성을 위한 chatroom_id는 비결정적 요소이므로, UUID로 임시 키 발급
  • 채팅방 프로필: url 생성을 위한 user_id, chatroom_id 모두 정해져 있으므로, 클라이언트에게 받아야 함.
  • 채팅 프로필: url 생성을 위한 chatroom_id는 클라이언트에게 받고, chat_id는 UUID로 임시 키 발급

public class PresignedUrlPropertyFactory {
    private final PresignedUrlProperty property;

    private PresignedUrlPropertyFactory(Long userId, String ext, ObjectKeyType type, Long chatRoomId) {
        this.property = switch (type) {
            case PROFILE -> new ProfileUrlProperty(userId, ext);
            case CHATROOM_PROFILE -> new ChatRoomProfileUrlProperty(ext);
            case CHAT_PROFILE -> new ChatProfileUrlProperty(userId, chatRoomId, ext);
            case CHAT -> new ChatUrlProperty(chatRoomId, ext);
            case FEED -> new FeedUrlProperty(ext);
        };
    }

    public static PresignedUrlPropertyFactory createInstance(String ext, ObjectKeyType type, Long userId, Long chatRoomId) {
        return new PresignedUrlPropertyFactory(userId, ext, type, chatRoomId);
    }

    public PresignedUrlProperty getProperty() {
        return property;
    }
}

public abstract class BaseUrlProperty implements PresignedUrlProperty {
    private static final Set<String> extensionSet = Set.of("jpg", "png", "jpeg");

    protected final String imageId;
    protected final String timestamp;
    protected final String ext;
    protected final ObjectKeyType type;

    protected BaseUrlProperty(String ext, ObjectKeyType type) {
        if (!extensionSet.contains(ext)) {
            throw new IllegalArgumentException("지원하지 않는 확장자입니다.");
        }

        this.imageId = UUIDUtil.generateUUID();
        this.timestamp = String.valueOf(System.currentTimeMillis());
        this.ext = ext;
        this.type = type;
    }

    ...
}

public class ChatRoomProfileUrlProperty extends BaseUrlProperty {
    private final String chatroomId;

    public ChatRoomProfileUrlProperty(String ext) {
        super(ext, ObjectKeyType.CHATROOM_PROFILE);
        this.chatroomId = UUIDUtil.generateUUID();
    }

    @Override
    public Map<String, String> variables() {
        ...
    }
}

• 기존의 인터페이스로만 정의했던 Property 정보를 추상 클래스를 사용하여, 중복 요소에 대한 유효성 처리를 한 곳으로 통합.
• Factory의 과도한 Builder 패턴을 제거하여, 보다 코드를 명시적으로 이해할 수 있도록 수정함.

2️⃣ 채팅방 생성 컨트롤러 수정

• Pend, Create 두 개의 컨트롤러로 구성되어 있던 작업을 하나로 통합하여 처리.
• deleteUrl을 originUrl로 치환하기 위해서, Service 로직에서 TSID 기반 ID를 생성 후 S3Adapter로 전달. -> 변경되어야 할 요소가 무엇인지 알려주어야 함.
  • 그러나, 이 과정에서 개발자가 S3 정책 세부 사항에 과하게 많이 알아야 한다는 문제가 존재하여, 다음과 같이 추상화했습니다.

/**
 * 임시 저장 URL에서 임의로 설정된 ID를 실제 ID로 변경하기 위한 정보를 제공하는 클래스
 */
public final class ActualIdProvider {
    private final ObjectKeyType type;
    private final Map<String, String> actualIds;

    private ActualIdProvider(ObjectKeyType type, Map<String, String> actualIds) {
        this.type = type;
        this.actualIds = actualIds;
    }

    ...

    /**
     * 채팅방 프로필 이미지 URL을 생성하기 위한 ActualIdProvider 인스턴스를 생성합니다.
     *
     * @param chatroomId 실제 채팅방 ID
     */
    public static ActualIdProvider createInstanceOfChatroomProfile(Long chatroomId) {
        Map<String, String> ids = new HashMap<>();
        ids.put("chatroom_id", chatroomId.toString());
        return new ActualIdProvider(ObjectKeyType.CHATROOM_PROFILE, ids);
    }

    ...
}

@Slf4j
@Adapter
@RequiredArgsConstructor
public class AwsS3Adapter {
    private final AwsS3Provider awsS3Provider;

    /**
     * 임시 저장 경로에서 원본 저장 경로로 사진을 복사하고, 원본이 저장된 키를 반환합니다.
     *
     * @param deleteImageUrl String : 임시 저장 이미지 URL
     * @param type           {@link ActualIdProvider} : 실제 ID를 제공하는 클래스
     * @return 프로필 이미지 원본이 저장된 key
     * @throws StorageException 프로필 이미지 URL이 유효하지 않을 때
     */
    public String saveImage(String deleteImageUrl, ActualIdProvider type) {
        if (!awsS3Provider.isObjectExist(deleteImageUrl)) {
            log.info("프로필 이미지 URL이 유효하지 않습니다.");
            throw new StorageException(StorageErrorCode.NOT_FOUND);
        }

        return awsS3Provider.copyObject(type, deleteImageUrl);
    }

    ...
}

• deleteUrl을 originUrl로 변경하기 위해 필요한 정보를 요구하는 ActualIdProvider를 사용하여, 클라이언트가 문자열 의존적인 키와 S3 정책 세부사항에 대한 관심을 줄일 수 있게 수정.

리뷰어가 중점적으로 확인해야 하는 부분

# Request
{
  "title": "페니웨이",
  "description": "페니웨이 채팅방입니다.",
  "password": "123456",
  "backgroundImageUrl": "delete/chatroom/49791a78-7b2b-4d2f-8f41-cb48febfc3bc/eb51ff2e-2b79-4683-b503-262346f88c8a_1729338581781.png"
}

# Response
{
  "code": "2000",
  "data": {
    "chatRoom": {
      "id": 635445399499637100,
      "title": "페니웨이",
      "description": "페니웨이 채팅방입니다.",
      "backgroundImageUrl": "chatroom/635445399499637070/origin/eb51ff2e-2b79-4683-b503-262346f88c8a_1729338581781.png",
      "isPrivate": true,
      "participantCount": 1,
      "createdAt": "2024-10-19 20:53:09"
    }
  }
}

변경된 채팅방 생성 플로우는 다음과 같습니다.

1. 클라이언트가 채팅방 사진을 선택
2. GET /v1/storage/presigend-url 요청으로, 임시 저장 경로 수신
3. PUT {S3 presigned url} 요청으로 사진 저장.
4. 채팅방 정보를 POST /v2/chat-rooms로 전달. (url은 /delete/~.{ext} 범위로 파싱하여 전달)
5. 서버에서 채팅방 ID를 생성 후, 임시 저장된 사진을 원본 저장소로 copy한 후 채팅방 정보 생성
6. 서버에서 클라이언트에게 생성된 채팅방 정보 반환

발견한 이슈

• presigned url 생성 시, 특정 채팅방의 ID로 URL을 생성하므로, 해당 채팅방에 대한 자원 접근 검사가 누락되어 있음.
• 이는 사용자가 임의의 ID를 주입해도 성공함을 의미하므로, 보안 위협이 됨.