Skip to content

feat(spring): [Data Collection 6] Apply incoming request body policy #5802

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 2 commits into
base: feat/data-collection-database-query-data
Choose a base branch
from
Draft

feat(spring): [Data Collection 6] Apply incoming request body policy #5802

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d17418d
feat(spring): Apply incoming request body policy
adinauer Jul 17, 2026
2ce1e51
merge: Update Data Collection stack
adinauer Jul 21, 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
4 changes: 2 additions & 2 deletions sentry-spring-7/src/main/java/io/sentry/spring7/SentrySpringFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ private void configureScope(

private @NotNull HttpServletRequest resolveHttpServletRequest(
final @NotNull IScopes scopes, final @NotNull HttpServletRequest request) {
if (scopes.getOptions().isSendDefaultPii()
if (scopes.getOptions().getDataCollectionResolver().isIncomingRequestBody()
&& qualifiesForCaching(request, scopes.getOptions().getMaxRequestBodySize())) {
return new ContentCachingRequestWrapper(request, 0);
}
Expand Down Expand Up @@ -155,7 +155,7 @@ public RequestBodyExtractingEventProcessor(
@Override
public @NotNull SentryEvent process(@NotNull SentryEvent event, @NotNull Hint hint) {
if (event.getRequest() != null
&& options.isSendDefaultPii()
&& options.getDataCollectionResolver().isIncomingRequestBody()
&& qualifiesForCaching(request, options.getMaxRequestBodySize())) {
event.getRequest().setData(requestPayloadExtractor.extract(request, options));
}
Expand Down
47 changes: 47 additions & 0 deletions sentry-spring-7/src/test/kotlin/io/sentry/spring7/SentrySpringFilterTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package io.sentry.spring7

import io.sentry.Breadcrumb
import io.sentry.HttpBodyType
import io.sentry.IScope
import io.sentry.IScopes
import io.sentry.ISentryLifecycleToken
Expand Down Expand Up @@ -318,6 +319,52 @@ class SentrySpringFilterTest {
}
}

@Test
fun `data collection can enable request body when sendDefaultPii is false`() {
val options =
SentryOptions().apply {
isSendDefaultPii = false
maxRequestBodySize = SMALL
dataCollection.httpBodies = setOf(HttpBodyType.INCOMING_REQUEST)
}
val listener =
fixture.getSut(
request =
MockMvcRequestBuilders.post(URI.create("http://example.com"))
.content("xxx")
.contentType("application/json")
.buildRequest(MockServletContext()),
options = options,
)

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

verify(fixture.chain).doFilter(check { assertTrue(it is ContentCachingRequestWrapper) }, any())
}

@Test
fun `data collection can disable request body when sendDefaultPii is true`() {
val options =
SentryOptions().apply {
isSendDefaultPii = true
maxRequestBodySize = SMALL
dataCollection.httpBodies = emptySet()
}
val listener =
fixture.getSut(
request =
MockMvcRequestBuilders.post(URI.create("http://example.com"))
.content("xxx")
.contentType("application/json")
.buildRequest(MockServletContext()),
options = options,
)

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

verify(fixture.chain).doFilter(check { assertFalse(it is ContentCachingRequestWrapper) }, any())
}

private fun servletContextWithCustomCookieName(name: String): ServletContext =
MockServletContext().also { it.sessionCookieConfig.name = name }
}
4 changes: 2 additions & 2 deletions sentry-spring-jakarta/src/main/java/io/sentry/spring/jakarta/SentrySpringFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ private void configureScope(

private @NotNull HttpServletRequest resolveHttpServletRequest(
final @NotNull IScopes scopes, final @NotNull HttpServletRequest request) {
if (scopes.getOptions().isSendDefaultPii()
if (scopes.getOptions().getDataCollectionResolver().isIncomingRequestBody()
&& qualifiesForCaching(request, scopes.getOptions().getMaxRequestBodySize())) {
return new ContentCachingRequestWrapper(request);
}
Expand Down Expand Up @@ -155,7 +155,7 @@ public RequestBodyExtractingEventProcessor(
@Override
public @NotNull SentryEvent process(@NotNull SentryEvent event, @NotNull Hint hint) {
if (event.getRequest() != null
&& options.isSendDefaultPii()
&& options.getDataCollectionResolver().isIncomingRequestBody()
&& qualifiesForCaching(request, options.getMaxRequestBodySize())) {
event.getRequest().setData(requestPayloadExtractor.extract(request, options));
}
Expand Down
47 changes: 47 additions & 0 deletions sentry-spring-jakarta/src/test/kotlin/io/sentry/spring/jakarta/SentrySpringFilterTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package io.sentry.spring.jakarta

import io.sentry.Breadcrumb
import io.sentry.HttpBodyType
import io.sentry.IScope
import io.sentry.IScopes
import io.sentry.ISentryLifecycleToken
Expand Down Expand Up @@ -318,6 +319,52 @@ class SentrySpringFilterTest {
}
}

@Test
fun `data collection can enable request body when sendDefaultPii is false`() {
val options =
SentryOptions().apply {
isSendDefaultPii = false
maxRequestBodySize = SMALL
dataCollection.httpBodies = setOf(HttpBodyType.INCOMING_REQUEST)
}
val listener =
fixture.getSut(
request =
MockMvcRequestBuilders.post(URI.create("http://example.com"))
.content("xxx")
.contentType("application/json")
.buildRequest(MockServletContext()),
options = options,
)

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

verify(fixture.chain).doFilter(check { assertTrue(it is ContentCachingRequestWrapper) }, any())
}

@Test
fun `data collection can disable request body when sendDefaultPii is true`() {
val options =
SentryOptions().apply {
isSendDefaultPii = true
maxRequestBodySize = SMALL
dataCollection.httpBodies = emptySet()
}
val listener =
fixture.getSut(
request =
MockMvcRequestBuilders.post(URI.create("http://example.com"))
.content("xxx")
.contentType("application/json")
.buildRequest(MockServletContext()),
options = options,
)

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

verify(fixture.chain).doFilter(check { assertFalse(it is ContentCachingRequestWrapper) }, any())
}

private fun servletContextWithCustomCookieName(name: String): ServletContext =
MockServletContext().also { it.sessionCookieConfig.name = name }
}
4 changes: 2 additions & 2 deletions sentry-spring/src/main/java/io/sentry/spring/SentrySpringFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ private void configureScope(

private @NotNull HttpServletRequest resolveHttpServletRequest(
final @NotNull IScopes scopes, final @NotNull HttpServletRequest request) {
if (scopes.getOptions().isSendDefaultPii()
if (scopes.getOptions().getDataCollectionResolver().isIncomingRequestBody()
&& qualifiesForCaching(request, scopes.getOptions().getMaxRequestBodySize())) {
return new ContentCachingRequestWrapper(request);
}
Expand Down Expand Up @@ -155,7 +155,7 @@ public RequestBodyExtractingEventProcessor(
@Override
public @NotNull SentryEvent process(@NotNull SentryEvent event, @NotNull Hint hint) {
if (event.getRequest() != null
&& options.isSendDefaultPii()
&& options.getDataCollectionResolver().isIncomingRequestBody()
&& qualifiesForCaching(request, options.getMaxRequestBodySize())) {
event.getRequest().setData(requestPayloadExtractor.extract(request, options));
}
Expand Down
47 changes: 47 additions & 0 deletions sentry-spring/src/test/kotlin/io/sentry/spring/SentrySpringFilterTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package io.sentry.spring

import io.sentry.Breadcrumb
import io.sentry.HttpBodyType
import io.sentry.IScope
import io.sentry.IScopes
import io.sentry.ISentryLifecycleToken
Expand Down Expand Up @@ -318,6 +319,52 @@ class SentrySpringFilterTest {
}
}

@Test
fun `data collection can enable request body when sendDefaultPii is false`() {
val options =
SentryOptions().apply {
isSendDefaultPii = false
maxRequestBodySize = SMALL
dataCollection.httpBodies = setOf(HttpBodyType.INCOMING_REQUEST)
}
val listener =
fixture.getSut(
request =
MockMvcRequestBuilders.post(URI.create("http://example.com"))
.content("xxx")
.contentType("application/json")
.buildRequest(MockServletContext()),
options = options,
)

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

verify(fixture.chain).doFilter(check { assertTrue(it is ContentCachingRequestWrapper) }, any())
}

@Test
fun `data collection can disable request body when sendDefaultPii is true`() {
val options =
SentryOptions().apply {
isSendDefaultPii = true
maxRequestBodySize = SMALL
dataCollection.httpBodies = emptySet()
}
val listener =
fixture.getSut(
request =
MockMvcRequestBuilders.post(URI.create("http://example.com"))
.content("xxx")
.contentType("application/json")
.buildRequest(MockServletContext()),
options = options,
)

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

verify(fixture.chain).doFilter(check { assertFalse(it is ContentCachingRequestWrapper) }, any())
}

private fun servletContextWithCustomCookieName(name: String): ServletContext =
MockServletContext().also { it.sessionCookieConfig.name = name }
}
Loading