Skip to content

test(spring-jakarta): [Queue Instrumentation 30] Cover Kafka record interceptor lifecycle edge cases #5327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
adinauer wants to merge 1 commit into
base: fix/queue-instrumentation-spring-kafka-body-size
Choose a base branch
from
+60 −0
Open

test(spring-jakarta): [Queue Instrumentation 30] Cover Kafka record interceptor lifecycle edge cases #5327

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
60 changes: 60 additions & 0 deletions ...akarta/src/test/kotlin/io/sentry/spring/jakarta/kafka/SentryKafkaRecordInterceptorTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import kotlin.test.AfterTest
import kotlin.test.BeforeTest
import kotlin.test.Test
import kotlin.test.assertEquals
import kotlin.test.assertFailsWith
import kotlin.test.assertNull
import kotlin.test.assertTrue
import org.apache.kafka.clients.consumer.Consumer
Expand All @@ -27,6 +28,7 @@ import org.apache.kafka.common.record.TimestampType
import org.mockito.kotlin.any
import org.mockito.kotlin.mock
import org.mockito.kotlin.never
import org.mockito.kotlin.times
import org.mockito.kotlin.verify
import org.mockito.kotlin.whenever
import org.springframework.kafka.listener.RecordInterceptor
Expand Down Expand Up @@ -377,6 +379,64 @@ class SentryKafkaRecordInterceptorTest {
verify(delegate).clearThreadState(consumer)
}

@Test
fun `full lifecycle intercept success clearThreadState closes token exactly once`() {
val delegate = mock<RecordInterceptor<String, String>>()
val record = createRecord()
whenever(delegate.intercept(record, consumer)).thenReturn(record)
val interceptor = SentryKafkaRecordInterceptor(scopes, delegate)

interceptor.setupThreadState(consumer)
interceptor.intercept(record, consumer)
interceptor.success(record, consumer)
interceptor.clearThreadState(consumer)

// token closed once by success(); clearThreadState must not re-close it
verify(lifecycleToken, times(1)).close()
assertTrue(transaction.isFinished)
// delegate hooks still delegated across the full lifecycle
verify(delegate).setupThreadState(consumer)
verify(delegate).success(record, consumer)
verify(delegate).clearThreadState(consumer)
}

@Test
fun `when delegate intercept returns null clearThreadState still finishes transaction and closes token`() {
val delegate = mock<RecordInterceptor<String, String>>()
val record = createRecord()
// delegate filters the record — per Spring Kafka contract, success/failure will not be invoked
whenever(delegate.intercept(record, consumer)).thenReturn(null)
val interceptor = SentryKafkaRecordInterceptor(scopes, delegate)

interceptor.setupThreadState(consumer)
val result = interceptor.intercept(record, consumer)
interceptor.clearThreadState(consumer)

assertNull(result)
verify(lifecycleToken, times(1)).close()
assertTrue(transaction.isFinished)
verify(delegate).clearThreadState(consumer)
}

@Test
fun `when delegate intercept throws clearThreadState still finishes transaction and closes token`() {
val delegate = mock<RecordInterceptor<String, String>>()
val record = createRecord()
val boom = RuntimeException("delegate boom")
whenever(delegate.intercept(record, consumer)).thenThrow(boom)
val interceptor = SentryKafkaRecordInterceptor(scopes, delegate)

interceptor.setupThreadState(consumer)
val thrown = assertFailsWith<RuntimeException> { interceptor.intercept(record, consumer) }
assertEquals(boom, thrown)

interceptor.clearThreadState(consumer)

verify(lifecycleToken, times(1)).close()
assertTrue(transaction.isFinished)
verify(delegate).clearThreadState(consumer)
}

@Test
fun `intercept cleans up stale context from previous record`() {
val lifecycleToken2 = mock<ISentryLifecycleToken>()
Expand Down
Loading