merge: (#523) topic 구독 설정 저장 및 조회 api

dms-core/src/main/kotlin/team/aliens/dms/common/spi/EventPort.kt

@@ -3,7 +3,7 @@ package team.aliens.dms.common.spi
 import team.aliens.dms.domain.notification.model.Notification
 
 interface NotificationEventPort {
-    fun publishNotification(deviceToken: String, notification: Notification)
+    fun publishNotification(token: String, notification: Notification)
     fun publishNotificationToAllByTopic(notification: Notification)
 }
 

dms-core/src/main/kotlin/team/aliens/dms/domain/notification/dto/SetDeviceTokenRequest.kt

@@ -4,11 +4,11 @@ import team.aliens.dms.domain.notification.model.DeviceToken
 import team.aliens.dms.domain.user.model.User
 
 class SetDeviceTokenRequest(
-    val deviceToken: String
+    val token: String
 ) {
     fun toDeviceToken(user: User) = DeviceToken(
         userId = user.id,
         schoolId = user.schoolId,
-        deviceToken = deviceToken
+        token = token
     )
 }

dms-core/src/main/kotlin/team/aliens/dms/domain/notification/dto/TopicSubscriptionResponse.kt

@@ -0,0 +1,58 @@
+package team.aliens.dms.domain.notification.dto
+
+import team.aliens.dms.domain.notification.model.Topic
+import team.aliens.dms.domain.notification.model.TopicGroup
+import team.aliens.dms.domain.notification.model.TopicSubscription
+
+data class TopicSubscriptionGroupsResponse(
+    val topicGroups: List<TopicGroupSubscriptionResponse>
+) {
+    companion object {
+        fun of(topicSubscriptions: List<TopicSubscription>): TopicSubscriptionGroupsResponse {
+
+            return TopicSubscriptionGroupsResponse(
+                TopicGroup.values()
+                    .associateWith { mutableListOf<TopicSubscriptionResponse>() }
+                    .also { topicGroupsMap ->
+                        addTopicSubscriptionsToTopicGroupsMap(
+                            topicGroupsMap = topicGroupsMap,
+                            topicSubscriptionsMap = topicSubscriptions.associateBy { it.topic }
+                        )
+                    }
+                    .map {
+                        TopicGroupSubscriptionResponse(
+                            topicGroup = it.key,
+                            topicSubscriptions = it.value
+                        )
+                    }
+            )
+        }
+
+        private fun addTopicSubscriptionsToTopicGroupsMap(
+            topicGroupsMap: Map<TopicGroup, MutableList<TopicSubscriptionResponse>>,
+            topicSubscriptionsMap: Map<Topic, TopicSubscription>
+        ) {
+            Topic.values().forEach {
+                topicGroupsMap[it.topicGroup]?.add(
+                    TopicSubscriptionResponse(
+                        topic = it,
+                        isSubscribed = topicSubscriptionsMap[it]?.isSubscribed ?: false
+                    )
+                )
+            }
+        }
+    }
+}
+
+data class TopicGroupSubscriptionResponse(
+    val topicGroup: TopicGroup,
+    val groupName: String = topicGroup.groupName,
+    val topicSubscriptions: List<TopicSubscriptionResponse>
+)
+
+data class TopicSubscriptionResponse(
+    val topic: Topic,
+    val title: String = topic.title,
+    val description: String = topic.content,
+    val isSubscribed: Boolean
+)

dms-core/src/main/kotlin/team/aliens/dms/domain/notification/model/DeviceToken.kt

@@ -6,5 +6,5 @@ data class DeviceToken(
     val id: UUID = UUID(0, 0),
     val userId: UUID,
     val schoolId: UUID,
-    val deviceToken: String
+    val token: String
 )

dms-core/src/main/kotlin/team/aliens/dms/domain/notification/model/Topic.kt

@@ -1,5 +1,31 @@
 package team.aliens.dms.domain.notification.model
 
-enum class Topic {
-    NOTICE
+enum class TopicGroup(
+    val groupName: String
+) {
+    NOTICE("공지"),
+    STUDY_ROOM("자습실")
+}
+
+enum class Topic(
+    val topicGroup: TopicGroup,
+    val title: String,
+    val content: String
+) {
+    NOTICE(
+        topicGroup = TopicGroup.NOTICE,
+        title = "공지 알림",
+        content = "기숙사 공지에 대한 알림입니다."
+    ),
+
+    STUDY_ROOM_TIME_SLOT(
+        topicGroup = TopicGroup.STUDY_ROOM,
+        title = "이용 시간 알림",
+        content = "자습실 이용 시작 10분 전에 알림을 받을 수 있습니다."
+    ),
+    STUDY_ROOM_APPLY(
+        topicGroup = TopicGroup.STUDY_ROOM,
+        title = "신청 시간 알림",
+        content = "자습실 신청 시간을 알리는 알림입니다."
+    );
 }

dms-core/src/main/kotlin/team/aliens/dms/domain/notification/model/TopicSubscription.kt

@@ -0,0 +1,34 @@
+package team.aliens.dms.domain.notification.model
+
+import java.util.UUID
+
+data class TopicSubscription(
+
+    val deviceTokenId: UUID,
+
+    val topic: Topic,
+
+    val isSubscribed: Boolean
+
+) {
+    companion object {
+
+        fun subscribe(
+            deviceTokenId: UUID,
+            topic: Topic,
+        ) = TopicSubscription(
+            deviceTokenId = deviceTokenId,
+            topic = topic,
+            isSubscribed = true
+        )
+
+        fun unsubscribe(
+            deviceTokenId: UUID,
+            topic: Topic,
+        ) = TopicSubscription(
+            deviceTokenId = deviceTokenId,
+            topic = topic,
+            isSubscribed = false
+        )
+    }
+}

dms-core/src/main/kotlin/team/aliens/dms/domain/notification/service/NotificationService.kt

@@ -3,19 +3,20 @@ package team.aliens.dms.domain.notification.service
 import team.aliens.dms.domain.notification.model.DeviceToken
 import team.aliens.dms.domain.notification.model.Notification
 import team.aliens.dms.domain.notification.model.Topic
+import team.aliens.dms.domain.notification.model.TopicSubscription
 
 interface NotificationService {
 
     fun saveDeviceToken(deviceToken: DeviceToken)
 
-    fun unsubscribeTopic(deviceToken: String, topic: Topic)
+    fun unsubscribeTopic(token: String, topic: Topic)
 
-    fun subscribeTopic(deviceToken: String, topic: Topic)
+    fun subscribeTopic(token: String, topic: Topic)
 
-    fun updateSubscribes(deviceToken: String, topicsToSubscribe: List<Pair<Topic, Boolean>>)
+    fun updateSubscribes(token: String, topicsToSubscribe: List<Pair<Topic, Boolean>>)
 
     fun sendMessage(
-        deviceToken: String,
+        token: String,
         notification: Notification
     )
 
@@ -24,4 +25,6 @@ interface NotificationService {
     fun sendMessagesByTopic(
         notification: Notification
     )
+
+    fun getTopicSubscriptionsByToken(token: String): List<TopicSubscription>
 }

dms-core/src/main/kotlin/team/aliens/dms/domain/notification/service/NotificationServiceImpl.kt

@@ -5,67 +5,97 @@ import team.aliens.dms.domain.notification.exception.DeviceTokenNotFoundExceptio
 import team.aliens.dms.domain.notification.model.DeviceToken
 import team.aliens.dms.domain.notification.model.Notification
 import team.aliens.dms.domain.notification.model.Topic
+import team.aliens.dms.domain.notification.model.TopicSubscription
 import team.aliens.dms.domain.notification.spi.DeviceTokenPort
 import team.aliens.dms.domain.notification.spi.NotificationPort
+import team.aliens.dms.domain.notification.spi.TopicSubscriptionPort
 
 @Component
 class NotificationServiceImpl(
     private val notificationPort: NotificationPort,
+    private val topicSubscriptionPort: TopicSubscriptionPort,
     private val deviceTokenPort: DeviceTokenPort
 ) : NotificationService {
 
     override fun saveDeviceToken(deviceToken: DeviceToken) {
         deviceTokenPort.saveDeviceToken(deviceToken)
         notificationPort.subscribeAllTopics(
-            deviceToken = deviceToken.deviceToken
+            token = deviceToken.token
         )
     }
 
-    override fun subscribeTopic(deviceToken: String, topic: Topic) {
+    override fun subscribeTopic(token: String, topic: Topic) {
+        val deviceToken = this.getDeviceTokenByToken(token)
+        topicSubscriptionPort.saveTopicSubscription(
+            TopicSubscription.subscribe(
+                deviceTokenId = deviceToken.id,
+                topic = topic,
+            )
+        )
         notificationPort.subscribeTopic(
-            deviceToken = this.getDeviceTokenByDeviceToken(deviceToken).deviceToken,
+            token = token,
             topic = topic
         )
     }
 
-    override fun unsubscribeTopic(deviceToken: String, topic: Topic) {
+    override fun unsubscribeTopic(token: String, topic: Topic) {
+        val deviceToken = this.getDeviceTokenByToken(token)
+        topicSubscriptionPort.saveTopicSubscription(
+            TopicSubscription.unsubscribe(
+                deviceTokenId = deviceToken.id,
+                topic = topic,
+            )
+        )
         notificationPort.unsubscribeTopic(
-            deviceToken = this.getDeviceTokenByDeviceToken(deviceToken).deviceToken,
+            token = token,
             topic = topic
         )
     }
 
-    override fun updateSubscribes(deviceToken: String, topicsToSubscribe: List<Pair<Topic, Boolean>>) {
+    override fun updateSubscribes(token: String, topicsToSubscribe: List<Pair<Topic, Boolean>>) {
+        val deviceToken = this.getDeviceTokenByToken(token)
+        val topicSubscriptions = topicsToSubscribe.map { (topic, isSubscribe) ->
+            this.subscribeOrUnsubscribeTopic(isSubscribe, token, topic)
+            TopicSubscription(
+                deviceTokenId = deviceToken.id,
+                topic = topic,
+                isSubscribed = isSubscribe
+            )
+        }
+        topicSubscriptionPort.saveAllTopicSubscriptions(topicSubscriptions)
+    }
 
-        val deviceToken = this.getDeviceTokenByDeviceToken(deviceToken)
-        topicsToSubscribe.forEach { (topic, isSubscribe) ->
-            if (isSubscribe) {
-                notificationPort.subscribeTopic(
-                    deviceToken = deviceToken.deviceToken,
-                    topic = topic
-                )
-            } else {
-                notificationPort.unsubscribeTopic(
-                    deviceToken = deviceToken.deviceToken,
-                    topic = topic
-                )
-            }
+    private fun subscribeOrUnsubscribeTopic(
+        isSubscribe: Boolean,
+        token: String,
+        topic: Topic
+    ) {
+        if (isSubscribe) {
+            notificationPort.subscribeTopic(
+                token = token,
+                topic = topic
+            )
+        } else {
+            notificationPort.unsubscribeTopic(
+                token = token,
+                topic = topic
+            )
         }
     }
 
-    private fun getDeviceTokenByDeviceToken(deviceToken: String) =
-        deviceTokenPort.queryDeviceTokenByDeviceToken(deviceToken) ?: throw DeviceTokenNotFoundException
+    private fun getDeviceTokenByToken(token: String) =
+        deviceTokenPort.queryDeviceTokenByToken(token) ?: throw DeviceTokenNotFoundException
 
-    override fun sendMessage(deviceToken: String, notification: Notification) {
+    override fun sendMessage(token: String, notification: Notification) {
         notificationPort.sendMessage(
-            deviceToken = deviceToken,
+            token = token,
             notification = notification
         )
     }
 
     override fun sendMessages(deviceTokens: List<String>, notification: Notification) {
         notificationPort.sendMessages(
-            deviceTokens = deviceTokens,
+            tokens = deviceTokens,
             notification = notification
         )
     }
@@ -75,4 +105,9 @@ class NotificationServiceImpl(
             notification = notification
         )
     }
+
+    override fun getTopicSubscriptionsByToken(token: String): List<TopicSubscription> {
+        val savedToken = getDeviceTokenByToken(token)
+        return topicSubscriptionPort.queryTopicSubscriptionsByDeviceTokenId(savedToken.id)
+    }
 }

dms-core/src/main/kotlin/team/aliens/dms/domain/notification/spi/DeviceTokenPort.kt

@@ -9,7 +9,7 @@ interface DeviceTokenPort {
 
     fun queryDeviceTokenByUserId(userId: UUID): DeviceToken?
 
-    fun queryDeviceTokenByDeviceToken(deviceToken: String): DeviceToken?
+    fun queryDeviceTokenByToken(token: String): DeviceToken?
 
     fun deleteDeviceTokenByUserId(userId: UUID)
 }

dms-core/src/main/kotlin/team/aliens/dms/domain/notification/spi/NotificationPort.kt

@@ -6,19 +6,19 @@ import team.aliens.dms.domain.notification.model.Topic
 interface NotificationPort {
 
     fun sendMessage(
-        deviceToken: String,
+        token: String,
         notification: Notification
     )
 
-    fun sendMessages(deviceTokens: List<String>, notification: Notification)
+    fun sendMessages(tokens: List<String>, notification: Notification)
 
     fun sendByTopic(
         notification: Notification
     )
 
-    fun subscribeTopic(deviceToken: String, topic: Topic)
+    fun subscribeTopic(token: String, topic: Topic)
 
-    fun subscribeAllTopics(deviceToken: String)
+    fun subscribeAllTopics(token: String)
 
-    fun unsubscribeTopic(deviceToken: String, topic: Topic)
+    fun unsubscribeTopic(token: String, topic: Topic)
 }

dms-core/src/main/kotlin/team/aliens/dms/domain/notification/spi/TopicSubscriptionPort.kt

@@ -0,0 +1,13 @@
+package team.aliens.dms.domain.notification.spi
+
+import java.util.UUID
+import team.aliens.dms.domain.notification.model.TopicSubscription
+
+interface TopicSubscriptionPort {
+
+    fun saveTopicSubscription(topicSubscription: TopicSubscription): TopicSubscription
+
+    fun queryTopicSubscriptionsByDeviceTokenId(deviceTokenId: UUID): List<TopicSubscription>
+
+    fun saveAllTopicSubscriptions(topicSubscriptions: List<TopicSubscription>)
+}

dms-core/src/main/kotlin/team/aliens/dms/domain/notification/usecase/QueryTopicSubscriptionUseCase.kt

@@ -0,0 +1,17 @@
+package team.aliens.dms.domain.notification.usecase
+
+import team.aliens.dms.common.annotation.ReadOnlyUseCase
+import team.aliens.dms.domain.notification.dto.TopicSubscriptionGroupsResponse
+import team.aliens.dms.domain.notification.service.NotificationService
+
+@ReadOnlyUseCase
+class QueryTopicSubscriptionUseCase(
+    private val notificationService: NotificationService
+) {
+
+    fun execute(token: String): TopicSubscriptionGroupsResponse {
+        return TopicSubscriptionGroupsResponse.of(
+            notificationService.getTopicSubscriptionsByToken(token)
+        )
+    }
+}