[DDING-102] 폼지 섹션 조회 API 구현 #245
Merged
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
Seooooo24
requested review from
wonjunYou,
5uhwann and
KoSeonJe
as code owners
|
Caution Review failedThe pull request is closed. Walkthrough이번 PR은 폼 섹션 조회 기능을 위해 새로운 API 인터페이스(UserFormApi)와 이를 구현하는 컨트롤러(UserFormController)가 추가되었습니다. 또한 폼 섹션 데이터를 표현하기 위한 DTO인 FormSectionResponse와 관련 변환 로직, 그리고 서비스 인터페이스(FacadeUserFormService)와 그 구현체(FacadeUserFormServiceImpl), 그리고 데이터를 캡슐화하는 FormSectionQuery가 도입되었습니다. 한편, 폼 응용 서비스의 네이밍 변경에 따른 호출 수정 및 테스트 코드 업데이트가 이루어졌습니다. Changes
Sequence Diagram(s)sequenceDiagram
participant C as Client
participant Ctrl as UserFormController
participant Facade as FacadeUserFormServiceImpl
participant Srv as FormService
C->>Ctrl: GET /server/forms/{formId}/sections
Ctrl->>Facade: getFormSection(formId)
Facade->>Srv: findFormById(formId)
Srv-->>Facade: Form 데이터 반환
Facade->>Facade: FormSectionQuery 생성
Facade-->>Ctrl: FormSectionQuery 반환
Ctrl->>Ctrl: FormSectionResponse.from(query) 호출
Ctrl-->>C: JSON 형식의 폼 섹션 응답 전달
Possibly related PRs
Suggested labels
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (3)
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
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (6)
src/main/java/ddingdong/ddingdongBE/domain/form/service/dto/query/FormSectionQuery.java (1)
12-18: 정적 팩토리 메서드에 유효성 검사 추가 필요
of메서드에 다음과 같은 유효성 검사를 추가하는 것이 좋겠습니다:
- title이 null이거나 비어있는 경우
- sections가 null인 경우
다음과 같이 수정하는 것을 제안드립니다:
public static FormSectionQuery of(String title, String description, List<String> sections) { + if (title == null || title.trim().isEmpty()) { + throw new IllegalArgumentException("제목은 필수 입력값입니다."); + } + if (sections == null) { + throw new IllegalArgumentException("섹션 목록은 null일 수 없습니다."); + } return FormSectionQuery.builder() .title(title) .description(description) .sections(sections) .build(); }src/main/java/ddingdong/ddingdongBE/domain/form/api/UserFormApi.java (2)
11-13: API 문서화 개선이 필요합니다.
@Tag어노테이션의 description이 API의 구체적인 목적과 사용 사례를 설명하지 않습니다.-@Tag(name = "Form - User", description = "User Form API") +@Tag(name = "Form - User", description = "사용자의 폼 관련 작업을 위한 API - 폼 섹션 조회 등")
15-20: API 문서화에 응답 스키마 정보가 누락되었습니다.
@Operation과@ApiResponse어노테이션에 응답 스키마와 예시 데이터가 포함되어 있지 않습니다.@Operation(summary = "폼지 섹션 조회 API") -@ApiResponse(responseCode = "200", description = "폼지 섹션 조회 성공") +@Operation( + summary = "폼지 섹션 조회 API", + description = "주어진 폼 ID에 해당하는 폼의 섹션 정보를 조회합니다." +) +@ApiResponse( + responseCode = "200", + description = "폼지 섹션 조회 성공", + content = @Content( + mediaType = "application/json", + schema = @Schema(implementation = FormSectionResponse.class) + ) +) +@ApiResponse( + responseCode = "404", + description = "폼을 찾을 수 없음" +)src/main/java/ddingdong/ddingdongBE/domain/form/controller/dto/response/FormSectionResponse.java (1)
10-15: 스키마 예시 데이터를 더 현실적으로 개선해야 합니다.현재 예시 데이터가 너무 단순하며, 실제 사용 사례를 잘 반영하지 않습니다.
- @Schema(description = "폼지 제목", example = "카우 1기 폼지") + @Schema(description = "폼지 제목", example = "2024년도 1학기 COW 동아리 지원서") - @Schema(description = "폼지 설명", example = "폼지 설명입니다") + @Schema(description = "폼지 설명", example = "COW 동아리는 웹/서버 개발 동아리로, 프로젝트 중심의 학습을 지향합니다.") - @Schema(description = "섹션 리스트", example = "[서버, 웹]") + @Schema(description = "섹션 리스트", example = "[\"기본 정보\", \"개발 경험\", \"지원 동기\", \"프로젝트 경험\"]")src/test/java/ddingdong/ddingdongBE/domain/form/service/FacadeUserFormServiceImplTest.java (1)
23-24: 테스트 클래스 이름이 구현체를 참조하고 있습니다.테스트 클래스 이름을 인터페이스 기반으로 변경하는 것이 좋습니다.
-class FacadeUserFormServiceImplTest extends TestContainerSupport { +class FacadeUserFormServiceTest extends TestContainerSupport {src/test/java/ddingdong/ddingdongBE/domain/form/service/FacadeUserFormApplicationServiceImplTest.java (1)
32-60: 테스트 클래스 구조에 대한 개선 제안테스트 클래스의 기본 구조는 잘 잡혀있으나, 다음과 같은 개선사항을 제안드립니다:
TestContainerSupport의 역할과 설정에 대한 주석 추가FixtureMonkey설정을 테스트 설정 클래스로 분리하여 재사용성 향상
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (11)
src/main/java/ddingdong/ddingdongBE/domain/form/api/UserFormApi.java(1 hunks)src/main/java/ddingdong/ddingdongBE/domain/form/controller/UserFormController.java(1 hunks)src/main/java/ddingdong/ddingdongBE/domain/form/controller/dto/response/FormSectionResponse.java(1 hunks)src/main/java/ddingdong/ddingdongBE/domain/form/service/FacadeUserFormService.java(1 hunks)src/main/java/ddingdong/ddingdongBE/domain/form/service/FacadeUserFormServiceImpl.java(1 hunks)src/main/java/ddingdong/ddingdongBE/domain/form/service/dto/query/FormSectionQuery.java(1 hunks)src/main/java/ddingdong/ddingdongBE/domain/formapplication/controller/UserFormApplicationController.java(1 hunks)src/main/java/ddingdong/ddingdongBE/domain/formapplication/service/FacadeUserFormApplicationService.java(1 hunks)src/main/java/ddingdong/ddingdongBE/domain/formapplication/service/FacadeUserFormApplicationServiceImpl.java(1 hunks)src/test/java/ddingdong/ddingdongBE/domain/form/service/FacadeUserFormApplicationServiceImplTest.java(1 hunks)src/test/java/ddingdong/ddingdongBE/domain/form/service/FacadeUserFormServiceImplTest.java(2 hunks)
✅ Files skipped from review due to trivial changes (2)
- src/main/java/ddingdong/ddingdongBE/domain/formapplication/service/FacadeUserFormApplicationService.java
- src/main/java/ddingdong/ddingdongBE/domain/formapplication/controller/UserFormApplicationController.java
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Build and analyze
🔇 Additional comments (3)
src/main/java/ddingdong/ddingdongBE/domain/form/service/FacadeUserFormService.java (1)
5-8: 인터페이스 설계가 깔끔합니다!단일 책임 원칙을 잘 준수하고 있으며, 메서드 시그니처가 명확합니다.
src/main/java/ddingdong/ddingdongBE/domain/form/controller/dto/response/FormSectionResponse.java (1)
17-23: 정적 팩토리 메서드가 잘 구현되었습니다.
from메서드가 명확하고 간결하게 구현되어 있으며, 빌더 패턴을 적절히 활용하고 있습니다.src/main/java/ddingdong/ddingdongBE/domain/formapplication/service/FacadeUserFormApplicationServiceImpl.java (1)
17-18: 트랜잭션 설정이 적절합니다.클래스 레벨에서
@Transactional(readOnly = true)를 설정하고, 쓰기 작업이 필요한 메서드에서만@Transactional을 명시적으로 설정한 것이 좋은 방식입니다.
Comment on lines
16
to
20
| @Override | ||
| public FormSectionQuery getFormSection(Long formId) { | ||
| Form form = formService.getById(formId); | ||
| return FormSectionQuery.of(form.getTitle(), form.getDescription(), form.getSections()); | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
예외 처리 및 의존성 개선 필요
formService.getById()에서 발생할 수 있는 예외 처리가 누락되었습니다.- FormService에 대한 직접적인 의존성이 있습니다.
다음과 같이 수정하는 것을 제안드립니다:
@Override
public FormSectionQuery getFormSection(Long formId) {
+ try {
Form form = formService.getById(formId);
+ if (form == null) {
+ throw new FormNotFoundException(formId);
+ }
return FormSectionQuery.of(form.getTitle(), form.getDescription(), form.getSections());
+ } catch (Exception e) {
+ throw new FormServiceException("폼 섹션 조회 중 오류가 발생했습니다.", e);
+ }
}FormService를 인터페이스로 분리하여 의존성 역전 원칙(DIP)을 적용하는 것을 고려해보세요.
Comment on lines
+16
to
+20
| @Override | ||
| public FormSectionResponse getFormSections(Long formId) { | ||
| FormSectionQuery query = facadeUserFormService.getFormSection(formId); | ||
| return FormSectionResponse.from(query); | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
입력값 검증 및 오류 처리 보완 필요
- formId에 대한 유효성 검사가 누락되었습니다.
- 예외 발생 시 적절한 오류 응답 처리가 필요합니다.
다음과 같이 수정하는 것을 제안드립니다:
@Override
public FormSectionResponse getFormSections(Long formId) {
+ if (formId == null || formId <= 0) {
+ throw new InvalidParameterException("유효하지 않은 폼 ID입니다.");
+ }
try {
FormSectionQuery query = facadeUserFormService.getFormSection(formId);
return FormSectionResponse.from(query);
+ } catch (FormNotFoundException e) {
+ throw new ResponseStatusException(HttpStatus.NOT_FOUND, "요청한 폼을 찾을 수 없습니다.", e);
+ } catch (Exception e) {
+ throw new ResponseStatusException(HttpStatus.INTERNAL_SERVER_ERROR, "폼 섹션 조회 중 오류가 발생했습니다.", e);
+ }
}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| @Override | |
| public FormSectionResponse getFormSections(Long formId) { | |
| FormSectionQuery query = facadeUserFormService.getFormSection(formId); | |
| return FormSectionResponse.from(query); | |
| } | |
| @Override | |
| public FormSectionResponse getFormSections(Long formId) { | |
| if (formId == null || formId <= 0) { | |
| throw new InvalidParameterException("유효하지 않은 폼 ID입니다."); | |
| } | |
| try { | |
| FormSectionQuery query = facadeUserFormService.getFormSection(formId); | |
| return FormSectionResponse.from(query); | |
| } catch (FormNotFoundException e) { | |
| throw new ResponseStatusException(HttpStatus.NOT_FOUND, "요청한 폼을 찾을 수 없습니다.", e); | |
| } catch (Exception e) { | |
| throw new ResponseStatusException(HttpStatus.INTERNAL_SERVER_ERROR, "폼 섹션 조회 중 오류가 발생했습니다.", e); | |
| } | |
| } |
Comment on lines
+40
to
+77
| @DisplayName("유저는 섹션 목록을 조회할 수 있다.") | ||
| @Test | ||
| void getFormSection() { | ||
| // given | ||
| User user = fixtureMonkey.giveMeBuilder(User.class) | ||
| .set("id", 1L) | ||
| .set("Role", Role.CLUB) | ||
| .set("deletedAt", null) | ||
| .sample(); | ||
| User savedUser = userRepository.save(user); | ||
|
|
||
| @Autowired | ||
| private FormFieldRepository formFieldRepository; | ||
| Club club = fixtureMonkey.giveMeBuilder(Club.class) | ||
| .set("id", 1L) | ||
| .set("user", savedUser) | ||
| .set("score", null) | ||
| .set("clubMembers", null) | ||
| .set("deletedAt", null) | ||
| .sample(); | ||
| clubRepository.save(club); | ||
|
|
||
| @Autowired | ||
| private EntityManager entityManager; | ||
| List<String> savedSections = new ArrayList<>(); | ||
| savedSections.add("section1"); | ||
| savedSections.add("section2"); | ||
|
|
||
| private static final FixtureMonkey fixtureMonkey = FixtureMonkeyFactory.getNotNullBuilderIntrospectorMonkey(); | ||
| Form form = fixtureMonkey.giveMeBuilder(Form.class) | ||
| .set("id", 1L) | ||
| .set("title", "띵동 폼") | ||
| .set("description", "저희 동아리는 띵동입니다.") | ||
| .set("hasInterview", false) | ||
| .set("club", club) | ||
| .set("sections", savedSections) | ||
| .sample(); | ||
| Form savedForm = formRepository.save(form); | ||
|
|
||
| @DisplayName("사용자는 동아리에 지원할 수 있다.") | ||
| @Test | ||
| void createFormApplication() { | ||
| // given | ||
| User user = fixtureMonkey.giveMeBuilder(User.class) | ||
| .set("id", 1L) | ||
| .set("Role", Role.CLUB) | ||
| .set("deletedAt", null) | ||
| .sample(); | ||
| User savedUser = userRepository.save(user); | ||
| Club club = fixtureMonkey.giveMeBuilder(Club.class) | ||
| .set("id", 1L) | ||
| .set("user", savedUser) | ||
| .set("score", null) | ||
| .set("clubMembers", null) | ||
| .set("deletedAt", null) | ||
| .sample(); | ||
| clubRepository.save(club); | ||
| Club savedClub = clubRepository.save(club); | ||
| Form form = fixtureMonkey.giveMeBuilder(Form.class) | ||
| .set("id", 1L) | ||
| .set("title", "띵동 폼") | ||
| .set("description", "저희 동아리는 띵동입니다.") | ||
| .set("hasInterview", false) | ||
| .set("club", savedClub) | ||
| .sample(); | ||
| Form savedForm = formRepository.save(form); | ||
| FormField formField = FormField.builder() | ||
| .form(savedForm) | ||
| .fieldType(FieldType.CHECK_BOX) | ||
| .fieldOrder(1) | ||
| .section("서버") | ||
| .required(true) | ||
| .question("질문") | ||
| .build(); | ||
| FormField savedFormField = formFieldRepository.save(formField); | ||
| CreateFormApplicationCommand createFormApplicationCommand = fixtureMonkey.giveMeBuilder(CreateFormApplicationCommand.class) | ||
| .set("formId", savedForm.getId()) | ||
| .set("formAnswerCommands", List.of(new CreateFormAnswerCommand(savedFormField.getId(), List.of("답변")))) | ||
| .sample(); | ||
| // when | ||
| facadeUserFormService.createFormApplication(createFormApplicationCommand); | ||
| // then | ||
| List<FormApplication> formApplications = formApplicationRepository.findAll(); | ||
| List<FormAnswer> formAnswers = formAnswerRepository.findAll(); | ||
| FormSectionQuery sectionQuery = facadeUserFormService.getFormSection(savedForm.getId()); | ||
|
|
||
| assertThat(formApplications).isNotEmpty(); | ||
| assertThat(formApplications.get(0).getForm().getId()).isEqualTo(savedForm.getId()); | ||
| assertThat(formAnswers).isNotEmpty(); | ||
| assertThat(formAnswers.get(0).getValue()).isEqualTo(List.of("답변")); | ||
| } | ||
| } | ||
| assertThat(sectionQuery.sections()).isEqualTo(savedSections); | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
테스트 코드 개선이 필요합니다.
- 테스트 데이터 설정이 너무 길고 반복적입니다.
- 검증(assertion)이 충분하지 않습니다.
다음과 같이 개선하는 것을 제안합니다:
+ private User createTestUser() {
+ User user = fixtureMonkey.giveMeBuilder(User.class)
+ .set("id", 1L)
+ .set("Role", Role.CLUB)
+ .set("deletedAt", null)
+ .sample();
+ return userRepository.save(user);
+ }
+
+ private Club createTestClub(User user) {
+ Club club = fixtureMonkey.giveMeBuilder(Club.class)
+ .set("id", 1L)
+ .set("user", user)
+ .set("score", null)
+ .set("clubMembers", null)
+ .set("deletedAt", null)
+ .sample();
+ return clubRepository.save(club);
+ }
+
+ private Form createTestForm(Club club, List<String> sections) {
+ Form form = fixtureMonkey.giveMeBuilder(Form.class)
+ .set("id", 1L)
+ .set("title", "띵동 폼")
+ .set("description", "저희 동아리는 띵동입니다.")
+ .set("hasInterview", false)
+ .set("club", club)
+ .set("sections", sections)
+ .sample();
+ return formRepository.save(form);
+ }
@DisplayName("유저는 섹션 목록을 조회할 수 있다.")
@Test
void getFormSection() {
// given
- User user = fixtureMonkey.giveMeBuilder(User.class)
- .set("id", 1L)
- .set("Role", Role.CLUB)
- .set("deletedAt", null)
- .sample();
- User savedUser = userRepository.save(user);
-
- Club club = fixtureMonkey.giveMeBuilder(Club.class)
- .set("id", 1L)
- .set("user", savedUser)
- .set("score", null)
- .set("clubMembers", null)
- .set("deletedAt", null)
- .sample();
- clubRepository.save(club);
+ User savedUser = createTestUser();
+ Club savedClub = createTestClub(savedUser);
List<String> savedSections = new ArrayList<>();
savedSections.add("section1");
savedSections.add("section2");
- Form form = fixtureMonkey.giveMeBuilder(Form.class)
- .set("id", 1L)
- .set("title", "띵동 폼")
- .set("description", "저희 동아리는 띵동입니다.")
- .set("hasInterview", false)
- .set("club", club)
- .set("sections", savedSections)
- .sample();
- Form savedForm = formRepository.save(form);
+ Form savedForm = createTestForm(savedClub, savedSections);
// when
FormSectionQuery sectionQuery = facadeUserFormService.getFormSection(savedForm.getId());
// then
- assertThat(sectionQuery.sections()).isEqualTo(savedSections);
+ assertThat(sectionQuery.title()).isEqualTo(savedForm.getTitle());
+ assertThat(sectionQuery.description()).isEqualTo(savedForm.getDescription());
+ assertThat(sectionQuery.sections())
+ .hasSize(savedSections.size())
+ .containsExactlyElementsOf(savedSections);
}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| @DisplayName("유저는 섹션 목록을 조회할 수 있다.") | |
| @Test | |
| void getFormSection() { | |
| // given | |
| User user = fixtureMonkey.giveMeBuilder(User.class) | |
| .set("id", 1L) | |
| .set("Role", Role.CLUB) | |
| .set("deletedAt", null) | |
| .sample(); | |
| User savedUser = userRepository.save(user); | |
| @Autowired | |
| private FormFieldRepository formFieldRepository; | |
| Club club = fixtureMonkey.giveMeBuilder(Club.class) | |
| .set("id", 1L) | |
| .set("user", savedUser) | |
| .set("score", null) | |
| .set("clubMembers", null) | |
| .set("deletedAt", null) | |
| .sample(); | |
| clubRepository.save(club); | |
| @Autowired | |
| private EntityManager entityManager; | |
| List<String> savedSections = new ArrayList<>(); | |
| savedSections.add("section1"); | |
| savedSections.add("section2"); | |
| private static final FixtureMonkey fixtureMonkey = FixtureMonkeyFactory.getNotNullBuilderIntrospectorMonkey(); | |
| Form form = fixtureMonkey.giveMeBuilder(Form.class) | |
| .set("id", 1L) | |
| .set("title", "띵동 폼") | |
| .set("description", "저희 동아리는 띵동입니다.") | |
| .set("hasInterview", false) | |
| .set("club", club) | |
| .set("sections", savedSections) | |
| .sample(); | |
| Form savedForm = formRepository.save(form); | |
| @DisplayName("사용자는 동아리에 지원할 수 있다.") | |
| @Test | |
| void createFormApplication() { | |
| // given | |
| User user = fixtureMonkey.giveMeBuilder(User.class) | |
| .set("id", 1L) | |
| .set("Role", Role.CLUB) | |
| .set("deletedAt", null) | |
| .sample(); | |
| User savedUser = userRepository.save(user); | |
| Club club = fixtureMonkey.giveMeBuilder(Club.class) | |
| .set("id", 1L) | |
| .set("user", savedUser) | |
| .set("score", null) | |
| .set("clubMembers", null) | |
| .set("deletedAt", null) | |
| .sample(); | |
| clubRepository.save(club); | |
| Club savedClub = clubRepository.save(club); | |
| Form form = fixtureMonkey.giveMeBuilder(Form.class) | |
| .set("id", 1L) | |
| .set("title", "띵동 폼") | |
| .set("description", "저희 동아리는 띵동입니다.") | |
| .set("hasInterview", false) | |
| .set("club", savedClub) | |
| .sample(); | |
| Form savedForm = formRepository.save(form); | |
| FormField formField = FormField.builder() | |
| .form(savedForm) | |
| .fieldType(FieldType.CHECK_BOX) | |
| .fieldOrder(1) | |
| .section("서버") | |
| .required(true) | |
| .question("질문") | |
| .build(); | |
| FormField savedFormField = formFieldRepository.save(formField); | |
| CreateFormApplicationCommand createFormApplicationCommand = fixtureMonkey.giveMeBuilder(CreateFormApplicationCommand.class) | |
| .set("formId", savedForm.getId()) | |
| .set("formAnswerCommands", List.of(new CreateFormAnswerCommand(savedFormField.getId(), List.of("답변")))) | |
| .sample(); | |
| // when | |
| facadeUserFormService.createFormApplication(createFormApplicationCommand); | |
| // then | |
| List<FormApplication> formApplications = formApplicationRepository.findAll(); | |
| List<FormAnswer> formAnswers = formAnswerRepository.findAll(); | |
| FormSectionQuery sectionQuery = facadeUserFormService.getFormSection(savedForm.getId()); | |
| assertThat(formApplications).isNotEmpty(); | |
| assertThat(formApplications.get(0).getForm().getId()).isEqualTo(savedForm.getId()); | |
| assertThat(formAnswers).isNotEmpty(); | |
| assertThat(formAnswers.get(0).getValue()).isEqualTo(List.of("답변")); | |
| } | |
| } | |
| assertThat(sectionQuery.sections()).isEqualTo(savedSections); | |
| } | |
| private User createTestUser() { | |
| User user = fixtureMonkey.giveMeBuilder(User.class) | |
| .set("id", 1L) | |
| .set("Role", Role.CLUB) | |
| .set("deletedAt", null) | |
| .sample(); | |
| return userRepository.save(user); | |
| } | |
| private Club createTestClub(User user) { | |
| Club club = fixtureMonkey.giveMeBuilder(Club.class) | |
| .set("id", 1L) | |
| .set("user", user) | |
| .set("score", null) | |
| .set("clubMembers", null) | |
| .set("deletedAt", null) | |
| .sample(); | |
| return clubRepository.save(club); | |
| } | |
| private Form createTestForm(Club club, List<String> sections) { | |
| Form form = fixtureMonkey.giveMeBuilder(Form.class) | |
| .set("id", 1L) | |
| .set("title", "띵동 폼") | |
| .set("description", "저희 동아리는 띵동입니다.") | |
| .set("hasInterview", false) | |
| .set("club", club) | |
| .set("sections", sections) | |
| .sample(); | |
| return formRepository.save(form); | |
| } | |
| @DisplayName("유저는 섹션 목록을 조회할 수 있다.") | |
| @Test | |
| void getFormSection() { | |
| // given | |
| User savedUser = createTestUser(); | |
| Club savedClub = createTestClub(savedUser); | |
| List<String> savedSections = new ArrayList<>(); | |
| savedSections.add("section1"); | |
| savedSections.add("section2"); | |
| Form savedForm = createTestForm(savedClub, savedSections); | |
| // when | |
| FormSectionQuery sectionQuery = facadeUserFormService.getFormSection(savedForm.getId()); | |
| // then | |
| assertThat(sectionQuery.title()).isEqualTo(savedForm.getTitle()); | |
| assertThat(sectionQuery.description()).isEqualTo(savedForm.getDescription()); | |
| assertThat(sectionQuery.sections()) | |
| .hasSize(savedSections.size()) | |
| .containsExactlyElementsOf(savedSections); | |
| } |
Comment on lines
+61
to
+111
| @DisplayName("사용자는 동아리에 지원할 수 있다.") | ||
| @Test | ||
| void createFormApplication() { | ||
| // given | ||
| User user = fixtureMonkey.giveMeBuilder(User.class) | ||
| .set("id", 1L) | ||
| .set("Role", Role.CLUB) | ||
| .set("deletedAt", null) | ||
| .sample(); | ||
| User savedUser = userRepository.save(user); | ||
| Club club = fixtureMonkey.giveMeBuilder(Club.class) | ||
| .set("id", 1L) | ||
| .set("user", savedUser) | ||
| .set("score", null) | ||
| .set("clubMembers", null) | ||
| .set("deletedAt", null) | ||
| .sample(); | ||
| clubRepository.save(club); | ||
| Club savedClub = clubRepository.save(club); | ||
| Form form = fixtureMonkey.giveMeBuilder(Form.class) | ||
| .set("id", 1L) | ||
| .set("title", "띵동 폼") | ||
| .set("description", "저희 동아리는 띵동입니다.") | ||
| .set("hasInterview", false) | ||
| .set("club", savedClub) | ||
| .sample(); | ||
| Form savedForm = formRepository.save(form); | ||
| FormField formField = FormField.builder() | ||
| .form(savedForm) | ||
| .fieldType(FieldType.CHECK_BOX) | ||
| .fieldOrder(1) | ||
| .section("서버") | ||
| .required(true) | ||
| .question("질문") | ||
| .build(); | ||
| FormField savedFormField = formFieldRepository.save(formField); | ||
| CreateFormApplicationCommand createFormApplicationCommand = fixtureMonkey.giveMeBuilder(CreateFormApplicationCommand.class) | ||
| .set("formId", savedForm.getId()) | ||
| .set("formAnswerCommands", List.of(new CreateFormAnswerCommand(savedFormField.getId(), List.of("답변")))) | ||
| .sample(); | ||
| // when | ||
| facadeUserFormApplicationService.createFormApplication(createFormApplicationCommand); | ||
| // then | ||
| List<FormApplication> formApplications = formApplicationRepository.findAll(); | ||
| List<FormAnswer> formAnswers = formAnswerRepository.findAll(); | ||
|
|
||
| assertThat(formApplications).isNotEmpty(); | ||
| assertThat(formApplications.get(0).getForm().getId()).isEqualTo(savedForm.getId()); | ||
| assertThat(formAnswers).isNotEmpty(); | ||
| assertThat(formAnswers.get(0).getValue()).isEqualTo(List.of("답변")); | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
테스트 메소드 구현에 대한 개선 제안
테스트 구현에 대해 다음과 같은 개선사항을 제안드립니다:
- 테스트 데이터 설정 부분이 너무 길어 가독성이 떨어집니다. 테스트 데이터 생성을 별도의 헬퍼 메소드로 추출하는 것을 추천드립니다.
- 현재 검증(assertion)이 기본적인 부분만 커버하고 있습니다. 다음과 같은 추가 검증이 필요합니다:
- 생성된
FormApplication의 상태값 검증 FormAnswer의 모든 필드 검증- 저장된 데이터의 개수 검증
- 생성된
- 다음과 같은 엣지 케이스에 대한 테스트가 필요합니다:
- 필수 필드가 누락된 경우
- 잘못된 형식의 답변이 입력된 경우
- 존재하지 않는 폼 ID가 입력된 경우
다음과 같이 테스트 데이터 설정을 분리하는 것을 제안드립니다:
@TestInstance(TestInstance.Lifecycle.PER_CLASS)
class FacadeUserFormApplicationServiceImplTest extends TestContainerSupport {
// ... existing fields ...
private User createTestUser() {
User user = fixtureMonkey.giveMeBuilder(User.class)
.set("id", 1L)
.set("Role", Role.CLUB)
.set("deletedAt", null)
.sample();
return userRepository.save(user);
}
private Club createTestClub(User user) {
Club club = fixtureMonkey.giveMeBuilder(Club.class)
.set("id", 1L)
.set("user", user)
.set("score", null)
.set("clubMembers", null)
.set("deletedAt", null)
.sample();
return clubRepository.save(club);
}
private Form createTestForm(Club club) {
Form form = fixtureMonkey.giveMeBuilder(Form.class)
.set("id", 1L)
.set("title", "띵동 폼")
.set("description", "저희 동아리는 띵동입니다.")
.set("hasInterview", false)
.set("club", club)
.sample();
return formRepository.save(form);
}
@Test
@DisplayName("사용자는 동아리에 지원할 수 있다.")
void createFormApplication() {
// given
User savedUser = createTestUser();
Club savedClub = createTestClub(savedUser);
Form savedForm = createTestForm(savedClub);
// ... rest of the test
}
@Test
@DisplayName("필수 필드가 누락된 경우 예외가 발생한다.")
void createFormApplication_WithMissingRequiredField() {
// ... implement edge case test
}
}
KoSeonJe
reviewed
Feb 7, 2025
Comment on lines
15
to
20
| @Operation(summary = "폼지 섹션 조회 API") | ||
| @ApiResponse(responseCode = "200", description = "폼지 섹션 조회 성공") | ||
| @GetMapping("/forms/{formId}/sections") | ||
| FormSectionResponse getFormSections( | ||
| @PathVariable("formId") Long formId | ||
| ); |
There was a problem hiding this comment.
p2)
ResponseStatus 지정해줘야 할 것 같습니다.
추가로 응답 값이 어떻게 반환되는 지 DTO 통해 보여주는 법 다른 api 참고해서 추가해주면 좋을 것 같아요
Comment on lines
+10
to
+15
| @Schema(description = "폼지 제목", example = "카우 1기 폼지") | ||
| String title, | ||
| @Schema(description = "폼지 설명", example = "폼지 설명입니다") | ||
| String description, | ||
| @Schema(description = "섹션 리스트", example = "[서버, 웹]") | ||
| List<String> sections |
There was a problem hiding this comment.
p3)
이 api필요한 이유가 어떤 섹션을 선택할지 사용자에게 선택지를 보여주기 위함인 것으로 알고있는데, 관련 안내문구같은거는 프론트에서 저장해서 보여주나요?
There was a problem hiding this comment.
피그마 상에 따로 안내 문구가 없었어서 저는 동아리에서 description에 자체적으로 넣을 거라고 생각했습니다. 혹시 안내 문구를 엔터티에 따로 저장해야 할까요?
There was a problem hiding this comment.
아! "지원 분야를 선택해주세요" 같은 부분을 말씀하시는 걸까요? 저는 모든 동아리에서 동일하게 보여지는 문구라 프론트에서 저장하여 보여준다고 생각했는데 선배님은 백엔드에서 응답에 포함해주는 것이 좋다고 생각하시는 걸까요? 선배님 생각이 어떤지 여쭤보고 싶습니다.
There was a problem hiding this comment.
아뇨 그냥 궁금했습니다. 프론트에서 고정된 문구 보여주는 것도 괜찮을 것 같아요!
5uhwann
approved these changes
Feb 8, 2025
| @Override | ||
| public FormSectionQuery getFormSection(Long formId) { | ||
| Form form = formService.getById(formId); | ||
| return FormSectionQuery.of(form.getTitle(), form.getDescription(), form.getSections()); |
There was a problem hiding this comment.
p4)
사소한거긴 한데 FormSectionQuery.of() 메서드의 파라미터로 넘기는 값이 모두 form 객체의 필드라면 form 객체를 넘겨 팩토리 메서드에서 필드에 접근하는 것이 더 나아보입니다!
Suggested change
| return FormSectionQuery.of(form.getTitle(), form.getDescription(), form.getSections()); | |
| return FormSectionQuery.from(form); |
There was a problem hiding this comment.
확실히 그렇네요! 수정했습니다!
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.
🚀 작업 내용
폼지 섹션 조회 API 구현하였습니다.
🤔 고민했던 내용
💬 리뷰 중점사항
Summary by CodeRabbit