Ignore: 🐛 Modify Device Token Management Policy

pennyway-app-external-api/src/main/java/kr/co/pennyway/api/apis/users/usecase/UserAccountUseCase.java

@@ -8,6 +8,7 @@
 import kr.co.pennyway.api.apis.users.service.*;
 import kr.co.pennyway.api.common.storage.AwsS3Adapter;
 import kr.co.pennyway.common.annotation.UseCase;
+import kr.co.pennyway.domain.context.account.service.DeviceTokenRegisterService;
 import kr.co.pennyway.domain.domains.device.domain.DeviceToken;
 import kr.co.pennyway.domain.domains.oauth.domain.Oauth;
 import kr.co.pennyway.domain.domains.user.domain.NotifySetting;

pennyway-domain/domain-rdb/src/main/java/kr/co/pennyway/domain/domains/device/domain/DeviceToken.java

@@ -62,7 +62,19 @@ public Boolean isActivated() {
         return activated && lastSignedInAt.plusDays(7).isAfter(now);
     }
 
+    /**
+     * 디바이스 토큰이 만료되었는지 확인한다.
+     *
+     * @return 토큰이 갱신된지 7일이 지났거나 토큰이 비활성화 되었다면 true, 그렇지 않으면 false
+     */
+    public boolean isExpired() {
+        LocalDateTime now = LocalDateTime.now();
+
+        return !activated || lastSignedInAt.plusDays(7).isBefore(now);
+    }
+
     public void activate() {
+        lastSignedInAt = LocalDateTime.now();
         this.activated = Boolean.TRUE;
     }
 
@@ -75,14 +87,22 @@ public void updateLastSignedInAt() {
     }
 
     /**
-     * 디바이스 토큰이 만료되었는지 확인한다.
-     *
-     * @return 토큰이 갱신된지 7일이 지났으면 true, 그렇지 않으면 false
+     * 토큰의 소유자를 확인하고 필요한 상태 변경을 수행합니다.
+     * 다른 소유자인 경우 소유자를 갱신하고, 같은 소유자인 경우 활성화만 수행합니다.
      */
-    public boolean isExpired() {
-        LocalDateTime now = LocalDateTime.now();
+    public void handleOwner(User newUser, String newDeviceId) {
+        Objects.requireNonNull(newUser, "user는 null이 될 수 없습니다.");
+        Objects.requireNonNull(newDeviceId, "deviceId는 null이 될 수 없습니다.");
+
+        if (!this.user.equals(newUser)) {
+            this.user = newUser;
+        }
+
+        if (!this.deviceId.equals(newDeviceId)) {
+            this.deviceId = newDeviceId;
+        }
 
-        return lastSignedInAt.plusDays(7).isBefore(now);
+        this.activate();
     }
 
     @Override

pennyway-domain/domain-rdb/src/main/java/kr/co/pennyway/domain/domains/device/exception/DeviceTokenErrorCode.java

@@ -9,7 +9,11 @@
 @RequiredArgsConstructor
 public enum DeviceTokenErrorCode implements BaseErrorCode {
     /* 404 NOT_FOUND */
-    NOT_FOUND_DEVICE(StatusCode.NOT_FOUND, ReasonCode.REQUESTED_RESOURCE_NOT_FOUND, "디바이스를 찾을 수 없습니다.");
+    NOT_FOUND_DEVICE(StatusCode.NOT_FOUND, ReasonCode.REQUESTED_RESOURCE_NOT_FOUND, "디바이스를 찾을 수 없습니다."),
+
+    /* 409 CONFLICT */
+    DUPLICATED_DEVICE_TOKEN(StatusCode.CONFLICT, ReasonCode.RESOURCE_ALREADY_EXISTS, "이미 등록된 디바이스 토큰입니다."),
+    ;
 
     private final StatusCode statusCode;
     private final ReasonCode reasonCode;

pennyway-domain/domain-rdb/src/main/java/kr/co/pennyway/domain/domains/device/repository/DeviceTokenRepository.java

@@ -15,6 +15,10 @@ public interface DeviceTokenRepository extends JpaRepository<DeviceToken, Long>
 
     List<DeviceToken> findAllByUser_Id(Long userId);
 
+    Optional<DeviceToken> findByToken(String token);
+
+    List<DeviceToken> findAllByUser_IdAndDeviceId(Long userId, String deviceId);
+
     @Modifying(clearAutomatically = true)
     @Transactional
     @Query("UPDATE DeviceToken d SET d.activated = false WHERE d.user.id = :userId")

pennyway-domain/domain-rdb/src/main/java/kr/co/pennyway/domain/domains/device/service/DeviceTokenRdbService.java

@@ -2,9 +2,12 @@
 
 import kr.co.pennyway.common.annotation.DomainService;
 import kr.co.pennyway.domain.domains.device.domain.DeviceToken;
+import kr.co.pennyway.domain.domains.device.exception.DeviceTokenErrorCode;
+import kr.co.pennyway.domain.domains.device.exception.DeviceTokenErrorException;
 import kr.co.pennyway.domain.domains.device.repository.DeviceTokenRepository;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
+import org.springframework.dao.DataIntegrityViolationException;
 import org.springframework.transaction.annotation.Transactional;
 
 import java.util.List;
@@ -16,9 +19,18 @@
 public class DeviceTokenRdbService {
     private final DeviceTokenRepository deviceTokenRepository;
 
+    /**
+     * @throws DeviceTokenErrorException 중복된 디바이스 토큰이 이미 존재하는 경우
+     */
     @Transactional
     public DeviceToken createDevice(DeviceToken deviceToken) {
-        return deviceTokenRepository.save(deviceToken);
+        try {
+            return deviceTokenRepository.save(deviceToken);
+        } catch (DataIntegrityViolationException e) {
+            log.error("DeviceToken 등록 중 중복 에러가 발생했습니다. deviceToken: {}", deviceToken);
+
+            throw new DeviceTokenErrorException(DeviceTokenErrorCode.DUPLICATED_DEVICE_TOKEN);
+        }
     }
 
     /**
@@ -29,6 +41,16 @@ public Optional<DeviceToken> readDeviceByUserIdAndToken(Long userId, String toke
         return deviceTokenRepository.findByUser_IdAndToken(userId, token);
     }
 
+    @Transactional(readOnly = true)
+    public Optional<DeviceToken> readDeviceByToken(String token) {
+        return deviceTokenRepository.findByToken(token);
+    }
+
+    @Transactional(readOnly = true)
+    public List<DeviceToken> readByUserIdAndDeviceId(Long userId, String deviceId) {
+        return deviceTokenRepository.findAllByUser_IdAndDeviceId(userId, deviceId);
+    }
+
     /**
      * @return 비활성화된 디바이스 토큰 정보를 포함합니다.
      */

pennyway-domain/domain-service/src/main/java/kr/co/pennyway/domain/context/account/service/DeviceTokenRegisterService.java

@@ -0,0 +1,87 @@
+package kr.co.pennyway.domain.context.account.service;
+
+import kr.co.pennyway.common.annotation.DomainService;
+import kr.co.pennyway.domain.domains.device.domain.DeviceToken;
+import kr.co.pennyway.domain.domains.device.exception.DeviceTokenErrorCode;
+import kr.co.pennyway.domain.domains.device.exception.DeviceTokenErrorException;
+import kr.co.pennyway.domain.domains.device.service.DeviceTokenRdbService;
+import kr.co.pennyway.domain.domains.user.domain.User;
+import kr.co.pennyway.domain.domains.user.exception.UserErrorCode;
+import kr.co.pennyway.domain.domains.user.exception.UserErrorException;
+import kr.co.pennyway.domain.domains.user.service.UserRdbService;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.transaction.annotation.Transactional;
+
+import java.util.List;
+
+@Slf4j
+@DomainService
+@RequiredArgsConstructor
+public class DeviceTokenRegisterService {
+    private final UserRdbService userRdbService;
+    private final DeviceTokenRdbService deviceTokenRdbService;
+
+    /**
+     * 사용자의 디바이스 토큰을 생성하거나 갱신한다.
+     *
+     * <pre>
+     * [비즈니스 규칙]
+     * - 같은 {userId, deviceId}에 대해 새로운 토큰이 발급될 수 있지만, 활성화된 토큰은 하나여야 합니다.
+     * - {deviceId, token} 조합은 시스템 전체에서 유일해야 합니다.
+     * - device token이 이미 등록된 경우, 소유자 정보를 갱신하고 마지막 로그인 시간을 갱신한다.
+     * - device token이 등록되지 않은 경우, 새로운 device token을 생성한다.
+     * </pre>
+     *
+     * @param userId      사용자 식별자
+     * @param deviceId    디바이스 식별자
+     * @param deviceName  디바이스 이름
+     * @param deviceToken 디바이스 토큰
+     * @return {@link DeviceToken} 사용자의 기기로 등록된 Device 정보
+     */
+    @Transactional
+    public DeviceToken execute(Long userId, String deviceId, String deviceName, String deviceToken) {
+        User user = userRdbService.readUser(userId).orElseThrow(() -> new UserErrorException(UserErrorCode.NOT_FOUND));
+
+        return getOrCreateDevice(user, deviceId, deviceName, deviceToken);
+    }
+
+    /**
+     * 사용자의 디바이스 토큰을 생성합니다.
+     * 만약, 이미 등록된 디바이스 토큰이 존재한다면, 해당 토큰을 갱신하고 반환합니다.
+     */
+    private DeviceToken getOrCreateDevice(User user, String deviceId, String deviceName, String deviceToken) {
+        return deviceTokenRdbService.readDeviceByToken(deviceToken)
+                .map(originalDeviceToken -> updateDevice(user, deviceId, originalDeviceToken))
+                .orElseGet(() -> createDevice(user, deviceId, deviceName, deviceToken));
+    }
+
+    private DeviceToken updateDevice(User user, String deviceId, DeviceToken originalDeviceToken) {
+        if (!originalDeviceToken.getDeviceId().equals(deviceId) && originalDeviceToken.isActivated()) {
+            throw new DeviceTokenErrorException(DeviceTokenErrorCode.DUPLICATED_DEVICE_TOKEN);
+        }
+
+        originalDeviceToken.handleOwner(user, deviceId);
+        return originalDeviceToken;
+    }
+
+    private DeviceToken createDevice(User user, String deviceId, String deviceName, String deviceToken) {
+        deactivateExistingTokens(user.getId(), deviceId);
+
+        DeviceToken newDeviceToken = DeviceToken.of(deviceToken, deviceId, deviceName, user);
+
+        return deviceTokenRdbService.createDevice(newDeviceToken);
+    }
+
+    /**
+     * 특정 사용자의 디바이스에 대한 기존 활성 토큰들을 비활성화합니다.
+     * 새로운 토큰 등록 시 호출되어 하나의 디바이스에 하나의 활성 토큰만 존재하도록 보장합니다.
+     */
+    private void deactivateExistingTokens(Long userId, String deviceId) {
+        List<DeviceToken> userDeviceTokens = deviceTokenRdbService.readByUserIdAndDeviceId(userId, deviceId);
+
+        userDeviceTokens.stream()
+                .filter(DeviceToken::isActivated)
+                .forEach(DeviceToken::deactivate);
+    }
+}