[graphql] WEB-64772 simplify GraphQLLibraryManager API

GitOrigin-RevId: 07f27ff1f5719d1109ac70222d902c2a97f36b0d

Author: vepanimas

src/main/com/intellij/lang/jsgraphql/GraphQLCoroutineScope.kt

@@ -0,0 +1,14 @@
+package com.intellij.lang.jsgraphql
+
+import com.intellij.openapi.components.Service
+import com.intellij.openapi.components.service
+import com.intellij.openapi.project.Project
+import kotlinx.coroutines.CoroutineScope
+
+@Service(Service.Level.PROJECT)
+class GraphQLCoroutineScope(private val cs: CoroutineScope) {
+  companion object {
+    @JvmStatic
+    fun get(project: Project): CoroutineScope = project.service<GraphQLCoroutineScope>().cs
+  }
+}

src/main/com/intellij/lang/jsgraphql/schema/library/GraphQLLibraryManager.kt

@@ -1,6 +1,7 @@
 package com.intellij.lang.jsgraphql.schema.library
 
 import com.intellij.openapi.application.ApplicationManager
+import com.intellij.openapi.application.readAction
 import com.intellij.openapi.components.Service
 import com.intellij.openapi.components.service
 import com.intellij.openapi.components.serviceAsync
@@ -14,13 +15,11 @@ import com.intellij.platform.backend.workspace.toVirtualFileUrl
 import com.intellij.platform.workspace.storage.MutableEntityStorage
 import com.intellij.psi.search.GlobalSearchScope
 import com.intellij.util.PathUtil
+import com.intellij.util.concurrency.annotations.RequiresBackgroundThread
+import com.intellij.util.concurrency.annotations.RequiresReadLockAbsence
 import com.intellij.util.io.URLUtil
-import kotlinx.coroutines.CoroutineScope
-import kotlinx.coroutines.future.asCompletableFuture
-import kotlinx.coroutines.launch
+import org.jetbrains.annotations.ApiStatus
 import org.jetbrains.annotations.TestOnly
-import org.jetbrains.annotations.VisibleForTesting
-import java.util.concurrent.CompletableFuture
 import java.util.concurrent.ConcurrentHashMap
 import kotlin.concurrent.Volatile
 
@@ -35,8 +34,9 @@ private val BUNDLED_RESOURCE_PATHS = mapOf(
 
 private val BUNDLED_LIBRARIES_IDS = BUNDLED_RESOURCE_PATHS.keys.map { it.identifier }.toSet()
 
+@ApiStatus.Experimental
 @Service(Service.Level.PROJECT)
-class GraphQLLibraryManager(private val project: Project, @VisibleForTesting val cs: CoroutineScope) {
+class GraphQLLibraryManager(private val project: Project) {
   companion object {
     private val LOG = logger<GraphQLLibraryManager>()
 
@@ -57,18 +57,17 @@ class GraphQLLibraryManager(private val project: Project, @VisibleForTesting val
     shouldInitializeLibraries = enabled
   }
 
-  private val isEnabled: Boolean
-    get() = ApplicationManager.getApplication().isUnitTestMode() && !shouldInitializeLibraries
-
   /**
    * Registers an external GraphQL library.
    * If a library with the same identifier is already registered,
    * it will be replaced with the new library.
    *
    * @param library The external GraphQL library to register, containing its descriptor and set of root URLs.
    */
+  @RequiresBackgroundThread
+  @RequiresReadLockAbsence
   suspend fun registerExternalLibrary(library: GraphQLLibrary) {
-    if (isEnabled) {
+    if (!shouldInitializeLibraries) {
       return
     }
 
@@ -81,16 +80,16 @@ class GraphQLLibraryManager(private val project: Project, @VisibleForTesting val
     attachLibrary(library)
   }
 
-  private fun isBundledLibrary(library: GraphQLLibrary): Boolean = library.descriptor.identifier in BUNDLED_LIBRARIES_IDS
-
   /**
    * If the specified library is not currently registered, a warning message is logged.
    * Otherwise, the library is removed from the list of external libraries and detached.
    *
    * @param library The external GraphQL library to unregister, containing its descriptor and set of root URLs.
    */
+  @RequiresBackgroundThread
+  @RequiresReadLockAbsence
   suspend fun unregisterExternalLibrary(library: GraphQLLibrary) {
-    if (isEnabled) {
+    if (!shouldInitializeLibraries) {
       return
     }
 
@@ -115,31 +114,19 @@ class GraphQLLibraryManager(private val project: Project, @VisibleForTesting val
    * @see getOrCreateLibraries
    * @see updateLibrariesWorkspaceModel
    */
+  @RequiresBackgroundThread
+  @RequiresReadLockAbsence
   suspend fun syncLibraries() {
-    if (isEnabled) {
+    if (!shouldInitializeLibraries) {
       return
     }
 
     val libraries = getOrCreateLibraries().also { LOG.debug { "GraphQL libraries to sync:\n${it.joinToString("\n")}" } }
-    val availableLibraries = libraries.filter { it.descriptor.isEnabled(project) }
+    val availableLibraries = libraries.filter { readAction { it.descriptor.isEnabled(project) } }
     updateLibrariesWorkspaceModel(availableLibraries)
   }
 
-  /**
-   * Schedules the synchronization of GraphQL libraries in the workspace.
-   *
-   * This method triggers the [syncLibraries] function to execute asynchronously,
-   * ensuring that the libraries, both external and bundled, are synchronized and updated
-   * in the workspace model.
-   *
-   * The synchronization is managed using a CompletableFuture, allowing the Java code
-   * to monitor its completion or handle any exceptions.
-   *
-   * @return A [CompletableFuture] representing the asynchronous task of library synchronization.
-   */
-  fun scheduleLibrariesSynchronization(): CompletableFuture<Unit> {
-    return cs.launch { syncLibraries() }.asCompletableFuture()
-  }
+  private fun isBundledLibrary(library: GraphQLLibrary): Boolean = library.descriptor.identifier in BUNDLED_LIBRARIES_IDS
 
   val libraries: Collection<GraphQLLibrary>
     get() = sequenceOf(bundledLibraries.values, externalLibraries.values)

src/main/com/intellij/lang/jsgraphql/ui/GraphQLSettingsConfigurable.kt

@@ -3,6 +3,7 @@ package com.intellij.lang.jsgraphql.ui
 import com.intellij.codeInsight.daemon.DaemonCodeAnalyzer
 import com.intellij.lang.jsgraphql.GraphQLBundle.message
 import com.intellij.lang.jsgraphql.GraphQLConstants
+import com.intellij.lang.jsgraphql.GraphQLCoroutineScope
 import com.intellij.lang.jsgraphql.GraphQLSettings
 import com.intellij.lang.jsgraphql.schema.library.GraphQLLibraryManager
 import com.intellij.openapi.application.ApplicationManager
@@ -13,6 +14,7 @@ import com.intellij.ui.EditorNotifications
 import com.intellij.ui.dsl.builder.Cell
 import com.intellij.ui.dsl.builder.bindSelected
 import com.intellij.ui.dsl.builder.panel
+import kotlinx.coroutines.launch
 import javax.swing.JComponent
 
 private const val CONFIGURABLE_ID = "settings.jsgraphql"
@@ -29,7 +31,9 @@ class GraphQLSettingsConfigurable(private val project: Project) :
     super.apply()
 
     if (shouldUpdateLibraries) {
-      GraphQLLibraryManager.getInstance(project).scheduleLibrariesSynchronization()
+      GraphQLCoroutineScope.get(project).launch {
+        GraphQLLibraryManager.getInstance(project).syncLibraries()
+      }
     }
     else {
       ApplicationManager.getApplication().invokeLater({

tests/testSrc/com/intellij/lang/jsgraphql/GraphQLTestUtils.kt

@@ -14,7 +14,6 @@ import com.intellij.lang.jsgraphql.schema.library.GraphQLLibraryManager
 import com.intellij.openapi.Disposable
 import com.intellij.openapi.application.ApplicationManager
 import com.intellij.openapi.application.PluginPathManager
-import com.intellij.openapi.progress.runBlockingMaybeCancellable
 import com.intellij.openapi.project.Project
 import com.intellij.openapi.util.Disposer
 import com.intellij.openapi.util.io.FileUtil
@@ -106,10 +105,9 @@ fun withLibrary(
 }
 
 private fun updateLibraries(project: Project) {
-  runBlockingMaybeCancellable {
-    GraphQLLibraryManager.getInstance(project).scheduleLibrariesSynchronization()
+  runWithModalProgressBlocking(project, "com.intellij.lang.jsgraphql.GraphQLTestUtils.updateLibraries") {
+    GraphQLLibraryManager.getInstance(project).syncLibraries()
   }
-  waitCoroutinesBlocking(GraphQLLibraryManager.getInstance(project).cs)
 
   PlatformTestUtil.dispatchAllEventsInIdeEventQueue()
   IndexingTestUtil.waitUntilIndexesAreReady(project);
@@ -163,7 +161,6 @@ fun reloadConfiguration(project: Project) {
   GraphQLConfigProvider.getInstance(project).scheduleConfigurationReload()
 
   waitCoroutinesBlocking(GraphQLNodeModulesLibraryUpdater.getInstance(project).cs)
-  waitCoroutinesBlocking(GraphQLLibraryManager.getInstance(project).cs)
   PlatformTestUtil.dispatchAllEventsInIdeEventQueue()
   IndexingTestUtil.waitUntilIndexesAreReady(project)
 }