232 - Implement error handling for search, added log debugging for se…

…arch caches. (#54)

* Implement error handling for package search, better debugging for search caches.

Added new functionality to handle search errors during package search, allowing users to retry the search. Included visual error representation in the UI with a retry link. The search can now also be retried programmatically if it fails.

* Allow search error message to be collapsed.

plugin/core/src/main/kotlin/com/jetbrains/packagesearch/plugin/core/utils/Utils.kt

@@ -36,6 +36,7 @@ import com.jetbrains.packagesearch.plugin.core.data.PackageSearchDeclaredPackage
 import com.jetbrains.packagesearch.plugin.core.services.PackageSearchProjectCachesService
 import java.nio.file.Path
 import kotlin.contracts.contract
+import kotlin.coroutines.cancellation.CancellationException
 import kotlinx.coroutines.channels.ProducerScope
 import kotlinx.coroutines.channels.awaitClose
 import kotlinx.coroutines.flow.Flow
@@ -308,4 +309,6 @@ class ProjectDataImportListenerAdapter(private val project: Project) : ProjectDa
     override fun onFinalTasksFinished(projectPath: String?) {
         project.service<State>().value = false
     }
-}
+}
+
+fun <T> Result<T>.suspendSafe() = onFailure { if (it is CancellationException) throw it }

plugin/src/main/kotlin/com/jetbrains/packagesearch/plugin/ui/model/packageslist/PackageListBuilder.kt

@@ -278,24 +278,60 @@ class PackageListBuilder(
                     additionalContent = search.buildVariantsText()
                 )
 
-                is Search.Results.Base -> addFromSearchQueryBase(
+                is Search.Response.Base.Success -> addFromSearchQueryBase(
                     headerId = headerId as PackageListItem.Header.Id.Remote.Base,
                     search = search,
                     module = modulesMap[headerId.moduleIdentity] as? PackageSearchModule.Base ?: return@forEach
                 )
 
-                is Search.Results.WithVariants -> addFromSearchQueryWithVariants(
+                is Search.Response.WithVariants.Success -> addFromSearchQueryWithVariants(
                     headerId = headerId as PackageListItem.Header.Id.Remote.WithVariant,
                     search = search,
                     module = modulesMap[headerId.moduleIdentity] as? PackageSearchModule.WithVariants ?: return@forEach
                 )
+
+                is Search.Response.Base.Error -> addSearchResultError(headerId = headerId)
+
+                is Search.Response.WithVariants.Error -> addSearchResultError(
+                    headerId = headerId,
+                    attributes = search.attributes,
+                    additionalContent = search.buildVariantsText()
+                )
             }
         }
     }
 
+    private fun addSearchResultError(
+        headerId: PackageListItem.Header.Id.Remote,
+        attributes: List<String> = emptyList(),
+        additionalContent: PackageListItem.Header.AdditionalContent.VariantsText? = null,
+    ) {
+        val headerState = when (headerCollapsedStates[headerId]) {
+            TargetState.OPEN -> PackageListItem.Header.State.OPEN
+            else -> PackageListItem.Header.State.CLOSED
+        }
+        addHeader(
+            title = PackageSearchBundle.message("packagesearch.ui.toolwindow.tab.packages.searchResults"),
+            id = headerId,
+            state = headerState,
+            attributes = attributes,
+            additionalContent = additionalContent,
+        )
+        if (headerState == PackageListItem.Header.State.OPEN) {
+            items.add(
+                PackageListItem.SearchError(
+                    id = PackageListItem.SearchError.Id(
+                        headerId.moduleIdentity,
+                        headerId
+                    )
+                )
+            )
+        }
+    }
+
     private fun addFromSearchQueryWithVariants(
         headerId: PackageListItem.Header.Id.Remote.WithVariant,
-        search: Search.Results.WithVariants,
+        search: Search.Response.WithVariants.Success,
         module: PackageSearchModule.WithVariants,
     ) {
         val state = when (headerCollapsedStates[headerId]) {
@@ -347,7 +383,7 @@ class PackageListBuilder(
 
     private fun addFromSearchQueryBase(
         headerId: PackageListItem.Header.Id.Remote.Base,
-        search: Search.Results.Base,
+        search: Search.Response.Base.Success,
         module: PackageSearchModule.Base,
     ) {
         val state = when (headerCollapsedStates[headerId]) {

plugin/src/main/kotlin/com/jetbrains/packagesearch/plugin/ui/model/packageslist/PackageListItem.kt

@@ -6,7 +6,6 @@ import kotlinx.serialization.Serializable
 
 sealed interface PackageListItem {
 
-    val title: String
     val id: Id
 
     @Serializable
@@ -15,7 +14,7 @@ sealed interface PackageListItem {
     }
 
     data class Header(
-        override val title: String,
+        val title: String,
         override val id: Id,
         val state: State,
         val attributes: List<String> = emptyList(),
@@ -39,6 +38,7 @@ sealed interface PackageListItem {
             sealed interface Declared : Id {
                 @Serializable
                 data class Base(override val moduleIdentity: PackageSearchModule.Identity) : Declared
+
                 @Serializable
                 data class WithVariant(
                     override val moduleIdentity: PackageSearchModule.Identity,
@@ -49,8 +49,10 @@ sealed interface PackageListItem {
 
             @Serializable
             sealed interface Remote : Id {
+
                 @Serializable
                 data class Base(override val moduleIdentity: PackageSearchModule.Identity) : Remote
+
                 @Serializable
                 data class WithVariant(
                     override val moduleIdentity: PackageSearchModule.Identity,
@@ -63,6 +65,8 @@ sealed interface PackageListItem {
 
     sealed interface Package : PackageListItem {
 
+        val title: String
+
         @Serializable
         sealed interface Id : PackageListItem.Id {
             val packageId: String
@@ -121,7 +125,7 @@ sealed interface PackageListItem {
                     override val moduleIdentity: PackageSearchModule.Identity,
                     override val packageId: String,
                     val headerId: Header.Id.Remote.Base,
-                    ) : Remote.Id
+                ) : Remote.Id
             }
 
             data class WithVariant(
@@ -143,4 +147,14 @@ sealed interface PackageListItem {
             }
         }
     }
+
+    data class SearchError(override val id: Id) : PackageListItem {
+
+        @Serializable
+        data class Id(
+            override val moduleIdentity: PackageSearchModule.Identity,
+            val parentHeaderId: Header.Id,
+        ) : PackageListItem.Id
+    }
+
 }

plugin/src/main/kotlin/com/jetbrains/packagesearch/plugin/ui/model/packageslist/PackageListItemEvent.kt

@@ -115,4 +115,9 @@ sealed interface PackageListItemEvent {
         data class GoToSource(override val eventId: PackageListItem.Package.Declared.Id) : OnPackageAction
 
     }
+
+    @Serializable
+    data class OnRetryPackageSearch(
+        override val eventId: PackageListItem.SearchError.Id,
+    ) : PackageListItemEvent
 }

plugin/src/main/kotlin/com/jetbrains/packagesearch/plugin/ui/model/packageslist/PackageListViewModel.kt

@@ -13,6 +13,7 @@ import com.jetbrains.packagesearch.plugin.core.data.PackageSearchDependencyManag
 import com.jetbrains.packagesearch.plugin.core.data.PackageSearchModule
 import com.jetbrains.packagesearch.plugin.core.data.PackageSearchModuleEditor
 import com.jetbrains.packagesearch.plugin.core.utils.IntelliJApplication
+import com.jetbrains.packagesearch.plugin.core.utils.replayOn
 import com.jetbrains.packagesearch.plugin.fus.logGoToSource
 import com.jetbrains.packagesearch.plugin.fus.logHeaderAttributesClick
 import com.jetbrains.packagesearch.plugin.fus.logHeaderVariantsClick
@@ -37,7 +38,6 @@ import com.jetbrains.packagesearch.plugin.utils.PackageSearchApplicationCachesSe
 import com.jetbrains.packagesearch.plugin.utils.PackageSearchProjectService
 import com.jetbrains.packagesearch.plugin.utils.logTODO
 import com.jetbrains.packagesearch.plugin.utils.logWarn
-import com.jetbrains.packagesearch.plugin.utils.searchPackages
 import kotlin.time.Duration.Companion.milliseconds
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
@@ -138,6 +138,9 @@ class PackageListViewModel(private val project: Project) : Disposable {
         val searchQuery: String,
     )
 
+    private val restartSearchChannel = Channel<Unit>()
+    private val restartSearchFlow = restartSearchChannel.consumeAsFlow()
+
     private val searchResultMapFlow: StateFlow<Map<PackageListItem.Header.Id.Remote, Search>> = combine(
         selectedModulesFlow,
         searchQueryStateFlow
@@ -148,8 +151,9 @@ class PackageListViewModel(private val project: Project) : Disposable {
             else -> null
         }
     }
+        .replayOn(restartSearchFlow)
         .mapLatest { data ->
-            when (data) {
+            val map: Map<PackageListItem.Header.Id.Remote, Search> = when (data) {
                 null -> emptyMap()
                 else -> {
                     isLoadingChannel.send(true)
@@ -160,17 +164,18 @@ class PackageListViewModel(private val project: Project) : Disposable {
                     }
                 }
             }
+            map
         }
         .onEach { isLoadingChannel.send(false) }
-        .modifiedBy(headerCollapsedStatesFlow) { current: Map<PackageListItem.Header.Id.Remote, Search>, change ->
+        .modifiedBy(headerCollapsedStatesFlow) { current, change ->
             current.mapValues { (id, value) ->
                 when {
                     change[id] == OPEN && value is Search.Query -> value.execute()
                     else -> value
                 }
             }
         }
-        .modifiedBy(selectedModulesFlow) { current: Map<PackageListItem.Header.Id.Remote, Search>, change ->
+        .modifiedBy(selectedModulesFlow) { current, change ->
             val changeIdentities = change.map { it.identity }
             if (current.keys.any { it.moduleIdentity !in changeIdentities }) {
                 emptyMap()
@@ -215,23 +220,22 @@ class PackageListViewModel(private val project: Project) : Disposable {
 
     private suspend fun PackageSearchModule.Base.getSearchQuery(
         searchQuery: String,
-    ): Map<PackageListItem.Header.Id.Remote, Search.Results.Base> {
+    ): Map<PackageListItem.Header.Id.Remote, Search.Response.Base> {
         val headerId = PackageListItem.Header.Id.Remote.Base(identity)
-        val results = Search.Results.Base(
-            packages = IntelliJApplication.PackageSearchApplicationCachesService
-                .apiPackageCache
-                .searchPackages(buildSearchParameters {
-                    this.searchQuery = searchQuery
-                    packagesType = compatiblePackageTypes
-                }),
-        )
+        val response = Search.Query.Base(
+            query = buildSearchParameters {
+                this.searchQuery = searchQuery
+                packagesType = compatiblePackageTypes
+            },
+            apis = IntelliJApplication.PackageSearchApplicationCachesService.apiPackageCache,
+        ).execute()
         headerCollapsedStatesFlow.update { current ->
             when (headerId) {
                 !in current -> current + (headerId to OPEN)
                 else -> current
             }
         }
-        return mapOf(headerId to results)
+        return mapOf(headerId to response)
     }
 
     private suspend fun PackageSearchModule.WithVariants.getSearchQueries(
@@ -251,27 +255,26 @@ class PackageListViewModel(private val project: Project) : Disposable {
                 val primaryVariantName = variants.first { it.isPrimary }.name
                 val attributes = variants.first().attributes.map { it.value }
                 val additionalVariants = variants.map { it.name } - primaryVariantName
-                val search: Search = when (mainVariantName) {
+                val search = when (mainVariantName) {
                     in variants.map { it.name } -> {
-                        val results = Search.Results.WithVariants(
-                            packages = IntelliJApplication.PackageSearchApplicationCachesService
-                                .apiPackageCache
-                                .searchPackages {
-                                    this.searchQuery = searchQuery
-                                    this.packagesType = packagesType
-                                },
+                        val response = Search.Query.WithVariants(
+                            query = buildSearchParameters {
+                                this.searchQuery = searchQuery
+                                this.packagesType = packagesType
+                            },
+                            apis = IntelliJApplication.PackageSearchApplicationCachesService.apiPackageCache,
                             attributes = attributes,
                             primaryVariantName = primaryVariantName,
                             additionalVariants = additionalVariants,
-                        )
+                        ).execute()
                         headerCollapsedStatesFlow.update { current ->
                             when (headerId) {
                                 !in current -> current + (headerId to OPEN)
                                 else -> current
                             }
 
                         }
-                        results
+                        response
                     }
 
                     else -> Search.Query.WithVariants(
@@ -327,10 +330,15 @@ class PackageListViewModel(private val project: Project) : Disposable {
                 is PackageListItemEvent.OnPackageAction.Update -> handle(event)
                 is PackageListItemEvent.SetHeaderState -> handle(event)
                 is PackageListItemEvent.UpdateAllPackages -> handle(event)
+                is PackageListItemEvent.OnRetryPackageSearch -> handle(event)
             }
         }
     }
 
+    private suspend fun handle(event: PackageListItemEvent.OnRetryPackageSearch) {
+        restartSearchChannel.send(Unit)
+    }
+
     private fun handle(event: PackageListItemEvent.InfoPanelEvent.OnHeaderVariantsClick) {
         logTODO()
         logHeaderVariantsClick()
@@ -353,7 +361,7 @@ class PackageListViewModel(private val project: Project) : Disposable {
         when (event.eventId) {
             is PackageListItem.Package.Remote.Base.Id -> {
                 val headerId = PackageListItem.Header.Id.Remote.Base(event.eventId.moduleIdentity)
-                val search = searchResultMapFlow.value[headerId] as? Search.Results.Base
+                val search = searchResultMapFlow.value[headerId] as? Search.Response.Base.Success
                     ?: return
                 infoPanelViewModel.setPackage(
                     module = event.eventId.getModule() as? PackageSearchModule.Base ?: return,
@@ -367,8 +375,9 @@ class PackageListViewModel(private val project: Project) : Disposable {
                     event.eventId.moduleIdentity,
                     event.eventId.headerId.compatibleVariantNames
                 )
-                val search = searchResultMapFlow.value[headerId] as? Search.Results.WithVariants
-                    ?: return
+                val search =
+                    searchResultMapFlow.value[headerId] as? Search.Response.WithVariants.Success
+                        ?: return
                 infoPanelViewModel.setPackage(
                     module = event.eventId.getModule() as? PackageSearchModule.WithVariants ?: return,
                     apiPackage = search.packages.firstOrNull { it.id == event.eventId.packageId } ?: return,
@@ -467,7 +476,7 @@ class PackageListViewModel(private val project: Project) : Disposable {
         val variant = module.variants[actionType.selectedVariantName]
             ?: return
         val search = searchResultMapFlow
-            .value[actionType.headerId] as? Search.Results.WithVariants
+            .value[actionType.headerId] as? Search.Response.WithVariants.Success
             ?: return
         val apiPackage = search.packages
             .firstOrNull { it.id == actionType.eventId.packageId }
@@ -486,7 +495,8 @@ class PackageListViewModel(private val project: Project) : Disposable {
         val module = actionType.eventId
             .getModule() as? PackageSearchModule.Base
             ?: return
-        val search = searchResultMapFlow.value[actionType.headerId] as? Search.Results ?: return
+        val search =
+            searchResultMapFlow.value[actionType.headerId] as? Search.Response.Base.Success ?: return
         val apiPackage = search.packages
             .firstOrNull { it.id == actionType.eventId.packageId }
             ?: return