improve

Author: lcian

gradle/libs.versions.toml

@@ -98,6 +98,7 @@ kotlinx-coroutines = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core",
 kotlinx-coroutines-android = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-android", version.ref = "coroutines" }
 ktor-client-core = { module = "io.ktor:ktor-client-core", version.ref = "ktorClient" }
 ktor-client-java = { module = "io.ktor:ktor-client-java", version.ref = "ktorClient" }
+ktor-client-okhttp = { module = "io.ktor:ktor-client-okhttp", version.ref = "ktorClient" }
 log4j-api = { module = "org.apache.logging.log4j:log4j-api", version.ref = "log4j2" }
 log4j-core = { module = "org.apache.logging.log4j:log4j-core", version.ref = "log4j2" }
 leakcanary = { module = "com.squareup.leakcanary:leakcanary-android", version = "2.14" }

sentry-ktor-client/build.gradle.kts

@@ -27,6 +27,7 @@ dependencies {
   compileOnly(libs.jetbrains.annotations)
   compileOnly(libs.nopen.annotations)
   compileOnly(libs.ktor.client.core)
+  compileOnly(libs.ktor.client.okhttp)
   errorprone(libs.errorprone.core)
   errorprone(libs.nopen.checker)
   errorprone(libs.nullaway)
@@ -37,6 +38,8 @@ dependencies {
   testImplementation(libs.mockito.inline)
   testImplementation(libs.ktor.client.core)
   testImplementation(libs.ktor.client.java)
+  testImplementation(libs.ktor.client.okhttp)
+  testImplementation(projects.sentryOkhttp)
   testImplementation(libs.okhttp.mockwebserver)
 }
 

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.*
@@ -78,6 +79,17 @@ internal const val TRACE_ORIGIN = "auto.http.ktor-client"
  */
 public val SentryKtorClientPlugin: ClientPlugin<SentryKtorClientPluginConfig> =
   createClientPlugin(SENTRY_KTOR_CLIENT_PLUGIN_KEY, ::SentryKtorClientPluginConfig) {
+    // If the engine is OkHttp and the OkHttp client is configured to use the SentryOkHttpInterceptor, any functionality of this plugin is disabled
+    // Without this check, all HTTP requests would be doubly instrumented
+    if (client.engine.config is OkHttpConfig) {
+      val config = client.engine.config as OkHttpConfig
+      var interceptors = config.preconfigured?.interceptors ?: emptyList()
+      config.config { interceptors += this@config.interceptors() }
+      if (interceptors.any { it.toString().contains("SentryOkHttpInterceptor") }) {
+        return@createClientPlugin
+      }
+    }
+
     // Init
     SentryIntegrationPackageStorage.getInstance()
       .addPackage("maven:io.sentry:sentry-ktor-client", BuildConfig.VERSION_NAME)

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

@@ -1,6 +1,13 @@
 package io.sentry.ktorClient
 
 import io.ktor.client.HttpClient
+import io.ktor.client.HttpClientConfig
+import io.ktor.client.engine.HttpClientEngine
+import io.ktor.client.engine.java.Java
+import io.ktor.client.engine.okhttp.OkHttp
+import io.ktor.client.engine.okhttp.OkHttpConfig
+import io.ktor.client.engine.okhttp.OkHttpEngine
+import io.ktor.client.plugins.plugin
 import io.ktor.client.request.get
 import io.ktor.client.request.post
 import io.ktor.client.request.setBody
@@ -24,8 +31,10 @@ 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.test.Test
+import okhttp3.OkHttpClient
 import kotlin.test.assertEquals
 import kotlin.test.assertNotNull
 import kotlin.test.assertNull
@@ -68,6 +77,7 @@ class SentryKtorClientPluginTest {
         ),
       sendDefaultPii: Boolean = false,
       optionsConfiguration: Sentry.OptionsConfiguration<SentryOptions>? = null,
+      httpClientEngine: HttpClientEngine = Java.create(),
     ): HttpClient {
       options =
         SentryOptions().also {
@@ -102,7 +112,7 @@ class SentryKtorClientPluginTest {
           .setResponseCode(httpStatusCode)
       )
 
-      return HttpClient {
+      return HttpClient(httpClientEngine) {
         install(SentryKtorClientPlugin) {
           this.scopes = this@Fixture.scopes
           this.captureFailedRequests = captureFailedRequests
@@ -364,9 +374,12 @@ class SentryKtorClientPluginTest {
   @Test
   fun `does not add sentry-trace header when span origin is ignored`(): Unit = runBlocking {
     val sut =
-      fixture.getSut(isSpanActive = false) { options ->
-        options.setIgnoredSpanOrigins(listOf("auto.http.ktor-client"))
-      }
+      fixture.getSut(
+        isSpanActive = false,
+        optionsConfiguration = { options ->
+          options.setIgnoredSpanOrigins(listOf("auto.http.ktor-client"))
+        }
+      )
     sut.get(fixture.server.url("/hello").toString())
 
     val recordedRequest =
@@ -419,4 +432,23 @@ class SentryKtorClientPluginTest {
     assertTrue(baggageHeaderValues[0].contains("sentry-transaction=name"))
     assertTrue(baggageHeaderValues[0].contains("sentry-trace_id"))
   }
+
+  @Test
+  fun `is disabled when using OkHttp client with Sentry interceptor added to builder`() {
+    val okHttpClient = OkHttpClient.Builder()
+      .addInterceptor(SentryOkHttpInterceptor())
+      .build()
+    val engine = OkHttpEngine(OkHttpConfig().apply { 
+      preconfigured = okHttpClient
+    })
+    
+    val client = fixture.getSut(httpClientEngine = engine)
+    val plugin = client.plugin(SentryKtorClientPlugin)
+  }
+
+  @Test
+  fun `is disabled when using preconfigured OkHttp client with Sentry interceptor`() {
+    val engine = OkHttpEngine(OkHttpConfig())
+    val client = fixture.getSut(httpClientEngine = engine)
+  }
 }