Skip to content

fix(spring): Handle user provider failures #6240

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

Merged
adinauer merged 5 commits into from
Oct 9, 2026
+175 −9
Merged

fix(spring): Handle user provider failures #6240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
805d7ea
fix(spring): Handle user provider failures
adinauer Oct 9, 2026
22bc0e6
changelog
adinauer Oct 9, 2026
35555aa
Merge branch 'fix/callback-error-handling' into fix/callback-error-ha…
adinauer Oct 9, 2026
27184c6
fix(spring): Include user provider name in error log
adinauer Oct 9, 2026
5c639a8
Merge branch 'fix/callback-error-handling' into fix/callback-error-ha…
adinauer Oct 9, 2026
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

### Fixes

- Keep Spring requests running when a `SentryUserProvider` throws and discard the incomplete user identity ([#6240](https://github.com/getsentry/sentry-java/pull/6240))
- Drop Apollo 5 spans when `beforeSpan` throws without disrupting the GraphQL request ([#6238](https://github.com/getsentry/sentry-java/pull/6238))

### Features
Expand Down
22 changes: 19 additions & 3 deletions sentry-spring-7/src/main/java/io/sentry/spring7/SentryUserFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@
import io.sentry.IScope;
import io.sentry.IScopes;
import io.sentry.IpAddressUtils;
import io.sentry.SentryLevel;
import io.sentry.protocol.User;
import io.sentry.util.ExceptionUtils;
import io.sentry.util.Objects;
import jakarta.servlet.FilterChain;
import jakarta.servlet.ServletException;
Expand Down Expand Up @@ -43,16 +45,30 @@ protected void doFilterInternal(
final @NotNull FilterChain chain)
throws ServletException, IOException {
final User user = new User();
boolean providerFailed = false;
for (final SentryUserProvider provider : sentryUserProviders) {
apply(user, provider.provideUser());
try {
apply(user, provider.provideUser());
} catch (Throwable e) {
ExceptionUtils.rethrowIfFatal(e);
providerFailed = true;
scopes
.getOptions()
.getLogger()
.log(
SentryLevel.ERROR,
e,
"The SentryUserProvider callback %s threw an exception.",
provider.getClass().getName());
}
}
if (scopes.getOptions().getDataCollectionResolver().isUserInfo()) {
if (!providerFailed && scopes.getOptions().getDataCollectionResolver().isUserInfo()) {
if (IpAddressUtils.isDefault(user.getIpAddress())) {
// unset {{auto}} as it would set the server's ip address as a user ip address
user.setIpAddress(null);
}
}
scopes.setUser(user);
scopes.setUser(providerFailed ? new User() : user);

@adinauer adinauer Oct 9, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

overriding with an empty user seems safer in terms of PII leak risk compared to taking last good state or ignoring failing providers and using the others as it might be a data stripping provider that failed

chain.doFilter(request, response);
}

Expand Down
39 changes: 39 additions & 0 deletions sentry-spring-7/src/test/kotlin/io/sentry/spring7/SentryUserFilterTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,12 @@ import io.sentry.protocol.User
import jakarta.servlet.FilterChain
import kotlin.test.Test
import kotlin.test.assertEquals
import kotlin.test.assertFailsWith
import kotlin.test.assertNull
import org.assertj.core.api.Assertions.assertThat
import org.mockito.kotlin.check
import org.mockito.kotlin.mock
import org.mockito.kotlin.never
import org.mockito.kotlin.verify
import org.mockito.kotlin.whenever
import org.springframework.mock.web.MockHttpServletRequest
Expand Down Expand Up @@ -151,6 +154,42 @@ class SentryUserFilterTest {
verify(fixture.scopes).setUser(check { assertNull(it.ipAddress) })
}

@Test
fun `provider failure discards user data while later providers and request continue`() {
val failure = RuntimeException("provider failed")
val laterProvider = mock<SentryUserProvider>()
whenever(laterProvider.provideUser()).thenReturn(sampleUser)
val filter =
fixture.getSut(
userProviders =
listOf(
SentryUserProvider { sampleUser },
SentryUserProvider { throw failure },
laterProvider,
)
)

filter.doFilter(fixture.request, fixture.response, fixture.chain)

verify(fixture.scopes).setUser(check { assertEquals(User(), it) })
verify(laterProvider).provideUser()
verify(fixture.chain).doFilter(fixture.request, fixture.response)
}

@Test
fun `fatal provider failure propagates`() {
val failure = OutOfMemoryError("fatal")
val filter = fixture.getSut(userProviders = listOf(SentryUserProvider { throw failure }))

assertThat(
assertFailsWith<OutOfMemoryError> {
filter.doFilter(fixture.request, fixture.response, fixture.chain)
}
)
.isSameAs(failure)
verify(fixture.chain, never()).doFilter(fixture.request, fixture.response)
}

private fun assertEquals(user1: User, user2: User) {
assertEquals(user1.username, user2.username)
assertEquals(user1.id, user2.id)
Expand Down
22 changes: 19 additions & 3 deletions sentry-spring-jakarta/src/main/java/io/sentry/spring/jakarta/SentryUserFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@
import io.sentry.IScope;
import io.sentry.IScopes;
import io.sentry.IpAddressUtils;
import io.sentry.SentryLevel;
import io.sentry.protocol.User;
import io.sentry.util.ExceptionUtils;
import io.sentry.util.Objects;
import jakarta.servlet.FilterChain;
import jakarta.servlet.ServletException;
Expand Down Expand Up @@ -43,16 +45,30 @@ protected void doFilterInternal(
final @NotNull FilterChain chain)
throws ServletException, IOException {
final User user = new User();
boolean providerFailed = false;
for (final SentryUserProvider provider : sentryUserProviders) {
apply(user, provider.provideUser());
try {
apply(user, provider.provideUser());
} catch (Throwable e) {
ExceptionUtils.rethrowIfFatal(e);
providerFailed = true;
scopes
.getOptions()
.getLogger()
.log(
SentryLevel.ERROR,
e,
"The SentryUserProvider callback %s threw an exception.",
provider.getClass().getName());
}
}
if (scopes.getOptions().getDataCollectionResolver().isUserInfo()) {
if (!providerFailed && scopes.getOptions().getDataCollectionResolver().isUserInfo()) {
if (IpAddressUtils.isDefault(user.getIpAddress())) {
// unset {{auto}} as it would set the server's ip address as a user ip address
user.setIpAddress(null);
}
}
scopes.setUser(user);
scopes.setUser(providerFailed ? new User() : user);
chain.doFilter(request, response);
}

Expand Down
39 changes: 39 additions & 0 deletions sentry-spring-jakarta/src/test/kotlin/io/sentry/spring/jakarta/SentryUserFilterTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,12 @@ import io.sentry.protocol.User
import jakarta.servlet.FilterChain
import kotlin.test.Test
import kotlin.test.assertEquals
import kotlin.test.assertFailsWith
import kotlin.test.assertNull
import org.assertj.core.api.Assertions.assertThat
import org.mockito.kotlin.check
import org.mockito.kotlin.mock
import org.mockito.kotlin.never
import org.mockito.kotlin.verify
import org.mockito.kotlin.whenever
import org.springframework.mock.web.MockHttpServletRequest
Expand Down Expand Up @@ -151,6 +154,42 @@ class SentryUserFilterTest {
verify(fixture.scopes).setUser(check { assertNull(it.ipAddress) })
}

@Test
fun `provider failure discards user data while later providers and request continue`() {
val failure = RuntimeException("provider failed")
val laterProvider = mock<SentryUserProvider>()
whenever(laterProvider.provideUser()).thenReturn(sampleUser)
val filter =
fixture.getSut(
userProviders =
listOf(
SentryUserProvider { sampleUser },
SentryUserProvider { throw failure },
laterProvider,
)
)

filter.doFilter(fixture.request, fixture.response, fixture.chain)

verify(fixture.scopes).setUser(check { assertEquals(User(), it) })
verify(laterProvider).provideUser()
verify(fixture.chain).doFilter(fixture.request, fixture.response)
}

@Test
fun `fatal provider failure propagates`() {
val failure = OutOfMemoryError("fatal")
val filter = fixture.getSut(userProviders = listOf(SentryUserProvider { throw failure }))

assertThat(
assertFailsWith<OutOfMemoryError> {
filter.doFilter(fixture.request, fixture.response, fixture.chain)
}
)
.isSameAs(failure)
verify(fixture.chain, never()).doFilter(fixture.request, fixture.response)
}

private fun assertEquals(user1: User, user2: User) {
assertEquals(user1.username, user2.username)
assertEquals(user1.id, user2.id)
Expand Down
22 changes: 19 additions & 3 deletions sentry-spring/src/main/java/io/sentry/spring/SentryUserFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@
import io.sentry.IScope;
import io.sentry.IScopes;
import io.sentry.IpAddressUtils;
import io.sentry.SentryLevel;
import io.sentry.protocol.User;
import io.sentry.util.ExceptionUtils;
import io.sentry.util.Objects;
import java.io.IOException;
import java.util.List;
Expand Down Expand Up @@ -43,16 +45,30 @@ protected void doFilterInternal(
final @NotNull FilterChain chain)
throws ServletException, IOException {
final User user = new User();
boolean providerFailed = false;
for (final SentryUserProvider provider : sentryUserProviders) {
apply(user, provider.provideUser());
try {
apply(user, provider.provideUser());
} catch (Throwable e) {
ExceptionUtils.rethrowIfFatal(e);
providerFailed = true;
scopes
.getOptions()
.getLogger()
.log(
SentryLevel.ERROR,
e,
"The SentryUserProvider callback %s threw an exception.",
provider.getClass().getName());
}
}
if (scopes.getOptions().getDataCollectionResolver().isUserInfo()) {
if (!providerFailed && scopes.getOptions().getDataCollectionResolver().isUserInfo()) {
if (IpAddressUtils.isDefault(user.getIpAddress())) {
// unset {{auto}} as it would set the server's ip address as a user ip address
user.setIpAddress(null);
}
}
scopes.setUser(user);
scopes.setUser(providerFailed ? new User() : user);
chain.doFilter(request, response);
}

Expand Down
39 changes: 39 additions & 0 deletions sentry-spring/src/test/kotlin/io/sentry/spring/SentryUserFilterTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,12 @@ import io.sentry.protocol.User
import javax.servlet.FilterChain
import kotlin.test.Test
import kotlin.test.assertEquals
import kotlin.test.assertFailsWith
import kotlin.test.assertNull
import org.assertj.core.api.Assertions.assertThat
import org.mockito.kotlin.check
import org.mockito.kotlin.mock
import org.mockito.kotlin.never
import org.mockito.kotlin.verify
import org.mockito.kotlin.whenever
import org.springframework.mock.web.MockHttpServletRequest
Expand Down Expand Up @@ -151,6 +154,42 @@ class SentryUserFilterTest {
verify(fixture.scopes).setUser(check { assertNull(it.ipAddress) })
}

@Test
fun `provider failure discards user data while later providers and request continue`() {
val failure = RuntimeException("provider failed")
val laterProvider = mock<SentryUserProvider>()
whenever(laterProvider.provideUser()).thenReturn(sampleUser)
val filter =
fixture.getSut(
userProviders =
listOf(
SentryUserProvider { sampleUser },
SentryUserProvider { throw failure },
laterProvider,
)
)

filter.doFilter(fixture.request, fixture.response, fixture.chain)

verify(fixture.scopes).setUser(check { assertEquals(User(), it) })
verify(laterProvider).provideUser()
verify(fixture.chain).doFilter(fixture.request, fixture.response)
}

@Test
fun `fatal provider failure propagates`() {
val failure = OutOfMemoryError("fatal")
val filter = fixture.getSut(userProviders = listOf(SentryUserProvider { throw failure }))

assertThat(
assertFailsWith<OutOfMemoryError> {
filter.doFilter(fixture.request, fixture.response, fixture.chain)
}
)
.isSameAs(failure)
verify(fixture.chain, never()).doFilter(fixture.request, fixture.response)
}

private fun assertEquals(user1: User, user2: User) {
assertEquals(user1.username, user2.username)
assertEquals(user1.id, user2.id)
Expand Down
Loading