[Android] Change default okHttpInstrumentation to PROXY (instead of OVERWRITE) (#891)

Author: FranAguilera

CHANGELOG.md

@@ -26,6 +26,7 @@
 **Changed**
 
 - Bump `androidx.metrics:metrics-performance` dep to 1.0.0
+- io.bitdrift.capture-plugin: `automaticOkHttpInstrumentation` now defaults to `PROXY` mode instead of `OVERWRITE`, preserving any custom `EventListener.Factory` on the `OkHttpClient`.
 
 **Fixed**
 

platform/jvm/capture-plugin/src/main/kotlin/io/bitdrift/capture/extension/InstrumentationExtension.kt

@@ -47,7 +47,7 @@ open class InstrumentationExtension
             objects
                 .property(
                     OkHttpInstrumentationType::class.java,
-                ).convention(OkHttpInstrumentationType.OVERWRITE)
+                ).convention(OkHttpInstrumentationType.PROXY)
 
         enum class OkHttpInstrumentationType {
             PROXY,

platform/jvm/gradle-test-app/build.gradle.kts

@@ -3,6 +3,7 @@ plugins {
     alias(libs.plugins.apollo.graphql)
     alias(libs.plugins.kotlin.android)
     alias(libs.plugins.compose.compiler)
+    // TODO(Fran): BIT-7448. Update to 0.22.8 once release is completed
     id("io.bitdrift.capture-plugin") version "0.22.7"
 }
 
@@ -172,5 +173,6 @@ bitdrift {
     instrumentation {
         automaticOkHttpInstrumentation = true
         automaticWebViewInstrumentation = true
+        // Comment out to change the default type. e.g. okHttpInstrumentationType = OVERWRITE
     }
 }

platform/jvm/gradle-test-app/src/main/java/io/bitdrift/gradletestapp/data/model/Actions.kt

@@ -51,7 +51,9 @@ sealed class DiagnosticsAction : AppAction {
 }
 
 sealed class NetworkTestAction : AppAction {
-    object PerformOkHttpRequest : NetworkTestAction()
+    object PerformOkHttpRequestManual : NetworkTestAction()
+
+    object PerformOkHttpRequestAutomatic : NetworkTestAction()
 
     object PerformGraphQlRequest : NetworkTestAction()
 

platform/jvm/gradle-test-app/src/main/java/io/bitdrift/gradletestapp/data/repository/NetworkTestingRepository.kt

@@ -23,23 +23,28 @@ import kotlinx.coroutines.MainScope
 import kotlinx.coroutines.launch
 import okhttp3.Call
 import okhttp3.Callback
+import okhttp3.Connection
+import okhttp3.EventListener
 import okhttp3.HttpUrl
 import okhttp3.OkHttpClient
+import okhttp3.Protocol
 import okhttp3.Request
 import okhttp3.RequestBody.Companion.toRequestBody
 import okhttp3.Response
 import retrofit2.Retrofit
 import retrofit2.converter.gson.GsonConverterFactory
 import timber.log.Timber
 import java.io.IOException
+import java.net.InetSocketAddress
+import java.net.Proxy
 import kotlin.random.Random
 
 /**
  * Performs OkHttp/GraphQL requests
  */
 class NetworkTestingRepository {
-    // Initialize network clients
-    private val okHttpClient: OkHttpClient =
+    // Manual integration: explicit CaptureOkHttpEventListenerFactory with custom field providers
+    private val okHttpClientManual: OkHttpClient =
         OkHttpClient
             .Builder()
             .eventListenerFactory(
@@ -48,16 +53,24 @@ class NetworkTestingRepository {
                     responseFieldProvider = CustomResponseFieldProvider(),
                 ),
             ).build()
+
+    // Automatic integration: relies on Gradle plugin instrumentation (tests PROXY vs OVERWRITE)
+    private val okHttpClientAutomatic: OkHttpClient =
+        OkHttpClient
+            .Builder()
+            .eventListenerFactory { TimberOkHttpEventListener() }
+            .build()
+
     private val apolloClient: ApolloClient =
         ApolloClient
             .Builder()
             .serverUrl("https://apollo-fullstack-tutorial.herokuapp.com/graphql")
-            .okHttpClient(okHttpClient)
+            .okHttpClient(okHttpClientManual)
             .addInterceptor(CaptureApolloInterceptor())
             .build()
     private val retrofitService = Retrofit.Builder()
         .baseUrl("https://binaryjazz.us")
-        .client(okHttpClient)
+        .client(okHttpClientManual)
         .addConverterFactory(GsonConverterFactory.create())
         .build()
         .create(BinaryJazzRetrofitService::class.java)
@@ -104,8 +117,16 @@ class NetworkTestingRepository {
     }
 
     fun performOkHttpRequest() {
+        performOkHttpRequestWithClient(okHttpClientManual, "Manual")
+    }
+
+    fun performOkHttpRequestAutomatic() {
+        performOkHttpRequestWithClient(okHttpClientAutomatic, "Automatic")
+    }
+
+    private fun performOkHttpRequestWithClient(okHttpClient: OkHttpClient, label: String) {
         val requestDef = requestDefinitions.random()
-        Timber.i("Performing OkHttp Network Request: $requestDef")
+        Timber.i("Performing OkHttp Network Request ($label): $requestDef")
 
         val url =
             HttpUrl
@@ -136,14 +157,14 @@ class NetworkTestingRepository {
                         response.use {
                             it.body!!.string()
                         }
-                    Timber.v("OkHttp request completed with status code=${response.code} and body=$body")
+                    Timber.v("OkHttp request ($label) completed with status code=${response.code} and body=$body")
                 }
 
                 override fun onFailure(
                     call: Call,
                     e: IOException,
                 ) {
-                    Timber.v("OkHttp request failed with exception=$e")
+                    Timber.v("OkHttp request ($label) failed with exception=$e")
                 }
             },
         )
@@ -177,6 +198,36 @@ class NetworkTestingRepository {
         }
     }
 
+    /**
+     * Logs OkHttp events via Timber. Used with auto-instrumentation to test PROXY vs OVERWRITE.
+     */
+    private class TimberOkHttpEventListener : EventListener() {
+        override fun callStart(call: Call) {
+            Timber.d("[TimberOkHttpEventListener] callStart: ${call.request().url}")
+        }
+
+        override fun callEnd(call: Call) {
+            Timber.d("[TimberOkHttpEventListener] callEnd: ${call.request().url}")
+        }
+
+        override fun connectStart(call: Call, inetSocketAddress: InetSocketAddress, proxy: Proxy) {
+            Timber.d("[TimberOkHttpEventListener] connectStart")
+        }
+
+        override fun connectEnd(
+            call: Call,
+            inetSocketAddress: InetSocketAddress,
+            proxy: Proxy,
+            protocol: Protocol?
+        ) {
+            Timber.d("[TimberOkHttpEventListener] connectEnd")
+        }
+
+        override fun connectionAcquired(call: Call, connection: Connection) {
+            Timber.d("[TimberOkHttpEventListener] connectionAcquired")
+        }
+    }
+
     private class CustomRequestFieldProvider : OkHttpRequestFieldProvider {
         override fun provideExtraFields(request: Request): Map<String, String> =
             mapOf("additional_network_request_host_field" to request.url.host)

platform/jvm/gradle-test-app/src/main/java/io/bitdrift/gradletestapp/ui/compose/MainScreen.kt

@@ -317,7 +317,8 @@ private fun SdkApisTabContent(
         }
         item {
             NetworkTestingCard(
-                onOkHttpRequest = { onAction(NetworkTestAction.PerformOkHttpRequest) },
+                onOkHttpManualRequest = { onAction(NetworkTestAction.PerformOkHttpRequestManual) },
+                onOkHttpAutoRequest = { onAction(NetworkTestAction.PerformOkHttpRequestAutomatic) },
                 onGraphQlRequest = { onAction(NetworkTestAction.PerformGraphQlRequest) },
                 onRetrofitRequest = { onAction(NetworkTestAction.PerformRetrofitRequest) },
             )

platform/jvm/gradle-test-app/src/main/java/io/bitdrift/gradletestapp/ui/compose/components/NetworkTestingCard.kt

@@ -20,7 +20,8 @@ import io.bitdrift.gradletestapp.ui.theme.BitdriftColors
  */
 @Composable
 fun NetworkTestingCard(
-    onOkHttpRequest: () -> Unit,
+    onOkHttpManualRequest: () -> Unit,
+    onOkHttpAutoRequest: () -> Unit,
     onGraphQlRequest: () -> Unit,
     onRetrofitRequest: () -> Unit,
     modifier: Modifier = Modifier,
@@ -54,16 +55,32 @@ fun NetworkTestingCard(
                 horizontalArrangement = Arrangement.spacedBy(8.dp),
             ) {
                 OutlinedButton(
-                    onClick = onOkHttpRequest,
+                    onClick = onOkHttpManualRequest,
                     modifier = Modifier.weight(1f),
                     colors =
                         ButtonDefaults.outlinedButtonColors(
                             contentColor = BitdriftColors.TextPrimary,
                         ),
                 ) {
-                    Text("OkHttp", maxLines = 1, softWrap = false)
+                    Text("OkHttp (Manual)", maxLines = 1, softWrap = false)
                 }
 
+                OutlinedButton(
+                    onClick = onOkHttpAutoRequest,
+                    modifier = Modifier.weight(1f),
+                    colors =
+                        ButtonDefaults.outlinedButtonColors(
+                            contentColor = BitdriftColors.TextPrimary,
+                        ),
+                ) {
+                    Text("OkHttp (Auto)", maxLines = 1, softWrap = false)
+                }
+            }
+
+            Row(
+                modifier = Modifier.fillMaxWidth(),
+                horizontalArrangement = Arrangement.spacedBy(8.dp),
+            ) {
                 OutlinedButton(
                     onClick = onGraphQlRequest,
                     modifier = Modifier.weight(1f),

platform/jvm/gradle-test-app/src/main/java/io/bitdrift/gradletestapp/ui/viewmodel/MainViewModel.kt

@@ -113,9 +113,12 @@ class MainViewModel(
             is DiagnosticsAction.ForceAppExit -> forceAppExit()
             is DiagnosticsAction.UpdateAppExitReason -> updateAppExitReason(action.reason)
 
-            is NetworkTestAction.PerformOkHttpRequest -> {
+            is NetworkTestAction.PerformOkHttpRequestManual -> {
                 networkTestingRepository.performOkHttpRequest()
             }
+            is NetworkTestAction.PerformOkHttpRequestAutomatic -> {
+                networkTestingRepository.performOkHttpRequestAutomatic()
+            }
             is NetworkTestAction.PerformGraphQlRequest -> {
                 networkTestingRepository.performGraphQlRequest()
             }