feat, fix, chore, docs: 여러 자잘한 수정

.github/workflows/deploy-dev.yml

@@ -21,7 +21,7 @@ jobs:
           SSH_DEST: ${{ secrets.DEV_SSH_DEST }}
           SSH_KEY: ${{ secrets.DEV_SSH_KEY }}
         with:
-          version: 0.11.8
+          version: 0.11.9
           verb: call
           module: ./cicd
           args: >-

.github/workflows/deploy-stag.yml

@@ -21,7 +21,7 @@ jobs:
           SSH_DEST: ${{ secrets.STAG_SSH_DEST }}
           SSH_KEY: ${{ secrets.STAG_SSH_KEY }}
         with:
-          version: 0.11.8
+          version: 0.11.9
           verb: call
           module: ./cicd
           args: >-

api/src/main/java/vook/server/api/domain/vocabulary/model/Term.java

@@ -31,6 +31,12 @@ public class Term extends BaseEntity {
     @Column(length = 2000, nullable = false)
     private String meaning;
 
+    /**
+     * 동의어
+     */
+    @Column(length = 1000)
+    private String synonym;
+
     @OneToMany(mappedBy = "term", fetch = FetchType.EAGER, cascade = CascadeType.ALL, orphanRemoval = true)
     private List<TermSynonym> synonyms = new ArrayList<>();
 
@@ -66,13 +72,15 @@ public static Term forUpdateOf(
         return result;
     }
 
-    private void addAllSynonym(List<String> synonyms) {
-        synonyms.forEach(s -> this.synonyms.add(TermSynonym.forCreateOf(s, this)));
+    private void addAllSynonym(List<String> input) {
+        this.synonym = String.join(",", input);
+        input.forEach(s -> this.synonyms.add(TermSynonym.forCreateOf(s, this)));
     }
 
     public void update(Term term) {
         this.term = term.getTerm();
         this.meaning = term.getMeaning();
+        this.synonym = term.getSynonym();
         this.synonyms.clear();
         this.synonyms.addAll(term.getSynonyms());
     }

api/src/main/java/vook/server/api/domain/vocabulary/service/TermService.java

@@ -1,6 +1,7 @@
 package vook.server.api.domain.vocabulary.service;
 
 import jakarta.validation.Valid;
+import jakarta.validation.constraints.NotBlank;
 import lombok.RequiredArgsConstructor;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
@@ -31,17 +32,17 @@ public Term create(@Valid TermCreateCommand command) {
         return termRepository.save(term);
     }
 
-    public Term getByUid(String uid) {
+    public Term getByUid(@NotBlank String uid) {
         return termRepository.findByUid(uid).orElseThrow(TermNotFoundException::new);
     }
 
-    public void update(TermUpdateCommand serviceCommand) {
+    public void update(@Valid TermUpdateCommand serviceCommand) {
         Term term = termRepository.findByUid(serviceCommand.getUid()).orElseThrow(TermNotFoundException::new);
         Term updateTerm = serviceCommand.toEntity();
         term.update(updateTerm);
     }
 
-    public void delete(String uid) {
+    public void delete(@NotBlank String uid) {
         Term term = termRepository.findByUid(uid).orElseThrow(TermNotFoundException::new);
         term.getVocabulary().removeTerm(term);
         termRepository.delete(term);

api/src/main/java/vook/server/api/domain/vocabulary/service/data/TermCreateCommand.java

@@ -1,5 +1,6 @@
 package vook.server.api.domain.vocabulary.service.data;
 
+import jakarta.validation.Valid;
 import jakarta.validation.constraints.NotBlank;
 import jakarta.validation.constraints.NotNull;
 import jakarta.validation.constraints.Size;
@@ -28,7 +29,9 @@ public class TermCreateCommand {
     private String meaning;
 
     @NotNull
-    private List<String> synonyms;
+    @Valid
+    @Size(max = 10)
+    private List<@Size(min = 1, max = 100) String> synonyms;
 
     @Builder
     private static TermCreateCommand of(String vocabularyUid, String term, String meaning, List<String> synonyms) {

api/src/main/java/vook/server/api/domain/vocabulary/service/data/TermUpdateCommand.java

@@ -1,5 +1,6 @@
 package vook.server.api.domain.vocabulary.service.data;
 
+import jakarta.validation.Valid;
 import jakarta.validation.constraints.NotBlank;
 import jakarta.validation.constraints.NotNull;
 import jakarta.validation.constraints.Size;
@@ -24,7 +25,9 @@ public class TermUpdateCommand {
     private String meaning;
 
     @NotNull
-    private List<String> synonyms;
+    @Valid
+    @Size(max = 10)
+    private List<@Size(min = 1, max = 100) String> synonyms;
 
     @Builder
     private static TermUpdateCommand of(String uid, String term, String meaning, List<String> synonyms) {

api/src/main/java/vook/server/api/web/term/TermApi.java

@@ -27,7 +27,8 @@ public interface TermApi {
                     @SecurityRequirement(name = "AccessToken")
             },
             description = """
-                    비즈니스 규칙 위반 내용
+                    ## 비즈니스 규칙 위반 내용
+
                     - VocabularyNotFound: 사용자의 용어집 중 해당 ID의 용어집이 존재하지 않는 경우
                     - TermLimitExceeded: 사용자의 용어집에 용어를 추가할 수 있는 제한을 초과한 경우
                     - NotValidVocabularyOwner: 용어를 추가하려는 용어집에 대한 권한이 없는 경우"""
@@ -52,11 +53,12 @@ class TermApiCreateResponse extends CommonApiResponse<TermCreateResponse> {
                     @SecurityRequirement(name = "AccessToken")
             },
             description = """
-                    ## 허용하는 sort 키워드 
-                    term, meaning, createdAt
+                    ## 허용하는 sort 키워드
+                    term, synonym, meaning, createdAt
 
                     사용 예시
                     - term,asc
+                    - synonym,desc
                     - meaning,desc
                     - createdAt,asc
 
@@ -83,7 +85,7 @@ class TermApiRetrieveResponse extends CommonApiResponse<TermResponse> {
                     @SecurityRequirement(name = "AccessToken")
             },
             description = """
-                    비즈니스 규칙 위반 내용
+                    ## 비즈니스 규칙 위반 내용
                     - TermNotFound: 삭제하려는 용어가 존재하지 않는 경우
                     - NotValidVocabularyOwner: 조회하려는 용어가 속해있는 용어집에 대한 권한이 없는 경우"""
     )
@@ -95,7 +97,7 @@ class TermApiRetrieveResponse extends CommonApiResponse<TermResponse> {
                     @SecurityRequirement(name = "AccessToken")
             },
             description = """
-                    비즈니스 규칙 위반 내용
+                    ## 비즈니스 규칙 위반 내용
                     - TermNotFound: 삭제하려는 용어가 존재하지 않는 경우
                     - NotValidVocabularyOwner: 삭제하려는 용어가 속해있는 용어집에 대한 권한이 없는 경우"""
     )

api/src/main/java/vook/server/api/web/term/reqres/TermCreateRequest.java

@@ -1,5 +1,6 @@
 package vook.server.api.web.term.reqres;
 
+import jakarta.validation.Valid;
 import jakarta.validation.constraints.NotBlank;
 import jakarta.validation.constraints.Size;
 import lombok.Data;
@@ -23,7 +24,9 @@ public class TermCreateRequest {
     @Size(min = 1, max = 2000)
     private String meaning;
 
-    private List<String> synonyms = new ArrayList<>();
+    @Valid
+    @Size(max = 10)
+    private List<@Size(min = 1, max = 100) String> synonyms = new ArrayList<>();
 
     public CreateTermUseCase.Command toCommand(VookLoginUser loginUser) {
         return new CreateTermUseCase.Command(

api/src/main/java/vook/server/api/web/term/reqres/TermUpdateRequest.java

@@ -1,5 +1,6 @@
 package vook.server.api.web.term.reqres;
 
+import jakarta.validation.Valid;
 import jakarta.validation.constraints.NotBlank;
 import jakarta.validation.constraints.Size;
 import lombok.Data;
@@ -20,7 +21,9 @@ public class TermUpdateRequest {
     @Size(min = 1, max = 2000)
     private String meaning;
 
-    private List<String> synonyms = new ArrayList<>();
+    @Valid
+    @Size(max = 10)
+    private List<@Size(min = 1, max = 100) String> synonyms = new ArrayList<>();
 
     public UpdateTermUseCase.Command toCommand(VookLoginUser loginUser, String termUid) {
         return new UpdateTermUseCase.Command(

api/src/main/java/vook/server/api/web/user/UserApi.java

@@ -45,7 +45,7 @@ class UserApiUserInfoResponse extends CommonApiResponse<UserInfoResponse> {
                     @SecurityRequirement(name = "AccessToken")
             },
             description = """
-                    비즈니스 규칙 위반 내용
+                    ## 비즈니스 규칙 위반 내용
                     - AlreadyRegistered: 이미 회원가입이 완료된 유저가 해당 API를 호출 할 경우
                     - WithdrawnUser: 탈퇴한 유저가 해당 API를 호출 할 경우"""
     )
@@ -70,7 +70,7 @@ class UserApiUserInfoResponse extends CommonApiResponse<UserInfoResponse> {
                     @SecurityRequirement(name = "AccessToken")
             },
             description = """
-                    비즈니스 규칙 위반 내용
+                    ## 비즈니스 규칙 위반 내용
                     - NotReadyToOnboarding: 회원 가입이 완료되지 않은 유저가 해당 API를 호출 할 경우
                     - AlreadyOnboarding: 이미 온보딩이 완료된 유저가 해당 API를 호출 할 경우"""
     )
@@ -95,7 +95,7 @@ class UserApiUserInfoResponse extends CommonApiResponse<UserInfoResponse> {
                     @SecurityRequirement(name = "AccessToken")
             },
             description = """
-                    비즈니스 규칙 위반 내용
+                    ## 비즈니스 규칙 위반 내용
                     - NotRegistered: 가입하지 않은 유저가 해당 API를 호출 할 경우"""
     )
     @ApiResponses(value = {

api/src/main/java/vook/server/api/web/vocabulary/VocabularyApi.java

@@ -46,7 +46,7 @@ class VocabularyApiVocabulariesResponse extends CommonApiResponse<List<Vocabular
                     @SecurityRequirement(name = "AccessToken")
             },
             description = """
-                    비즈니스 규칙 위반 내용
+                    ## 비즈니스 규칙 위반 내용
                     - VocabularyLimitExceeded: 사용자의 용어집 생성 제한을 초과하여 용어집을 생성할 수 없는 경우 (3개 초과)"""
     )
     @ApiResponses(value = {
@@ -70,7 +70,7 @@ class VocabularyApiVocabulariesResponse extends CommonApiResponse<List<Vocabular
                     @SecurityRequirement(name = "AccessToken")
             },
             description = """
-                    비즈니스 규칙 위반 내용
+                    ## 비즈니스 규칙 위반 내용
                     - VocabularyNotFound: 사용자의 용어집 중 해당 ID의 용어집이 존재하지 않는 경우"""
     )
     @ApiResponses(value = {
@@ -98,7 +98,7 @@ CommonApiResponse<Void> updateVocabulary(
                     @SecurityRequirement(name = "AccessToken")
             },
             description = """
-                    비즈니스 규칙 위반 내용
+                    ## 비즈니스 규칙 위반 내용
                     - VocabularyNotFound: 사용자의 용어집 중 해당 ID의 용어집이 존재하지 않는 경우"""
     )
     @ApiResponses(value = {

api/src/test/java/vook/server/api/testhelper/creator/TestVocabularyCreator.java

@@ -38,7 +38,7 @@ public Term createTerm(Vocabulary vocabulary, String suffix) {
                 .vocabularyUid(vocabulary.getUid())
                 .term("testTerm" + suffix)
                 .meaning("testMeaning" + suffix)
-                .synonyms(List.of("testSynonym" + suffix))
+                .synonyms(List.of("testSynonymA" + suffix, "testSynonymB" + suffix))
                 .build());
     }
 }

api/src/test/java/vook/server/api/usecases/term/CreateTermUseCaseTest.java

@@ -64,6 +64,7 @@ void execute() {
         Term term = termRepository.findByUid(result.uid()).orElseThrow();
         assertThat(term.getTerm()).isEqualTo(command.term());
         assertThat(term.getMeaning()).isEqualTo(command.meaning());
+        assertThat(term.getSynonym()).isEqualTo(String.join(",", command.synonyms()));
         assertThat(term.getSynonyms().stream().map(TermSynonym::getSynonym))
                 .containsExactlyInAnyOrderElementsOf(command.synonyms());
         assertThat(term.getVocabulary().termCount()).isEqualTo(1);

api/src/test/java/vook/server/api/usecases/term/RetrieveTermUseCaseTest.java

@@ -151,6 +151,34 @@ Collection<DynamicTest> executeSort() {
                             PageRequest.of(0, Integer.MAX_VALUE, Sort.Direction.DESC, "createdAt")
                     ));
 
+                    // then
+                    assertThat(result.terms().getContent()).hasSize(3);
+                    assertThat(result.terms().getContent().get(0).termUid()).isEqualTo(term3.getUid());
+                    assertThat(result.terms().getContent().get(1).termUid()).isEqualTo(term2.getUid());
+                    assertThat(result.terms().getContent().get(2).termUid()).isEqualTo(term1.getUid());
+                }),
+                DynamicTest.dynamicTest("동의어 오름차순", () -> {
+                    // when
+                    RetrieveTermUseCase.Result result = useCase.execute(new RetrieveTermUseCase.Command(
+                            user.getUid(),
+                            vocabulary.getUid(),
+                            PageRequest.of(0, Integer.MAX_VALUE, Sort.Direction.ASC, "synonym")
+                    ));
+
+                    // then
+                    assertThat(result.terms().getContent()).hasSize(3);
+                    assertThat(result.terms().getContent().get(0).termUid()).isEqualTo(term1.getUid());
+                    assertThat(result.terms().getContent().get(1).termUid()).isEqualTo(term2.getUid());
+                    assertThat(result.terms().getContent().get(2).termUid()).isEqualTo(term3.getUid());
+                }),
+                DynamicTest.dynamicTest("동의어 내림차순", () -> {
+                    // when
+                    RetrieveTermUseCase.Result result = useCase.execute(new RetrieveTermUseCase.Command(
+                            user.getUid(),
+                            vocabulary.getUid(),
+                            PageRequest.of(0, Integer.MAX_VALUE, Sort.Direction.DESC, "synonym")
+                    ));
+
                     // then
                     assertThat(result.terms().getContent()).hasSize(3);
                     assertThat(result.terms().getContent().get(0).termUid()).isEqualTo(term3.getUid());

api/src/test/java/vook/server/api/usecases/term/UpdateTermUseCaseTest.java

@@ -58,6 +58,7 @@ void execute() {
         assertThat(updatedTerm.getTerm()).isEqualTo(command.term());
         assertThat(updatedTerm.getMeaning()).isEqualTo(command.meaning());
         assertThat(updatedTerm.getSynonyms()).isEmpty();
+        assertThat(updatedTerm.getSynonym()).isEmpty();
     }
 
     @Test

cicd/dagger.json

@@ -24,5 +24,5 @@
     }
   ],
   "source": "dagger",
-  "engineVersion": "v0.11.8"
+  "engineVersion": "v0.11.9"
 }