Skip to content

fix(spring): [Cache Tracing 21] Fix get(key, type) double-call in SentryCacheWrapper #5210

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

Draft
adinauer wants to merge 1 commit into
base: ref/cache-tracing-rename-constants
Choose a base branch
from
Draft

fix(spring): [Cache Tracing 21] Fix get(key, type) double-call in SentryCacheWrapper #5210

Show file tree
Hide file tree
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
3 changes: 1 addition & 2 deletions sentry-spring-7/src/main/java/io/sentry/spring7/cache/SentryCacheWrapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,8 @@ public SentryCacheWrapper(final @NotNull Cache delegate, final @NotNull IScopes
return delegate.get(key, type);
}
try {
final ValueWrapper wrapper = delegate.get(key);
span.setData(SpanDataConvention.CACHE_HIT, wrapper != null);
final T result = delegate.get(key, type);
span.setData(SpanDataConvention.CACHE_HIT, result != null);
span.setStatus(SpanStatus.OK);
return result;
} catch (Throwable e) {
Expand Down
19 changes: 0 additions & 19 deletions sentry-spring-7/src/test/kotlin/io/sentry/spring7/cache/SentryCacheWrapperTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,6 @@ class SentryCacheWrapperTest {
fun `get with type creates span with cache hit true on hit`() {
val tx = createTransaction()
val wrapper = SentryCacheWrapper(delegate, scopes)
val valueWrapper = mock<Cache.ValueWrapper>()
whenever(delegate.get("myKey")).thenReturn(valueWrapper)
whenever(delegate.get("myKey", String::class.java)).thenReturn("value")

val result = wrapper.get("myKey", String::class.java)
Expand All @@ -97,26 +95,10 @@ class SentryCacheWrapperTest {
assertEquals(true, tx.spans.first().getData(SpanDataConvention.CACHE_HIT))
}

@Test
fun `get with type creates span with cache hit true when cached value is null`() {
val tx = createTransaction()
val wrapper = SentryCacheWrapper(delegate, scopes)
val valueWrapper = mock<Cache.ValueWrapper>()
whenever(delegate.get("myKey")).thenReturn(valueWrapper)
whenever(delegate.get("myKey", String::class.java)).thenReturn(null)

val result = wrapper.get("myKey", String::class.java)

assertNull(result)
assertEquals(1, tx.spans.size)
assertEquals(true, tx.spans.first().getData(SpanDataConvention.CACHE_HIT))
}

@Test
fun `get with type creates span with cache hit false on miss`() {
val tx = createTransaction()
val wrapper = SentryCacheWrapper(delegate, scopes)
whenever(delegate.get("myKey")).thenReturn(null)
whenever(delegate.get("myKey", String::class.java)).thenReturn(null)

val result = wrapper.get("myKey", String::class.java)
Expand All @@ -131,7 +113,6 @@ class SentryCacheWrapperTest {
val tx = createTransaction()
val wrapper = SentryCacheWrapper(delegate, scopes)
val exception = RuntimeException("cache error")
whenever(delegate.get("myKey")).thenReturn(mock<Cache.ValueWrapper>())
whenever(delegate.get("myKey", String::class.java)).thenThrow(exception)

assertFailsWith<RuntimeException> { wrapper.get("myKey", String::class.java) }
Expand Down
3 changes: 1 addition & 2 deletions sentry-spring-jakarta/src/main/java/io/sentry/spring/jakarta/cache/SentryCacheWrapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,8 @@ public SentryCacheWrapper(final @NotNull Cache delegate, final @NotNull IScopes
return delegate.get(key, type);
}
try {
final ValueWrapper wrapper = delegate.get(key);
span.setData(SpanDataConvention.CACHE_HIT, wrapper != null);
final T result = delegate.get(key, type);
span.setData(SpanDataConvention.CACHE_HIT, result != null);
span.setStatus(SpanStatus.OK);
return result;
} catch (Throwable e) {
Expand Down
19 changes: 0 additions & 19 deletions ...y-spring-jakarta/src/test/kotlin/io/sentry/spring/jakarta/cache/SentryCacheWrapperTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,6 @@ class SentryCacheWrapperTest {
fun `get with type creates span with cache hit true on hit`() {
val tx = createTransaction()
val wrapper = SentryCacheWrapper(delegate, scopes)
val valueWrapper = mock<Cache.ValueWrapper>()
whenever(delegate.get("myKey")).thenReturn(valueWrapper)
whenever(delegate.get("myKey", String::class.java)).thenReturn("value")

val result = wrapper.get("myKey", String::class.java)
Expand All @@ -97,26 +95,10 @@ class SentryCacheWrapperTest {
assertEquals(true, tx.spans.first().getData(SpanDataConvention.CACHE_HIT))
}

@Test
fun `get with type creates span with cache hit true when cached value is null`() {
val tx = createTransaction()
val wrapper = SentryCacheWrapper(delegate, scopes)
val valueWrapper = mock<Cache.ValueWrapper>()
whenever(delegate.get("myKey")).thenReturn(valueWrapper)
whenever(delegate.get("myKey", String::class.java)).thenReturn(null)

val result = wrapper.get("myKey", String::class.java)

assertNull(result)
assertEquals(1, tx.spans.size)
assertEquals(true, tx.spans.first().getData(SpanDataConvention.CACHE_HIT))
}

@Test
fun `get with type creates span with cache hit false on miss`() {
val tx = createTransaction()
val wrapper = SentryCacheWrapper(delegate, scopes)
whenever(delegate.get("myKey")).thenReturn(null)
whenever(delegate.get("myKey", String::class.java)).thenReturn(null)

val result = wrapper.get("myKey", String::class.java)
Expand All @@ -131,7 +113,6 @@ class SentryCacheWrapperTest {
val tx = createTransaction()
val wrapper = SentryCacheWrapper(delegate, scopes)
val exception = RuntimeException("cache error")
whenever(delegate.get("myKey")).thenReturn(mock<Cache.ValueWrapper>())
whenever(delegate.get("myKey", String::class.java)).thenThrow(exception)

assertFailsWith<RuntimeException> { wrapper.get("myKey", String::class.java) }
Expand Down
3 changes: 1 addition & 2 deletions sentry-spring/src/main/java/io/sentry/spring/cache/SentryCacheWrapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,8 @@ public SentryCacheWrapper(final @NotNull Cache delegate, final @NotNull IScopes
return delegate.get(key, type);
}
try {
final ValueWrapper wrapper = delegate.get(key);
span.setData(SpanDataConvention.CACHE_HIT, wrapper != null);
final T result = delegate.get(key, type);
span.setData(SpanDataConvention.CACHE_HIT, result != null);
span.setStatus(SpanStatus.OK);
return result;
} catch (Throwable e) {
Expand Down
19 changes: 0 additions & 19 deletions sentry-spring/src/test/kotlin/io/sentry/spring/cache/SentryCacheWrapperTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,6 @@ class SentryCacheWrapperTest {
fun `get with type creates span with cache hit true on hit`() {
val tx = createTransaction()
val wrapper = SentryCacheWrapper(delegate, scopes)
val valueWrapper = mock<Cache.ValueWrapper>()
whenever(delegate.get("myKey")).thenReturn(valueWrapper)
whenever(delegate.get("myKey", String::class.java)).thenReturn("value")

val result = wrapper.get("myKey", String::class.java)
Expand All @@ -95,26 +93,10 @@ class SentryCacheWrapperTest {
assertEquals(true, tx.spans.first().getData(SpanDataConvention.CACHE_HIT))
}

@Test
fun `get with type creates span with cache hit true when cached value is null`() {
val tx = createTransaction()
val wrapper = SentryCacheWrapper(delegate, scopes)
val valueWrapper = mock<Cache.ValueWrapper>()
whenever(delegate.get("myKey")).thenReturn(valueWrapper)
whenever(delegate.get("myKey", String::class.java)).thenReturn(null)

val result = wrapper.get("myKey", String::class.java)

assertNull(result)
assertEquals(1, tx.spans.size)
assertEquals(true, tx.spans.first().getData(SpanDataConvention.CACHE_HIT))
}

@Test
fun `get with type creates span with cache hit false on miss`() {
val tx = createTransaction()
val wrapper = SentryCacheWrapper(delegate, scopes)
whenever(delegate.get("myKey")).thenReturn(null)
whenever(delegate.get("myKey", String::class.java)).thenReturn(null)

val result = wrapper.get("myKey", String::class.java)
Expand All @@ -129,7 +111,6 @@ class SentryCacheWrapperTest {
val tx = createTransaction()
val wrapper = SentryCacheWrapper(delegate, scopes)
val exception = RuntimeException("cache error")
whenever(delegate.get("myKey")).thenReturn(mock<Cache.ValueWrapper>())
whenever(delegate.get("myKey", String::class.java)).thenThrow(exception)

assertFailsWith<RuntimeException> { wrapper.get("myKey", String::class.java) }
Expand Down
Loading