okhttp detection

Author: lcian

sentry-ktor-client/api/sentry-ktor-client.api

@@ -7,11 +7,13 @@ public final class io/sentry/ktorClient/SentryKtorClientPluginConfig {
 	public fun <init> ()V
 	public final fun getBeforeSpan ()Lio/sentry/ktorClient/SentryKtorClientPluginConfig$BeforeSpanCallback;
 	public final fun getCaptureFailedRequests ()Z
+	public final fun getEnabled ()Z
 	public final fun getFailedRequestStatusCodes ()Ljava/util/List;
 	public final fun getFailedRequestTargets ()Ljava/util/List;
 	public final fun getScopes ()Lio/sentry/IScopes;
 	public final fun setBeforeSpan (Lio/sentry/ktorClient/SentryKtorClientPluginConfig$BeforeSpanCallback;)V
 	public final fun setCaptureFailedRequests (Z)V
+	public final fun setEnabled (Z)V
 	public final fun setFailedRequestStatusCodes (Ljava/util/List;)V
 	public final fun setFailedRequestTargets (Ljava/util/List;)V
 	public final fun setScopes (Lio/sentry/IScopes;)V
@@ -22,7 +24,8 @@ public abstract interface class io/sentry/ktorClient/SentryKtorClientPluginConfi
 }
 
 public class io/sentry/ktorClient/SentryKtorClientPluginContextHook : io/ktor/client/plugins/api/ClientHook {
-	public fun <init> (Lio/sentry/IScopes;)V
+	public fun <init> (Lio/sentry/IScopes;Z)V
+	protected final fun getEnabled ()Z
 	protected final fun getScopes ()Lio/sentry/IScopes;
 	public synthetic fun install (Lio/ktor/client/HttpClient;Ljava/lang/Object;)V
 	public fun install (Lio/ktor/client/HttpClient;Lkotlin/jvm/functions/Function2;)V

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

@@ -1,6 +1,7 @@
 package io.sentry.ktorClient
 
 import io.ktor.client.HttpClient
+import io.ktor.client.engine.okhttp.OkHttpConfig
 import io.ktor.client.plugins.api.*
 import io.ktor.client.plugins.api.ClientPlugin
 import io.ktor.client.request.*
@@ -24,7 +25,9 @@ import io.sentry.util.Platform
 import io.sentry.util.PropagationTargetsUtils
 import io.sentry.util.SpanUtils
 import io.sentry.util.TracingUtils
+import java.lang.reflect.Field
 import kotlinx.coroutines.withContext
+import okhttp3.OkHttpClient
 
 /** Configuration for the Sentry Ktor client plugin. */
 public class SentryKtorClientPluginConfig {
@@ -62,6 +65,9 @@ public class SentryKtorClientPluginConfig {
     public fun execute(span: ISpan, request: HttpRequest): ISpan?
   }
 
+  /** Whether the plugin is enabled. If disabled, the plugin has no effect. Defaults to true. */
+  public var enabled: Boolean = true
+
   /**
    * Forcefully use the passed in scope instead of relying on the one injected by [SentryContext].
    * Used for testing.
@@ -78,6 +84,52 @@ internal const val TRACE_ORIGIN = "auto.http.ktor-client"
  */
 public val SentryKtorClientPlugin: ClientPlugin<SentryKtorClientPluginConfig> =
   createClientPlugin(SENTRY_KTOR_CLIENT_PLUGIN_KEY, ::SentryKtorClientPluginConfig) {
+    /**
+     * Disables the plugin, if necessary.
+     *
+     * Currently, the only case in which we want to disable the plugin is when we detect that the
+     * OkHttp engine is used and SentryOkHttpInterceptor is registered, as otherwise all HTTP
+     * requests would be doubly instrumented.
+     */
+    fun maybeDisable() {
+      if (client.engine.config is OkHttpConfig) {
+        val config = client.engine.config as OkHttpConfig
+
+        // Case 1: OkHttp client initialized by Ktor and configured with a `config` block.
+        //
+        // The OkHttp client is initialized only upon the first request.
+        // Attempt to initialize a client to inspect the interceptors that are registered on it.
+        try {
+          val configField: Field = OkHttpConfig::class.java.getDeclaredField("config")
+          configField.isAccessible = true
+          val configFunction = configField.get(config) as? (OkHttpClient.Builder.() -> Unit)
+
+          if (configFunction != null) {
+            val builder = okhttp3.OkHttpClient.Builder()
+            configFunction.invoke(builder)
+            val client = builder.build()
+            if (client.interceptors.any { it.javaClass.name.contains("SentryOkHttpInterceptor") }) {
+              pluginConfig.enabled = false
+            }
+          }
+        } catch (_: Throwable) {}
+
+        // Case 2: pre-configured OkHttp client passed in.
+        val client = config.preconfigured
+        if (client != null) {
+          if (client.interceptors.any { it.javaClass.name.contains("SentryOkHttpInterceptor") }) {
+            pluginConfig.enabled = false
+          }
+        }
+      }
+    }
+
+    maybeDisable()
+
+    if (!pluginConfig.enabled) {
+      return@createClientPlugin
+    }
+
     // Init
     SentryIntegrationPackageStorage.getInstance()
       .addPackage("maven:io.sentry:sentry-ktor-client", BuildConfig.VERSION_NAME)
@@ -98,6 +150,10 @@ public val SentryKtorClientPlugin: ClientPlugin<SentryKtorClientPluginConfig> =
     val requestSpanKey = AttributeKey<ISpan>("SentryRequestSpan")
 
     onRequest { request, _ ->
+      if (!this@createClientPlugin.pluginConfig.enabled) {
+        return@onRequest
+      }
+
       request.attributes.put(
         requestStartTimestampKey,
         (if (forceScopes) scopes else Sentry.getCurrentScopes()).options.dateProvider.now(),
@@ -141,6 +197,10 @@ public val SentryKtorClientPlugin: ClientPlugin<SentryKtorClientPluginConfig> =
     }
 
     client.requestPipeline.intercept(HttpRequestPipeline.Before) {
+      if (!this@createClientPlugin.pluginConfig.enabled) {
+        proceed()
+      }
+
       try {
         proceed()
       } catch (t: Throwable) {
@@ -154,6 +214,10 @@ public val SentryKtorClientPlugin: ClientPlugin<SentryKtorClientPluginConfig> =
     }
 
     onResponse { response ->
+      if (!this@createClientPlugin.pluginConfig.enabled) {
+        return@onResponse
+      }
+
       val request = response.request
       val startTimestamp = response.call.attributes.getOrNull(requestStartTimestampKey)
       val endTimestamp =
@@ -186,18 +250,24 @@ public val SentryKtorClientPlugin: ClientPlugin<SentryKtorClientPluginConfig> =
       }
     }
 
-    on(SentryKtorClientPluginContextHook(scopes)) { block -> block() }
+    on(SentryKtorClientPluginContextHook(scopes, pluginConfig.enabled)) { block -> block() }
   }
 
 /**
  * Context hook to manage scopes during request handling. Forks the current scope and uses
  * [SentryContext] to ensure that the whole pipeline runs within the correct scopes.
  */
-public open class SentryKtorClientPluginContextHook(protected val scopes: IScopes) :
-  ClientHook<suspend (suspend () -> Unit) -> Unit> {
+public open class SentryKtorClientPluginContextHook(
+  protected val scopes: IScopes,
+  protected val enabled: Boolean,
+) : ClientHook<suspend (suspend () -> Unit) -> Unit> {
   private val phase = PipelinePhase("SentryKtorClientPluginContext")
 
   override fun install(client: HttpClient, handler: suspend (suspend () -> Unit) -> Unit) {
+    if (!enabled) {
+      return
+    }
+
     client.requestPipeline.insertPhaseBefore(HttpRequestPipeline.Before, phase)
     client.requestPipeline.intercept(phase) {
       val scopes =

sentry-ktor-client/src/main/resources/META-INF.proguard/sentry-ktor-client.pro

@@ -0,0 +1,9 @@
+##---------------Begin: proguard configuration for Ktor Client  ----------
+
+-keepclassmembers class io.ktor.client.engine.okhttp.OkHttpConfig {
+    kotlin.jvm.functions.Function1 config;
+}
+
+-keepnames class io.sentry.sentry.okhttp.**
+
+##---------------End: proguard configuration for Ktor Client  ----------

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

@@ -3,6 +3,8 @@ package io.sentry.ktorClient
 import io.ktor.client.HttpClient
 import io.ktor.client.engine.HttpClientEngine
 import io.ktor.client.engine.java.Java
+import io.ktor.client.engine.okhttp.OkHttpConfig
+import io.ktor.client.engine.okhttp.OkHttpEngine
 import io.ktor.client.request.get
 import io.ktor.client.request.post
 import io.ktor.client.request.setBody
@@ -26,13 +28,16 @@ import io.sentry.SpanStatus
 import io.sentry.TransactionContext
 import io.sentry.exception.SentryHttpClientException
 import io.sentry.mockServerRequestTimeoutMillis
+import io.sentry.okhttp.SentryOkHttpInterceptor
 import java.util.concurrent.TimeUnit
+import kotlin.Unit
 import kotlin.test.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertNotNull
 import kotlin.test.assertNull
 import kotlin.test.assertTrue
 import kotlinx.coroutines.runBlocking
+import okhttp3.OkHttpClient
 import okhttp3.mockwebserver.MockResponse
 import okhttp3.mockwebserver.MockWebServer
 import okhttp3.mockwebserver.SocketPolicy
@@ -425,4 +430,27 @@ class SentryKtorClientPluginTest {
     assertTrue(baggageHeaderValues[0].contains("sentry-transaction=name"))
     assertTrue(baggageHeaderValues[0].contains("sentry-trace_id"))
   }
+
+  @Test
+  fun `is disabled when using OkHttp engine with preconfigured client using Sentry interceptor`():
+    Unit = runBlocking {
+    val okHttpClient = OkHttpClient.Builder().addInterceptor(SentryOkHttpInterceptor()).build()
+    val engine = OkHttpEngine(OkHttpConfig().apply { preconfigured = okHttpClient })
+    val sut = fixture.getSut(httpClientEngine = engine)
+
+    sut.get(fixture.server.url("/hello").toString())
+
+    assertEquals(0, fixture.sentryTracer.children.size)
+  }
+
+  @Test
+  fun `is disabled when using OkHttp engine initialized with Sentry interceptor in config block`():
+    Unit = runBlocking {
+    val engine = OkHttpEngine(OkHttpConfig().apply { addInterceptor(SentryOkHttpInterceptor()) })
+    val sut = fixture.getSut(httpClientEngine = engine)
+
+    sut.get(fixture.server.url("/hello").toString())
+
+    assertEquals(0, fixture.sentryTracer.children.size)
+  }
 }