SentryCheckIn annotation and advice config for Spring

sentry-spring-jakarta/src/main/java/io/sentry/spring/jakarta/checkin/SentryCheckIn.java

@@ -9,7 +9,7 @@
 
 /** Sends a {@link io.sentry.CheckIn} for the annotated method. */
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD, ElementType.TYPE})
+@Target({ElementType.METHOD})
 @ApiStatus.Experimental
 public @interface SentryCheckIn {
 

sentry-spring-jakarta/src/test/kotlin/io/sentry/spring/jakarta/SentryCheckInAdviceTest.kt

@@ -0,0 +1,173 @@
+package io.sentry.spring.jakarta
+
+import io.sentry.CheckIn
+import io.sentry.CheckInStatus
+import io.sentry.IHub
+import io.sentry.SentryOptions
+import io.sentry.protocol.SentryId
+import io.sentry.spring.jakarta.checkin.SentryCheckIn
+import io.sentry.spring.jakarta.checkin.SentryCheckInAdviceConfiguration
+import io.sentry.spring.jakarta.checkin.SentryCheckInPointcutConfiguration
+import org.junit.jupiter.api.assertThrows
+import org.junit.runner.RunWith
+import org.mockito.kotlin.argumentCaptor
+import org.mockito.kotlin.mock
+import org.mockito.kotlin.whenever
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.context.annotation.Bean
+import org.springframework.context.annotation.Configuration
+import org.springframework.context.annotation.EnableAspectJAutoProxy
+import org.springframework.context.annotation.Import
+import org.springframework.test.context.junit.jupiter.SpringJUnitConfig
+import org.springframework.test.context.junit4.SpringRunner
+import kotlin.RuntimeException
+import kotlin.test.BeforeTest
+import kotlin.test.Test
+import kotlin.test.assertEquals
+import kotlin.test.assertNotNull
+
+@RunWith(SpringRunner::class)
+@SpringJUnitConfig(SentryCheckInAdviceTest.Config::class)
+class SentryCheckInAdviceTest {
+
+    @Autowired
+    lateinit var sampleService: SampleService
+
+    @Autowired
+    lateinit var sampleServiceNoSlug: SampleServiceNoSlug
+
+    @Autowired
+    lateinit var sampleServiceHeartbeat: SampleServiceHeartbeat
+
+    @Autowired
+    lateinit var hub: IHub
+
+    @BeforeTest
+    fun setup() {
+        whenever(hub.options).thenReturn(SentryOptions())
+    }
+
+    @Test
+    fun `when class is annotated with @SentryCheckIn, every method call creates two check-ins`() {
+        val checkInId = SentryId()
+        val checkInCaptor = argumentCaptor<CheckIn>()
+        whenever(hub.captureCheckIn(checkInCaptor.capture())).thenReturn(checkInId)
+        val result = sampleService.hello()
+        assertEquals(1, result)
+        assertEquals(2, checkInCaptor.allValues.size)
+
+        val inProgressCheckIn = checkInCaptor.firstValue
+        assertEquals("monitor_slug_1", inProgressCheckIn.monitorSlug)
+        assertEquals(CheckInStatus.IN_PROGRESS.apiName(), inProgressCheckIn.status)
+
+        val doneCheckIn = checkInCaptor.lastValue
+        assertEquals("monitor_slug_1", doneCheckIn.monitorSlug)
+        assertEquals(CheckInStatus.OK.apiName(), doneCheckIn.status)
+    }
+
+    @Test
+    fun `when class is annotated with @SentryCheckIn, every method call creates two check-ins error`() {
+        val checkInId = SentryId()
+        val checkInCaptor = argumentCaptor<CheckIn>()
+        whenever(hub.captureCheckIn(checkInCaptor.capture())).thenReturn(checkInId)
+        assertThrows<RuntimeException> {
+            sampleService.oops()
+        }
+        assertEquals(2, checkInCaptor.allValues.size)
+
+        val inProgressCheckIn = checkInCaptor.firstValue
+        assertEquals("monitor_slug_1e", inProgressCheckIn.monitorSlug)
+        assertEquals(CheckInStatus.IN_PROGRESS.apiName(), inProgressCheckIn.status)
+
+        val doneCheckIn = checkInCaptor.lastValue
+        assertEquals("monitor_slug_1e", doneCheckIn.monitorSlug)
+        assertEquals(CheckInStatus.ERROR.apiName(), doneCheckIn.status)
+    }
+
+    @Test
+    fun `when class is annotated with @SentryCheckIn and heartbeat only, every method call creates only one check-in at the end`() {
+        val checkInId = SentryId()
+        val checkInCaptor = argumentCaptor<CheckIn>()
+        whenever(hub.captureCheckIn(checkInCaptor.capture())).thenReturn(checkInId)
+        val result = sampleServiceHeartbeat.hello()
+        assertEquals(1, result)
+        assertEquals(1, checkInCaptor.allValues.size)
+
+        val doneCheckIn = checkInCaptor.lastValue
+        assertEquals("monitor_slug_2", doneCheckIn.monitorSlug)
+        assertEquals(CheckInStatus.OK.apiName(), doneCheckIn.status)
+        assertNotNull(doneCheckIn.duration)
+    }
+
+    @Test
+    fun `when class is annotated with @SentryCheckIn and heartbeat only, every method call creates only one check-in at the end with error`() {
+        val checkInId = SentryId()
+        val checkInCaptor = argumentCaptor<CheckIn>()
+        whenever(hub.captureCheckIn(checkInCaptor.capture())).thenReturn(checkInId)
+        assertThrows<RuntimeException> {
+            sampleServiceHeartbeat.oops()
+        }
+        assertEquals(1, checkInCaptor.allValues.size)
+
+        val doneCheckIn = checkInCaptor.lastValue
+        assertEquals("monitor_slug_2e", doneCheckIn.monitorSlug)
+        assertEquals(CheckInStatus.ERROR.apiName(), doneCheckIn.status)
+        assertNotNull(doneCheckIn.duration)
+    }
+
+    @Test
+    fun `when class is annotated with @SentryCheckIn but slug is missing, does not create check-in`() {
+        val checkInId = SentryId()
+        val checkInCaptor = argumentCaptor<CheckIn>()
+        whenever(hub.captureCheckIn(checkInCaptor.capture())).thenReturn(checkInId)
+        val result = sampleServiceNoSlug.hello()
+        assertEquals(1, result)
+        assertEquals(0, checkInCaptor.allValues.size)
+    }
+
+    @Configuration
+    @EnableAspectJAutoProxy(proxyTargetClass = true)
+    @Import(SentryCheckInAdviceConfiguration::class, SentryCheckInPointcutConfiguration::class)
+    open class Config {
+
+        @Bean
+        open fun sampleService() = SampleService()
+
+        @Bean
+        open fun sampleServiceNoSlug() = SampleServiceNoSlug()
+
+        @Bean
+        open fun sampleServiceHeartbeat() = SampleServiceHeartbeat()
+
+        @Bean
+        open fun hub() = mock<IHub>()
+    }
+
+    open class SampleService {
+
+        @SentryCheckIn("monitor_slug_1")
+        open fun hello() = 1
+
+        @SentryCheckIn("monitor_slug_1e")
+        open fun oops() {
+            throw RuntimeException("thrown on purpose")
+        }
+    }
+
+    open class SampleServiceNoSlug {
+
+        @SentryCheckIn
+        open fun hello() = 1
+    }
+
+    open class SampleServiceHeartbeat {
+
+        @SentryCheckIn(monitorSlug = "monitor_slug_2", heartbeat = true)
+        open fun hello() = 1
+
+        @SentryCheckIn(monitorSlug = "monitor_slug_2e", heartbeat = true)
+        open fun oops() {
+            throw RuntimeException("thrown on purpose")
+        }
+    }
+}

sentry-spring/src/main/java/io/sentry/spring/checkin/SentryCheckIn.java

@@ -9,7 +9,7 @@
 
 /** Sends a {@link io.sentry.CheckIn} for the annotated method. */
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD, ElementType.TYPE})
+@Target({ElementType.METHOD})
 @ApiStatus.Experimental
 public @interface SentryCheckIn {
 

sentry-spring/src/test/kotlin/io/sentry/spring/SentryCheckInAdviceTest.kt

@@ -0,0 +1,173 @@
+package io.sentry.spring
+
+import io.sentry.CheckIn
+import io.sentry.CheckInStatus
+import io.sentry.IHub
+import io.sentry.SentryOptions
+import io.sentry.protocol.SentryId
+import io.sentry.spring.checkin.SentryCheckIn
+import io.sentry.spring.checkin.SentryCheckInAdviceConfiguration
+import io.sentry.spring.checkin.SentryCheckInPointcutConfiguration
+import org.junit.jupiter.api.assertThrows
+import org.junit.runner.RunWith
+import org.mockito.kotlin.argumentCaptor
+import org.mockito.kotlin.mock
+import org.mockito.kotlin.whenever
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.context.annotation.Bean
+import org.springframework.context.annotation.Configuration
+import org.springframework.context.annotation.EnableAspectJAutoProxy
+import org.springframework.context.annotation.Import
+import org.springframework.test.context.junit.jupiter.SpringJUnitConfig
+import org.springframework.test.context.junit4.SpringRunner
+import kotlin.RuntimeException
+import kotlin.test.BeforeTest
+import kotlin.test.Test
+import kotlin.test.assertEquals
+import kotlin.test.assertNotNull
+
+@RunWith(SpringRunner::class)
+@SpringJUnitConfig(SentryCheckInAdviceTest.Config::class)
+class SentryCheckInAdviceTest {
+
+    @Autowired
+    lateinit var sampleService: SampleService
+
+    @Autowired
+    lateinit var sampleServiceNoSlug: SampleServiceNoSlug
+
+    @Autowired
+    lateinit var sampleServiceHeartbeat: SampleServiceHeartbeat
+
+    @Autowired
+    lateinit var hub: IHub
+
+    @BeforeTest
+    fun setup() {
+        whenever(hub.options).thenReturn(SentryOptions())
+    }
+
+    @Test
+    fun `when class is annotated with @SentryCheckIn, every method call creates two check-ins`() {
+        val checkInId = SentryId()
+        val checkInCaptor = argumentCaptor<CheckIn>()
+        whenever(hub.captureCheckIn(checkInCaptor.capture())).thenReturn(checkInId)
+        val result = sampleService.hello()
+        assertEquals(1, result)
+        assertEquals(2, checkInCaptor.allValues.size)
+
+        val inProgressCheckIn = checkInCaptor.firstValue
+        assertEquals("monitor_slug_1", inProgressCheckIn.monitorSlug)
+        assertEquals(CheckInStatus.IN_PROGRESS.apiName(), inProgressCheckIn.status)
+
+        val doneCheckIn = checkInCaptor.lastValue
+        assertEquals("monitor_slug_1", doneCheckIn.monitorSlug)
+        assertEquals(CheckInStatus.OK.apiName(), doneCheckIn.status)
+    }
+
+    @Test
+    fun `when class is annotated with @SentryCheckIn, every method call creates two check-ins error`() {
+        val checkInId = SentryId()
+        val checkInCaptor = argumentCaptor<CheckIn>()
+        whenever(hub.captureCheckIn(checkInCaptor.capture())).thenReturn(checkInId)
+        assertThrows<RuntimeException> {
+            sampleService.oops()
+        }
+        assertEquals(2, checkInCaptor.allValues.size)
+
+        val inProgressCheckIn = checkInCaptor.firstValue
+        assertEquals("monitor_slug_1e", inProgressCheckIn.monitorSlug)
+        assertEquals(CheckInStatus.IN_PROGRESS.apiName(), inProgressCheckIn.status)
+
+        val doneCheckIn = checkInCaptor.lastValue
+        assertEquals("monitor_slug_1e", doneCheckIn.monitorSlug)
+        assertEquals(CheckInStatus.ERROR.apiName(), doneCheckIn.status)
+    }
+
+    @Test
+    fun `when class is annotated with @SentryCheckIn and heartbeat only, every method call creates only one check-in at the end`() {
+        val checkInId = SentryId()
+        val checkInCaptor = argumentCaptor<CheckIn>()
+        whenever(hub.captureCheckIn(checkInCaptor.capture())).thenReturn(checkInId)
+        val result = sampleServiceHeartbeat.hello()
+        assertEquals(1, result)
+        assertEquals(1, checkInCaptor.allValues.size)
+
+        val doneCheckIn = checkInCaptor.lastValue
+        assertEquals("monitor_slug_2", doneCheckIn.monitorSlug)
+        assertEquals(CheckInStatus.OK.apiName(), doneCheckIn.status)
+        assertNotNull(doneCheckIn.duration)
+    }
+
+    @Test
+    fun `when class is annotated with @SentryCheckIn and heartbeat only, every method call creates only one check-in at the end with error`() {
+        val checkInId = SentryId()
+        val checkInCaptor = argumentCaptor<CheckIn>()
+        whenever(hub.captureCheckIn(checkInCaptor.capture())).thenReturn(checkInId)
+        assertThrows<RuntimeException> {
+            sampleServiceHeartbeat.oops()
+        }
+        assertEquals(1, checkInCaptor.allValues.size)
+
+        val doneCheckIn = checkInCaptor.lastValue
+        assertEquals("monitor_slug_2e", doneCheckIn.monitorSlug)
+        assertEquals(CheckInStatus.ERROR.apiName(), doneCheckIn.status)
+        assertNotNull(doneCheckIn.duration)
+    }
+
+    @Test
+    fun `when class is annotated with @SentryCheckIn but slug is missing, does not create check-in`() {
+        val checkInId = SentryId()
+        val checkInCaptor = argumentCaptor<CheckIn>()
+        whenever(hub.captureCheckIn(checkInCaptor.capture())).thenReturn(checkInId)
+        val result = sampleServiceNoSlug.hello()
+        assertEquals(1, result)
+        assertEquals(0, checkInCaptor.allValues.size)
+    }
+
+    @Configuration
+    @EnableAspectJAutoProxy(proxyTargetClass = true)
+    @Import(SentryCheckInAdviceConfiguration::class, SentryCheckInPointcutConfiguration::class)
+    open class Config {
+
+        @Bean
+        open fun sampleService() = SampleService()
+
+        @Bean
+        open fun sampleServiceNoSlug() = SampleServiceNoSlug()
+
+        @Bean
+        open fun sampleServiceHeartbeat() = SampleServiceHeartbeat()
+
+        @Bean
+        open fun hub() = mock<IHub>()
+    }
+
+    open class SampleService {
+
+        @SentryCheckIn("monitor_slug_1")
+        open fun hello() = 1
+
+        @SentryCheckIn("monitor_slug_1e")
+        open fun oops() {
+            throw RuntimeException("thrown on purpose")
+        }
+    }
+
+    open class SampleServiceNoSlug {
+
+        @SentryCheckIn
+        open fun hello() = 1
+    }
+
+    open class SampleServiceHeartbeat {
+
+        @SentryCheckIn(monitorSlug = "monitor_slug_2", heartbeat = true)
+        open fun hello() = 1
+
+        @SentryCheckIn(monitorSlug = "monitor_slug_2e", heartbeat = true)
+        open fun oops() {
+            throw RuntimeException("thrown on purpose")
+        }
+    }
+}