[OING-341] feature: 가족 이름 수정 API 추가 및 조회 API 응답 수정 (#264)

Ji-soo708 · Ji-soo708 · commit acbd1fc14f2f · 2024-06-21T23:44:52.000+09:00
* feature: add familyName field in api

* feature: add UpdateFamilyName API

* fix: fix failed test related to family

* test: add updateFamilyName test code

* refactor: add familyNameEditorId to FamilyResponse
diff --git a/family/src/main/java/com/oing/controller/FamilyController.java b/family/src/main/java/com/oing/controller/FamilyController.java
@@ -1,6 +1,7 @@
 package com.oing.controller;
 
 import com.oing.domain.Family;
+import com.oing.dto.request.UpdateFamilyNameRequest;
 import com.oing.dto.response.FamilyResponse;
 import com.oing.exception.AuthorizationFailedException;
 import com.oing.restapi.FamilyApi;
@@ -28,4 +29,14 @@ public FamilyResponse getFamilyCreatedAt(String familyId, String loginFamilyId)
         Family family = familyService.getFamilyById(familyId);
         return FamilyResponse.of(family);
     }
+
+    @Override
+    public FamilyResponse updateFamilyName(String familyId, String loginFamilyId, String loginMemberId, UpdateFamilyNameRequest request) {
+        if (!familyId.equals(loginFamilyId)) {
+            throw new AuthorizationFailedException();
+        }
+
+        Family family = familyService.updateFamilyName(familyId, loginMemberId, request.familyName());
+        return FamilyResponse.of(family);
+    }
 }
diff --git a/family/src/main/java/com/oing/domain/Family.java b/family/src/main/java/com/oing/domain/Family.java
@@ -7,6 +7,8 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
+import java.security.InvalidParameterException;
+
 @Entity(name = "family")
 @NoArgsConstructor(access = lombok.AccessLevel.PROTECTED)
 @AllArgsConstructor
@@ -20,13 +22,17 @@ public class Family extends BaseEntity {
     @Column(name = "family_name", columnDefinition = "CHAR(10)")
     private String familyName;
 
+    @Column(name = "family_name_editor_id", columnDefinition = "CHAR(26)")
+    private String familyNameEditorId;
+
     @Column(name = "score", nullable = false)
     private Integer score = 0;
 
 
-    public Family(String id, String familyName) {
+    public Family(String id, String familyName, String familyNameEditorId) {
         this.id = id;
         this.familyName = familyName;
+        this.familyNameEditorId = familyNameEditorId;
     }
 
     public static final int NEW_POST_SCORE = 20;
@@ -86,4 +92,21 @@ public void subtractScore(int score) {
     public void resetScore() {
         this.score = 0;
     }
+
+    public void updateFamilyName(String familyName, String loginFamilyId) {
+        if (familyName == null) {
+            this.familyName = null;
+            this.familyNameEditorId = null;
+        } else {
+            validateFamilyName(familyName);
+            this.familyName = familyName;
+            this.familyNameEditorId = loginFamilyId;
+        }
+    }
+
+    private void validateFamilyName(String familyName) {
+        if ((familyName.codePoints().count() > 10) || familyName.isBlank()) {
+            throw new InvalidParameterException();
+        }
+    }
 }
diff --git a/family/src/main/java/com/oing/dto/request/UpdateFamilyNameRequest.java b/family/src/main/java/com/oing/dto/request/UpdateFamilyNameRequest.java
@@ -0,0 +1,13 @@
+package com.oing.dto.request;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.constraints.Size;
+
+@Schema(description = "가족 이름 수정 요청")
+public record UpdateFamilyNameRequest(
+
+        @Size(max = 10)
+        @Schema(description = "가족 이름", example = "오잉")
+        String familyName
+) {
+}
diff --git a/family/src/main/java/com/oing/dto/response/FamilyResponse.java b/family/src/main/java/com/oing/dto/response/FamilyResponse.java
@@ -11,12 +11,20 @@ public record FamilyResponse(
         @Schema(description = "가족 ID", example = "01HGW2N7EHJVJ4CJ999RRS2E97")
         String familyId,
 
+        @Schema(description = "가족 이름", example = "미밍이네")
+        String familyName,
+
+        @Schema(description = "가족 이름 마지막 수정자 ID", example = "01HGW2N7EHJVJ4CJ999RRS2E97")
+        String familyNameEditorId,
+
         @Schema(description = "가족 생성 시간", example = "2021-12-05T12:30:00.000+09:00")
         ZonedDateTime createdAt
 ) {
     public static FamilyResponse of(Family family) {
         return new FamilyResponse(
                 family.getId(),
+                family.getFamilyName(),
+                family.getFamilyNameEditorId(),
                 family.getCreatedAt().atZone(ZoneId.systemDefault())
         );
     }
diff --git a/family/src/main/java/com/oing/restapi/FamilyApi.java b/family/src/main/java/com/oing/restapi/FamilyApi.java
@@ -1,7 +1,9 @@
 package com.oing.restapi;
 
+import com.oing.dto.request.UpdateFamilyNameRequest;
 import com.oing.dto.response.FamilyResponse;
 import com.oing.util.security.LoginFamilyId;
+import com.oing.util.security.LoginMemberId;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.tags.Tag;
@@ -28,4 +30,23 @@ FamilyResponse getFamilyCreatedAt(
             @LoginFamilyId
             String loginFamilyId
     );
+
+    @Operation(summary = "가족 이름 변경", description = "가족 이름을 변경합니다.")
+    @PutMapping("/{familyId}/name")
+    FamilyResponse updateFamilyName(
+            @Parameter(description = "가족 ID", example = "01HGW2N7EHJVJ4CJ999RRS2E97")
+            @PathVariable
+            String familyId,
+
+            @Parameter(hidden = true)
+            @LoginFamilyId
+            String loginFamilyId,
+
+            @Parameter(hidden = true)
+            @LoginMemberId
+            String loginMemberId,
+
+            @RequestBody
+            UpdateFamilyNameRequest request
+    );
 }
diff --git a/family/src/main/java/com/oing/service/FamilyService.java b/family/src/main/java/com/oing/service/FamilyService.java
@@ -24,7 +24,7 @@ public class FamilyService {
 
     @Transactional
     public Family createFamily() {
-        Family family = new Family(identityGenerator.generateIdentity(), null);
+        Family family = new Family(identityGenerator.generateIdentity(), null, null);
         return familyRepository.save(family);
     }
 
@@ -57,4 +57,11 @@ private int calculateLiveFamilyTopPercentage(String familyId) {
         // score 를 통한 순위를 통해 전체 가족들 중 상위 백분율 계산 (1%에 가까울수록 고순위)
         return familyScoreBridge.calculateFamilyTopPercentage(rank, familiesCount);
     }
+
+    @Transactional
+    public Family updateFamilyName(String familyId, String loginMemberId, String familyName) {
+        Family family = getFamilyById(familyId);
+        family.updateFamilyName(familyName, loginMemberId);
+        return family;
+    }
 }
diff --git a/family/src/test/java/com/oing/service/FamilyServiceTest.java b/family/src/test/java/com/oing/service/FamilyServiceTest.java
@@ -0,0 +1,80 @@
+package com.oing.service;
+
+import com.oing.domain.Family;
+import com.oing.repository.FamilyRepository;
+import com.oing.util.IdentityGenerator;
+import jakarta.transaction.Transactional;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+import org.mockito.junit.jupiter.MockitoExtension;
+import org.springframework.test.context.ActiveProfiles;
+
+import java.security.InvalidParameterException;
+import java.util.Optional;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.mockito.Mockito.when;
+
+@Transactional
+@ActiveProfiles("test")
+@ExtendWith(MockitoExtension.class)
+public class FamilyServiceTest {
+
+    @InjectMocks
+    private FamilyService familyService;
+    @Mock
+    private FamilyRepository familyRepository;
+    @Mock
+    private FamilyTopPercentageHistoryService familyTopPercentageHistoryService;
+    @Mock
+    private FamilyScoreBridge familyScoreBridge;
+    @Mock
+    private IdentityGenerator identityGenerator;
+
+    @Test
+    void 가족_이름_수정_테스트() {
+        // given
+        String newName = "new-name";
+        String memberId = "1";
+        String familyId = "1";
+
+        // when
+        when(familyRepository.findById(familyId)).thenReturn(Optional.of(new Family(familyId, null, null)));
+        Family family = familyService.updateFamilyName(familyId, memberId, newName);
+
+        // then
+        assertEquals(newName, family.getFamilyName());
+        assertEquals(memberId, family.getFamilyNameEditorId());
+    }
+
+    @Test
+    void 열_자_초과_가족_이름_수정_예외_검증() {
+        // given
+        String newName = "wrong-length-name";
+        String memberId = "1";
+        String familyId = "1";
+
+        // when
+        when(familyRepository.findById(familyId)).thenReturn(Optional.of(new Family(familyId, null, null)));
+
+        // then
+        assertThrows(InvalidParameterException.class, () -> familyService.updateFamilyName(familyId, memberId, newName));
+    }
+
+    @Test
+    void 공백만을_포함한_이름_수정_예외_검증() {
+        // given
+        String newName = " ";
+        String memberId = "1";
+        String familyId = "1";
+
+        // when
+        when(familyRepository.findById(familyId)).thenReturn(Optional.of(new Family(familyId, null, null)));
+
+        // then
+        assertThrows(InvalidParameterException.class, () -> familyService.updateFamilyName(familyId, memberId, newName));
+    }
+}
diff --git a/gateway/src/main/java/com/oing/controller/MainViewController.java b/gateway/src/main/java/com/oing/controller/MainViewController.java
@@ -30,6 +30,7 @@ public class MainViewController implements MainViewApi {
     private final MemberBridge memberBridge;
     private final MissionBridge missionBridge;
     private final PostController postController;
+    private final FamilyBridge familyBridge;
 
     private static final int PAGE_FETCH_SIZE = 1000;
 
@@ -75,10 +76,12 @@ public DaytimePageResponse getDaytimePage(
                 .isMeMissionUploadedToday();
         int leftUploadCountUntilMissionUnlock = postController.getRemainingSurvivalPostCount(loginMemberId, loginMemberId, familyId)
                 .leftUploadCountUntilMissionUnlock();
+        String familyName = familyBridge.findFamilyNameByFamilyId(familyId);
 
         return new DaytimePageResponse(
                 members.stream().sorted(comparator).map((member) -> new MainPageTopBarResponse(
                         member.memberId(),
+                        familyName,
                         member.imageUrl(),
                         String.valueOf(member.name().charAt(0)),
                         member.name(),
@@ -143,8 +146,10 @@ public DaytimePageResponse getDaytimePage(
     public NighttimePageResponse getNighttimePage(String loginMemberId, String loginFamilyId) {
         Page<FamilyMemberProfileResponse> members = memberService.getFamilyMembersProfilesByFamilyId(loginFamilyId, 1, PAGE_FETCH_SIZE);
         LocalDate today = ZonedDateTime.now().toLocalDate();
+        String familyName = familyBridge.findFamilyNameByFamilyId(loginFamilyId);
         List<MainPageTopBarResponse> mainPageTopBarResponses = members.stream().map((member) -> new MainPageTopBarResponse(
                 member.memberId(),
+                familyName,
                 member.imageUrl(),
                 String.valueOf(member.name().charAt(0)),
                 member.name(),
diff --git a/gateway/src/main/java/com/oing/dto/response/MainPageTopBarResponse.java b/gateway/src/main/java/com/oing/dto/response/MainPageTopBarResponse.java
@@ -13,6 +13,9 @@ public record MainPageTopBarResponse(
         @Schema(description = "멤버ID", example = "01HGW2N7EHJVJ4CJ999RRS2E97")
         String memberId,
 
+        @Schema(description = "가족 이름", example = "미밍이네")
+        String familyName,
+
         @Schema(description = "이미지 URL", example = "https://no5ing.com/image/01HGW2N7EHJVJ4CJ999RRS2E97")
         String imageUrl,
 
diff --git a/gateway/src/main/resources/db/migration/V202406211527__add_family_name_editor_id_column_to_family_tbl.sql b/gateway/src/main/resources/db/migration/V202406211527__add_family_name_editor_id_column_to_family_tbl.sql
@@ -0,0 +1 @@
+ALTER TABLE `family` ADD COLUMN (`family_name_editor_id` CHAR(26) COMMENT 'ULID');
diff --git a/gateway/src/test/java/com/oing/event/FamilyScoreEventListenerTest.java b/gateway/src/test/java/com/oing/event/FamilyScoreEventListenerTest.java
@@ -68,7 +68,7 @@ class FamilyScoreEventListenerTest {
 
     @BeforeEach
     void setUp() {
-        familyRepository.save(new Family(testMember1.getFamilyId(), null));
+        familyRepository.save(new Family(testMember1.getFamilyId(), null, null));
         memberRepository.save(testMember1);
         memberRepository.save(testMember2);
     }
diff --git a/gateway/src/test/java/com/oing/repository/MemberRepositoryCustomTest.java b/gateway/src/test/java/com/oing/repository/MemberRepositoryCustomTest.java
@@ -70,7 +70,7 @@ public class MemberRepositoryCustomTest {
     @BeforeEach
     void setup() {
         // Family & Members
-        familyRepository.save(new Family("testFamily", null));
+        familyRepository.save(new Family("testFamily", null, null));
         memberRepository.save(testMember1);
         memberRepository.save(testMember2);
         memberRepository.save(testMember3);
diff --git a/gateway/src/test/java/com/oing/repository/PostRepositoryCustomTest.java b/gateway/src/test/java/com/oing/repository/PostRepositoryCustomTest.java
@@ -84,7 +84,7 @@ class PostRepositoryCustomTest {
     @BeforeEach
     void setup() {
         // Family & Members
-        familyRepository.save(new Family("testFamily", null));
+        familyRepository.save(new Family("testFamily", null, null));
         memberRepository.save(testMember1);
         memberRepository.save(testMember2);
         memberRepository.save(testMember3);

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ public class FamilyService {`
`24`	`24`
`25`	`25`	`@Transactional`
`26`	`26`	`public Family createFamily() {`
`27`		`- Family family = new Family(identityGenerator.generateIdentity(), null);`
	`27`	`+ Family family = new Family(identityGenerator.generateIdentity(), null, null);`
`28`	`28`	`return familyRepository.save(family);`
`29`	`29`	`}`
`30`	`30`
`@@ -57,4 +57,11 @@ private int calculateLiveFamilyTopPercentage(String familyId) {`
`57`	`57`	`// score 를 통한 순위를 통해 전체 가족들 중 상위 백분율 계산 (1%에 가까울수록 고순위)`
`58`	`58`	`return familyScoreBridge.calculateFamilyTopPercentage(rank, familiesCount);`
`59`	`59`	`}`
	`60`	`+`
	`61`	`+ @Transactional`
	`62`	`+ public Family updateFamilyName(String familyId, String loginMemberId, String familyName) {`
	`63`	`+ Family family = getFamilyById(familyId);`
	`64`	`+ family.updateFamilyName(familyName, loginMemberId);`
	`65`	`+ return family;`
	`66`	`+ }`
`60`	`67`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+ALTER TABLE `family` ADD COLUMN (`family_name_editor_id` CHAR(26) COMMENT 'ULID');