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

feat: 무료 주문 생성하기 API 구현 #520

Merged
merged 16 commits into from
Jul 26, 2024

Conversation

uwoobeat
Copy link
Member

@uwoobeat uwoobeat commented Jul 25, 2024

🌱 관련 이슈

📌 작업 내용 및 특이사항

  • 주문 결제정보 조회의 경우 완료 상태인 주문의 paymentKey가 필요한데, 무료 주문의 경우 처음부터 완료상태로 생성되지만 paymentKey는 null이므로 해당 조회 API의 경우 1) 유료 주문이면서 2) 완료된 주문인 경우에만 토스페이먼츠로 결제 정보 요청하도록 변경했습니다
  • 무료 주문 / 유료 주문 구분이 추가되었으며, 이는 최종결제금액이 0원인지의 여부로 판단합니다

📝 참고사항

  • 금액이 0원인 경우가 자주 사용되므로 해당 클래스에 Money.ZERO 와 같이 상수로 생성할 수 있도록 했습니다
  • 주문 취소 시 결제상태 롤백하고 준회원으로 강등해야 하는데, ✨ 결제 취소 후 정회원 권한을 회수하는 정책 구현  #518 에 추가하고 TODO로도 남겨놨습니다
  • 참고로 pg 결제의 경우 100원 이상인 결제 건만 가능합니다 (무료 주문 생성하기 API를 만든 이유이기도 합니다)

📚 기타

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features
    • 무료 주문 생성 기능 추가
  • Enhancements
    • 결제 처리 및 주문 상태 관련 API 메서드 이름 변경
    • 코드 내에서 금액 비교를 더 간결하게 처리
    • 오류 코드 명확성 향상 및 추가
  • Tests
    • 무료 주문 생성 및 취소에 대한 테스트 케이스 추가 및 개선
    • 테스트 구조를 중첩 클래스로 재조정하여 가독성 개선

@uwoobeat uwoobeat requested a review from a team as a code owner July 25, 2024 15:54
Copy link

coderabbitai bot commented Jul 25, 2024

Walkthrough

이번 변경사항은 무료 주문 생성 기능을 추가하고, 결제 금액이 0원인 경우의 주문 처리 로직을 개선합니다. 새로운 상수 Money.ZERO를 도입하여 코드의 일관성을 높였으며, 주문과 관련된 여러 메서드와 API의 명확성을 강화하는 작업이 포함됩니다. 또한, 유효성 검사 및 오류 처리 로직이 향상되어 전체 시스템의 안정성이 증가했습니다.

Changes

파일 변경 요약
.../domain/common/vo/Money.java, .../domain/coupon/domain/Coupon.java Money.ZERO 상수 추가 및 사용하여 코드 클리어성과 성능 향상
.../domain/order/api/AdminOrderController.java, .../domain/order/application/OrderService.java 메서드 이름 변경 및 API 설명 수정으로 명확성 증가
.../domain/order/api/OnboardingOrderController.java 무료 주문 생성 API 추가 및 기존 메서드 설명 수정
.../domain/order/domain/Order.java, .../domain/order/domain/MoneyInfo.java 무료 주문 생성 로직 추가 및 주문 취소 로직 강화
.../domain/order/domain/OrderTest.java, .../domain/order/domain/OrderValidatorTest.java 테스트 케이스 구조 재편 및 무료 주문 관련 테스트 추가

Sequence Diagram(s)

sequenceDiagram
    participant Customer
    participant OrderService
    participant Order
    participant Membership
    participant Coupon

    Customer->>OrderService: createFreeOrder()
    OrderService->>Membership: checkMembership()
    OrderService->>Coupon: validateCoupon()
    OrderService->>Order: createFree()
    Order->>OrderService: return order details
    OrderService->>Customer: return order confirmation
Loading

Assessment against linked issues

Objective Addressed Explanation
결제금액 0원인 경우 주문 생성 및 즉시 완료하기 API 구현 (#509)
무료 주문 관련 로직 추가 및 유효성 검사 수정 (#509)

🐇 변화의 순간, 기쁜 마음으로
주문이 완벽하게 연결되어,
무료로 즐길 수 있는 기회,
이제 모두가 행복하게,
0원의 기적, 함께 나누리! 🌟


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 3c0ee8f and c3005dd.

Files selected for processing (11)
  • src/main/java/com/gdschongik/gdsc/domain/common/vo/Money.java (1 hunks)
  • src/main/java/com/gdschongik/gdsc/domain/coupon/domain/Coupon.java (2 hunks)
  • src/main/java/com/gdschongik/gdsc/domain/order/api/AdminOrderController.java (1 hunks)
  • src/main/java/com/gdschongik/gdsc/domain/order/api/OnboardingOrderController.java (2 hunks)
  • src/main/java/com/gdschongik/gdsc/domain/order/application/OrderService.java (3 hunks)
  • src/main/java/com/gdschongik/gdsc/domain/order/domain/Order.java (4 hunks)
  • src/main/java/com/gdschongik/gdsc/domain/order/domain/OrderValidator.java (3 hunks)
  • src/main/java/com/gdschongik/gdsc/domain/order/dto/request/OrderFreeCreateRequest.java (1 hunks)
  • src/main/java/com/gdschongik/gdsc/global/exception/ErrorCode.java (1 hunks)
  • src/test/java/com/gdschongik/gdsc/domain/order/domain/OrderTest.java (2 hunks)
  • src/test/java/com/gdschongik/gdsc/domain/order/domain/OrderValidatorTest.java (4 hunks)
Files skipped from review due to trivial changes (1)
  • src/main/java/com/gdschongik/gdsc/domain/coupon/domain/Coupon.java
Additional comments not posted (24)
src/main/java/com/gdschongik/gdsc/domain/order/dto/request/OrderFreeCreateRequest.java (3)

1-1: 패키지 선언 확인

패키지 선언이 올바르게 되어 있습니다.


3-6: 필요한 유효성 검사 주석 추가

유효성 검사 주석이 적절하게 추가되었습니다.


8-11: DTO 필드와 유효성 검사 확인

필드와 유효성 검사 주석이 올바르게 정의되었습니다. orderNanoId는 길이 제한이 있고, membershipIdissuedCouponId는 양수여야 합니다.

src/main/java/com/gdschongik/gdsc/domain/order/api/OnboardingOrderController.java (3)

6-6: 새로운 DTO 요청 추가

새로운 OrderFreeCreateRequest DTO 요청이 올바르게 추가되었습니다.


32-32: 주문 완료 메서드 요약 수정

completeOrder 메서드의 요약이 적절하게 수정되었습니다.


39-44: 무료 주문 생성 엔드포인트 추가

무료 주문을 생성하는 새로운 엔드포인트가 올바르게 추가되었습니다. 요청을 처리하고 적절한 응답을 반환합니다.

src/main/java/com/gdschongik/gdsc/domain/order/api/AdminOrderController.java (3)

40-41: 메서드 요약 및 설명 수정

getCompletedOrderPayment 메서드의 요약 및 설명이 적절하게 수정되었습니다.


44-44: 메서드 이름 변경

메서드 이름이 getCompletedPaidOrderPayment로 변경되었습니다. 이 변경은 메서드의 목적을 더 명확하게 합니다.


48-48: 주문 취소 메서드 설명 확장

cancelOrder 메서드의 설명이 확장되어 주문 취소 시의 추가 작업을 명확하게 설명합니다.

src/main/java/com/gdschongik/gdsc/domain/common/vo/Money.java (1)

37-38: 잘했습니다! 새로운 상수 ZERO는 올바르게 초기화되었으며, 코드의 가독성과 재사용성을 높입니다.

src/main/java/com/gdschongik/gdsc/domain/order/domain/OrderValidator.java (2)

70-72: 잘했습니다! Money.ZERO를 사용하여 코드의 명확성과 일관성이 향상되었습니다.


102-131: 잘했습니다! validateFreeOrderCreate 메서드는 무료 주문 생성에 필요한 모든 검증을 포괄적으로 수행합니다.

src/main/java/com/gdschongik/gdsc/domain/order/domain/Order.java (3)

102-112: 잘했습니다! createFree 메서드는 무료 주문을 올바르게 생성하며, 적절한 상태와 금액 값을 초기화합니다.


157-159: 잘했습니다! isFree 메서드는 주문이 무료인지 올바르게 판단합니다.


Line range hint 135-148:
잘했습니다! validateCancelable 메서드는 무료 주문에 대한 검증을 추가하여 주문 취소 로직을 강화합니다.

src/main/java/com/gdschongik/gdsc/domain/order/application/OrderService.java (2)

111-116: 메소드 이름 변경 및 로직 추가 확인

getCompletedPaidOrderPayment 메소드 이름 변경과 무료 주문이 아닌지 확인하는 로직 추가가 적절합니다. 이로 인해 메소드의 목적이 명확해졌습니다.


147-165: 무료 주문 생성 메소드 추가 확인

createFreeOrder 메소드가 무료 주문 생성을 처리하기 위해 추가되었습니다. 필요한 검증을 포함하고 있으며, 주문을 저장소에 저장하는 로직도 적절합니다.

src/main/java/com/gdschongik/gdsc/global/exception/ErrorCode.java (2)

120-120: 에러 코드 이름 변경 확인

ORDER_COMPLETED_NOT_FOUND 에러 코드가 ORDER_COMPLETED_PAID_NOT_FOUND로 변경되었습니다. 이로 인해 유료 주문과 관련된 에러임이 명확해졌습니다.


122-122: 새로운 에러 코드 추가 확인

무료 주문을 취소할 수 없는 경우를 처리하기 위한 ORDER_CANCEL_FREE_ORDER 에러 코드가 추가되었습니다. 이는 에러 처리 범위를 확장하여 적절합니다.

src/test/java/com/gdschongik/gdsc/domain/order/domain/OrderTest.java (2)

44-83: 무료 주문 생성 테스트 추가 확인

무료주문_생성할때 클래스에 무료 주문 생성과 관련된 테스트 메소드가 추가되었습니다. 이 테스트들은 무료 주문이 올바르게 생성되고 상태와 최종 결제 금액이 검증되는지 확인합니다.


86-157: 주문 취소 테스트 추가 확인

주문_취소할때 클래스에 무료 주문 취소 시 실패하는지 확인하는 테스트 메소드가 추가되었습니다. 이 테스트는 무료 주문을 취소하려고 할 때 예상된 예외가 발생하는지 확인합니다.

src/test/java/com/gdschongik/gdsc/domain/order/domain/OrderValidatorTest.java (3)

Line range hint 14-14: 상수 MONEY_0_WON 제거 확인

MONEY_0_WON 상수가 제거되었습니다. 이제 Money.ZERO를 사용하여 0 값을 나타냅니다. 코드의 일관성을 유지하기 위한 좋은 변경입니다.


382-382: Money.ZERO 사용 확인

Order.createPending 메서드에서 MONEY_0_WON 대신 Money.ZERO를 사용합니다. 이는 0 값의 일관된 표현을 보장합니다.

다른 코드베이스에서도 Money.ZERO가 일관되게 사용되는지 확인하는 것이 좋습니다.


302-302: Money.ZERO 사용 확인

Order.createPending 메서드에서 MONEY_0_WON 대신 Money.ZERO를 사용합니다. 이는 0 값의 일관된 표현을 보장합니다.

다른 코드베이스에서도 Money.ZERO가 일관되게 사용되는지 확인하는 것이 좋습니다.

Verification successful

Money.ZERO 사용 확인

Order.createPending 메서드에서 MONEY_0_WON 대신 Money.ZERO를 사용합니다. 이는 0 값의 일관된 표현을 보장합니다.

다른 코드베이스에서도 Money.ZERO가 일관되게 사용되는지 확인한 결과, 여러 테스트 파일 및 주요 애플리케이션 파일에서 일관되게 사용되고 있음을 확인했습니다.

  • src/test/java/com/gdschongik/gdsc/domain/order/domain/OrderTest.java
  • src/test/java/com/gdschongik/gdsc/domain/order/domain/OrderValidatorTest.java
  • src/main/java/com/gdschongik/gdsc/domain/order/domain/Order.java
  • src/main/java/com/gdschongik/gdsc/domain/order/domain/OrderValidator.java
  • src/main/java/com/gdschongik/gdsc/domain/coupon/domain/Coupon.java
  • src/main/java/com/gdschongik/gdsc/domain/common/vo/Money.java

이로써 Money.ZERO의 일관된 사용이 확인되었습니다.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all usages of `Money.ZERO` in the codebase.

# Test: Search for the usage of `Money.ZERO`. Expect: Consistent usage across the codebase.
rg --type java -A 5 $'Money.ZERO'

Length of output: 5403

@uwoobeat uwoobeat changed the title Feature/509 create no payment order feat: 무료 주문 생성하기 API 구현 Jul 25, 2024
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 c3005dd and 9da42f9.

Files selected for processing (6)
  • src/main/java/com/gdschongik/gdsc/domain/order/api/OnboardingOrderController.java (1 hunks)
  • src/main/java/com/gdschongik/gdsc/domain/order/application/OrderService.java (2 hunks)
  • src/main/java/com/gdschongik/gdsc/domain/order/domain/MoneyInfo.java (1 hunks)
  • src/main/java/com/gdschongik/gdsc/domain/order/domain/Order.java (3 hunks)
  • src/main/java/com/gdschongik/gdsc/global/exception/ErrorCode.java (1 hunks)
  • src/test/java/com/gdschongik/gdsc/domain/order/domain/OrderTest.java (2 hunks)
Files skipped from review as they are similar to previous changes (4)
  • src/main/java/com/gdschongik/gdsc/domain/order/api/OnboardingOrderController.java
  • src/main/java/com/gdschongik/gdsc/domain/order/application/OrderService.java
  • src/main/java/com/gdschongik/gdsc/domain/order/domain/Order.java
  • src/main/java/com/gdschongik/gdsc/global/exception/ErrorCode.java
Additional comments not posted (7)
src/main/java/com/gdschongik/gdsc/domain/order/domain/MoneyInfo.java (1)

62-64: 새로운 메서드 추가 확인됨: isFree

이 메서드는 finalPaymentAmountMoney.ZERO인지 확인합니다. 로직이 명확하고 올바르게 구현되었습니다.

src/test/java/com/gdschongik/gdsc/domain/order/domain/OrderTest.java (6)

47-65: 테스트 메서드 추가 확인됨: 주문상태는_완료이다

이 테스트는 무료 주문이 생성될 때 주문 상태가 COMPLETED인지 확인합니다. 테스트 설정과 검증이 올바르게 구현되었습니다.


67-84: 테스트 메서드 추가 확인됨: 최종결제금액이_0원이_아니면_실패한다

이 테스트는 최종 결제 금액이 0원이 아닌 경우 예외가 발생하는지 확인합니다. 테스트 설정과 검증이 올바르게 구현되었습니다.


90-111: 테스트 메서드 추가 확인됨: 대기상태이면_실패한다

이 테스트는 주문이 대기 상태일 때 취소를 시도하면 예외가 발생하는지 확인합니다. 테스트 설정과 검증이 올바르게 구현되었습니다.


113-136: 테스트 메서드 추가 확인됨: 취소상태이면_실패한다

이 테스트는 주문이 이미 취소된 상태일 때 취소를 시도하면 예외가 발생하는지 확인합니다. 테스트 설정과 검증이 올바르게 구현되었습니다.


138-159: 테스트 메서드 추가 확인됨: 무료주문이면_실패한다

이 테스트는 무료 주문을 취소하려고 할 때 예외가 발생하는지 확인합니다. 테스트 설정과 검증이 올바르게 구현되었습니다.


161-185: 테스트 메서드 추가 확인됨: 완료상태이면_성공한다

이 테스트는 주문이 완료 상태일 때 성공적으로 취소될 수 있는지 확인합니다. 테스트 설정과 검증이 올바르게 구현되었습니다.

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 9da42f9 and 58e61de.

Files selected for processing (1)
  • src/test/java/com/gdschongik/gdsc/domain/order/domain/OrderValidatorTest.java (6 hunks)
Files skipped from review as they are similar to previous changes (1)
  • src/test/java/com/gdschongik/gdsc/domain/order/domain/OrderValidatorTest.java

Copy link
Member

@Sangwook02 Sangwook02 left a comment

Choose a reason for hiding this comment

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

lgtm
공백이 하나 실수로 들어간 것 같아요
이것만 수정 부탁드려요

@@ -37,15 +37,15 @@ public ResponseEntity<Page<OrderAdminResponse>> getOrders(
}

@Operation(
summary = "완료된 주문 결제정보 조회하기",
description = "주문 결제정보를 조회합니다. 토스페이먼츠 API의 결제 정보인 Payment 객체를 반환합니다. 완료된 주문에 대해서만 조회 가능합니다.")
summary = " 완료된 유료 주문 결제정보 조회하기",
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
summary = " 완료된 유료 주문 결제정보 조회하기",
summary = "완료된 유료 주문 결제정보 조회하기",

@@ -98,6 +98,26 @@ public static Order createPending(
.build();
}

public static Order createFree(
String nanoId, Membership membership, @Nullable IssuedCoupon issuedCoupon, MoneyInfo moneyInfo) {
Copy link
Contributor

Choose a reason for hiding this comment

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

무료 주문이면 쿠폰이 반드시 필요한거아닌가요??

Copy link
Member Author

@uwoobeat uwoobeat Jul 26, 2024

Choose a reason for hiding this comment

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

회비가 0원인 경우에는 쿠폰 없이 무료 주문이 가능하다고 봤어요
물론 회비를 무조건 양수로 지정하면 항상 쿠폰이 필요해지겠지만
쿠폰을 꼭 써야 무료 주문이다 보다는 최종결제금액이 0원이면 무료 주문이다 가 더 의미적으로 적절하다고 봤습니다

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

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

@uwoobeat uwoobeat self-assigned this Jul 26, 2024
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 58e61de and b25c3f2.

Files selected for processing (1)
  • src/main/java/com/gdschongik/gdsc/domain/order/api/AdminOrderController.java (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • src/main/java/com/gdschongik/gdsc/domain/order/api/AdminOrderController.java

@uwoobeat uwoobeat merged commit 7622747 into develop Jul 26, 2024
1 check passed
@uwoobeat uwoobeat deleted the feature/509-create-no-payment-order branch July 26, 2024 12:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

✨ 결제금액 0원인 경우 주문 생성 및 즉시 완료하기 API 구현
4 participants