diff --git a/.changeset/quiet-queues-rest.md b/.changeset/quiet-queues-rest.md new file mode 100644 index 000000000..2b96c0e17 --- /dev/null +++ b/.changeset/quiet-queues-rest.md @@ -0,0 +1,6 @@ +--- +"posthog": patch +"posthog-android": patch +--- + +Only attach `$sdk_debug_pending_queue_size` once the event queue reaches `flushAt`, so healthy queues no longer add it to every event diff --git a/posthog-android/src/test/java/com/posthog/android/PostHogAndroidEventSnapshotsTest.kt b/posthog-android/src/test/java/com/posthog/android/PostHogAndroidEventSnapshotsTest.kt index e2d5b534d..b3dfdb7a9 100644 --- a/posthog-android/src/test/java/com/posthog/android/PostHogAndroidEventSnapshotsTest.kt +++ b/posthog-android/src/test/java/com/posthog/android/PostHogAndroidEventSnapshotsTest.kt @@ -31,6 +31,7 @@ import kotlin.test.AfterTest import kotlin.test.BeforeTest import kotlin.test.Test import kotlin.test.assertEquals +import kotlin.test.assertFalse import kotlin.test.assertIs import kotlin.test.assertNotNull import kotlin.test.assertTrue @@ -269,11 +270,7 @@ internal class PostHogAndroidEventSnapshotsTest { event["uuid"] = "" val properties = event.map("properties") normalizeSdkVersion(properties) - // Depends on how many earlier captures the async queueExecutor has drained by the time - // this event's properties are built on the calling thread -- not deterministic run to run. - if (properties.containsKey("\$sdk_debug_pending_queue_size")) { - properties["\$sdk_debug_pending_queue_size"] = "" - } + assertFalse(properties.containsKey("\$sdk_debug_pending_queue_size")) } val featureFlagEvent = batch.single { (it as Map<*, *>)["event"] == "\$feature_flag_called" } as Map<*, *> diff --git a/posthog-android/src/test/resources/json/snapshots/batch-request.json b/posthog-android/src/test/resources/json/snapshots/batch-request.json index f7fd87b2c..7ec5badec 100644 --- a/posthog-android/src/test/resources/json/snapshots/batch-request.json +++ b/posthog-android/src/test/resources/json/snapshots/batch-request.json @@ -45,7 +45,6 @@ "$sdk_debug_replay_event_trigger_status": "trigger_disabled", "$sdk_debug_replay_linked_flag_trigger_status": "trigger_disabled", "$sdk_debug_replay_internal_buffer_length": 0, - "$sdk_debug_pending_queue_size": "", "$set": { "plan": "pro" }, @@ -99,7 +98,6 @@ "$sdk_debug_replay_capture_mode": "screenshot", "$sdk_debug_replay_internal_buffer_length": 0, "$sdk_debug_session_start": 1700000000123, - "$sdk_debug_pending_queue_size": "", "$set": { "email": "person@example.com" }, @@ -144,7 +142,6 @@ "$sdk_debug_replay_event_trigger_status": "trigger_disabled", "$sdk_debug_replay_linked_flag_trigger_status": "trigger_disabled", "$sdk_debug_replay_internal_buffer_length": 0, - "$sdk_debug_pending_queue_size": "", "$group_type": "company", "$group_key": "posthog", "$group_set": { @@ -189,7 +186,6 @@ "$sdk_debug_replay_event_trigger_status": "trigger_disabled", "$sdk_debug_replay_linked_flag_trigger_status": "trigger_disabled", "$sdk_debug_replay_internal_buffer_length": 0, - "$sdk_debug_pending_queue_size": "", "$groups": { "company": "posthog" }, @@ -237,7 +233,6 @@ "$sdk_debug_replay_event_trigger_status": "trigger_disabled", "$sdk_debug_replay_linked_flag_trigger_status": "trigger_disabled", "$sdk_debug_replay_internal_buffer_length": 0, - "$sdk_debug_pending_queue_size": "", "$groups": { "company": "posthog" }, diff --git a/posthog/src/main/java/com/posthog/PostHog.kt b/posthog/src/main/java/com/posthog/PostHog.kt index 7790c7697..4a36d0f1b 100644 --- a/posthog/src/main/java/com/posthog/PostHog.kt +++ b/posthog/src/main/java/com/posthog/PostHog.kt @@ -1059,7 +1059,7 @@ public class PostHog private constructor( if (claimed) { sessionStart(sessionId, managerStart)?.let { props["\$sdk_debug_session_start"] = it } } - queue?.size?.let { props["\$sdk_debug_pending_queue_size"] = it } + queue?.backedUpSize?.let { props["\$sdk_debug_pending_queue_size"] = it } } catch (e: Throwable) { props["\$sdk_debug_error_capturing_properties"] = e.toString().take(MAX_DEBUG_ERROR_LENGTH) } diff --git a/posthog/src/main/java/com/posthog/internal/PostHogQueue.kt b/posthog/src/main/java/com/posthog/internal/PostHogQueue.kt index 28baf11b3..914b2e862 100644 --- a/posthog/src/main/java/com/posthog/internal/PostHogQueue.kt +++ b/posthog/src/main/java/com/posthog/internal/PostHogQueue.kt @@ -93,6 +93,9 @@ public class PostHogQueue( override val size: Int get() = synchronized(dequeLock) { deque.size } + override val backedUpSize: Int? + get() = size.takeIf { it > 0 && it >= batchLimits.flushAt } + public val queueDirectory: File? get() = spec.storagePrefix?.let { File(it, config.projectToken) } @@ -771,7 +774,8 @@ public class PostHogQueue( internal class BatchLimits( var cap: Int, - var flushAt: Int, + // Halved on the queue executor and read on capture threads by backedUpSize. + @Volatile var flushAt: Int, ) { fun halve(actualBatchSize: Int) { cap = diff --git a/posthog/src/main/java/com/posthog/internal/PostHogQueueInterface.kt b/posthog/src/main/java/com/posthog/internal/PostHogQueueInterface.kt index 8b3ece53d..1824dbe59 100644 --- a/posthog/src/main/java/com/posthog/internal/PostHogQueueInterface.kt +++ b/posthog/src/main/java/com/posthog/internal/PostHogQueueInterface.kt @@ -14,6 +14,13 @@ import com.posthog.PostHogInternal public interface PostHogQueueInterface { public val size: Int + /** + * The size once the queue has reached its flush threshold, else null: below it the queue is + * ordinary batching, not a backlog worth reporting. + */ + public val backedUpSize: Int? + get() = null + public fun add(record: Record) public fun flush() diff --git a/posthog/src/test/java/com/posthog/PostHogTest.kt b/posthog/src/test/java/com/posthog/PostHogTest.kt index 694b08bcb..17420656a 100644 --- a/posthog/src/test/java/com/posthog/PostHogTest.kt +++ b/posthog/src/test/java/com/posthog/PostHogTest.kt @@ -1062,7 +1062,7 @@ internal class PostHogTest { assertTrue(theEvent.properties!!.containsKey("\$active_feature_flags")) assertEquals("disabled", theEvent.properties!!["\$recording_status"]) assertFalse(theEvent.properties!!.containsKey("\$sdk_debug_session_start")) - assertNotNull(theEvent.properties!!["\$sdk_debug_pending_queue_size"]) + assertFalse(theEvent.properties!!.containsKey("\$sdk_debug_pending_queue_size")) sut.close() } @@ -4122,7 +4122,7 @@ internal class PostHogTest { assertEquals("trigger_pending", props["\$sdk_debug_replay_event_trigger_status"]) assertEquals("trigger_disabled", props["\$sdk_debug_replay_linked_flag_trigger_status"]) assertEquals(1, (props["\$sdk_debug_replay_internal_buffer_length"] as Number).toInt()) - assertNotNull(props["\$sdk_debug_pending_queue_size"]) + assertFalse(props.containsKey("\$sdk_debug_pending_queue_size")) assertFalse(props.containsKey("\$sdk_debug_replay_capture_mode")) assertFalse(props.containsKey("\$sdk_debug_replay_flush_hold_reason")) assertFalse(props.containsKey("\$sdk_debug_replay_pending_trigger_conditions")) @@ -4158,7 +4158,7 @@ internal class PostHogTest { assertEquals("disabled", theEvent.properties!!["\$recording_status"]) assertEquals("wireframe", theEvent.properties!!["\$sdk_debug_replay_capture_mode"]) assertNotNull(theEvent.properties!!["\$sdk_debug_session_start"]) - assertNotNull(theEvent.properties!!["\$sdk_debug_pending_queue_size"]) + assertFalse(theEvent.properties!!.containsKey("\$sdk_debug_pending_queue_size")) assertFalse(theEvent.properties!!.containsKey("\$sdk_debug_replay_throttle_delay_ms")) assertFalse(theEvent.properties!!.containsKey("\$sdk_debug_current_session_duration")) @@ -4297,7 +4297,7 @@ internal class PostHogTest { assertFalse(theEvent.properties!!.containsKey("\$recording_status")) // The session and queue keys do not come from the replay handler, so they survive its throw. assertNotNull(theEvent.properties!!["\$sdk_debug_session_start"]) - assertNotNull(theEvent.properties!!["\$sdk_debug_pending_queue_size"]) + assertFalse(theEvent.properties!!.containsKey("\$sdk_debug_pending_queue_size")) sut.close() } @@ -4338,6 +4338,42 @@ internal class PostHogTest { beforeSend = beforeSend, ) + @Test + fun `pending queue size is attached only once the queue reaches flushAt`() { + val http = mockHttp() + val sut = getSut(http.url("/").toString(), flushAt = 3, preloadFeatureFlags = false, reloadFeatureFlags = false) + + repeat(3) { sut.capture(EVENT) } + + val events = capturedEvents(http) + assertEquals(listOf(false, false, false), events.map { it.properties!!.containsKey("\$sdk_debug_pending_queue_size") }) + + sut.close() + } + + @Test + fun `a backed-up queue reports its size on the next event`() { + val http = mockHttp() + val sut = getSut(http.url("/").toString(), flushAt = 3, preloadFeatureFlags = false, reloadFeatureFlags = false) + var connected = false + config.networkStatus = + object : PostHogNetworkStatus { + override fun isConnected(): Boolean = connected + } + + repeat(3) { sut.capture(EVENT) } + queueExecutor.awaitExecution() + assertEquals(0, http.requestCount) + sut.capture(EVENT) + + connected = true + sut.flush() + val events = capturedEvents(http) + assertEquals(listOf(null, null, null, 3), events.map { it.properties!!["\$sdk_debug_pending_queue_size"] }) + + sut.close() + } + @Test fun `replay debug bundle is attached at most once every 30 seconds while required keys stay on every event`() { val http = mockHttp() @@ -4358,7 +4394,7 @@ internal class PostHogTest { assertEquals("trigger_pending", it.properties!!["\$sdk_debug_replay_event_trigger_status"]) assertEquals("trigger_disabled", it.properties!!["\$sdk_debug_replay_linked_flag_trigger_status"]) assertNotNull(it.properties!!["\$sdk_debug_replay_internal_buffer_length"]) - assertNotNull(it.properties!!["\$sdk_debug_pending_queue_size"]) + assertFalse(it.properties!!.containsKey("\$sdk_debug_pending_queue_size")) } sut.close() @@ -4416,7 +4452,7 @@ internal class PostHogTest { assertEquals(listOf(false, false, true), events.map { it.carriesReplayDebugBundle }) events.forEach { assertEquals("buffering", it.properties!!["\$recording_status"]) - assertNotNull(it.properties!!["\$sdk_debug_pending_queue_size"]) + assertFalse(it.properties!!.containsKey("\$sdk_debug_pending_queue_size")) } sut.close() diff --git a/posthog/src/test/java/com/posthog/internal/PostHogQueueTest.kt b/posthog/src/test/java/com/posthog/internal/PostHogQueueTest.kt index 9b6222428..a85b1e5c3 100644 --- a/posthog/src/test/java/com/posthog/internal/PostHogQueueTest.kt +++ b/posthog/src/test/java/com/posthog/internal/PostHogQueueTest.kt @@ -32,6 +32,7 @@ import kotlin.test.AfterTest import kotlin.test.Test import kotlin.test.assertEquals import kotlin.test.assertNotNull +import kotlin.test.assertNull import kotlin.test.assertTrue internal class PostHogQueueTest { @@ -236,6 +237,30 @@ internal class PostHogQueueTest { assertEquals(0, http.requestCount) } + @Test + fun `reports a backed-up size only once the queue reaches flushAt`() { + val http = mockHttp() + val sut = + getSut( + host = http.url("/").toString(), + flushAt = 2, + networkStatus = + object : PostHogNetworkStatus { + override fun isConnected() = false + }, + ) + + assertNull(sut.backedUpSize) + + sut.add(generateEvent()) + awaitQueue() + assertNull(sut.backedUpSize) + + sut.add(generateEvent()) + awaitQueue() + assertEquals(2, sut.backedUpSize) + } + @Test fun `does not flush if not connected but try to flush again`() { val http = mockHttp()