Merge pull request #70 from soma-baekgu/feature/BG-332-register-ws-session-in-redis

[BG-332]: ws 접속 정보를 레디스에 기록한다 (4h / 3h)

Author: GGHDMS

api/src/test/resources/application.yaml

@@ -28,11 +28,6 @@ spring:
   kafka:
     bootstrap-servers: [ "localhost:9092" ]
 
-  data:
-    redis:
-      host: localhost
-      port: 6379
-
 oauth:
   google:
     client-id: a

common/src/main/kotlin/com/backgu/amaker/common/status/StatusCode.kt

@@ -52,4 +52,7 @@ enum class StatusCode(
 
     // eventAssignedUser
     EVENT_ASSIGNED_USER_NOT_FOUND("4000", "접근할 수 없는 이벤트입니다."),
+
+    // realtime
+    REALTIME_NOT_FOUND("4000", "세션정보를 찾을 수 없습니다."),
 }

domain/src/main/kotlin/com/backgu/amaker/domain/workspace/WorkspaceSession.kt

@@ -0,0 +1,8 @@
+package com.backgu.amaker.domain.workspace
+
+data class WorkspaceSession(
+    val id: String,
+    val userId: String,
+    val workspaceId: Long,
+    val realtimeId: String,
+)

infra/src/main/kotlin/com/backgu/amaker/infra/redis/workspace/dto/WorkspaceSessionRedisData.kt

@@ -0,0 +1,26 @@
+package com.backgu.amaker.infra.redis.workspace.dto
+
+import com.backgu.amaker.domain.workspace.WorkspaceSession
+import com.fasterxml.jackson.annotation.JsonCreator
+import com.fasterxml.jackson.annotation.JsonProperty
+
+data class WorkspaceSessionRedisData
+    @JsonCreator
+    constructor(
+        @JsonProperty("id") val id: String,
+        @JsonProperty("userId") val userId: String,
+        @JsonProperty("workspaceId") val workspaceId: Long,
+        @JsonProperty("realtimeId") val realtimeId: String,
+    ) {
+        companion object {
+            fun of(workspaceSession: WorkspaceSession) =
+                WorkspaceSessionRedisData(
+                    workspaceSession.id,
+                    workspaceSession.userId,
+                    workspaceSession.workspaceId,
+                    workspaceSession.realtimeId,
+                )
+        }
+
+        fun toDomain() = WorkspaceSession(id, userId, workspaceId, realtimeId)
+    }

infra/src/main/kotlin/com/backgu/amaker/infra/redis/workspace/repository/WorkspaceSessionRepository.kt

@@ -0,0 +1,26 @@
+package com.backgu.amaker.infra.redis.workspace.repository
+
+import com.backgu.amaker.domain.workspace.WorkspaceSession
+import com.backgu.amaker.infra.redis.workspace.dto.WorkspaceSessionRedisData
+import org.springframework.data.redis.core.ListOperations
+import org.springframework.data.redis.core.RedisTemplate
+import org.springframework.stereotype.Repository
+
+@Repository
+class WorkspaceSessionRepository(
+    private val redisTemplate: RedisTemplate<String, WorkspaceSessionRedisData>,
+    private val listOps: ListOperations<String, WorkspaceSessionRedisData> = redisTemplate.opsForList(),
+) {
+    companion object {
+        const val PREFIX = "workspace:"
+
+        fun key(workspaceId: Long) = "$PREFIX$workspaceId"
+    }
+
+    fun addWorkspaceSession(
+        workspaceId: Long,
+        workspaceSession: WorkspaceSession,
+    ) {
+        listOps.leftPush(key(workspaceId), WorkspaceSessionRedisData.of(workspaceSession))
+    }
+}

realtime/build.gradle.kts

@@ -21,6 +21,9 @@ dependencies {
     implementation("org.springframework.boot:spring-boot-starter-data-redis")
 
     testImplementation(kotlin("test"))
+    testImplementation("com.redis.testcontainers:testcontainers-redis-junit:1.6.4")
+    testImplementation("org.testcontainers:testcontainers:1.19.0")
+    testImplementation("org.testcontainers:mysql:1.16.0")
 }
 
 tasks.withType<KotlinCompile> {

realtime/src/main/kotlin/com/backgu/amaker/realtime/config/RedisConfig.kt

@@ -0,0 +1,39 @@
+package com.backgu.amaker.realtime.config
+
+import com.backgu.amaker.infra.redis.workspace.dto.WorkspaceSessionRedisData
+import com.backgu.amaker.infra.redis.workspace.repository.WorkspaceSessionRepository
+import org.springframework.boot.context.properties.ConfigurationProperties
+import org.springframework.context.annotation.Bean
+import org.springframework.context.annotation.Configuration
+import org.springframework.data.redis.connection.RedisConnectionFactory
+import org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory
+import org.springframework.data.redis.core.RedisTemplate
+import org.springframework.data.redis.serializer.GenericJackson2JsonRedisSerializer
+import org.springframework.data.redis.serializer.StringRedisSerializer
+
+@Configuration
+@ConfigurationProperties(prefix = "spring.data.redis")
+class RedisConfig {
+    lateinit var host: String
+    var port: Int = 0
+
+    @Bean
+    fun redisConnectionFactory(): RedisConnectionFactory {
+        val factory = LettuceConnectionFactory(host, port)
+        factory.afterPropertiesSet()
+        return factory
+    }
+
+    @Bean
+    fun redisTemplate(): RedisTemplate<String, WorkspaceSessionRedisData> {
+        val template = RedisTemplate<String, WorkspaceSessionRedisData>()
+        template.connectionFactory = redisConnectionFactory()
+        template.keySerializer = StringRedisSerializer()
+        template.valueSerializer = GenericJackson2JsonRedisSerializer()
+        return template
+    }
+
+    @Bean
+    fun workspaceSessionRepository(redisTemplate: RedisTemplate<String, WorkspaceSessionRedisData>): WorkspaceSessionRepository =
+        WorkspaceSessionRepository(redisTemplate)
+}

realtime/src/main/kotlin/com/backgu/amaker/realtime/workspace/service/WorkspaceSessionFacadeService.kt

@@ -0,0 +1,28 @@
+package com.backgu.amaker.realtime.workspace.service
+
+import com.backgu.amaker.realtime.workspace.session.WorkspaceWebSocketSession
+import org.springframework.stereotype.Service
+import org.springframework.web.socket.WebSocketSession
+
+@Service
+class WorkspaceSessionFacadeService(
+    private val workspaceUserService: WorkspaceUserService,
+    private val workspaceSessionService: WorkspaceSessionService,
+) {
+    fun enrollUserToWorkspaceSession(
+        userId: String,
+        workspaceId: Long,
+        workspaceSession: WorkspaceWebSocketSession<WebSocketSession>,
+    ) {
+        workspaceUserService.checkUserBelongToWorkspace(userId, workspaceId)
+        workspaceSessionService.enrollUserToWorkspaceSession(userId, workspaceId, workspaceSession)
+    }
+
+    fun dropOutWorkspaceSession(
+        userId: String,
+        workspaceId: Long,
+        workspaceSession: WorkspaceWebSocketSession<WebSocketSession>,
+    ) {
+        workspaceSessionService.dropOut(userId, workspaceId, workspaceSession)
+    }
+}

realtime/src/main/kotlin/com/backgu/amaker/realtime/workspace/service/WorkspaceSessionService.kt

@@ -0,0 +1,33 @@
+package com.backgu.amaker.realtime.workspace.service
+
+import com.backgu.amaker.infra.redis.workspace.repository.WorkspaceSessionRepository
+import com.backgu.amaker.realtime.workspace.session.WorkspaceWebSocketSession
+import com.backgu.amaker.realtime.workspace.storage.SessionStorage
+import org.springframework.stereotype.Service
+import org.springframework.web.socket.WebSocketSession
+
+@Service
+class WorkspaceSessionService(
+    private val sessionStorage: SessionStorage,
+    private val workspaceSessionRepository: WorkspaceSessionRepository,
+) {
+    fun enrollUserToWorkspaceSession(
+        userId: String,
+        workspaceId: Long,
+        session: WorkspaceWebSocketSession<WebSocketSession>,
+    ) {
+        sessionStorage.addSession(session)
+        workspaceSessionRepository.addWorkspaceSession(
+            workspaceId,
+            session.toDomain(),
+        )
+    }
+
+    fun dropOut(
+        userId: String,
+        workspaceId: Long,
+        session: WorkspaceWebSocketSession<WebSocketSession>,
+    ) {
+        sessionStorage.removeSession(session.id)
+    }
+}

realtime/src/main/kotlin/com/backgu/amaker/realtime/workspace/session/WorkspaceWebSocketSession.kt

@@ -0,0 +1,13 @@
+package com.backgu.amaker.realtime.workspace.session
+
+import com.backgu.amaker.domain.workspace.WorkspaceSession
+
+class WorkspaceWebSocketSession<T>(
+    val id: String,
+    val userId: String,
+    val workspaceId: Long,
+    val realTimeId: String,
+    val session: T,
+) {
+    fun toDomain() = WorkspaceSession(id, userId, workspaceId, realTimeId)
+}

realtime/src/main/kotlin/com/backgu/amaker/realtime/workspace/storage/SessionStorage.kt

@@ -0,0 +1,24 @@
+package com.backgu.amaker.realtime.workspace.storage
+
+import com.backgu.amaker.common.status.StatusCode
+import com.backgu.amaker.realtime.common.excpetion.RealTimeException
+import com.backgu.amaker.realtime.workspace.session.WorkspaceWebSocketSession
+import org.springframework.stereotype.Component
+import org.springframework.web.socket.WebSocketSession
+import java.util.concurrent.ConcurrentHashMap
+
+@Component
+class SessionStorage {
+    private val sessionsMap = ConcurrentHashMap<String, WorkspaceWebSocketSession<WebSocketSession>>()
+
+    fun addSession(session: WorkspaceWebSocketSession<WebSocketSession>) {
+        sessionsMap[session.id] = session
+    }
+
+    fun removeSession(id: String) {
+        sessionsMap.remove(id)
+    }
+
+    fun getSession(id: String): WorkspaceWebSocketSession<WebSocketSession> =
+        sessionsMap[id] ?: throw RealTimeException(StatusCode.INTERNAL_SERVER_ERROR)
+}

realtime/src/main/kotlin/com/backgu/amaker/realtime/ws/handler/WebSocketSessionHandler.kt

@@ -1,28 +1,29 @@
 package com.backgu.amaker.realtime.ws.handler
 
+import com.backgu.amaker.realtime.server.config.ServerConfig
 import com.backgu.amaker.realtime.utils.WebSocketSessionUtils
-import com.backgu.amaker.realtime.workspace.service.WorkspaceUserService
+import com.backgu.amaker.realtime.workspace.service.WorkspaceSessionFacadeService
+import com.backgu.amaker.realtime.workspace.session.WorkspaceWebSocketSession
 import com.backgu.amaker.realtime.ws.constants.WebSocketConstants.Companion.USER_ID
 import com.backgu.amaker.realtime.ws.constants.WebSocketConstants.Companion.WORKSPACE_ID
-import com.backgu.amaker.realtime.ws.session.SessionInfo
-import com.backgu.amaker.realtime.ws.session.storage.SessionStorage
 import org.springframework.stereotype.Component
 import org.springframework.web.socket.CloseStatus
 import org.springframework.web.socket.WebSocketSession
 import org.springframework.web.socket.handler.TextWebSocketHandler
 
 @Component
 class WebSocketSessionHandler(
-    private val storage: SessionStorage<Long, String, SessionInfo>,
-    private val workspaceUserService: WorkspaceUserService,
+    private val workspaceSessionFacadeService: WorkspaceSessionFacadeService,
+    private val serverConfig: ServerConfig,
 ) : TextWebSocketHandler() {
     override fun afterConnectionEstablished(session: WebSocketSession) {
         val userId: String = WebSocketSessionUtils.extractAttribute<String>(session, USER_ID)
         val workspaceId = WebSocketSessionUtils.extractAttribute<Long>(session, WORKSPACE_ID)
-
-        workspaceUserService.checkUserBelongToWorkspace(userId, workspaceId)
-
-        storage.addSession(workspaceId, userId, SessionInfo(userId, workspaceId, session))
+        workspaceSessionFacadeService.enrollUserToWorkspaceSession(
+            userId,
+            workspaceId,
+            WorkspaceWebSocketSession(session.id, userId, workspaceId, serverConfig.id, session),
+        )
     }
 
     override fun afterConnectionClosed(
@@ -32,6 +33,10 @@ class WebSocketSessionHandler(
         val userId: String = WebSocketSessionUtils.extractAttribute<String>(session, USER_ID)
         val workspaceId = WebSocketSessionUtils.extractAttribute<Long>(session, WORKSPACE_ID)
 
-        storage.removeSession(workspaceId, userId)
+        workspaceSessionFacadeService.dropOutWorkspaceSession(
+            userId,
+            workspaceId,
+            WorkspaceWebSocketSession(session.id, userId, workspaceId, serverConfig.id, session),
+        )
     }
 }