feat: 유저 태그 생성 API

Author: leeedohyun

capturecat-core/src/main/java/com/capturecat/core/api/user/UserTagController.java

@@ -0,0 +1,29 @@
+package com.capturecat.core.api.user;
+
+import org.springframework.security.core.annotation.AuthenticationPrincipal;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+import lombok.RequiredArgsConstructor;
+
+import com.capturecat.core.service.auth.LoginUser;
+import com.capturecat.core.service.image.TagResponse;
+import com.capturecat.core.service.user.UserTagService;
+import com.capturecat.core.support.response.ApiResponse;
+
+@RestController
+@RequiredArgsConstructor
+@RequestMapping("/v1/user-tags")
+public class UserTagController {
+
+	private final UserTagService userTagService;
+
+	@PostMapping
+	public ApiResponse<TagResponse> create(@AuthenticationPrincipal LoginUser loginUser, @RequestParam String tagName) {
+		TagResponse tagResponse = userTagService.create(loginUser, tagName);
+
+		return ApiResponse.success(tagResponse);
+	}
+}

capturecat-core/src/main/java/com/capturecat/core/domain/tag/TagRegister.java

@@ -38,4 +38,15 @@ public List<Tag> registerTagsFor(List<String> tagNames) {
 		result.addAll(savedNewTags);
 		return result;
 	}
+
+	/**
+	 * 등록되지 않은 태그는 등록하고, 이미 존재하는 태그는 그대로 반환합니다.
+	 * @param tagName 태그 이름
+	 * @return 조회되거나 새로 생성된 {@link Tag} 엔티티
+	 */
+	@Transactional
+	public Tag registerTagsFor(String tagName) {
+		return tagRepository.findByName(tagName)
+			.orElseGet(() -> tagRepository.save(new Tag(tagName)));
+	}
 }

capturecat-core/src/main/java/com/capturecat/core/domain/tag/TagRepository.java

@@ -1,10 +1,13 @@
 package com.capturecat.core.domain.tag;
 
 import java.util.List;
+import java.util.Optional;
 
 import org.springframework.data.jpa.repository.JpaRepository;
 
 public interface TagRepository extends JpaRepository<Tag, Long>, TagCustomRepository {
 
 	List<Tag> findByNameIn(List<String> names);
+
+	Optional<Tag> findByName(String name);
 }

capturecat-core/src/main/java/com/capturecat/core/domain/user/UserTag.java

@@ -11,6 +11,7 @@
 import jakarta.persistence.UniqueConstraint;
 
 import lombok.AccessLevel;
+import lombok.Getter;
 import lombok.NoArgsConstructor;
 
 import com.capturecat.core.domain.BaseTimeEntity;
@@ -21,6 +22,7 @@
 	uniqueConstraints = @UniqueConstraint(name = "uk_user_tag_user_tag", columnNames = {"user_id", "tag_id"})
 )
 @NoArgsConstructor(access = AccessLevel.PROTECTED)
+@Getter
 public class UserTag extends BaseTimeEntity {
 
 	@Id
@@ -34,4 +36,13 @@ public class UserTag extends BaseTimeEntity {
 	@ManyToOne(fetch = FetchType.LAZY)
 	@JoinColumn(name = "tag_id")
 	private Tag tag;
+
+	private UserTag(User user, Tag tag) {
+		this.user = user;
+		this.tag = tag;
+	}
+
+	public static UserTag create(User user, Tag tag) {
+		return new UserTag(user, tag);
+	}
 }

capturecat-core/src/main/java/com/capturecat/core/domain/user/UserTagRepository.java

@@ -0,0 +1,12 @@
+package com.capturecat.core.domain.user;
+
+import org.springframework.data.jpa.repository.JpaRepository;
+
+import com.capturecat.core.domain.tag.Tag;
+
+public interface UserTagRepository extends JpaRepository<UserTag, Long> {
+
+	boolean existsByUserAndTag(User user, Tag tag);
+
+	long countByUser(User user);
+}

capturecat-core/src/main/java/com/capturecat/core/service/user/UserTagService.java

@@ -0,0 +1,67 @@
+package com.capturecat.core.service.user;
+
+import org.springframework.dao.DataIntegrityViolationException;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
+
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+
+import com.capturecat.core.domain.tag.Tag;
+import com.capturecat.core.domain.tag.TagRegister;
+import com.capturecat.core.domain.user.User;
+import com.capturecat.core.domain.user.UserRepository;
+import com.capturecat.core.domain.user.UserTag;
+import com.capturecat.core.domain.user.UserTagRepository;
+import com.capturecat.core.service.auth.LoginUser;
+import com.capturecat.core.service.image.TagResponse;
+import com.capturecat.core.support.error.CoreException;
+import com.capturecat.core.support.error.ErrorType;
+
+@Slf4j
+@Service
+@RequiredArgsConstructor
+public class UserTagService {
+
+	private static final int MAX_USER_TAG_COUNT = 30;
+
+	private final UserRepository userRepository;
+	private final UserTagRepository userTagRepository;
+	private final TagRegister tagRegister;
+
+	@Transactional
+	public TagResponse create(LoginUser loginUser, String tagName) {
+		try {
+			User user = userRepository.findByUsername(loginUser.getUsername())
+				.orElseThrow(() -> new CoreException(ErrorType.USER_NOT_FOUND));
+			Tag tag = tagRegister.registerTagsFor(tagName);
+
+			validate(user, tag);
+
+			userTagRepository.save(UserTag.create(user, tag));
+
+			return TagResponse.from(tag);
+		} catch (DataIntegrityViolationException ex) {
+			throw new CoreException(ErrorType.USER_TAG_ALREADY_EXISTS);
+		}
+	}
+
+	private void validate(User user, Tag tag) {
+		validateDuplicateUserTag(user, tag);
+		validateUserTagCountLimit(user);
+	}
+
+	private void validateDuplicateUserTag(User user, Tag tag) {
+		if (userTagRepository.existsByUserAndTag(user, tag)) {
+			throw new CoreException(ErrorType.USER_TAG_ALREADY_EXISTS);
+		}
+	}
+
+	private void validateUserTagCountLimit(User user) {
+		long userTagCount = userTagRepository.countByUser(user);
+
+		if (userTagCount >= MAX_USER_TAG_COUNT) {
+			throw new CoreException(ErrorType.TOO_MANY_USER_TAGS);
+		}
+	}
+}

capturecat-core/src/main/java/com/capturecat/core/support/error/ErrorCode.java

@@ -38,7 +38,9 @@ public enum ErrorCode {
 	SOCIAL_API_ERROR("소셜 서비스 API 호출 결과 실패를 응답받았습니다."),
 	MISSING_PARAMETER("필수 파라미터 %s(이)가 누락되었습니다."),
 	INTERNAL_SERVER_ERROR("서버에서 오류가 발생했습니다."),
-	INVALID_LOGOUT_AUTH_TOKEN("ACCESS 토큰 또는 REFRESH 토큰이 유효하지 않습니다.");
+	INVALID_LOGOUT_AUTH_TOKEN("ACCESS 토큰 또는 REFRESH 토큰이 유효하지 않습니다."),
+	ALREADY_EXISTS_USER_TAG("이미 등록된 유저 태그입니다."),
+	EXCEED_MAX_USER_TAG_COUNT("태그는 한 계정당 최대 30개까지 추가할 수 있어요.");
 
 	private final String message;
 

capturecat-core/src/main/java/com/capturecat/core/support/error/ErrorType.java

@@ -38,11 +38,14 @@ public enum ErrorType {
 	INVALID_LOGOUT_AUTH_TOKEN(HttpStatus.UNAUTHORIZED, ErrorCode.INVALID_LOGOUT_AUTH_TOKEN, LogLevel.WARN),
 	BOOKMARK_NOT_FOUND(HttpStatus.NOT_FOUND, ErrorCode.NOT_FOUND_BOOKMARK, LogLevel.WARN),
 	GENERATE_CLIENT_SECRET_FAIL(HttpStatus.INTERNAL_SERVER_ERROR, ErrorCode.GENERATE_CLIENT_SECRET_FAIL,
-		LogLevel.ERROR), UNLINK_SOCIAL_FAIL(HttpStatus.BAD_REQUEST, ErrorCode.UNLINK_SOCIAL_FAIL, LogLevel.WARN),
+		LogLevel.ERROR),
+	UNLINK_SOCIAL_FAIL(HttpStatus.BAD_REQUEST, ErrorCode.UNLINK_SOCIAL_FAIL, LogLevel.WARN),
 	FETCH_SOCIAL_TOKEN_FAIL(HttpStatus.BAD_REQUEST, ErrorCode.FETCH_SOCIAL_TOKEN_FAIL, LogLevel.WARN),
 	SOCIAL_API_ERROR(HttpStatus.INTERNAL_SERVER_ERROR, ErrorCode.SOCIAL_API_ERROR, LogLevel.WARN),
 	MISSING_PARAMETER(HttpStatus.BAD_REQUEST, ErrorCode.MISSING_PARAMETER, LogLevel.WARN),
-	INTERNAL_SERVER_ERROR(HttpStatus.INTERNAL_SERVER_ERROR, ErrorCode.INTERNAL_SERVER_ERROR, LogLevel.ERROR);
+	INTERNAL_SERVER_ERROR(HttpStatus.INTERNAL_SERVER_ERROR, ErrorCode.INTERNAL_SERVER_ERROR, LogLevel.ERROR),
+	USER_TAG_ALREADY_EXISTS(HttpStatus.BAD_REQUEST, ErrorCode.ALREADY_EXISTS_USER_TAG, LogLevel.WARN),
+	TOO_MANY_USER_TAGS(HttpStatus.BAD_REQUEST, ErrorCode.EXCEED_MAX_USER_TAG_COUNT, LogLevel.WARN);
 
 	private final HttpStatus status;
 

capturecat-core/src/test/java/com/capturecat/core/api/user/UserErrorCodeControllerTest.java

@@ -0,0 +1,22 @@
+package com.capturecat.core.api.user;
+
+import static com.capturecat.core.support.error.ErrorType.TOO_MANY_USER_TAGS;
+import static com.capturecat.core.support.error.ErrorType.USER_NOT_FOUND;
+import static com.capturecat.core.support.error.ErrorType.USER_TAG_ALREADY_EXISTS;
+
+import java.util.List;
+
+import org.junit.jupiter.api.Test;
+
+import com.capturecat.core.api.error.ErrorCodeDocumentTest;
+import com.capturecat.test.snippet.ErrorCodeDescriptor;
+
+class UserErrorCodeControllerTest extends ErrorCodeDocumentTest {
+
+	@Test
+	void 유저_태그_생성_에러_코드_문서화() {
+		List<ErrorCodeDescriptor> errorCodeDescriptors = generateErrorCodeDescriptors(USER_TAG_ALREADY_EXISTS,
+			TOO_MANY_USER_TAGS, USER_NOT_FOUND);
+		generateErrorDocs("errorCode/createUserTag", errorCodeDescriptors);
+	}
+}

capturecat-core/src/test/java/com/capturecat/core/api/user/UserTagControllerTest.java

@@ -0,0 +1,65 @@
+package com.capturecat.core.api.user;
+
+import static com.capturecat.test.api.RestDocsUtil.requestPreprocessor;
+import static com.capturecat.test.api.RestDocsUtil.responsePreprocessor;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.Mockito.mock;
+import static org.springframework.restdocs.headers.HeaderDocumentation.headerWithName;
+import static org.springframework.restdocs.headers.HeaderDocumentation.requestHeaders;
+import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;
+import static org.springframework.restdocs.payload.PayloadDocumentation.fieldWithPath;
+import static org.springframework.restdocs.payload.PayloadDocumentation.responseFields;
+import static org.springframework.restdocs.request.RequestDocumentation.parameterWithName;
+import static org.springframework.restdocs.request.RequestDocumentation.queryParameters;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.mockito.BDDMockito;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpStatus;
+import org.springframework.restdocs.payload.JsonFieldType;
+
+import io.restassured.http.ContentType;
+
+import com.capturecat.core.config.jwt.JwtUtil;
+import com.capturecat.core.service.image.TagResponse;
+import com.capturecat.core.service.user.UserTagService;
+import com.capturecat.test.api.RestDocsTest;
+
+class UserTagControllerTest extends RestDocsTest {
+
+	private static final String ACCESS_TOKEN = "valid-access-token";
+
+	private UserTagController userTagController;
+	private UserTagService userTagService;
+
+	@BeforeEach
+	void setUp() {
+		userTagService = mock(UserTagService.class);
+		userTagController = new UserTagController(userTagService);
+		mockMvc = mockController(userTagController);
+	}
+
+	@Test
+	void 유저_태그_생성() {
+		// given
+		BDDMockito.given(userTagService.create(any(), anyString())).willReturn(new TagResponse(1L, "java"));
+
+		// when & then
+		given()
+			.header(HttpHeaders.AUTHORIZATION, JwtUtil.BEARER_PREFIX + ACCESS_TOKEN)
+			.contentType(ContentType.JSON)
+			.queryParam("tagName", "java")
+			.when().post("/v1/user-tags")
+			.then().status(HttpStatus.OK)
+			.apply(document("createUserTag", requestPreprocessor(), responsePreprocessor(),
+				requestHeaders(headerWithName(HttpHeaders.AUTHORIZATION).description("유효한 Access 토큰")),
+				queryParameters(parameterWithName("tagName").description("태그 이름")),
+				responseFields(
+					fieldWithPath("result").type(JsonFieldType.STRING).description("요청 결과"),
+					fieldWithPath("data").type(JsonFieldType.OBJECT).description("사용자가 등록한 태그 정보"),
+					fieldWithPath("data.id").type(JsonFieldType.NUMBER).description("태그 ID"),
+					fieldWithPath("data.name").type(JsonFieldType.STRING).description("태그 이름"))));
+	}
+}