Feature/189/session replay min duration

USAGE.md

@@ -218,6 +218,8 @@ val config = PostHogAndroidConfig(apiKey).apply {
     sessionReplayConfig.screenshot = false
     // debouncerDelayMs is 500ms by default
     sessionReplayConfig.debouncerDelayMs = 1000
+    // minSessionDurationMs is 0ms by default
+    sessionReplayConfig.minSessionDurationMs = 2000
 }
 ```
 

posthog-android/src/main/java/com/posthog/android/replay/PostHogReplayIntegration.kt

@@ -58,6 +58,7 @@ import com.posthog.android.internal.screenSize
 import com.posthog.android.replay.internal.NextDrawListener.Companion.onNextDraw
 import com.posthog.android.replay.internal.ViewTreeSnapshotStatus
 import com.posthog.android.replay.internal.isAliveAndAttachedToWindow
+import com.posthog.internal.PostHogPreferences
 import com.posthog.internal.PostHogThreadFactory
 import com.posthog.internal.replay.RRCustomEvent
 import com.posthog.internal.replay.RREvent
@@ -118,6 +119,11 @@ public class PostHogReplayIntegration(
     private val isSessionReplayEnabled: Boolean
         get() = PostHog.isSessionReplayActive()
 
+    private val sessionStartTime by lazy { config.dateProvider.currentTimeMillis() }
+    private val events = mutableListOf<RREvent>()
+    private val mouseInteractions = mutableListOf<RRIncrementalMouseInteractionEvent>()
+    private var minSessionThresholdCrossed = false
+
     private fun addView(
         view: View,
         added: Boolean = true,
@@ -251,7 +257,6 @@ public class PostHogReplayIntegration(
         motionEvent: MotionEvent,
         type: RRMouseInteraction,
     ) {
-        val mouseInteractions = mutableListOf<RRIncrementalMouseInteractionEvent>()
         for (index in 0 until motionEvent.pointerCount) {
             // if the id is 0, BE transformer will set it to the virtual bodyId
             val id = motionEvent.getPointerId(index)
@@ -269,12 +274,14 @@ public class PostHogReplayIntegration(
             mouseInteractions.add(mouseInteraction)
         }
 
-        if (mouseInteractions.isNotEmpty()) {
+        if (mouseInteractions.isNotEmpty() && sessionLongerThanMinDuration()) {
             // TODO: we can probably batch those
             // if we batch them, we need to be aware that the order of the events matters
             // also because if we send a mouse interaction later, it might be attached to the wrong
             // screen
+            config.logger.log("Session replay mouse events captured: " + mouseInteractions.size)
             mouseInteractions.capture()
+            mouseInteractions.clear()
         }
     }
 
@@ -312,6 +319,7 @@ public class PostHogReplayIntegration(
 
         // workaround for react native that is started after the window is added
         // Curtains.rootViews should be empty for normal apps yet
+
         Curtains.rootViews.forEach { view ->
             addView(view)
         }
@@ -373,8 +381,6 @@ public class PostHogReplayIntegration(
             }
         }
 
-        val events = mutableListOf<RREvent>()
-
         if (!status.sentMetaEvent) {
             val title = view.phoneWindow?.attributes?.title?.toString()?.substringAfter("/") ?: ""
             // TODO: cache and compare, if size changes, we send a ViewportResize event
@@ -453,13 +459,29 @@ public class PostHogReplayIntegration(
             events.add(it)
         }
 
-        if (events.isNotEmpty()) {
+        if (events.isNotEmpty() && sessionLongerThanMinDuration()) {
+            config.logger.log("Session replay events captured: " + events.size)
             events.capture()
+            events.clear()
         }
 
         status.lastSnapshot = wireframe
     }
 
+    private fun sessionLongerThanMinDuration(): Boolean {
+        //Check value only if threshold not crossed.
+        if (!minSessionThresholdCrossed) {
+            //Give server min duration is set, give it a higher priority than locally passed config
+            val finalMinimumDuration = config.minReplaySessionDurationMs ?: config.sessionReplayConfig.minSessionDurationMs
+
+            config.logger.log("Minimum replay session duration set to: $finalMinimumDuration")
+
+            minSessionThresholdCrossed =
+                config.dateProvider.currentTimeMillis() - sessionStartTime >= finalMinimumDuration
+        }
+        return minSessionThresholdCrossed
+    }
+
     private fun View.isVisible(): Boolean {
         // TODO: also check for getGlobalVisibleRect intersects the display
         val visible = isShown && width >= 0 && height >= 0 && this !is ViewStub

posthog-android/src/main/java/com/posthog/android/replay/PostHogSessionReplayConfig.kt

@@ -48,4 +48,11 @@ public class PostHogSessionReplayConfig
          */
         @PostHogExperimental
         public var debouncerDelayMs: Long = 500,
+        /**
+         * Define the minimum duration for sessions to be recorded.
+         * This is useful if you want to exclude sessions that are too short to be useful.
+         * Defaults to 0ms
+         */
+        @PostHogExperimental
+        public var minSessionDurationMs: Long = 0,
     )

posthog-samples/posthog-android-sample/src/main/java/com/posthog/android/sample/MyApp.kt

@@ -40,6 +40,7 @@ class MyApp : Application() {
                 sessionReplayConfig.maskAllImages = false
                 sessionReplayConfig.captureLogcat = true
                 sessionReplayConfig.screenshot = true
+                sessionReplayConfig.minSessionDurationMs = 5000
             }
         PostHogAndroid.setup(this, config)
     }

posthog/src/main/java/com/posthog/PostHog.kt

@@ -853,7 +853,8 @@ public class PostHog private constructor(
     // this is used in cases where we know the session is already active
     // so we spare another locker
     private fun isSessionReplayFlagActive(): Boolean {
-        return config?.sessionReplay == true && featureFlags?.isSessionReplayFlagActive() == true
+        //FIXME -> Remove this true hardcoding
+        return true || config?.sessionReplay == true && featureFlags?.isSessionReplayFlagActive() == true
     }
 
     override fun isSessionReplayActive(): Boolean {

posthog/src/main/java/com/posthog/PostHogConfig.kt

@@ -150,6 +150,9 @@ public open class PostHogConfig(
     @PostHogInternal
     public var snapshotEndpoint: String = "/s/"
 
+    @PostHogInternal
+    public var minReplaySessionDurationMs: Long? = null
+
     @PostHogInternal
     public var dateProvider: PostHogDateProvider = PostHogDeviceDateProvider()
 

posthog/src/main/java/com/posthog/internal/PostHogFeatureFlags.kt

@@ -127,6 +127,8 @@ internal class PostHogFeatureFlags(
                                     config.snapshotEndpoint = it["endpoint"] as? String
                                         ?: config.snapshotEndpoint
 
+                                    config.minReplaySessionDurationMs = (it["minimumDurationMilliseconds"] as? Number)?.toLong() ?: config.minReplaySessionDurationMs
+
                                     sessionReplayFlagActive = isRecordingActive(this.featureFlags ?: mapOf(), it)
                                     config.cachePreferences?.setValue(SESSION_REPLAY, it)
 
@@ -178,6 +180,8 @@ internal class PostHogFeatureFlags(
 
                     config.snapshotEndpoint = sessionRecording["endpoint"] as? String
                         ?: config.snapshotEndpoint
+
+                    config.minReplaySessionDurationMs = (sessionRecording["minimumDurationMilliseconds"] as? Number)?.toLong() ?: config.minReplaySessionDurationMs
                 }
             }
         }