[YS-284] feat: 실험 공고 전체 조회 최신순/오래된순 옵션 추가 #91
Merged
+32
−16
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- infrastructure 계층에서 query에 order 조건 추가 - domain 계층의 gateway에 파라미터 추가
- application 계층에서 파라미터값 추가
- presentation 계층에서의 sort 필드 추가
Walkthrough이번 PR은 실험 포스트 정렬 순서를 제어하기 위해 전 계층에 "order" 파라미터를 추가하고, 해당 입력값의 유효성을 검증하는 로직을 도입합니다. ExperimentPostService에서는 getExperimentPosts 및 getMyExperimentPosts 메소드에 sort order 검증(validateSortOrder) 절차가 추가되었으며, UseCase, Gateway, Repository, Controller, Mapper, 그리고 테스트 코드에서 메소드 시그니처가 업데이트되어 order 파라미터("DESC" 기본값)를 반영하도록 수정되었습니다. 잘못된 정렬 값 입력 시 예외가 발생하여 오류를 사전에 방지합니다. Changes
Sequence Diagram(s)sequenceDiagram
participant C as 클라이언트
participant Ctrl as ExperimentPostController
participant S as ExperimentPostService
participant UC as GetExperimentPostsUseCase
participant GW as ExperimentPostGateway
participant Repo as ExperimentPostCustomRepository
C->>Ctrl: GET /experiment-posts?order=...
Ctrl->>S: getExperimentPosts(order 포함 요청)
S->>S: validateSortOrder(order) 호출
S->>UC: use case 호출 (order 포함)
UC->>GW: findExperimentPostsByCustomFilter(filter, pagination, order)
GW->>Repo: 데이터 조회 (order 포함)
Repo-->>GW: 정렬된 결과 반환
GW-->>UC: 결과 반환
UC-->>S: 결과 반환
S-->>Ctrl: 응답 반환
Ctrl-->>C: HTTP 응답 전송
Possibly related PRs
Suggested labels
Suggested reviewers
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? 🪧 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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (6)
src/main/kotlin/com/dobby/backend/infrastructure/database/repository/ExperimentPostCustomRepository.kt (1)
12-16: 메서드 시그니처가 일관성 있게 업데이트되었습니다.order 파라미터가 기존 findExperimentPostsByMemberIdWithPagination 메서드와 동일한 방식으로 추가되었습니다.
order 파라미터에 대한 KDoc 문서를 추가하는 것이 좋겠습니다:
fun findExperimentPostsByCustomFilter( customFilter: CustomFilter, pagination: Pagination, + /** 정렬 순서 ("ASC" 또는 "DESC") */ order: String ): List<ExperimentPostEntity>?src/main/kotlin/com/dobby/backend/application/usecase/experiment/GetExperimentPostsUseCase.kt (1)
41-45: PaginationInput에 정렬 순서가 적절하게 추가되었습니다.기본값이 "DESC"로 설정된 것이 일반적인 사용 패턴과 일치합니다.
문자열 대신 enum을 사용하면 타입 안전성이 향상될 것 같습니다:
enum class SortOrder { ASC, DESC } data class PaginationInput( val page: Int = 1, val count: Int = 6, val order: SortOrder = SortOrder.DESC )src/main/kotlin/com/dobby/backend/application/service/ExperimentPostService.kt (1)
116-121: validateSortOrder 메서드의 반환값이 사용되지 않습니다.메서드가 검증된 정렬 순서를 반환하고 있지만, 호출하는 곳에서 이 값을 사용하지 않습니다. 반환값이 불필요하다면 Unit을 반환하도록 수정하는 것이 좋습니다.
다음과 같이 수정을 제안합니다:
- private fun validateSortOrder(sortOrder: String): String { + private fun validateSortOrder(sortOrder: String) { - return when (sortOrder) { + when (sortOrder) { - "ASC", "DESC" -> sortOrder + "ASC", "DESC" -> Unit else -> throw InvalidRequestValueException } }src/main/kotlin/com/dobby/backend/presentation/api/controller/ExperimentPostController.kt (2)
158-159: 정렬 순서 파라미터가 적절히 추가되었습니다.기본값이 "DESC"로 설정되어 있어 기존 동작과의 하위 호환성이 유지됩니다. 하지만 Swagger 문서에 정렬 순서 파라미터에 대한 설명이 누락되어 있습니다.
Operation 어노테이션의 description에 정렬 순서 파라미터에 대한 설명을 추가하는 것을 제안합니다:
@Operation( summary = "공고 전체 조회 API - 필터링 + 페이지네이션 적용" , - description = "사용자가 필터링한 조건에 맞는 공고 목록들을 조회합니다" + description = "사용자가 필터링한 조건에 맞는 공고 목록들을 조회합니다. order 파라미터로 정렬 순서를 지정할 수 있습니다 (ASC: 오래된순, DESC: 최신순)." )
181-181: 정렬 순서 파라미터가 적절히 추가되었습니다.기본값이 "DESC"로 설정되어 있어 기존 동작과의 하위 호환성이 유지됩니다. 하지만 Swagger 문서에 정렬 순서 파라미터에 대한 설명이 누락되어 있습니다.
Operation 어노테이션의 description에 정렬 순서 파라미터에 대한 설명을 추가하는 것을 제안합니다:
@Operation( summary = "연구자가 작성한 실험 공고 리스트 조회", - description = "로그인한 연구자가 작성한 실험 공고 리스트를 반환합니다" + description = "로그인한 연구자가 작성한 실험 공고 리스트를 반환합니다. order 파라미터로 정렬 순서를 지정할 수 있습니다 (ASC: 오래된순, DESC: 최신순)." )src/main/kotlin/com/dobby/backend/infrastructure/database/repository/ExperimentPostCustomRepositoryImpl.kt (1)
139-146: getOrderClause 메서드가 잘 구현되었습니다.정렬 순서에 따라 적절한 OrderSpecifier를 반환하도록 구현되었습니다. 하지만 이미 서비스 계층에서 검증된 값이라도 안전성을 위해 else 분기에서 기본값을 반환하는 것이 좋습니다.
다음과 같이 수정을 제안합니다:
private fun getOrderClause(order: String): OrderSpecifier<*> { val post = QExperimentPostEntity.experimentPostEntity - return if (order == "ASC") { - post.createdAt.asc() - } else { - post.createdAt.desc() - } + return when (order) { + "ASC" -> post.createdAt.asc() + else -> post.createdAt.desc() + } }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (9)
src/main/kotlin/com/dobby/backend/application/service/ExperimentPostService.kt(1 hunks)src/main/kotlin/com/dobby/backend/application/usecase/experiment/GetExperimentPostsUseCase.kt(2 hunks)src/main/kotlin/com/dobby/backend/domain/gateway/experiment/ExperimentPostGateway.kt(1 hunks)src/main/kotlin/com/dobby/backend/infrastructure/database/repository/ExperimentPostCustomRepository.kt(1 hunks)src/main/kotlin/com/dobby/backend/infrastructure/database/repository/ExperimentPostCustomRepositoryImpl.kt(2 hunks)src/main/kotlin/com/dobby/backend/infrastructure/gateway/experiment/ExperimentPostGatewayImpl.kt(1 hunks)src/main/kotlin/com/dobby/backend/presentation/api/controller/ExperimentPostController.kt(1 hunks)src/main/kotlin/com/dobby/backend/presentation/api/mapper/ExperimentPostMapper.kt(1 hunks)src/test/kotlin/com/dobby/backend/application/usecase/experiment/GetExperimentPostsUseCaseTest.kt(6 hunks)
🧰 Additional context used
📓 Learnings (4)
📓 Common learnings
Learnt from: Ji-soo708
PR: YAPP-Github/25th-Web-Team-2-BE#53
File: src/main/kotlin/com/dobby/backend/presentation/api/mapper/ExperimentPostMapper.kt:329-329
Timestamp: 2025-01-23T05:23:06.631Z
Learning: In the ExperimentPostService class, order parameter validation is performed in the service layer through the validateSortOrder method, which ensures the value is either "ASC" or "DESC" and throws InvalidParameterException for invalid values.
src/main/kotlin/com/dobby/backend/application/service/ExperimentPostService.kt (1)
Learnt from: Ji-soo708
PR: YAPP-Github/25th-Web-Team-2-BE#53
File: src/main/kotlin/com/dobby/backend/presentation/api/mapper/ExperimentPostMapper.kt:329-329
Timestamp: 2025-01-23T05:23:06.631Z
Learning: In the ExperimentPostService class, order parameter validation is performed in the service layer through the validateSortOrder method, which ensures the value is either "ASC" or "DESC" and throws InvalidParameterException for invalid values.
src/main/kotlin/com/dobby/backend/presentation/api/mapper/ExperimentPostMapper.kt (1)
Learnt from: Ji-soo708
PR: YAPP-Github/25th-Web-Team-2-BE#53
File: src/main/kotlin/com/dobby/backend/presentation/api/mapper/ExperimentPostMapper.kt:329-329
Timestamp: 2025-01-23T05:23:06.631Z
Learning: In the ExperimentPostService class, order parameter validation is performed in the service layer through the validateSortOrder method, which ensures the value is either "ASC" or "DESC" and throws InvalidParameterException for invalid values.
src/main/kotlin/com/dobby/backend/infrastructure/database/repository/ExperimentPostCustomRepositoryImpl.kt (2)
Learnt from: chock-cho
PR: YAPP-Github/25th-Web-Team-2-BE#51
File: src/main/kotlin/com/dobby/backend/infrastructure/database/repository/ExperimentPostCustomRepositoryImpl.kt:138-182
Timestamp: 2025-01-23T08:12:48.950Z
Learning: In the experiment post system, optimistic locking is unnecessary as posts can only be modified by their original authors, making concurrent modification impossible. Over-engineering should be avoided when existing access controls provide sufficient data integrity.
Learnt from: chock-cho
PR: YAPP-Github/25th-Web-Team-2-BE#77
File: src/main/kotlin/com/dobby/backend/infrastructure/database/repository/ExperimentPostCustomRepositoryImpl.kt:213-213
Timestamp: 2025-02-04T14:53:30.154Z
Learning: The hardcoded time (8:01 AM) in `ExperimentPostCustomRepositoryImpl.lastProcessedTime` is an intentional business requirement for processing experiment posts from the previous day.
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build
🔇 Additional comments (10)
src/main/kotlin/com/dobby/backend/domain/gateway/experiment/ExperimentPostGateway.kt (1)
14-14: 게이트웨이 인터페이스가 적절하게 업데이트되었습니다.order 파라미터가 repository 계층과 일관되게 추가되었습니다.
src/main/kotlin/com/dobby/backend/application/usecase/experiment/GetExperimentPostsUseCase.kt (1)
74-78: 게이트웨이 호출이 올바르게 업데이트되었습니다.pagination과 함께 order 파라미터가 일관되게 전달됩니다.
src/main/kotlin/com/dobby/backend/infrastructure/gateway/experiment/ExperimentPostGatewayImpl.kt (1)
27-37: 게이트웨이 구현이 인터페이스와 일관되게 업데이트되었습니다.order 파라미터가 repository 계층으로 올바르게 전달됩니다.
src/main/kotlin/com/dobby/backend/application/service/ExperimentPostService.kt (2)
46-47: 정렬 순서 검증이 적절히 추가되었습니다.필터 검증 후에 정렬 순서 검증이 순차적으로 이루어지도록 잘 구현되었습니다.
108-109: 정렬 순서 검증이 적절히 추가되었습니다.내 실험 공고 조회에도 정렬 순서 검증이 일관성 있게 적용되었습니다.
src/main/kotlin/com/dobby/backend/infrastructure/database/repository/ExperimentPostCustomRepositoryImpl.kt (2)
36-40: 메서드 시그니처가 적절히 업데이트되었습니다.정렬 순서 파라미터가 일관성 있게 추가되었습니다.
64-68: 메서드 시그니처가 적절히 업데이트되었습니다.정렬 순서 파라미터가 일관성 있게 추가되었습니다.
src/test/kotlin/com/dobby/backend/application/usecase/experiment/GetExperimentPostsUseCaseTest.kt (1)
98-100: Mock 설정이 적절히 업데이트되었습니다.정렬 순서 파라미터가 올바르게 전달되도록 설정되어 있습니다.
src/main/kotlin/com/dobby/backend/presentation/api/mapper/ExperimentPostMapper.kt (2)
286-296: 정렬 파라미터가 추가된 것을 확인했습니다.
order파라미터가PaginationInput에 올바르게 전달되고 있습니다. 서비스 레이어에서validateSortOrder메소드를 통해 유효성 검증이 이루어지는 것을 확인했습니다.
435-443: 정렬 파라미터가 일관성 있게 적용되었습니다.
GetMyExperimentPostsUseCase에도 동일한 방식으로order파라미터가 추가되어 일관성이 유지되었습니다.
Comment on lines
+39
to
40
| val pagination = PaginationInput(page = 1, count = 6, order = "DESC") | ||
| val input = Input(customFilter, pagination) |
There was a problem hiding this comment.
🛠️ Refactor suggestion
테스트 입력값이 적절히 업데이트되었습니다.
정렬 순서 파라미터가 기본값 "DESC"로 설정되어 있습니다. 하지만 "ASC" 정렬 순서에 대한 테스트 케이스가 누락되어 있습니다.
오름차순 정렬에 대한 테스트 케이스를 추가하는 것을 제안합니다:
given("오름차순 정렬이 주어졌을 때") {
val customFilter = CustomFilterInput(
matchType = MatchType.ALL,
studyTarget = null,
locationTarget = null,
recruitStatus = RecruitStatus.ALL
)
val pagination = PaginationInput(page = 1, count = 6, order = "ASC")
val input = Input(customFilter, pagination)
val mockPost1 = // ... create mock post with earlier date
val mockPost2 = // ... create mock post with later date
every {
experimentPostGateway.findExperimentPostsByCustomFilter(
any(),
Pagination(pagination.page, pagination.count),
pagination.order
)
} returns listOf(mockPost1, mockPost2)
`when`("execute가 호출되면") {
val result = useCase.execute(input)
then("오름차순으로 정렬된 결과가 반환된다") {
result.size shouldBe 2
result[0].postInfo.title shouldBe mockPost1.title
result[1].postInfo.title shouldBe mockPost2.title
}
}
}
Ji-soo708
approved these changes
Feb 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
💡 작업 내용
GetExperimentPostsUseCase에 정렬값(최신순, 오래된순)을 조회하는 기능을 추가하였습니다.최신순 정렬 - order =
DESC오래된순 정렬 - order =
ASC✅ 셀프 체크리스트
🙋🏻 확인해주세요
🔗 Jira 티켓
https://yappsocks.atlassian.net/browse/YS-284
Summary by CodeRabbit