feat(apollo): Add a flag to stop attaching tracing headers in SentryApolloInterceptor (#6414)

* feat(apollo): Add a flag to stop attaching tracing headers in SentryApolloInterceptor

* changelog

* fix(apollo): Preserve interceptor constructor compatibility

Keep the existing Kotlin default-argument constructor ABI while exposing the tracing-header opt-out through a secondary constructor. This prevents runtime linkage failures for precompiled consumers upgrading the SDK.

Co-Authored-By: Claude <noreply@anthropic.com>

---------

Co-authored-by: Alexander Dinauer <adinauer@users.noreply.github.com>
Co-authored-by: Claude <noreply@anthropic.com>

Author: 3 people

CHANGELOG.md

@@ -6,6 +6,8 @@
 
 - Added `Environment` to the `Scope`, allowing you to overwrite the `Environment` set on the options ([#5772](https://github.com/getsentry/sentry-java/pull/5772))
   - The scope `Environment` is also applied to the trace envelope header (DSC), logs, metrics and profiles, so all telemetry of a trace reports the same environment
+- Add an `attachTracingHeaders` flag to `SentryApolloInterceptor` to stop attaching `sentry-trace` and `baggage` headers to Apollo v2 requests ([#6414](https://github.com/getsentry/sentry-java/pull/6414))
+  - Apollo v2 has no request URL in the interceptor, so these headers are attached without checking `tracePropagationTargets`. Pass `attachTracingHeaders = false` to opt out.
 
 ### Improvements
 

sentry-apollo/api/sentry-apollo.api

@@ -8,6 +8,8 @@ public final class io/sentry/apollo/SentryApolloInterceptor : com/apollographql/
 	public fun <init> (Lio/sentry/IScopes;)V
 	public fun <init> (Lio/sentry/IScopes;Lio/sentry/apollo/SentryApolloInterceptor$BeforeSpanCallback;)V
 	public synthetic fun <init> (Lio/sentry/IScopes;Lio/sentry/apollo/SentryApolloInterceptor$BeforeSpanCallback;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun <init> (Lio/sentry/IScopes;Lio/sentry/apollo/SentryApolloInterceptor$BeforeSpanCallback;Z)V
+	public synthetic fun <init> (Lio/sentry/IScopes;Lio/sentry/apollo/SentryApolloInterceptor$BeforeSpanCallback;ZILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public fun <init> (Lio/sentry/apollo/SentryApolloInterceptor$BeforeSpanCallback;)V
 	public fun dispose ()V
 	public fun interceptAsync (Lcom/apollographql/apollo/interceptor/ApolloInterceptor$InterceptorRequest;Lcom/apollographql/apollo/interceptor/ApolloInterceptorChain;Ljava/util/concurrent/Executor;Lcom/apollographql/apollo/interceptor/ApolloInterceptor$CallBack;)V

sentry-apollo/src/main/java/io/sentry/apollo/SentryApolloInterceptor.kt

@@ -44,8 +44,18 @@ class SentryApolloInterceptor(
     }
   }
 
+  private var attachTracingHeaders: Boolean = true
+
   constructor(scopes: IScopes) : this(scopes, null)
 
+  constructor(
+    scopes: IScopes = ScopesAdapter.getInstance(),
+    beforeSpan: BeforeSpanCallback? = null,
+    attachTracingHeaders: Boolean,
+  ) : this(scopes, beforeSpan) {
+    this.attachTracingHeaders = attachTracingHeaders
+  }
+
   constructor(beforeSpan: BeforeSpanCallback) : this(ScopesAdapter.getInstance(), beforeSpan)
 
   init {
@@ -134,7 +144,7 @@ class SentryApolloInterceptor(
   private fun addTracingHeaders(request: InterceptorRequest, span: ISpan?): RequestHeaders {
     val requestHeaderBuilder = request.requestHeaders.toBuilder()
 
-    if (scopes.options.isTraceSampling && !isIgnored()) {
+    if (attachTracingHeaders && scopes.options.isTraceSampling && !isIgnored()) {
       // we have no access to URI, no way to verify tracing origins
       TracingUtils.trace(
           scopes,

sentry-apollo/src/test/java/io/sentry/apollo/SentryApolloInterceptorTest.kt

@@ -88,6 +88,7 @@ class SentryApolloInterceptorTest {
   }
 }""",
       socketPolicy: SocketPolicy = SocketPolicy.KEEP_OPEN,
+      attachTracingHeaders: Boolean = true,
       beforeSpan: SentryApolloInterceptor.BeforeSpanCallback? = null,
     ): ApolloClient {
       server.enqueue(
@@ -97,8 +98,8 @@ class SentryApolloInterceptorTest {
           .setResponseCode(httpStatusCode)
       )
 
-      if (beforeSpan != null) {
-        interceptor = SentryApolloInterceptor(scopes, beforeSpan)
+      if (beforeSpan != null || !attachTracingHeaders) {
+        interceptor = SentryApolloInterceptor(scopes, beforeSpan, attachTracingHeaders)
       }
       return ApolloClient.builder()
         .serverUrl(server.url("/"))
@@ -206,6 +207,16 @@ class SentryApolloInterceptorTest {
     assertNull(recorderRequest.headers[BaggageHeader.BAGGAGE_HEADER])
   }
 
+  @Test
+  fun `does not add sentry-trace header when attaching tracing headers is disabled`() {
+    executeQuery(fixture.getSut(attachTracingHeaders = false))
+
+    val recorderRequest =
+      fixture.server.takeRequest(mockServerRequestTimeoutMillis, TimeUnit.MILLISECONDS)!!
+    assertNull(recorderRequest.headers[SentryTraceHeader.SENTRY_TRACE_HEADER])
+    assertNull(recorderRequest.headers[BaggageHeader.BAGGAGE_HEADER])
+  }
+
   @Test
   fun `when there is an active span, adds sentry trace headers to the request`() {
     executeQuery()