Skip to content
Merged
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package team.darkmoderap.aikon.domain.avatar.event

import org.springframework.web.servlet.mvc.method.annotation.SseEmitter

class AvatarSseSubscribedEvent(
val emitter: SseEmitter,
)
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ package team.darkmoderap.aikon.domain.avatar.service

import org.slf4j.LoggerFactory
import org.springframework.beans.factory.annotation.Value
import org.springframework.context.ApplicationEventPublisher
import org.springframework.context.event.EventListener
import org.springframework.scheduling.annotation.Async
import org.springframework.scheduling.annotation.Scheduled
import org.springframework.stereotype.Service
Expand All @@ -12,89 +14,70 @@ import org.springframework.web.servlet.mvc.method.annotation.SseEmitter
import team.darkmoderap.aikon.domain.avatar.dto.AvatarChangeResDto
import team.darkmoderap.aikon.domain.avatar.entity.AvatarEntity
import team.darkmoderap.aikon.domain.avatar.event.AvatarListChangedEvent
import team.darkmoderap.aikon.domain.avatar.event.AvatarSseSubscribedEvent
import team.darkmoderap.aikon.domain.avatar.repository.AvatarRepository
import team.darkmoderap.aikon.global.common.error.AikonException
import team.darkmoderap.aikon.global.common.error.ErrorCode
import java.io.IOException
import java.util.concurrent.CopyOnWriteArrayList
import java.util.concurrent.atomic.AtomicInteger

@Service
class SubscribeAvatarChangesServiceImpl(
private val avatarRepository: AvatarRepository,
private val eventPublisher: ApplicationEventPublisher,
@Value("\${aikon.sse.timeout-millis:1800000}") private val timeoutMillis: Long,
@Value("\${aikon.sse.max-connections:100}") private val maxConnections: Int,
) : SubscribeAvatarChangesService {
private val logger = LoggerFactory.getLogger(SubscribeAvatarChangesServiceImpl::class.java)
private val emitters = CopyOnWriteArrayList<SseEmitter>()
private val activeConnections = AtomicInteger(0)

@Transactional(readOnly = true)
override fun execute(): SseEmitter {
if (activeConnections.incrementAndGet() > maxConnections) {
activeConnections.decrementAndGet()
throw AikonException(ErrorCode.SSE_MAX_CONNECTIONS_EXCEEDED)
}
val emitter = SseEmitter(timeoutMillis)
try {
emitters.add(emitter)

emitter.onCompletion {
if (emitters.remove(emitter)) {
logger.info("SSE connection closed. active={}", activeConnections.decrementAndGet())
}
}
emitter.onTimeout {
if (emitters.remove(emitter)) {
logger.info("SSE connection timed out. active={}", activeConnections.decrementAndGet())
}
synchronized(emitters) {
if (emitters.size >= maxConnections) {
throw AikonException(ErrorCode.SSE_MAX_CONNECTIONS_EXCEEDED)
}
emitter.onError { e ->
if (emitters.remove(emitter)) {
logger.warn("SSE connection error {}. active={}", e.message, activeConnections.decrementAndGet())
}
}

logger.info("SSE connection opened. active={}", activeConnections.get())
send(emitter, findAvatarChanges())
} catch (e: Throwable) {
if (emitters.remove(emitter)) activeConnections.decrementAndGet()
throw e
emitters.add(emitter)
}

emitter.onCompletion { cleanup(emitter, "closed") }
emitter.onTimeout { cleanup(emitter, "timed out") }
emitter.onError { e -> cleanup(emitter, "error: ${e.message}") }

logger.info("SSE connection opened. active={}", emitters.size)
eventPublisher.publishEvent(AvatarSseSubscribedEvent(emitter))
return emitter
}

@Async
@TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT)
@EventListener
@Transactional(readOnly = true)
fun onAvatarSseSubscribed(event: AvatarSseSubscribedEvent) {
send(event.emitter, findAvatarChanges())
}
Comment on lines 51 to +56

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

In onAvatarSseSubscribed, if findAvatarChanges() throws an exception (e.g., due to a database connection timeout or query failure), the exception will propagate out of the @Async method. Because send is never called, the cleanup method is never invoked, leaving the SseEmitter in the emitters list indefinitely (until it eventually times out, which is set to 30 minutes). This can leak connection slots and quickly exhaust maxConnections under database error conditions.

We should wrap the execution in a runCatching block and ensure cleanup is called with complete = true if an exception occurs.

    @Async
    @EventListener
    @Transactional(readOnly = true)
    fun onAvatarSseSubscribed(event: AvatarSseSubscribedEvent) {
        runCatching { findAvatarChanges() }
            .onSuccess { send(event.emitter, it) }
            .onFailure { e ->
                logger.error("Failed to send initial avatar changes", e)
                cleanup(event.emitter, "initial send failed", complete = true)
            }
    }


@Async
@TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT, fallbackExecution = true)
@Transactional(readOnly = true)
fun handleAvatarListChanged(event: AvatarListChangedEvent) {
if (emitters.isEmpty()) return
val avatarChanges = findAvatarChanges()
emitters.forEach { emitter -> send(emitter, avatarChanges) }
}

@Scheduled(fixedDelayString = "\${aikon.sse.heartbeat-interval-millis:30000}")
@Scheduled(fixedDelayString = "\${aikon.sse.heartbeat-interval-millis:10000}")
fun sendHeartbeat() {
if (emitters.isEmpty()) return
val deadEmitters = mutableListOf<SseEmitter>()
emitters.forEach { emitter ->
var failed = false
synchronized(emitter) {
try {
emitter.send(SseEmitter.event().comment("heartbeat"))
} catch (exception: IOException) {
logger.warn("Removed failed emitter on heartbeat {}", exception.message)
deadEmitters.add(emitter)
} catch (exception: IllegalStateException) {
logger.warn("Removed closed emitter on heartbeat {}", exception.message)
deadEmitters.add(emitter)
} catch (e: Exception) {
logger.warn("Heartbeat send failed {}", e.message)
failed = true
}
}
}
if (deadEmitters.isNotEmpty()) {
var removedCount = 0
deadEmitters.forEach { dead ->
if (emitters.remove(dead)) removedCount++
}
if (removedCount > 0) activeConnections.addAndGet(-removedCount)
if (failed) cleanup(emitter, "heartbeat failed", complete = true)
}
}

Expand All @@ -107,6 +90,7 @@ class SubscribeAvatarChangesServiceImpl(
emitter: SseEmitter,
avatarChanges: List<AvatarChangeResDto>,
) {
var failed = false
synchronized(emitter) {
try {
emitter.send(
Expand All @@ -115,12 +99,23 @@ class SubscribeAvatarChangesServiceImpl(
.name(EVENT_NAME)
.data(avatarChanges),
)
} catch (exception: IOException) {
logger.warn("Removed failed avatar change emitter {}", exception.message)
if (emitters.remove(emitter)) activeConnections.decrementAndGet()
} catch (exception: IllegalStateException) {
logger.warn("Removed closed avatar change emitter {}", exception.message)
if (emitters.remove(emitter)) activeConnections.decrementAndGet()
} catch (e: Exception) {
logger.warn("Send failed, removing emitter {}", e.message)
failed = true
}
}
if (failed) cleanup(emitter, "send failed", complete = true)
}

private fun cleanup(
emitter: SseEmitter,
reason: String,
complete: Boolean = false,
) {
if (emitters.remove(emitter)) {
logger.info("SSE connection {} active={}", reason, emitters.size)
if (complete) {
runCatching { emitter.complete() }
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/application.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ aikon:
public-base-url: ${FRONTEND_PUBLIC_BASE_URL:}
sse:
timeout-millis: 1800000
heartbeat-interval-millis: 30000
heartbeat-interval-millis: 10000
max-connections: 100

gemini:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,20 @@ import org.junit.jupiter.api.DisplayName
import org.junit.jupiter.api.Nested
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.extension.ExtendWith
import org.mockito.ArgumentMatchers.any
import org.mockito.BDDMockito.given
import org.mockito.Mock
import org.mockito.Mockito.times
import org.mockito.Mockito.verify
import org.mockito.junit.jupiter.MockitoExtension
import org.springframework.context.ApplicationEventPublisher
import org.springframework.web.servlet.mvc.method.annotation.SseEmitter
import team.darkmoderap.aikon.domain.avatar.entity.AvatarEntity
import team.darkmoderap.aikon.domain.avatar.entity.enum.AgeRange
import team.darkmoderap.aikon.domain.avatar.entity.enum.Gender
import team.darkmoderap.aikon.domain.avatar.entity.enum.GenerationStatus
import team.darkmoderap.aikon.domain.avatar.entity.enum.Style
import team.darkmoderap.aikon.domain.avatar.event.AvatarListChangedEvent
import team.darkmoderap.aikon.domain.avatar.event.AvatarSseSubscribedEvent
import team.darkmoderap.aikon.domain.avatar.repository.AvatarRepository
import team.darkmoderap.aikon.global.common.error.AikonException

Expand All @@ -25,13 +28,17 @@ class SubscribeAvatarChangesServiceImplTest {
@Mock
private lateinit var avatarRepository: AvatarRepository

@Mock
private lateinit var eventPublisher: ApplicationEventPublisher

private lateinit var subscribeAvatarChangesService: SubscribeAvatarChangesServiceImpl

@BeforeEach
fun setUp() {
subscribeAvatarChangesService =
SubscribeAvatarChangesServiceImpl(
avatarRepository = avatarRepository,
eventPublisher = eventPublisher,
timeoutMillis = 5000L,
maxConnections = 2,
)
Expand All @@ -41,23 +48,21 @@ class SubscribeAvatarChangesServiceImplTest {
@DisplayName("execute 메서드는")
inner class Execute {
@Test
@DisplayName("구독을 시작하면 현재 아바타 목록을 조회한다")
fun `finds current avatar list when subscription starts`() {
// Given
given(avatarRepository.findAllByOrderByIdAsc()).willReturn(listOf(avatar()))
@DisplayName("구독을 시작하면 AvatarSseSubscribedEvent를 발행한다")
fun `publishes AvatarSseSubscribedEvent when subscription starts`() {
// Given — no setup needed

// When
subscribeAvatarChangesService.execute()

// Then
verify(avatarRepository).findAllByOrderByIdAsc()
verify(eventPublisher).publishEvent(any(AvatarSseSubscribedEvent::class.java))
}

@Test
@DisplayName("최대 연결 수를 초과하면 예외를 던진다")
fun `throws exception when max connections exceeded`() {
// Given
given(avatarRepository.findAllByOrderByIdAsc()).willReturn(emptyList())
subscribeAvatarChangesService.execute()
subscribeAvatarChangesService.execute()

Expand All @@ -81,7 +86,7 @@ class SubscribeAvatarChangesServiceImplTest {
subscribeAvatarChangesService.handleAvatarListChanged(AvatarListChangedEvent())

// Then
verify(avatarRepository, times(2)).findAllByOrderByIdAsc()
verify(avatarRepository).findAllByOrderByIdAsc()
}
}

Expand Down
Loading