Add AnalyticsService.cancelLongRunningTransaction and AnalyticsService.finishLongRunningTransaction

2025-11-27 12:27:49 +01:00
parent 884c547123
commit 29117ce93d
7 changed files with 37 additions and 9 deletions
--- a/appnav/src/main/kotlin/io/element/android/appnav/room/joined/JoinedRoomLoadedFlowNode.kt
+++ b/appnav/src/main/kotlin/io/element/android/appnav/room/joined/JoinedRoomLoadedFlowNode.kt
@@ -49,6 +49,7 @@ import io.element.android.services.analytics.api.AnalyticsLongRunningTransaction
 import io.element.android.services.analytics.api.AnalyticsLongRunningTransaction.LoadMessagesUi
 import io.element.android.services.analytics.api.AnalyticsLongRunningTransaction.OpenRoom
 import io.element.android.services.analytics.api.AnalyticsService
+import io.element.android.services.analytics.api.finishLongRunningTransaction
 import io.element.android.services.appnavstate.api.ActiveRoomsHolder
 import io.element.android.services.appnavstate.api.AppNavigationStateService
 import kotlinx.coroutines.CoroutineScope
@@ -107,7 +108,7 @@ class JoinedRoomLoadedFlowNode(
                trackVisitedRoom()
            },
            onResume = {
-                analyticsService.removeLongRunningTransaction(LoadJoinedRoomFlow)?.finish()
+                analyticsService.finishLongRunningTransaction(LoadJoinedRoomFlow)
                sessionCoroutineScope.launch {
                    inputs.room.subscribeToSync()
                }
--- a/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/MessagesNode.kt
+++ b/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/MessagesNode.kt
@@ -70,6 +70,7 @@ import io.element.android.libraries.mediaplayer.api.MediaPlayer
 import io.element.android.libraries.ui.strings.CommonStrings
 import io.element.android.services.analytics.api.AnalyticsLongRunningTransaction.LoadMessagesUi
 import io.element.android.services.analytics.api.AnalyticsService
+import io.element.android.services.analytics.api.finishLongRunningTransaction
 import kotlinx.collections.immutable.ImmutableList
 import kotlinx.collections.immutable.toImmutableList
 import kotlinx.coroutines.CoroutineScope
@@ -138,7 +139,7 @@ class MessagesNode(
                sessionCoroutineScope.launch { analyticsService.capture(room.toAnalyticsViewRoom()) }
            },
            onResume = {
-                analyticsService.removeLongRunningTransaction(LoadMessagesUi)?.finish()
+                analyticsService.finishLongRunningTransaction(LoadMessagesUi)
            },
            onDestroy = {
                mediaPlayer.close()
--- a/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/timeline/TimelinePresenter.kt
+++ b/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/timeline/TimelinePresenter.kt
@@ -59,6 +59,7 @@ import io.element.android.services.analytics.api.AnalyticsLongRunningTransaction
 import io.element.android.services.analytics.api.AnalyticsLongRunningTransaction.NotificationTapOpensTimeline
 import io.element.android.services.analytics.api.AnalyticsLongRunningTransaction.OpenRoom
 import io.element.android.services.analytics.api.AnalyticsService
+import io.element.android.services.analytics.api.finishLongRunningTransaction
 import kotlinx.collections.immutable.ImmutableList
 import kotlinx.collections.immutable.persistentListOf
 import kotlinx.coroutines.CoroutineScope
@@ -239,9 +240,9 @@ class TimelinePresenter(
                    timelineItems = newTimelineItems

                    analyticsService.run {
-                        removeLongRunningTransaction(DisplayFirstTimelineItems)?.finish()
-                        removeLongRunningTransaction(OpenRoom)?.finish()
-                        removeLongRunningTransaction(NotificationTapOpensTimeline)?.finish()
+                        finishLongRunningTransaction(DisplayFirstTimelineItems)
+                        finishLongRunningTransaction(OpenRoom)
+                        finishLongRunningTransaction(NotificationTapOpensTimeline)
                    }
                }
                .launchIn(this)
--- a/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/roomlist/RoomListFactory.kt
+++ b/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/roomlist/RoomListFactory.kt
@@ -14,6 +14,7 @@ import io.element.android.libraries.matrix.api.roomlist.RoomListFilter
 import io.element.android.libraries.matrix.api.roomlist.RoomSummary
 import io.element.android.services.analytics.api.AnalyticsLongRunningTransaction
 import io.element.android.services.analytics.api.AnalyticsService
+import io.element.android.services.analytics.api.finishLongRunningTransaction
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.flow.MutableSharedFlow
 import kotlinx.coroutines.flow.MutableStateFlow
@@ -73,7 +74,7 @@ internal class RoomListFactory(
                    initialFilterKind = RoomListEntriesDynamicFilterKind.All(ROOM_LIST_RUST_FILTERS),
                ).onEach { update ->
                    if (!firstRoomsTransaction.isFinished()) {
-                        analyticsService.removeLongRunningTransaction(AnalyticsLongRunningTransaction.FirstRoomsDisplayed)?.finish()
+                        analyticsService.finishLongRunningTransaction(AnalyticsLongRunningTransaction.FirstRoomsDisplayed)
                        firstRoomsTransaction.finish()
                    }
                    processor.postUpdate(update)
--- a/services/analytics/api/src/main/kotlin/io/element/android/services/analytics/api/AnalyticsService.kt
+++ b/services/analytics/api/src/main/kotlin/io/element/android/services/analytics/api/AnalyticsService.kt
@@ -89,3 +89,24 @@ inline fun <T> AnalyticsService.recordTransaction(
        transaction.finish()
    }
 }
+
+/**
+ * Cancels a long running transaction. It behaves the same as [AnalyticsService.removeLongRunningTransaction],
+ * but it doesn't return the transaction so we can't finish it later.
+ */
+fun AnalyticsService.cancelLongRunningTransaction(
+    longRunningTransaction: AnalyticsLongRunningTransaction
+) = removeLongRunningTransaction(longRunningTransaction)
+
+/**
+ * Finishes a long running transaction if it exists. Optionally performs an [action] with the transaction before finishing it.
+ */
+fun AnalyticsService.finishLongRunningTransaction(
+    longRunningTransaction: AnalyticsLongRunningTransaction,
+    action: (AnalyticsTransaction) -> Unit = {},
+) {
+    removeLongRunningTransaction(longRunningTransaction)?.let {
+        action(it)
+        it.finish()
+    }
+}
--- a/services/analytics/impl/src/main/kotlin/io/element/android/services/analytics/impl/watchers/DefaultAnalyticsColdStartWatcher.kt
+++ b/services/analytics/impl/src/main/kotlin/io/element/android/services/analytics/impl/watchers/DefaultAnalyticsColdStartWatcher.kt
@@ -13,6 +13,8 @@ import dev.zacsweers.metro.SingleIn
 import io.element.android.libraries.di.annotations.AppCoroutineScope
 import io.element.android.services.analytics.api.AnalyticsLongRunningTransaction
 import io.element.android.services.analytics.api.AnalyticsService
+import io.element.android.services.analytics.api.cancelLongRunningTransaction
+import io.element.android.services.analytics.api.finishLongRunningTransaction
 import io.element.android.services.analytics.api.watchers.AnalyticsColdStartWatcher
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.flow.catch
@@ -47,7 +49,7 @@ class DefaultAnalyticsColdStartWatcher(

    override fun whenLoggingIn() {
        if (isColdStart.getAndSet(false)) {
-            analyticsService.removeLongRunningTransaction(AnalyticsLongRunningTransaction.ColdStartUntilCachedRoomList)
+            analyticsService.cancelLongRunningTransaction(AnalyticsLongRunningTransaction.ColdStartUntilCachedRoomList)
            Timber.d("Canceled cold start check: user is logging in")
        }
    }
@@ -55,7 +57,7 @@ class DefaultAnalyticsColdStartWatcher(
    override fun onRoomListVisible() {
        if (isColdStart.getAndSet(false)) {
            Timber.d("Room list is visible, finishing cold start check")
-            analyticsService.removeLongRunningTransaction(AnalyticsLongRunningTransaction.ColdStartUntilCachedRoomList)?.finish()
+            analyticsService.finishLongRunningTransaction(AnalyticsLongRunningTransaction.ColdStartUntilCachedRoomList)
        }
    }
 }
--- a/services/analytics/impl/src/main/kotlin/io/element/android/services/analytics/impl/watchers/DefaultAnalyticsRoomListStateWatcher.kt
+++ b/services/analytics/impl/src/main/kotlin/io/element/android/services/analytics/impl/watchers/DefaultAnalyticsRoomListStateWatcher.kt
@@ -16,6 +16,7 @@ import io.element.android.libraries.di.annotations.SessionCoroutineScope
 import io.element.android.libraries.matrix.api.roomlist.RoomListService
 import io.element.android.services.analytics.api.AnalyticsLongRunningTransaction
 import io.element.android.services.analytics.api.AnalyticsService
+import io.element.android.services.analytics.api.finishLongRunningTransaction
 import io.element.android.services.analytics.api.watchers.AnalyticsRoomListStateWatcher
 import io.element.android.services.appnavstate.api.AppNavigationStateService
 import kotlinx.coroutines.CoroutineScope
@@ -63,7 +64,7 @@ class DefaultAnalyticsRoomListStateWatcher(
        roomListService.state
            .onEach { state ->
                if (state == RoomListService.State.Running && isWarmState.get()) {
-                    analyticsService.removeLongRunningTransaction(AnalyticsLongRunningTransaction.ResumeAppUntilNewRoomsReceived)?.finish()
+                    analyticsService.finishLongRunningTransaction(AnalyticsLongRunningTransaction.ResumeAppUntilNewRoomsReceived)
                }
            }
            .launchIn(coroutineScope)