Merge pull request #2982 from DataDog/merge-from-feature-flagging-feature-branch

Flags Feature

Co-authored-by: typotter <[email protected]>
Co-authored-by: dd-mergequeue[bot] <121105855+dd-mergequeue[bot]@users.noreply.github.com>
Co-authored-by: jonathanmos <[email protected]>

Author: 3 people

ci/pipelines/default-pipeline.yml

@@ -526,6 +526,24 @@ publish:release-internal:
       - dd-sdk-android-internal/verification-metadata.xml
 
 # region Publish features/*
+
+publish:release-flags:
+  tags: [ "arch:amd64" ]
+  only:
+    - tags
+    - develop
+  image: $CI_IMAGE_DOCKER
+  stage: publish
+  timeout: 30m
+  script:
+    - !reference [.snippets, set-publishing-credentials]
+    - ./gradlew :features:dd-sdk-android-flags:publishToSonatype closeSonatypeStagingRepository --stacktrace --no-daemon
+  artifacts:
+    when: on_success
+    expire_in: 7 days
+    paths:
+      - features/dd-sdk-android-flags/verification-metadata.xml
+
 publish:release-trace-api:
   tags: [ "arch:amd64" ]
   only:
@@ -1081,6 +1099,7 @@ notify:merge-verification-metadata:
     - publish:release-okhttp
     - publish:release-okhttp-otel
     - publish:release-benchmark
+    - publish:release-flags
   script:
     - python3 ./ci/scripts/merge_verification_metadata.py
   artifacts:

dd-sdk-android-core/api/apiSurface

@@ -110,6 +110,7 @@ interface com.datadog.android.api.feature.Feature
   companion object 
     const val LOGS_FEATURE_NAME: String
     const val RUM_FEATURE_NAME: String
+    const val FLAGS_FEATURE_NAME: String
     const val TRACING_FEATURE_NAME: String
     const val SESSION_REPLAY_FEATURE_NAME: String
     const val SESSION_REPLAY_RESOURCES_FEATURE_NAME: String
@@ -140,6 +141,7 @@ interface com.datadog.android.api.feature.FeatureSdkCore : com.datadog.android.a
   fun removeContextUpdateReceiver(FeatureContextUpdateReceiver)
   fun createSingleThreadExecutorService(String): java.util.concurrent.ExecutorService
   fun createScheduledExecutorService(String): java.util.concurrent.ScheduledExecutorService
+  fun createOkHttpCallFactory(okhttp3.OkHttpClient.Builder.() -> Unit = {}): okhttp3.Call.Factory
   fun setAnonymousId(java.util.UUID?)
 interface com.datadog.android.api.feature.StorageBackedFeature : Feature
   val requestFactory: com.datadog.android.api.net.RequestFactory

dd-sdk-android-core/api/dd-sdk-android-core.api

@@ -360,6 +360,7 @@ public final class com/datadog/android/api/context/UserInfo {
 
 public abstract interface class com/datadog/android/api/feature/Feature {
 	public static final field Companion Lcom/datadog/android/api/feature/Feature$Companion;
+	public static final field FLAGS_FEATURE_NAME Ljava/lang/String;
 	public static final field LOGS_FEATURE_NAME Ljava/lang/String;
 	public static final field NDK_CRASH_REPORTS_FEATURE_NAME Ljava/lang/String;
 	public static final field RUM_FEATURE_NAME Ljava/lang/String;
@@ -372,6 +373,7 @@ public abstract interface class com/datadog/android/api/feature/Feature {
 }
 
 public final class com/datadog/android/api/feature/Feature$Companion {
+	public static final field FLAGS_FEATURE_NAME Ljava/lang/String;
 	public static final field LOGS_FEATURE_NAME Ljava/lang/String;
 	public static final field NDK_CRASH_REPORTS_FEATURE_NAME Ljava/lang/String;
 	public static final field RUM_FEATURE_NAME Ljava/lang/String;
@@ -411,6 +413,7 @@ public final class com/datadog/android/api/feature/FeatureScopeExtKt {
 }
 
 public abstract interface class com/datadog/android/api/feature/FeatureSdkCore : com/datadog/android/api/SdkCore {
+	public abstract fun createOkHttpCallFactory (Lkotlin/jvm/functions/Function1;)Lokhttp3/Call$Factory;
 	public abstract fun createScheduledExecutorService (Ljava/lang/String;)Ljava/util/concurrent/ScheduledExecutorService;
 	public abstract fun createSingleThreadExecutorService (Ljava/lang/String;)Ljava/util/concurrent/ExecutorService;
 	public abstract fun getFeature (Ljava/lang/String;)Lcom/datadog/android/api/feature/FeatureScope;
@@ -426,6 +429,7 @@ public abstract interface class com/datadog/android/api/feature/FeatureSdkCore :
 }
 
 public final class com/datadog/android/api/feature/FeatureSdkCore$DefaultImpls {
+	public static synthetic fun createOkHttpCallFactory$default (Lcom/datadog/android/api/feature/FeatureSdkCore;Lkotlin/jvm/functions/Function1;ILjava/lang/Object;)Lokhttp3/Call$Factory;
 	public static synthetic fun getFeatureContext$default (Lcom/datadog/android/api/feature/FeatureSdkCore;Ljava/lang/String;ZILjava/lang/Object;)Ljava/util/Map;
 	public static synthetic fun updateFeatureContext$default (Lcom/datadog/android/api/feature/FeatureSdkCore;Ljava/lang/String;ZLkotlin/jvm/functions/Function1;ILjava/lang/Object;)V
 }

dd-sdk-android-core/src/main/kotlin/com/datadog/android/api/feature/Feature.kt

@@ -44,6 +44,11 @@ interface Feature {
          */
         const val RUM_FEATURE_NAME: String = "rum"
 
+        /**
+         * Flags feature name.
+         */
+        const val FLAGS_FEATURE_NAME: String = "flags"
+
         /**
          * Tracing feature name.
          */

dd-sdk-android-core/src/main/kotlin/com/datadog/android/api/feature/FeatureSdkCore.kt

@@ -8,6 +8,8 @@ package com.datadog.android.api.feature
 
 import com.datadog.android.api.InternalLogger
 import com.datadog.android.api.SdkCore
+import okhttp3.Call
+import okhttp3.OkHttpClient
 import java.util.UUID
 import java.util.concurrent.ExecutorService
 import java.util.concurrent.ScheduledExecutorService
@@ -115,6 +117,28 @@ interface FeatureSdkCore : SdkCore {
      */
     fun createScheduledExecutorService(executorContext: String): ScheduledExecutorService
 
+    /**
+     * Creates an OkHttp [okhttp3.Call.Factory] with custom configuration that shares the SDK's
+     * underlying thread pool and connection pool.
+     *
+     * This method allows features to configure their HTTP client while efficiently
+     * sharing resources (dispatcher thread pool, connection pool) across the entire SDK.
+     * Using a shared base client reduces resource consumption and improves performance
+     * through better connection reuse.
+     *
+     * Example:
+     * ```
+     * val callFactory = sdkCore.createOkHttpCallFactory {
+     *     callTimeout(45, TimeUnit.SECONDS)
+     *     writeTimeout(30, TimeUnit.SECONDS)
+     * }
+     * ```
+     *
+     * @param block Configuration block to customize the [OkHttpClient.Builder]
+     * @return A [Call.Factory] instance configured with shared resources
+     */
+    fun createOkHttpCallFactory(block: OkHttpClient.Builder.() -> Unit = {}): Call.Factory
+
     /**
      * Allows the given feature to set the anonymous ID for the SDK.
      *

dd-sdk-android-core/src/main/kotlin/com/datadog/android/core/internal/CoreFeature.kt

@@ -110,6 +110,35 @@ internal class CoreFeature(
     private val scheduledExecutorServiceFactory: ScheduledExecutorServiceFactory
 ) {
 
+    /**
+     * Lazy-initialized shared OkHttpClient instance with FIPS 140-2 compliant configuration.
+     * This base client is used as the foundation for all HTTP clients in the SDK.
+     * When creating new clients via newBuilder(), the new clients will share the
+     * dispatcher (thread pool) and connection pool with this base client, reducing
+     * resource consumption across the SDK.
+     *
+     * Configuration includes:
+     * - FIPS 140-2 compliant TLS 1.2/1.3 with restricted cipher suites for GovCloud support
+     * - Network timeouts (45 seconds)
+     * - HTTP/2 and HTTP/1.1 protocol support
+     * - Rotating DNS resolver for reliability
+     */
+    @Suppress("SpreadOperator", "UnsafeThirdPartyFunctionCall")
+    private val lazySharedOkHttpClient: OkHttpClient by lazy {
+        val connectionSpec = ConnectionSpec.Builder(ConnectionSpec.RESTRICTED_TLS)
+            .tlsVersions(TlsVersion.TLS_1_2, TlsVersion.TLS_1_3)
+            .cipherSuites(*RESTRICTED_CIPHER_SUITES)
+            .build()
+
+        OkHttpClient.Builder()
+            .callTimeout(NETWORK_TIMEOUT_MS, TimeUnit.MILLISECONDS)
+            .writeTimeout(NETWORK_TIMEOUT_MS, TimeUnit.MILLISECONDS)
+            .protocols(listOf(Protocol.HTTP_2, Protocol.HTTP_1_1))
+            .connectionSpecs(listOf(connectionSpec))
+            .dns(RotatingDnsResolver()) // NPE cannot happen here
+            .build()
+    }
+
     internal class OkHttpCallFactory(factory: () -> OkHttpClient) : Call.Factory {
         val okhttpClient by lazy(factory)
 
@@ -301,6 +330,19 @@ internal class CoreFeature(
         return scheduledExecutorServiceFactory.create(internalLogger, executorContext, backpressureStrategy)
     }
 
+    fun createOkHttpCallFactory(block: OkHttpClient.Builder.() -> Unit): Call.Factory {
+        return object : Call.Factory {
+            // Create a new client that shares pools with the base client
+            private val client = lazySharedOkHttpClient.newBuilder()
+                .apply(block)
+                .build()
+
+            override fun newCall(request: Request): Call {
+                return client.newCall(request)
+            }
+        }
+    }
+
     @Throws(UnsupportedOperationException::class, InterruptedException::class)
     @Suppress("UnsafeThirdPartyFunctionCall") // Used in Nightly tests only
     fun drainAndShutdownExecutors() {
@@ -563,23 +605,18 @@ internal class CoreFeature(
         networkInfoProvider.register(appContext)
     }
 
-    @Suppress("SpreadOperator")
     private fun setupOkHttpClient(configuration: Configuration.Core) {
         callFactory = OkHttpCallFactory {
-            val connectionSpec = when {
-                configuration.needsClearTextHttp -> ConnectionSpec.CLEARTEXT
-                else -> ConnectionSpec.Builder(ConnectionSpec.RESTRICTED_TLS)
-                    .tlsVersions(TlsVersion.TLS_1_2, TlsVersion.TLS_1_3)
-                    .cipherSuites(*RESTRICTED_CIPHER_SUITES)
-                    .build()
-            }
+            // Use shared base client to inherit FIPS-compliant configuration,
+            // shared thread pool and connection pool
+            val builder = lazySharedOkHttpClient.newBuilder()
 
-            val builder = OkHttpClient.Builder()
-            builder.callTimeout(NETWORK_TIMEOUT_MS, TimeUnit.MILLISECONDS)
-                .writeTimeout(NETWORK_TIMEOUT_MS, TimeUnit.MILLISECONDS)
-                .protocols(listOf(Protocol.HTTP_2, Protocol.HTTP_1_1))
-                .connectionSpecs(listOf(connectionSpec))
+            // Override connection specs for cleartext HTTP if needed
+            if (configuration.needsClearTextHttp) {
+                builder.connectionSpecs(listOf(ConnectionSpec.CLEARTEXT))
+            }
 
+            // Add debug or production interceptors
             if (BuildConfig.DEBUG) {
                 @Suppress("UnsafeThirdPartyFunctionCall") // NPE cannot happen here
                 builder.addNetworkInterceptor(CurlInterceptor())
@@ -588,14 +625,12 @@ internal class CoreFeature(
                 builder.addInterceptor(GzipRequestInterceptor(internalLogger))
             }
 
+            // Configure proxy if provided
             if (configuration.proxy != null) {
                 builder.proxy(configuration.proxy)
                 builder.proxyAuthenticator(configuration.proxyAuth)
             }
 
-            @Suppress("UnsafeThirdPartyFunctionCall") // NPE cannot happen here
-            builder.dns(RotatingDnsResolver())
-
             builder.build()
         }
     }

dd-sdk-android-core/src/main/kotlin/com/datadog/android/core/internal/DatadogCore.kt

@@ -43,6 +43,8 @@ import com.datadog.android.error.internal.CrashReportsFeature
 import com.datadog.android.internal.telemetry.InternalTelemetryEvent
 import com.datadog.android.privacy.TrackingConsent
 import com.google.gson.JsonObject
+import okhttp3.Call
+import okhttp3.OkHttpClient
 import java.io.File
 import java.util.Collections
 import java.util.Locale
@@ -340,6 +342,11 @@ internal class DatadogCore(
         return coreFeature.createScheduledExecutorService(executorContext)
     }
 
+    /** @inheritDoc */
+    override fun createOkHttpCallFactory(block: OkHttpClient.Builder.() -> Unit): Call.Factory {
+        return coreFeature.createOkHttpCallFactory(block)
+    }
+
     override fun setAnonymousId(anonymousId: UUID?) {
         coreFeature.contextExecutorService.executeSafe("DatadogCore.setAnonymousId", internalLogger) {
             coreFeature.userInfoProvider.setAnonymousId(anonymousId?.toString())

dd-sdk-android-core/src/main/kotlin/com/datadog/android/core/internal/NoOpInternalSdkCore.kt

@@ -21,6 +21,12 @@ import com.datadog.android.core.internal.net.DefaultFirstPartyHostHeaderTypeReso
 import com.datadog.android.core.internal.net.FirstPartyHostHeaderTypeResolver
 import com.datadog.android.privacy.TrackingConsent
 import com.google.gson.JsonObject
+import okhttp3.Call
+import okhttp3.OkHttpClient
+import okhttp3.Protocol
+import okhttp3.Request
+import okhttp3.Response
+import okio.Timeout
 import java.io.File
 import java.util.UUID
 import java.util.concurrent.Callable
@@ -140,6 +146,10 @@ internal object NoOpInternalSdkCore : InternalSdkCore {
         return NoOpScheduledExecutorService()
     }
 
+    override fun createOkHttpCallFactory(block: OkHttpClient.Builder.() -> Unit): Call.Factory {
+        return NoOpCallFactory
+    }
+
     override fun setAnonymousId(anonymousId: UUID?) = Unit
 
     // endregion
@@ -291,4 +301,47 @@ internal object NoOpInternalSdkCore : InternalSdkCore {
             throw ExecutionException("Unsupported", UnsupportedOperationException())
         }
     }
+
+    object NoOpCallFactory : Call.Factory {
+        override fun newCall(request: Request): Call {
+            return NoOpCall(request)
+        }
+    }
+
+    class NoOpCall(private val originalRequest: Request) : Call {
+        override fun cancel() = Unit
+
+        override fun clone(): Call {
+            return NoOpCall(originalRequest)
+        }
+
+        override fun enqueue(responseCallback: okhttp3.Callback) = Unit
+
+        @Suppress("UnsafeThirdPartyFunctionCall") // All required fields are set, won't throw
+        override fun execute(): Response {
+            // Response.Builder.build() requires: request, protocol, code, and message
+            // to be set, otherwise it throws IllegalStateException
+            return Response.Builder()
+                .request(originalRequest)
+                .protocol(Protocol.HTTP_1_1)
+                .message("OK")
+                .build()
+        }
+
+        override fun isCanceled(): Boolean {
+            return false
+        }
+
+        override fun isExecuted(): Boolean {
+            return false
+        }
+
+        override fun request(): Request {
+            return originalRequest
+        }
+
+        override fun timeout(): Timeout {
+            return Timeout.NONE
+        }
+    }
 }

dd-sdk-android-core/src/test/kotlin/com/datadog/android/core/DatadogCoreTest.kt

@@ -1461,6 +1461,24 @@ internal class DatadogCoreTest {
         assertThat(isActive).isTrue()
     }
 
+    @Test
+    fun `M delegate to core feature W createOkHttpCallFactory() { }`(
+        @LongForgery(min = 0, max = 60) customTimeout: Long,
+        @LongForgery(min = 0, max = 60) customWriteTimeout: Long
+    ) {
+        // Given
+        testedCore.initialize(fakeConfiguration)
+
+        // When
+        val callFactory = testedCore.createOkHttpCallFactory {
+            callTimeout(customTimeout, TimeUnit.SECONDS)
+            writeTimeout(customWriteTimeout, TimeUnit.SECONDS)
+        }
+
+        // Then
+        assertThat(callFactory).isNotNull()
+    }
+
     class ErrorRecordingRunnable(
         private val collector: MutableList<Throwable>,
         private val delegate: Runnable
@@ -1477,6 +1495,7 @@ internal class DatadogCoreTest {
     companion object {
 
         val msToNs = TimeUnit.MILLISECONDS.toNanos(1)
+        val secondsToNs = TimeUnit.SECONDS.toNanos(1)
 
         val appContext = ApplicationContextTestConfiguration(Application::class.java)