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: 테스트에서만 사용하는 메서드 제거 #770

Merged
merged 2 commits into from
Sep 12, 2024

Conversation

Sangwook02
Copy link
Member

@Sangwook02 Sangwook02 commented Sep 11, 2024

🌱 관련 이슈

📌 작업 내용 및 특이사항

  • 테스트에서만 사용하는 메서드가 있어서 제거했습니다.

📝 참고사항

  • Membership의 내부에서만 호출하는 검증 메서드가 public으로 되어 있어서 private으로 수정했습니다.

📚 기타

Summary by CodeRabbit

  • 버그 수정

    • 결제 상태 확인을 위한 중복 메서드를 제거하여 서비스 인터페이스를 간소화했습니다.
  • 변경 사항

    • 특정 메서드의 접근 제어자를 변경하여 클래스 내부에서만 접근 가능하도록 수정했습니다.
  • 테스트

    • MembershipServiceTest에서 여러 테스트 메서드와 관련 변수를 제거하여 테스트 범위를 축소했습니다.

@Sangwook02 Sangwook02 added ✅ test 테스트 작업 ♻️ refactor 기능 개선 labels Sep 11, 2024
@Sangwook02 Sangwook02 self-assigned this Sep 11, 2024
@Sangwook02 Sangwook02 requested a review from a team as a code owner September 11, 2024 05:46
Copy link

coderabbitai bot commented Sep 11, 2024

Walkthrough

변경 사항은 MembershipService 클래스에서 verifyPaymentStatus(Long membershipId) 메서드를 제거하고, Membership 클래스의 validateRegularRequirement 접근 제어자를 private으로 변경한 것입니다. 또한, MembershipServiceTest 클래스에서 여러 테스트 메서드와 멤버 변수를 삭제하여 테스트 로직을 수정했습니다. 이러한 변경은 코드의 간결성을 높이고, 클래스 간의 상호작용 방식을 조정합니다.

Changes

파일 경로 변경 요약
src/main/java/com/gdschongik/gdsc/domain/membership/application/MembershipService.java verifyPaymentStatus(Long membershipId) 메서드 제거
src/main/java/com/gdschongik/gdsc/domain/membership/domain/Membership.java validateRegularRequirement() 접근 제어자를 public에서 private으로 변경
src/test/java/com/gdschongik/gdsc/domain/membership/application/MembershipServiceTest.java 여러 테스트 메서드 및 membershipRepository 필드 제거

Assessment against linked issues

Objective Addressed Explanation
MembershipService.verifyPaymentStatus 제거 (#737)

🐰 변화의 기쁨을 노래해요,
메서드가 사라지고, 새로워졌죠!
간결함이 더해진 코드의 길,
테스트도 정리되어 더 깔끔해질!
함께 뛰어놀며, 더 나은 미래를 꿈꿔요! 🌟


Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e9e4c62 and 2422ef5.

Files selected for processing (3)
  • src/main/java/com/gdschongik/gdsc/domain/membership/application/MembershipService.java (1 hunks)
  • src/main/java/com/gdschongik/gdsc/domain/membership/domain/Membership.java (1 hunks)
  • src/test/java/com/gdschongik/gdsc/domain/membership/application/MembershipServiceTest.java (3 hunks)
Files skipped from review due to trivial changes (1)
  • src/main/java/com/gdschongik/gdsc/domain/membership/application/MembershipService.java
Additional comments not posted (5)
src/test/java/com/gdschongik/gdsc/domain/membership/application/MembershipServiceTest.java (4)

1-1: 멤버 변수 제거에 대한 의견 없음

membershipRepository 필드가 제거되었지만, 제공된 변경 사항에서는 이로 인한 문제가 발견되지 않습니다.


1-1: 이전 리뷰 의견 참조

이 변경 사항은 이전 리뷰 의견에서 이미 다루었습니다.


1-1: 중첩 클래스 제거의 영향 확인 필요

정회원_가입조건_인증시도시 중첩 클래스와 관련 테스트 메서드가 제거되었습니다. 이는 테스트 스위트를 단순화하기 위한 리팩토링이나 결정을 나타낼 수 있습니다. 이러한 테스트가 중복되거나 다른 곳으로 이동되었을 가능성이 있습니다.

이 중첩 클래스와 테스트 메서드를 제거한 이유와 그 영향을 확인하기 위해 다음 스크립트를 실행해 보세요:

Verification successful

중첩 클래스 및 테스트 메서드 제거 확인

정회원_가입조건_인증시도시 중첩 클래스와 멤버십_회비납부시_정회원_가입조건중_회비납부_인증상태가_인증_성공한다() 테스트 메서드는 코드베이스에서 직접적인 대체나 이름 변경 없이 제거된 것으로 보입니다. 이는 코드베이스의 리팩토링 또는 단순화를 위한 결정일 수 있습니다.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# 설명: 제거된 중첩 클래스와 테스트 메서드의 영향 확인

# 테스트: 제거된 중첩 클래스 검색. 기대 결과: 중첩 클래스가 다른 곳으로 이동되었거나 불필요하다고 판단되어 완전히 제거되었음을 확인.
rg --type java $'class 정회원_가입조건_인증시도시'

# 테스트: 제거된 테스트 메서드 검색. 기대 결과: 테스트 메서드가 다른 곳으로 이동되었거나 불필요하다고 판단되어 완전히 제거되었음을 확인.  
rg --type java $'멤버십_회비납부시_정회원_가입조건중_회비납부_인증상태가_인증_성공한다\(\)'

Length of output: 101


Script:

#!/bin/bash
# 설명: 제거된 중첩 클래스와 테스트 메서드의 리팩토링 또는 이름 변경 확인

# 리팩토링 또는 이름 변경된 중첩 클래스 검색
rg --type java '정회원' -A 5

# 리팩토링 또는 이름 변경된 테스트 메서드 검색
rg --type java '회비납부' -A 5

Length of output: 19224


1-1: 테스트 메서드 제거의 영향 확인 필요

멤버십_회비납부시_이미_회비납부_했다면_회비납부_실패한다() 테스트 메서드가 제거되어, 멤버십 결제 상태 검증이 더 이상 이 컨텍스트에서 테스트되지 않습니다. 이는 멤버십 결제 검증과 관련된 서비스의 정확성 보장에 영향을 미칠 수 있습니다.

이 테스트 메서드를 제거한 이유와 그 영향을 확인하기 위해 다음 스크립트를 실행해 보세요:

src/main/java/com/gdschongik/gdsc/domain/membership/domain/Membership.java (1)

Line range hint 65-69: 접근 제어자 변경 승인

validateRegularRequirement 메서드의 접근 제어자를 public에서 private으로 변경하는 것을 승인합니다. 이 변경은 메서드의 가시성을 Membership 클래스 내부로 제한하여 캡슐화 원칙에 부합합니다.

다만, 이 변경으로 인해 다른 클래스에서 해당 검증 메서드를 직접 호출할 수 없게 되므로, Membership 클래스와 상호 작용하는 방식에 영향을 미칠 수 있습니다. 필요한 경우 관련 코드를 적절히 조정해야 할 수 있습니다.


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

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

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

findMembershipAndVerifiyPayment는 이벤트로 호출되서 트랜잭셔널이 없는건가요?!

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

@Sangwook02 Sangwook02 merged commit 88f6840 into develop Sep 12, 2024
1 check passed
@Sangwook02 Sangwook02 deleted the refactor/737-remove-test-only-method branch September 12, 2024 00:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
♻️ refactor 기능 개선 ✅ test 테스트 작업
Projects
None yet
Development

Successfully merging this pull request may close these issues.

♻️ 테스트에서만 사용하는 메서드 제거
3 participants