Detect GraphQL language injection using language=GraphQL injection comments (#235)

- Fixes discovery of fragment definitions in manually injected GraphQL
- Enables schema discovery to run on manual injections

Author: jimkyndemeyer

build.gradle

@@ -42,7 +42,7 @@ intellij {
     type 'IU'
     updateSinceUntilBuild = false
     pluginName 'JS GraphQL'
-    plugins = ['JavaScriptLanguage', 'CSS']
+    plugins = ['JavaScriptLanguage', 'CSS', 'IntelliLang']
     ideaDependencyCachePath = project.buildDir
 }
 

resources/META-INF/graphql-intellilang.xml

@@ -0,0 +1,5 @@
+<idea-plugin>
+    <extensions defaultExtensionNs="com.intellij">
+        <applicationService serviceInterface="com.intellij.lang.jsgraphql.ide.injection.GraphQLCommentBasedInjectionHelper" serviceImplementation="com.intellij.lang.jsgraphql.ide.injection.GraphQLCommentBasedInjectionHelperImpl" />
+    </extensions>
+</idea-plugin>

resources/META-INF/plugin.xml

@@ -74,6 +74,7 @@
 
   <depends>com.intellij.modules.lang</depends>
   <depends optional="true" config-file="graphql-javascript.xml">JavaScript</depends>
+  <depends optional="true" config-file="graphql-intellilang.xml">org.intellij.intelliLang</depends>
 
   <extensionPoints>
     <extensionPoint name="graphQLFindUsagesFileTypeContributor" interface="com.intellij.lang.jsgraphql.ide.references.GraphQLFindUsagesFileTypeContributor" />

src/main/com/intellij/lang/jsgraphql/ide/injection/GraphQLCommentBasedInjectionHelper.java

@@ -0,0 +1,23 @@
+/*
+ *  Copyright (c) 2019-present, Jim Kynde Meyer
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the MIT license found in the
+ *  LICENSE file in the root directory of this source tree.
+ */
+package com.intellij.lang.jsgraphql.ide.injection;
+
+import com.intellij.openapi.util.Ref;
+import com.intellij.psi.PsiElement;
+import org.jetbrains.annotations.Nullable;
+
+public interface GraphQLCommentBasedInjectionHelper {
+
+    /**
+     * Gets whether the specified host element has a GraphQL injection based a language=GraphQL comment
+     * @param host the host to check
+     * @param envRef optional GraphQL environment ref to set if the host is a match
+     * @return <code>true</code> if the host has an active GraphQL injection, <code>false</code> otherwise
+     */
+    boolean isGraphQLInjectedUsingComment(PsiElement host, @Nullable Ref<String> envRef);
+}

src/main/com/intellij/lang/jsgraphql/ide/injection/GraphQLCommentBasedInjectionHelperImpl.java

@@ -0,0 +1,34 @@
+/*
+ *  Copyright (c) 2019-present, Jim Kynde Meyer
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the MIT license found in the
+ *  LICENSE file in the root directory of this source tree.
+ */
+package com.intellij.lang.jsgraphql.ide.injection;
+
+import com.intellij.lang.jsgraphql.GraphQLLanguage;
+import com.intellij.openapi.util.Ref;
+import com.intellij.psi.PsiElement;
+import org.intellij.plugins.intelliLang.inject.InjectorUtils;
+import org.jetbrains.annotations.Nullable;
+
+/**
+ * Detects manual GraphQL injections using IntelliLang <code>language=GraphQL</code> injection comments.
+ */
+public class GraphQLCommentBasedInjectionHelperImpl implements GraphQLCommentBasedInjectionHelper {
+
+    @Override
+    public boolean isGraphQLInjectedUsingComment(PsiElement host, @Nullable Ref<String> envRef) {
+        final InjectorUtils.CommentInjectionData injectionData = InjectorUtils.findCommentInjectionData(host, true, null);
+        if (injectionData != null) {
+            if (GraphQLLanguage.INSTANCE.getID().equals(injectionData.getInjectedLanguageId())) {
+                if (envRef != null) {
+                    envRef.set("graphql");
+                }
+                return true;
+            }
+        }
+        return false;
+    }
+}

src/main/com/intellij/lang/jsgraphql/ide/injection/javascript/GraphQLLanguageInjectionUtil.java

@@ -13,7 +13,9 @@
 import com.intellij.lang.javascript.psi.JSFile;
 import com.intellij.lang.javascript.psi.JSReferenceExpression;
 import com.intellij.lang.javascript.psi.ecma6.JSStringTemplateExpression;
+import com.intellij.lang.jsgraphql.ide.injection.GraphQLCommentBasedInjectionHelper;
 import com.intellij.lang.jsgraphql.psi.GraphQLFile;
+import com.intellij.openapi.components.ServiceManager;
 import com.intellij.openapi.project.Project;
 import com.intellij.openapi.util.Ref;
 import com.intellij.openapi.util.TextRange;
@@ -110,6 +112,11 @@ public static boolean isJSGraphQLLanguageInjectionTarget(PsiElement host, @Nulla
                     return true;
                 }
             }
+            // also check for "manual" language=GraphQL injection comments
+            final GraphQLCommentBasedInjectionHelper commentBasedInjectionHelper = ServiceManager.getService(GraphQLCommentBasedInjectionHelper.class);
+            if (commentBasedInjectionHelper != null) {
+                return commentBasedInjectionHelper.isGraphQLInjectedUsingComment(host, envRef);
+            }
         }
         return false;
     }

src/test/com/intellij/lang/jsgraphql/injection/GraphQLInjectionCodeInsightTest.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright (c) 2019-present, Jim Kynde Meyer
+ * All rights reserved.
+ * <p>
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+package com.intellij.lang.jsgraphql.injection;
+
+import com.intellij.codeInsight.daemon.impl.HighlightInfo;
+import com.intellij.lang.annotation.HighlightSeverity;
+import com.intellij.lang.jsgraphql.ide.project.graphqlconfig.GraphQLConfigManager;
+import com.intellij.testFramework.fixtures.LightCodeInsightFixtureTestCase;
+import org.junit.Test;
+
+import java.util.List;
+
+
+public class GraphQLInjectionCodeInsightTest extends LightCodeInsightFixtureTestCase {
+
+    @Override
+    public void setUp() throws Exception {
+        super.setUp();
+        myFixture.configureByFiles(".graphqlconfig", "schema.graphql");
+        // use the synchronous method of building the configuration for the unit test
+        GraphQLConfigManager.getService(getProject()).doBuildConfigurationModel(null);
+    }
+
+    @Override
+    protected String getTestDataPath() {
+        return "test-resources/testData/graphql/injection";
+    }
+
+    // ---- highlighting -----
+
+    @Test
+    public void testErrorAnnotator() {
+        myFixture.configureByFiles("injection-comment.js");
+        final List<HighlightInfo> highlighting = myFixture.doHighlighting(HighlightSeverity.ERROR);
+        assertEquals("Expected just one error", 1, highlighting.size());
+        assertEquals("Unknown fragment name should be the error", "OnlyTheUnknownFragmentShouldBeHighlightedAsError", highlighting.get(0).getText());
+    }
+
+}

test-resources/testData/graphql/injection/.graphqlconfig

@@ -0,0 +1,3 @@
+{
+  "name": "Injection Test GraphQL Schema"
+}

test-resources/testData/graphql/injection/injection-comment.js

@@ -0,0 +1,28 @@
+const result = (
+    // language=GraphQL
+    {
+        query: `
+
+            extend type Query {
+                manualExtension: String
+            }                
+            
+            fragment Login on Login {
+                message
+                success
+            }
+
+            mutation login($email: String! $pwd: String!) {
+                login(email: $email pwd: $pwd) {
+                    ...Login
+                    ...OnlyTheUnknownFragmentShouldBeHighlightedAsError
+                }
+            }
+            
+            query Foo {
+                manualExtension
+            }
+        `
+    }
+);
+console.log(result);

test-resources/testData/graphql/injection/schema.graphql

@@ -0,0 +1,15 @@
+scalar String
+scalar Boolean
+
+type Query {
+    hello: String
+}
+
+type Mutation {
+    login(email: String, pwd: String): Login
+}
+
+type Login {
+    success: Boolean
+    message: String
+}