shared schemas #661

vepanimas · vepanimas · commit cffc10538289 · 2023-04-26T02:35:52.000+03:00
diff --git a/src/main/com/intellij/lang/jsgraphql/ide/actions/GraphQLOpenConfigAction.kt b/src/main/com/intellij/lang/jsgraphql/ide/actions/GraphQLOpenConfigAction.kt
@@ -50,10 +50,10 @@ class GraphQLOpenConfigAction : AnAction(
             return
         }
         val provider = GraphQLConfigProvider.getInstance(project)
-        val config = provider.resolveConfig(psiFile)
+        val config = provider.resolveProjectConfig(psiFile)
         // look for the closest one as a fallback for cases when a file is excluded
         // and not matched by the `resolveConfig` call
-        val configFile = config?.file ?: provider.findClosestConfig(psiFile)?.file
+        val configFile = config?.file ?: provider.findConfig(psiFile)?.config?.file
         if (configFile != null) {
             val fileEditorManager = FileEditorManager.getInstance(project)
             fileEditorManager.openFile(configFile, true, true)
diff --git a/src/main/com/intellij/lang/jsgraphql/ide/config/GraphQLConfigProvider.kt b/src/main/com/intellij/lang/jsgraphql/ide/config/GraphQLConfigProvider.kt
@@ -63,7 +63,7 @@ class GraphQLConfigProvider(private val project: Project) : Disposable, Modifica
         private val LOG = logger<GraphQLConfigProvider>()
 
         private val CONFIG_CLOSEST =
-            Key.create<CachedValue<GraphQLConfig?>>("graphql.config.closest")
+            Key.create<CachedValue<GraphQLConfigSearchResult?>>("graphql.config.closest")
         private val CONFIG_OVERRIDE_FILE_KEY =
             Key.create<CachedValue<GraphQLConfigOverride?>>("graphql.config.override.file")
         private val CONFIG_OVERRIDE_PATH_KEY =
@@ -127,29 +127,23 @@ class GraphQLConfigProvider(private val project: Project) : Disposable, Modifica
         }
 
     @RequiresReadLock
-    fun resolveConfig(context: PsiFile): GraphQLProjectConfig? {
+    fun resolveProjectConfig(context: PsiFile): GraphQLProjectConfig? {
         // shouldn't try resolving for the config file itself
-        if (getPhysicalVirtualFile(context)?.name in CONFIG_NAMES) {
+        if (isConfigFile(context)) {
             return null
         }
 
-        val overriddenConfig = findOverriddenConfig(context)
-        if (overriddenConfig != null) {
-            val config = getForConfigFile(overriddenConfig.file)
-            if (config != null) {
-                val projectConfig = config.findProject(overriddenConfig.projectName)
-                if (projectConfig != null) {
-                    return projectConfig
-                }
-            }
+        val searchResult = findConfig(context)
+        return when {
+            searchResult == null -> null
+            searchResult.projectName != null -> searchResult.config.findProject(searchResult.projectName)
+            else -> searchResult.config.match(context)
         }
-
-        return findClosestConfig(context)?.match(context)
     }
 
     @RequiresReadLock
-    fun resolveConfig(virtualFile: VirtualFile): GraphQLProjectConfig? =
-        PsiManager.getInstance(project).findFile(virtualFile)?.let { resolveConfig(it) }
+    fun resolveProjectConfig(virtualFile: VirtualFile): GraphQLProjectConfig? =
+        PsiManager.getInstance(project).findFile(virtualFile)?.let { resolveProjectConfig(it) }
 
     fun getForConfigFile(file: VirtualFile?): GraphQLConfig? {
         return when {
@@ -239,17 +233,30 @@ class GraphQLConfigProvider(private val project: Project) : Disposable, Modifica
     }
 
     @RequiresReadLock
-    fun findClosestConfig(context: PsiFile): GraphQLConfig? {
+    fun findConfig(context: PsiFile): GraphQLConfigSearchResult? {
         return CachedValuesManager.getCachedValue(context, CONFIG_CLOSEST) {
+            val overriddenConfig = findOverriddenConfig(context)
+            if (overriddenConfig != null) {
+                val config = getForConfigFile(overriddenConfig.file)
+                if (config != null) {
+                    return@getCachedValue CachedValueProvider.Result.create(
+                        GraphQLConfigSearchResult(config, overriddenConfig.projectName ?: GraphQLConfig.DEFAULT_PROJECT),
+                        scopeDependency,
+                    )
+                }
+            }
+
             var from: VirtualFile? = getPhysicalVirtualFile(context)
 
             val sourceFile = generatedSourcesManager.getSourceFile(from) ?: remoteSchemasRegistry.getSourceFile(from)
             if (sourceFile != null) {
                 from = sourceFile
             }
 
-            val config = findConfigInParents(from)
-            CachedValueProvider.Result.create(config, scopeDependency)
+            CachedValueProvider.Result.create(
+                findConfigInParents(from)?.let { GraphQLConfigSearchResult(it) },
+                scopeDependency,
+            )
         }
     }
 
@@ -500,4 +507,6 @@ class GraphQLConfigProvider(private val project: Project) : Disposable, Modifica
     data class ConfigEvaluationState(val status: GraphQLConfigEvaluationStatus, val error: Throwable?)
 }
 
+class GraphQLConfigSearchResult(val config: GraphQLConfig, val projectName: String? = null)
+
 private data class GraphQLConfigOverride(val file: VirtualFile, val projectName: String?)
diff --git a/src/main/com/intellij/lang/jsgraphql/ide/config/GraphQLConfigUtil.kt b/src/main/com/intellij/lang/jsgraphql/ide/config/GraphQLConfigUtil.kt
@@ -3,7 +3,9 @@
 package com.intellij.lang.jsgraphql.ide.config
 
 import com.intellij.lang.jsgraphql.asSafely
+import com.intellij.lang.jsgraphql.psi.getPhysicalVirtualFile
 import com.intellij.openapi.vfs.VirtualFile
+import com.intellij.psi.PsiFile
 
 fun isLegacyConfig(file: VirtualFile?): Boolean {
     return isLegacyConfig(file?.name)
@@ -13,6 +15,8 @@ fun isLegacyConfig(filename: String?): Boolean {
     return filename?.lowercase() in LEGACY_CONFIG_NAMES
 }
 
+fun isConfigFile(context: PsiFile) = getPhysicalVirtualFile(context)?.name in CONFIG_NAMES
+
 fun parseMap(value: Any?): Map<String, Any?>? =
     value.asSafely<Map<*, *>>()?.mapNotNull {
         val key = it.key as? String ?: return@mapNotNull null
diff --git a/src/main/com/intellij/lang/jsgraphql/ide/config/env/GraphQLEditEnvironmentVariablesAction.kt b/src/main/com/intellij/lang/jsgraphql/ide/config/env/GraphQLEditEnvironmentVariablesAction.kt
@@ -24,7 +24,7 @@ class GraphQLEditEnvironmentVariablesAction : AnAction(
         val environment = if (virtualFile.name in CONFIG_NAMES) {
             provider.getForConfigFile(virtualFile)?.environment
         } else if (GraphQLFileType.isGraphQLFile(project, virtualFile) && inToolbar) {
-            provider.resolveConfig(virtualFile)?.parentConfig?.environment
+            provider.resolveProjectConfig(virtualFile)?.rootConfig?.environment
         } else {
             null
         }
@@ -55,7 +55,7 @@ class GraphQLEditEnvironmentVariablesAction : AnAction(
         val environment = if (virtualFile.name in CONFIG_NAMES) {
             provider.getForConfigFile(virtualFile)?.environment
         } else {
-            provider.resolveConfig(virtualFile)?.parentConfig?.environment
+            provider.resolveProjectConfig(virtualFile)?.rootConfig?.environment
         } ?: return
 
         GraphQLEnvironmentVariablesDialog(project, environment, virtualFile, false).show()
diff --git a/src/main/com/intellij/lang/jsgraphql/ide/config/model/GraphQLConfig.kt b/src/main/com/intellij/lang/jsgraphql/ide/config/model/GraphQLConfig.kt
@@ -45,6 +45,11 @@ data class GraphQLConfig(
 
     private val projects: Map<String, GraphQLProjectConfig> = initProjects()
 
+    /**
+     * A first project config without `include` and `exclude` specified.
+     */
+    val fallback: GraphQLProjectConfig? = findFallbackConfig()
+
     /**
      * NULL config to store as weak referenced value in [fileToProjectCache]. Shouldn't be exposed to the outside of the class.
      */
@@ -75,6 +80,15 @@ data class GraphQLConfig(
         }
     }
 
+    private fun findFallbackConfig(): GraphQLProjectConfig? {
+        for (config in projects.values) {
+            if (config.include.isEmpty() && config.exclude.isEmpty()) {
+                return config
+            }
+        }
+        return null
+    }
+
     fun findProject(name: String? = null): GraphQLProjectConfig? {
         return if (name == null) getDefault() else projects[name]
     }
@@ -127,16 +141,10 @@ data class GraphQLConfig(
             }
         }
 
-        for (config in projects.values) {
-            if (config.include.isEmpty() && config.exclude.isEmpty()) {
-                return config
-            }
-        }
-
-        return null
+        return fallback
     }
 
-    private fun requiresSchemaStrictMatch(virtualFile: VirtualFile) =
+    fun requiresSchemaStrictMatch(virtualFile: VirtualFile) =
         virtualFile.fileType == JsonFileType.INSTANCE ||
             generatedSourcesManager.isGeneratedFile(virtualFile) ||
             generatedSourcesManager.isSourceForGeneratedFile(virtualFile) ||
diff --git a/src/main/com/intellij/lang/jsgraphql/ide/config/model/GraphQLProjectConfig.kt b/src/main/com/intellij/lang/jsgraphql/ide/config/model/GraphQLProjectConfig.kt
@@ -35,16 +35,16 @@ class GraphQLProjectConfig(
     val rawData: GraphQLRawProjectConfig,
     val defaultData: GraphQLRawProjectConfig?,
     val environment: GraphQLEnvironmentSnapshot,
-    val parentConfig: GraphQLConfig,
+    val rootConfig: GraphQLConfig,
 ) {
     private val generatedSourcesManager = GraphQLGeneratedSourcesManager.getInstance(project)
     private val remoteSchemasRegistry = GraphQLRemoteSchemasRegistry.getInstance(project)
 
-    val dir: VirtualFile = parentConfig.dir
+    val dir: VirtualFile = rootConfig.dir
 
-    val file: VirtualFile? = parentConfig.file
+    val file: VirtualFile? = rootConfig.file
 
-    val isRootEmpty: Boolean = parentConfig.isEmpty
+    val isRootEmpty: Boolean = rootConfig.isEmpty
 
     val isLegacy = isLegacyConfig(file)
 
diff --git a/src/main/com/intellij/lang/jsgraphql/ide/config/scope/GraphQLConfigSchemaScope.kt b/src/main/com/intellij/lang/jsgraphql/ide/config/scope/GraphQLConfigSchemaScope.kt
@@ -15,9 +15,9 @@ class GraphQLConfigSchemaScope(
         if (!super.match(file)) {
             return false
         }
-        if (config.isDefault && config.isRootEmpty) {
+        if (projectConfig.isDefault && projectConfig.isRootEmpty) {
             return true
         }
-        return config.matchesSchema(file)
+        return projectConfig.matchesSchema(file)
     }
 }
diff --git a/src/main/com/intellij/lang/jsgraphql/ide/config/scope/GraphQLConfigScope.kt b/src/main/com/intellij/lang/jsgraphql/ide/config/scope/GraphQLConfigScope.kt
@@ -4,16 +4,18 @@ import com.intellij.lang.jsgraphql.ide.config.GraphQLConfigProvider
 import com.intellij.lang.jsgraphql.ide.config.model.GraphQLProjectConfig
 import com.intellij.openapi.project.Project
 import com.intellij.openapi.vfs.VirtualFile
+import com.intellij.psi.PsiManager
 import com.intellij.psi.search.DelegatingGlobalSearchScope
 import com.intellij.psi.search.GlobalSearchScope
 import com.intellij.psi.util.PsiModificationTracker
 
 open class GraphQLConfigScope(
     project: Project,
     baseScope: GlobalSearchScope,
-    protected val config: GraphQLProjectConfig
-) : DelegatingGlobalSearchScope(baseScope, config) {
+    protected val projectConfig: GraphQLProjectConfig,
+) : DelegatingGlobalSearchScope(baseScope, projectConfig) {
 
+    private val psiManager = PsiManager.getInstance(project)
     private val configProvider = GraphQLConfigProvider.getInstance(project)
 
     private val matchingFiles =
@@ -28,13 +30,20 @@ open class GraphQLConfigScope(
     }
 
     protected open fun match(file: VirtualFile): Boolean {
-        // The matching logic considers both glob patterns and specific corner cases,
-        // such as utilizing the first project with empty `include` and `exclude` arrays
-        // in the absence of an exact match or using a default project if the whole config is empty.
-        //
-        // Scope checks will be evaluated against the whole project,
-        // so we need to run a complete matching algorithm, including a search for the nearest config file.
-        // Otherwise, it's possible to include a random file from non-related subdirectory, e.g. when we have an empty config.
-        return configProvider.resolveConfig(file) == config
+        val psiFile = psiManager.findFile(file) ?: return false
+        val matchingConfig = configProvider.resolveProjectConfig(psiFile) ?: return false
+        if (projectConfig == matchingConfig) {
+            return true
+        }
+        if (projectConfig.rootConfig != matchingConfig.rootConfig) {
+            return false
+        }
+        // a resolved config could be just a first one matching or even a fallback,
+        // so to support shared files between projects we need to match them manually
+        return if (projectConfig.rootConfig.requiresSchemaStrictMatch(file)) {
+            projectConfig.matchesSchema(psiFile)
+        } else {
+            projectConfig.matches(psiFile)
+        }
     }
 }
diff --git a/src/main/com/intellij/lang/jsgraphql/ide/resolve/GraphQLScopeProvider.kt b/src/main/com/intellij/lang/jsgraphql/ide/resolve/GraphQLScopeProvider.kt
@@ -92,7 +92,7 @@ class GraphQLScopeProvider(private val project: Project) {
     ): GlobalSearchScope {
         val file = element.containingFile
         return CachedValuesManager.getCachedValue(file, key) {
-            val projectConfig = configProvider.resolveConfig(file)
+            val projectConfig = configProvider.resolveProjectConfig(file)
             var scope: GlobalSearchScope =
                 projectConfig?.let { if (key == STRICT_SCOPE_KEY) it.schemaScope else it.scope }
                     ?: globalScope.takeUnless { configProvider.hasExplicitConfiguration }
diff --git a/src/main/com/intellij/lang/jsgraphql/ui/GraphQLUIProjectService.java b/src/main/com/intellij/lang/jsgraphql/ui/GraphQLUIProjectService.java
@@ -198,7 +198,7 @@ private void reloadEndpoints() {
 
             for (VirtualFile file : files) {
                 List<GraphQLConfigEndpoint> endpoints = ReadAction.compute(() -> {
-                    GraphQLProjectConfig config = configProvider.resolveConfig(file);
+                    GraphQLProjectConfig config = configProvider.resolveProjectConfig(file);
                     return config != null ? config.getEndpoints() : Collections.emptyList();
                 });
 
@@ -254,7 +254,7 @@ private static class GraphQLEditorHeaderComponent extends EditorHeaderComponent
     }
 
     private JComponent createEditorHeaderComponent(@NotNull FileEditor fileEditor, @NotNull Editor editor, @NotNull VirtualFile file) {
-        GraphQLProjectConfig config = ReadAction.compute(() -> GraphQLConfigProvider.getInstance(myProject).resolveConfig(file));
+        GraphQLProjectConfig config = ReadAction.compute(() -> GraphQLConfigProvider.getInstance(myProject).resolveProjectConfig(file));
         List<GraphQLConfigEndpoint> endpoints = config != null ? config.getEndpoints() : Collections.emptyList();
 
         final GraphQLEditorHeaderComponent headerComponent = new GraphQLEditorHeaderComponent();
diff --git a/src/test/com/intellij/lang/jsgraphql/config/GraphQLConfigOverrideTest.kt b/src/test/com/intellij/lang/jsgraphql/config/GraphQLConfigOverrideTest.kt
@@ -206,7 +206,7 @@ class GraphQLConfigOverrideTest : GraphQLTestCaseBase() {
     }
 
     private fun resolveConfig(file: VirtualFile): GraphQLProjectConfig {
-        val config = GraphQLConfigProvider.getInstance(project).resolveConfig(file)
+        val config = GraphQLConfigProvider.getInstance(project).resolveProjectConfig(file)
         TestCase.assertNotNull("config is not found", config)
         return config!!
     }
diff --git a/src/test/com/intellij/lang/jsgraphql/config/GraphQLConfigResolveTest.kt b/src/test/com/intellij/lang/jsgraphql/config/GraphQLConfigResolveTest.kt
@@ -133,20 +133,20 @@ class GraphQLConfigResolveTest : GraphQLTestCaseBase() {
     private fun resolveConfig(filePath: String): GraphQLProjectConfig {
         val context = myFixture.configureFromTempProjectFile(filePath)
         TestCase.assertNotNull("source file is not found", context)
-        val config = GraphQLConfigProvider.getInstance(project).resolveConfig(context)
+        val config = GraphQLConfigProvider.getInstance(project).resolveProjectConfig(context)
         TestCase.assertNotNull("config is not resolved", config)
         return config!!
     }
 
     private fun noConfig(filePath: String) {
         val context = myFixture.configureFromTempProjectFile(filePath)
         TestCase.assertNotNull("source file is not found", context)
-        val config = GraphQLConfigProvider.getInstance(project).resolveConfig(context)
+        val config = GraphQLConfigProvider.getInstance(project).resolveProjectConfig(context)
         TestCase.assertNull("config should be null", config)
     }
 
     private fun compareContents(config: GraphQLProjectConfig) {
-        compareContents(config.parentConfig)
+        compareContents(config.rootConfig)
     }
 
     private fun compareContents(config: GraphQLConfig) {
diff --git a/src/test/com/intellij/lang/jsgraphql/config/GraphQLConfigScopeTest.kt b/src/test/com/intellij/lang/jsgraphql/config/GraphQLConfigScopeTest.kt
@@ -153,6 +153,12 @@ class GraphQLConfigScopeTest : GraphQLTestCaseBase() {
         )
     }
 
+    fun testShared() {
+        doScopeTest("graphql.config.yml", setOf("lib/common.graphql"), emptySet(), "lib")
+        doScopeTest("graphql.config.yml", setOf("lib/common.graphql", "one/one.graphql"), emptySet(), "one")
+        doScopeTest("graphql.config.yml", setOf("lib/common.graphql", "two/two.graphql"), emptySet(), "two")
+    }
+
     private fun doScopeTest(
         configPath: String,
         expectedSchemas: Set<String>,
diff --git a/test-resources/testData/graphql/config/scope/shared/graphql.config.yml b/test-resources/testData/graphql/config/scope/shared/graphql.config.yml
@@ -0,0 +1,12 @@
+projects:
+  lib:
+    schema: lib/common.graphql
+  one:
+    schema:
+      - one/one.graphql
+      - lib/common.graphql 
+  two:
+    schema:
+      - two/two.graphql
+      - lib/common.graphql
+  
diff --git a/test-resources/testData/graphql/config/scope/shared/lib/common.graphql b/test-resources/testData/graphql/config/scope/shared/lib/common.graphql
@@ -0,0 +1,9 @@
+type CommonType {
+    name: String
+    color: CommonColor 
+}
+
+enum CommonColor {
+    RED
+    BLUE
+}
diff --git a/test-resources/testData/graphql/config/scope/shared/one/one.graphql b/test-resources/testData/graphql/config/scope/shared/one/one.graphql
@@ -0,0 +1,4 @@
+type OneType {
+    one: String
+    common: CommonType
+}
diff --git a/test-resources/testData/graphql/config/scope/shared/two/two.graphql b/test-resources/testData/graphql/config/scope/shared/two/two.graphql
@@ -0,0 +1,4 @@
+type TwoType {
+    one: String
+    common: CommonType
+}

Original file line number	Diff line number	Diff line change
`@@ -15,9 +15,9 @@ class GraphQLConfigSchemaScope(`
`15`	`15`	`if (!super.match(file)) {`
`16`	`16`	`return false`
`17`	`17`	`}`
`18`		`- if (config.isDefault && config.isRootEmpty) {`
	`18`	`+ if (projectConfig.isDefault && projectConfig.isRootEmpty) {`
`19`	`19`	`return true`
`20`	`20`	`}`
`21`		`- return config.matchesSchema(file)`
	`21`	`+ return projectConfig.matchesSchema(file)`
`22`	`22`	`}`
`23`	`23`	`}`