�feat: 알림기능을 개발합니다. (#123)

* [BOOK-313] feat(apis): FCM 토큰 및 알림 설정 API 추가 (#122)

* [BOOK-313] feat(domain): 유저 마지막 활동 시간, 알림 설정, FCM 토큰 필드 추가 (#122)

* [BOOK-313] feat(user): 유저 활동내역 업데이트 기능 추가 (#122)

* [BOOK-313] feat(batch): 비활성 유저 알림 기능 추가 (#122)

* [BOOK-313] fix: batch: delete test code (#122)

* [BOOK-313] refactor: apis - 컨벤션에 맞게 리팩토링 (#122)

* [BOOK-313] feat: batch - 알림 title을 수정합니다 (#122)

Author: minwoo1999

.gitignore

@@ -175,5 +175,6 @@ node_modules/
 # secret
 application-*-secret.properties
 secret/
+**/reed-firebase-adminsdk.json
 
 # End of https://www.toptal.com/developers/gitignore/api/intellij,kotlin,gradle

apis/src/main/kotlin/org/yapp/apis/book/service/UserBookService.kt

@@ -12,16 +12,19 @@ import org.yapp.apis.book.exception.UserBookException
 import org.yapp.domain.userbook.BookStatus
 import org.yapp.domain.userbook.UserBookDomainService
 import org.yapp.domain.userbook.UserBookSortType
+import org.yapp.domain.user.UserDomainService
 import org.yapp.globalutils.annotation.ApplicationService
 import java.util.*
 
 @ApplicationService
 class UserBookService(
-    private val userBookDomainService: UserBookDomainService
+    private val userBookDomainService: UserBookDomainService,
+    private val userDomainService: UserDomainService
 ) {
     fun upsertUserBook(@Valid upsertUserBookRequest: UpsertUserBookRequest): UserBookResponse {
+        val userId = upsertUserBookRequest.validUserId()
         val userBookInfoVO = userBookDomainService.upsertUserBook(
-            upsertUserBookRequest.validUserId(),
+            userId,
             upsertUserBookRequest.validBookId(),
             upsertUserBookRequest.validBookIsbn13(),
             upsertUserBookRequest.validBookTitle(),
@@ -30,6 +33,10 @@ class UserBookService(
             upsertUserBookRequest.validBookCoverImageUrl(),
             upsertUserBookRequest.validStatus()
         )
+
+        // Update user's lastActivity when a book is registered
+        userDomainService.updateLastActivity(userId)
+
         return UserBookResponse.from(userBookInfoVO)
     }
 

apis/src/main/kotlin/org/yapp/apis/readingrecord/service/ReadingRecordService.kt

@@ -7,12 +7,14 @@ import org.yapp.apis.readingrecord.dto.request.UpdateReadingRecordRequest
 import org.yapp.apis.readingrecord.dto.response.ReadingRecordResponse
 import org.yapp.domain.readingrecord.ReadingRecordDomainService
 import org.yapp.domain.readingrecord.ReadingRecordSortType
+import org.yapp.domain.user.UserDomainService
 import org.yapp.globalutils.annotation.ApplicationService
 import java.util.*
 
 @ApplicationService
 class ReadingRecordService(
     private val readingRecordDomainService: ReadingRecordDomainService,
+    private val userDomainService: UserDomainService
 ) {
     fun createReadingRecord(
         userId: UUID,
@@ -27,6 +29,9 @@ class ReadingRecordService(
             emotionTags = request.validEmotionTags()
         )
 
+        // Update user's lastActivity when a reading record is created
+        userDomainService.updateLastActivity(userId)
+
         return ReadingRecordResponse.from(readingRecordInfoVO)
     }
 
@@ -51,6 +56,7 @@ class ReadingRecordService(
         readingRecordDomainService.deleteAllByUserBookId(userBookId)
     }
     fun updateReadingRecord(
+        userId: UUID,
         readingRecordId: UUID,
         request: UpdateReadingRecordRequest
     ): ReadingRecordResponse {
@@ -61,6 +67,10 @@ class ReadingRecordService(
             review = request.validReview(),
             emotionTags = request.validEmotionTags()
         )
+
+        // Update user's lastActivity when a reading record is updated
+        userDomainService.updateLastActivity(userId)
+
         return ReadingRecordResponse.from(readingRecordInfoVO)
     }
 

apis/src/main/kotlin/org/yapp/apis/readingrecord/usecase/ReadingRecordUseCase.kt

@@ -86,6 +86,7 @@ class ReadingRecordUseCase(
         userService.validateUserExists(userId)
 
         return readingRecordService.updateReadingRecord(
+            userId = userId,
             readingRecordId = readingRecordId,
             request = request
         )

apis/src/main/kotlin/org/yapp/apis/user/controller/UserController.kt

@@ -4,6 +4,8 @@ import jakarta.validation.Valid
 import org.springframework.http.ResponseEntity
 import org.springframework.security.core.annotation.AuthenticationPrincipal
 import org.springframework.web.bind.annotation.*
+import org.yapp.apis.user.dto.request.FcmTokenRequest
+import org.yapp.apis.user.dto.request.NotificationSettingsRequest
 import org.yapp.apis.user.dto.request.TermsAgreementRequest
 import org.yapp.apis.user.dto.response.UserProfileResponse
 import org.yapp.apis.user.usecase.UserUseCase
@@ -30,4 +32,22 @@ class UserController(
         val userProfile = userUseCase.updateTermsAgreement(userId, request)
         return ResponseEntity.ok(userProfile)
     }
+
+    @PutMapping("/me/notification-settings")
+    override fun updateNotificationSettings(
+        @AuthenticationPrincipal userId: UUID,
+        @Valid @RequestBody request: NotificationSettingsRequest
+    ): ResponseEntity<UserProfileResponse> {
+        val userProfile = userUseCase.updateNotificationSettings(userId, request)
+        return ResponseEntity.ok(userProfile)
+    }
+
+    @PutMapping("/me/fcm-token")
+    override fun updateFcmToken(
+        @AuthenticationPrincipal userId: UUID,
+        @Valid @RequestBody request: FcmTokenRequest
+    ): ResponseEntity<UserProfileResponse> {
+        val userProfile = userUseCase.updateFcmToken(userId, request)
+        return ResponseEntity.ok(userProfile)
+    }
 }

apis/src/main/kotlin/org/yapp/apis/user/controller/UserControllerApi.kt

@@ -14,6 +14,8 @@ import org.springframework.web.bind.annotation.GetMapping
 import org.springframework.web.bind.annotation.PutMapping
 import org.springframework.web.bind.annotation.RequestBody
 import org.springframework.web.bind.annotation.RequestMapping
+import org.yapp.apis.user.dto.request.FcmTokenRequest
+import org.yapp.apis.user.dto.request.NotificationSettingsRequest
 import org.yapp.apis.user.dto.request.TermsAgreementRequest
 import org.yapp.apis.user.dto.response.UserProfileResponse
 import org.yapp.globalutils.exception.ErrorResponse
@@ -84,4 +86,72 @@ interface UserControllerApi {
         @Parameter(hidden = true) @AuthenticationPrincipal userId: UUID,
         @Valid @RequestBody @Parameter(description = "약관 동의 요청 객체") request: TermsAgreementRequest
     ): ResponseEntity<UserProfileResponse>
+
+    @Operation(
+        summary = "알림 설정 업데이트",
+        description = "사용자의 알림 설정을 업데이트합니다."
+    )
+    @ApiResponses(
+        value = [
+            ApiResponse(
+                responseCode = "200",
+                description = "알림 설정 업데이트 성공",
+                content = [Content(schema = Schema(implementation = UserProfileResponse::class))]
+            ),
+            ApiResponse(
+                responseCode = "400",
+                description = "잘못된 요청 파라미터",
+                content = [Content(schema = Schema(implementation = ErrorResponse::class))]
+            ),
+            ApiResponse(
+                responseCode = "401",
+                description = "인증되지 않은 사용자",
+                content = [Content(schema = Schema(implementation = ErrorResponse::class))]
+            ),
+            ApiResponse(
+                responseCode = "404",
+                description = "사용자를 찾을 수 없습니다.",
+                content = [Content(schema = Schema(implementation = ErrorResponse::class))]
+            )
+        ]
+    )
+    @PutMapping("/me/notification-settings")
+    fun updateNotificationSettings(
+        @Parameter(hidden = true) @AuthenticationPrincipal userId: UUID,
+        @Valid @RequestBody @Parameter(description = "알림 설정 요청 객체") request: NotificationSettingsRequest
+    ): ResponseEntity<UserProfileResponse>
+
+    @Operation(
+        summary = "FCM 토큰 등록",
+        description = "사용자의 FCM 토큰을 등록합니다."
+    )
+    @ApiResponses(
+        value = [
+            ApiResponse(
+                responseCode = "200",
+                description = "FCM 토큰 등록 성공",
+                content = [Content(schema = Schema(implementation = UserProfileResponse::class))]
+            ),
+            ApiResponse(
+                responseCode = "400",
+                description = "잘못된 요청 파라미터",
+                content = [Content(schema = Schema(implementation = ErrorResponse::class))]
+            ),
+            ApiResponse(
+                responseCode = "401",
+                description = "인증되지 않은 사용자",
+                content = [Content(schema = Schema(implementation = ErrorResponse::class))]
+            ),
+            ApiResponse(
+                responseCode = "404",
+                description = "사용자를 찾을 수 없습니다.",
+                content = [Content(schema = Schema(implementation = ErrorResponse::class))]
+            )
+        ]
+    )
+    @PutMapping("/me/fcm-token")
+    fun updateFcmToken(
+        @Parameter(hidden = true) @AuthenticationPrincipal userId: UUID,
+        @Valid @RequestBody @Parameter(description = "FCM 토큰 요청 객체") request: FcmTokenRequest
+    ): ResponseEntity<UserProfileResponse>
 }

apis/src/main/kotlin/org/yapp/apis/user/dto/request/FcmTokenRequest.kt

@@ -0,0 +1,20 @@
+package org.yapp.apis.user.dto.request
+
+import io.swagger.v3.oas.annotations.media.Schema
+import jakarta.validation.constraints.NotBlank
+
+@Schema(
+    name = "FcmTokenRequest",
+    description = "DTO for FCM token update requests"
+)
+data class FcmTokenRequest private constructor(
+    @field:Schema(
+        description = "FCM 토큰",
+        example = "epGzIKlHScicTBrbt26pFG:APA91bG-ZPD-KMJyS-JOiflEPUIVvrp8l9DFBN2dlNG8IHw8mFlkAPok7dVPFJR4phc9061KPztkAIjBJaryZLnv6vIJXNGQsykzDcok3wFC9LrsC-F_aKY",
+        required = true
+    )
+    @field:NotBlank(message = "FCM 토큰은 필수입니다.")
+    val fcmToken: String? = null
+) {
+    fun validFcmToken(): String = fcmToken!!.trim()
+}

apis/src/main/kotlin/org/yapp/apis/user/dto/request/NotificationSettingsRequest.kt

@@ -0,0 +1,20 @@
+package org.yapp.apis.user.dto.request
+
+import io.swagger.v3.oas.annotations.media.Schema
+import jakarta.validation.constraints.NotNull
+
+@Schema(
+    name = "NotificationSettingsRequest",
+    description = "DTO for notification settings update requests"
+)
+data class NotificationSettingsRequest private constructor(
+    @field:Schema(
+        description = "알림 설정 여부",
+        example = "true",
+        required = true
+    )
+    @field:NotNull(message = "알림 설정 여부는 필수입니다.")
+    val notificationEnabled: Boolean? = null
+) {
+    fun validNotificationEnabled(): Boolean = notificationEnabled!!
+}

apis/src/main/kotlin/org/yapp/apis/user/dto/response/UserProfileResponse.kt

@@ -39,7 +39,13 @@ data class UserProfileResponse(
         description = "Whether the user has agreed to the terms of service",
         example = "false"
     )
-    val termsAgreed: Boolean
+    val termsAgreed: Boolean,
+
+    @field:Schema(
+        description = "Whether notifications are enabled for the user",
+        example = "true"
+    )
+    val notificationEnabled: Boolean
 ) {
     companion object {
         fun from(userProfileVO: UserProfileVO): UserProfileResponse {
@@ -48,7 +54,8 @@ data class UserProfileResponse(
                 email = userProfileVO.email.value,
                 nickname = userProfileVO.nickname,
                 provider = userProfileVO.provider,
-                termsAgreed = userProfileVO.termsAgreed
+                termsAgreed = userProfileVO.termsAgreed,
+                notificationEnabled = userProfileVO.notificationEnabled
             )
         }
     }

apis/src/main/kotlin/org/yapp/apis/user/service/UserService.kt

@@ -3,7 +3,9 @@ package org.yapp.apis.user.service
 import jakarta.validation.Valid
 import org.yapp.apis.auth.exception.AuthErrorCode
 import org.yapp.apis.auth.exception.AuthException
+import org.yapp.apis.user.dto.request.FcmTokenRequest
 import org.yapp.apis.user.dto.request.FindUserIdentityRequest
+import org.yapp.apis.user.dto.request.NotificationSettingsRequest
 import org.yapp.apis.user.dto.request.TermsAgreementRequest
 import org.yapp.apis.user.dto.response.UserAuthInfoResponse
 import org.yapp.apis.user.dto.response.UserProfileResponse
@@ -36,4 +38,16 @@ class UserService(
         val userIdentity = userDomainService.findUserIdentityById(findUserIdentityRequest.validUserId())
         return UserAuthInfoResponse.from(userIdentity)
     }
+
+    fun updateNotificationSettings(userId: UUID, @Valid request: NotificationSettingsRequest): UserProfileResponse {
+        validateUserExists(userId)
+        val updatedUserProfile = userDomainService.updateNotificationSettings(userId, request.validNotificationEnabled())
+        return UserProfileResponse.from(updatedUserProfile)
+    }
+
+    fun updateFcmToken(userId: UUID, @Valid request: FcmTokenRequest): UserProfileResponse {
+        validateUserExists(userId)
+        val updatedUserProfile = userDomainService.updateFcmToken(userId, request.validFcmToken())
+        return UserProfileResponse.from(updatedUserProfile)
+    }
 }