[graphql] WEB-68173 move introspection settings to advanced settings

GitOrigin-RevId: 257a49c6c010f45f860eb833e154b8fdf048dbde

Author: vepanimas

resources/META-INF/plugin.xml

@@ -223,18 +223,19 @@
     <registryKey key="graphql.schema.build.timeout" defaultValue="500" description="GraphQL schema build timeout in ms"/>
     <registryKey key="graphql.schema.size.definitions.limit" defaultValue="4000"
                  description="A limit on the total number of type definitions in a GraphQL schema"/>
-    <registryKey key="graphql.introspection.detect.schema.capabilities"
-                 defaultValue="[Adaptive*|Latest|Legacy]"
-                 description="Enables preliminary request to detect GraphQL server capabilities before schema introspection"/>
     <registryKey key="graphql.introspection.custom.query"
                  defaultValue=""
                  description="Defines a custom query for server introspection, overriding the default behavior"/>
-    <registryKey key="graphql.introspection.skip.default.values"
-                 defaultValue="false"
-                 description="Improves compatibility with non-compliant endpoints by skipping default values, though this removes default value information from the schema"/>
-    <registryKey key="graphql.introspection.include.empty.types"
-                 defaultValue="false"
-                 description="Determines whether empty types are included in the introspection result"/>
+
+    <advancedSetting id="graphql.introspection.detect.schema.capabilities" default="ADAPTIVE"
+                     enumClass="com.intellij.lang.jsgraphql.ide.introspection.GraphQLSchemaCapabilitiesDetectionStrategy"
+                     groupKey="group.advanced.settings.graphql" bundle="messages.GraphQLBundle"
+                     descriptionKey="advanced.setting.graphql.introspection.detect.schema.capabilities.description"/>
+    <advancedSetting id="graphql.introspection.skip.default.values" default="false"
+                     groupKey="group.advanced.settings.graphql" bundle="messages.GraphQLBundle"
+                     descriptionKey="advanced.setting.graphql.introspection.skip.default.values.description"/>
+    <advancedSetting id="graphql.introspection.include.empty.types" default="true"
+                     groupKey="group.advanced.settings.graphql" bundle="messages.GraphQLBundle"/>
 
     <!-- Inspections -->
     <localInspection language="GraphQL" key="graphql.inspection.display.name.unresolved.reference"

resources/messages/GraphQLBundle.properties

@@ -239,4 +239,12 @@ graphql.validation.unknown.type.0=Unknown type "{0}"
 graphql.schema.is.too.complex.error.text=The schema size exceeds the limit of {0} type definitions. This limit is set by the IDE to prevent performance issues. To resolve this, consider defining a more specific scope by creating a GraphQL configuration file
 
 # Parser
-graphql.parsing.error.injection.placeholder=Injection placeholder
+graphql.parsing.error.injection.placeholder=Injection placeholder
+
+# Advanced settings
+group.advanced.settings.graphql=GraphQL
+advanced.setting.graphql.introspection.detect.schema.capabilities=Schema capabilities detection mode
+advanced.setting.graphql.introspection.detect.schema.capabilities.description=Enables a preliminary request to detect GraphQL server capabilities before schema introspection.
+advanced.setting.graphql.introspection.skip.default.values=Skip default values in introspection queries
+advanced.setting.graphql.introspection.skip.default.values.description=Improves compatibility with non-compliant endpoints by skipping default values, though this removes default value information from the schema.
+advanced.setting.graphql.introspection.include.empty.types=Include empty types in the introspection result

src/main/com/intellij/lang/jsgraphql/ide/introspection/GraphQLIntrospectionQueryExecutor.kt

@@ -5,8 +5,8 @@ import com.google.gson.JsonElement
 import com.google.gson.JsonObject
 import com.intellij.lang.jsgraphql.GraphQLBundle
 import com.intellij.lang.jsgraphql.ide.config.model.GraphQLConfigEndpoint
-import com.intellij.lang.jsgraphql.ide.introspection.GraphQLQueryRunner.Companion.parseResponseJson
-import com.intellij.lang.jsgraphql.ide.introspection.GraphQLQueryRunner.Companion.prepareQueryPayload
+import com.intellij.lang.jsgraphql.ide.introspection.GraphQLQueryClient.Companion.parseResponseJson
+import com.intellij.lang.jsgraphql.ide.introspection.GraphQLQueryClient.Companion.prepareQueryPayload
 import com.intellij.lang.jsgraphql.ide.introspection.GraphQLSchemaCapability.*
 import com.intellij.lang.jsgraphql.ide.notifications.handleIntrospectionError
 import com.intellij.openapi.application.EDT
@@ -15,6 +15,7 @@ import com.intellij.openapi.components.service
 import com.intellij.openapi.diagnostic.debug
 import com.intellij.openapi.diagnostic.getOrLogException
 import com.intellij.openapi.diagnostic.logger
+import com.intellij.openapi.options.advanced.AdvancedSettings
 import com.intellij.openapi.progress.blockingContext
 import com.intellij.openapi.project.Project
 import com.intellij.openapi.util.io.FileUtil
@@ -58,7 +59,7 @@ class GraphQLIntrospectionQueryExecutor(private val project: Project, private va
         }
         val introspectionQuery = composeIntrospectionQuery(capabilities)
         val rawIntrospectionResponse = withContext(Dispatchers.IO) {
-          val queryRunner = GraphQLQueryRunner.getInstance(project)
+          val queryRunner = GraphQLQueryClient.getInstance(project)
           queryRunner.sendRequest(endpoint, prepareQueryPayload(introspectionQuery), retry)
         } ?: return@withBackgroundProgress
         val parsedIntrospection = blockingContext {
@@ -83,7 +84,7 @@ class GraphQLIntrospectionQueryExecutor(private val project: Project, private va
     retry: Runnable? = null,
   ): EnumSet<GraphQLSchemaCapability>? {
     val response = withContext(Dispatchers.IO) {
-      GraphQLQueryRunner.getInstance(project)
+      GraphQLQueryClient.getInstance(project)
         .sendRequest(endpoint, prepareQueryPayload(INTROSPECTION_SCHEMA_CAPABILITIES_QUERY), retry)
     } ?: return null
 
@@ -96,17 +97,7 @@ class GraphQLIntrospectionQueryExecutor(private val project: Project, private va
   }
 
   private val capabilitiesDetectionStrategy: GraphQLSchemaCapabilitiesDetectionStrategy
-    get() {
-      val option = Registry.get("graphql.introspection.detect.schema.capabilities").selectedOption
-                   ?: return GraphQLSchemaCapabilitiesDetectionStrategy.ADAPTIVE
-
-      return try {
-        GraphQLSchemaCapabilitiesDetectionStrategy.valueOf(option.uppercase(Locale.getDefault()))
-      }
-      catch (_: IllegalArgumentException) {
-        GraphQLSchemaCapabilitiesDetectionStrategy.ADAPTIVE
-      }
-    }
+    get() = AdvancedSettings.getEnum("graphql.introspection.detect.schema.capabilities", GraphQLSchemaCapabilitiesDetectionStrategy::class.java)
 
   private suspend fun createIntrospectionOutput(
     schemaPath: String,
@@ -144,8 +135,8 @@ class GraphQLIntrospectionQueryExecutor(private val project: Project, private va
 
     // this is still needed since we can have an issue with parsing values returned from server,
     // especially for custom JSON types, more https://github.com/JetBrains/js-graphql-intellij-plugin/issues/217
-    if (Registry.`is`("graphql.introspection.skip.default.values")) {
-      capabilities.remove(GraphQLSchemaCapability.INPUT_VALUE_DEFAULT_VALUE)
+    if (AdvancedSettings.getBoolean("graphql.introspection.skip.default.values")) {
+      capabilities.remove(INPUT_VALUE_DEFAULT_VALUE)
     }
 
     return buildIntrospectionQueryFromTemplate(capabilities)
@@ -224,9 +215,3 @@ class GraphQLIntrospectionQueryExecutor(private val project: Project, private va
   private fun JsonElement.hasArgument(fieldName: String, argName: String): Boolean =
     getArgument(fieldName, argName) != null
 }
-
-private enum class GraphQLSchemaCapabilitiesDetectionStrategy {
-  ADAPTIVE,
-  LATEST,
-  LEGACY,
-}

src/main/com/intellij/lang/jsgraphql/ide/introspection/GraphQLIntrospectionService.java

@@ -42,12 +42,12 @@
 import com.intellij.openapi.fileEditor.FileEditor;
 import com.intellij.openapi.fileEditor.FileEditorManager;
 import com.intellij.openapi.fileEditor.TextEditor;
+import com.intellij.openapi.options.advanced.AdvancedSettings;
 import com.intellij.openapi.progress.ProcessCanceledException;
 import com.intellij.openapi.project.DumbService;
 import com.intellij.openapi.project.Project;
 import com.intellij.openapi.util.Ref;
 import com.intellij.openapi.util.io.FileUtil;
-import com.intellij.openapi.util.registry.Registry;
 import com.intellij.openapi.util.text.StringUtil;
 import com.intellij.openapi.vfs.LocalFileSystem;
 import com.intellij.openapi.vfs.VirtualFile;
@@ -184,23 +184,23 @@ private boolean isEndpointConfigurationValid(GraphQLConfigEndpoint endpoint) {
   }
 
   public static @NotNull String printIntrospectionAsGraphQL(@NotNull Project project, @NotNull String introspectionJson) {
-    return printIntrospectionAsGraphQL(project, GraphQLQueryRunner.parseResponseJsonAsMap(introspectionJson));
+    return printIntrospectionAsGraphQL(project, GraphQLQueryClient.parseResponseJsonAsMap(introspectionJson));
   }
 
   /**
-   * @deprecated Use {@link GraphQLQueryRunner#createHttpClient(String, GraphQLConfigSecurity)} instead.
+   * @deprecated Use {@link GraphQLQueryClient#createHttpClient(String, GraphQLConfigSecurity)} instead.
    */
   @Deprecated(forRemoval = true)
   public @NotNull CloseableHttpClient createHttpClient(@NotNull String url, @Nullable GraphQLConfigSecurity sslConfig)
     throws NoSuchAlgorithmException, KeyManagementException, KeyStoreException, IOException, UnrecoverableKeyException,
            CertificateException {
-    return GraphQLQueryRunner.getInstance(myProject).createHttpClient(url, sslConfig);
+    return GraphQLQueryClient.getInstance(myProject).createHttpClient(url, sslConfig);
   }
 
   public static @NotNull String printIntrospectionAsGraphQL(@NotNull Project project, @NotNull Map<String, Object> introspection) {
     introspection = getIntrospectionSchemaDataFromParsedResponse(introspection);
 
-    if (Registry.is("graphql.introspection.skip.default.values")) {
+    if (AdvancedSettings.getBoolean("graphql.introspection.skip.default.values")) {
       // strip out the defaultValues that are potentially non-spec compliant
       Ref<Consumer<Object>> defaultValueVisitJson = Ref.create();
       defaultValueVisitJson.set((value) -> {
@@ -220,7 +220,7 @@ else if (value instanceof Map) {
       .defaultOptions()
       .includeScalarTypes(true)
       .includeSchemaDefinition(true)
-      .includeEmptyTypes(false)
+      .includeEmptyTypes(AdvancedSettings.getBoolean("graphql.introspection.include.empty.types"))
       .includeDirectives(directive -> !GraphQLKnownTypes.DEFAULT_DIRECTIVES.contains(directive.getName()));
 
     GraphQLRegistryInfo registryInfo = new GraphQLRegistryInfo(new SchemaParser().buildRegistry(schemaDefinition), false);
@@ -267,7 +267,7 @@ else if (value instanceof Map) {
   }
 
   /**
-   * @deprecated use {@link GraphQLQueryRunner#createRequest(GraphQLConfigEndpoint, String)} instead.
+   * @deprecated use {@link GraphQLQueryClient#createRequest(GraphQLConfigEndpoint, String)} instead.
    */
   @Deprecated(forRemoval = true)
   public static @NotNull HttpPost createRequest(@NotNull GraphQLConfigEndpoint endpoint,
@@ -291,7 +291,7 @@ record IntrospectionOutput(@NotNull String schemaText, @NotNull IntrospectionOut
                                                                           @NotNull GraphQLConfigEndpoint endpoint,
                                                                           @NotNull String introspectionResponse) {
     try {
-      Map<String, Object> introspection = GraphQLQueryRunner.parseResponseJsonAsMap(introspectionResponse);
+      Map<String, Object> introspection = GraphQLQueryClient.parseResponseJsonAsMap(introspectionResponse);
       if (GraphQLIntrospectionUtil.getErrorCountFromResponse(introspection) > 0) {
         GraphQLUIProjectService.getInstance(project).showQueryResult(introspectionResponse);
       }

src/main/com/intellij/lang/jsgraphql/ide/introspection/GraphQLQueryRunner.kt renamed to src/main/com/intellij/lang/jsgraphql/ide/introspection/GraphQLQueryClient.kt

@@ -42,13 +42,13 @@ import java.util.concurrent.CancellationException
 import javax.net.ssl.HostnameVerifier
 
 @Service(Service.Level.PROJECT)
-class GraphQLQueryRunner(private val project: Project) {
+class GraphQLQueryClient(private val project: Project) {
 
   companion object {
-    private val LOG = logger<GraphQLQueryRunner>()
+    private val LOG = logger<GraphQLQueryClient>()
 
     @JvmStatic
-    fun getInstance(project: Project): GraphQLQueryRunner = project.service()
+    fun getInstance(project: Project): GraphQLQueryClient = project.service()
 
     @JvmStatic
     fun parseResponseJsonAsMap(responseJson: String): Map<String, Any?> {
@@ -76,10 +76,12 @@ class GraphQLQueryRunner(private val project: Project) {
       return responseJson.replace("[\ud83c\udf00-\ud83d\ude4f]|[\ud83d\ude80-\ud83d\udeff]".toRegex(), "")
     }
 
+    @JvmStatic
     fun prepareQueryPayload(query: String): String =
       """{"query": "${EscapeUtil.escapeJsonString(query)}"}"""
   }
 
+  @JvmOverloads
   fun sendRequest(
     endpoint: GraphQLConfigEndpoint,
     payload: String,
@@ -108,6 +110,7 @@ class GraphQLQueryRunner(private val project: Project) {
     }
   }
 
+  @JvmOverloads
   fun sendRequest(
     endpoint: GraphQLConfigEndpoint,
     request: HttpUriRequest,

src/main/com/intellij/lang/jsgraphql/ide/introspection/GraphQLSchemaCapabilitiesDetectionStrategy.kt

@@ -0,0 +1,9 @@
+package com.intellij.lang.jsgraphql.ide.introspection
+
+enum class GraphQLSchemaCapabilitiesDetectionStrategy(private val displayName: String) {
+  ADAPTIVE("Adaptive"),
+  LATEST("Latest"),
+  LEGACY("Legacy");
+
+  override fun toString(): String = displayName
+}

src/main/com/intellij/lang/jsgraphql/types/schema/idl/SchemaPrinter.java

@@ -26,7 +26,6 @@ The MIT License (MIT)
 import com.intellij.lang.jsgraphql.types.schema.*;
 import com.intellij.lang.jsgraphql.types.schema.visibility.GraphqlFieldVisibility;
 import com.intellij.openapi.project.Project;
-import com.intellij.openapi.util.registry.Registry;
 import com.intellij.psi.codeStyle.CommonCodeStyleSettings;
 import com.intellij.util.containers.ContainerUtil;
 import org.jetbrains.annotations.NotNull;
@@ -442,7 +441,7 @@ private TypePrinter<GraphQLEnumType> enumPrinter() {
       if (isIntrospectionType(type)) {
         return;
       }
-      if (!shouldIncludeEmptyTypes() && type.getValues().isEmpty()) {
+      if (!options.isIncludeEmptyTypes() && type.getValues().isEmpty()) {
         return;
       }
 
@@ -513,7 +512,7 @@ private TypePrinter<GraphQLInterfaceType> interfacePrinter() {
       if (isIntrospectionType(type)) {
         return;
       }
-      if (!shouldIncludeEmptyTypes() && type.getFields().isEmpty()) {
+      if (!options.isIncludeEmptyTypes() && type.getFields().isEmpty()) {
         return;
       }
 
@@ -560,7 +559,7 @@ private TypePrinter<GraphQLUnionType> unionPrinter() {
       if (isIntrospectionType(type)) {
         return;
       }
-      if (!shouldIncludeEmptyTypes() && type.getTypes().isEmpty()) {
+      if (!options.isIncludeEmptyTypes() && type.getTypes().isEmpty()) {
         return;
       }
 
@@ -597,7 +596,7 @@ private TypePrinter<GraphQLObjectType> objectPrinter() {
       if (isIntrospectionType(type)) {
         return;
       }
-      if (!shouldIncludeEmptyTypes() && type.getFields().isEmpty()) {
+      if (!options.isIncludeEmptyTypes() && type.getFields().isEmpty()) {
         return;
       }
 
@@ -644,7 +643,7 @@ private TypePrinter<GraphQLInputObjectType> inputObjectPrinter() {
       if (isIntrospectionType(type)) {
         return;
       }
-      if (!shouldIncludeEmptyTypes() && type.getFields().isEmpty()) {
+      if (!options.isIncludeEmptyTypes() && type.getFields().isEmpty()) {
         return;
       }
 
@@ -687,10 +686,6 @@ private TypePrinter<GraphQLInputObjectType> inputObjectPrinter() {
     };
   }
 
-  private boolean shouldIncludeEmptyTypes() {
-    return options.isIncludeEmptyTypes() || Registry.is("graphql.introspection.include.empty.types");
-  }
-
   /**
    * This will return true if the options say to use the AST and we have an AST element
    *

src/main/com/intellij/lang/jsgraphql/ui/GraphQLUIProjectService.java

@@ -31,7 +31,7 @@
 import com.intellij.lang.jsgraphql.ide.highlighting.query.GraphQLQueryContextHighlightVisitor;
 import com.intellij.lang.jsgraphql.ide.introspection.GraphQLIntrospectionUtil;
 import com.intellij.lang.jsgraphql.ide.introspection.GraphQLOpenIntrospectionSchemaAction;
-import com.intellij.lang.jsgraphql.ide.introspection.GraphQLQueryRunner;
+import com.intellij.lang.jsgraphql.ide.introspection.GraphQLQueryClient;
 import com.intellij.lang.jsgraphql.ide.introspection.GraphQLRunIntrospectionQueryAction;
 import com.intellij.lang.jsgraphql.ide.introspection.remote.GraphQLRemoteSchemasRegistry;
 import com.intellij.lang.jsgraphql.ide.introspection.source.GraphQLGeneratedSourcesManager;
@@ -398,7 +398,7 @@ public void executeGraphQL(@NotNull Editor editor, @NotNull VirtualFile virtualF
       return;
     }
     String payload = createQueryJsonSerializer().toJson(requestData);
-    HttpUriRequest request = GraphQLQueryRunner.getInstance(myProject).createRequest(selectedEndpoint, payload);
+    HttpUriRequest request = GraphQLQueryClient.getInstance(myProject).createRequest(selectedEndpoint, payload);
     if (request == null) {
       return;
     }
@@ -422,7 +422,7 @@ private void runQuery(@NotNull Editor editor,
                         @NotNull GraphQLConfigEndpoint endpoint) {
     try {
       GraphQLConfigSecurity sslConfig = GraphQLConfigSecurity.getSecurityConfig(endpoint.getConfig());
-      try (final CloseableHttpClient httpClient = GraphQLQueryRunner.getInstance(myProject).createHttpClient(url, sslConfig)) {
+      try (final CloseableHttpClient httpClient = GraphQLQueryClient.getInstance(myProject).createHttpClient(url, sslConfig)) {
         editor.putUserData(GRAPH_QL_EDITOR_QUERYING, true);
 
         String responseJson;