fix: empty balance flash on restore

Author: ovitrif

app/src/main/java/to/bitkit/repositories/BackupRepo.kt

@@ -301,7 +301,7 @@ class BackupRepo @Inject constructor(
                 type = Toast.ToastType.ERROR,
                 title = context.getString(R.string.settings__backup__failed_title),
                 description = context.getString(R.string.settings__backup__failed_message).formatPlural(
-                    mapOf("interval" to (BACKUP_CHECK_INTERVAL / 60_000)) // displayed in minutes
+                    mapOf("interval" to (BACKUP_CHECK_INTERVAL / MINUTE_IN_MS)) // displayed in minutes
                 ),
             )
         }
@@ -396,12 +396,22 @@ class BackupRepo @Inject constructor(
         BackupCategory.LIGHTNING_CONNECTIONS -> throw NotImplementedError("LIGHTNING backup is managed by ldk-node")
     }
 
-    suspend fun performFullRestoreFromLatestBackup(): Result<Unit> = withContext(ioDispatcher) {
+    suspend fun performFullRestoreFromLatestBackup(
+        onCacheRestored: suspend () -> Unit = {},
+    ): Result<Unit> = withContext(ioDispatcher) {
         Logger.debug("Full restore starting", context = TAG)
 
         isRestoring = true
 
         return@withContext try {
+            performRestore(BackupCategory.METADATA) { dataBytes ->
+                val parsed = json.decodeFromString<MetadataBackupV1>(String(dataBytes))
+                db.tagMetadataDao().upsert(parsed.tagMetadata)
+                cacheStore.update { parsed.cache }
+                onCacheRestored()
+                Logger.debug("Restored caches and ${parsed.tagMetadata.size} tags metadata records", TAG)
+            }
+
             performRestore(BackupCategory.SETTINGS) { dataBytes ->
                 val parsed = json.decodeFromString<SettingsData>(String(dataBytes)).resetPin()
                 settingsStore.update { parsed }
@@ -415,12 +425,6 @@ class BackupRepo @Inject constructor(
                 db.transferDao().upsert(parsed.transfers)
                 Logger.debug("Restored ${parsed.transfers.size} transfers", context = TAG)
             }
-            performRestore(BackupCategory.METADATA) { dataBytes ->
-                val parsed = json.decodeFromString<MetadataBackupV1>(String(dataBytes))
-                db.tagMetadataDao().upsert(parsed.tagMetadata)
-                cacheStore.update { parsed.cache }
-                Logger.debug("Restored caches and ${parsed.tagMetadata.size} tags metadata records", TAG)
-            }
             performRestore(BackupCategory.BLOCKTANK) { dataBytes ->
                 val parsed = json.decodeFromString<BlocktankBackupV1>(String(dataBytes))
                 blocktankRepo.restoreFromBackup(parsed).onSuccess {
@@ -485,6 +489,7 @@ class BackupRepo @Inject constructor(
     companion object {
         private const val TAG = "BackupRepo"
 
+        private const val MINUTE_IN_MS = 60_000
         private const val BACKUP_DEBOUNCE = 5000L // 5 seconds
         private const val BACKUP_CHECK_INTERVAL = 60 * 1000L // 1 minute
         private const val FAILED_BACKUP_CHECK_TIME = 30 * 60 * 1000L // 30 minutes

app/src/main/java/to/bitkit/repositories/WalletRepo.kt

@@ -62,11 +62,6 @@ class WalletRepo @Inject constructor(
     private val _balanceState = MutableStateFlow(BalanceState())
     val balanceState = _balanceState.asStateFlow()
 
-    init {
-        // Load from cache once on init
-        loadFromCache()
-    }
-
     fun loadFromCache() {
         // TODO try keeping in sync with cache if performant and reliable
         repoScope.launch {

app/src/main/java/to/bitkit/viewmodels/WalletViewModel.kt

@@ -69,6 +69,9 @@ class WalletViewModel @Inject constructor(
     private fun walletEffect(effect: WalletViewModelEffects) = viewModelScope.launch { _walletEffect.emit(effect) }
 
     init {
+        if (walletExists) {
+            walletRepo.loadFromCache()
+        }
         collectStates()
     }
 
@@ -110,7 +113,7 @@ class WalletViewModel @Inject constructor(
 
     private suspend fun restoreFromBackup() {
         restoreState = RestoreState.RestoringBackups
-        backupRepo.performFullRestoreFromLatestBackup()
+        backupRepo.performFullRestoreFromLatestBackup(onCacheRestored = walletRepo::loadFromCache)
         // data backup is not critical and mostly for user convenience so there is no reason to propagate errors up
         restoreState = RestoreState.BackupRestoreCompleted
     }

app/src/test/java/to/bitkit/repositories/WalletRepoTest.kt

@@ -48,6 +48,7 @@ class WalletRepoTest : BaseUnitTest() {
     private val cacheStore: CacheStore = mock()
     private val deriveBalanceStateUseCase: DeriveBalanceStateUseCase = mock()
     private val vssStoreIdProvider = mock<VssStoreIdProvider>()
+    private val backupRepo = mock<BackupRepo>()
 
     @Before
     fun setUp() {
@@ -78,6 +79,7 @@ class WalletRepoTest : BaseUnitTest() {
         cacheStore = cacheStore,
         deriveBalanceStateUseCase = deriveBalanceStateUseCase,
         vssStoreIdProvider = vssStoreIdProvider,
+        backupRepo = backupRepo,
     )
 
     @Test
@@ -196,6 +198,7 @@ class WalletRepoTest : BaseUnitTest() {
         whenever(cacheStore.data).thenReturn(flowOf(AppCacheData(onchainAddress = existingAddress)))
         whenever(addressChecker.getAddressInfo(any())).thenReturn(mockAddressInfo())
         sut = createSut()
+        sut.loadFromCache()
 
         val result = sut.refreshBip21()
 
@@ -266,6 +269,7 @@ class WalletRepoTest : BaseUnitTest() {
         whenever(cacheStore.data).thenReturn(flowOf(AppCacheData(onchainAddress = testAddress)))
         whenever(lightningRepo.createInvoice(anyOrNull(), any(), any())).thenReturn(Result.success("testInvoice"))
         sut = createSut()
+        sut.loadFromCache()
 
         sut.updateBip21Invoice(amountSats = 1000uL, description = "test").let { result ->
             assertTrue(result.isSuccess)
@@ -524,6 +528,7 @@ class WalletRepoTest : BaseUnitTest() {
         val testAddress = "testAddress"
         whenever(cacheStore.data).thenReturn(flowOf(AppCacheData(onchainAddress = testAddress)))
         sut = createSut()
+        sut.loadFromCache()
         sut.setBolt11("existingInvoice")
         whenever(lightningRepo.canReceive()).thenReturn(false)
 
@@ -570,6 +575,7 @@ class WalletRepoTest : BaseUnitTest() {
         )
         whenever(lightningRepo.newAddress()).thenReturn(Result.success("newAddress"))
         sut = createSut()
+        sut.loadFromCache()
 
         sut.refreshBip21ForEvent(
             Event.PaymentReceived(
@@ -589,6 +595,7 @@ class WalletRepoTest : BaseUnitTest() {
         whenever(cacheStore.data).thenReturn(flowOf(AppCacheData(onchainAddress = testAddress)))
         whenever(addressChecker.getAddressInfo(any())).thenReturn(mockAddressInfo())
         sut = createSut()
+        sut.loadFromCache()
 
         sut.refreshBip21ForEvent(
             Event.PaymentReceived(