forward early cancel events and skip re-wrapping Sentry OkHttp listeners

Author: lbloder

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 ### Features
 
-- Add OkHttp autoconfiguration for Spring Boot 4 ([#5797](https://github.com/getsentry/sentry-java/pull/5797))
+- Add OkHttp autoconfiguration for Spring Boot ([#5797](https://github.com/getsentry/sentry-java/pull/5797))
 - Add `LocalSentrySpan` to `sentry-compose` so apps can provide a parent `ISpan` to a composable subtree and have nested `SentryTraced` spans attach to it ([#6112]https://github.com/getsentry/sentry-java/pull/6112)
 - Add `dataCollection`, a fine-grained replacement for `sendDefaultPii`, for controlling data collected automatically by SDK integrations ([#5759](https://github.com/getsentry/sentry-java/pull/5759))
   - `sendDefaultPii` remains supported for backwards compatibility. When `dataCollection` is not configured, the SDK preserves the existing `sendDefaultPii` behavior.

sentry-spring-boot-4/src/main/java/io/sentry/spring/boot4/SentryOkHttpClientBeanPostProcessor.java

@@ -78,7 +78,11 @@ private SentryEventListenerFactory(final @NotNull EventListener.Factory delegate
 
     @Override
     public @NotNull EventListener create(final @NotNull Call call) {
-      return new SentryOkHttpEventListener(ScopesAdapter.getInstance(), delegate);
+      final @NotNull EventListener original = delegate.create(call);
+      if (original instanceof SentryOkHttpEventListener) {
+        return original;
+      }
+      return new SentryOkHttpEventListener(ScopesAdapter.getInstance(), original);
     }
   }
 }

sentry-spring-boot-4/src/test/kotlin/io/sentry/spring/boot4/SentryOkHttpAutoConfigurationTest.kt

@@ -118,6 +118,39 @@ class SentryOkHttpAutoConfigurationTest {
       }
   }
 
+  @Test
+  fun `forwards canceled before callStart to the original event listener`() {
+    noOtelContextRunner
+      .withPropertyValues("sentry.dsn=http://key@localhost/proj")
+      .withUserConfiguration(OkHttpClientConfiguration::class.java)
+      .run { context ->
+        val client = context.getBean(OkHttpClient::class.java)
+
+        // OkHttp creates the listener in the Call constructor and reports canceled() even if
+        // the call is never executed, i.e. before callStart() ever happens
+        client.newCall(Request.Builder().url("https://example.com").build()).cancel()
+
+        assertThat(context.getBean(RecordingEventListener::class.java).callCanceled.get()).isTrue()
+      }
+  }
+
+  @Test
+  fun `does not wrap a Sentry listener created by the original factory`() {
+    val sentryListener = SentryOkHttpEventListener()
+    val client = OkHttpClient.Builder().eventListenerFactory { sentryListener }.build()
+
+    noOtelContextRunner
+      .withPropertyValues("sentry.dsn=http://key@localhost/proj")
+      .withBean("okHttpClient", OkHttpClient::class.java, { client })
+      .run { context ->
+        val instrumented = context.getBean(OkHttpClient::class.java)
+
+        assertThat(instrumented.eventListenerFactory.create(mock()))
+          .isSameInstanceAs(sentryListener)
+        assertThat(instrumented.interceptors.filterIsInstance<SentryOkHttpInterceptor>()).hasSize(1)
+      }
+  }
+
   @Test
   fun `does not duplicate an existing Sentry interceptor`() {
     noOtelContextRunner
@@ -285,9 +318,14 @@ class SentryOkHttpAutoConfigurationTest {
 
   class RecordingEventListener : EventListener() {
     val callStarted = AtomicBoolean(false)
+    val callCanceled = AtomicBoolean(false)
 
     override fun callStart(call: Call) {
       callStarted.set(true)
     }
+
+    override fun canceled(call: Call) {
+      callCanceled.set(true)
+    }
   }
 }