Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/s1-api-spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -817,7 +817,9 @@ GET /api/v1/users/me/usage

##### Error Code

이 API 전용 에러 없음 (공통 에러만)
| HttpStatus | ResultCode | ErrorMessage | Description |
| --- | --- | --- | --- |
| 404 | USER404_1 | 회원 정보를 찾을 수 없어요. | 탈퇴했거나 없는 회원의 토큰 |

##### 비고

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@
import com.sniptext.domain.template.service.dto.result.TemplateShortcutAssignResult;
import com.sniptext.domain.template.service.dto.result.TemplateUpdateResult;
import com.sniptext.domain.template.service.dto.result.TemplateUsageResult;
import com.sniptext.domain.template.support.TemplateLimit;
import com.sniptext.domain.user.service.UserCommandService;
import com.sniptext.global.exception.BusinessException;
import com.sniptext.global.policy.UsageLimits;

import lombok.RequiredArgsConstructor;

Expand Down Expand Up @@ -174,7 +174,7 @@ private static void requireNoOuterTransaction() {

/** 활성 템플릿(휴지통 제외)이 한도 이상이면 TEMPLATE403_1 */
void validateTemplateLimit(Long userId) {
if (templateRepository.countByUserIdAndDeletedAtIsNull(userId) >= UsageLimits.TEMPLATE_LIMIT) {
if (TemplateLimit.isReached(templateRepository.countByUserIdAndDeletedAtIsNull(userId))) {
throw new BusinessException(TemplateErrorCode.TEMPLATE_LIMIT_REACHED);
}
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
package com.sniptext.domain.template.support;

import com.sniptext.global.policy.UsageLimits;

/**
* 보유 템플릿 한도 규칙. 활성 템플릿(휴지통 제외)이 한도 이상이면 더 만들 수 없다.
* 저장 차단(TemplateCommandService)과 사용량 화면 표시(사용량 API)가 같은 기준을 쓰도록 여기 한 곳에 둔다.
* 한도 숫자는 UsageLimits에서 가져온다.
*/
public final class TemplateLimit {

private TemplateLimit() {
}

public static boolean isReached(long activeCount) {
return activeCount >= UsageLimits.TEMPLATE_LIMIT;
}

/** 더 만들 수 있는 개수. 한도 이상이면 0이다 */
public static int remaining(long activeCount) {
return Math.toIntExact(Math.max(UsageLimits.TEMPLATE_LIMIT - activeCount, 0));
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,11 @@
import org.springframework.web.bind.annotation.RestController;

import com.sniptext.domain.user.controller.dto.UserDetailResponse;
import com.sniptext.domain.user.controller.dto.UserUsageResponse;
import com.sniptext.domain.user.service.UserQueryService;
import com.sniptext.domain.user.service.UserUsageQueryService;
import com.sniptext.domain.user.service.dto.result.UserDetailResult;
import com.sniptext.domain.user.service.dto.result.UserUsageResult;
import com.sniptext.global.response.ApiResponse;
import com.sniptext.global.security.LoginUser;

Expand All @@ -22,6 +25,7 @@
public class UserController {

private final UserQueryService userQueryService;
private final UserUsageQueryService userUsageQueryService;

@GetMapping("/me")
public ResponseEntity<ApiResponse<UserDetailResponse>> getMe(@LoginUser Long userId) {
Expand All @@ -30,4 +34,11 @@ public ResponseEntity<ApiResponse<UserDetailResponse>> getMe(@LoginUser Long use
return ApiResponse.success(UserSuccessCode.USER_FOUND, UserDetailResponse.from(result));
}

@GetMapping("/me/usage")
public ResponseEntity<ApiResponse<UserUsageResponse>> getUsage(@LoginUser Long userId) {
UserUsageResult result = userUsageQueryService.getUsage(userId);

return ApiResponse.success(UserSuccessCode.USAGE_FOUND, UserUsageResponse.from(result));
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@
@RequiredArgsConstructor
public enum UserSuccessCode implements ResultCode {

USER_FOUND(HttpStatus.OK, "USER200_1", "내 정보 조회에 성공했습니다.");
USER_FOUND(HttpStatus.OK, "USER200_1", "내 정보 조회에 성공했습니다."),
USAGE_FOUND(HttpStatus.OK, "USER200_2", "사용량 조회에 성공했습니다.");

private final HttpStatus httpStatus;
private final String code;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
package com.sniptext.domain.user.controller.dto;

import java.time.LocalDateTime;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.sniptext.domain.user.service.dto.result.UserUsageResult;

/** 사용량 (명세 6번). 시각은 전역 직렬화 설정이 +09:00을 붙여 내보낸다. */
public record UserUsageResponse(TemplateUsage template, AiToneUsage aiTone) {

public static UserUsageResponse from(UserUsageResult result) {
UserUsageResult.TemplateUsage template = result.template();
UserUsageResult.AiToneUsage aiTone = result.aiTone();
return new UserUsageResponse(
new TemplateUsage(template.count(), template.limit(), template.remaining(), template.full()),
new AiToneUsage(aiTone.usedCount(), aiTone.limit(), aiTone.remaining(), aiTone.resetAt()));
}

public record TemplateUsage(int count, int limit, int remaining, @JsonProperty("isFull") boolean isFull) {
}

public record AiToneUsage(int usedCount, int limit, int remaining, LocalDateTime resetAt) {
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
package com.sniptext.domain.user.service;

import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

import com.sniptext.domain.ai.service.AiToneUsageQueryService;
import com.sniptext.domain.template.service.TemplateQueryService;
import com.sniptext.domain.user.service.dto.result.UserUsageResult;

import lombok.RequiredArgsConstructor;

/**
* 사용량 조회. template·ai 서비스를 조합하므로 UserQueryService와 분리한다.
* UserQueryService에 넣으면 template·ai가 UserQueryService를 부르게 될 때 생성자 주입이 순환해 앱이 뜨지 않는다.
*/
@Service
@RequiredArgsConstructor
@Transactional(readOnly = true)
public class UserUsageQueryService {

private final UserQueryService userQueryService;
private final TemplateQueryService templateQueryService;
private final AiToneUsageQueryService aiToneUsageQueryService;

/** 없거나 탈퇴한 회원이면 USER404_1. */
public UserUsageResult getUsage(Long userId) {
userQueryService.validateActive(userId);

return UserUsageResult.of(templateQueryService.countActive(userId),
aiToneUsageQueryService.getTodayUsage(userId));
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
package com.sniptext.domain.user.service.dto.result;

import java.time.LocalDateTime;

import com.sniptext.domain.ai.service.dto.result.AiToneUsageResult;
import com.sniptext.domain.template.support.TemplateLimit;
import com.sniptext.global.policy.UsageLimits;

/**
* 사용량. 템플릿은 휴지통 제외 개수 기준이고, AI 톤 교정은 오늘(KST) 기준이다.
* 남은 개수와 한도 도달은 저장 차단과 같은 규칙(TemplateLimit)으로 계산한다.
*/
public record UserUsageResult(TemplateUsage template, AiToneUsage aiTone) {

public static UserUsageResult of(long templateCount, AiToneUsageResult aiTone) {
return new UserUsageResult(
new TemplateUsage(Math.toIntExact(templateCount), UsageLimits.TEMPLATE_LIMIT,
TemplateLimit.remaining(templateCount), TemplateLimit.isReached(templateCount)),
new AiToneUsage(aiTone.usedCount(), aiTone.limit(), aiTone.remaining(), aiTone.resetAt()));
}

public record TemplateUsage(int count, int limit, int remaining, boolean full) {
}

public record AiToneUsage(int usedCount, int limit, int remaining, LocalDateTime resetAt) {
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
package com.sniptext.domain.template.support;

import static org.assertj.core.api.Assertions.assertThat;

import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;

import com.sniptext.global.policy.UsageLimits;

class TemplateLimitTest {

private static final int LIMIT = UsageLimits.TEMPLATE_LIMIT;

@Test
@DisplayName("한도 1개 전(49개)은 도달이 아니고 1개 남는다")
void belowLimit() {
assertThat(TemplateLimit.isReached(LIMIT - 1)).isFalse();
assertThat(TemplateLimit.remaining(LIMIT - 1)).isEqualTo(1);
}

@Test
@DisplayName("한도(50개)면 도달이고 0개 남는다")
void atLimit() {
assertThat(TemplateLimit.isReached(LIMIT)).isTrue();
assertThat(TemplateLimit.remaining(LIMIT)).isZero();
}

@Test
@DisplayName("한도를 넘어도(51개) 도달이고 남은 개수는 음수가 아니라 0이다")
void overLimit() {
assertThat(TemplateLimit.isReached(LIMIT + 1)).isTrue();
assertThat(TemplateLimit.remaining(LIMIT + 1)).isZero();
}

@Test
@DisplayName("0개면 한도만큼 남는다")
void empty() {
assertThat(TemplateLimit.isReached(0)).isFalse();
assertThat(TemplateLimit.remaining(0)).isEqualTo(LIMIT);
}

}
Loading
Loading