Merge pull request #2516 from DataDog/carlosnogueira/RUM-8652/add-config-option-to-override-specific-sr-methods

[RUM-8652] Allow definition of custom implementations of specific SR methods

Author: cdn34dd

features/dd-sdk-android-session-replay/api/apiSurface

@@ -36,6 +36,8 @@ data class com.datadog.android.sessionreplay.SessionReplayConfiguration
     fun setDynamicOptimizationEnabled(Boolean): Builder
     fun setSystemRequirements(SystemRequirementsConfiguration): Builder
     fun build(): SessionReplayConfiguration
+interface com.datadog.android.sessionreplay.SessionReplayInternalCallback
+  fun getCurrentActivity(): android.app.Activity?
 enum com.datadog.android.sessionreplay.SessionReplayPrivacy
   - ALLOW
   - MASK
@@ -55,6 +57,9 @@ enum com.datadog.android.sessionreplay.TextAndInputPrivacy : PrivacyLevel
 enum com.datadog.android.sessionreplay.TouchPrivacy : PrivacyLevel
   - SHOW
   - HIDE
+class com.datadog.android.sessionreplay._SessionReplayInternalProxy
+  constructor(SessionReplayConfiguration.Builder)
+  fun setInternalCallback(SessionReplayInternalCallback): SessionReplayConfiguration.Builder
 class com.datadog.android.sessionreplay.internal.TouchPrivacyManager
   constructor(com.datadog.android.sessionreplay.TouchPrivacy)
   fun addTouchOverrideArea(android.graphics.Rect, com.datadog.android.sessionreplay.TouchPrivacy)

features/dd-sdk-android-session-replay/api/dd-sdk-android-session-replay.api

@@ -46,8 +46,8 @@ public final class com/datadog/android/sessionreplay/SessionReplay {
 }
 
 public final class com/datadog/android/sessionreplay/SessionReplayConfiguration {
-	public final fun copy (Ljava/lang/String;Lcom/datadog/android/sessionreplay/SessionReplayPrivacy;Ljava/util/List;Ljava/util/List;Ljava/util/List;FLcom/datadog/android/sessionreplay/ImagePrivacy;ZLcom/datadog/android/sessionreplay/TouchPrivacy;Lcom/datadog/android/sessionreplay/TextAndInputPrivacy;ZLcom/datadog/android/sessionreplay/SystemRequirementsConfiguration;)Lcom/datadog/android/sessionreplay/SessionReplayConfiguration;
-	public static synthetic fun copy$default (Lcom/datadog/android/sessionreplay/SessionReplayConfiguration;Ljava/lang/String;Lcom/datadog/android/sessionreplay/SessionReplayPrivacy;Ljava/util/List;Ljava/util/List;Ljava/util/List;FLcom/datadog/android/sessionreplay/ImagePrivacy;ZLcom/datadog/android/sessionreplay/TouchPrivacy;Lcom/datadog/android/sessionreplay/TextAndInputPrivacy;ZLcom/datadog/android/sessionreplay/SystemRequirementsConfiguration;ILjava/lang/Object;)Lcom/datadog/android/sessionreplay/SessionReplayConfiguration;
+	public final fun copy (Ljava/lang/String;Lcom/datadog/android/sessionreplay/SessionReplayPrivacy;Ljava/util/List;Ljava/util/List;Ljava/util/List;FLcom/datadog/android/sessionreplay/ImagePrivacy;ZLcom/datadog/android/sessionreplay/TouchPrivacy;Lcom/datadog/android/sessionreplay/TextAndInputPrivacy;ZLcom/datadog/android/sessionreplay/SystemRequirementsConfiguration;Lcom/datadog/android/sessionreplay/SessionReplayInternalCallback;)Lcom/datadog/android/sessionreplay/SessionReplayConfiguration;
+	public static synthetic fun copy$default (Lcom/datadog/android/sessionreplay/SessionReplayConfiguration;Ljava/lang/String;Lcom/datadog/android/sessionreplay/SessionReplayPrivacy;Ljava/util/List;Ljava/util/List;Ljava/util/List;FLcom/datadog/android/sessionreplay/ImagePrivacy;ZLcom/datadog/android/sessionreplay/TouchPrivacy;Lcom/datadog/android/sessionreplay/TextAndInputPrivacy;ZLcom/datadog/android/sessionreplay/SystemRequirementsConfiguration;Lcom/datadog/android/sessionreplay/SessionReplayInternalCallback;ILjava/lang/Object;)Lcom/datadog/android/sessionreplay/SessionReplayConfiguration;
 	public fun equals (Ljava/lang/Object;)Z
 	public fun hashCode ()I
 	public fun toString ()Ljava/lang/String;
@@ -69,6 +69,10 @@ public final class com/datadog/android/sessionreplay/SessionReplayConfiguration$
 	public final fun useCustomEndpoint (Ljava/lang/String;)Lcom/datadog/android/sessionreplay/SessionReplayConfiguration$Builder;
 }
 
+public abstract interface class com/datadog/android/sessionreplay/SessionReplayInternalCallback {
+	public abstract fun getCurrentActivity ()Landroid/app/Activity;
+}
+
 public final class com/datadog/android/sessionreplay/SessionReplayPrivacy : java/lang/Enum {
 	public static final field ALLOW Lcom/datadog/android/sessionreplay/SessionReplayPrivacy;
 	public static final field MASK Lcom/datadog/android/sessionreplay/SessionReplayPrivacy;
@@ -108,6 +112,11 @@ public final class com/datadog/android/sessionreplay/TouchPrivacy : java/lang/En
 	public static fun values ()[Lcom/datadog/android/sessionreplay/TouchPrivacy;
 }
 
+public final class com/datadog/android/sessionreplay/_SessionReplayInternalProxy {
+	public fun <init> (Lcom/datadog/android/sessionreplay/SessionReplayConfiguration$Builder;)V
+	public final fun setInternalCallback (Lcom/datadog/android/sessionreplay/SessionReplayInternalCallback;)Lcom/datadog/android/sessionreplay/SessionReplayConfiguration$Builder;
+}
+
 public final class com/datadog/android/sessionreplay/internal/TouchPrivacyManager {
 	public fun <init> (Lcom/datadog/android/sessionreplay/TouchPrivacy;)V
 	public final fun addTouchOverrideArea (Landroid/graphics/Rect;Lcom/datadog/android/sessionreplay/TouchPrivacy;)V

features/dd-sdk-android-session-replay/src/main/kotlin/com/datadog/android/sessionreplay/SessionReplay.kt

@@ -59,7 +59,8 @@ object SessionReplay {
                     customDrawableMappers = sessionReplayConfiguration.customDrawableMappers,
                     sampleRate = sessionReplayConfiguration.sampleRate,
                     startRecordingImmediately = sessionReplayConfiguration.startRecordingImmediately,
-                    dynamicOptimizationEnabled = sessionReplayConfiguration.dynamicOptimizationEnabled
+                    dynamicOptimizationEnabled = sessionReplayConfiguration.dynamicOptimizationEnabled,
+                    internalCallback = sessionReplayConfiguration.internalCallback
                 )
 
                 if (isAlreadyRegistered()) {

features/dd-sdk-android-session-replay/src/main/kotlin/com/datadog/android/sessionreplay/SessionReplayConfiguration.kt

@@ -8,6 +8,7 @@ package com.datadog.android.sessionreplay
 
 import androidx.annotation.FloatRange
 import com.datadog.android.api.InternalLogger
+import com.datadog.android.sessionreplay.internal.recorder.SessionReplayRecorder
 import com.datadog.android.sessionreplay.recorder.OptionSelectorDetector
 import com.datadog.android.sessionreplay.utils.DrawableToColorMapper
 import java.util.Locale
@@ -27,7 +28,8 @@ data class SessionReplayConfiguration internal constructor(
     internal val touchPrivacy: TouchPrivacy,
     internal val textAndInputPrivacy: TextAndInputPrivacy,
     internal val dynamicOptimizationEnabled: Boolean,
-    internal val systemRequirementsConfiguration: SystemRequirementsConfiguration
+    internal val systemRequirementsConfiguration: SystemRequirementsConfiguration,
+    internal val internalCallback: SessionReplayInternalCallback
 ) {
 
     /**
@@ -73,6 +75,7 @@ data class SessionReplayConfiguration internal constructor(
         private var extensionSupportSet: MutableSet<ExtensionSupport> = mutableSetOf()
         private var dynamicOptimizationEnabled = true
         private var systemRequirementsConfiguration = SystemRequirementsConfiguration.NONE
+        private var internalCallback: SessionReplayInternalCallback = NoOpSessionReplayInternalCallback()
 
         /**
          * Adds an extension support implementation. This is mostly used when you want to provide
@@ -210,6 +213,19 @@ data class SessionReplayConfiguration internal constructor(
             return this
         }
 
+        /**
+         * Allows definition of custom callback functions for Session Replay
+         * that may require platform-specific behavior.
+         * Currently, this enables defining:
+         * - [SessionReplayInternalCallback.getCurrentActivity]:
+         *   Used in [SessionReplayRecorder] to register fragment lifecycle callbacks
+         *   for clients initialized after the `Application.onCreate` phase.
+         */
+        internal fun setInternalCallback(internalCallback: SessionReplayInternalCallback): Builder {
+            this.internalCallback = internalCallback
+            return this
+        }
+
         /**
          * Builds a [SessionReplayConfiguration] based on the current state of this Builder.
          */
@@ -226,7 +242,8 @@ data class SessionReplayConfiguration internal constructor(
                 sampleRate = sampleRate,
                 startRecordingImmediately = startRecordingImmediately,
                 dynamicOptimizationEnabled = dynamicOptimizationEnabled,
-                systemRequirementsConfiguration = systemRequirementsConfiguration
+                systemRequirementsConfiguration = systemRequirementsConfiguration,
+                internalCallback = internalCallback
             )
         }
 

features/dd-sdk-android-session-replay/src/main/kotlin/com/datadog/android/sessionreplay/SessionReplayInternalCallback.kt

@@ -0,0 +1,24 @@
+/*
+ * 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.sessionreplay
+
+import android.app.Activity
+import com.datadog.android.sessionreplay.internal.recorder.SessionReplayRecorder
+import com.datadog.tools.annotation.NoOpImplementation
+
+/**
+ * Defines points of change for clients to override existing functionality with platform specific code.
+ */
+@NoOpImplementation
+interface SessionReplayInternalCallback {
+    /**
+     * Retrieves the current activity, allowing clients to pass it when needed.
+     * This is used by [SessionReplayRecorder] to register fragment lifecycle callbacks
+     * that were missed because the client was initialized after the `Application.onCreate` phase.
+     */
+    fun getCurrentActivity(): Activity?
+}

features/dd-sdk-android-session-replay/src/main/kotlin/com/datadog/android/sessionreplay/_SessionReplayInternalProxy.kt

@@ -0,0 +1,38 @@
+/*
+ * 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.sessionreplay
+
+import com.datadog.android.lint.InternalApi
+
+/**
+ * This class exposes internal methods that are used by other Datadog modules and cross platform
+ * frameworks. It is not meant for public use.
+ *
+ * DO NOT USE this class or its methods if you are not working on the internals of the Datadog SDK
+ * or one of the cross platform frameworks.
+ *
+ * Methods, members, and functionality of this class  are subject to change without notice, as they
+ * are not considered part of the public interface of the Datadog SDK.
+ */
+@InternalApi
+@Suppress(
+    "ClassName",
+    "ClassNaming"
+)
+class _SessionReplayInternalProxy(private val builder: SessionReplayConfiguration.Builder) {
+    /**
+     * Sets an internal callback for session replay.
+     *
+     * @param internalCallback callback instance to override specific parts of the codebase.
+     * @return [SessionReplayConfiguration.Builder] instance.
+     */
+    fun setInternalCallback(
+        internalCallback: SessionReplayInternalCallback
+    ): SessionReplayConfiguration.Builder {
+        return builder.setInternalCallback(internalCallback)
+    }
+}

features/dd-sdk-android-session-replay/src/main/kotlin/com/datadog/android/sessionreplay/internal/DefaultRecorderProvider.kt

@@ -25,6 +25,7 @@ import com.datadog.android.api.feature.FeatureSdkCore
 import com.datadog.android.internal.utils.ImageViewUtils
 import com.datadog.android.sessionreplay.ImagePrivacy
 import com.datadog.android.sessionreplay.MapperTypeWrapper
+import com.datadog.android.sessionreplay.SessionReplayInternalCallback
 import com.datadog.android.sessionreplay.TextAndInputPrivacy
 import com.datadog.android.sessionreplay.internal.recorder.Recorder
 import com.datadog.android.sessionreplay.internal.recorder.SessionReplayRecorder
@@ -64,7 +65,8 @@ internal class DefaultRecorderProvider(
     private val customMappers: List<MapperTypeWrapper<*>>,
     private val customOptionSelectorDetectors: List<OptionSelectorDetector>,
     private val customDrawableMappers: List<DrawableToColorMapper>,
-    private val dynamicOptimizationEnabled: Boolean
+    private val dynamicOptimizationEnabled: Boolean,
+    private val internalCallback: SessionReplayInternalCallback
 ) : RecorderProvider {
 
     override fun provideSessionReplayRecorder(
@@ -87,7 +89,8 @@ internal class DefaultRecorderProvider(
             customOptionSelectorDetectors = customOptionSelectorDetectors,
             customDrawableMappers = customDrawableMappers,
             sdkCore = sdkCore,
-            dynamicOptimizationEnabled = dynamicOptimizationEnabled
+            dynamicOptimizationEnabled = dynamicOptimizationEnabled,
+            internalCallback = internalCallback
         )
     }
 

features/dd-sdk-android-session-replay/src/main/kotlin/com/datadog/android/sessionreplay/internal/SessionReplayFeature.kt

@@ -20,6 +20,7 @@ import com.datadog.android.core.sampling.RateBasedSampler
 import com.datadog.android.core.sampling.Sampler
 import com.datadog.android.sessionreplay.ImagePrivacy
 import com.datadog.android.sessionreplay.MapperTypeWrapper
+import com.datadog.android.sessionreplay.SessionReplayInternalCallback
 import com.datadog.android.sessionreplay.SessionReplayPrivacy
 import com.datadog.android.sessionreplay.TextAndInputPrivacy
 import com.datadog.android.sessionreplay.TouchPrivacy
@@ -71,7 +72,8 @@ internal class SessionReplayFeature(
         customDrawableMappers: List<DrawableToColorMapper>,
         sampleRate: Float,
         startRecordingImmediately: Boolean,
-        dynamicOptimizationEnabled: Boolean
+        dynamicOptimizationEnabled: Boolean,
+        internalCallback: SessionReplayInternalCallback
     ) : this(
         sdkCore,
         customEndpointUrl,
@@ -89,7 +91,8 @@ internal class SessionReplayFeature(
             customMappers,
             customOptionSelectorDetectors,
             customDrawableMappers,
-            dynamicOptimizationEnabled
+            dynamicOptimizationEnabled,
+            internalCallback
         )
     )
 

features/dd-sdk-android-session-replay/src/main/kotlin/com/datadog/android/sessionreplay/internal/SessionReplayLifecycleCallback.kt

@@ -21,6 +21,24 @@ internal class SessionReplayLifecycleCallback(
 
     private val currentActiveWindows = WeakHashMap<Window, Any?>()
 
+    fun setCurrentWindow(activity: Activity) {
+        activity.window?.let {
+            currentActiveWindows[it] = null
+        }
+    }
+
+    fun registerFragmentLifecycleCallbacks(activity: Activity) {
+        if (activity is FragmentActivity) {
+            // we need to register before the activity resumes to catch all the fragments
+            // added even before the activity resumes
+            val lifecycleCallback = RecorderFragmentLifecycleCallback(this)
+            activity.supportFragmentManager.registerFragmentLifecycleCallbacks(
+                lifecycleCallback,
+                true
+            )
+        }
+    }
+
     override fun onWindowsAdded(windows: List<Window>) {
         windows.forEach {
             currentActiveWindows[it] = null
@@ -41,15 +59,7 @@ internal class SessionReplayLifecycleCallback(
 
     @MainThread
     override fun onActivityCreated(activity: Activity, savedInstanceState: Bundle?) {
-        if (activity is FragmentActivity) {
-            // we need to register before the activity resumes to catch all the fragments
-            // added even before the activity resumes
-            val lifecycleCallback = RecorderFragmentLifecycleCallback(this)
-            activity.supportFragmentManager.registerFragmentLifecycleCallbacks(
-                lifecycleCallback,
-                true
-            )
-        }
+        registerFragmentLifecycleCallbacks(activity)
     }
 
     @MainThread

features/dd-sdk-android-session-replay/src/main/kotlin/com/datadog/android/sessionreplay/internal/recorder/SessionReplayRecorder.kt

@@ -16,6 +16,7 @@ import com.datadog.android.api.InternalLogger
 import com.datadog.android.api.feature.FeatureSdkCore
 import com.datadog.android.sessionreplay.ImagePrivacy
 import com.datadog.android.sessionreplay.MapperTypeWrapper
+import com.datadog.android.sessionreplay.SessionReplayInternalCallback
 import com.datadog.android.sessionreplay.TextAndInputPrivacy
 import com.datadog.android.sessionreplay.internal.LifecycleCallback
 import com.datadog.android.sessionreplay.internal.SessionReplayLifecycleCallback
@@ -71,7 +72,7 @@ internal class SessionReplayRecorder : OnWindowRefreshedCallback, Recorder {
     private val viewOnDrawInterceptor: ViewOnDrawInterceptor
     private val internalLogger: InternalLogger
     private val resourceDataStoreManager: ResourceDataStoreManager
-
+    private val internalCallback: SessionReplayInternalCallback
     private val uiHandler: Handler
     private var shouldRecord = false
 
@@ -91,7 +92,8 @@ internal class SessionReplayRecorder : OnWindowRefreshedCallback, Recorder {
         windowInspector: WindowInspector = WindowInspector,
         sdkCore: FeatureSdkCore,
         resourceDataStoreManager: ResourceDataStoreManager,
-        dynamicOptimizationEnabled: Boolean
+        dynamicOptimizationEnabled: Boolean,
+        internalCallback: SessionReplayInternalCallback
     ) {
         val internalLogger = sdkCore.internalLogger
         val rumContextDataHandler = RumContextDataHandler(
@@ -129,6 +131,7 @@ internal class SessionReplayRecorder : OnWindowRefreshedCallback, Recorder {
             recordedDataQueue = ConcurrentLinkedQueue()
         )
         this.resourceDataStoreManager = resourceDataStoreManager
+        this.internalCallback = internalCallback
 
         val viewIdentifierResolver: ViewIdentifierResolver = DefaultViewIdentifierResolver
         val colorStringFormatter: ColorStringFormatter = DefaultColorStringFormatter
@@ -208,6 +211,13 @@ internal class SessionReplayRecorder : OnWindowRefreshedCallback, Recorder {
             touchPrivacyManager
         )
         this.sessionReplayLifecycleCallback = SessionReplayLifecycleCallback(this)
+
+        // Register fragment lifecycle callbacks for clients initialized after the Application.onCreate phase
+        internalCallback.getCurrentActivity()?.let {
+            sessionReplayLifecycleCallback.setCurrentWindow(it)
+            sessionReplayLifecycleCallback.registerFragmentLifecycleCallbacks(it)
+        }
+
         this.uiHandler = Handler(Looper.getMainLooper())
         this.internalLogger = internalLogger
     }
@@ -231,7 +241,8 @@ internal class SessionReplayRecorder : OnWindowRefreshedCallback, Recorder {
         recordedDataQueueHandler: RecordedDataQueueHandler,
         resourceDataStoreManager: ResourceDataStoreManager,
         uiHandler: Handler,
-        internalLogger: InternalLogger
+        internalLogger: InternalLogger,
+        internalCallback: SessionReplayInternalCallback
     ) {
         this.appContext = appContext
         this.rumContextProvider = rumContextProvider
@@ -250,6 +261,7 @@ internal class SessionReplayRecorder : OnWindowRefreshedCallback, Recorder {
         this.uiHandler = uiHandler
         this.internalLogger = internalLogger
         this.resourceDataStoreManager = resourceDataStoreManager
+        this.internalCallback = internalCallback
     }
 
     override fun stopProcessingRecords() {