Skip to content

Commit 1ad9a19

Browse files
adinauerclaude
andcommitted
feat(core): Add Data Collection resolver
Add a resolver owned by SentryOptions that applies namespace-wide Data Collection defaults and legacy sendDefaultPii fallbacks. Expose boolean, key-value, and directional HTTP body policies without changing production collection paths. Refs #5666 Co-Authored-By: Claude <noreply@anthropic.com>
1 parent a337d9e commit 1ad9a19

4 files changed

Lines changed: 362 additions & 0 deletions

File tree

‎sentry/api/sentry.api‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -417,6 +417,22 @@ public final class io/sentry/DataCollection$HttpHeaders {
417417
public fun setResponse (Lio/sentry/KeyValueCollectionBehavior;)V
418418
}
419419

420+
public final class io/sentry/DataCollectionResolver {
421+
public fun getCookies ()Lio/sentry/KeyValueCollectionBehavior;
422+
public fun getHttpRequestHeaders ()Lio/sentry/KeyValueCollectionBehavior;
423+
public fun getHttpResponseHeaders ()Lio/sentry/KeyValueCollectionBehavior;
424+
public fun getQueryParams ()Lio/sentry/KeyValueCollectionBehavior;
425+
public fun isDataCollectionConfigured ()Z
426+
public fun isDatabaseQueryData ()Z
427+
public fun isGraphqlDocument ()Z
428+
public fun isGraphqlVariables ()Z
429+
public fun isIncomingRequestBody ()Z
430+
public fun isIncomingResponseBody ()Z
431+
public fun isOutgoingRequestBody ()Z
432+
public fun isOutgoingResponseBody ()Z
433+
public fun isUserInfo ()Z
434+
}
435+
420436
public final class io/sentry/DateUtils {
421437
public static fun dateToSeconds (Ljava/util/Date;)D
422438
public static fun doubleToBigDecimal (D)Ljava/math/BigDecimal;
@@ -3698,6 +3714,7 @@ public class io/sentry/SentryOptions {
36983714
public fun getContinuousProfiler ()Lio/sentry/IContinuousProfiler;
36993715
public fun getCron ()Lio/sentry/SentryOptions$Cron;
37003716
public fun getDataCollection ()Lio/sentry/DataCollection;
3717+
public fun getDataCollectionResolver ()Lio/sentry/DataCollectionResolver;
37013718
public fun getDateProvider ()Lio/sentry/SentryDateProvider;
37023719
public fun getDeadlineTimeout ()J
37033720
public fun getDebugMetaLoader ()Lio/sentry/internal/debugmeta/IDebugMetaLoader;
Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
package io.sentry;
2+
3+
import java.util.Set;
4+
import org.jetbrains.annotations.ApiStatus;
5+
import org.jetbrains.annotations.NotNull;
6+
import org.jetbrains.annotations.Nullable;
7+
8+
/** Resolves effective Data Collection policies for SDK integrations. */
9+
@ApiStatus.Internal
10+
public final class DataCollectionResolver {
11+
12+
private static final @NotNull KeyValueCollectionBehavior OFF = KeyValueCollectionBehavior.off();
13+
private static final @NotNull KeyValueCollectionBehavior EMPTY_DENY_LIST =
14+
KeyValueCollectionBehavior.denyList();
15+
16+
private final @NotNull SentryOptions options;
17+
18+
DataCollectionResolver(final @NotNull SentryOptions options) {
19+
this.options = options;
20+
}
21+
22+
public boolean isDataCollectionConfigured() {
23+
return options.getDataCollection().isExplicitlyConfigured();
24+
}
25+
26+
public boolean isUserInfo() {
27+
return explicitOrSendDefaultPii(options.getDataCollection().getUserInfo(), true);
28+
}
29+
30+
public boolean isDatabaseQueryData() {
31+
return explicitOrSendDefaultPii(options.getDataCollection().getDatabaseQueryData(), true);
32+
}
33+
34+
public boolean isGraphqlDocument() {
35+
return explicitOrSendDefaultPii(options.getDataCollection().getGraphql().getDocument(), true);
36+
}
37+
38+
public boolean isGraphqlVariables() {
39+
return explicitOrSendDefaultPii(options.getDataCollection().getGraphql().getVariables(), true);
40+
}
41+
42+
public @NotNull KeyValueCollectionBehavior getCookies() {
43+
final @NotNull DataCollection dataCollection = options.getDataCollection();
44+
final @Nullable KeyValueCollectionBehavior cookies = dataCollection.getCookies();
45+
46+
if (cookies != null) {
47+
return cookies;
48+
}
49+
if (isDataCollectionConfigured()) {
50+
return EMPTY_DENY_LIST;
51+
}
52+
return options.isSendDefaultPii() ? EMPTY_DENY_LIST : OFF;
53+
}
54+
55+
public @NotNull KeyValueCollectionBehavior getQueryParams() {
56+
return explicitOrEmptyDenyList(options.getDataCollection().getQueryParams());
57+
}
58+
59+
public @NotNull KeyValueCollectionBehavior getHttpRequestHeaders() {
60+
return explicitOrEmptyDenyList(options.getDataCollection().getHttpHeaders().getRequest());
61+
}
62+
63+
public @NotNull KeyValueCollectionBehavior getHttpResponseHeaders() {
64+
return explicitOrEmptyDenyList(options.getDataCollection().getHttpHeaders().getResponse());
65+
}
66+
67+
public boolean isIncomingRequestBody() {
68+
return isHttpBodyEnabled(HttpBodyType.INCOMING_REQUEST, options.isSendDefaultPii());
69+
}
70+
71+
public boolean isOutgoingRequestBody() {
72+
return isHttpBodyEnabled(HttpBodyType.OUTGOING_REQUEST, true);
73+
}
74+
75+
public boolean isIncomingResponseBody() {
76+
return isHttpBodyEnabled(HttpBodyType.INCOMING_RESPONSE, true);
77+
}
78+
79+
public boolean isOutgoingResponseBody() {
80+
return isHttpBodyEnabled(HttpBodyType.OUTGOING_RESPONSE, options.isSendDefaultPii());
81+
}
82+
83+
private boolean explicitOrSendDefaultPii(
84+
final @Nullable Boolean explicit, final boolean defaultValue) {
85+
if (explicit != null) {
86+
return explicit;
87+
}
88+
return isDataCollectionConfigured() ? defaultValue : options.isSendDefaultPii();
89+
}
90+
91+
private @NotNull KeyValueCollectionBehavior explicitOrEmptyDenyList(
92+
final @Nullable KeyValueCollectionBehavior explicit) {
93+
return explicit != null ? explicit : EMPTY_DENY_LIST;
94+
}
95+
96+
private boolean isHttpBodyEnabled(
97+
final @NotNull HttpBodyType bodyType, final boolean legacyFallback) {
98+
final @NotNull DataCollection dataCollection = options.getDataCollection();
99+
final @Nullable Set<HttpBodyType> httpBodies = dataCollection.getHttpBodies();
100+
if (httpBodies != null) {
101+
return httpBodies.contains(bodyType);
102+
}
103+
return isDataCollectionConfigured() || legacyFallback;
104+
}
105+
}

‎sentry/src/main/java/io/sentry/SentryOptions.java‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -340,6 +340,9 @@ public class SentryOptions {
340340

341341
private @NotNull DataCollection dataCollection = new DataCollection(false);
342342

343+
private final @NotNull DataCollectionResolver dataCollectionResolver =
344+
new DataCollectionResolver(this);
345+
343346
/** SSLSocketFactory for self-signed certificate trust * */
344347
private @Nullable SSLSocketFactory sslSocketFactory;
345348

@@ -1718,6 +1721,12 @@ public void setDataCollection(final @NotNull DataCollection dataCollection) {
17181721
this.dataCollection = dataCollection;
17191722
}
17201723

1724+
/** Returns the Data Collection policy resolver used by SDK integrations. */
1725+
@ApiStatus.Internal
1726+
public @NotNull DataCollectionResolver getDataCollectionResolver() {
1727+
return dataCollectionResolver;
1728+
}
1729+
17211730
/**
17221731
* Adds a Scope observer
17231732
*
Lines changed: 231 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,231 @@
1+
package io.sentry
2+
3+
import com.google.common.truth.Truth.assertThat
4+
import kotlin.test.Test
5+
6+
class DataCollectionResolverTest {
7+
@Test
8+
fun `one resolver is reused per options instance`() {
9+
val options = SentryOptions()
10+
11+
assertThat(options.dataCollectionResolver).isSameInstanceAs(options.dataCollectionResolver)
12+
}
13+
14+
@Test
15+
fun `each options instance owns its resolver`() {
16+
val first = SentryOptions()
17+
val second = SentryOptions()
18+
19+
assertThat(first.dataCollectionResolver).isNotSameInstanceAs(second.dataCollectionResolver)
20+
}
21+
22+
@Test
23+
fun `data collection configured reflects namespace explicitness`() {
24+
val options = SentryOptions()
25+
26+
assertThat(options.dataCollectionResolver.isDataCollectionConfigured).isFalse()
27+
28+
options.dataCollection.queryParams = KeyValueCollectionBehavior.denyList()
29+
30+
assertThat(options.dataCollectionResolver.isDataCollectionConfigured).isTrue()
31+
}
32+
33+
@Test
34+
fun `user info falls back to sendDefaultPii when unset`() {
35+
val options = SentryOptions()
36+
37+
assertThat(options.dataCollectionResolver.isUserInfo).isFalse()
38+
39+
options.isSendDefaultPii = true
40+
41+
assertThat(options.dataCollectionResolver.isUserInfo).isTrue()
42+
}
43+
44+
@Test
45+
fun `user info override takes precedence over sendDefaultPii`() {
46+
val options = SentryOptions().apply { isSendDefaultPii = true }
47+
48+
options.dataCollection.setUserInfo(false)
49+
50+
assertThat(options.dataCollectionResolver.isUserInfo).isFalse()
51+
52+
options.isSendDefaultPii = false
53+
options.dataCollection.setUserInfo(true)
54+
55+
assertThat(options.dataCollectionResolver.isUserInfo).isTrue()
56+
}
57+
58+
@Test
59+
fun `omitted booleans use data collection defaults once namespace is explicit`() {
60+
val options = SentryOptions().apply { isSendDefaultPii = false }
61+
62+
options.dataCollection.cookies = KeyValueCollectionBehavior.off()
63+
64+
assertThat(options.dataCollectionResolver.isUserInfo).isTrue()
65+
assertThat(options.dataCollectionResolver.isDatabaseQueryData).isTrue()
66+
assertThat(options.dataCollectionResolver.isGraphqlDocument).isTrue()
67+
assertThat(options.dataCollectionResolver.isGraphqlVariables).isTrue()
68+
}
69+
70+
@Test
71+
fun `database query data falls back to sendDefaultPii and override takes precedence`() {
72+
val options = SentryOptions().apply { isSendDefaultPii = true }
73+
74+
assertThat(options.dataCollectionResolver.isDatabaseQueryData).isTrue()
75+
76+
options.dataCollection.setDatabaseQueryData(false)
77+
78+
assertThat(options.dataCollectionResolver.isDatabaseQueryData).isFalse()
79+
}
80+
81+
@Test
82+
fun `GraphQL document falls back to sendDefaultPii and override takes precedence`() {
83+
val options = SentryOptions().apply { isSendDefaultPii = true }
84+
85+
assertThat(options.dataCollectionResolver.isGraphqlDocument).isTrue()
86+
87+
options.dataCollection.graphql.setDocument(false)
88+
89+
assertThat(options.dataCollectionResolver.isGraphqlDocument).isFalse()
90+
}
91+
92+
@Test
93+
fun `cookies are off when unset and sendDefaultPii is false`() {
94+
val options = SentryOptions()
95+
96+
assertThat(options.dataCollectionResolver.cookies).isEqualTo(KeyValueCollectionBehavior.off())
97+
}
98+
99+
@Test
100+
fun `cookies use default deny list when unset and sendDefaultPii is true`() {
101+
val options = SentryOptions().apply { isSendDefaultPii = true }
102+
103+
assertThat(options.dataCollectionResolver.cookies)
104+
.isEqualTo(KeyValueCollectionBehavior.denyList())
105+
}
106+
107+
@Test
108+
fun `cookies use default deny list when namespace is explicit`() {
109+
val options = SentryOptions().apply { isSendDefaultPii = false }
110+
111+
options.dataCollection.setUserInfo(false)
112+
113+
assertThat(options.dataCollectionResolver.cookies)
114+
.isEqualTo(KeyValueCollectionBehavior.denyList())
115+
}
116+
117+
@Test
118+
fun `cookies override takes precedence over sendDefaultPii`() {
119+
val options = SentryOptions().apply { isSendDefaultPii = false }
120+
val behavior = KeyValueCollectionBehavior.allowList("language", "theme")
121+
122+
options.dataCollection.cookies = behavior
123+
124+
assertThat(options.dataCollectionResolver.cookies).isEqualTo(behavior)
125+
}
126+
127+
@Test
128+
fun `query params use default deny list when unset`() {
129+
val options = SentryOptions()
130+
131+
assertThat(options.dataCollectionResolver.queryParams)
132+
.isEqualTo(KeyValueCollectionBehavior.denyList())
133+
}
134+
135+
@Test
136+
fun `query params override takes precedence`() {
137+
val options = SentryOptions()
138+
val behavior = KeyValueCollectionBehavior.allowList("language", "theme")
139+
140+
options.dataCollection.queryParams = behavior
141+
142+
assertThat(options.dataCollectionResolver.queryParams).isEqualTo(behavior)
143+
}
144+
145+
@Test
146+
fun `HTTP request headers use default deny list when unset`() {
147+
val options = SentryOptions()
148+
149+
assertThat(options.dataCollectionResolver.httpRequestHeaders)
150+
.isEqualTo(KeyValueCollectionBehavior.denyList())
151+
}
152+
153+
@Test
154+
fun `HTTP request headers override takes precedence`() {
155+
val options = SentryOptions()
156+
val behavior = KeyValueCollectionBehavior.allowList("content-type")
157+
158+
options.dataCollection.httpHeaders.request = behavior
159+
160+
assertThat(options.dataCollectionResolver.httpRequestHeaders).isEqualTo(behavior)
161+
}
162+
163+
@Test
164+
fun `HTTP response headers use default deny list when unset`() {
165+
val options = SentryOptions()
166+
167+
assertThat(options.dataCollectionResolver.httpResponseHeaders)
168+
.isEqualTo(KeyValueCollectionBehavior.denyList())
169+
}
170+
171+
@Test
172+
fun `HTTP response headers override takes precedence`() {
173+
val options = SentryOptions()
174+
val behavior = KeyValueCollectionBehavior.off()
175+
176+
options.dataCollection.httpHeaders.response = behavior
177+
178+
assertThat(options.dataCollectionResolver.httpResponseHeaders).isEqualTo(behavior)
179+
}
180+
181+
@Test
182+
fun `HTTP bodies preserve direction-specific legacy fallbacks when data collection is absent`() {
183+
val options = SentryOptions()
184+
185+
assertThat(options.dataCollectionResolver.isIncomingRequestBody).isFalse()
186+
assertThat(options.dataCollectionResolver.isOutgoingRequestBody).isTrue()
187+
assertThat(options.dataCollectionResolver.isIncomingResponseBody).isTrue()
188+
assertThat(options.dataCollectionResolver.isOutgoingResponseBody).isFalse()
189+
190+
options.isSendDefaultPii = true
191+
192+
assertThat(options.dataCollectionResolver.isIncomingRequestBody).isTrue()
193+
assertThat(options.dataCollectionResolver.isOutgoingRequestBody).isTrue()
194+
assertThat(options.dataCollectionResolver.isIncomingResponseBody).isTrue()
195+
assertThat(options.dataCollectionResolver.isOutgoingResponseBody).isTrue()
196+
}
197+
198+
@Test
199+
fun `explicit empty data collection enables every HTTP body direction`() {
200+
val options = SentryOptions().apply { dataCollection = DataCollection() }
201+
202+
assertThat(options.dataCollectionResolver.isIncomingRequestBody).isTrue()
203+
assertThat(options.dataCollectionResolver.isOutgoingRequestBody).isTrue()
204+
assertThat(options.dataCollectionResolver.isIncomingResponseBody).isTrue()
205+
assertThat(options.dataCollectionResolver.isOutgoingResponseBody).isTrue()
206+
}
207+
208+
@Test
209+
fun `explicit HTTP body set controls every direction`() {
210+
val options = SentryOptions().apply { isSendDefaultPii = true }
211+
212+
options.dataCollection.httpBodies =
213+
setOf(HttpBodyType.INCOMING_REQUEST, HttpBodyType.OUTGOING_RESPONSE)
214+
215+
assertThat(options.dataCollectionResolver.isIncomingRequestBody).isTrue()
216+
assertThat(options.dataCollectionResolver.isOutgoingRequestBody).isFalse()
217+
assertThat(options.dataCollectionResolver.isIncomingResponseBody).isFalse()
218+
assertThat(options.dataCollectionResolver.isOutgoingResponseBody).isTrue()
219+
}
220+
221+
@Test
222+
fun `GraphQL variables fall back to sendDefaultPii and override takes precedence`() {
223+
val options = SentryOptions().apply { isSendDefaultPii = true }
224+
225+
assertThat(options.dataCollectionResolver.isGraphqlVariables).isTrue()
226+
227+
options.dataCollection.graphql.setVariables(false)
228+
229+
assertThat(options.dataCollectionResolver.isGraphqlVariables).isFalse()
230+
}
231+
}

0 commit comments

Comments
 (0)