Merge remote-tracking branch 'origin/feature/v3' into feature/v3

Author: satween

dd-sdk-android-core/api/apiSurface

@@ -116,20 +116,23 @@ interface com.datadog.android.api.feature.FeatureEventReceiver
   fun onReceive(Any)
 interface com.datadog.android.api.feature.FeatureScope
   val dataStore: com.datadog.android.api.storage.datastore.DataStoreHandler
-  fun withWriteContext(Boolean = false, (com.datadog.android.api.context.DatadogContext, com.datadog.android.api.storage.EventBatchWriter) -> Unit)
+  fun withWriteContext(Set<String> = emptySet(), (com.datadog.android.api.context.DatadogContext) -> Unit)
+  fun withContext(Set<String> = emptySet(), (com.datadog.android.api.context.DatadogContext) -> Unit)
+  fun getWriteContextSync(Set<String> = emptySet()): Pair<com.datadog.android.api.context.DatadogContext, EventWriteScope>?
   fun sendEvent(Any)
   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
 interface com.datadog.android.api.feature.FeatureSdkCore : com.datadog.android.api.SdkCore
   val internalLogger: com.datadog.android.api.InternalLogger
   fun registerFeature(Feature)
   fun getFeature(String): FeatureScope?
-  fun updateFeatureContext(String, (MutableMap<String, Any?>) -> Unit)
-  fun getFeatureContext(String): Map<String, Any?>
+  fun updateFeatureContext(String, Boolean = true, (MutableMap<String, Any?>) -> Unit)
+  fun getFeatureContext(String, Boolean = true): Map<String, Any?>
   fun setEventReceiver(String, FeatureEventReceiver)
-  fun setContextUpdateReceiver(String, FeatureContextUpdateReceiver)
-  fun removeContextUpdateReceiver(String, FeatureContextUpdateReceiver)
   fun removeEventReceiver(String)
+  fun setContextUpdateReceiver(FeatureContextUpdateReceiver)
+  fun removeContextUpdateReceiver(FeatureContextUpdateReceiver)
   fun createSingleThreadExecutorService(String): java.util.concurrent.ExecutorService
   fun createScheduledExecutorService(String): java.util.concurrent.ScheduledExecutorService
   fun setAnonymousId(java.util.UUID?)
@@ -196,7 +199,7 @@ interface com.datadog.android.core.InternalSdkCore : com.datadog.android.api.fea
   fun writeLastFatalAnrSent(Long)
   fun getPersistenceExecutorService(): java.util.concurrent.ExecutorService
   fun getAllFeatures(): List<com.datadog.android.api.feature.FeatureScope>
-  fun getDatadogContext(): com.datadog.android.api.context.DatadogContext?
+  fun getDatadogContext(Set<String> = emptySet()): com.datadog.android.api.context.DatadogContext?
 class com.datadog.android.core.SdkReference
   constructor(String? = null, (com.datadog.android.api.SdkCore) -> Unit = {})
   fun get(): com.datadog.android.api.SdkCore?
@@ -294,6 +297,8 @@ fun Collection<ByteArray>.join(ByteArray, ByteArray = ByteArray(0), ByteArray =
 fun java.util.concurrent.Executor.executeSafe(String, com.datadog.android.api.InternalLogger, Runnable)
 fun java.util.concurrent.ScheduledExecutorService.scheduleSafe(String, Long, java.util.concurrent.TimeUnit, com.datadog.android.api.InternalLogger, Runnable): java.util.concurrent.ScheduledFuture<*>?
 fun java.util.concurrent.ExecutorService.submitSafe(String, com.datadog.android.api.InternalLogger, Runnable): java.util.concurrent.Future<*>?
+fun <T> java.util.concurrent.ExecutorService.submitSafe(String, com.datadog.android.api.InternalLogger, java.util.concurrent.Callable<T>): java.util.concurrent.Future<T>?
+fun <T> java.util.concurrent.Future<T>?.getSafe(String, com.datadog.android.api.InternalLogger): T?
 object com.datadog.android.core.internal.utils.JsonSerializer
   fun toJsonElement(Any?): com.google.gson.JsonElement
   fun Map<String, Any?>.safeMapValuesToJson(com.datadog.android.api.InternalLogger): Map<String, com.google.gson.JsonElement>

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

@@ -371,13 +371,17 @@ public abstract interface class com/datadog/android/api/feature/FeatureEventRece
 
 public abstract interface class com/datadog/android/api/feature/FeatureScope {
 	public abstract fun getDataStore ()Lcom/datadog/android/api/storage/datastore/DataStoreHandler;
+	public abstract fun getWriteContextSync (Ljava/util/Set;)Lkotlin/Pair;
 	public abstract fun sendEvent (Ljava/lang/Object;)V
 	public abstract fun unwrap ()Lcom/datadog/android/api/feature/Feature;
-	public abstract fun withWriteContext (ZLkotlin/jvm/functions/Function2;)V
+	public abstract fun withContext (Ljava/util/Set;Lkotlin/jvm/functions/Function1;)V
+	public abstract fun withWriteContext (Ljava/util/Set;Lkotlin/jvm/functions/Function2;)V
 }
 
 public final class com/datadog/android/api/feature/FeatureScope$DefaultImpls {
-	public static synthetic fun withWriteContext$default (Lcom/datadog/android/api/feature/FeatureScope;ZLkotlin/jvm/functions/Function2;ILjava/lang/Object;)V
+	public static synthetic fun getWriteContextSync$default (Lcom/datadog/android/api/feature/FeatureScope;Ljava/util/Set;ILjava/lang/Object;)Lkotlin/Pair;
+	public static synthetic fun withContext$default (Lcom/datadog/android/api/feature/FeatureScope;Ljava/util/Set;Lkotlin/jvm/functions/Function1;ILjava/lang/Object;)V
+	public static synthetic fun withWriteContext$default (Lcom/datadog/android/api/feature/FeatureScope;Ljava/util/Set;Lkotlin/jvm/functions/Function2;ILjava/lang/Object;)V
 }
 
 public final class com/datadog/android/api/feature/FeatureScopeExtKt {
@@ -389,15 +393,20 @@ public abstract interface class com/datadog/android/api/feature/FeatureSdkCore :
 	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;
-	public abstract fun getFeatureContext (Ljava/lang/String;)Ljava/util/Map;
+	public abstract fun getFeatureContext (Ljava/lang/String;Z)Ljava/util/Map;
 	public abstract fun getInternalLogger ()Lcom/datadog/android/api/InternalLogger;
 	public abstract fun registerFeature (Lcom/datadog/android/api/feature/Feature;)V
-	public abstract fun removeContextUpdateReceiver (Ljava/lang/String;Lcom/datadog/android/api/feature/FeatureContextUpdateReceiver;)V
+	public abstract fun removeContextUpdateReceiver (Lcom/datadog/android/api/feature/FeatureContextUpdateReceiver;)V
 	public abstract fun removeEventReceiver (Ljava/lang/String;)V
 	public abstract fun setAnonymousId (Ljava/util/UUID;)V
-	public abstract fun setContextUpdateReceiver (Ljava/lang/String;Lcom/datadog/android/api/feature/FeatureContextUpdateReceiver;)V
+	public abstract fun setContextUpdateReceiver (Lcom/datadog/android/api/feature/FeatureContextUpdateReceiver;)V
 	public abstract fun setEventReceiver (Ljava/lang/String;Lcom/datadog/android/api/feature/FeatureEventReceiver;)V
-	public abstract fun updateFeatureContext (Ljava/lang/String;Lkotlin/jvm/functions/Function1;)V
+	public abstract fun updateFeatureContext (Ljava/lang/String;ZLkotlin/jvm/functions/Function1;)V
+}
+
+public final class com/datadog/android/api/feature/FeatureSdkCore$DefaultImpls {
+	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
 }
 
 public abstract interface class com/datadog/android/api/feature/StorageBackedFeature : com/datadog/android/api/feature/Feature {
@@ -559,7 +568,7 @@ public abstract interface class com/datadog/android/core/InternalSdkCore : com/d
 	public abstract fun deleteLastViewEvent ()V
 	public abstract fun getAllFeatures ()Ljava/util/List;
 	public abstract fun getAppStartTimeNs ()J
-	public abstract fun getDatadogContext ()Lcom/datadog/android/api/context/DatadogContext;
+	public abstract fun getDatadogContext (Ljava/util/Set;)Lcom/datadog/android/api/context/DatadogContext;
 	public abstract fun getFirstPartyHostResolver ()Lcom/datadog/android/core/internal/net/FirstPartyHostHeaderTypeResolver;
 	public abstract fun getLastFatalAnrSent ()Ljava/lang/Long;
 	public abstract fun getLastViewEvent ()Lcom/google/gson/JsonObject;
@@ -572,6 +581,10 @@ public abstract interface class com/datadog/android/core/InternalSdkCore : com/d
 	public abstract fun writeLastViewEvent ([B)V
 }
 
+public final class com/datadog/android/core/InternalSdkCore$DefaultImpls {
+	public static synthetic fun getDatadogContext$default (Lcom/datadog/android/core/InternalSdkCore;Ljava/util/Set;ILjava/lang/Object;)Lcom/datadog/android/api/context/DatadogContext;
+}
+
 public final class com/datadog/android/core/SdkReference {
 	public fun <init> ()V
 	public fun <init> (Ljava/lang/String;)V
@@ -785,8 +798,10 @@ public final class com/datadog/android/core/internal/utils/ByteArrayExtKt {
 
 public final class com/datadog/android/core/internal/utils/ConcurrencyExtKt {
 	public static final fun executeSafe (Ljava/util/concurrent/Executor;Ljava/lang/String;Lcom/datadog/android/api/InternalLogger;Ljava/lang/Runnable;)V
+	public static final fun getSafe (Ljava/util/concurrent/Future;Ljava/lang/String;Lcom/datadog/android/api/InternalLogger;)Ljava/lang/Object;
 	public static final fun scheduleSafe (Ljava/util/concurrent/ScheduledExecutorService;Ljava/lang/String;JLjava/util/concurrent/TimeUnit;Lcom/datadog/android/api/InternalLogger;Ljava/lang/Runnable;)Ljava/util/concurrent/ScheduledFuture;
 	public static final fun submitSafe (Ljava/util/concurrent/ExecutorService;Ljava/lang/String;Lcom/datadog/android/api/InternalLogger;Ljava/lang/Runnable;)Ljava/util/concurrent/Future;
+	public static final fun submitSafe (Ljava/util/concurrent/ExecutorService;Ljava/lang/String;Lcom/datadog/android/api/InternalLogger;Ljava/util/concurrent/Callable;)Ljava/util/concurrent/Future;
 }
 
 public final class com/datadog/android/core/internal/utils/JsonSerializer {

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

@@ -94,8 +94,10 @@ object Datadog {
                 sdkInstanceName
             ).apply {
                 initialize(configuration)
+                // not pushing to the context thread to have it set already at the
+                // moment Datadog.initialize is completed
+                coreFeature.trackingConsentProvider.setConsent(trackingConsent)
             }
-            sdkCore.setTrackingConsent(trackingConsent)
             registry.register(sdkInstanceName, sdkCore)
 
             return sdkCore

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

@@ -16,8 +16,8 @@ fun interface FeatureContextUpdateReceiver {
     /**
      * Called when the context for a feature is updated.
      * @param featureName the name of the feature
-     * @param event the updated context
+     * @param context the updated context
      */
     @AnyThread
-    fun onContextUpdate(featureName: String, event: Map<String, Any?>)
+    fun onContextUpdate(featureName: String, context: Map<String, Any?>)
 }

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

@@ -10,6 +10,7 @@ import androidx.annotation.AnyThread
 import com.datadog.android.api.context.DatadogContext
 import com.datadog.android.api.storage.EventBatchWriter
 import com.datadog.android.api.storage.datastore.DataStoreHandler
+import com.datadog.android.lint.InternalApi
 
 /**
  * Represents a Datadog feature.
@@ -23,19 +24,48 @@ interface FeatureScope {
 
     /**
      * Utility to write an event, asynchronously.
-     * @param forceNewBatch if `true` forces the [EventBatchWriter] to write in a new file and
-     * not reuse the already existing pending data persistence file. By default it is `false`.
+     * @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.
      * @param callback an operation called with an up-to-date [DatadogContext]
-     * and an [EventBatchWriter]. Callback will be executed on a worker thread from I/O pool.
-     * [DatadogContext] will have a state created at the moment this method is called, before the
-     * thread switch for the callback invocation.
+     * and an [EventWriteScope]. Callback will be executed on a single context processing worker thread. Execution of
+     * [EventWriteScope] will be done on a worker thread from I/O pool.
+     * [DatadogContext] will have a state created at the moment this method is called.
      */
     @AnyThread
     fun withWriteContext(
-        forceNewBatch: Boolean = false,
-        callback: (DatadogContext, EventBatchWriter) -> Unit
+        withFeatureContexts: Set<String> = emptySet(),
+        callback: (datadogContext: DatadogContext, write: EventWriteScope) -> Unit
     )
 
+    /**
+     * 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.
+     * @param callback an operation called with an up-to-date [DatadogContext].
+     * [DatadogContext] will have a state created at the moment this method is called.
+     */
+    @AnyThread
+    fun withContext(
+        withFeatureContexts: Set<String> = emptySet(),
+        callback: (datadogContext: DatadogContext) -> Unit
+    )
+
+    // TODO RUM-9852 Implement better passthrough mechanism for the JVM crash scenario
+    /**
+     * Same as [withWriteContext] but will be executed in the blocking manner.
+     *
+     * @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.
+     *
+     * **NOTE**: This API is for the internal use only and is not guaranteed to be stable.
+     */
+    @AnyThread
+    @InternalApi
+    fun getWriteContextSync(withFeatureContexts: Set<String> = emptySet()): Pair<DatadogContext, EventWriteScope>?
+
     /**
      * Send event to a given feature. It will be sent in a synchronous way.
      *
@@ -48,3 +78,9 @@ interface FeatureScope {
      */
     fun <T : Feature> unwrap(): T
 }
+
+/**
+ * Scope for the event write operation which is invoked on the worker thread from I/O pool, which is different
+ * from the context processing worker thread used for [FeatureScope.withWriteContext] callback invocation.
+ */
+typealias EventWriteScope = ((EventBatchWriter) -> Unit) -> Unit

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

@@ -45,21 +45,30 @@ interface FeatureSdkCore : SdkCore {
      * provided [featureName], a new one will be created.
      *
      * @param featureName Feature name.
+     * @param useContextThread Whenever update of the context should happen on the context processing thread or not. It
+     * should be true for most of the cases related to the event processing. Be careful when setting it to false, valid
+     * use-case can be like updating/reading feature context on the same (or already on the context) thread.
+     * Defaults to true.
      * @param updateCallback Provides current feature context for the update. If there is no feature
      * with the given name registered, callback won't be called.
      */
     fun updateFeatureContext(
         featureName: String,
+        useContextThread: Boolean = true,
         updateCallback: (context: MutableMap<String, Any?>) -> Unit
     )
 
     /**
      * Retrieves the context for the particular feature.
      *
      * @param featureName Feature name.
+     * @param useContextThread Whenever context read should happen on the context processing thread or not. It
+     * should be true for most of the cases related to the event processing. Be careful when setting it to false, valid
+     * use-case can be like updating/reading feature context on the same (or already on the context) thread.
+     * Defaults to true.
      * @return Context for the given feature or empty map if feature is not registered.
      */
-    fun getFeatureContext(featureName: String): Map<String, Any?>
+    fun getFeatureContext(featureName: String, useContextThread: Boolean = true): Map<String, Any?>
 
     /**
      * Sets event receiver for the given feature.
@@ -70,27 +79,26 @@ interface FeatureSdkCore : SdkCore {
     fun setEventReceiver(featureName: String, receiver: FeatureEventReceiver)
 
     /**
-     * Sets context update receiver for the given feature.
+     * Removes events receive for the given feature.
      *
      * @param featureName Feature name.
-     * @param listener Listener to remove.
      */
-    fun setContextUpdateReceiver(featureName: String, listener: FeatureContextUpdateReceiver)
+    fun removeEventReceiver(featureName: String)
 
     /**
-     * Removes context update listener for the given feature.
+     * Sets feature context update listener. Once subscribed, current context will be emitted
+     * immdediately if it exists.
      *
-     * @param featureName Feature name.
      * @param listener Listener to remove.
      */
-    fun removeContextUpdateReceiver(featureName: String, listener: FeatureContextUpdateReceiver)
+    fun setContextUpdateReceiver(listener: FeatureContextUpdateReceiver)
 
     /**
-     * Removes events receive for the given feature.
+     * Removes feature context update listener.
      *
-     * @param featureName Feature name.
+     * @param listener Listener to remove.
      */
-    fun removeEventReceiver(featureName: String)
+    fun removeContextUpdateReceiver(listener: FeatureContextUpdateReceiver)
 
     /**
      * Returns a new single thread [ExecutorService], set up with backpressure and internal monitoring.

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

@@ -116,8 +116,11 @@ interface InternalSdkCore : FeatureSdkCore {
     fun getAllFeatures(): List<FeatureScope>
 
     /**
-     * @return the current DatadogContext, or null
+     * @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.
+     * @return the current [DatadogContext], or null
      */
     @InternalApi
-    fun getDatadogContext(): DatadogContext?
+    fun getDatadogContext(withFeatureContexts: Set<String> = emptySet()): DatadogContext?
 }

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

@@ -7,18 +7,16 @@
 package com.datadog.android.core.internal
 
 import com.datadog.android.api.context.DatadogContext
+import com.datadog.android.api.feature.Feature
 
 internal interface ContextProvider {
-    // TODO RUM-3784 getting context may be quite heavy, should it be something non-blocking here?
-
     // TODO RUM-3784 lifecycle checks may be needed for the cases when context is requested
     //  when datadog is not initialized yet/anymore (case of UploadWorker, other calls site
     //  should be in sync with lifecycle)
-
-    // TODO RUM-3784 can be accessed from different threads
-    val context: DatadogContext
-
-    fun setFeatureContext(feature: String, context: Map<String, Any?>)
-
-    fun getFeatureContext(feature: String): Map<String, Any?>
+    /**
+     * @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.
+     */
+    fun getContext(withFeatureContexts: Set<String>): DatadogContext
 }