feat-be: 프로세스 목록 조회 API 필터링 및 정렬 구현 #756

github-actions · 2024-10-02T01:44:38Z

목적

프로세스 목록 조회 API에 필터링 및 정렬을 구현합니다.

작업 세부사항

평가 평균 점수 필터링 구현
평가 유무 필터링 구현
평가 평균 점수 정렬 구현
지원자의 지원 날짜 정렬 구현
테스트 코드 변경
API 문서 작업

참고 사항

필터링 기준과 정렬 기준은 다음과 같습니다.

[필터링 기준]

평가 평균 점수(averageScore)대별로 필터링할 수 있습니다.
- 예를 들어, 평가 평균 점수가 3.50~4.50 사이인 지원자 목록을 조회합니다.
- mixScore default = 0.00
- maxScore default = 5.00
평가 유무(evaluationStatus)로 필터링할 수 있습니다.
- default 값은 EvaluationStatus.ALL(필터링 적용 안 함)입니다.
- EvaluationStatus.NOT_EVALUATED: 평가가 없는 상태(evaluationCount = 0)입니다.
- EvaluationStatus.EVALUATED: 평가가 있는 상태(evaluationCount > 0)입니다.

[정렬 기준]

평가 평균 점수(averageScore)로 내림차순/오름차순 정렬을 할 수 있습니다.
- 기본 값은 desc입니다.
지원자의 지원 날짜(createdAt)로 내림차순/오름차순 정렬을 할 수 있습니다.
- 기본 값은 desc입니다.

아래의 별표줄 밑에 요구사항 ID만 작성해주세요. Prefix 금지!

PROC_READ_06

closes #755

+) 필드명 수정

github-actions · 2024-10-02T07:37:55Z

1727854674.677589

github-actions · 2024-10-02T07:39:27Z

📌 Test Coverage Report

Overall Project	79.05% `-0.02%`	❌
Files changed	98.48%	🍏

File	Coverage
EvaluationStatus.java	100%	🍏
ProcessFacade.java	100%	🍏
ProcessController.java	100%	🍏
ApplicantCardSorter.java	100%	🍏
ApplicantService.java	96.9%	🍏
ApplicantCardFilter.java	95.92% `-4.08%`	🍏

Chocochip101

안녕하세요, 냥인! 😸

필터링 기능 구현하느라 수고하셨습니다!

관련해서 리뷰 남겼으니, 확인해주세요!

backend/src/test/java/com/cruru/applicant/service/ApplicantCardFilterTest.java

backend/src/docs/asciidoc/process.adoc

backend/src/main/java/com/cruru/applicant/service/ApplicantCardFilter.java

backend/src/main/java/com/cruru/applicant/service/ApplicantCardSorter.java

backend/src/main/java/com/cruru/applicant/service/ApplicantService.java

backend/src/main/java/com/cruru/process/controller/ProcessController.java

backend/src/main/java/com/cruru/applicant/service/ApplicantCardFilter.java

backend/src/main/java/com/cruru/process/facade/ProcessFacade.java

HyungHoKim00

고생하셨습니다 냥인. 리뷰 남겨놓았으니 확인해주세요~

HyungHoKim00 · 2024-10-02T08:23:25Z

backend/src/main/java/com/cruru/applicant/service/ApplicantService.java

+        List<ApplicantCard> applicantCards = applicantRepository.findApplicantCardsByProcesses(processes);
+
+        return applicantCards.stream()
+                .filter(card -> ApplicantCardFilter.filterByScore(card, minScore, maxScore))


메서드를 보니 applicantCard에 로직이 있으면 깔끔했겠다는 생각은 드네용. DTO만 아니엿어도..

backend/src/main/java/com/cruru/process/controller/ProcessController.java

backend/src/main/java/com/cruru/applicant/service/ApplicantService.java

backend/src/main/java/com/cruru/process/controller/ProcessController.java

HyungHoKim00 · 2024-10-02T08:31:03Z

backend/src/test/java/com/cruru/applicant/service/ApplicantCardSorterTest.java

+                LocalDateTime.of(2024, 10, 2, 20, 0), false, 5, 3.00, 1L);
+        ApplicantCard applicantCard2 = new ApplicantCard(2L, "최냥인",
+                LocalDateTime.of(2024, 10, 3, 20, 0), false, 0, 0.00, 1L);
+        List<ApplicantCard> applicantCards = Arrays.asList(applicantCard1, applicantCard2);


Suggested change

List<ApplicantCard> applicantCards = Arrays.asList(applicantCard1, applicantCard2);

List<ApplicantCard> applicantCards = List.of(applicantCard1, applicantCard2);

들어가는 인자가 array라고 착각할 수도 있을 것 같아요~

정렬을 해야 해서 List.of()는 불가능입니다..ㅎ ㅎ

backend/src/main/java/com/cruru/applicant/service/ApplicantCardSorter.java

backend/src/test/java/com/cruru/process/facade/ProcessFacadeTest.java

+) 변수명 통일

ApplicantCard, DefaultFilterAndOrderFixture

- ApplicantCardFilter -> EvaluationStatus, ApplicantService - ApplicantCardSorter -> ApplicantSortOption

cutehumanS2 · 2024-10-03T02:19:59Z

@Chocochip101 @HyungHoKim00

[주요 변경 사항 요약]

EvaluationStatus의 필드명을 변경하였습니다.
- NO_EVALUATED -> NOT_EVALUATED
Enum으로 받던 파라미터를 String으로 받는 방식으로 변경하였습니다.
- 검증 로직을 추가하기 위함입니다.
- 기존 방식 그대로 Enum으로 받으면서 검증 로직을 추가하려면, 컨버터를 사용할 수 있을 듯합니다. 일단은 String으로 받고 Enum 클래스가 검증 로직을 갖게 하였습니다.
ApplicantCardFilter, ApplicantCardSorter가 갖고 있던 책임을 다른 곳으로 위임했습니다.
- ApplicantCardFilter -> EvaluationStatus, ApplicantService
- ApplicantCardSorter -> ApplicantSortOption
테스트 픽스처를 생성하였습니다: ApplicantCard, DefaultFilterAndOrderFixture
API 문서 잘 작성되었는지도 확인 부탁드려요.

Chocochip101

구현과 리팩터링 양이 꽤 되었을텐데, 고생 많으셨습니다 :)

간단한 리뷰 남겼는데, 엄청 중요한 부분은 아니여서 approve하겠습니다!

수고 많으셨어요!

backend/src/main/java/com/cruru/applicant/domain/EvaluationStatus.java

Chocochip101 · 2024-10-03T03:51:32Z

필수 유무가 표시되면 좋겠다는 생각이 드는데, 괜찮은 방법을 모르겠군요...🧐 description에 작성하면 너무 많은 정보가 담기는 느낌?

cutehumanS2 · 2024-10-03T05:18:47Z

@Chocochip101
저도 너무 이렇게 하고 싶은데, query-parameters.adoc에서 직접 수정한 내용 반영되게 하는 법 아시나요?

HyungHoKim00

고생하셨습니다 냥인. RESTDocs 관련 코멘트도 남겨놓았어요.

HyungHoKim00 · 2024-10-03T13:32:44Z

backend/src/main/java/com/cruru/applicant/domain/ApplicantSortOption.java

+import java.util.Arrays;
+import java.util.Comparator;
+
+public enum ApplicantSortOption {


raw type 에러가 뜨는 게 보기 싫어서 아래와 같이 바꿔보았는데 어떤가요..? 다른 방법도 좋습니다 그냥 노란 줄을 없애고 싶어요. (여러 번 시도해봤는데 어렵네요 제네릭 ㅠㅠ)

package com.cruru.applicant.domain; import com.cruru.applicant.domain.dto.ApplicantCard; import com.cruru.applicant.exception.badrequest.ApplicantSortException; import java.util.Arrays; import java.util.Comparator; public class ApplicantSortOption { public static Comparator<ApplicantCard> getCombinedComparator(String sortByCreatedAt, String sortByScore) { Comparator<ApplicantCard> createdAtComparator = CreatedAtSortOption.convertToComparator(sortByCreatedAt); Comparator<ApplicantCard> scoreComparator = ScoreSortOption.convertToComparator(sortByScore); return createdAtComparator.thenComparing(scoreComparator); } enum CreatedAtSortOption { ASC(Comparator.comparing(ApplicantCard::createdAt, Comparator.naturalOrder())), DESC(Comparator.comparing(ApplicantCard::createdAt, Comparator.reverseOrder())); private final Comparator<ApplicantCard> comparator; CreatedAtSortOption(Comparator<ApplicantCard> comparator) { this.comparator = comparator; } private static Comparator<ApplicantCard> convertToComparator(String sortOption) { return Arrays.stream(CreatedAtSortOption.values()) .filter(option -> option.name().equalsIgnoreCase(sortOption)) .findAny() .orElseThrow(ApplicantSortException::new) .comparator; } } enum ScoreSortOption { ASC(Comparator.comparing(ApplicantCard::averageScore, Comparator.naturalOrder())), DESC(Comparator.comparing(ApplicantCard::averageScore, Comparator.reverseOrder())); private final Comparator<ApplicantCard> comparator; ScoreSortOption(Comparator<ApplicantCard> comparator) { this.comparator = comparator; } private static Comparator<ApplicantCard> convertToComparator(String sortOption) { return Arrays.stream(ScoreSortOption.values()) .filter(option -> option.name().equalsIgnoreCase(sortOption)) .findAny() .orElseThrow(ApplicantSortException::new) .comparator; } } }

노란 줄.. 시각적 효과가 굉장하죠.
저도 없애보려다가 실패 좀 맛봤는데요.
이 부분은 좀 더 얘기를 나눠볼게요...

HyungHoKim00 · 2024-10-03T13:33:48Z

backend/src/test/java/com/cruru/process/controller/ProcessControllerTest.java

+                        requestCookies(cookieWithName("token").description("사용자 토큰")),
+                        queryParameters(
+                                parameterWithName("dashboardId").description("대시보드의 id"),
+                                parameterWithName("minScore").description("지원자 최소 평균 점수: 0.00(default) ~ 5.00"),


Suggested change

parameterWithName("minScore").description("지원자 최소 평균 점수: 0.00(default) ~ 5.00"),

parameterWithName("minScore").description("지원자 최소 평균 점수: 0.00(default) ~ 5.00").optional(),

optional() 필드를 추가하고 커스텀 스니펫을 생성하면 optional이 표시되도록 만들 수 있습니다.
참고

backend/src/main/java/com/cruru/applicant/service/ApplicantService.java

backend/src/main/java/com/cruru/applicant/domain/EvaluationStatus.java

matchesEvaluationStatus -> matches

Dobby-Kim

고생하셨습니다~~

로직보다는 굵직한 단위의 리뷰 남겼으니 확인해주세요 :>

Dobby-Kim · 2024-10-02T08:44:58Z

backend/src/main/java/com/cruru/applicant/service/ApplicantCardFilter.java

+import com.cruru.applicant.domain.EvaluationStatus;
+import com.cruru.applicant.domain.dto.ApplicantCard;
+
+public class ApplicantCardFilter {


Filter라는 클래스명을 사용하면 기존의 Spring의 Filter와 혼동 가능성이 있을 수 있으니 다른 이름을 고안해보시는건 어떨까요!

사실 저는 당장 생각이 나지는 않네요..ㅎㅎ

Dobby-Kim · 2024-10-04T00:32:49Z

backend/src/main/java/com/cruru/applicant/domain/dto/ApplicantCard.java

이제는 ApplicantCard가 DTO로서의 역할에서 많이 벗어난 것 같습니다!
ApplicantCard를 엔티티+도메인인 Applicant와 별개인 도메인으로 다루는 클래스로 따로 빼는 것이 좋지 않을까요?

또한 이 도메인을 Comparator interface를 상속받는 구현체로 만들어 compare 메서드를 오버라이딩하는 식으로 정렬 기준을 정해주면 전체 코드 복잡도를 줄일 수 있을 것 같습니다

Dobby-Kim · 2024-10-04T00:38:15Z

backend/src/main/java/com/cruru/process/controller/ProcessController.java

@@ -33,9 +33,17 @@ public class ProcessController {
    @RequireAuthCheck(targetId = "dashboardId", targetDomain = Dashboard.class)
    @GetMapping
    public ResponseEntity<ProcessResponses> read(
-            LoginProfile loginProfile, @RequestParam(name = "dashboardId") Long dashboardId


기존의 read 메서드를 변경한 이유가 있을까요?
기존 API와 분리되어야되지 않나 싶습니다!

또한, 이 정도 사이즈의 파라미터 개수이고, 변경될 Api라면 DTO로 요청을 처리하도록 변경하는 것이 어떨까요

Dobby-Kim · 2024-10-04T00:41:34Z

backend/src/main/java/com/cruru/applicant/domain/ApplicantSortOption.java

[참고]ApplicantCard에 남긴 리뷰와 연관됩니다!

ApplicantCard를 DTO와 분리된 도메인 클래스로 취급하고 Comparator interface를 구현하도록 만들면 이 클래스에서 Compartor 반환 책임을 분리할 수 있을 것 같습니다

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: cutehumanS2 <oddpinkjadeite@gmail.com>

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Kwoun Ki Ho <fingercut3822@gmail.com> feat-be: 프로세스 목록 조회 API 필터링 및 정렬 구현 (#756) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: cutehumanS2 <oddpinkjadeite@gmail.com> feat-be: 다중 불합격자 해제 기능 구현 (#759) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Kwoun Ki Ho <fingercut3822@gmail.com> feat-be: 대시보드 삭제 api 구현 (#749) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: HyungHoKim00 <hkim1109@naver.com> fix-be: 예외 처리 과정에서 NPE가 발생하지 않도록 수정 (#753) feat-be: 다중 불합격자 기능 구현 (#751) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Kwoun Ki Ho <fingercut3822@gmail.com> chore-be(Actions-Prod): 무중단 배포 설정 수정

82a5d2d (HEAD -> be/main, origin/be/main) fix-be: OSIV 오류 해결 (#746) 7434b61 feat-be: 프로세스 목록 조회 API 필터링 및 정렬 구현 (#756) 2e05f2b feat-be: 다중 불합격자 해제 기능 구현 (#759) 4c60d92 feat-be: 대시보드 삭제 api 구현 (#749) fbbfee5 fix-be: 예외 처리 과정에서 NPE가 발생하지 않도록 수정 (#753) a55783d feat-be: 다중 불합격자 기능 구현 (#751) 071cebc chore-be(Actions-Prod): 무중단 배포 설정 수정

Create draft PR for #755

4f5fdba

github-actions bot added backend 백엔드 feature 새로운 기능 labels Oct 2, 2024

github-actions bot assigned cutehumanS2 Oct 2, 2024

github-actions bot added this to the 스프린트 5.0 milestone Oct 2, 2024

cutehumanS2 added 4 commits October 2, 2024 14:54

feat: 프로세스 조회 API 필터링 및 정렬 구현

9a3c248

refactor: 평가 유무 상태를 Enum으로 관리

a84ee9b

refactor: 지원자 카드 Filter 및 Sorter 클래스 분리

9ca0fc4

docs: API 문서 추가

1b0d75e

+) 필드명 수정

cutehumanS2 marked this pull request as ready for review October 2, 2024 07:37

cutehumanS2 requested review from Chocochip101, HyungHoKim00, xogns1514 and Dobby-Kim and removed request for Chocochip101 October 2, 2024 07:38

Chocochip101 requested changes Oct 2, 2024

View reviewed changes

HyungHoKim00 reviewed Oct 2, 2024

View reviewed changes

cutehumanS2 added 9 commits October 2, 2024 17:44

refactor: 조건 순서 변경

5691888

style: 코드 컨벤션 준수

5cdc879

+) 변수명 통일

refactor: Collectors.toList() -> toList()

973a731

test: 텍스트 픽스처 생성

8a8c625

ApplicantCard, DefaultFilterAndOrderFixture

refactor: Enum 필드명 변경

602163f

docs: API 문서 변경

07393da

refactor: 정렬 조건 상수화

a051ea8

feat: 예외 검증 추가, 필터링 및 정렬 책임 위임

6cf3ed5

- ApplicantCardFilter -> EvaluationStatus, ApplicantService - ApplicantCardSorter -> ApplicantSortOption

test: 테스트 데이터 추가

2c4025e

cutehumanS2 requested review from HyungHoKim00 and Chocochip101 October 3, 2024 02:20

test: Default 정렬 조건 변경

3473dd7

Chocochip101 approved these changes Oct 3, 2024

View reviewed changes

backend/src/main/java/com/cruru/applicant/domain/EvaluationStatus.java Outdated Show resolved Hide resolved

refactor: 메서드 분리

5fc181b

HyungHoKim00 requested changes Oct 3, 2024

View reviewed changes

cutehumanS2 added 2 commits October 4, 2024 09:39

refactor: 불필요한 this 키워드 제거

eb68ad2

refactor: 메서드명 변경

d6f5f7f

matchesEvaluationStatus -> matches

Dobby-Kim requested changes Oct 4, 2024

View reviewed changes

docs: requestParam 필수 여부 포함

d40ee73

HyungHoKim00 approved these changes Oct 4, 2024

View reviewed changes

Dobby-Kim approved these changes Oct 4, 2024

View reviewed changes

cutehumanS2 merged commit f430017 into be/develop Oct 4, 2024
10 checks passed

cutehumanS2 deleted the be-755-PROC_READ_06 branch October 4, 2024 02:26

Dobby-Kim mentioned this pull request Oct 5, 2024

[BE] Release-HotFix: Cruru v1.1.1 #768

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat-be: 프로세스 목록 조회 API 필터링 및 정렬 구현 #756

feat-be: 프로세스 목록 조회 API 필터링 및 정렬 구현 #756

github-actions bot commented Oct 2, 2024 •

edited by cutehumanS2

Loading

github-actions bot commented Oct 2, 2024

github-actions bot commented Oct 2, 2024

Chocochip101 left a comment

HyungHoKim00 left a comment

HyungHoKim00 Oct 2, 2024

cutehumanS2 Oct 2, 2024

HyungHoKim00 Oct 2, 2024

cutehumanS2 Oct 2, 2024

cutehumanS2 commented Oct 3, 2024

Chocochip101 left a comment

Chocochip101 commented Oct 3, 2024

cutehumanS2 commented Oct 3, 2024

HyungHoKim00 left a comment

HyungHoKim00 Oct 3, 2024

cutehumanS2 Oct 4, 2024

HyungHoKim00 Oct 3, 2024

Dobby-Kim left a comment

Dobby-Kim Oct 2, 2024

Dobby-Kim Oct 4, 2024

Dobby-Kim Oct 4, 2024

Dobby-Kim Oct 4, 2024

	List<ApplicantCard> applicantCards = Arrays.asList(applicantCard1, applicantCard2);
	List<ApplicantCard> applicantCards = List.of(applicantCard1, applicantCard2);

	parameterWithName("minScore").description("지원자 최소 평균 점수: 0.00(default) ~ 5.00"),
	parameterWithName("minScore").description("지원자 최소 평균 점수: 0.00(default) ~ 5.00").optional(),

feat-be: 프로세스 목록 조회 API 필터링 및 정렬 구현 #756

feat-be: 프로세스 목록 조회 API 필터링 및 정렬 구현 #756

Conversation

github-actions bot commented Oct 2, 2024 • edited by cutehumanS2 Loading

목적

작업 세부사항

참고 사항

github-actions bot commented Oct 2, 2024

github-actions bot commented Oct 2, 2024

📌 Test Coverage Report

Chocochip101 left a comment

Choose a reason for hiding this comment

HyungHoKim00 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cutehumanS2 commented Oct 3, 2024

Chocochip101 left a comment

Choose a reason for hiding this comment

Chocochip101 commented Oct 3, 2024

cutehumanS2 commented Oct 3, 2024

HyungHoKim00 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Dobby-Kim left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Oct 2, 2024 •

edited by cutehumanS2

Loading