Include retry mechanism in multiple coroutines flow

Numerous streams of data in the Kotlin coroutines flow now have the retry operator included. This optimizes error handling by implementing automated retries upon encountering failures. The modification affects key parts of the code, such as PackageListViewModel, PackageSearchProjectService, and several viewModel modules related to UI and project services. (cherry picked from commit 7e2f7a5)
JetBrains · Jan 11, 2024 · 8fa6499 · 8fa6499
1 parent a05a2ea
commit 8fa6499
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 12 deletions.
diff --git a/...rc/main/kotlin/com/jetbrains/packagesearch/plugin/services/PackageSearchProjectService.kt b/...rc/main/kotlin/com/jetbrains/packagesearch/plugin/services/PackageSearchProjectService.kt
@@ -32,7 +32,6 @@ import kotlinx.coroutines.channels.Channel
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.SharingStarted
 import kotlinx.coroutines.flow.asFlow
-import kotlinx.coroutines.flow.catch
 import kotlinx.coroutines.flow.combine
 import kotlinx.coroutines.flow.consumeAsFlow
 import kotlinx.coroutines.flow.debounce
@@ -43,6 +42,8 @@ import kotlinx.coroutines.flow.flatMapMerge
 import kotlinx.coroutines.flow.launchIn
 import kotlinx.coroutines.flow.map
 import kotlinx.coroutines.flow.onEach
+import kotlinx.coroutines.flow.retry
+import kotlinx.coroutines.flow.retryWhen
 import kotlinx.coroutines.flow.shareIn
 import kotlinx.coroutines.flow.stateIn
 import kotlinx.coroutines.sync.Mutex
@@ -69,7 +70,12 @@ class PackageSearchProjectService(
             .apiPackageCache
             .getKnownRepositories()
             .associateBy { it.id }
-    }.stateIn(coroutineScope, SharingStarted.Eagerly, emptyMap())
+    }
+        .retry {
+            logWarn("${this::class.simpleName}#knownRepositoriesStateFlow", throwable = it)
+            true
+        }
+        .stateIn(coroutineScope, SharingStarted.Eagerly, emptyMap())
 
     override val knownRepositories: Map<String, ApiRepository>
         get() = knownRepositoriesStateFlow.value
@@ -114,20 +120,15 @@ class PackageSearchProjectService(
     private var counter = 0
     private val counterMutex = Mutex()
 
-    private suspend fun restartWithCounter() = counterMutex.withLock {
-        if (counter++ < 3) {
-            restart()
-        }
-    }
-
     private suspend fun resetCounter() = counterMutex.withLock { counter = 0 }
 
     val modulesStateFlow = restartFlow
         .withInitialValue(Unit)
         .flatMapLatest { moduleProvidersList }
-        .catch {
-            logWarn("${this::class.simpleName}#modulesStateFlow", throwable = it)
-            restartWithCounter()
+        .retryWhen { cause, attempt ->
+            logWarn("${this::class.simpleName}#modulesStateFlow", throwable = cause)
+            restart()
+            attempt < 3
         }
         .onEach { resetCounter() }
         .stateIn(coroutineScope, SharingStarted.Eagerly, emptyList())
@@ -144,12 +145,20 @@ class PackageSearchProjectService(
 
         stableOnlyStateFlow
             .onEach { logOnlyStableToggle(it) }
+            .retry {
+                logWarn("${this::class.simpleName}#stableOnlyStateFlow", throwable = it)
+                true
+            }
             .launchIn(coroutineScope)
 
         IntelliJApplication.PackageSearchApplicationCachesService
             .isOnlineFlow
             .filter { it }
             .onEach { restart() }
+            .retry {
+                logWarn("${this::class.simpleName}#isOnlineFlow", throwable = it)
+                true
+            }
             .launchIn(coroutineScope)
 
         combine(
@@ -169,6 +178,10 @@ class PackageSearchProjectService(
                         ?.let { DaemonCodeAnalyzer.getInstance(project).restart(it) }
                 }
             }
+            .retry {
+                logWarn("${this::class.simpleName}#fileOpenedFlow", throwable = it)
+                true
+            }
             .launchIn(coroutineScope)
     }
 

diff --git a/plugin/src/main/kotlin/com/jetbrains/packagesearch/plugin/ui/model/ToolWindowViewModel.kt b/plugin/src/main/kotlin/com/jetbrains/packagesearch/plugin/ui/model/ToolWindowViewModel.kt
@@ -19,6 +19,7 @@ import kotlinx.coroutines.flow.SharingStarted
 import kotlinx.coroutines.flow.combine
 import kotlinx.coroutines.flow.debounce
 import kotlinx.coroutines.flow.map
+import kotlinx.coroutines.flow.retry
 import kotlinx.coroutines.flow.stateIn
 import org.jetbrains.compose.splitpane.SplitPaneState
 
@@ -76,6 +77,7 @@ class ToolWindowViewModel(project: Project, private val viewModelScope: Coroutin
             else -> PackageSearchToolWindowState.NoModules
         }
     }
+        .retry()
         .stateIn(
             scope = viewModelScope,
             started = SharingStarted.Lazily,

diff --git a/...c/main/kotlin/com/jetbrains/packagesearch/plugin/ui/model/infopanel/InfoPanelViewModel.kt b/...c/main/kotlin/com/jetbrains/packagesearch/plugin/ui/model/infopanel/InfoPanelViewModel.kt
@@ -23,6 +23,7 @@ import kotlinx.coroutines.flow.launchIn
 import kotlinx.coroutines.flow.map
 import kotlinx.coroutines.flow.mapNotNull
 import kotlinx.coroutines.flow.onEach
+import kotlinx.coroutines.flow.retry
 import kotlinx.coroutines.flow.stateIn
 import org.jetbrains.packagesearch.api.v3.ApiPackage
 
@@ -73,6 +74,7 @@ class InfoPanelViewModel(
             }
         }
     }
+        .retry()
         .stateIn(viewModelScope, SharingStarted.Eagerly, emptyList())
 
     private val activeTabTitleMutableStateFlow: MutableStateFlow<String?> = MutableStateFlow(null)

diff --git a/...n/kotlin/com/jetbrains/packagesearch/plugin/ui/model/packageslist/PackageListViewModel.kt b/...n/kotlin/com/jetbrains/packagesearch/plugin/ui/model/packageslist/PackageListViewModel.kt
@@ -54,6 +54,7 @@ import kotlinx.coroutines.flow.launchIn
 import kotlinx.coroutines.flow.map
 import kotlinx.coroutines.flow.mapLatest
 import kotlinx.coroutines.flow.onEach
+import kotlinx.coroutines.flow.retry
 import kotlinx.coroutines.flow.shareIn
 import kotlinx.coroutines.flow.stateIn
 import kotlinx.coroutines.flow.update
@@ -165,14 +166,16 @@ class PackageListViewModel(
                     else -> value
                 }
             }
-        }.modifiedBy(selectedModulesFlow) { current: Map<PackageListItem.Header.Id.Remote, Search>, change ->
+        }
+        .modifiedBy(selectedModulesFlow) { current: Map<PackageListItem.Header.Id.Remote, Search>, change ->
             val changeIdentities = change.map { it.identity }
             if (current.keys.any { it.moduleIdentity !in changeIdentities }) {
                 emptyMap()
             } else {
                 current
             }
         }
+        .retry()
         .stateIn(viewModelScope, SharingStarted.Eagerly, emptyMap())
 
     val selectableLazyListState = SelectableLazyListState(LazyListState())
@@ -204,6 +207,7 @@ class PackageListViewModel(
                     }
                 }
             }
+            .retry()
             .stateIn(viewModelScope, SharingStarted.Eagerly, emptyList())
 
     private suspend fun PackageSearchModule.Base.getSearchQuery(

diff --git a/plugin/src/main/kotlin/com/jetbrains/packagesearch/plugin/ui/model/tree/TreeViewModel.kt b/plugin/src/main/kotlin/com/jetbrains/packagesearch/plugin/ui/model/tree/TreeViewModel.kt
@@ -11,6 +11,7 @@ import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.flow.SharingStarted
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.combine
+import kotlinx.coroutines.flow.retry
 import kotlinx.coroutines.flow.stateIn
 import org.jetbrains.jewel.foundation.lazy.SelectableLazyListState
 import org.jetbrains.jewel.foundation.lazy.tree.Tree
@@ -29,6 +30,7 @@ internal class TreeViewModel(
     ) { modules, stableOnly ->
         modules.asTree(stableOnly)
     }
+        .retry()
         .stateIn(viewModelScope, SharingStarted.Lazily, emptyTree())
 
     internal val lazyListState = LazyListState()