Merge pull request #2904 from DataDog/tvaleev/feature/RUM-11854-rum-context-fix

[RUM-11854]: Proper support propagation of RUM context for automatic http tracing via baggage header

Author: satween

dd-sdk-android-core/api/apiSurface

@@ -127,6 +127,7 @@ interface com.datadog.android.api.feature.FeatureScope
   fun <T: Feature> unwrap(): T
 typealias EventWriteScope = ((com.datadog.android.api.storage.EventBatchWriter) -> Unit) -> Unit
 fun <R: Any?> com.datadog.android.api.InternalLogger.measureMethodCallPerf(Class<*>, String, Float = 100f, () -> R): R
+fun FeatureScope.getContextFuture(Set<String> = emptySet()): java.util.concurrent.Future<com.datadog.android.api.context.DatadogContext?>?
 interface com.datadog.android.api.feature.FeatureSdkCore : com.datadog.android.api.SdkCore
   val internalLogger: com.datadog.android.api.InternalLogger
   fun registerFeature(Feature)
@@ -344,6 +345,10 @@ open class com.datadog.android.core.sampling.DeterministicSampler<T: Any> : Samp
   constructor((T) -> ULong, Double)
   override fun sample(T): Boolean
   override fun getSampleRate(): Float
+  companion object 
+    const val SAMPLE_ALL_RATE: Float
+    const val SAMPLER_HASHER: ULong
+    const val MAX_ID: ULong
 open class com.datadog.android.core.sampling.RateBasedSampler<T: Any> : Sampler<T>
   constructor(() -> Float)
   constructor(Float)

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

@@ -404,6 +404,8 @@ public final class com/datadog/android/api/feature/FeatureScope$DefaultImpls {
 }
 
 public final class com/datadog/android/api/feature/FeatureScopeExtKt {
+	public static final fun getContextFuture (Lcom/datadog/android/api/feature/FeatureScope;Ljava/util/Set;)Ljava/util/concurrent/Future;
+	public static synthetic fun getContextFuture$default (Lcom/datadog/android/api/feature/FeatureScope;Ljava/util/Set;ILjava/lang/Object;)Ljava/util/concurrent/Future;
 	public static final fun measureMethodCallPerf (Lcom/datadog/android/api/InternalLogger;Ljava/lang/Class;Ljava/lang/String;FLkotlin/jvm/functions/Function0;)Ljava/lang/Object;
 	public static synthetic fun measureMethodCallPerf$default (Lcom/datadog/android/api/InternalLogger;Ljava/lang/Class;Ljava/lang/String;FLkotlin/jvm/functions/Function0;ILjava/lang/Object;)Ljava/lang/Object;
 }
@@ -913,6 +915,9 @@ public final class com/datadog/android/core/persistence/datastore/DataStoreConte
 }
 
 public class com/datadog/android/core/sampling/DeterministicSampler : com/datadog/android/core/sampling/Sampler {
+	public static final field Companion Lcom/datadog/android/core/sampling/DeterministicSampler$Companion;
+	public static final field MAX_ID J
+	public static final field SAMPLER_HASHER J
 	public static final field SAMPLE_ALL_RATE F
 	public fun <init> (Lkotlin/jvm/functions/Function1;D)V
 	public fun <init> (Lkotlin/jvm/functions/Function1;F)V
@@ -921,6 +926,9 @@ public class com/datadog/android/core/sampling/DeterministicSampler : com/datado
 	public fun sample (Ljava/lang/Object;)Z
 }
 
+public final class com/datadog/android/core/sampling/DeterministicSampler$Companion {
+}
+
 public class com/datadog/android/core/sampling/RateBasedSampler : com/datadog/android/core/sampling/Sampler {
 	public static final field SAMPLE_ALL_RATE F
 	public fun <init> (D)V

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

@@ -6,9 +6,13 @@
 
 package com.datadog.android.api.feature
 
+import androidx.annotation.AnyThread
 import com.datadog.android.api.InternalLogger
+import com.datadog.android.api.context.DatadogContext
+import com.datadog.android.core.internal.SdkFeature
 import com.datadog.android.core.metrics.TelemetryMetricType
 import com.datadog.android.lint.InternalApi
+import java.util.concurrent.Future
 
 /**
  * Measures the execution time for the given block and report it as a MethodCall telemetry metric.
@@ -39,3 +43,22 @@ fun <R : Any?> InternalLogger.measureMethodCallPerf(
 
     return result
 }
+
+/**
+ * Utility to read current [DatadogContext], asynchronously.
+ * @param withFeatureContexts Feature contexts ([DatadogContext.featuresContext] property) to include
+ * in the [DatadogContext] provided. The value should be the feature names as declared by [Feature.name].
+ * Default is empty, meaning that no feature contexts will be included.
+ *
+ * Returns future that will contain [DatadogContext] in the state that it has at the moment of call.
+ */
+@AnyThread
+@InternalApi
+fun FeatureScope.getContextFuture(
+    withFeatureContexts: Set<String> = emptySet()
+): Future<DatadogContext?>? {
+    return when (this) {
+        is SdkFeature -> getContextFuture(withFeatureContexts)
+        else -> null
+    }
+}

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

@@ -61,6 +61,7 @@ import com.datadog.android.privacy.TrackingConsentProviderCallback
 import com.datadog.android.security.Encryption
 import java.util.Locale
 import java.util.concurrent.Callable
+import java.util.concurrent.Future
 import java.util.concurrent.atomic.AtomicBoolean
 import java.util.concurrent.atomic.AtomicReference
 import java.util.concurrent.locks.ReadWriteLock
@@ -196,6 +197,20 @@ internal class SdkFeature(
             }
     }
 
+    internal fun getContextFuture(withFeatureContexts: Set<String>): Future<DatadogContext?>? {
+        return coreFeature.contextExecutorService.submitSafe(
+            "getContextFuture-${wrappedFeature.name}",
+            internalLogger,
+            Callable {
+                if (coreFeature.initialized.get()) {
+                    contextProvider.getContext(withFeatureContexts)
+                } else {
+                    null
+                }
+            }
+        )
+    }
+
     override fun getWriteContextSync(
         withFeatureContexts: Set<String>
     ): Pair<DatadogContext, EventWriteScope>? {

dd-sdk-android-core/src/main/kotlin/com/datadog/android/core/sampling/DeterministicSampler.kt

@@ -82,12 +82,22 @@ open class DeterministicSampler<T : Any>(
         }
     }
 
-    private companion object {
-        const val SAMPLE_ALL_RATE = 100f
+    companion object {
+        /**
+         * Represents the maximum allowable sample rate in the sampling process.
+         */
+        const val SAMPLE_ALL_RATE: Float = 100f
 
-        // Good number for Knuth hashing (large, prime, fit in 64 bit long)
-        private const val SAMPLER_HASHER: ULong = 1111111111111111111u
+        /**
+         * A constant value used as a multiplier for generating deterministic hash values
+         * within the [DeterministicSampler] implementation. This value is a good number for
+         * Knuth hashing (large, prime, fit in 64 bit long).
+         */
+        const val SAMPLER_HASHER: ULong = 1111111111111111111u
 
-        private const val MAX_ID: ULong = 0xFFFFFFFFFFFFFFFFUL
+        /**
+         * The maximum value used as an upper limit for computing hash-based sampling thresholds.
+         */
+        const val MAX_ID: ULong = 0xFFFFFFFFFFFFFFFFUL
     }
 }

dd-sdk-android-core/src/testFixtures/kotlin/com/datadog/android/api/feature/SdkFeatureMock.kt

@@ -0,0 +1,23 @@
+/*
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2016-Present Datadog, Inc.
+ */
+
+package com.datadog.android.api.feature
+
+import com.datadog.android.api.context.DatadogContext
+import com.datadog.android.core.internal.SdkFeature
+import org.mockito.kotlin.any
+import org.mockito.kotlin.doReturn
+import org.mockito.kotlin.mock
+import java.util.concurrent.Future
+
+object SdkFeatureMock {
+    /**
+     * This method is a trick that allows to mock FeatureScope.getContextFuture extension method.
+     */
+    fun create(future: Future<DatadogContext?>? = null): FeatureScope = mock<SdkFeature> {
+        on { getContextFuture(any()) } doReturn future
+    }
+}

dd-sdk-android-internal/api/apiSurface

@@ -22,10 +22,6 @@ class com.datadog.android.internal.collections.EvictingQueue<T> : java.util.Queu
   override fun add(T): Boolean
   override fun offer(T): Boolean
   override fun addAll(Collection<T>): Boolean
-class com.datadog.android.internal.concurrent.CompletableFuture<T: Any>
-  var value: T
-  fun isComplete(): Boolean
-  fun complete(T)
 enum com.datadog.android.internal.network.GraphQLHeaders
   constructor(String)
   - DD_GRAPHQL_NAME_HEADER

dd-sdk-android-internal/api/dd-sdk-android-internal.api

@@ -54,13 +54,6 @@ public final class com/datadog/android/internal/collections/EvictingQueue : java
 	public fun toArray ([Ljava/lang/Object;)[Ljava/lang/Object;
 }
 
-public final class com/datadog/android/internal/concurrent/CompletableFuture {
-	public fun <init> ()V
-	public final fun complete (Ljava/lang/Object;)V
-	public final fun getValue ()Ljava/lang/Object;
-	public final fun isComplete ()Z
-}
-
 public final class com/datadog/android/internal/network/GraphQLHeaders : java/lang/Enum {
 	public static final field DD_GRAPHQL_NAME_HEADER Lcom/datadog/android/internal/network/GraphQLHeaders;
 	public static final field DD_GRAPHQL_PAYLOAD_HEADER Lcom/datadog/android/internal/network/GraphQLHeaders;