feat(KL-68): update Product API #25
Conversation
- updateDtoλ₯Ό λ°μ nullμ΄ μλ νλ κ°μ λ³κ²½νλ μν update λ©μλ μμ± - κ΄λ ¨ ν μ€νΈμ½λ μμ± - μν μ 보 μ λ°μ΄νΈ ν μ€νΈ - μν μ 보 λΆλΆ μ λ°μ΄νΈ ν μ€νΈ - μν μ 보 μ λ°μ΄νΈ μ null κ° λ¬΄μ ν μ€νΈ
- ProductServiceμ id, updateDtoλ₯Ό λ°μ μνμ μ 보λ₯Ό μμ λ° λ ν¬μ§ν 리μ λ³κ²½μ¬ν μ μ₯ - κ΄λ ¨ ν μ€νΈμ½λ μμ± - μν μ λ°μ΄νΈ μ±κ³΅ ν μ€νΈ - μν μ λ°μ΄νΈ μ€ν¨ ν μ€νΈ - μν μμ
- μν μ 보 μμ API ꡬν - κ΄λ ¨ ν μ€νΈμ½λ μμ± - μν μ 보 λΆλΆ μ λ°μ΄νΈ API ν μ€νΈ
ohhamma
added
β
Test
ohhamma
changed the title
- μν λ±λ‘ μμ² μ ν¨μ± κ²μ¬ - 컨νΈλ‘€λ¬μ @Valid ν€μλ μΆκ° - κ΄λ ¨ ν μ€νΈμ½λ μΆκ° - μν λ±λ‘ API μ ν¨μ± κ²μ¬ μ€ν¨ ν μ€νΈ - μ ν¨μ± κ²μ¬μμ λ°μν μ€λ₯ λ©μμ§λ₯Ό μμ§ν΄μ μΆλ ₯νλλ‘ GlobalExceptionHandler μμ - μμ λ λ΄μ©μ λ§κ² ν μ€νΈμ½λ μμ - BindingResultλ₯Ό λͺ¨νΉν΄μ getFieldErrors()κ° μ ν¨ν FieldError λͺ©λ‘μ λ°ννλλ‘ μ€μ - h2 λ°μ΄ν°λ² μ΄μ€ λͺ¨λ MySQLλ‘ μ€μ
- μ ν¨νμ§ μμ μμ² λ©μμ§μ λν μμΈ νΈλ€λ§ - κ΄λ ¨ ν μ€νΈμ½λ μΆκ°
- μν κ°κ²©μ΄ 0 μ΄μμ΄μ΄μΌ νλ€λ μ μ½ μΆκ° - κ΄λ ¨ ν μ€νΈμ½λ μΆκ° - κ°κ²©μ΄ μμμΌ λ μ ν¨μ± κ²μ¬ μ€ν¨ - κ°κ²©μ΄ 0μΌ λ μ ν¨μ± κ²μ¬ μ±κ³΅ - μν μμ² dtoμμ κ°κ²©κ³Ό μ£Όμ μ리 λ°κΏ - λ°λ μ리μ λ§κ² κ΄λ ¨ ν μ€νΈμ½λ μμ
- κ° ν μ€νΈμΌμ΄μ€μμ λ°μν μμΈμ λν μ½λμ λ©μμ§λ₯Ό ErrorCodeμ μμΈμ κ°λ€κ³Ό λΉκ΅νλλ‘ μμ - μ§μνμ§ μλ λ©μλ μμΈμ μ΄λ¦μ METHOD_NOT_SUPPORTEDλ‘ λ³κ²½
- μν λ±λ‘ μμ² dtoμ μ ν¨μ± κ²μ¬ μΆκ° - μνλͺ , μν μ€λͺ , μ£Όμμ κΈΈμ΄ κ²μ¬ - νμ String νλμμ λΉ λ¬Έμμ΄ κ²μ¬ - κ°κ²©μ λ²μ κ²μ¬ - μΆκ°λ κ²μ¬ λ΄μ© ν μ€νΈμ½λμ μΆκ° - μν λ±λ‘ μμ² dtoμ νλ μμ λ³κ²½ - μ΄μ λ§κ² ν μ€νΈμ½λ μμ - μν νλμ maxκ° constantsλ‘ κ΄λ¦¬ - μ΄λ¦, μ€λͺ , μ£Όμμ κ° μ΅λ κΈΈμ΄
- μν λ±λ‘ μ ν¨μ± κ²μ¬ μ 보μ¬μ£Όλ λ©μμ§λ€μ μμλ‘ κ΄λ¦¬ - μ΄μ λ§κ² ν μ€νΈμ½λ μμ
- μμ κ΄λ¦¬νλ ν΄λμ€μ final ν€μλ μΆκ°
- μν μ 보 μμ μ μ ν¨μ± κ²μ¬ - μνλͺ , μνμ€λͺ , μ£Όμ κΈΈμ΄ κ²μ¬ - κ°κ²© λ²μ κ²μ¬ - μν μ 보 μμ dto νλ μμ λ³κ²½ - μ΄μ λ°λΌ ν μ€νΈμ½λ μμ
src/main/java/taco/klkl/domain/product/controller/ProductController.java
Show resolved
Hide resolved
src/test/java/taco/klkl/domain/product/dto/request/ProductCreateRequestDtoTest.java
Show resolved
Hide resolved
src/main/java/taco/klkl/global/error/GlobalExceptionHandler.java
Outdated
Show resolved
Hide resolved
- νμ μλ TODO μ½λ©νΈ μμ
- update λ‘μ§μ λΆνμν save λ©μλ νΈμΆ μ κ±° - μ΄μ λ°λ₯Έ ν μ€νΈμ½λ μμ
WalkthroughThis update enhances the Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant ProductController
participant ProductService
participant ProductRepository
Client->>ProductController: PATCH /products/{id}
ProductController->>ProductService: updateProduct(id, updateRequest)
ProductService->>ProductRepository: findById(id)
ProductRepository-->>ProductService: product
ProductService->>Product: update(updateRequest)
Product->>ProductService: return updated product
ProductService-->>ProductController: return updated product
ProductController-->>Client: ResponseEntity<ProductDetailResponseDto>
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configuration File (
|
|
@coderabbitai review |
Actions performedReview triggered.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (19)
- src/main/java/taco/klkl/domain/product/controller/ProductController.java (3 hunks)
- src/main/java/taco/klkl/domain/product/domain/Product.java (3 hunks)
- src/main/java/taco/klkl/domain/product/dto/request/ProductCreateRequestDto.java (1 hunks)
- src/main/java/taco/klkl/domain/product/dto/request/ProductUpdateRequestDto.java (1 hunks)
- src/main/java/taco/klkl/domain/product/service/ProductService.java (2 hunks)
- src/main/java/taco/klkl/global/common/constants/DefaultConstants.java (1 hunks)
- src/main/java/taco/klkl/global/common/constants/ProductConstants.java (1 hunks)
- src/main/java/taco/klkl/global/common/constants/ProductValidationMessages.java (1 hunks)
- src/main/java/taco/klkl/global/common/constants/UserConstants.java (1 hunks)
- src/main/java/taco/klkl/global/error/GlobalExceptionHandler.java (5 hunks)
- src/main/java/taco/klkl/global/error/exception/ErrorCode.java (1 hunks)
- src/main/resources/application-h2.yaml (1 hunks)
- src/test/java/taco/klkl/domain/product/controller/ProductControllerTest.java (6 hunks)
- src/test/java/taco/klkl/domain/product/domain/ProductTest.java (3 hunks)
- src/test/java/taco/klkl/domain/product/dto/request/ProductCreateRequestDtoTest.java (2 hunks)
- src/test/java/taco/klkl/domain/product/dto/request/ProductUpdateRequestDtoTest.java (2 hunks)
- src/test/java/taco/klkl/domain/product/integration/ProductIntegrationTest.java (2 hunks)
- src/test/java/taco/klkl/domain/product/service/ProductServiceTest.java (3 hunks)
- src/test/java/taco/klkl/global/error/GlobalExceptionHandlerTest.java (7 hunks)
Files skipped from review due to trivial changes (1)
- src/main/java/taco/klkl/global/common/constants/DefaultConstants.java
Additional comments not posted (57)
src/main/java/taco/klkl/global/common/constants/ProductConstants.java (2)
3-3: Good practice: Making the class final.Declaring the class as
finalprevents it from being subclassed, which is a good practice for utility classes.
9-11: New constants added for validation.The new constants
NAME_MAX_LENGTH,DESCRIPTION_MAX_LENGTH, andADDRESS_MAX_LENGTHprovide clear guidelines for data validation.src/main/java/taco/klkl/global/common/constants/UserConstants.java (1)
6-6: Good practice: Making the class final.Declaring the class as
finalprevents it from being subclassed, which is a good practice for utility classes.src/main/resources/application-h2.yaml (1)
10-10: Verify the impact ofMODE=MySQL.The change introduces compatibility with MySQL syntax. Ensure that all SQL queries are compatible with MySQL mode and test thoroughly.
src/main/java/taco/klkl/domain/product/dto/request/ProductUpdateRequestDto.java (2)
3-6: LGTM!The import statements are correct and necessary for the validation annotations and constants used in the record.
9-26: LGTM!The validation annotations ensure data integrity by enforcing size and positivity constraints. The usage of constants for validation messages and sizes promotes maintainability.
src/main/java/taco/klkl/global/error/exception/ErrorCode.java (1)
13-15: LGTM!The renaming of
METHOD_NOT_ALLOWEDtoMETHOD_NOT_SUPPORTEDimproves clarity. The addition ofHTTP_MESSAGE_NOT_READABLEenhances error handling for invalid request message formats.src/main/java/taco/klkl/global/common/constants/ProductValidationMessages.java (1)
1-23: LGTM!The validation messages are clear and provide specific feedback for each field. The class is well-structured and final, preventing inheritance.
src/main/java/taco/klkl/domain/product/dto/request/ProductCreateRequestDto.java (8)
3-8: LGTM! Imports are necessary for the new validation annotations and constants.The added import statements are appropriate and necessary for the new validation annotations and constants.
22-25: LGTM! Validation annotations for thenamefield are appropriate.The
@NotNull,@NotBlank, and@Sizeannotations ensure that thenamefield is not null, not blank, and within the specified size limit.
27-30: LGTM! Validation annotations for thedescriptionfield are appropriate.The
@NotNull,@NotBlank, and@Sizeannotations ensure that thedescriptionfield is not null, not blank, and within the specified size limit.
32-33: LGTM! Validation annotation for theaddressfield is appropriate.The
@Sizeannotation ensures that theaddressfield is within the specified size limit.
35-36: LGTM! Validation annotation for thepricefield is appropriate.The
@PositiveOrZeroannotation ensures that thepricefield is non-negative.
38-39: LGTM! Validation annotation for thecityIdfield is appropriate.The
@NotNullannotation ensures that thecityIdfield is not null.
41-42: LGTM! Validation annotation for thesubcategoryIdfield is appropriate.The
@NotNullannotation ensures that thesubcategoryIdfield is not null.
44-45: LGTM! Validation annotation for thecurrencyIdfield is appropriate.The
@NotNullannotation ensures that thecurrencyIdfield is not null.src/main/java/taco/klkl/domain/product/service/ProductService.java (4)
10-14: LGTM! Imports are necessary for the new methods and functionality.The added import statements are appropriate and necessary for the new methods and functionality.
25-26: LGTM! Use offinalkeyword enhances code clarity and immutability.The
finalkeyword for the parameter and the local variable ensures that these values are not modified, enhancing code clarity and immutability.
31-34: LGTM!createProductmethod is appropriate for creating new products.The
@Transactionalannotation ensures that the method performs write operations within a transaction.
38-43: LGTM!updateProductmethod is appropriate for updating existing products.The
@Transactionalannotation ensures that the method performs write operations within a transaction.src/main/java/taco/klkl/domain/product/controller/ProductController.java (3)
Line range hint
6-18:
LGTM! Imports are necessary for the new endpoint and enhanced validation.The added import statements are appropriate and necessary for the new endpoint and enhanced validation.
39-41: LGTM!@Validannotation enhances validation for thecreateProductmethod.The
@Validannotation ensures that the incoming product creation requests are validated according to the constraints defined in the DTO.
46-54: LGTM!updateProductmethod is appropriate for updating product information.The
@Validannotation ensures that the input is validated according to the constraints defined in the DTO.src/test/java/taco/klkl/domain/product/integration/ProductIntegrationTest.java (2)
45-49: Verify the new parameters inProductCreateRequestDto.Ensure that the new parameters ("address" and 1000) align with the expected input format for product creation.
78-82: Verify the new parameters inProductCreateRequestDto.Ensure that the new parameters ("address" and 1000) align with the expected input format for product creation.
src/main/java/taco/klkl/domain/product/domain/Product.java (2)
39-94: LGTM! Improved maintainability and readability.The use of constants from
ProductConstantsandDefaultConstantsenhances maintainability and readability.
142-164: LGTM! New method for selective updates.The new method
updatecorrectly updates the product properties based on theProductUpdateRequestDto.src/test/java/taco/klkl/domain/product/dto/request/ProductUpdateRequestDtoTest.java (5)
30-39: LGTM! Clearer method naming.The method
validProductUpdateRequestDtoprovides a clearer description of its purpose and correctly validates aProductUpdateRequestDtowith all valid fields.
46-65: LGTM! Enhanced validation for product name length.The new parameterized test
productNameExceedsMaxLengthcorrectly validates the maximum length constraint for the product name and provides meaningful error messages.
67-86: LGTM! Enhanced validation for product description length.The new parameterized test
productDescriptionExceedsMaxLengthcorrectly validates the maximum length constraint for the product description and provides meaningful error messages.
88-107: LGTM! Enhanced validation for address length.The new parameterized test
addressExceedsMaxLengthcorrectly validates the maximum length constraint for the address and provides meaningful error messages.
109-126: LGTM! Enhanced validation for non-negative price.The new parameterized test
negativePricecorrectly validates that the price cannot be negative and provides meaningful error messages.src/main/java/taco/klkl/global/error/GlobalExceptionHandler.java (4)
Line range hint
27-50: LGTM! Improved error reporting for method argument validation.The changes enhance the clarity of the error responses by collecting all field errors and constructing a comprehensive error message.
Line range hint
62-66: LGTM! Corrected error code for HTTP method not supported.The change aligns the error handling with more accurate HTTP semantics.
83-95: LGTM! Added structured error handling for unreadable HTTP messages.The new method provides consistent and informative feedback for
HttpMessageNotReadableException.
Line range hint
96-104: LGTM! Structured error handling for custom exceptions.The method provides consistent and informative feedback for
CustomException.src/test/java/taco/klkl/domain/product/domain/ProductTest.java (4)
Line range hint
80-104: LGTM! Updated display name for price handling.The change aligns the display name with the intended data type for price handling.
107-142: LGTM! Comprehensive test for updating product information.The test ensures that all product attributes are correctly updated when provided with a complete
ProductUpdateRequestDto.
144-179: LGTM! Test for partial update of product information.The test ensures that the product retains its original values for any attributes that are not included in the update request, while still updating the fields that are provided.
181-215: LGTM! Test for ignoring null values during product update.The test ensures that when all fields in the update DTO are
null, the product remains unchanged.src/test/java/taco/klkl/domain/product/service/ProductServiceTest.java (2)
157-200: LGTM! Test for successful product update.The test sets up a mock product repository to return an existing product when queried by its ID and verifies that the update logic functions correctly.
202-227: LGTM! Test for product update failure when product not found.The test verifies that a
ProductNotFoundExceptionis thrown when the product ID is not found in the repository.src/test/java/taco/klkl/global/error/GlobalExceptionHandlerTest.java (1)
120-143: LGTM!The new test method
httpMessageNotReadableOccurredis correctly implemented and ensures that theHttpMessageNotReadableExceptionis handled as expected.src/test/java/taco/klkl/domain/product/dto/request/ProductCreateRequestDtoTest.java (10)
30-42: LGTM!The test method
validProductCreateRequestDtois correctly implemented and verifies that a validProductCreateRequestDtopasses validation.
47-64: LGTM!The test method
nullProductNameis correctly implemented and verifies that aProductCreateRequestDtowith a null product name fails validation with the appropriate message.
68-86: LGTM!The test method
emptyProductNameis correctly implemented and verifies that aProductCreateRequestDtowith an empty product name fails validation with the appropriate message.
88-105: LGTM!The parameterized test method
productNameExceedsMaxLengthis correctly implemented and verifies that aProductCreateRequestDtowith a product name that exceeds the maximum length fails validation with the appropriate message.
109-126: LGTM!The test method
nullProductDescriptionis correctly implemented and verifies that aProductCreateRequestDtowith a null product description fails validation with the appropriate message.
130-148: LGTM!The test method
emptyProductDescriptionis correctly implemented and verifies that aProductCreateRequestDtowith an empty product description fails validation with the appropriate message.
150-167: LGTM!The parameterized test method
productDescriptionExceedsMaxLengthis correctly implemented and verifies that aProductCreateRequestDtowith a product description that exceeds the maximum length fails validation with the appropriate message.
170-188: LGTM!The parameterized test method
addressExceedsMaxLengthis correctly implemented and verifies that aProductCreateRequestDtowith an address that exceeds the maximum length fails validation with the appropriate message.
190-206: LGTM!The parameterized test method
negativePriceis correctly implemented and verifies that aProductCreateRequestDtowith a negative price fails validation with the appropriate message.
210-260: LGTM!The test methods
nullCityId,nullSubcategoryId, andnullCurrencyIdare correctly implemented and verify that aProductCreateRequestDtowith null values for cityId, subcategoryId, and currencyId, respectively, fail validation with the appropriate messages.src/test/java/taco/klkl/domain/product/controller/ProductControllerTest.java (4)
Line range hint
5-29:
LGTM!The new imports for
ProductUpdateRequestDtoandeqmatcher are correctly added. The setup method initializes mock objects forUserandProductappropriately.
98-106: LGTM!The test method
testCreateProductis correctly implemented and verifies that the product creation endpoint works as expected with valid data.
129-154: LGTM!The test method
testCreateProductValidationFailureis correctly implemented and verifies that the product creation endpoint returns the appropriate validation errors for invalid data.
156-192: LGTM!The test method
testUpdateProductis correctly implemented and verifies that the product update endpoint works as expected with valid data.
src/main/java/taco/klkl/global/common/constants/ProductValidationMessages.java
Show resolved
Hide resolved
π μ°κ΄λ μ΄μ
π μμ λ΄μ©
π³ μμ λΈλμΉλͺ
KL-68/μν-μ 보-μμ -api-ꡬνπΈ μ€ν¬λ¦°μ· (μ ν)
π¬ 리뷰 μꡬμ¬ν (μ ν)
Summary by CodeRabbit
New Features
Bug Fixes
Tests
Documentation