From 573de1c16896cea00fe34eff118bb33a4f8b0f56 Mon Sep 17 00:00:00 2001
From: Benoit Marty <benoit@matrix.org>
Date: Tue, 20 Jun 2023 15:26:16 +0200
Subject: [PATCH] Improve rendering of cache size (and fix compilation issue)

---
 features/messages/impl/build.gradle.kts               |  2 +-
 features/preferences/impl/build.gradle.kts            |  1 +
 .../impl/developer/DeveloperSettingsPresenter.kt      |  6 +++---
 .../impl/developer/DeveloperSettingsState.kt          |  2 +-
 .../impl/developer/DeveloperSettingsStateProvider.kt  |  2 +-
 .../impl/developer/DeveloperSettingsView.kt           |  8 +++-----
 .../preferences/impl/tasks/ComputeCacheSizeUseCase.kt | 11 +++++++----
 .../impl/developer/DeveloperSettingsPresenterTest.kt  |  2 +-
 .../androidtools/impl/AndroidFileSizeFormatter.kt     |  4 +++-
 .../main/kotlin/extension/DependencyHandleScope.kt    |  1 +
 10 files changed, 22 insertions(+), 17 deletions(-)

diff --git a/features/messages/impl/build.gradle.kts b/features/messages/impl/build.gradle.kts
index 73360a0a25..882c226b6b 100644
--- a/features/messages/impl/build.gradle.kts
+++ b/features/messages/impl/build.gradle.kts
@@ -34,7 +34,7 @@ dependencies {
     anvil(projects.anvilcodegen)
     api(projects.features.messages.api)
     implementation(projects.libraries.androidutils)
-    implementation(projects.libraries.androidtools.api)
+    api(projects.libraries.androidtools.api)
     implementation(projects.libraries.core)
     implementation(projects.libraries.architecture)
     implementation(projects.libraries.matrix.api)
diff --git a/features/preferences/impl/build.gradle.kts b/features/preferences/impl/build.gradle.kts
index e0ecbe9ddd..bb55094347 100644
--- a/features/preferences/impl/build.gradle.kts
+++ b/features/preferences/impl/build.gradle.kts
@@ -33,6 +33,7 @@ dependencies {
     implementation(projects.anvilannotations)
     anvil(projects.anvilcodegen)
     implementation(projects.libraries.androidutils)
+    api(projects.libraries.androidtools.api)
     implementation(projects.libraries.core)
     implementation(projects.libraries.architecture)
     implementation(projects.libraries.matrix.api)
diff --git a/features/preferences/impl/src/main/kotlin/io/element/android/features/preferences/impl/developer/DeveloperSettingsPresenter.kt b/features/preferences/impl/src/main/kotlin/io/element/android/features/preferences/impl/developer/DeveloperSettingsPresenter.kt
index ffcbb92ba9..08a787e998 100644
--- a/features/preferences/impl/src/main/kotlin/io/element/android/features/preferences/impl/developer/DeveloperSettingsPresenter.kt
+++ b/features/preferences/impl/src/main/kotlin/io/element/android/features/preferences/impl/developer/DeveloperSettingsPresenter.kt
@@ -56,7 +56,7 @@ class DeveloperSettingsPresenter @Inject constructor(
             mutableStateMapOf<String, Boolean>()
         }
         val cacheSize = remember {
-            mutableStateOf<Async<Long>>(Async.Uninitialized)
+            mutableStateOf<Async<String>>(Async.Uninitialized)
         }
         val clearCacheAction = remember {
             mutableStateOf<Async<Unit>>(Async.Uninitialized)
@@ -88,7 +88,7 @@ class DeveloperSettingsPresenter @Inject constructor(
 
         return DeveloperSettingsState(
             features = featureUiModels.toImmutableList(),
-            cacheSizeInBytes = cacheSize.value,
+            cacheSize = cacheSize.value,
             clearCacheAction = clearCacheAction.value,
             eventSink = ::handleEvents
         )
@@ -125,7 +125,7 @@ class DeveloperSettingsPresenter @Inject constructor(
         }
     }
 
-    private fun CoroutineScope.computeCacheSize(cacheSize: MutableState<Async<Long>>) = launch {
+    private fun CoroutineScope.computeCacheSize(cacheSize: MutableState<Async<String>>) = launch {
         suspend {
             computeCacheSizeUseCase.execute()
         }.execute(cacheSize)
diff --git a/features/preferences/impl/src/main/kotlin/io/element/android/features/preferences/impl/developer/DeveloperSettingsState.kt b/features/preferences/impl/src/main/kotlin/io/element/android/features/preferences/impl/developer/DeveloperSettingsState.kt
index 7d9bfed714..61205e7f7d 100644
--- a/features/preferences/impl/src/main/kotlin/io/element/android/features/preferences/impl/developer/DeveloperSettingsState.kt
+++ b/features/preferences/impl/src/main/kotlin/io/element/android/features/preferences/impl/developer/DeveloperSettingsState.kt
@@ -22,7 +22,7 @@ import kotlinx.collections.immutable.ImmutableList
 
 data class DeveloperSettingsState constructor(
     val features: ImmutableList<FeatureUiModel>,
-    val cacheSizeInBytes: Async<Long>,
+    val cacheSize: Async<String>,
     val clearCacheAction: Async<Unit>,
     val eventSink: (DeveloperSettingsEvents) -> Unit
 )
diff --git a/features/preferences/impl/src/main/kotlin/io/element/android/features/preferences/impl/developer/DeveloperSettingsStateProvider.kt b/features/preferences/impl/src/main/kotlin/io/element/android/features/preferences/impl/developer/DeveloperSettingsStateProvider.kt
index 92fb248142..de94bd6664 100644
--- a/features/preferences/impl/src/main/kotlin/io/element/android/features/preferences/impl/developer/DeveloperSettingsStateProvider.kt
+++ b/features/preferences/impl/src/main/kotlin/io/element/android/features/preferences/impl/developer/DeveloperSettingsStateProvider.kt
@@ -30,7 +30,7 @@ open class DeveloperSettingsStateProvider : PreviewParameterProvider<DeveloperSe
 
 fun aDeveloperSettingsState() = DeveloperSettingsState(
     features = aFeatureUiModelList(),
-    cacheSizeInBytes = Async.Success(0L),
+    cacheSize = Async.Success("1.2 MB"),
     clearCacheAction = Async.Uninitialized,
     eventSink = {}
 )
diff --git a/features/preferences/impl/src/main/kotlin/io/element/android/features/preferences/impl/developer/DeveloperSettingsView.kt b/features/preferences/impl/src/main/kotlin/io/element/android/features/preferences/impl/developer/DeveloperSettingsView.kt
index 2ac9572029..027b3cfd1d 100644
--- a/features/preferences/impl/src/main/kotlin/io/element/android/features/preferences/impl/developer/DeveloperSettingsView.kt
+++ b/features/preferences/impl/src/main/kotlin/io/element/android/features/preferences/impl/developer/DeveloperSettingsView.kt
@@ -56,15 +56,13 @@ fun DeveloperSettingsView(
                 onClick = onOpenShowkase
             )
         }
-        val cache = state.cacheSizeInBytes
+        val cache = state.cacheSize
         PreferenceCategory(title = "Cache") {
             PreferenceText(
                 title = "Clear cache",
                 icon = Icons.Default.Delete,
-                currentValue = if (cache is Async.Success) {
-                    "${cache.state} bytes"
-                } else null,
-                loadingCurrentValue = state.cacheSizeInBytes.isLoading() || state.clearCacheAction.isLoading(),
+                currentValue = cache.dataOrNull(),
+                loadingCurrentValue = state.cacheSize.isLoading() || state.clearCacheAction.isLoading(),
                 onClick = {
                     if (state.clearCacheAction.isLoading().not()) {
                         state.eventSink(DeveloperSettingsEvents.ClearCache)
diff --git a/features/preferences/impl/src/main/kotlin/io/element/android/features/preferences/impl/tasks/ComputeCacheSizeUseCase.kt b/features/preferences/impl/src/main/kotlin/io/element/android/features/preferences/impl/tasks/ComputeCacheSizeUseCase.kt
index 42174ff61d..9da6909e5f 100644
--- a/features/preferences/impl/src/main/kotlin/io/element/android/features/preferences/impl/tasks/ComputeCacheSizeUseCase.kt
+++ b/features/preferences/impl/src/main/kotlin/io/element/android/features/preferences/impl/tasks/ComputeCacheSizeUseCase.kt
@@ -18,6 +18,7 @@ package io.element.android.features.preferences.impl.tasks
 
 import android.content.Context
 import com.squareup.anvil.annotations.ContributesBinding
+import io.element.android.libraries.androidtools.api.FileSizeFormatter
 import io.element.android.libraries.androidutils.file.getSizeOfFiles
 import io.element.android.libraries.core.coroutine.CoroutineDispatchers
 import io.element.android.libraries.di.ApplicationContext
@@ -27,7 +28,7 @@ import kotlinx.coroutines.withContext
 import javax.inject.Inject
 
 interface ComputeCacheSizeUseCase {
-    suspend fun execute(): Long
+    suspend fun execute(): String
 }
 
 @ContributesBinding(SessionScope::class)
@@ -35,11 +36,13 @@ class DefaultComputeCacheSizeUseCase @Inject constructor(
     @ApplicationContext private val context: Context,
     private val matrixClient: MatrixClient,
     private val coroutineDispatchers: CoroutineDispatchers,
+    private val fileSizeFormatter: FileSizeFormatter,
 ) : ComputeCacheSizeUseCase {
-    override suspend fun execute(): Long = withContext(coroutineDispatchers.io) {
+    override suspend fun execute(): String = withContext(coroutineDispatchers.io) {
         var cumulativeSize = 0L
         cumulativeSize += matrixClient.getCacheSize()
-        cumulativeSize += context.cacheDir.getSizeOfFiles()
-        cumulativeSize
+        // - 4096 to not include the size fo the folder
+        cumulativeSize += (context.cacheDir.getSizeOfFiles() - 4096).coerceAtLeast(0)
+        fileSizeFormatter.format(cumulativeSize)
     }
 }
diff --git a/features/preferences/impl/src/test/kotlin/io/element/android/features/preferences/impl/developer/DeveloperSettingsPresenterTest.kt b/features/preferences/impl/src/test/kotlin/io/element/android/features/preferences/impl/developer/DeveloperSettingsPresenterTest.kt
index 6ed831b0db..226140647d 100644
--- a/features/preferences/impl/src/test/kotlin/io/element/android/features/preferences/impl/developer/DeveloperSettingsPresenterTest.kt
+++ b/features/preferences/impl/src/test/kotlin/io/element/android/features/preferences/impl/developer/DeveloperSettingsPresenterTest.kt
@@ -42,7 +42,7 @@ class DeveloperSettingsPresenterTest {
             val initialState = awaitItem()
             assertThat(initialState.features).isEmpty()
             assertThat(initialState.clearCacheAction).isEqualTo(Async.Uninitialized)
-            assertThat(initialState.cacheSizeInBytes).isEqualTo(Async.Uninitialized)
+            assertThat(initialState.cacheSize).isEqualTo(Async.Uninitialized)
             cancelAndIgnoreRemainingEvents()
         }
     }
diff --git a/libraries/androidtools/impl/src/main/kotlin/io/element/android/libraries/androidtools/impl/AndroidFileSizeFormatter.kt b/libraries/androidtools/impl/src/main/kotlin/io/element/android/libraries/androidtools/impl/AndroidFileSizeFormatter.kt
index fe156f1635..1437c15ed5 100644
--- a/libraries/androidtools/impl/src/main/kotlin/io/element/android/libraries/androidtools/impl/AndroidFileSizeFormatter.kt
+++ b/libraries/androidtools/impl/src/main/kotlin/io/element/android/libraries/androidtools/impl/AndroidFileSizeFormatter.kt
@@ -26,7 +26,9 @@ import io.element.android.libraries.di.ApplicationContext
 import javax.inject.Inject
 
 @ContributesBinding(AppScope::class)
-class AndroidFileSizeFormatter @Inject constructor(@ApplicationContext private val context: Context) : FileSizeFormatter {
+class AndroidFileSizeFormatter @Inject constructor(
+    @ApplicationContext private val context: Context,
+    ) : FileSizeFormatter {
     override fun format(fileSize: Long, useShortFormat: Boolean): String {
         // Since Android O, the system considers that 1ko = 1000 bytes instead of 1024 bytes.
         // We want to avoid that.
diff --git a/plugins/src/main/kotlin/extension/DependencyHandleScope.kt b/plugins/src/main/kotlin/extension/DependencyHandleScope.kt
index 88f499b993..47bdabcbcd 100644
--- a/plugins/src/main/kotlin/extension/DependencyHandleScope.kt
+++ b/plugins/src/main/kotlin/extension/DependencyHandleScope.kt
@@ -77,6 +77,7 @@ private fun DependencyHandlerScope.addImplementationProjects(
 fun DependencyHandlerScope.allLibrariesImpl() {
     implementation(project(":libraries:androidutils"))
     implementation(project(":libraries:deeplink"))
+    implementation(project(":libraries:androidtools:impl"))
     implementation(project(":libraries:designsystem"))
     implementation(project(":libraries:matrix:impl"))
     implementation(project(":libraries:matrixui"))