refactor: 출석체크시 수강신청 여부 검증 로직을 도메인 서비스로 이동

[Sangwook02]

🌱 관련 이슈

• close ♻️ 출석체크시 수강신청 여부 검증 로직을 도메인 서비스로 이동 #709

📌 작업 내용 및 특이사항

• 출석체크시 해당 스터디에 신청했는지 확인하는 로직이 필요한데, 기존에는 findById로 조회하고 있었습니다.
  exists로 조회하도록 수정했고 존재 여부로 예외를 던지는 부분은 Validator에서 처리하도록 했습니다.

📝 참고사항

• test에서 수강생의 변수명이 mentor로 되어있어서 student로 모두 수정했습니다!

📚 기타

Summary by CodeRabbit

• 신규 기능

  • 출석 검증 로직 간소화 및 성능 향상.
  • 출석 시 학생의 신청 여부를 확인하는 추가 조건 도입.

• 버그 수정

  • 출석 검증에서 신청하지 않은 학생에 대한 예외 처리 추가.

• 테스트

  • 학생 관련 출석 검증 테스트 케이스 추가 및 개선.

[coderabbitai]

Walkthrough

이 변경 사항은 StudentStudyService 클래스의 attend 메소드에서 출석 검증 로직을 단순화하고, AttendanceValidator 클래스의 validateAttendance 메소드에 새로운 매개변수를 추가하여 출석 신청 여부를 확인하는 기능을 도입합니다. 또한, 로그 메시지를 개선하여 더 많은 정보를 제공하며, 관련 테스트 케이스를 수정하여 학생 관련 시나리오에 중점을 두었습니다.

Changes

파일 경로	변경 요약
src/main/java/com/gdschongik/gdsc/domain/study/application/StudentStudyService.java	attend 메소드에서 출석 검증 로직을 단순화하고, 로그 메시지에 memberId 추가.
src/main/java/com/gdschongik/gdsc/domain/study/domain/AttendanceValidator.java	validateAttendance 메소드에 boolean isAppliedToStudy 매개변수 추가, 출석 신청 여부 검증 로직 강화.
src/main/java/com/gdschongik/gdsc/global/exception/ErrorCode.java	STUDY_DETAIL_CURRICULUM_SIZE_MISMATCH 오류 코드 뒤에 빈 줄 추가.
src/test/java/com/gdschongik/gdsc/domain/study/domain/AttendanceValidatorTest.java	테스트 케이스에서 멘토 대신 학생 사용, 새로운 출석 검증 로직에 대한 테스트 케이스 추가.

Assessment against linked issues

Objective	Addressed	Explanation
출석 체크 시 수강 신청 여부 검증 로직을 도메인 서비스로 이동 (#709)	✅

Possibly related PRs

• feat: 스터디 개설하기 API 추가 #431: 출석 검증 로직과 관련된 변경 사항이 포함되어 있어, 학습 관리 기능과 연결될 수 있습니다.
• feat: 스터디 수강신청 API 추가 #532: 학습 신청 API의 변경이 출석 체크와 관련이 있을 수 있습니다.
• feat: 스터디 수강신청 취소 API 추가 #536: 학습 신청 취소와 관련하여 출석 검증 로직에 영향을 미칠 수 있습니다.

Poem

🐰 출석 체크, 이제는 간편해,
학생의 신청, 확인해줘요!
로그도 풍성, 정보 가득해,
모든 출석, 문제 없어요!
함께하는 학습, 즐거운 시간,
변화의 순간, 기쁨의 노래! 🎉

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between bdd647b and 102447f.

Files selected for processing (4)

• src/main/java/com/gdschongik/gdsc/domain/study/application/StudentStudyService.java (1 hunks)
• src/main/java/com/gdschongik/gdsc/domain/study/domain/AttendanceValidator.java (2 hunks)
• src/main/java/com/gdschongik/gdsc/global/exception/ErrorCode.java (1 hunks)
• src/test/java/com/gdschongik/gdsc/domain/study/domain/AttendanceValidatorTest.java (3 hunks)

Files skipped from review due to trivial changes (1)

• src/main/java/com/gdschongik/gdsc/global/exception/ErrorCode.java

Additional comments not posted (7)

src/main/java/com/gdschongik/gdsc/domain/study/domain/AttendanceValidator.java (1)

Line range hint 11-37: LGTM!

validateAttendance 메서드에 isAppliedToStudy 매개변수를 추가하고 사용자가 스터디에 신청했는지 여부를 검증하는 로직을 도입한 것은 좋은 변경 사항입니다. 이 변경으로 인해 출석 검증 로직의 견고성이 향상되었습니다.

새로운 검증 로직은 메서드의 목적에 부합하며, 예외 처리도 적절합니다. 코드 변경 사항은 기존 코드에 잘 통합되어 있으며 확립된 코딩 스타일과 규칙을 따르고 있습니다.

전반적으로 코드 변경 사항은 시스템의 기능이나 성능에 부정적인 영향을 미치지 않을 것으로 보입니다.

src/test/java/com/gdschongik/gdsc/domain/study/domain/AttendanceValidatorTest.java (4)

25-43: 테스트 코드 변경 사항이 잘 반영되었습니다!

mentor 멤버 변수를 student로 변경하여 학생 관련 시나리오에 중점을 두는 것이 좋습니다. 테스트 설정과 검증 로직이 테스트 메서드 이름과 잘 일치합니다.

---

45-63: 테스트 코드 변경 사항이 잘 반영되었습니다!

mentor 멤버 변수를 student로 변경하여 학생 관련 시나리오에 중점을 두는 것이 좋습니다. 테스트 설정과 검증 로직이 테스트 메서드 이름과 잘 일치합니다.

---

65-82: 테스트 코드 변경 사항이 잘 반영되었습니다!

mentor 멤버 변수를 student로 변경하여 학생 관련 시나리오에 중점을 두는 것이 좋습니다. 테스트 설정과 검증 로직이 테스트 메서드 이름과 잘 일치합니다.

---

84-102: 새로운 테스트 케이스 추가를 환영합니다!

신청하지_않은_스터디라면_실패한다 테스트 메서드는 학생이 신청하지 않은 스터디에 대해 출석 검증을 시도할 때 예외가 발생하는 시나리오를 잘 다루고 있습니다. 이 추가 사항은 출석 검증 프로세스의 견고성을 향상시킵니다.

src/main/java/com/gdschongik/gdsc/domain/study/application/StudentStudyService.java (2)

96-96: 좋은 변경 사항입니다!

existsByStudentAndStudy 메서드를 사용하여 학생이 스터디에 신청했는지 여부를 직접 확인하는 것은 StudyHistory 객체를 가져올 필요성을 제거하여 로직을 단순화하고 성능을 향상시킬 수 있습니다. 또한 isAppliedToStudy 변수 이름은 확인의 목적을 명확하게 전달합니다.

---

99-104: 좋은 변경 사항입니다!

isAppliedToStudy 값을 AttendanceValidator의 validateAttendance 메서드에 추가 매개변수로 전달하는 것은 출석 검증 시 학생이 스터디에 신청했는지 여부를 고려하도록 합니다. 이는 출석 검증 로직을 개선하는 데 도움이 됩니다.

또한 로깅 문에 memberId를 포함하는 것은 더 많은 컨텍스트를 제공하고 추적 가능성과 디버깅 기능을 향상시킵니다.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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 generate interesting stats about this repository and render them as a table.
  -- @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.

[AlmondBreez3]

lgtm

[github-actions]

Job Summary for Gradle

Check Style and Test to Develop :: build-test

Gradle Root Project	Requested Tasks	Gradle Version	Build Outcome	Build Scan®
gdsc	check	8.5	✅

[uwoobeat]

lgtm

[seulgi99]

LGTM