feat: 과제 휴강 처리 API 추가 #542
Conversation
Walkthrough이번 변경 사항은 스터디 과제 취소 API의 구현으로, 스터디 멘토 관리 기능을 크게 향상시킵니다. 새로운 Changes
Assessment against linked issues
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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 as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
Job Summary for GradleCheck Style and Test to Develop :: build-test
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (10)
- src/main/java/com/gdschongik/gdsc/domain/study/api/StudyMentorController.java (2 hunks)
- src/main/java/com/gdschongik/gdsc/domain/study/application/StudyMentorService.java (1 hunks)
- src/main/java/com/gdschongik/gdsc/domain/study/domain/StudyDetail.java (1 hunks)
- src/main/java/com/gdschongik/gdsc/domain/study/domain/vo/Assignment.java (2 hunks)
- src/main/java/com/gdschongik/gdsc/global/exception/ErrorCode.java (1 hunks)
- src/test/java/com/gdschongik/gdsc/domain/study/application/StudyMentorServiceTest.java (1 hunks)
- src/test/java/com/gdschongik/gdsc/domain/study/domain/StudyDetailTest.java (1 hunks)
- src/test/java/com/gdschongik/gdsc/global/common/constant/StudyConstant.java (1 hunks)
- src/test/java/com/gdschongik/gdsc/helper/FixtureHelper.java (2 hunks)
- src/test/java/com/gdschongik/gdsc/helper/IntegrationTest.java (4 hunks)
Additional comments not posted (17)
src/test/java/com/gdschongik/gdsc/global/common/constant/StudyConstant.java (1)
18-18: LGTM! 새로운 상수 추가
ATTENDANCE_NUMBER상수 추가는 문제 없습니다.src/main/java/com/gdschongik/gdsc/domain/study/application/StudyMentorService.java (1)
1-31: LGTM! 예외 처리 및 로깅 확인
cancelStudyAssignment메서드는 예외 처리가 잘 되어 있으며, 로깅도 적절하게 구현되었습니다.그러나 예외 처리가 제대로 동작하는지 확인하는 것이 좋습니다.
Verification successful
예외 처리가 적절하게 구현되었습니다.
cancelStudyAssignment메서드에서orElseThrow를 사용하여CustomException을 던지는 부분이 확인되었습니다. 예외 처리가 잘 되어 있으며, 로깅도 적절하게 구현되었습니다.
StudyMentorService.java파일의cancelStudyAssignment메서드에서orElseThrow를 통해CustomException을 던짐Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify exception handling in `cancelStudyAssignment` method. # Test: Search for the exception handling. Expect: Proper handling of `CustomException`. rg --type java 'throw new CustomException' -A 5Length of output: 42037
Script:
#!/bin/bash # Description: Verify exception handling in `cancelStudyAssignment` method specifically within StudyMentorService.java. # Test: Search for the exception handling. Expect: Proper handling of `CustomException`. rg --type java 'throw new CustomException' -A 5 src/main/java/com/gdschongik/gdsc/domain/study/application/StudyMentorService.javaLength of output: 132
Script:
#!/bin/bash # Description: Verify exception handling in `cancelStudyAssignment` method specifically within StudyMentorService.java. # Test: Search for the usage of `orElseThrow` to confirm exception handling. rg --type java 'orElseThrow' -A 5 src/main/java/com/gdschongik/gdsc/domain/study/application/StudyMentorService.javaLength of output: 333
src/test/java/com/gdschongik/gdsc/domain/study/domain/StudyDetailTest.java (1)
1-38: LGTM! 테스트 구현 확인
과제_상태가_휴강이_된다테스트 메서드는 과제 상태가CANCELLED로 설정되는 것을 확인합니다. 테스트 구현이 잘 되어 있습니다.src/main/java/com/gdschongik/gdsc/domain/study/api/StudyMentorController.java (3)
3-3: 필요한 import 문 추가
StudyMentorService를 사용하기 위해 필요한 import 문이 추가되었습니다.
18-18: 필요한 서비스 필드 추가
StudyMentorService필드가 추가되었습니다. 이는 서비스 로직을 사용하기 위해 필요합니다.
27-32: 스터디 과제 휴강 처리 엔드포인트 추가스터디 과제를 휴강 처리하는 새로운 PATCH 엔드포인트가 추가되었습니다. 서비스 메서드를 호출하고
204 No Content응답을 반환합니다.서비스 메서드 호출이 올바르게 이루어졌는지 확인하십시오.
Verification successful
스터디 과제 휴강 처리 엔드포인트 추가
스터디 과제를 휴강 처리하는 새로운 PATCH 엔드포인트가 추가되었습니다. 서비스 메서드를 호출하고
204 No Content응답을 반환합니다.
StudyMentorService클래스의cancelStudyAssignment메서드가 올바르게 구현되었습니다.StudyDetail클래스의cancelAssignment메서드가 올바르게 구현되었습니다.Assignment클래스의cancelAssignment메서드가 올바르게 구현되었습니다.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the usage of the service method `cancelStudyAssignment`. # Test: Search for the method implementation. Expect: Proper implementation of `cancelStudyAssignment`. rg --type java -A 5 $'public void cancelStudyAssignment'Length of output: 832
Script:
#!/bin/bash # Description: Verify the implementation of the `cancelAssignment` method in the `StudyDetail` class. # Test: Search for the method implementation. Expect: Proper implementation of `cancelAssignment`. rg --type java -A 5 $'public void cancelAssignment'Length of output: 433
Script:
#!/bin/bash # Description: Verify the implementation of the `cancelAssignment` method in the `Assignment` class. # Test: Search for the method implementation. Expect: Proper implementation of `cancelAssignment`. rg --type java -A 5 $'public static Assignment cancelAssignment'Length of output: 478
src/test/java/com/gdschongik/gdsc/domain/study/application/StudyMentorServiceTest.java (3)
14-14: 통합 테스트 클래스 설정
IntegrationTest를 확장하고 필요한 의존성을 자동 주입하여 통합 테스트 클래스를 올바르게 설정했습니다.
22-22: 중첩 클래스 설정관련 테스트 케이스를 조직하기 위해 중첩 클래스를 올바르게 설정했습니다.
25-38: 스터디 과제 휴강 처리 테스트 케이스스터디 과제 휴강 처리가 성공적으로 이루어지는지 확인하는 테스트 케이스입니다. given-when-then 구조와 적절한 단언문이 사용되었습니다.
src/main/java/com/gdschongik/gdsc/domain/study/domain/vo/Assignment.java (3)
3-3: 정적 import 문 추가
StudyStatus상수를 사용하기 위해 정적 import 문이 추가되었습니다. 이는 코드의 가독성을 높입니다.
51-52: 빈 과제 생성 메서드 업데이트정적 import를 사용하여 상태가
NONE인 빈 과제를 생성하는 메서드가 업데이트되었습니다.
54-55: 과제 취소 메서드 추가상태가
CANCELLED인 과제를 생성하는 새로운 메서드가 추가되었습니다.src/main/java/com/gdschongik/gdsc/domain/study/domain/StudyDetail.java (1)
73-75:cancelAssignment메서드의 구현을 검토하세요.
cancelAssignment메서드는assignment속성을 변경합니다.Assignment.cancelAssignment()메서드가 올바르게 구현되었는지 확인하세요.Verification successful
cancelAssignment메서드의 구현을 검토하세요.
Assignment.cancelAssignment()메서드는Assignment객체를CANCELLED상태로 설정하여 반환합니다. 이 구현은 올바르게 보이며,cancelAssignment메서드의 기대 동작과 일치합니다.
Assignment.cancelAssignment()메서드의 구현이 적절합니다.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the implementation of the Assignment.cancelAssignment() method. # Test: Search for the method implementation. Expect: Proper implementation of the method. rg --type java -A 5 $'public static Assignment cancelAssignment()'Length of output: 480
src/test/java/com/gdschongik/gdsc/helper/FixtureHelper.java (1)
84-89:createStudyDetail메서드의 구현을 검토하세요.
createStudyDetail메서드는 제공된 매개변수를 사용하여StudyDetail객체를 생성합니다. 매개변수가 올바르게 사용되고StudyDetail객체가 제대로 인스턴스화되었는지 확인하세요.Verification successful
createStudyDetail메서드의 구현을 검토하세요.
createStudyDetail메서드는 제공된 매개변수를 사용하여StudyDetail객체를 생성합니다. 매개변수가 올바르게 사용되고StudyDetail객체가 제대로 인스턴스화되었는지 확인하세요.
StudyDetail.createStudyDetail메서드가StudyDetail객체를 빌더 패턴을 사용하여 올바르게 인스턴스화하는지 확인했습니다.FixtureHelper.java에서StudyDetail.createStudyDetail메서드에 전달되는 매개변수가 예상되는 매개변수와 일치하는지 확인했습니다.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the correct instantiation of the StudyDetail object. # Test: Search for the method usage. Expect: Proper instantiation of the StudyDetail object. rg --type java -A 5 $'StudyDetail.createStudyDetail'Length of output: 3046
src/main/java/com/gdschongik/gdsc/global/exception/ErrorCode.java (1)
140-140:ASSIGNMENT_NOT_FOUND상수의 사용을 검토하세요.
ASSIGNMENT_NOT_FOUND상수는ErrorCode열거형에 추가되었습니다. 코드베이스에서 적절하게 사용되고 있는지 확인하세요.Verification successful
ASSIGNMENT_NOT_FOUND상수가 적절하게 사용되고 있습니다.
ASSIGNMENT_NOT_FOUND상수는StudyMentorService.java파일에서CustomException을 던지는 데 사용되고 있습니다. 이는 상수가 올바르게 사용되고 있음을 나타냅니다.
src/main/java/com/gdschongik/gdsc/domain/study/application/StudyMentorService.java파일에서 확인됨.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the usage of the ASSIGNMENT_NOT_FOUND constant. # Test: Search for the constant usage. Expect: Proper usage of the constant in the codebase. rg --type java $'ErrorCode.ASSIGNMENT_NOT_FOUND'Length of output: 47
Script:
#!/bin/bash # Description: Reverify the usage of the ASSIGNMENT_NOT_FOUND constant. # Test: Search for the constant usage. Expect: Proper usage of the constant in the codebase. rg --type java 'ASSIGNMENT_NOT_FOUND'Length of output: 331
src/test/java/com/gdschongik/gdsc/helper/IntegrationTest.java (2)
191-202: 코드 변경 사항이 올바릅니다.
createStudyDetail함수는 올바르게 작성되었습니다.하지만 함수의 모든 매개변수가 올바르게 사용되는지 확인해야 합니다.
Verification successful
코드 변경 사항이 올바릅니다.
createStudyDetail함수는 여러 파일에서 올바르게 사용되고 있습니다. 모든 매개변수가 적절하게 사용되고 있으며, 함수 호출이 예상된 유형과 값을 일치합니다.
src/main/java/com/gdschongik/gdsc/domain/study/factory/StudyDomainFactory.javasrc/main/java/com/gdschongik/gdsc/domain/study/domain/StudyDetail.javasrc/test/java/com/gdschongik/gdsc/helper/IntegrationTest.javasrc/test/java/com/gdschongik/gdsc/helper/FixtureHelper.javasrc/test/java/com/gdschongik/gdsc/domain/study/application/StudyMentorServiceTest.javasrc/test/java/com/gdschongik/gdsc/domain/study/domain/StudyDetailTest.javaScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all function calls to `createStudyDetail` to ensure all parameters are used correctly. # Test: Search for the function usage. Expect: All occurrences of the function usage with correct parameters. rg --type java -A 5 $'createStudyDetail'Length of output: 4510
175-189: 코드 변경 사항이 올바릅니다.
createStudy함수는 올바르게 작성되었습니다.하지만 함수의 모든 매개변수가 올바르게 사용되는지 확인해야 합니다.
Verification successful
코드 변경 사항이 올바릅니다.
createStudy함수는 올바르게 작성되었으며, 코드베이스에서 모든 매개변수가 올바르게 사용되고 있습니다.
src/test/java/com/gdschongik/gdsc/helper/IntegrationTest.javasrc/test/java/com/gdschongik/gdsc/helper/FixtureHelper.javasrc/test/java/com/gdschongik/gdsc/domain/study/domain/StudyDetailTest.javasrc/test/java/com/gdschongik/gdsc/domain/study/domain/StudyHistoryValidatorTest.javasrc/test/java/com/gdschongik/gdsc/domain/study/domain/StudyTest.javasrc/main/java/com/gdschongik/gdsc/domain/study/factory/StudyDomainFactory.javasrc/main/java/com/gdschongik/gdsc/domain/study/application/AdminStudyService.javasrc/main/java/com/gdschongik/gdsc/domain/study/api/AdminStudyController.javasrc/test/java/com/gdschongik/gdsc/domain/study/application/StudyMentorServiceTest.javaScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all function calls to `createStudy` to ensure all parameters are used correctly. # Test: Search for the function usage. Expect: All occurrences of the function usage with correct parameters. rg --type java -A 5 $'createStudy'Length of output: 16585
Job Summary for GradleCheck Style and Test to Develop :: build-test
|
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- src/main/java/com/gdschongik/gdsc/domain/study/api/StudyMentorController.java (2 hunks)
- src/main/java/com/gdschongik/gdsc/domain/study/application/StudyMentorService.java (1 hunks)
- src/main/java/com/gdschongik/gdsc/global/exception/ErrorCode.java (1 hunks)
Files skipped from review as they are similar to previous changes (3)
- src/main/java/com/gdschongik/gdsc/domain/study/api/StudyMentorController.java
- src/main/java/com/gdschongik/gdsc/domain/study/application/StudyMentorService.java
- src/main/java/com/gdschongik/gdsc/global/exception/ErrorCode.java
| @Transactional | ||
| public void cancelStudyAssignment(Long studyDetailId) { | ||
| StudyDetail studyDetail = studyDetailRepository | ||
| .findById(studyDetailId) | ||
| .orElseThrow(() -> new CustomException(STUDY_DETAIL_NOT_FOUND)); | ||
|
|
||
| studyDetail.cancelAssignment(); | ||
|
|
||
| log.info("[StudyMentorService] 과제 휴강 처리: studyDetailId={}", studyDetail.getId()); | ||
| } |
There was a problem hiding this comment.
이 스터디가 현재 로그인한 유저(멘토)가 만든 스터디인지 검증하는 로직도 필요할거같아요!!
아예 StudyMentorService에서 전부 다 쓸거같으니 스터디가 멘토임을 검증하는 로직을 함수로 하나 만들어두면 유용할것같습니다!
src/main/java/com/gdschongik/gdsc/domain/study/application/StudyMentorService.java
Show resolved
Hide resolved
| @@ -79,4 +80,11 @@ public Study createStudy(Member mentor, Period period, Period applicationPeriod) | |||
| STUDY_START_TIME, | |||
| STUDY_END_TIME); | |||
| } | |||
|
|
|||
| public StudyDetail createStudyDetail( | |||
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (6)
- src/main/java/com/gdschongik/gdsc/domain/study/application/StudyMentorService.java (1 hunks)
- src/main/java/com/gdschongik/gdsc/domain/study/domain/StudyDetailValidator.java (1 hunks)
- src/main/java/com/gdschongik/gdsc/global/exception/ErrorCode.java (1 hunks)
- src/test/java/com/gdschongik/gdsc/domain/study/domain/StudyDetailTest.java (1 hunks)
- src/test/java/com/gdschongik/gdsc/domain/study/domain/StudyDetailValidatorTest.java (1 hunks)
- src/test/java/com/gdschongik/gdsc/helper/FixtureHelper.java (2 hunks)
Files skipped from review as they are similar to previous changes (3)
- src/main/java/com/gdschongik/gdsc/global/exception/ErrorCode.java
- src/test/java/com/gdschongik/gdsc/domain/study/domain/StudyDetailTest.java
- src/test/java/com/gdschongik/gdsc/helper/FixtureHelper.java
Additional comments not posted (3)
src/main/java/com/gdschongik/gdsc/domain/study/domain/StudyDetailValidator.java (1)
1-16: 코드가 잘 작성되었습니다!클래스와 메서드 구현이 올바르게 작성되었습니다.
src/main/java/com/gdschongik/gdsc/domain/study/application/StudyMentorService.java (1)
1-39: 코드가 잘 작성되었습니다!클래스와 메서드 구현이 올바르게 작성되었습니다.
src/test/java/com/gdschongik/gdsc/domain/study/domain/StudyDetailValidatorTest.java (1)
1-38: 테스트 코드가 잘 작성되었습니다!클래스와 테스트 메서드 구현이 올바르게 작성되었습니다.
Job Summary for GradleCheck Style and Test to Develop :: build-test
|
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- src/main/java/com/gdschongik/gdsc/domain/study/api/StudyMentorController.java (2 hunks)
- src/main/java/com/gdschongik/gdsc/domain/study/application/StudyMentorService.java (3 hunks)
- src/main/java/com/gdschongik/gdsc/global/exception/ErrorCode.java (1 hunks)
Files skipped from review as they are similar to previous changes (3)
- src/main/java/com/gdschongik/gdsc/domain/study/api/StudyMentorController.java
- src/main/java/com/gdschongik/gdsc/domain/study/application/StudyMentorService.java
- src/main/java/com/gdschongik/gdsc/global/exception/ErrorCode.java
Job Summary for GradleCheck Style and Test to Develop :: build-test
|
Job Summary for GradleCheck Style and Test to Develop :: build-test
|
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- src/main/java/com/gdschongik/gdsc/domain/study/application/StudyMentorService.java (3 hunks)
- src/test/java/com/gdschongik/gdsc/domain/study/application/StudyMentorServiceTest.java (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- src/test/java/com/gdschongik/gdsc/domain/study/application/StudyMentorServiceTest.java
Additional comments not posted (2)
src/main/java/com/gdschongik/gdsc/domain/study/application/StudyMentorService.java (2)
5-11: LGTM! 새로운 import가 적절하게 추가되었습니다.추가된
MemberUtil,StudyDetailValidator, 및CustomExceptionimport는 새로운 기능에 필요하며 올바르게 사용되고 있습니다.
23-25: LGTM! 새로운 필드가 적절하게 추가되었습니다.추가된
memberUtil및studyDetailValidator필드는 새로운 메서드cancelStudyAssignment에 필요하며 올바르게 선언되고 초기화되었습니다.
src/main/java/com/gdschongik/gdsc/domain/study/application/StudyMentorService.java
Show resolved
Hide resolved
|
|
||
| public void validateCancelStudyAssignment(Member currentMember, StudyDetail studyDetail) { | ||
| // 멘토가 아니라면 과제를 휴강처리 할 수 없다. | ||
| if (!currentMember.equals(studyDetail.getStudy().getMentor())) { |
There was a problem hiding this comment.
상욱님 이거 보고 구현하다가 생각난건데
저희 이 권한 처리는 로그인과정에서 처리한다고 하지 않았나요?
There was a problem hiding this comment.
수많은 멘토 중 해당 스터디의 멘토만 수정 가능해야 한다는 맥락에서 이런 검증을 넣었습니다
There was a problem hiding this comment.
그리고 그냥 든 생각인데
validateCancel
validatePublish
이렇게 여러개 생성하지 말고 그냥 공통으로 쓸 수 있게 구현하는게 좋지 않을까요?
There was a problem hiding this comment.
StudyDetail 관련된 모든 수정시 수많은 멘토 중 해당 스터디의 멘토만 수정 가능해야 한다라는 검증을 해야할텐데,
그렇다면 제가 지금 구현해둔걸 나중에 private으로 메서드로 추출해서 각 validate 메서드에서 호출하면 될 것 같습니다.
항상 검증할게 이것만 있는건 아니니까요!
There was a problem hiding this comment.
아아~ 알겠습니다 그럼 저도 그냥 validatePublish~~이런 메소드 저기다가 생성해서 과제 생성 api pr에 올리겠습니다~
There was a problem hiding this comment.
제가 메서드 추출해뒀어요.
pull 받아서 활용하시면 될 것 같아요
Job Summary for GradleCheck Style and Test to Develop :: build-test
|
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- src/main/java/com/gdschongik/gdsc/domain/study/domain/StudyDetailValidator.java (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- src/main/java/com/gdschongik/gdsc/domain/study/domain/StudyDetailValidator.java
Job Summary for GradleCheck Style and Test to Develop :: build-test
|
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- src/test/java/com/gdschongik/gdsc/domain/study/application/StudyMentorServiceTest.java (1 hunks)
- src/test/java/com/gdschongik/gdsc/helper/IntegrationTest.java (4 hunks)
Files skipped from review as they are similar to previous changes (2)
- src/test/java/com/gdschongik/gdsc/domain/study/application/StudyMentorServiceTest.java
- src/test/java/com/gdschongik/gdsc/helper/IntegrationTest.java
🌱 관련 이슈
📌 작업 내용 및 특이사항
📝 참고사항
📚 기타
Summary by CodeRabbit
Summary by CodeRabbit
New Features
Bug Fixes
Tests