[RN] Allow customer to change okHttpInstrumentationType in init call + updated docs (#239)

* Allow customer to change okHttpInstrumentationType in init call + updated docs

* Update withAndroid.ts

Author: FranAguilera

packages/react-native/README.md

@@ -166,7 +166,7 @@ Enabling this via the Objective-C API is not yet supported if initialization is
 
 #### Android
 
-To enable network integration in Android a Gradle plugin needs to be added to the project. This can be done by adding a dependency on the `io.bitdrift.capture-plugin` plugin in the `plugins` block of the apps's `build.gradle` file:
+To enable automatic OkHttp instrumentation on Android, add the `io.bitdrift.capture-plugin` plugin in the app `build.gradle` file:
 
 ```gradle
 plugins {
@@ -176,6 +176,18 @@ plugins {
 
 To find the version to use, use the same version of the Capture SDK that is being used in the React Native project. Check the `build.gradle` file in the `node_modules/@bitdrift/react-native/android` directory for the version of the Capture SDK being used.
 
+For manual Gradle setup, enable plugin instrumentation:
+
+```gradle
+bitdrift {
+    instrumentation {
+        automaticOkHttpInstrumentation = true
+        // Optional. Defaults to PROXY when omitted.
+        // okHttpInstrumentationType = OVERWRITE
+    }
+}
+```
+
 In addition to this the plugin repository needs to be added to the `pluginManagement` block in the `settings.gradle` file:
 
 ```gradle
@@ -209,3 +221,30 @@ When using Expo to generate the project, this can be achieved by setting the `ne
   }
 }
 ```
+
+When using the Expo plugin with `networkInstrumentation: true`, the Android Gradle plugin and `bitdrift { instrumentation { ... } }` block are generated automatically.
+
+The Android plugin mode can be configured with `okHttpInstrumentationType`:
+
+```json
+{
+  "expo": {
+    "plugins": [
+      [
+        "@bitdrift/react-native",
+        {
+          "networkInstrumentation": true,
+          "okHttpInstrumentationType": "OVERWRITE"
+        }
+      ]
+    ]
+  }
+}
+```
+
+`okHttpInstrumentationType` is Android-only and has no effect on iOS.
+
+- `PROXY` (default): preserves existing `EventListener.Factory` behavior in OkHttp clients.
+- `OVERWRITE`: replaces the listener factory and can avoid duplicate network spans in some app setups.
+
+If you recently upgraded and started seeing duplicate spans on Android, set `okHttpInstrumentationType` to `OVERWRITE`.

packages/react-native/src/plugin/config.ts

@@ -7,4 +7,6 @@
 
 export default interface PluginProps {
   networkInstrumentation?: boolean;
+  // Android-only. Only used when networkInstrumentation is true.
+  okHttpInstrumentationType?: 'PROXY' | 'OVERWRITE';
 }

packages/react-native/src/plugin/withAndroid.ts

@@ -10,24 +10,46 @@ import { withAppBuildGradle, withSettingsGradle } from '@expo/config-plugins';
 import type { ConfigPlugin } from '@expo/config-plugins';
 import PluginProps from './config';
 
+const CAPTURE_PLUGIN_ID = "id 'io.bitdrift.capture-plugin'";
+const BITDRIFT_MAVEN_HOST = 'dl.bitdrift.io';
+
 const withBitdriftAppBuildGradle: ConfigPlugin<PluginProps | void> = (
   config,
   props,
 ) => {
   return withAppBuildGradle(config, (config) => {
-    if (!config.modResults.contents.includes('dl.bitdrift.io')) {
-      // TODO(snowp): Eventually we'd always install the plugin and gate the okhttp instrumentation
-      // config on the networkInstrumentation prop.
-      if (props && props.networkInstrumentation) {
-        // Add the capture-plugin at the very top of the file.
-        config.modResults.contents =
-          `plugins {
+    const shouldEnableNetworkInstrumentation = props?.networkInstrumentation === true;
+    const okHttpInstrumentationType =
+      props?.okHttpInstrumentationType === 'OVERWRITE' ? 'OVERWRITE' : 'PROXY';
+
+    if (
+      shouldEnableNetworkInstrumentation &&
+      !config.modResults.contents.includes(CAPTURE_PLUGIN_ID)
+    ) {
+      config.modResults.contents =
+        `plugins {
     id 'io.bitdrift.capture-plugin' version '0.22.12'
 }
 
 ` + config.modResults.contents;
-      }
+    }
+
+    if (
+      shouldEnableNetworkInstrumentation &&
+      !config.modResults.contents.includes('automaticOkHttpInstrumentation')
+    ) {
+      config.modResults.contents += `
+
+bitdrift {
+    instrumentation {
+        automaticOkHttpInstrumentation = true
+        okHttpInstrumentationType = ${okHttpInstrumentationType}
+    }
+}
+`;
+    }
 
+    if (!config.modResults.contents.includes(BITDRIFT_MAVEN_HOST)) {
       // Define the bitdrift maven repository at the end. This is necessary to resolve the SDK dependency specified by the plugin.
       config.modResults.contents += `
 
@@ -52,7 +74,7 @@ const withBitdriftSettingsGradle: ConfigPlugin<PluginProps | void> = (
 ) => {
   // Add the bitdrift maven repository to the pluginManagement block to allow the plugin to resolve the SDK dependency. This is safe to do regardless of whether the network instrumentation is enabled or not.
   return withSettingsGradle(config, (config) => {
-    if (!config.modResults.contents.includes('dl.bitdrift.io')) {
+    if (!config.modResults.contents.includes(BITDRIFT_MAVEN_HOST)) {
       // There will be a pluginManagement block in the settings.gradle file already, so we need to insert ourselves
       // into the existing block.
       //