Merge pull request #5231 from getsentry/fix/cache-tracing-invalidate-cache-write

fix(spring): [Cache Tracing 24] Track invalidate cache.write accurately

Author: adinauer

sentry-spring-7/src/main/java/io/sentry/spring7/cache/SentryCacheWrapper.java

@@ -287,7 +287,7 @@ public boolean invalidate() {
     }
     try {
       final boolean result = delegate.invalidate();
-      span.setData(SpanDataConvention.CACHE_WRITE, true);
+      span.setData(SpanDataConvention.CACHE_WRITE, result);
       span.setStatus(SpanStatus.OK);
       return result;
     } catch (Throwable e) {

sentry-spring-7/src/test/kotlin/io/sentry/spring7/cache/SentryCacheWrapperTest.kt

@@ -13,6 +13,7 @@ import kotlin.test.BeforeTest
 import kotlin.test.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertFailsWith
+import kotlin.test.assertFalse
 import kotlin.test.assertNull
 import kotlin.test.assertTrue
 import org.mockito.kotlin.any
@@ -450,6 +451,21 @@ class SentryCacheWrapperTest {
     assertEquals("invalidate", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION))
   }
 
+  @Test
+  fun `invalidate sets cache write false when cache had no mappings`() {
+    val tx = createTransaction()
+    val wrapper = SentryCacheWrapper(delegate, scopes)
+    whenever(delegate.invalidate()).thenReturn(false)
+
+    val result = wrapper.invalidate()
+
+    assertFalse(result)
+    assertEquals(1, tx.spans.size)
+    assertEquals("cache.invalidate", tx.spans.first().operation)
+    assertEquals(false, tx.spans.first().getData(SpanDataConvention.CACHE_WRITE))
+    assertEquals("invalidate", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION))
+  }
+
   // -- no span when no active transaction --
 
   @Test

sentry-spring-jakarta/src/main/java/io/sentry/spring/jakarta/cache/SentryCacheWrapper.java

@@ -287,7 +287,7 @@ public boolean invalidate() {
     }
     try {
       final boolean result = delegate.invalidate();
-      span.setData(SpanDataConvention.CACHE_WRITE, true);
+      span.setData(SpanDataConvention.CACHE_WRITE, result);
       span.setStatus(SpanStatus.OK);
       return result;
     } catch (Throwable e) {

sentry-spring-jakarta/src/test/kotlin/io/sentry/spring/jakarta/cache/SentryCacheWrapperTest.kt

@@ -13,6 +13,7 @@ import kotlin.test.BeforeTest
 import kotlin.test.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertFailsWith
+import kotlin.test.assertFalse
 import kotlin.test.assertNull
 import kotlin.test.assertTrue
 import org.mockito.kotlin.any
@@ -450,6 +451,21 @@ class SentryCacheWrapperTest {
     assertEquals("invalidate", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION))
   }
 
+  @Test
+  fun `invalidate sets cache write false when cache had no mappings`() {
+    val tx = createTransaction()
+    val wrapper = SentryCacheWrapper(delegate, scopes)
+    whenever(delegate.invalidate()).thenReturn(false)
+
+    val result = wrapper.invalidate()
+
+    assertFalse(result)
+    assertEquals(1, tx.spans.size)
+    assertEquals("cache.invalidate", tx.spans.first().operation)
+    assertEquals(false, tx.spans.first().getData(SpanDataConvention.CACHE_WRITE))
+    assertEquals("invalidate", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION))
+  }
+
   // -- no span when no active transaction --
 
   @Test

sentry-spring/src/main/java/io/sentry/spring/cache/SentryCacheWrapper.java

@@ -214,7 +214,7 @@ public boolean invalidate() {
     }
     try {
       final boolean result = delegate.invalidate();
-      span.setData(SpanDataConvention.CACHE_WRITE, true);
+      span.setData(SpanDataConvention.CACHE_WRITE, result);
       span.setStatus(SpanStatus.OK);
       return result;
     } catch (Throwable e) {

sentry-spring/src/test/kotlin/io/sentry/spring/cache/SentryCacheWrapperTest.kt

@@ -11,6 +11,7 @@ import kotlin.test.BeforeTest
 import kotlin.test.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertFailsWith
+import kotlin.test.assertFalse
 import kotlin.test.assertNull
 import kotlin.test.assertTrue
 import org.mockito.kotlin.any
@@ -274,6 +275,21 @@ class SentryCacheWrapperTest {
     assertEquals("invalidate", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION))
   }
 
+  @Test
+  fun `invalidate sets cache write false when cache had no mappings`() {
+    val tx = createTransaction()
+    val wrapper = SentryCacheWrapper(delegate, scopes)
+    whenever(delegate.invalidate()).thenReturn(false)
+
+    val result = wrapper.invalidate()
+
+    assertFalse(result)
+    assertEquals(1, tx.spans.size)
+    assertEquals("cache.invalidate", tx.spans.first().operation)
+    assertEquals(false, tx.spans.first().getData(SpanDataConvention.CACHE_WRITE))
+    assertEquals("invalidate", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION))
+  }
+
   // -- no span when no active transaction --
 
   @Test