Line Markers for GraphQl navigation

META-INF/plugin.xml

@@ -35,6 +35,7 @@
     <depends>com.jetbrains.php</depends>
     <depends>JavaScript</depends>
     <depends>com.intellij.modules.platform</depends>
+    <depends>com.intellij.lang.jsgraphql</depends>
 
     <actions>
         <group id="MagentoGenerateGroup">
@@ -86,10 +87,13 @@
         <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.mftf.DataIndex" />
         <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.mftf.PageIndex" />
         <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.mftf.StepKeyIndex" />
+        <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.graphql.GraphQlResolverIndex" />
 
         <codeInsight.lineMarkerProvider language="PHP" implementationClass="com.magento.idea.magento2plugin.php.linemarker.PluginLineMarkerProvider"/>
         <codeInsight.lineMarkerProvider language="PHP" implementationClass="com.magento.idea.magento2plugin.php.linemarker.ClassConfigurationLineMarkerProvider"/>
         <codeInsight.lineMarkerProvider language="PHP" implementationClass="com.magento.idea.magento2plugin.php.linemarker.WebApiLineMarkerProvider"/>
+        <codeInsight.lineMarkerProvider language="GraphQL" implementationClass="com.magento.idea.magento2plugin.graphql.linemarker.GraphQlResolverClassLineMarkerProvider"/>
+        <codeInsight.lineMarkerProvider language="PHP" implementationClass="com.magento.idea.magento2plugin.php.linemarker.GraphQlResolverUsageLineMarkerProvider"/>
 
         <directoryProjectConfigurator implementation="com.magento.idea.magento2plugin.project.ProjectDetector"/>
 

src/com/magento/idea/magento2plugin/graphql/linemarker/GraphQlResolverClassLineMarkerProvider.java

@@ -0,0 +1,94 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+package com.magento.idea.magento2plugin.graphql.linemarker;
+
+import com.intellij.codeInsight.daemon.LineMarkerInfo;
+import com.intellij.codeInsight.daemon.LineMarkerProvider;
+import com.intellij.codeInsight.navigation.NavigationGutterIconBuilder;
+import com.intellij.lang.jsgraphql.psi.GraphQLArgument;
+import com.intellij.lang.jsgraphql.psi.GraphQLStringValue;
+import com.intellij.openapi.project.Project;
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.util.PsiTreeUtil;
+import com.jetbrains.php.PhpIcons;
+import com.jetbrains.php.PhpIndex;
+import com.jetbrains.php.lang.psi.elements.PhpClass;
+import com.magento.idea.magento2plugin.project.Settings;
+import com.magento.idea.magento2plugin.util.magento.graphql.GraphQlUtil;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+import java.util.*;
+
+public class GraphQlResolverClassLineMarkerProvider implements LineMarkerProvider {
+    @Nullable
+    @Override
+    public LineMarkerInfo getLineMarkerInfo(@NotNull PsiElement psiElement) {
+        return null;
+    }
+
+    @Override
+    public void collectSlowLineMarkers(@NotNull List<PsiElement> psiElements, @NotNull Collection<LineMarkerInfo> collection) {
+        if (psiElements.size() > 0) {
+            if (!Settings.isEnabled(psiElements.get(0).getProject())) {
+                return;
+            }
+        }
+
+        for (PsiElement psiElement : psiElements) {
+            if (psiElement instanceof GraphQLArgument) {
+                Collection<? extends PsiElement> results;
+
+                GraphQlResolverClassCollector collector = new GraphQlResolverClassCollector();
+                results = collector.getGraphQLResolverClasses((GraphQLArgument) psiElement);
+                GraphQLStringValue argumentStringValue = GraphQlUtil.fetchResolverQuotedStringFromArgument(psiElement);
+                if (argumentStringValue == null) {
+                    continue;
+                }
+
+                if (results.size() > 0 ) {
+                    collection.add(NavigationGutterIconBuilder
+                            .create(PhpIcons.CLASS)
+                            .setTargets(results)
+                            .setTooltipText("Navigate to class")
+                            .createLineMarkerInfo(PsiTreeUtil.getDeepestLast(argumentStringValue))
+                    );
+                }
+            }
+        }
+    }
+
+    private static class GraphQlResolverClassCollector {
+
+        private HashMap<String, Collection<PhpClass>> routesCache = new HashMap<>();
+
+
+        Collection<PhpClass> getGraphQLResolverClasses(@NotNull GraphQLArgument graphQLArgument) {
+            List<PhpClass> graphQLResolverClasses = new ArrayList<>();
+            GraphQLStringValue argumentStringValue = GraphQlUtil.fetchResolverQuotedStringFromArgument(graphQLArgument);
+            if (argumentStringValue == null) {
+                return graphQLResolverClasses;
+            }
+
+            graphQLResolverClasses.addAll(getUsages(argumentStringValue));
+
+            return graphQLResolverClasses;
+        }
+
+        Collection<PhpClass> getUsages(@NotNull GraphQLStringValue graphQLStringValue) {
+            String phpClassFQN = GraphQlUtil.resolverStringToPhpFQN(graphQLStringValue.getText());
+            if (!routesCache.containsKey(phpClassFQN)) {
+
+                Collection<PhpClass> phpClasses = extractClasses(phpClassFQN, graphQLStringValue.getProject());
+                routesCache.put(phpClassFQN, phpClasses);
+            }
+            return routesCache.get(phpClassFQN);
+        }
+
+        Collection<PhpClass> extractClasses(@NotNull String phpClassFQN, Project project) {
+            PhpIndex phpIndex = PhpIndex.getInstance(project);
+            return phpIndex.getClassesByFQN(phpClassFQN);
+        }
+    }
+}

src/com/magento/idea/magento2plugin/indexes/IndexManager.java

@@ -7,6 +7,7 @@
 import com.intellij.util.indexing.FileBasedIndexImpl;
 import com.intellij.util.indexing.ID;
 import com.magento.idea.magento2plugin.stubs.indexes.*;
+import com.magento.idea.magento2plugin.stubs.indexes.graphql.GraphQlResolverIndex;
 import com.magento.idea.magento2plugin.stubs.indexes.mftf.*;
 import com.magento.idea.magento2plugin.stubs.indexes.xml.PhpClassNameIndex;
 
@@ -36,7 +37,9 @@ public static void manualReindex() {
             DataIndex.KEY,
             PageIndex.KEY,
             SectionIndex.KEY,
-            StepKeyIndex.KEY
+            StepKeyIndex.KEY,
+             //graphql
+            GraphQlResolverIndex.KEY
         };
 
         for (ID<?, ?> id: indexIds) {

src/com/magento/idea/magento2plugin/php/linemarker/GraphQlResolverUsageLineMarkerProvider.java

@@ -0,0 +1,97 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+package com.magento.idea.magento2plugin.php.linemarker;
+
+import com.intellij.codeInsight.daemon.LineMarkerInfo;
+import com.intellij.codeInsight.daemon.LineMarkerProvider;
+import com.intellij.codeInsight.navigation.NavigationGutterIconBuilder;
+import com.intellij.lang.jsgraphql.GraphQLIcons;
+import com.intellij.lang.jsgraphql.psi.GraphQLQuotedString;
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.util.PsiTreeUtil;
+import com.jetbrains.php.lang.psi.elements.PhpClass;
+import com.magento.idea.magento2plugin.project.Settings;
+import com.magento.idea.magento2plugin.stubs.indexes.graphql.GraphQlResolverIndex;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.List;
+
+public class GraphQlResolverUsageLineMarkerProvider implements LineMarkerProvider {
+    @Nullable
+    @Override
+    public LineMarkerInfo getLineMarkerInfo(@NotNull PsiElement psiElement) {
+        return null;
+    }
+
+    @Override
+    public void collectSlowLineMarkers(@NotNull List<PsiElement> psiElements, @NotNull Collection<LineMarkerInfo> collection) {
+        if (psiElements.size() > 0) {
+            if (!Settings.isEnabled(psiElements.get(0).getProject())) {
+                return;
+            }
+        }
+
+        for (PsiElement psiElement : psiElements) {
+            if (psiElement instanceof PhpClass) {
+                List<? extends PsiElement> results;
+
+                if (!isResolver((PhpClass) psiElement)) {
+                    return;
+                }
+                GraphQlUsagesCollector collector = new GraphQlUsagesCollector();
+                results = collector.getGraphQLUsages((PhpClass) psiElement);
+
+                if (results.size() > 0 ) {
+                    collection.add(NavigationGutterIconBuilder
+                            .create(GraphQLIcons.FILE)
+                            .setTargets(results)
+                            .setTooltipText("Navigate to schema")
+                            .createLineMarkerInfo(PsiTreeUtil.getDeepestFirst(psiElement))
+                    );
+                }
+            }
+        }
+    }
+
+    private boolean isResolver(PhpClass psiElement) {
+        PhpClass[] implementedInterfaces = psiElement.getImplementedInterfaces();
+        for (PhpClass implementedInterface: implementedInterfaces) {
+            if (!implementedInterface.getFQN().equals("\\Magento\\Framework\\GraphQl\\Query\\ResolverInterface")) {
+                continue;
+            }
+            return true;
+        }
+        return false;
+    }
+
+    private static class GraphQlUsagesCollector {
+
+        private HashMap<String, List<GraphQLQuotedString>> routesCache = new HashMap<>();
+
+        List<GraphQLQuotedString> getGraphQLUsages(@NotNull PhpClass phpClass) {
+            List<GraphQLQuotedString> graphQLQuotedStrings = new ArrayList<>();
+
+            graphQLQuotedStrings.addAll(getUsages(phpClass));
+
+            return graphQLQuotedStrings;
+        }
+
+        List<GraphQLQuotedString> getUsages(@NotNull PhpClass phpClass) {
+            String phpClassFQN = phpClass.getFQN();
+            if (!routesCache.containsKey(phpClassFQN)) {
+                List<GraphQLQuotedString> graphQLStringValues = extractGraphQLQuotesStringsForClass(phpClass);
+                routesCache.put(phpClassFQN, graphQLStringValues);
+            }
+            return routesCache.get(phpClassFQN);
+        }
+
+        List<GraphQLQuotedString> extractGraphQLQuotesStringsForClass(@NotNull PhpClass phpClass) {
+            return GraphQlResolverIndex.getGraphQLUsages(phpClass);
+        }
+    }
+}