Fixed source location deltas as part of upgrade to graphql-java 12.0 (#238)

Author: jimkyndemeyer

src/main/com/intellij/lang/jsgraphql/ide/GraphQLValidationAnnotator.java

@@ -186,7 +186,14 @@ public void annotate(@NotNull PsiElement psiElement, @NotNull AnnotationHolder a
             // store the editor since we need to translate graphql-java source locations to psi elements
             Editor editor = session.getUserData(EDITOR);
             if (editor == null) {
-                final FileEditor fileEditor = FileEditorManager.getInstance(project).getSelectedEditor(containingFile.getVirtualFile());
+                FileEditor fileEditor = FileEditorManager.getInstance(project).getSelectedEditor(containingFile.getVirtualFile());
+                if (fileEditor == null && containingFile.getContext() != null) {
+                    // injected PsiFile so try to get the editor from the hosting/context file
+                    final PsiFile contextFile = containingFile.getContext().getContainingFile();
+                    if (contextFile != null) {
+                        fileEditor = FileEditorManager.getInstance(project).getSelectedEditor(contextFile.getVirtualFile());
+                    }
+                }
                 if (fileEditor instanceof TextEditor) {
                     editor = ((TextEditor) fileEditor).getEditor();
                     session.putUserData(EDITOR, editor);

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

@@ -14,6 +14,7 @@
 import com.intellij.lang.javascript.JSTokenTypes;
 import com.intellij.lang.javascript.psi.ecma6.JSStringTemplateExpression;
 import com.intellij.lang.jsgraphql.GraphQLLanguage;
+import com.intellij.openapi.application.ApplicationManager;
 import com.intellij.openapi.util.TextRange;
 import com.intellij.openapi.vfs.VirtualFile;
 import com.intellij.psi.PsiElement;
@@ -66,7 +67,7 @@ public void getLanguagesToInject(@NotNull MultiHostRegistrar registrar, @NotNull
 
             // update graphql config notifications
             final VirtualFile virtualFile = context.getContainingFile().getVirtualFile();
-            if(virtualFile != null) {
+            if(virtualFile != null && !ApplicationManager.getApplication().isUnitTestMode()) {
                 EditorNotifications.getInstance(context.getProject()).updateNotifications(virtualFile);
             }
         }

src/main/com/intellij/lang/jsgraphql/schema/SchemaIDLTypeDefinitionRegistry.java

@@ -201,11 +201,9 @@ public TypeDefinitionRegistryWithErrors getRegistryWithErrors(PsiElement scopedE
                                 if(e.getCause() instanceof RecognitionException) {
                                     final Token offendingToken = ((RecognitionException) e.getCause()).getOffendingToken();
                                     if(offendingToken != null) {
-                                        final List<SourceLocation> sourceLocation = Collections.singletonList(new SourceLocation(
-                                                offendingToken.getLine(),
-                                                offendingToken.getCharPositionInLine() + 1,
-                                                GraphQLPsiSearchHelper.getFileName(psiFile)
-                                        ));
+                                        final List<SourceLocation> sourceLocation = Collections.singletonList(
+                                                GraphQLUtil.createSourceLocationFromDelta(offendingToken, lineDelta.get() + injectionLineDelta, injectedFirstLineColumnDelta)
+                                        );
                                         errors.add(new SchemaProblem(Collections.singletonList(new InvalidSyntaxError(sourceLocation, "Unexpected token: \"" + offendingToken.getText() + "\""))));
                                     }
                                 }

src/main/com/intellij/lang/jsgraphql/utils/GraphQLUtil.java

@@ -42,6 +42,31 @@ public static Document parseDocument(String input, int lineDelta, int firstLineC
         return parseDocument(input, null, lineDelta, firstLineColumnDelta);
     }
 
+    /**
+     *
+     * Creates a source location based on a token and line/column offsets
+     * @param token the token to create a location for
+     * @param lineDelta the delta line to apply to the document and all child nodes
+     * @param firstLineColumnDelta the column delta for the first line
+     * @return the offset location for the token
+     */
+    public static SourceLocation createSourceLocationFromDelta(Token token, int lineDelta, int firstLineColumnDelta) {
+        String sourceName = token.getTokenSource().getSourceName();
+        if (IntStream.UNKNOWN_SOURCE_NAME.equals(sourceName)) {
+            // UNKNOWN_SOURCE_NAME is Antrl's way of indicating that no source name was given during parsing --
+            // which is the case when queries and other operations are parsed. We don't want this hardcoded
+            // '<unknown>' sourceName to leak to clients when the response is serialized as JSON, so we null it.
+            sourceName = null;
+        }
+        int line = token.getLine();
+        int column = token.getCharPositionInLine() + 1;
+        if(line == 0 && firstLineColumnDelta > 0) {
+            column += firstLineColumnDelta;
+        }
+        line += lineDelta;
+        return new SourceLocation(line, column, sourceName);
+    }
+
     /**
      * Parses GraphQL string input into a graphql-java Document, shifting the source locations in the specified document with the specified line delta.
      * Shifting of the sourceLocation is required for proper error reporting locations for GraphQL language injections, e.g. GraphQL in a JavaScript file.
@@ -77,21 +102,12 @@ public static Document parseDocument(String input, String sourceName, int lineDe
         GraphqlAntlrToLanguage antlrToLanguage = new GraphqlAntlrToLanguage(tokens, multiSourceReader) {
             @Override
             protected SourceLocation getSourceLocation(ParserRuleContext parserRuleContext) {
-                Token startToken = parserRuleContext.getStart();
-                String sourceName = startToken.getTokenSource().getSourceName();
-                if (IntStream.UNKNOWN_SOURCE_NAME.equals(sourceName)) {
-                    // UNKNOWN_SOURCE_NAME is Antrl's way of indicating that no source name was given during parsing --
-                    // which is the case when queries and other operations are parsed. We don't want this hardcoded
-                    // '<unknown>' sourceName to leak to clients when the response is serialized as JSON, so we null it.
-                    sourceName = null;
-                }
-                int line = startToken.getLine();
-                int column = startToken.getCharPositionInLine() + 1;
-                if(line == 1 && firstLineColumnDelta > 0) {
-                    column += firstLineColumnDelta;
-                }
-                line += lineDelta;
-                return new SourceLocation(line, column, sourceName);
+                return createSourceLocationFromDelta(parserRuleContext.getStart(), lineDelta, firstLineColumnDelta);
+            }
+
+            @Override
+            protected SourceLocation getSourceLocation(Token token) {
+                return createSourceLocationFromDelta(token, lineDelta, firstLineColumnDelta);
             }
         };
         Document doc = antlrToLanguage.createDocument(documentContext);

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

@@ -21,7 +21,12 @@ public class GraphQLInjectionCodeInsightTest extends LightCodeInsightFixtureTest
     @Override
     public void setUp() throws Exception {
         super.setUp();
-        myFixture.configureByFiles(".graphqlconfig", "schema.graphql");
+        myFixture.configureByFiles(
+                "schema.graphql",
+                ".graphqlconfig",
+                "lines-1/.graphqlconfig",
+                "lines-2/.graphqlconfig"
+        );
         // use the synchronous method of building the configuration for the unit test
         GraphQLConfigManager.getService(getProject()).doBuildConfigurationModel(null);
     }
@@ -34,11 +39,29 @@ protected String getTestDataPath() {
     // ---- highlighting -----
 
     @Test
-    public void testErrorAnnotator() {
+    public void testErrorAnnotatorOnFragments() {
         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
+    public void testErrorAnnotatorSourceLines1() {
+        myFixture.configureByFiles("lines-1/injection-source-lines-1.js");
+        final List<HighlightInfo> highlighting = myFixture.doHighlighting(HighlightSeverity.ERROR);
+        assertEquals("Expected just one error", 1, highlighting.size());
+        assertEquals("Should mark ServerType with an error", "ServerType", highlighting.get(0).getText());
+        assertEquals("Should mark ServerType in the right injected position", 201, highlighting.get(0).getStartOffset());
+    }
+
+    @Test
+    public void testErrorAnnotatorSourceLines2() {
+        myFixture.configureByFiles("lines-2/injection-source-lines-2.js");
+        final List<HighlightInfo> highlighting = myFixture.doHighlighting(HighlightSeverity.ERROR);
+        assertEquals("Expected just one error", 1, highlighting.size());
+        assertEquals("Should mark OutputType with an error", "OutputType", highlighting.get(0).getText());
+        assertEquals("Should mark OutputType in the right injected position", 209, highlighting.get(0).getStartOffset());
+    }
+
 }

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

@@ -1,3 +1,4 @@
 {
-  "name": "Injection Test GraphQL Schema"
+  "name": "Injection Test GraphQL Schema",
+  "includes": ["*"]
 }

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

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

test-resources/testData/graphql/injection/lines-1/injection-source-lines-1.js

@@ -0,0 +1,22 @@
+//
+// line deltas
+//
+
+const schema1 = gql`
+    
+    scalar Foo
+    
+    type ServerType {
+        valueFromServer: Foo!
+    }
+
+    type Query {
+        hello: Foo
+    }
+
+    query Foo {
+        ... on ServerType {
+            valueFromServer
+        }
+    }
+`;

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

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

test-resources/testData/graphql/injection/lines-2/injection-source-lines-2.js

@@ -0,0 +1,21 @@
+//
+// line deltas
+//
+
+const schema2 = gql`
+    
+    scalar Foo
+    
+    type OutputType {
+        someField: Foo!
+    }
+
+    type Query {
+        hello: Foo
+    }
+
+    type SchemaError {
+        argument(foo: OutputType): Foo
+    }
+
+`;