Added doc to the UseCases

wireapp · Feb 26, 2025 · 389894b · 389894b
1 parent fa3ef82
commit 389894b
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/...monMain/kotlin/com/wire/kalium/logic/feature/analytics/GetAnalyticsContactsDataUseCase.kt b/...monMain/kotlin/com/wire/kalium/logic/feature/analytics/GetAnalyticsContactsDataUseCase.kt
@@ -28,6 +28,10 @@ import com.wire.kalium.logic.data.sync.SlowSyncStatus
 import com.wire.kalium.logic.data.user.UserRepository
 import kotlinx.coroutines.flow.first
 
+/**
+ * Use case that combine contacts data necessary for analytics [AnalyticsContactsData].
+ * It always get a Cached data and, except case when there is no cache, in that case useCase selects all the data from DB.
+ */
 interface GetAnalyticsContactsDataUseCase {
     suspend operator fun invoke(): AnalyticsContactsData
 }
@@ -91,6 +95,10 @@ class GetAnalyticsContactsDataUseCaseImpl internal constructor(
 
 }
 
+/**
+ * If val is null mean it shouldn't be provided to the analytics.
+ * More details in task https://wearezeta.atlassian.net/browse/WPB-16121
+ */
 data class AnalyticsContactsData(
     val teamId: String?,
     val contactsSize: Int?,

diff --git a/...nMain/kotlin/com/wire/kalium/logic/feature/analytics/UpdateContactsAmountsCacheUseCase.kt b/...nMain/kotlin/com/wire/kalium/logic/feature/analytics/UpdateContactsAmountsCacheUseCase.kt
@@ -26,6 +26,10 @@ import kotlinx.coroutines.flow.first
 import kotlinx.datetime.Clock
 import kotlin.time.Duration.Companion.days
 
+/**
+ * Use case that checks if users ContactsAmount and TeamSize cache are too old and updates it.
+ * Currently max live period is [UpdateContactsAmountsCacheUseCaseImpl.CACHE_PERIOD] 7 days
+ */
 interface UpdateContactsAmountsCacheUseCase {
     suspend operator fun invoke()
 }