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

refactor: 메일 발송 요청 로직에 도메인 서비스 적용 #488

Conversation

Sangwook02
Copy link
Member

@Sangwook02 Sangwook02 commented Jul 19, 2024

🌱 관련 이슈

📌 작업 내용 및 특이사항

  • 원래 있던 HongikUnivEmailValidator@DomainService를 달았습니다.
  • 이미 재학생 인증에 사용된 메일인지를 검증하는 로직을 HongikUnivEmailValidator에 추가했습니다.

📝 참고사항

  • 기존 test에 given, when, then 구분이 없길래 추가했습니다.
  • log도 같이 추가했습니다.

📚 기타

Summary by CodeRabbit

  • 신규 기능

    • 대학 이메일 검증 프로세스를 개선하여 회원 데이터 확인 및 유효성 검사를 통합했습니다.
    • 이메일 검증 시 기존 회원의 존재 여부를 고려하는 새로운 검증 규칙을 도입했습니다.
  • 버그 수정

    • 이메일 발송 및 검증 과정에서 로깅 기능이 추가되어 문제 추적이 용이해졌습니다.
  • 테스트

    • 이메일 검증 로직을 반영하여 테스트 케이스를 업데이트하고, 회원 데이터 검사 기능을 강화했습니다.

@Sangwook02 Sangwook02 added the ♻️ refactor 기능 개선 label Jul 19, 2024
@Sangwook02 Sangwook02 self-assigned this Jul 19, 2024
@Sangwook02 Sangwook02 requested a review from a team as a code owner July 19, 2024 13:40
Copy link

coderabbitai bot commented Jul 19, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

이 변경 사항은 대학 이메일 인증 링크 발송 프로세스를 개선하기 위한 것입니다. UnivEmailVerificationLinkSendServicesend 메서드가 리팩토링되어 이메일 검증 로직이 통합되었으며, HongikUnivEmailValidator가 더 나은 오류 처리를 위해 수정되었습니다. 테스트 케이스도 새로운 로직을 반영하도록 업데이트되었습니다.

Changes

파일 경로 변경 요약
src/main/java/com/gdschongik/gdsc/domain/email/application/UnivEmailVerificationLinkSendService.java, src/main/java/com/gdschongik/gdsc/domain/email/domain/HongikUnivEmailValidator.java send 메서드 리팩토링, 검증 로직 통합 및 로그 기능 추가. 새로운 검증 메서드 도입.
src/test/java/com/gdschongik/gdsc/domain/email/domain/HongikUnivEmailValidatorTest.java 테스트 케이스가 새로운 검증 로직을 반영하도록 업데이트, 패키지 경로 변경, Spring Boot 테스트 어노테이션 제거.
src/main/java/com/gdschongik/gdsc/domain/member/dao/MemberRepository.java 회원 조회 메서드 변경: Discord 사용자 이름으로 조회에서 대학 이메일 존재 여부 확인으로 변경.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UnivEmailVerificationLinkSendService
    participant HongikUnivEmailValidator
    participant MemberRepository

    User->>UnivEmailVerificationLinkSendService: send(univEmail)
    UnivEmailVerificationLinkSendService->>MemberRepository: existsByUnivEmail(univEmail)
    MemberRepository-->>UnivEmailVerificationLinkSendService: exists
    UnivEmailVerificationLinkSendService->>HongikUnivEmailValidator: validateSendUnivEmailVerificationLink(univEmail, exists)
    HongikUnivEmailValidator-->>UnivEmailVerificationLinkSendService: validationResult
    UnivEmailVerificationLinkSendService->>User: emailSentOrError
Loading

Assessment against linked issues

Objective Addressed Explanation
메일 발송 요청 로직에 도메인 서비스 적용 (#486)

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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

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 Build Scan published

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 f7b9efa and 389ce0c.

Files selected for processing (3)
  • src/main/java/com/gdschongik/gdsc/domain/email/application/UnivEmailVerificationLinkSendService.java (4 hunks)
  • src/main/java/com/gdschongik/gdsc/global/util/email/HongikUnivEmailValidator.java (1 hunks)
  • src/test/java/com/gdschongik/gdsc/domain/email/domain/HongikUnivEmailValidatorTest.java (2 hunks)
Additional comments not posted (11)
src/main/java/com/gdschongik/gdsc/global/util/email/HongikUnivEmailValidator.java (4)

5-10: LGTM! 필요한 import 문이 추가되었습니다.

추가된 Optional, Member, @DomainService import 문은 새로운 기능을 위해 필요합니다.


12-12: LGTM! 클래스 주석이 적절하게 변경되었습니다.

@Component에서 @DomainService로 변경된 것은 도메인 주도 설계 원칙과 일치합니다.


15-15: LGTM! 메서드 시그니처가 적절하게 변경되었습니다.

validate 메서드가 이제 Optional<Member> 매개변수를 받아 Member 객체의 존재를 고려하여 이메일을 검증할 수 있게 되었습니다.


24-25: LGTM! 새로운 로직이 적절하게 추가되었습니다.

optionalMember가 존재하는 경우 CustomException을 던지는 로직이 추가되어, 이미 존재하는 멤버가 있는 경우 검증이 성공하지 않도록 합니다.

src/main/java/com/gdschongik/gdsc/domain/email/application/UnivEmailVerificationLinkSendService.java (3)

15-15: LGTM! 필요한 import 문이 추가되었습니다.

추가된 Slf4j import 문은 로깅 기능을 위해 필요합니다.


19-19: LGTM! 클래스 주석이 적절하게 추가되었습니다.

@Slf4j 추가로 클래스 내에서 로깅이 가능해져 추적성과 디버깅 기능이 향상됩니다.


48-50: LGTM! 메서드 로직이 적절하게 리팩토링되었습니다.

send 메서드가 리팩토링되어 검증 로직이 직접 통합되고 로깅이 추가되었습니다. 이로 인해 제어 흐름이 단순해지고 메서드 호출 수가 줄어들어 코드가 더 깔끔해지고 성능이 향상될 수 있습니다.

src/test/java/com/gdschongik/gdsc/domain/email/domain/HongikUnivEmailValidatorTest.java (4)

1-1: LGTM! 패키지 선언이 적절하게 업데이트되었습니다.

패키지 선언이 업데이트되어 패키지 계층 구조의 재구성을 반영합니다.


3-11: LGTM! 필요한 import 문이 추가되었습니다.

추가된 Optional, Member import 문은 업데이트된 테스트 케이스를 위해 필요합니다.


24-29: LGTM! 테스트 케이스가 적절하게 업데이트되었습니다.

테스트 케이스가 새로운 validate 메서드 시그니처를 반영하도록 업데이트되어 새로운 기능을 정확하게 테스트합니다.


93-105: LGTM! 새로운 테스트 케이스가 적절하게 추가되었습니다.

이미 등록된 멤버의 이메일 주소를 검증할 때 예외가 발생하는지 확인하는 새로운 테스트 케이스가 추가되어 검증 로직의 견고성이 향상됩니다.

Copy link

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 Build Scan published

Copy link
Contributor

@seulgi99 seulgi99 left a comment

Choose a reason for hiding this comment

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

좋습니다!!

@Sangwook02
Copy link
Member Author

Sangwook02 commented Jul 19, 2024

    @Operation(summary = "학교 인증 메일 발송 요청", description = "학교 인증 메일 발송을 요청합니다.")
    @PostMapping("/send-verify-email")

별개로, 학교 인증 메일 발송 요청이라는 말이 뭔가 어색하지 않나요?
재학생 인증 메일 발송 요청으로 수정하면 어떤가 싶은데 다른 분들은 어떠신가요?

Copy link
Member

@AlmondBreez3 AlmondBreez3 left a comment

Choose a reason for hiding this comment

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

lgtm

Copy link
Member

@uwoobeat uwoobeat left a comment

Choose a reason for hiding this comment

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

lgtm
워딩 변경하는거 좋습니다
옛날에 작업된 로직이라 지금 쓰는 워딩과 다른 것 같네요

public class HongikUnivEmailValidator {

public void validate(String email) {
public void validateSendUnivEmailVerificationLink(String email, Optional<Member> optionalMember) {
Copy link
Member

Choose a reason for hiding this comment

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

optionalMember보다 exists 쿼리 써도 되지 않을까 싶네요

Copy link
Member Author

Choose a reason for hiding this comment

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

그게 더 깔끔하기는 하겠네요
수정 후 머지하겠습니다~

Copy link

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 Build Scan published

@Sangwook02 Sangwook02 merged commit a243dc3 into develop Jul 19, 2024
1 check passed
@Sangwook02 Sangwook02 deleted the refactor/486-apply-domain-service-on-verification-mail-sender branch July 19, 2024 14:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
♻️ refactor 기능 개선
Projects
None yet
Development

Successfully merging this pull request may close these issues.

♻️ 메일 발송 요청 로직에 도메인 서비스 적용
4 participants