feat(core): Data Collection

sentry-apollo-3/api/sentry-apollo-3.api

@@ -35,6 +35,8 @@ public final class io/sentry/apollo3/SentryApollo3HttpInterceptor$Companion {
 
 public final class io/sentry/apollo3/SentryApollo3Interceptor : com/apollographql/apollo3/interceptor/ApolloInterceptor {
 	public fun <init> ()V
+	public fun <init> (Lio/sentry/IScopes;)V
+	public synthetic fun <init> (Lio/sentry/IScopes;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public fun intercept (Lcom/apollographql/apollo3/api/ApolloRequest;Lcom/apollographql/apollo3/interceptor/ApolloInterceptorChain;)Lkotlinx/coroutines/flow/Flow;
 }
 

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

@@ -27,6 +27,7 @@ import io.sentry.exception.ExceptionMechanismException
 import io.sentry.protocol.Mechanism
 import io.sentry.protocol.Request
 import io.sentry.protocol.Response
+import io.sentry.util.GraphqlUtils
 import io.sentry.util.HttpUtils
 import io.sentry.util.IntegrationUtils.addIntegrationToSdkVersion
 import io.sentry.util.Platform
@@ -159,7 +160,7 @@ constructor(
     operationType: String?,
     operationId: String?,
   ): ISpan {
-    val urlDetails = UrlUtils.parse(request.url)
+    val urlDetails = UrlUtils.parse(request.url, scopes.options.dataCollectionResolver)
     val method = request.method.name
 
     val operation = if (operationType != null) "http.graphql.$operationType" else "http.graphql"
@@ -174,7 +175,9 @@ constructor(
 
       operationId?.let { setData("operationId", it) }
 
-      variables?.let { setData("variables", it) }
+      if (scopes.options.dataCollectionResolver.isGraphqlVariablesWithLegacyAlways) {
+        variables?.let { setData("variables", it) }
+      }
       setData(HTTP_METHOD_KEY, method.uppercase())
     }
   }
@@ -229,7 +232,13 @@ constructor(
       span.finish()
     }
 
-    val breadcrumb = Breadcrumb.http(request.url, request.method.name, statusCode)
+    val breadcrumb =
+      Breadcrumb.http(
+        request.url,
+        request.method.name,
+        statusCode,
+        scopes.options.dataCollectionResolver,
+      )
 
     request.body?.contentLength.ifHasValidLength { contentLength ->
       breadcrumb.setData("request_body_size", contentLength)
@@ -261,6 +270,36 @@ constructor(
   private fun getHeader(key: String, headers: List<HttpHeader>): String? =
     headers.firstOrNull { it.name.equals(key, true) }?.value
 
+  private fun getRequestHeaders(headers: List<HttpHeader>): MutableMap<String, String>? {
+    if (scopes.options.dataCollectionResolver.isDataCollectionConfigured) {
+      val requestHeaders = mutableMapOf<String, String>()
+      for (header in headers) {
+        requestHeaders[header.name] = header.value
+      }
+      return HttpUtils.filterHeaders(
+          requestHeaders,
+          scopes.options.dataCollectionResolver.httpRequestHeaders,
+        )
+        .toMutableMap()
+    }
+    return getHeaders(headers)
+  }
+
+  private fun getResponseHeaders(headers: List<HttpHeader>): MutableMap<String, String>? {
+    if (scopes.options.dataCollectionResolver.isDataCollectionConfigured) {
+      val responseHeaders = mutableMapOf<String, String>()
+      for (header in headers) {
+        responseHeaders[header.name] = header.value
+      }
+      return HttpUtils.filterHeaders(
+          responseHeaders,
+          scopes.options.dataCollectionResolver.httpResponseHeaders,
+        )
+        .toMutableMap()
+    }
+    return getHeaders(headers)
+  }
+
   private fun getHeaders(headers: List<HttpHeader>): MutableMap<String, String>? {
     // Headers are only sent if isSendDefaultPii is enabled due to PII
     if (!scopes.options.isSendDefaultPii) {
@@ -318,7 +357,7 @@ constructor(
       // url will be: https://api.github.com/users/getsentry/repos/
       // ideally we'd like a parameterized url: https://api.github.com/users/{user}/repos/
       // but that's not possible
-      val urlDetails = UrlUtils.parse(request.url)
+      val urlDetails = UrlUtils.parse(request.url, scopes.options.dataCollectionResolver)
 
       // return if its not a target match
       if (!PropagationTargetsUtils.contain(failedRequestTargets, urlDetails.urlOrFallback)) {
@@ -356,22 +395,24 @@ constructor(
           cookies =
             if (scopes.options.isSendDefaultPii) getHeader("Cookie", request.headers) else null
           method = request.method.name
-          headers = getHeaders(request.headers)
+          headers = getRequestHeaders(request.headers)
           apiTarget = "graphql"
 
           request.body?.let {
             bodySize = it.contentLength
 
-            val buffer = Buffer()
-
-            try {
-              it.writeTo(buffer)
-              data = buffer.readUtf8()
-            } 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()
+              }
             }
           }
         }
@@ -385,13 +426,15 @@ constructor(
             } else {
               null
             }
-          headers = getHeaders(response.headers)
+          headers = getResponseHeaders(response.headers)
           statusCode = response.statusCode
 
           response.body?.buffer?.size?.ifHasValidLength { contentLength ->
             bodySize = contentLength
           }
-          data = body
+          if (scopes.options.dataCollectionResolver.isIncomingResponseBody) {
+            data = body
+          }
         }
 
       fingerprints.add(response.statusCode.toString())

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

@@ -10,12 +10,16 @@ import com.apollographql.apollo3.api.Subscription
 import com.apollographql.apollo3.api.variables
 import com.apollographql.apollo3.interceptor.ApolloInterceptor
 import com.apollographql.apollo3.interceptor.ApolloInterceptorChain
+import io.sentry.IScopes
+import io.sentry.ScopesAdapter
 import io.sentry.apollo3.SentryApollo3HttpInterceptor.Companion.SENTRY_APOLLO_3_OPERATION_TYPE
 import io.sentry.apollo3.SentryApollo3HttpInterceptor.Companion.SENTRY_APOLLO_3_VARIABLES
 import io.sentry.vendor.Base64
 import kotlinx.coroutines.flow.Flow
 
-class SentryApollo3Interceptor : ApolloInterceptor {
+class SentryApollo3Interceptor
+@JvmOverloads
+constructor(private val scopes: IScopes = ScopesAdapter.getInstance()) : ApolloInterceptor {
   override fun <D : Operation.Data> intercept(
     request: ApolloRequest<D>,
     chain: ApolloInterceptorChain,
@@ -28,14 +32,16 @@ class SentryApollo3Interceptor : ApolloInterceptor {
           Base64.encodeToString(operationType(request).toByteArray(), Base64.NO_WRAP),
         )
 
-    request.scalarAdapters?.let {
-      builder.addHttpHeader(
-        SENTRY_APOLLO_3_VARIABLES,
-        Base64.encodeToString(
-          request.operation.variables(it).valueMap.toString().toByteArray(),
-          Base64.NO_WRAP,
-        ),
-      )
+    if (scopes.options.dataCollectionResolver.isGraphqlVariablesWithLegacyAlways) {
+      request.scalarAdapters?.let {
+        builder.addHttpHeader(
+          SENTRY_APOLLO_3_VARIABLES,
+          Base64.encodeToString(
+            request.operation.variables(it).valueMap.toString().toByteArray(),
+            Base64.NO_WRAP,
+          ),
+        )
+      }
     }
     return chain.proceed(builder.build())
   }

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

@@ -13,7 +13,7 @@ fun ApolloClient.Builder.sentryTracing(
   failedRequestTargets: List<String> = listOf(DEFAULT_PROPAGATION_TARGETS),
   beforeSpan: SentryApollo3HttpInterceptor.BeforeSpanCallback? = null,
 ): ApolloClient.Builder {
-  addInterceptor(SentryApollo3Interceptor())
+  addInterceptor(SentryApollo3Interceptor(scopes))
   addHttpInterceptor(
     SentryApollo3HttpInterceptor(
       scopes = scopes,