Add a setting for the repeatable directives introspection

Author: vepanimas

resources/messages/GraphQLMessages.properties

@@ -82,6 +82,8 @@ graphql.settings.introspection.query.label=Introspection Query (leave blank for
 graphql.settings.introspection.query.tooltip=Use a different introspection query for cases where the GraphQL endpoint is incompatible with the plugin introspection query
 graphql.settings.introspection.default.values.label=Include argument default values in schema introspection
 graphql.settings.introspection.default.values.tooltip=Skipping default values improves interoperability with endpoints that don't follow the GraphQL specification for default values. The schema can still be used, but information about the default values will be unavailable
+graphql.settings.introspection.repeatable.directives.label=Request the "repeatable" property for directives
+graphql.settings.introspection.repeatable.directives.tooltip=Repeatable directives are a relatively new feature and may not be supported by some GraphQL implementations
 graphql.settings.introspection.open.editor.label=Open the editor with the introspection result
 
 # Libraries

src/main/com/intellij/lang/jsgraphql/GraphQLSettings.java

@@ -45,34 +45,26 @@ public GraphQLSettings.GraphQLSettingsState getState() {
     @Override
     public void loadState(@NotNull GraphQLSettings.GraphQLSettingsState state) {
         myState = state;
-        incrementModificationCount();
+        settingsChanged();
     }
 
-    public String getIntrospectionQuery() {
-        return myState.introspectionQuery;
-    }
-
-    public void setIntrospectionQuery(String introspectionQuery) {
-        myState.introspectionQuery = introspectionQuery;
-        incrementModificationCount();
+    public ModificationTracker getModificationTracker() {
+        return myModificationTracker;
     }
 
-    public boolean isRelaySupportEnabled() {
-        return myState.enableRelayModernFrameworkSupport;
+    private void settingsChanged() {
+        myModificationTracker.incModificationCount();
     }
 
-    public void setRelaySupportEnabled(boolean enableRelayModernFrameworkSupport) {
-        myState.enableRelayModernFrameworkSupport = enableRelayModernFrameworkSupport;
-        incrementModificationCount();
-    }
+    /* Introspection */
 
-    public boolean isFederationSupportEnabled() {
-        return myState.enableFederationSupport;
+    public String getIntrospectionQuery() {
+        return myState.introspectionQuery;
     }
 
-    public void setFederationSupportEnabled(boolean enableFederationSupport) {
-        myState.enableFederationSupport = enableFederationSupport;
-        incrementModificationCount();
+    public void setIntrospectionQuery(String introspectionQuery) {
+        myState.introspectionQuery = introspectionQuery;
+        settingsChanged();
     }
 
     public boolean isEnableIntrospectionDefaultValues() {
@@ -81,7 +73,16 @@ public boolean isEnableIntrospectionDefaultValues() {
 
     public void setEnableIntrospectionDefaultValues(boolean enableIntrospectionDefaultValues) {
         myState.enableIntrospectionDefaultValues = enableIntrospectionDefaultValues;
-        incrementModificationCount();
+        settingsChanged();
+    }
+
+    public boolean isEnableIntrospectionRepeatableDirectives() {
+        return myState.enableIntrospectionRepeatableDirectives;
+    }
+
+    public void setEnableIntrospectionRepeatableDirectives(boolean enableIntrospectionRepeatableDirectives) {
+        myState.enableIntrospectionRepeatableDirectives = enableIntrospectionRepeatableDirectives;
+        settingsChanged();
     }
 
     public boolean isOpenEditorWithIntrospectionResult() {
@@ -90,15 +91,27 @@ public boolean isOpenEditorWithIntrospectionResult() {
 
     public void setOpenEditorWithIntrospectionResult(boolean openEditorWithIntrospectionResult) {
         myState.openEditorWithIntrospectionResult = openEditorWithIntrospectionResult;
-        incrementModificationCount();
+        settingsChanged();
     }
 
-    public ModificationTracker getModificationTracker() {
-        return myModificationTracker;
+    /* Frameworks */
+
+    public boolean isRelaySupportEnabled() {
+        return myState.enableRelayModernFrameworkSupport;
     }
 
-    private void incrementModificationCount() {
-        myModificationTracker.incModificationCount();
+    public void setRelaySupportEnabled(boolean enableRelayModernFrameworkSupport) {
+        myState.enableRelayModernFrameworkSupport = enableRelayModernFrameworkSupport;
+        settingsChanged();
+    }
+
+    public boolean isFederationSupportEnabled() {
+        return myState.enableFederationSupport;
+    }
+
+    public void setFederationSupportEnabled(boolean enableFederationSupport) {
+        myState.enableFederationSupport = enableFederationSupport;
+        settingsChanged();
     }
 
     /**
@@ -108,7 +121,9 @@ private void incrementModificationCount() {
     public static class GraphQLSettingsState {
         public String introspectionQuery = "";
         public boolean enableIntrospectionDefaultValues = true;
+        public boolean enableIntrospectionRepeatableDirectives = false;
         public boolean openEditorWithIntrospectionResult = true;
+
         public boolean enableRelayModernFrameworkSupport;
         public boolean enableFederationSupport = false;
     }

src/main/com/intellij/lang/jsgraphql/types/introspection/IntrospectionQuery.java renamed to src/main/com/intellij/lang/jsgraphql/ide/introspection/GraphQLIntrospectionQuery.java

@@ -1,26 +1,6 @@
-/*
-    The MIT License (MIT)
+package com.intellij.lang.jsgraphql.ide.introspection;
 
-    Copyright (c) 2015 Andreas Marek and Contributors
-
-    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files
-    (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge,
-    publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do
-    so, subject to the following conditions:
-
-    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
-    OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-    LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-    CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- */
-package com.intellij.lang.jsgraphql.types.introspection;
-
-import com.intellij.lang.jsgraphql.types.PublicApi;
-
-@PublicApi
-public interface IntrospectionQuery {
+public interface GraphQLIntrospectionQuery {
 
     String INTROSPECTION_QUERY = "\n" +
         "  query IntrospectionQuery {\n" +
@@ -38,8 +18,7 @@ public interface IntrospectionQuery {
         "        args {\n" +
         "          ...InputValue\n" +
         "        }\n" +
-        // TODO: [intellij] support repeatable directive in introspection query
-        //            "        isRepeatable\n" +
+        "        isRepeatable\n" +
         "      }\n" +
         "    }\n" +
         "  }\n" +

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

@@ -336,10 +336,15 @@ private DirectiveDefinition createDirectiveDefinition(@NotNull Map<String, Objec
             .description(getDescription(definition))
             .directiveLocations(createDirectiveLocations((List<String>) definition.get("locations")))
             .inputValueDefinitions(inputValueDefinitions)
-            // .repeatable() TODO: [vepanimas] repeatable
+            .repeatable(isRepeatable(definition))
             .build();
     }
 
+    private boolean isRepeatable(@NotNull Map<String, Object> definition) {
+        Object isRepeatable = definition.get("isRepeatable");
+        return isRepeatable instanceof Boolean && (boolean) isRepeatable;
+    }
+
     @NotNull
     private static List<DirectiveLocation> createDirectiveLocations(@NotNull List<String> locations) {
         return ContainerUtil.mapNotNull(

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

@@ -23,7 +23,6 @@
 import com.intellij.lang.jsgraphql.schema.GraphQLSchemaInfo;
 import com.intellij.lang.jsgraphql.schema.GraphQLSchemaKeys;
 import com.intellij.lang.jsgraphql.types.GraphQLError;
-import com.intellij.lang.jsgraphql.types.introspection.IntrospectionQuery;
 import com.intellij.lang.jsgraphql.types.language.Document;
 import com.intellij.lang.jsgraphql.types.schema.idl.SchemaParser;
 import com.intellij.lang.jsgraphql.types.schema.idl.SchemaPrinter;
@@ -148,13 +147,7 @@ public void actionPerformed(@NotNull AnActionEvent e, @NotNull Notification noti
 
         try {
             final GraphQLSettings graphQLSettings = GraphQLSettings.getSettings(myProject);
-            String query = graphQLSettings.getIntrospectionQuery();
-            if (StringUtils.isBlank(query)) {
-                query = IntrospectionQuery.INTROSPECTION_QUERY;
-            }
-            if (!graphQLSettings.isEnableIntrospectionDefaultValues()) {
-                query = query.replace("defaultValue", "");
-            }
+            String query = buildIntrospectionQuery(graphQLSettings);
 
             final String requestJson = "{\"query\":\"" + StringEscapeUtils.escapeJavaScript(query) + "\"}";
             HttpPost request = createRequest(endpoint, url, requestJson);
@@ -165,6 +158,23 @@ public void actionPerformed(@NotNull AnActionEvent e, @NotNull Notification noti
         }
     }
 
+    @NotNull
+    private String buildIntrospectionQuery(@NotNull GraphQLSettings settings) {
+        String query = settings.getIntrospectionQuery();
+        if (!StringUtil.isEmptyOrSpaces(query)) {
+            return query;
+        }
+
+        query = GraphQLIntrospectionQuery.INTROSPECTION_QUERY;
+        if (!settings.isEnableIntrospectionRepeatableDirectives()) {
+            query = query.replace("isRepeatable", "");
+        }
+        if (!settings.isEnableIntrospectionDefaultValues()) {
+            query = query.replace("defaultValue", "");
+        }
+        return query;
+    }
+
     @NotNull
     public static HttpPost createRequest(@NotNull GraphQLConfigVariableAwareEndpoint endpoint,
                                          @NotNull String url,

src/main/com/intellij/lang/jsgraphql/types/schema/diff/DiffSet.java

@@ -21,11 +21,7 @@ The MIT License (MIT)
 
 import java.util.Map;
 
-/**
- * Represents 2 schemas that can be diffed.  The {@link SchemaDiff} code
- * assumes that that schemas to be diffed are the result of a
- * {@link com.intellij.lang.jsgraphql.types.introspection.IntrospectionQuery}.
- */
+
 @PublicApi
 public class DiffSet {
 

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

@@ -12,7 +12,6 @@
 import com.intellij.lang.jsgraphql.GraphQLSettings;
 import com.intellij.lang.jsgraphql.schema.library.GraphQLLibraryManager;
 import com.intellij.openapi.application.ApplicationManager;
-import com.intellij.openapi.application.WriteAction;
 import com.intellij.openapi.options.ConfigurationException;
 import com.intellij.openapi.options.SearchableConfigurable;
 import com.intellij.openapi.project.Project;
@@ -58,19 +57,19 @@ public JComponent createComponent() {
     public void apply() throws ConfigurationException {
         if (myProject.isDefault()) {
             myForm.apply();
-        } else {
-            boolean fireLibrariesChanged = myForm.shouldUpdateLibraries();
+            return;
+        }
 
-            WriteAction.run(() -> myForm.apply());
+        boolean fireLibrariesChanged = myForm.librarySettingsChanged();
 
-            if (fireLibrariesChanged) {
-                GraphQLLibraryManager.getInstance(myProject).notifyLibrariesChanged();
-            } else {
-                ApplicationManager.getApplication().invokeLater(() -> {
-                    DaemonCodeAnalyzer.getInstance(myProject).restart();
-                    EditorNotifications.getInstance(myProject).updateAllNotifications();
-                }, myProject.getDisposed());
-            }
+        myForm.apply();
+        if (fireLibrariesChanged) {
+            GraphQLLibraryManager.getInstance(myProject).notifyLibrariesChanged();
+        } else {
+            ApplicationManager.getApplication().invokeLater(() -> {
+                DaemonCodeAnalyzer.getInstance(myProject).restart();
+                EditorNotifications.getInstance(myProject).updateAllNotifications();
+            }, myProject.getDisposed());
         }
     }
 

src/main/com/intellij/lang/jsgraphql/ui/GraphQLProjectSettingsForm.form

@@ -13,7 +13,7 @@
           <grid row="2" column="0" row-span="1" col-span="1" vsize-policy="6" hsize-policy="1" anchor="0" fill="2" indent="0" use-parent-layout="false"/>
         </constraints>
       </vspacer>
-      <grid id="5f9ac" binding="introspectionPanel" layout-manager="GridLayoutManager" row-count="4" column-count="1" same-size-horizontally="false" same-size-vertically="false" hgap="-1" vgap="-1">
+      <grid id="5f9ac" binding="introspectionPanel" layout-manager="GridLayoutManager" row-count="5" column-count="1" same-size-horizontally="false" same-size-vertically="false" hgap="-1" vgap="-1">
         <margin top="0" left="0" bottom="0" right="0"/>
         <constraints>
           <grid row="0" column="0" row-span="1" col-span="1" vsize-policy="3" hsize-policy="3" anchor="0" fill="3" indent="0" use-parent-layout="false"/>
@@ -51,12 +51,21 @@
           </component>
           <component id="880f9" class="javax.swing.JCheckBox" binding="openEditorWithIntrospectionResult">
             <constraints>
-              <grid row="3" column="0" row-span="1" col-span="1" vsize-policy="0" hsize-policy="3" anchor="8" fill="0" indent="0" use-parent-layout="false"/>
+              <grid row="4" column="0" row-span="1" col-span="1" vsize-policy="0" hsize-policy="3" anchor="8" fill="0" indent="0" use-parent-layout="false"/>
             </constraints>
             <properties>
               <text resource-bundle="messages/GraphQLMessages" key="graphql.settings.introspection.open.editor.label"/>
             </properties>
           </component>
+          <component id="f9e30" class="javax.swing.JCheckBox" binding="enableIntrospectionRepeatableDirectives">
+            <constraints>
+              <grid row="3" column="0" row-span="1" col-span="1" vsize-policy="0" hsize-policy="3" anchor="8" fill="0" indent="0" use-parent-layout="false"/>
+            </constraints>
+            <properties>
+              <text resource-bundle="messages/GraphQLMessages" key="graphql.settings.introspection.repeatable.directives.label"/>
+              <toolTipText resource-bundle="messages/GraphQLMessages" key="graphql.settings.introspection.repeatable.directives.tooltip"/>
+            </properties>
+          </component>
         </children>
       </grid>
       <grid id="ed16d" binding="frameworksPanel" layout-manager="GridLayoutManager" row-count="1" column-count="2" same-size-horizontally="false" same-size-vertically="false" hgap="-1" vgap="-1">

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

@@ -32,6 +32,7 @@ public class GraphQLProjectSettingsForm {
     private JCheckBox enableRelay;
     private JCheckBox enableFederation;
     private JCheckBox openEditorWithIntrospectionResult;
+    private JCheckBox enableIntrospectionRepeatableDirectives;
 
     private GraphQLSettings mySettings;
 
@@ -53,29 +54,36 @@ JPanel getComponent() {
 
     void apply() {
         mySettings.setIntrospectionQuery(introspectionQueryTextField.getText());
-        mySettings.setRelaySupportEnabled(enableRelay.isSelected());
-        mySettings.setFederationSupportEnabled(enableFederation.isSelected());
         mySettings.setEnableIntrospectionDefaultValues(enableIntrospectionDefaultValues.isSelected());
+        mySettings.setEnableIntrospectionRepeatableDirectives(enableIntrospectionRepeatableDirectives.isSelected());
         mySettings.setOpenEditorWithIntrospectionResult(openEditorWithIntrospectionResult.isSelected());
+
+        mySettings.setRelaySupportEnabled(enableRelay.isSelected());
+        mySettings.setFederationSupportEnabled(enableFederation.isSelected());
     }
 
     void reset() {
         introspectionQueryTextField.setText(mySettings.getIntrospectionQuery());
         enableIntrospectionDefaultValues.setSelected(mySettings.isEnableIntrospectionDefaultValues());
+        enableIntrospectionRepeatableDirectives.setSelected(mySettings.isEnableIntrospectionRepeatableDirectives());
+        openEditorWithIntrospectionResult.setSelected(mySettings.isOpenEditorWithIntrospectionResult());
+
         enableRelay.setSelected(mySettings.isRelaySupportEnabled());
         enableFederation.setSelected(mySettings.isFederationSupportEnabled());
-        openEditorWithIntrospectionResult.setSelected(mySettings.isOpenEditorWithIntrospectionResult());
     }
 
     boolean isModified() {
+        return introspectionSettingsChanged() || librarySettingsChanged();
+    }
+
+    boolean introspectionSettingsChanged() {
         return !Objects.equals(mySettings.getIntrospectionQuery(), introspectionQueryTextField.getText()) ||
             mySettings.isEnableIntrospectionDefaultValues() != enableIntrospectionDefaultValues.isSelected() ||
-            mySettings.isOpenEditorWithIntrospectionResult() != openEditorWithIntrospectionResult.isSelected() ||
-            shouldUpdateLibraries();
-
+            mySettings.isEnableIntrospectionRepeatableDirectives() != enableIntrospectionRepeatableDirectives.isSelected() ||
+            mySettings.isOpenEditorWithIntrospectionResult() != openEditorWithIntrospectionResult.isSelected();
     }
 
-    boolean shouldUpdateLibraries() {
+    boolean librarySettingsChanged() {
         return mySettings.isRelaySupportEnabled() != enableRelay.isSelected() ||
             mySettings.isFederationSupportEnabled() != enableFederation.isSelected();
     }

src/test/com/intellij/lang/jsgraphql/ide/editor/GraphQLIntrospectionServiceTest.java

@@ -40,6 +40,10 @@ public void testPrintIntrospectionWithNullFields() {
         doTest("schemaWithNullFields.json", "schemaWithNullFields.graphql");
     }
 
+    public void testPrintIntrospectionRepeatableDirectives() {
+        doTest("schemaWithRepeatableDirectives.json", "schemaWithRepeatableDirectives.graphql");
+    }
+
     public void testGithubSchema() {
         // test only for being successful, file comparison doesn't give a meaningful result for files of this size
         assertNoThrowable(() -> new GraphQLIntrospectionService(getProject())