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: MemberAssociateEvent 네이밍 변경 #837

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

Sangwook02
Copy link
Member

@Sangwook02 Sangwook02 commented Jan 7, 2025

🌱 관련 이슈

📌 작업 내용 및 특이사항

  • todo 걸려있던 부분 처리했습니다.
  • AssociateRequirement에 수정이 발생했을 경우 준회원으로 승급이 가능한지 확인하는 이벤트를 발행하는데,
    이 이벤트의 이름이 MemberAssociateEvent로 되어있어서 우리 코드의 다른 이벤트들과 맞지 않는 부분이 있었습니다.
  • 우리의 이벤트들은 대체로 '일어난 일' + 'Event'로 네이밍 되고 있기 때문에 AssociateRequirementUpdatedEvent로 네이밍 했습니다.

📝 참고사항

📚 기타

Summary by CodeRabbit

  • 리팩토링

    • 회원 가입 이벤트 처리 메커니즘 변경
    • 이벤트 핸들러 및 리스너 클래스 이름 업데이트
    • 회원 정보 업데이트 시 트리거되는 이벤트 타입 변경
  • 새로운 기능

    • 회원 요구사항 업데이트 이벤트 추가
    • 트랜잭션 커밋 전 이벤트 리스너 구현
  • 변경 사항

    • 기존 MemberAssociateEvent 이벤트를 AssociateRequirementUpdatedEvent로 대체
    • 관련된 테스트 케이스 업데이트

@Sangwook02 Sangwook02 added the ♻️ refactor 기능 개선 label Jan 7, 2025
@Sangwook02 Sangwook02 self-assigned this Jan 7, 2025
@Sangwook02 Sangwook02 requested a review from a team as a code owner January 7, 2025 12:28
Copy link

coderabbitai bot commented Jan 7, 2025

Walkthrough

이 풀 리퀘스트는 회원 관련 이벤트 처리 메커니즘을 리팩토링하는 변경 사항을 포함하고 있습니다. MemberAssociateEventAssociateRequirementUpdatedEvent로 대체하고, 관련된 리스너, 핸들러, 그리고 테스트 코드를 업데이트했습니다. 이벤트 이름과 처리 로직을 더 명확하고 의미 있게 변경하여 코드의 가독성과 일관성을 개선했습니다.

Changes

파일 경로 변경 요약
src/main/java/com/gdschongik/gdsc/domain/member/application/handler/AssociateRequirementUpdatedEventHandler.java 클래스 이름 및 메서드 파라미터 타입 변경
src/main/java/com/gdschongik/gdsc/domain/member/application/listener/AssociateRequirementUpdatedEventListener.java 새로운 이벤트 리스너 클래스 추가
src/main/java/com/gdschongik/gdsc/domain/member/domain/AssociateRequirementUpdatedEvent.java 새로운 이벤트 레코드 추가
src/main/java/com/gdschongik/gdsc/domain/member/domain/Member.java 이벤트 등록 타입 변경
src/test/java/com/gdschongik/gdsc/domain/member/application/MemberIntegrationTest.java 테스트 코드 이벤트 핸들러 및 이벤트 타입 업데이트

Assessment against linked issues

목표 해결 여부 설명
이벤트 네이밍 개선 [#836]

Poem

🐰 이벤트의 춤, 토끼의 노래
코드는 흐르고 이름은 바뀌네
MemberAssociate에서 RequirementUpdated
리팩토링의 마법을 춤추며
더 명확한 길을 찾아가네! 🌈


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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

github-actions bot commented Jan 7, 2025

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

🔭 Outside diff range comments (1)
src/test/java/com/gdschongik/gdsc/domain/member/application/MemberIntegrationTest.java (1)

Line range hint 24-36: 테스트 케이스 보완이 필요합니다

현재는 성공 케이스만 테스트하고 있습니다. 다양한 예외 상황에 대한 테스트도 추가하면 좋을 것 같습니다.

다음과 같은 테스트 케이스들을 추가해보세요:

  • 존재하지 않는 회원 ID로 이벤트 발생 시
  • 이미 Associate인 회원에 대한 이벤트 발생 시
  • 승급 조건이 충족되지 않은 회원에 대한 이벤트 발생 시
🧹 Nitpick comments (2)
src/main/java/com/gdschongik/gdsc/domain/member/application/handler/AssociateRequirementUpdatedEventHandler.java (1)

Line range hint 18-27: 로깅 개선이 필요합니다

예외 발생 시 더 자세한 컨텍스트 정보를 로깅하면 디버깅에 도움이 될 것 같습니다.

다음과 같이 로깅을 개선해보세요:

         try {
             member.advanceToAssociate();
         } catch (CustomException e) {
-            log.info("{}", e.getErrorCode());
+            log.info("회원 승급 실패 - 회원ID: {}, 에러: {}", 
+                associateRequirementUpdatedEvent.memberId(), 
+                e.getErrorCode());
         }
src/main/java/com/gdschongik/gdsc/domain/member/domain/Member.java (1)

178-178: 이벤트 등록 로직 개선이 필요합니다

현재 이벤트 등록이 여러 메서드에서 반복되고 있습니다. 이를 더 선언적이고 중앙화된 방식으로 개선할 수 있습니다.

AssociateRequirement 클래스에 이벤트 발생 조건을 캡슐화하고, 다음과 같은 메서드를 추가하는 것을 고려해보세요:

public class AssociateRequirement {
    public Optional<AssociateRequirementUpdatedEvent> checkAndCreateEvent(Long memberId) {
        if (this.isUpdated()) {
            return Optional.of(new AssociateRequirementUpdatedEvent(memberId));
        }
        return Optional.empty();
    }
}

이를 통해 이벤트 등록 로직을 더 객체지향적으로 만들 수 있습니다.

Also applies to: 195-195, 210-210

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 26ec006 and e8a68b7.

📒 Files selected for processing (7)
  • src/main/java/com/gdschongik/gdsc/domain/member/application/handler/AssociateRequirementUpdatedEventHandler.java (2 hunks)
  • src/main/java/com/gdschongik/gdsc/domain/member/application/listener/AssociateRequirementUpdatedEventListener.java (1 hunks)
  • src/main/java/com/gdschongik/gdsc/domain/member/application/listener/MemberAssociateEventListener.java (0 hunks)
  • src/main/java/com/gdschongik/gdsc/domain/member/domain/AssociateRequirementUpdatedEvent.java (1 hunks)
  • src/main/java/com/gdschongik/gdsc/domain/member/domain/Member.java (3 hunks)
  • src/main/java/com/gdschongik/gdsc/domain/member/domain/MemberAssociateEvent.java (0 hunks)
  • src/test/java/com/gdschongik/gdsc/domain/member/application/MemberIntegrationTest.java (3 hunks)
💤 Files with no reviewable changes (2)
  • src/main/java/com/gdschongik/gdsc/domain/member/domain/MemberAssociateEvent.java
  • src/main/java/com/gdschongik/gdsc/domain/member/application/listener/MemberAssociateEventListener.java
✅ Files skipped from review due to trivial changes (1)
  • src/main/java/com/gdschongik/gdsc/domain/member/domain/AssociateRequirementUpdatedEvent.java
🔇 Additional comments (2)
src/main/java/com/gdschongik/gdsc/domain/member/application/listener/AssociateRequirementUpdatedEventListener.java (1)

10-22: 이벤트 리스너 구현이 잘 되었습니다!

트랜잭션 처리와 의존성 주입이 Spring 베스트 프랙티스를 잘 따르고 있습니다.

src/main/java/com/gdschongik/gdsc/domain/member/domain/Member.java (1)

Line range hint 213-227: 준회원 승급 로직에 대한 단위 테스트 추가 필요

advanceToAssociate 메서드는 중요한 도메인 로직을 포함하고 있지만, 이에 대한 단위 테스트가 충분하지 않아 보입니다.

다음 스크립트로 현재 테스트 커버리지를 확인해보세요:

Copy link
Member

@kckc0608 kckc0608 left a comment

Choose a reason for hiding this comment

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

lgtm

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.

♻️ MemberAssociateEvent가 적절한 이름을 갖도록 수정
2 participants