feat: 운영진 관리 기능 구현 완료 #648

SongJaeHoonn · 2024-12-28T08:52:21Z

Summary

#642

효율적인 운영진 정보 관리를 위해, 운영진 CRUD를 구현했습니다.

Tasks

운영진 등록 기능
운영진 조회 기능
운영진 수정 기능
운영직 삭제 기능

ETC

MemberManagement 카테고리의 Executive 도메인을 새로 만들었습니다.
현재 Member entity처럼, PK가 학번인 경우 그 값은 고유하고 변경되지 않기 때문에 Executive의 PK도 학번(id)으로 설정했으며, 이 값은 변경할 수 없도록 했습니다.
운영진 직급을 회장,부회장과 같은 문자열로 처리하려고 했으나, 유지보수의 용이성을 위해 Enum으로 관리하도록 했습니다.
정렬 순서는 PRESIDENT -> VICE_PRESIDENT -> GENERAL(학번 순) 입니다.

Screenshot

등록

조회

수정 후 조회

삭제 후 조회

사진 등록

limehee

회장, 부회장, 운영진 등의 정보를 관리하기 위해 이전에 position 테이블을 생성한 적이 있어요. 이번에 작성된 부분과 일부 겹치는 내용이 있어, 두 도메인 중 하나를 삭제하고 통합하는 것이 더 효율적일 것 같아요.

limehee · 2024-12-28T09:37:05Z

...e/clab/api/domain/memberManagement/executive/adapter/in/web/ExecutiveRegisterController.java

+        "position은 다음과 같이 등록 가능<br>" +
+        "- PRESIDENT : 회장<br>" +
+        "- VICE_PRESIDENT : 부회장<br>" +
+        "- GENERAL : 일반 운영진<br>")


API 문서에서 DTO의 속성을 통해 Enum 값을 추적할 수 있어, 별도로 position 정보를 기재할 필요는 없을 것 같아요.

limehee · 2024-12-28T09:41:53Z

...age/clab/api/domain/memberManagement/executive/adapter/in/web/ExecutiveRemoveController.java

+
+    @Operation(summary = "[A] 운영진 정보 삭제", description = "ROLE_ADMIN 이상의 권한이 필요함")
+    @PreAuthorize("hasRole('ADMIN')")
+    @DeleteMapping("/{id}")


해당 API와 '운영진 정보 수정' API 모두 Path 변수의 명칭을 id로 설정할 경우, 어떤 id를 의미하는지 명확하지 않을 수 있어요. 다른 API와 일관성을 유지하면서 의미를 명확히 전달하기 위해 executiveId로 변경할 것을 권장드려요.

limehee · 2024-12-28T09:47:36Z

...i/domain/memberManagement/executive/adapter/out/persistence/ExecutivePersistenceAdapter.java

+    @Override
+    public Executive getById(String id) {
+        ExecutiveJpaEntity jpaEntity = executiveRepository.findById(id)
+            .orElseThrow(() -> new NotFoundException("학번이 " + id + "인 운영진이 존재하지 않습니다."));


로깅 메시지의 통일성을 위해 [Executive] id: " + executiveId + "에 해당하는 운영진이 존재하지 않습니다.로 수정 부탁드려요. 매개변수 명칭도 id에서 executiveId로 변경해주세요.

limehee · 2024-12-28T09:54:20Z

src/main/java/page/clab/api/domain/memberManagement/executive/domain/Executive.java

+    private String id;
+    private String name;
+    private String email;
+    private String field;


현재 member와 application 테이블에서 '관심 분야'를 나타내는 명칭으로 interests를 사용하고 있어요. field또는 interests 중 하나로 통일할 필요가 있어보여요.

limehee · 2024-12-28T10:04:14Z

src/main/java/page/clab/api/global/common/file/application/FileService.java

        Role.SUPER,
        Set.of("boards", "profiles", "activity-photos", "membership-fees", "notices", "weekly-activities", "members",
-            "assignments", "submits")
+            "assignments", "submits", "executives")


isUserAccessibleByCategory() 메서드에서 비로그인 사용자도 executives 경로에 접근할 수 있도록 허용하고 있지만, 현재 roleCategoryMap에는 운영진 이상의 권한만 허용되어 있어요. GUEST, USER 권한을 가진 사용자도 운영진 사진을 열람할 수 있도록 수정이 필요해요.

Copilot reviewed 15 out of 30 changed files in this pull request and generated 1 comment.

Files not reviewed (15)

src/main/java/page/clab/api/domain/memberManagement/executive/application/service/ExecutiveRetrievalService.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/application/service/ExecutiveRegisterService.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/application/service/ExecutiveUpdateService.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/adapter/in/web/ExecutiveRegisterController.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/application/service/ExecutiveRemoveService.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/adapter/in/web/ExecutiveRemoveController.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/application/port/in/UpdateExecutiveUseCase.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/application/port/in/RemoveExecutiveUseCase.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/application/port/in/RetrieveExecutiveUseCase.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/domain/Executive.java: Evaluated as low risk
src/main/java/page/clab/api/global/common/file/api/FileController.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/application/exception/ExecutiveRegistrationException.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/application/port/in/RegisterExecutiveUseCase.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/application/dto/mapper/ExecutiveDtoMapper.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/application/dto/request/ExecutiveUpdateRequestDto.java: Evaluated as low risk

2024-12-28T10:20:21Z

.../clab/api/domain/memberManagement/executive/application/dto/request/ExecutiveRequestDto.java

+    private String name;
+
+    @NotNull(message = "{notNull.executive.email}")
+    @Schema(description = "이메일", example = "[email protected]")


There is a typo in the email example: "[email protected]" should be "[email protected]".

Suggested change

@Schema(description = "이메일", example = "clab.coreteam@gamil.com")

@Schema(description = "이메일", example = "clab.coreteam@gmail.com")

SongJaeHoonn · 2024-12-29T09:07:25Z

@limehee

회장, 부회장, 운영진 등의 정보를 관리하기 위해 이전에 position 테이블을 생성한 적이 있어요. 이번에 작성된 부분과 일부 겹치는 내용이 있어, 두 도메인 중 하나를 삭제하고 통합하는 것이 더 효율적일 것 같아요.

Position 테이블이 멤버의 직책을 담당하는 것이라고 알고 있었는데, 직책 중 일반 회원, 코어팀도 포함되어 있어 운영진 정보만(회장, 부회장, 운영진) 관리하는 테이블을 하나 더 만들도록 했었습니다.

그런데 다시 보니 겹치는 부분이 상당히 많고, 직책 등록이 더욱 포괄적인 것 같아 Executive도메인을 삭제하고, Position도메인으로 운영진을 관리할 수 있는 로직을 옮기는 방식이 더 좋을 것 같습니다! 감사합니다. 작업 후 다시 리뷰 요청 드리겠습니다.

SongJaeHoonn added 7 commits December 23, 2024 18:19

feat(ExecutiveJpaEntity): 엔티티 설계

3b54855

feat(ExecutiveRegisterService): 운영진 등록 기능 구현

b9ec0ff

feat(File): 운영진 사진 업로드 API 구현

b0e862a

feat(ExecutiveRetrieve): 운영진 정보 조회 기능 구현

2bd8be6

feat(Executive): 운영진 수정, 삭제 기능 구현

4c3c9aa

feat(ExecutiveRegisterService): 운영진 수정시 검증 로직 추가 작성

ce80cc1

refactor(ExecutiveRegisterController): 어노테이션 추가

2d1be29

SongJaeHoonn added the ✨ Feature 새로운 기능 명세 및 개발 label Dec 28, 2024

SongJaeHoonn requested a review from mingmingmon December 28, 2024 08:52

SongJaeHoonn self-assigned this Dec 28, 2024

SongJaeHoonn requested a review from limehee as a code owner December 28, 2024 08:52

SongJaeHoonn linked an issue Dec 28, 2024 that may be closed by this pull request

운영진 관리 기능 구현 #642

Open

4 tasks

Merge branch 'develop' into feat/#642

99186a3

limehee requested changes Dec 28, 2024

View reviewed changes

limehee requested a review from Copilot December 28, 2024 10:19

Copilot AI reviewed Dec 28, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: 운영진 관리 기능 구현 완료 #648

feat: 운영진 관리 기능 구현 완료 #648

SongJaeHoonn commented Dec 28, 2024

limehee left a comment

limehee Dec 28, 2024

limehee Dec 28, 2024

limehee Dec 28, 2024

limehee Dec 28, 2024

limehee Dec 28, 2024

Copilot AI left a comment

Copilot AI Dec 28, 2024

Provide additional feedback

Please help us improve GitHub Copilot by sharing more details about this comment.

SongJaeHoonn commented Dec 29, 2024

	@Schema(description = "이메일", example = "clab.coreteam@gamil.com")
	@Schema(description = "이메일", example = "clab.coreteam@gmail.com")

feat: 운영진 관리 기능 구현 완료 #648

Are you sure you want to change the base?

feat: 운영진 관리 기능 구현 완료 #648

Conversation

SongJaeHoonn commented Dec 28, 2024

Summary

Tasks

ETC

Screenshot

limehee left a comment

Choose a reason for hiding this comment

limehee Dec 28, 2024

Choose a reason for hiding this comment

limehee Dec 28, 2024

Choose a reason for hiding this comment

limehee Dec 28, 2024

Choose a reason for hiding this comment

limehee Dec 28, 2024

Choose a reason for hiding this comment

limehee Dec 28, 2024

Choose a reason for hiding this comment

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot AI Dec 28, 2024

Choose a reason for hiding this comment

SongJaeHoonn commented Dec 29, 2024