feat: Recruitment 생성 API 구현 #345

Sangwook02 · 2024-05-22T13:04:09Z

🌱 관련 이슈

close ✨ Recruitment 생성 API 구현 #333

📌 작업 내용 및 특이사항

~~academicYear와 semesterType을 dto로 받을지 고민이었는데 일단은 모집기간 시작일을 기준으로 서버에서 처리하도록 구현했습니다.~~
- dto로 입력 받는다면 모집기간 시작일과 어긋나지 않는지 (예를 들어, 모집 기간 시작일은 24년 2월인데 academicYear와 semesterType을 2023, SECOND로 입력한 경우) 검증이 필요해지므로,
  서버에서 직접 처리하는게 좋다고 판단했습니다.
- ~~semesterType은 시작일의 Month를 기준으로 1 ~ 6월은 FIRST, 7 ~ 12월은 SECOND가 되도록 했습니다.~~
검증해야 할 사항은 아래와 같습니다.
1. 기간이_중복되는_Recruitment가_있다면_실패한다
2. 신청 시작일과 종료일은 모두 미래의 시점이다.
3. 신청 시작일과 종료일의 year가 dto의 academicYear와 일치하는가
4. 신청 시작일과 종료일의 학기가 dto의 semesterType과 일치하는가
5. 신청 시작일과 종료일이 학기 시작일(3/1 혹은 9/1)로부터 2주 이내에 있는가

ii의 경우 dto에서 어노테이션으로 검증되는 부분이라 test를 작성하지는 않았습니다.

📝 참고사항

1차 모집 기간의 직전일에 기존 REGULAR 회원들을 모두 ASSOCIATE로 강등시키는 로직이 빠져있습니다.
이 부분은 코드 몇 줄로 끝나지 않을 것 같고 별도 이슈로 만들어 처리하는게 pr 리뷰하시기에 편할 것 같아서 todo 주석만 남겨뒀습니다.

📚 기타

github-actions · 2024-05-22T13:05:01Z

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	✅

AlmondBreez3

lgtm

AlmondBreez3 · 2024-05-25T07:33:47Z

src/main/java/com/gdschongik/gdsc/domain/recruitment/api/AdminRecruitmentController.java

+import org.springframework.web.bind.annotation.RestController;
+
+@Tag(name = "Admin Recruitment", description = "어드민 리쿠르트먼트 관리 API입니다.")
+@RestController


저희 근데 리크루팅으로 하자고 하지 않았나용? 기억이 안나네욥

너무 길다고 '리쿠르팅' 쓰기로 했던 것 같아요.
테이블 명이랑 안 맞는게 좀 아쉽긴하지만 swagger 문서에는 모두 리쿠르팅으로 변경하겠습니다.

++ 영문은 recruitment로 두는게 api 경로랑 혼동이 적겠죠?

넵넵 리크루팅은 단지 프론트/기획/백엔드 용어 통일을 위해 정한 것 같고 영어로 recruitment는 이게 리쿠르팅이다 라는것을 저희가 백끼리 이해만 하면될거같아요

github-actions · 2024-05-26T12:03:00Z

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	✅

uwoobeat · 2024-05-28T12:11:16Z

src/main/java/com/gdschongik/gdsc/domain/common/model/SemesterType.java

@@ -10,4 +11,11 @@ public enum SemesterType {
    SECOND("2학기");

    private final String value;
+
+    public static SemesterType from(LocalDateTime dateTime) {
+        if (dateTime.getMonthValue() < 7) {


해당 조건도 추출해서 의미있는 이름으로 만들면 좋을듯 합니다.

그리고 semesterType에 대한 정책도 달라져야 할 것 같습니다.
학기의 시작은 3월 1일이므로 해당 기준에 맞춰서 설정되어야 하고,

이때 유의해야 할 점은 recruitment의 startDate와 endDate는 학기 시작일 이전일 수 있다는 겁니다. 가령 3월에 1학기 시작이 이루어지더라도, 모집일 자체는 2월일 수 있겠지요. 이러한 부분을 고려하여 구현하셔야 합니다.

그리고 해당 정책도 적절히 문서화해서 공유할 수 있는 방법을 찾아봐야 할듯 합니다.

uwoobeat · 2024-05-28T12:12:27Z

src/main/java/com/gdschongik/gdsc/domain/recruitment/dto/request/RecruitmentCreateRequest.java

+import java.time.LocalDateTime;
+
+public record RecruitmentCreateRequest(
+        @NotBlank @Schema(description = "이름") String name,


학년 / 학기 정보를 클라이언트로부터 받는게 낫지 않을까요?
그리고 시작일 / 종료일이 해당 학년 / 학기 정보에 대하여 유효한지 validate만 하면 될 것 같습니다.

Sangwook02 · 2024-05-29T13:18:26Z

정회원들을 준회원으로 강등하는 로직이 빠졌네요.
작업 후에 다시 리뷰 요청 드리겠습니다.

github-actions · 2024-06-01T12:09:47Z

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	✅

uwoobeat · 2024-06-02T10:06:15Z

src/main/java/com/gdschongik/gdsc/domain/common/model/SemesterType.java

@@ -10,4 +14,30 @@ public enum SemesterType {
    SECOND("2학기");

    private final String value;
+
+    public static SemesterType from(LocalDateTime dateTime) {
+        return getSemesterType(dateTime);


분리하신 이유가 있나요?

해당 조건도 추출해서 의미있는 이름으로 만들면 좋을듯 합니다.

분리하자는 의미 아니었나요?

uwoobeat · 2024-06-02T10:06:33Z

src/main/java/com/gdschongik/gdsc/domain/common/model/SemesterType.java

+
+    private static SemesterType getSemesterType(LocalDateTime dateTime) {
+        int year = dateTime.getYear();
+        LocalDateTime firstSemesterStartDate = LocalDateTime.of(year, 3, 1, 0, 0, 0);


매직 넘버는 상수로 추출해주세요~
ex) 3월 1일, 2주, 7월

3월 1일과 9월 1은 아래와 같이 처리하면 좋을 것 같네요👍👍

public enum SemesterType { FIRST("1학기", MonthDay.of(3, 1)), SECOND("2학기", MonthDay.of(9, 1)); private final String value; private final MonthDay startDate; }

github-actions · 2024-06-02T13:59:33Z

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	✅

github-actions · 2024-06-02T14:01:48Z

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	✅

github-actions · 2024-06-02T14:04:26Z

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	✅

github-actions · 2024-06-02T14:18:47Z

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	✅

uwoobeat · 2024-06-02T14:59:32Z

src/main/java/com/gdschongik/gdsc/domain/common/model/SemesterType.java


    private final String value;
+    private final MonthDay startDate;
+
+    public static SemesterType from(LocalDateTime dateTime) {


해당 메서드가 적절한 책임을 가지지 못하는 것 같습니다.

저라면 이 메서드를 보고 "대충 enum 멤버로 학기 시작일이 있으니까, 인자로 받은 dateTime이 학기 시작일 ~ 종료일 사이이면 해당 학기타입을 반환하겠구나?" 라고 생각할 것 같아요.

그런데 실제 로직을 보면 학기 시작일 2주 전에 해당하는 dateTime도 해당 학기타입으로 매핑해주고 있습니다. 이렇게 하면 처음 보는 사람은 조금 혼란스러울 것 같다는 생각이 듭니다.

저희가 이렇게 했던 이유가 뭐였나요? 인자로 들어오는 값이 리쿠르팅의 시작일과 마감일이었기 때문이었죠.

여기서 두 가지 문제가 있는데요,

SemesterType의 내부 로직이, 이러한 리쿠르팅에 의존적인 컨텍스트 정보를 알 필요가 없고, 안다 하더라도 리쿠르팅이 가져야 할 책임을 학기타입이 가져가는 것이기 때문에 SRP 위반이고요,

SemesterType::from 으로 들어오는 값이 항상 리쿠르팅의 시작일과 마감일이라는 보장이 없다는 겁니다. 다른 로직에서 언제든지 실수하고 아, LocalDateTime을 SemesterType으로 매핑해주는 정적 메서드구나 하고 쓸 여지가 많습니다.

2번의 경우 인자를 Recruitment로 받거나 하면 해결될 수 있지만 1번을 해결 못했기 때문에 근본적인 해결책은 아니죠.
결국 학기타입 매핑 로직은 리쿠르팅 서비스로 빼내는 것이 적절해보입니다.

그렇네요.
저도 SemesterType.from이 항상 LocalDateTime만 받는게 맞을지, 그리고 받는 LocalDateTime에 대해 항상 같은 로직으로 SemesterType을 반환하는게 맞을지에 대한 고민이 있었는데 서비스로 옮기니 마음에 걸리던데 해소된 느낌이네요👍

uwoobeat · 2024-06-02T15:02:04Z

src/main/java/com/gdschongik/gdsc/domain/common/model/SemesterType.java

+        LocalDateTime secondSemesterStartDate =
+                LocalDateTime.of(year, SECOND.startDate.getMonth(), SECOND.startDate.getDayOfMonth(), 0, 0);
+
+        if (dateTime.isAfter(firstSemesterStartDate.minusWeeks(TWO_WEEKS)) && dateTime.getMonthValue() < JULY) {


그리고, "리쿠르팅의 경우 개강일 전에 시작하므로, 리쿠르팅 시작일이 2주 전이더라도 1학기로 매핑한다" 같은 식의 컨텍스트 정보를 주석에 쓰는 것도 나쁘지 않을 것 같아요. 저는 정책적인 부분은 주석으로 남기는 거 충분히 의미있다고 생각합니다.

리쿠르팅 시작이 2주 전이라는 것도 뭔가 빡빡해보이는데, 2주로 할지 4주로 할지에 대한 것도 운영진 쪽에서 컨펌받고 진행해야 하지 않을까 싶네요~

앞뒤로 2주라는 기간은 운영진과 협의해서 정한 부분입니다!

github-actions · 2024-06-03T05:18:40Z

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	✅

github-actions · 2024-06-03T05:33:15Z

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	✅

uwoobeat · 2024-06-03T13:29:56Z

src/main/java/com/gdschongik/gdsc/domain/recruitment/api/AdminRecruitmentController.java

+
+@Tag(name = "Admin Recruitment", description = "어드민 리쿠르팅 관리 API입니다.")
+@RestController
+@RequestMapping("/admin/recruitment")


Suggested change

@RequestMapping("/admin/recruitment")

@RequestMapping("/admin/recruitments")

uwoobeat · 2024-06-03T13:34:29Z

src/main/java/com/gdschongik/gdsc/domain/recruitment/application/AdminRecruitmentService.java

+        /*
+        개강일 기준으로 2주 전까지는 같은 학기로 간주한다.
+         */
+        if (dateTime.isAfter(firstSemesterStartDate.minusWeeks(TWO_WEEKS)) && dateTime.getMonthValue() < JULY) {


해당 상수명을 TWO_WEEKS로 하면 나중에 3주나 4주로 정책이 변경되었을 때 상수명을 전부 바꿔야 하지 않을까요?
상수에도 적절한 이름을 붙여야 할 것 같습니다.

해당 기간을 학기 준비 기간이라는 이름으로 정책에 추가했습니다.

github-actions · 2024-06-04T01:32:12Z

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	✅

uwoobeat · 2024-06-04T13:04:03Z

src/main/java/com/gdschongik/gdsc/domain/recruitment/application/AdminRecruitmentService.java

+        /*
+        개강일 기준으로 2주 전까지는 같은 학기로 간주한다.
+         */
+        if (dateTime.isAfter(firstSemesterStartDate.minusWeeks(PRE_SEMESTER_TERM)) && dateTime.getMonthValue() < JULY) {


JULY 대신 java에서 제공하는 Month를 사용하면 좋을 것 같습니다.

uwoobeat · 2024-06-04T13:04:26Z

src/main/java/com/gdschongik/gdsc/global/common/constant/TemporalConstant.java

+    public static final int JULY = 7;
+
+    // 학기 준비 기간
+    public static final int PRE_SEMESTER_TERM = 2;


'주' 단위라는 것도 명시되어야 할 것 같습니다.

uwoobeat

lgtm
위 내용만 수정하시면 될 것 같습니다.

uwoobeat · 2024-06-04T13:05:27Z

src/main/java/com/gdschongik/gdsc/global/exception/ErrorCode.java

@@ -66,7 +66,12 @@ public enum ErrorCode {
    // Recruitment
    DATE_PRECEDENCE_INVALID(HttpStatus.BAD_REQUEST, "종료일이 시작일과 같거나 앞설 수 없습니다."),
    RECRUITMENT_NOT_OPEN(HttpStatus.CONFLICT, "리크루트먼트 모집기간이 아닙니다."),
-    RECRUITMENT_NOT_FOUND(HttpStatus.NOT_FOUND, "열려있는 리크루트먼트가 없습니다.");
+    RECRUITMENT_NOT_FOUND(HttpStatus.NOT_FOUND, "열려있는 리크루트먼트가 없습니다."),


한글 워딩은 '리쿠르팅'으로 통일해야 합니다. 해당 건은 별도 이슈로 작업하셔도 됩니다

전범위로 검색해보니 여기에만 있네요
자잘한 부분이니 여기서 처리할게요
꼼꼼히 봐주셔서 감사드려요

github-actions · 2024-06-04T13:16:13Z

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	✅

Sangwook02 added 7 commits May 17, 2024 12:26

test: 모집기간이 중복되는 케이스에 대한 검증 추가

444386b

test: 서비스를 테스트 하도록 수정

157743b

rename: ErrorCode 수정

823db4c

resolve: merge conflict

77db96c

style: spotless apply

e688ec2

test: 모집 기간 중복을 검증하기 위한 테스트 추가

11604e9

feat: Recruitment 생성 api 구현

3ab5f5a

Sangwook02 added ✨ feature 새로운 기능 추가 및 수정 ⚓ Domain: Recruitment 리쿠르트먼트 관련 작업 labels May 22, 2024

Sangwook02 self-assigned this May 22, 2024

Sangwook02 requested a review from a team as a code owner May 22, 2024 13:04

Sangwook02 requested review from uwoobeat and AlmondBreez3 May 22, 2024 13:04

AlmondBreez3 approved these changes May 25, 2024

View reviewed changes

docs: 용어 변경

b617659

uwoobeat requested changes May 28, 2024

View reviewed changes

refactor: 학년도와 학기를 클라이언트로부터 입력받도록 수정

5c0ac34

Sangwook02 added 2 commits June 1, 2024 21:04

test: 리쿠르팅 생성 로직에 대한 테스트 추가

de7d072

feat: 리쿠르트먼트 생성 로직 검증 메서드 추가

d9182d4

uwoobeat requested changes Jun 2, 2024

View reviewed changes

refactor: SemesterType이 학기 시작일을 상수로 가지도록 수정

9e969ae

style: 개행 제거

afe6a55

refactor: 메서드 분리 복구

5bad8d5

feat: 시간과 기간에 대한 상수 클래스 추가

2c9d15e

uwoobeat requested changes Jun 2, 2024

View reviewed changes

refactor: 학기 타입 매핑 로직을 리쿠르팅 서비스로 이동

c6f6d3a

rename: ErrorCode 수정

88d0290

uwoobeat requested changes Jun 3, 2024

View reviewed changes

Sangwook02 added 2 commits June 4, 2024 10:30

fix: api 경로 수정

4d6daa6

rename: 상수 이름 수정

1b6e87d

uwoobeat requested changes Jun 4, 2024

View reviewed changes

uwoobeat approved these changes Jun 4, 2024

View reviewed changes

Sangwook02 added 2 commits June 4, 2024 22:12

refactor: 상수를 java.time.Month로 대체

4aa1ea5

fix: ErrorCode 메시지 수정

862cd80

Sangwook02 merged commit fc59a78 into develop Jun 4, 2024
1 check passed

Sangwook02 deleted the feature/333-create-recruitment branch June 4, 2024 13:22

	@RequestMapping("/admin/recruitment")
	@RequestMapping("/admin/recruitments")

feat: Recruitment 생성 API 구현 #345

feat: Recruitment 생성 API 구현 #345

Conversation

Sangwook02 commented May 22, 2024 • edited Loading

🌱 관련 이슈

📌 작업 내용 및 특이사항

📝 참고사항

📚 기타

github-actions bot commented May 22, 2024

Job Summary for Gradle

Check Style and Test to Develop :: build-test

AlmondBreez3 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Sangwook02 May 26, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented May 26, 2024

Job Summary for Gradle

Check Style and Test to Develop :: build-test

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Sangwook02 commented May 29, 2024

github-actions bot commented Jun 1, 2024

Job Summary for Gradle

Check Style and Test to Develop :: build-test

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 Jun 2, 2024

Job Summary for Gradle

Check Style and Test to Develop :: build-test

github-actions bot commented Jun 2, 2024

Job Summary for Gradle

Check Style and Test to Develop :: build-test

github-actions bot commented Jun 2, 2024

Job Summary for Gradle

Check Style and Test to Develop :: build-test

github-actions bot commented Jun 2, 2024

Job Summary for Gradle

Check Style and Test to Develop :: build-test

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Sangwook02 Jun 3, 2024 • edited Loading

Choose a reason for hiding this comment

github-actions bot commented Jun 3, 2024

Job Summary for Gradle

Check Style and Test to Develop :: build-test

github-actions bot commented Jun 3, 2024

Job Summary for Gradle

Check Style and Test to Develop :: build-test

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 Jun 4, 2024

Job Summary for Gradle

Check Style and Test to Develop :: build-test

Choose a reason for hiding this comment

Choose a reason for hiding this comment

uwoobeat left a 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 Jun 4, 2024

Job Summary for Gradle

Check Style and Test to Develop :: build-test

Sangwook02 commented May 22, 2024 •

edited

Loading

Sangwook02 May 26, 2024 •

edited

Loading

Sangwook02 Jun 3, 2024 •

edited

Loading