Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

톡픽 생성과 수정 요청 DTO 분리 #709

Merged
merged 2 commits into from
Nov 14, 2024

Conversation

Hanjaemo
Copy link
Member

@Hanjaemo Hanjaemo commented Nov 12, 2024

💡 작업 내용

  • CreateOrUpdateTalkPickRequest를 생성 요청 DTO와 수정 요청 DTO로 분리

💡 자세한 설명

아래와 같이 톡픽 생성 요청과 수정 요청 DTO를 하나로 통일하면, 수정 요청할 때도 조회수와 북마크 수가 0으로 초기화되는 문제가 발생합니다.

public class TalkPickDto {

    ...

    public static class CreateOrUpdateTalkPickRequest {

        private BaseTalkPickFields baseFields;

        @Schema(description = "첨부한 이미지 파일 ID 목록", example = "[12, 41]")
        private List<Long> fileIds;

        public TalkPick toEntity(Member member) {
            return TalkPick.builder()
                    .member(member)
                    .title(baseFields.getTitle())
                    .content(baseFields.getContent())
                    .optionA(baseFields.getOptionA())
                    .optionB(baseFields.getOptionB())
                    .sourceUrl(baseFields.getSourceUrl())
                    .views(0L)
                    .bookmarks(0L)
                    .viewStatus(NORMAL)
                    .editedAt(LocalDateTime.now())
                    .build();
        }
        ...

따라서 CreateOrUpdateTalkPickRequest를 생성 요청 DTO와 수정 요청 DTO로 분리하였습니다.

✅ 셀프 체크리스트

  • PR 제목을 형식에 맞게 작성했나요?
  • 브랜치 전략에 맞는 브랜치에 PR을 올리고 있나요?
  • 이슈는 close 했나요?
  • Reviewers, Labels, Projects를 등록했나요?
  • 작업 도중 문서 수정이 필요한 경우 잘 수정했나요?
  • 테스트는 잘 통과했나요?
  • 불필요한 코드는 제거했나요?

closes #704

Summary by CodeRabbit

  • 새로운 기능

    • Talk Pick 생성 및 업데이트를 위한 요청 처리 방식 개선.
    • 생성 및 업데이트 요청에 대해 각각 별도의 DTO 클래스 도입.
  • 버그 수정

    • 요청 처리 로직을 명확히 하여 파일 ID 확인 및 파일 이동 로직 통합.
  • 문서화

    • DTO 클래스의 목적 및 스키마 설명 업데이트로 명확성 향상.

@Hanjaemo Hanjaemo added 🪄 refactor 리팩토링 D-2 여유롭지 않으면서 일반적인 작업 labels Nov 12, 2024
@Hanjaemo Hanjaemo self-assigned this Nov 12, 2024
@Hanjaemo Hanjaemo linked an issue Nov 12, 2024 that may be closed by this pull request
Copy link
Contributor

coderabbitai bot commented Nov 12, 2024

Walkthrough

TalkPickService, TalkPickDto, 및 TalkPickController 클래스에서의 변경 사항은 톡픽 생성 및 수정 요청을 처리하는 방식의 개선을 중심으로 이루어졌습니다. CreateOrUpdateTalkPickRequest 타입이 CreateTalkPickRequestUpdateTalkPickRequest로 분리되어 요청의 의도를 명확히 하였으며, 각 메서드는 새로운 요청 타입을 수용하도록 업데이트되었습니다. 파일 ID 처리 로직도 통합되어 간소화되었습니다.

Changes

파일 경로 변경 요약
src/main/java/balancetalk/talkpick/application/TalkPickService.java CreateOrUpdateTalkPickRequestCreateTalkPickRequestUpdateTalkPickRequest로 분리; createTalkPickupdateTalkPick 메서드의 시그니처 업데이트; 파일 ID 처리 로직 통합.
src/main/java/balancetalk/talkpick/dto/TalkPickDto.java CreateOrUpdateTalkPickRequestCreateTalkPickRequest로 이름 변경 및 UpdateTalkPickRequest 추가; 각 요청 클래스의 toEntity 메서드 수정.
src/main/java/balancetalk/talkpick/presentation/TalkPickController.java createTalkPickupdateTalkPick 메서드의 요청 파라미터 타입을 각각 CreateTalkPickRequestUpdateTalkPickRequest로 변경.

Assessment against linked issues

Objective Addressed Explanation
톡픽 생성 요청 DTO와 수정 요청 DTO를 분리합니다. (#704)

Possibly related PRs

Suggested labels

✨ feature, D-0

Suggested reviewers

  • jschoi-96
  • gywns0417

🐰 새로운 요청 DTO로
톡픽의 길을 열고
생성과 수정을 분리해
더 명확하게 나아가요!
파일도 함께 옮겨
깔끔하게 정리해요! 🥕


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@Hanjaemo Hanjaemo changed the title 생성과 수정 요청 DTO 분리 톡픽 생성과 수정 요청 DTO 분리 Nov 12, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
src/main/java/balancetalk/talkpick/presentation/TalkPickController.java (1)

Line range hint 1-82: 아키텍처 관점에서 몇 가지 제안사항이 있습니다.

현재 구조는 잘 설계되어 있지만, 다음과 같은 개선사항을 고려해보시면 좋을 것 같습니다:

  1. 응답 DTO들도 요청 DTO처럼 별도의 패키지로 분리하는 것을 고려해보세요
  2. API 버저닝을 위한 준비를 해두면 좋을 것 같습니다
  3. 페이징 관련 파라미터를 상수로 분리하는 것을 고려해보세요
src/main/java/balancetalk/talkpick/dto/TalkPickDto.java (1)

66-76: Builder 패턴의 Null 안전성 개선이 필요합니다.

현재 구현에서는 필수 필드들에 대한 null 체크가 없습니다. 다음과 같은 개선을 제안드립니다:

 public TalkPick toEntity(Member member) {
+    if (member == null || baseFields == null) {
+        throw new IllegalArgumentException("필수 필드가 null일 수 없습니다.");
+    }
     return TalkPick.builder()
             .member(member)
             .title(baseFields.getTitle())
             .content(baseFields.getContent())
             .optionA(baseFields.getOptionA())
             .optionB(baseFields.getOptionB())
             .sourceUrl(baseFields.getSourceUrl())
             .editedAt(LocalDateTime.now())
             .build();
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 32343d2 and d07e2cb.

📒 Files selected for processing (3)
  • src/main/java/balancetalk/talkpick/application/TalkPickService.java (3 hunks)
  • src/main/java/balancetalk/talkpick/dto/TalkPickDto.java (2 hunks)
  • src/main/java/balancetalk/talkpick/presentation/TalkPickController.java (4 hunks)
🔇 Additional comments (8)
src/main/java/balancetalk/talkpick/presentation/TalkPickController.java (2)

3-6: DTO 클래스들의 정적 임포트가 잘 정리되었습니다!

각각의 DTO를 명시적으로 임포트함으로써 코드의 가독성이 향상되었습니다.


41-43: DTO 분리가 성공적으로 구현되었습니다.

생성과 수정 요청을 위한 DTO를 분리함으로써:

  • 각 작업의 의도가 명확해졌습니다
  • 수정 시 조회수와 북마크 수가 초기화되는 문제가 해결되었습니다

다음 스크립트로 DTO 사용을 검증하겠습니다:

Also applies to: 64-66

✅ Verification successful

DTO 분리 검증이 성공적으로 완료되었습니다.

  • 코드베이스 전체에서 CreateOrUpdateTalkPickRequest의 사용이 더 이상 존재하지 않습니다.
  • 서비스 레이어에서 CreateTalkPickRequestUpdateTalkPickRequest가 올바르게 사용되고 있음을 확인했습니다.
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that CreateTalkPickRequest and UpdateTalkPickRequest are used correctly throughout the codebase

# Check for any remaining usage of CreateOrUpdateTalkPickRequest
rg "CreateOrUpdateTalkPickRequest"

# Verify the separation of DTOs in service layer
rg -A 5 "class TalkPickService"

Length of output: 1239

src/main/java/balancetalk/talkpick/application/TalkPickService.java (4)

5-5: import 문이 DTO 분리 목적에 맞게 잘 수정되었습니다.

CreateTalkPickRequest와 UpdateTalkPickRequest를 개별적으로 import하여 각각의 책임을 명확히 분리했습니다.

Also applies to: 8-8


49-51: 파일 처리 로직이 잘 개선되었습니다.

파일 재배치 로직을 단일 메서드로 통합하여 코드 중복을 제거하고 재사용성을 향상시켰습니다.


87-93: 수정 로직이 개선되었으나 toEntity 구현 확인이 필요합니다.

UpdateTalkPickRequest를 사용하여 수정 시 view count와 bookmark count가 초기화되는 문제를 해결했습니다. 다만, 이 필드들이 보존되는지 확인이 필요합니다.


39-45: 생성 로직이 개선되었으나 toEntity 구현 확인이 필요합니다.

파일 처리 로직이 명확해졌고 CreateTalkPickRequest를 사용하여 책임이 분리되었습니다. 다만, view count와 bookmark count가 0으로 초기화되는지 확인이 필요합니다.

src/main/java/balancetalk/talkpick/dto/TalkPickDto.java (2)

Line range hint 26-55: 생성 요청 DTO의 분리가 잘 이루어졌습니다!

단일 책임 원칙에 맞게 생성 요청만을 담당하도록 분리되었으며, views와 bookmarks를 0으로 초기화하는 것이 적절합니다.


56-81: 수정 요청 DTO의 분리가 잘 이루어졌습니다!

기존의 문제였던 조회수와 북마크 수가 초기화되는 이슈가 해결되었습니다.

@Hanjaemo Hanjaemo added D-1 and removed D-2 여유롭지 않으면서 일반적인 작업 labels Nov 13, 2024
}
private void relocateFiles(List<Long> fileIds, Long talkPickId) {
List<File> files = fileRepository.findAllById(fileIds);
fileHandler.relocateFiles(files, talkPickId, TALK_PICK);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

분리 👍 🥇

@Hanjaemo Hanjaemo added D-0 긴급 이슈에 대한 작업 and removed D-1 labels Nov 14, 2024
@Hanjaemo Hanjaemo merged commit 643331f into main Nov 14, 2024
3 checks passed
@Hanjaemo Hanjaemo deleted the refactor/704-separate-talk-pick-dto branch November 24, 2024 17:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
D-0 긴급 이슈에 대한 작업 🪄 refactor 리팩토링
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

톡픽 생성 요청 DTO와 수정 요청 DTO를 분리합니다.
3 participants