Merge pull request #5804 from getsentry/feat/data-collection-outgoing-request-body

feat(apollo): [Data Collection 8] Apply outgoing request body policy

Author: adinauer

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

@@ -365,16 +365,18 @@ constructor(
           request.body?.let {
             bodySize = it.contentLength
 
-            val buffer = Buffer()
-
-            try {
-              it.writeTo(buffer)
-              data = GraphqlUtils.filterRequestBody(buffer.readUtf8(), scopes.options)
-            } catch (e: Throwable) {
-              scopes.options.logger.log(SentryLevel.ERROR, "Error reading the request body.", e)
-              // continue because the response body alone can already give some insights
-            } finally {
-              buffer.close()
+            if (scopes.options.dataCollectionResolver.isOutgoingRequestBody) {
+              val buffer = Buffer()
+
+              try {
+                it.writeTo(buffer)
+                data = GraphqlUtils.filterRequestBody(buffer.readUtf8(), scopes.options)
+              } catch (e: Throwable) {
+                scopes.options.logger.log(SentryLevel.ERROR, "Error reading the request body.", e)
+                // continue because the response body alone can already give some insights
+              } finally {
+                buffer.close()
+              }
             }
           }
         }

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

@@ -5,6 +5,7 @@ import com.apollographql.apollo3.api.http.HttpRequest
 import com.apollographql.apollo3.api.http.HttpResponse
 import com.apollographql.apollo3.exception.ApolloException
 import io.sentry.Hint
+import io.sentry.HttpBodyType
 import io.sentry.IScopes
 import io.sentry.SentryIntegrationPackageStorage
 import io.sentry.SentryOptions
@@ -268,6 +269,24 @@ class SentryApollo3InterceptorClientErrors {
       )
   }
 
+  @Test
+  fun `data collection can disable outgoing request body`() {
+    val sut =
+      fixture.getSut(responseBody = fixture.responseBodyNotOk) {
+        dataCollection.httpBodies = setOf(HttpBodyType.INCOMING_RESPONSE)
+      }
+    executeQuery(sut)
+
+    verify(fixture.scopes)
+      .captureEvent(
+        check {
+          assertEquals(193L, it.request!!.bodySize)
+          assertNull(it.request!!.data)
+        },
+        any<Hint>(),
+      )
+  }
+
   @Test
   fun `data collection can disable the GraphQL document independently`() {
     val sut =

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

@@ -364,16 +364,18 @@ constructor(
           request.body?.let {
             bodySize = it.contentLength
 
-            val buffer = Buffer()
-
-            try {
-              it.writeTo(buffer)
-              data = GraphqlUtils.filterRequestBody(buffer.readUtf8(), scopes.options)
-            } catch (e: Throwable) {
-              scopes.options.logger.log(SentryLevel.ERROR, "Error reading the request body.", e)
-              // continue because the response body alone can already give some insights
-            } finally {
-              buffer.close()
+            if (scopes.options.dataCollectionResolver.isOutgoingRequestBody) {
+              val buffer = Buffer()
+
+              try {
+                it.writeTo(buffer)
+                data = GraphqlUtils.filterRequestBody(buffer.readUtf8(), scopes.options)
+              } catch (e: Throwable) {
+                scopes.options.logger.log(SentryLevel.ERROR, "Error reading the request body.", e)
+                // continue because the response body alone can already give some insights
+              } finally {
+                buffer.close()
+              }
             }
           }
         }

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

@@ -8,6 +8,7 @@ import com.apollographql.apollo.api.http.HttpRequest
 import com.apollographql.apollo.api.http.HttpResponse
 import com.apollographql.apollo.exception.ApolloException
 import io.sentry.Hint
+import io.sentry.HttpBodyType
 import io.sentry.IScopes
 import io.sentry.SentryIntegrationPackageStorage
 import io.sentry.SentryOptions
@@ -282,6 +283,24 @@ abstract class SentryApollo4BuilderExtensionsClientErrorsTest(
       )
   }
 
+  @Test
+  fun `data collection can disable outgoing request body`() {
+    val sut =
+      fixture.getSut(responseBody = fixture.responseBodyNotOk) {
+        dataCollection.httpBodies = setOf(HttpBodyType.INCOMING_RESPONSE)
+      }
+    executeQuery(sut)
+
+    verify(fixture.scopes)
+      .captureEvent(
+        check {
+          assertEquals(193L, it.request!!.bodySize)
+          assertNull(it.request!!.data)
+        },
+        any<Hint>(),
+      )
+  }
+
   @Test
   fun `data collection can disable the GraphQL document independently`() {
     val sut =