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

🔀 :: (PiCK-335) refactor application dto #347

Merged
merged 9 commits into from
Aug 29, 2024

Conversation

rudeh2926
Copy link
Member

@rudeh2926 rudeh2926 commented Aug 29, 2024

close #335
스크린샷 2024-08-29 오후 7 04 18
스크린샷 2024-08-29 오후 7 10 52

Summary by CodeRabbit

  • New Features

    • 요청 데이터의 형식을 검증하는 새로운 유효성 검사 기능 추가.
    • ApplicationRequestCreateEarlyReturnRequest 클래스에 대한 형식 검증 규칙 도입.
  • Bug Fixes

    • 잘못된 데이터가 처리되는 것을 방지하여 API의 안정성 향상.
  • Documentation

    • 유효성 검사 주석 및 관련 로직에 대한 설명 추가.

@rudeh2926 rudeh2926 self-assigned this Aug 29, 2024
@rudeh2926 rudeh2926 requested a review from meltapplee as a code owner August 29, 2024 10:11
@rudeh2926 rudeh2926 added the 기능 개발 API 개발 label Aug 29, 2024
Copy link

coderabbitai bot commented Aug 29, 2024

Walkthrough

변경 사항은 ApplicationControllerEarlyReturnController 클래스의 요청 처리 메서드에 대한 유효성 검사 메커니즘을 추가하는 것입니다. @Valid@ValidFormat 어노테이션이 각각의 요청 DTO에 적용되어, 입력 데이터가 정의된 제약 조건을 충족하는지 검증합니다. 이로 인해 API의 데이터 처리 신뢰성이 향상됩니다.

Changes

파일 경로 변경 요약
.../ApplicationController.kt application 메서드에 @Valid 어노테이션 추가.
.../dto/request/ApplicationRequest.kt ApplicationRequest 데이터 클래스에 @ValidFormat 어노테이션 추가.
.../EarlyReturnController.kt createEarlyReturn 메서드에 @Valid 어노테이션 추가.
.../dto/request/CreateEarlyReturnRequest.kt CreateEarlyReturnRequest 데이터 클래스에 @ValidFormat 어노테이션 추가.
.../annotation/ValidFormat.kt @ValidFormat 커스텀 유효성 검사 어노테이션 정의.
.../annotation/common/FormatValidator.kt FormatValidator 클래스 추가, 요청 형식 검증 로직 구현.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant ApplicationController
    participant EarlyReturnController
    participant FormatValidator

    Client->>ApplicationController: applicationRequest
    ApplicationController->>FormatValidator: validate(applicationRequest)
    FormatValidator-->>ApplicationController: validationResult
    ApplicationController-->>Client: response

    Client->>EarlyReturnController: createEarlyReturnRequest
    EarlyReturnController->>FormatValidator: validate(createEarlyReturnRequest)
    FormatValidator-->>EarlyReturnController: validationResult
    EarlyReturnController-->>Client: response
Loading

Assessment against linked issues

Objective Addressed Explanation
외출 dto 어노테이션 만들기 ( #335 )
조기귀가 dto 어노테이션 만들기 ( #335 )

Poem

🐰
변화의 바람이 불어와
유효성 검사로 안전해져
외출과 귀가, 모두 준비 완료!
데이터의 신뢰, 이제는 확실해!
행복한 토끼가 춤을 춰요! 🌟


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

Copy link

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7efcd1d and 6c22983.

Files selected for processing (6)
  • src/main/kotlin/dsm/pick2024/domain/application/presentation/ApplicationController.kt (2 hunks)
  • src/main/kotlin/dsm/pick2024/domain/application/presentation/dto/request/ApplicationRequest.kt (1 hunks)
  • src/main/kotlin/dsm/pick2024/domain/earlyreturn/presentation/EarlyReturnController.kt (2 hunks)
  • src/main/kotlin/dsm/pick2024/domain/earlyreturn/presentation/dto/request/CreateEarlyReturnRequest.kt (1 hunks)
  • src/main/kotlin/dsm/pick2024/global/annotation/ValidFormat.kt (1 hunks)
  • src/main/kotlin/dsm/pick2024/global/annotation/common/FormatValidator.kt (1 hunks)
Additional comments not posted (14)
src/main/kotlin/dsm/pick2024/domain/earlyreturn/presentation/dto/request/CreateEarlyReturnRequest.kt (2)

3-3: 적절한 import 추가

ValidFormat 어노테이션을 사용하기 위해 필요한 import가 올바르게 추가되었습니다.


5-5: 유효성 검사 어노테이션 적용

@ValidFormat 어노테이션이 CreateEarlyReturnRequest 데이터 클래스에 올바르게 적용되었습니다. 이는 데이터 클래스의 유효성 검사 기능을 향상시킵니다.

src/main/kotlin/dsm/pick2024/domain/application/presentation/dto/request/ApplicationRequest.kt (2)

4-4: 적절한 import 추가

ValidFormat 어노테이션을 사용하기 위해 필요한 import가 올바르게 추가되었습니다.


6-6: 유효성 검사 어노테이션 적용

@ValidFormat 어노테이션이 ApplicationRequest 데이터 클래스에 올바르게 적용되었습니다. 이는 데이터 클래스의 유효성 검사 기능을 향상시킵니다.

src/main/kotlin/dsm/pick2024/global/annotation/ValidFormat.kt (3)

1-1: 적절한 패키지 선언

패키지 선언이 올바르게 추가되었습니다.


3-6: 적절한 import 추가

FormatValidator, Constraint, 및 Payload를 사용하기 위해 필요한 import가 올바르게 추가되었습니다.


8-15: 유효성 검사 어노테이션 정의

@ValidFormat 어노테이션이 Constraint, Target, 및 Retention 어노테이션과 함께 올바르게 정의되었습니다. 이 어노테이션은 데이터 클래스의 유효성 검사 기능을 향상시킵니다.

src/main/kotlin/dsm/pick2024/global/annotation/common/FormatValidator.kt (5)

14-20: 유효성 검사 메서드가 올바르게 구현되었습니다.

유효성 검사 메서드가 요청 유형에 따라 적절한 유효성 검사 메서드로 위임하고 있습니다.


22-28: ApplicationRequest 유효성 검사 메서드가 올바르게 구현되었습니다.

ApplicationRequestapplicationType에 따라 적절한 유효성 검사를 수행하고 있습니다.


30-32: CreateEarlyReturnRequest 유효성 검사 메서드가 올바르게 구현되었습니다.

CreateEarlyReturnRequest의 시간 형식을 올바르게 검사하고 있습니다.


34-36: 기간 형식 유효성 검사 메서드가 올바르게 구현되었습니다.

정규 표현식을 사용하여 기간 형식을 올바르게 검사하고 있습니다.


38-44: 시간 형식 유효성 검사 메서드가 올바르게 구현되었습니다.

시간 형식을 올바르게 검사하고 예외를 처리하고 있습니다.

src/main/kotlin/dsm/pick2024/domain/earlyreturn/presentation/EarlyReturnController.kt (1)

41-42: 유효성 검사 어노테이션이 올바르게 추가되었습니다.

@Valid 어노테이션이 createEarlyReturnRequest 파라미터에 추가되어 요청 객체가 처리되기 전에 유효성 검사가 수행됩니다.

src/main/kotlin/dsm/pick2024/domain/application/presentation/ApplicationController.kt (1)

45-46: 유효성 검사 어노테이션이 올바르게 추가되었습니다.

@Valid 어노테이션이 applicationRequest 파라미터에 추가되어 요청 객체가 처리되기 전에 유효성 검사가 수행됩니다.

@rudeh2926 rudeh2926 merged commit e12252a into develop Aug 29, 2024
1 check passed
@rudeh2926 rudeh2926 deleted the 335-refactor-application-dto branch August 29, 2024 10:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
기능 개발 API 개발
Projects
None yet
Development

Successfully merging this pull request may close these issues.

외출신청, 조기귀가 DTO 어노테이션 만들기
2 participants