Skip to content

Commit 6347a0b

Browse files
authored
Merge pull request #5806 from getsentry/feat/data-collection-http-request-headers
feat(http): [Data Collection 10] Apply request header policy
2 parents b86cbff + f6fa18c commit 6347a0b

26 files changed

Lines changed: 584 additions & 32 deletions

File tree

‎sentry-apollo-3/src/main/java/io/sentry/apollo3/SentryApollo3HttpInterceptor.kt‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,21 @@ constructor(
264264
private fun getHeader(key: String, headers: List<HttpHeader>): String? =
265265
headers.firstOrNull { it.name.equals(key, true) }?.value
266266

267+
private fun getRequestHeaders(headers: List<HttpHeader>): MutableMap<String, String>? {
268+
if (scopes.options.dataCollectionResolver.isDataCollectionConfigured) {
269+
val requestHeaders = mutableMapOf<String, String>()
270+
for (header in headers) {
271+
requestHeaders[header.name] = header.value
272+
}
273+
return HttpUtils.filterHeaders(
274+
requestHeaders,
275+
scopes.options.dataCollectionResolver.httpRequestHeaders,
276+
)
277+
.toMutableMap()
278+
}
279+
return getHeaders(headers)
280+
}
281+
267282
private fun getHeaders(headers: List<HttpHeader>): MutableMap<String, String>? {
268283
// Headers are only sent if isSendDefaultPii is enabled due to PII
269284
if (!scopes.options.isSendDefaultPii) {
@@ -359,7 +374,7 @@ constructor(
359374
cookies =
360375
if (scopes.options.isSendDefaultPii) getHeader("Cookie", request.headers) else null
361376
method = request.method.name
362-
headers = getHeaders(request.headers)
377+
headers = getRequestHeaders(request.headers)
363378
apiTarget = "graphql"
364379

365380
request.body?.let {

‎sentry-apollo-3/src/test/java/io/sentry/apollo3/SentryApollo3InterceptorClientErrors.kt‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import com.apollographql.apollo3.exception.ApolloException
77
import io.sentry.Hint
88
import io.sentry.HttpBodyType
99
import io.sentry.IScopes
10+
import io.sentry.KeyValueCollectionBehavior
1011
import io.sentry.SentryIntegrationPackageStorage
1112
import io.sentry.SentryOptions
1213
import io.sentry.SentryOptions.DEFAULT_PROPAGATION_TARGETS
@@ -341,6 +342,41 @@ class SentryApollo3InterceptorClientErrors {
341342
)
342343
}
343344

345+
@Test
346+
fun `data collection filters request headers`() {
347+
val sut =
348+
fixture.getSut(responseBody = fixture.responseBodyNotOk) {
349+
dataCollection.httpHeaders.request = KeyValueCollectionBehavior.denyList("operation-name")
350+
}
351+
executeQuery(sut)
352+
353+
verify(fixture.scopes)
354+
.captureEvent(
355+
check {
356+
assertEquals(
357+
"[Filtered]",
358+
it.request!!.headers?.get("X-APOLLO-OPERATION-NAME"),
359+
)
360+
},
361+
any<Hint>(),
362+
)
363+
}
364+
365+
@Test
366+
fun `data collection can disable request headers`() {
367+
val sut =
368+
fixture.getSut(responseBody = fixture.responseBodyNotOk) {
369+
dataCollection.httpHeaders.request = KeyValueCollectionBehavior.off()
370+
}
371+
executeQuery(sut)
372+
373+
verify(fixture.scopes)
374+
.captureEvent(
375+
check { assertTrue(it.request!!.headers!!.isEmpty()) },
376+
any<Hint>(),
377+
)
378+
}
379+
344380
@Test
345381
fun `capture errors with more request context if sendDefaultPii is enabled`() {
346382
val sut = fixture.getSut(responseBody = fixture.responseBodyNotOk, sendDefaultPii = true)

‎sentry-apollo-4/src/main/java/io/sentry/apollo4/SentryApollo4HttpInterceptor.kt‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,21 @@ constructor(
263263
private fun getHeader(key: String, headers: List<HttpHeader>): String? =
264264
headers.firstOrNull { it.name.equals(key, true) }?.value
265265

266+
private fun getRequestHeaders(headers: List<HttpHeader>): MutableMap<String, String>? {
267+
if (scopes.options.dataCollectionResolver.isDataCollectionConfigured) {
268+
val requestHeaders = mutableMapOf<String, String>()
269+
for (header in headers) {
270+
requestHeaders[header.name] = header.value
271+
}
272+
return HttpUtils.filterHeaders(
273+
requestHeaders,
274+
scopes.options.dataCollectionResolver.httpRequestHeaders,
275+
)
276+
.toMutableMap()
277+
}
278+
return getHeaders(headers)
279+
}
280+
266281
private fun getHeaders(headers: List<HttpHeader>): MutableMap<String, String>? {
267282
// Headers are only sent if isSendDefaultPii is enabled due to PII
268283
if (!scopes.options.isSendDefaultPii) {
@@ -358,7 +373,7 @@ constructor(
358373
cookies =
359374
if (scopes.options.isSendDefaultPii) getHeader("Cookie", request.headers) else null
360375
method = request.method.name
361-
headers = getHeaders(request.headers)
376+
headers = getRequestHeaders(request.headers)
362377
apiTarget = "graphql"
363378

364379
request.body?.let {

‎sentry-apollo-4/src/test/java/io/sentry/apollo4/SentryApollo4BuilderExtensionsClientErrorsTest.kt‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import com.apollographql.apollo.exception.ApolloException
1010
import io.sentry.Hint
1111
import io.sentry.HttpBodyType
1212
import io.sentry.IScopes
13+
import io.sentry.KeyValueCollectionBehavior
1314
import io.sentry.SentryIntegrationPackageStorage
1415
import io.sentry.SentryOptions
1516
import io.sentry.SentryOptions.DEFAULT_PROPAGATION_TARGETS
@@ -355,6 +356,38 @@ abstract class SentryApollo4BuilderExtensionsClientErrorsTest(
355356
)
356357
}
357358

359+
@Test
360+
fun `data collection filters request headers`() {
361+
val sut =
362+
fixture.getSut(responseBody = fixture.responseBodyNotOk) {
363+
dataCollection.httpHeaders.request = KeyValueCollectionBehavior.denyList("accept")
364+
}
365+
executeQuery(sut)
366+
367+
verify(fixture.scopes)
368+
.captureEvent(
369+
check {
370+
assertEquals("[Filtered]", it.request!!.headers?.get("Accept"))
371+
},
372+
any<Hint>(),
373+
)
374+
}
375+
376+
@Test
377+
fun `data collection can disable request headers`() {
378+
val sut =
379+
fixture.getSut(responseBody = fixture.responseBodyNotOk) {
380+
dataCollection.httpHeaders.request = KeyValueCollectionBehavior.off()
381+
}
382+
executeQuery(sut)
383+
384+
verify(fixture.scopes)
385+
.captureEvent(
386+
check { assertTrue(it.request!!.headers!!.isEmpty()) },
387+
any<Hint>(),
388+
)
389+
}
390+
358391
@Test
359392
fun `capture errors with more request context if sendDefaultPii is enabled`() {
360393
val sut = fixture.getSut(responseBody = fixture.responseBodyNotOk, sendDefaultPii = true)

‎sentry-ktor-client/src/main/java/io/sentry/ktorClient/SentryKtorClientUtils.kt‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ internal object SentryKtorClientUtils {
4040
urlDetails.applyToRequest(this)
4141
cookies = if (scopes.options.isSendDefaultPii) request.headers["Cookie"] else null
4242
method = request.method.value
43-
headers = getHeaders(scopes, request.headers)
43+
headers = getRequestHeaders(scopes, request.headers)
4444
bodySize = request.content.contentLength
4545
}
4646

@@ -67,6 +67,19 @@ internal object SentryKtorClientUtils {
6767
scopes.captureEvent(event, hint)
6868
}
6969

70+
private fun getRequestHeaders(scopes: IScopes, headers: Headers): MutableMap<String, String>? {
71+
if (scopes.options.dataCollectionResolver.isDataCollectionConfigured) {
72+
val requestHeaders =
73+
headers.toMap().mapValues { (_, values) -> values.joinToString(",") }.toMutableMap()
74+
return HttpUtils.filterHeaders(
75+
requestHeaders,
76+
scopes.options.dataCollectionResolver.httpRequestHeaders,
77+
)
78+
.toMutableMap()
79+
}
80+
return getHeaders(scopes, headers)
81+
}
82+
7083
private fun getHeaders(scopes: IScopes, headers: Headers): MutableMap<String, String>? {
7184
// Headers are only sent if isSendDefaultPii is enabled due to PII
7285
if (!scopes.options.isSendDefaultPii) {

‎sentry-ktor-client/src/test/java/io/sentry/ktorClient/SentryKtorClientPluginTest.kt‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ import io.sentry.Hint
1414
import io.sentry.HttpStatusCodeRange
1515
import io.sentry.IScope
1616
import io.sentry.IScopes
17+
import io.sentry.KeyValueCollectionBehavior
1718
import io.sentry.Scope
1819
import io.sentry.ScopeCallback
1920
import io.sentry.Sentry
@@ -255,6 +256,56 @@ class SentryKtorClientPluginTest {
255256
verify(fixture.scopes, never()).captureEvent(any(), any<Hint>())
256257
}
257258

259+
@Test
260+
fun `data collection filters request headers`(): Unit = runBlocking {
261+
val sut =
262+
fixture.getSut(
263+
captureFailedRequests = true,
264+
httpStatusCode = 500,
265+
optionsConfiguration =
266+
Sentry.OptionsConfiguration {
267+
it.dataCollection.httpHeaders.request = KeyValueCollectionBehavior.denyList("customer")
268+
},
269+
)
270+
271+
sut.get(fixture.server.url("/hello").toString()) {
272+
headers["content-type"] = "application/json"
273+
headers["authorization"] = "Bearer token"
274+
headers["x-customer"] = "customer value"
275+
}
276+
277+
verify(fixture.scopes)
278+
.captureEvent(
279+
check<SentryEvent> {
280+
assertEquals("application/json", it.request!!.headers!!["content-type"])
281+
assertEquals("[Filtered]", it.request!!.headers!!["authorization"])
282+
assertEquals("[Filtered]", it.request!!.headers!!["x-customer"])
283+
},
284+
any<Hint>(),
285+
)
286+
}
287+
288+
@Test
289+
fun `data collection can disable request headers`(): Unit = runBlocking {
290+
val sut =
291+
fixture.getSut(
292+
captureFailedRequests = true,
293+
httpStatusCode = 500,
294+
optionsConfiguration =
295+
Sentry.OptionsConfiguration {
296+
it.dataCollection.httpHeaders.request = KeyValueCollectionBehavior.off()
297+
},
298+
)
299+
300+
sut.get(fixture.server.url("/hello").toString()) { headers["myHeader"] = "myValue" }
301+
302+
verify(fixture.scopes)
303+
.captureEvent(
304+
check<SentryEvent> { assertTrue(it.request!!.headers!!.isEmpty()) },
305+
any<Hint>(),
306+
)
307+
}
308+
258309
@Test
259310
fun `does not capture headers when sendDefaultPii is disabled`(): Unit = runBlocking {
260311
val sut =

‎sentry-okhttp/src/main/java/io/sentry/okhttp/SentryOkHttpUtils.kt‎

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ internal object SentryOkHttpUtils {
4040
// Cookie is only sent if isSendDefaultPii is enabled
4141
cookies = if (scopes.options.isSendDefaultPii) request.headers["Cookie"] else null
4242
method = request.method
43-
headers = getHeaders(scopes, request.headers)
43+
headers = getRequestHeaders(scopes, request.headers)
4444

4545
request.body?.contentLength().ifHasValidLength { bodySize = it }
4646
}
@@ -67,6 +67,24 @@ internal object SentryOkHttpUtils {
6767
}
6868
}
6969

70+
private fun getRequestHeaders(
71+
scopes: IScopes,
72+
requestHeaders: Headers,
73+
): MutableMap<String, String>? {
74+
if (scopes.options.dataCollectionResolver.isDataCollectionConfigured) {
75+
val headers = mutableMapOf<String, String>()
76+
for (i in 0 until requestHeaders.size) {
77+
headers[requestHeaders.name(i)] = requestHeaders.value(i)
78+
}
79+
return HttpUtils.filterHeaders(
80+
headers,
81+
scopes.options.dataCollectionResolver.httpRequestHeaders,
82+
)
83+
.toMutableMap()
84+
}
85+
return getHeaders(scopes, requestHeaders)
86+
}
87+
7088
private fun getHeaders(scopes: IScopes, requestHeaders: Headers): MutableMap<String, String>? {
7189
// Headers are only sent if isSendDefaultPii is enabled due to PII
7290
if (!scopes.options.isSendDefaultPii) {

‎sentry-okhttp/src/test/java/io/sentry/okhttp/SentryOkHttpUtilsTest.kt‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ package io.sentry.okhttp
22

33
import io.sentry.Hint
44
import io.sentry.IScopes
5+
import io.sentry.KeyValueCollectionBehavior
56
import io.sentry.SentryOptions
67
import io.sentry.SentryTracer
78
import io.sentry.TransactionContext
@@ -36,12 +37,14 @@ class SentryOkHttpUtilsTest {
3637
responseBody: String = "success",
3738
socketPolicy: SocketPolicy = SocketPolicy.KEEP_OPEN,
3839
sendDefaultPii: Boolean = false,
40+
configureOptions: SentryOptions.() -> Unit = {},
3941
): OkHttpClient {
4042
val options =
4143
SentryOptions().apply {
4244
dsn = "https://key@sentry.io/proj"
4345
setTracePropagationTargets(listOf(server.hostName))
4446
isSendDefaultPii = sendDefaultPii
47+
configureOptions()
4548
}
4649
whenever(scopes.options).thenReturn(options)
4750

@@ -121,6 +124,40 @@ class SentryOkHttpUtilsTest {
121124
)
122125
}
123126

127+
@Test
128+
fun `data collection filters request headers`() {
129+
val sut = fixture.getSut {
130+
dataCollection.httpHeaders.request = KeyValueCollectionBehavior.denyList("myheader")
131+
}
132+
val request = getRequest()
133+
val response = sut.newCall(request).execute()
134+
135+
SentryOkHttpUtils.captureClientError(fixture.scopes, request, response)
136+
137+
verify(fixture.scopes)
138+
.captureEvent(
139+
check {
140+
assertEquals("[Filtered]", it.request!!.headers!!["myHeader"])
141+
assertEquals("[Filtered]", it.request!!.headers!!["Cookie"])
142+
},
143+
any<Hint>(),
144+
)
145+
}
146+
147+
@Test
148+
fun `data collection can disable request headers`() {
149+
val sut = fixture.getSut {
150+
dataCollection.httpHeaders.request = KeyValueCollectionBehavior.off()
151+
}
152+
val request = getRequest()
153+
val response = sut.newCall(request).execute()
154+
155+
SentryOkHttpUtils.captureClientError(fixture.scopes, request, response)
156+
157+
verify(fixture.scopes)
158+
.captureEvent(check { assertTrue(it.request!!.headers!!.isEmpty()) }, any<Hint>())
159+
}
160+
124161
@Test
125162
fun `captureClientError without sendDefaultPii does not send headers`() {
126163
val sut = fixture.getSut(sendDefaultPii = false)

‎sentry-servlet-jakarta/src/main/java/io/sentry/servlet/jakarta/SentryRequestHttpServletRequestProcessor.java‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
import io.sentry.EventProcessor;
44
import io.sentry.Hint;
55
import io.sentry.SentryEvent;
6+
import io.sentry.SentryOptions;
67
import io.sentry.protocol.Request;
78
import io.sentry.util.HttpUtils;
89
import io.sentry.util.Objects;
@@ -20,9 +21,12 @@
2021
final class SentryRequestHttpServletRequestProcessor implements EventProcessor {
2122

2223
private final @NotNull HttpServletRequest httpRequest;
24+
private final @NotNull SentryOptions options;
2325

24-
public SentryRequestHttpServletRequestProcessor(@NotNull HttpServletRequest httpRequest) {
26+
public SentryRequestHttpServletRequestProcessor(
27+
@NotNull HttpServletRequest httpRequest, @NotNull SentryOptions options) {
2528
this.httpRequest = Objects.requireNonNull(httpRequest, "httpRequest is required");
29+
this.options = Objects.requireNonNull(options, "options are required");
2630
}
2731

2832
// httpRequest.getRequestURL() returns StringBuffer which is considered an obsolete class.
@@ -45,11 +49,15 @@ public SentryRequestHttpServletRequestProcessor(@NotNull HttpServletRequest http
4549
final @NotNull HttpServletRequest request) {
4650
final Map<String, String> headersMap = new HashMap<>();
4751
for (String headerName : Collections.list(request.getHeaderNames())) {
48-
// do not copy personal information identifiable headers
49-
if (!HttpUtils.containsSensitiveHeader(headerName.toUpperCase(Locale.ROOT))) {
52+
if (options.getDataCollectionResolver().isDataCollectionConfigured()
53+
|| !HttpUtils.containsSensitiveHeader(headerName.toUpperCase(Locale.ROOT))) {
5054
headersMap.put(headerName, toString(request.getHeaders(headerName)));
5155
}
5256
}
57+
if (options.getDataCollectionResolver().isDataCollectionConfigured()) {
58+
return HttpUtils.filterHeaders(
59+
headersMap, options.getDataCollectionResolver().getHttpRequestHeaders());
60+
}
5361
return headersMap;
5462
}
5563

0 commit comments

Comments
 (0)