Handle escaped backticks in gql tagged template literals (#279)

Author: jimkyndemeyer

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

@@ -17,6 +17,7 @@
 import com.intellij.lang.annotation.AnnotationHolder;
 import com.intellij.lang.annotation.AnnotationSession;
 import com.intellij.lang.annotation.Annotator;
+import com.intellij.lang.jsgraphql.ide.project.GraphQLInjectionSearchHelper;
 import com.intellij.lang.jsgraphql.ide.project.GraphQLPsiSearchHelper;
 import com.intellij.lang.jsgraphql.psi.GraphQLArgument;
 import com.intellij.lang.jsgraphql.psi.GraphQLDirective;
@@ -28,12 +29,10 @@
 import com.intellij.lang.jsgraphql.schema.GraphQLTypeDefinitionRegistryServiceImpl;
 import com.intellij.lang.jsgraphql.schema.GraphQLTypeScopeProvider;
 import com.intellij.lang.jsgraphql.utils.GraphQLUtil;
+import com.intellij.openapi.components.ServiceManager;
 import com.intellij.openapi.editor.Editor;
 import com.intellij.openapi.editor.LogicalPosition;
 import com.intellij.openapi.editor.colors.CodeInsightColors;
-import com.intellij.openapi.fileEditor.FileEditor;
-import com.intellij.openapi.fileEditor.FileEditorManager;
-import com.intellij.openapi.fileEditor.TextEditor;
 import com.intellij.openapi.project.Project;
 import com.intellij.openapi.util.Key;
 import com.intellij.openapi.util.Pair;
@@ -371,7 +370,14 @@ boolean isInsideTemplateElement(PsiElement psiElement) {
      * @return the transformed valid GraphQL as a string
      */
     private String replacePlaceholdersWithValidGraphQL(PsiFile graphqlPsiFile) {
-        final StringBuffer buffer = new StringBuffer(graphqlPsiFile.getText());
+        String graphqlText = graphqlPsiFile.getText();
+        if (graphqlPsiFile.getContext() instanceof PsiLanguageInjectionHost) {
+            final GraphQLInjectionSearchHelper graphQLInjectionSearchHelper = ServiceManager.getService(GraphQLInjectionSearchHelper.class);
+            if (graphQLInjectionSearchHelper != null) {
+                graphqlText = graphQLInjectionSearchHelper.applyInjectionDelimitingQuotesEscape(graphqlText);
+            }
+        }
+        final StringBuffer buffer = new StringBuffer(graphqlText);
         final GraphQLVisitor visitor = new GraphQLVisitor() {
             @Override
             public void visitTemplateDefinition(@NotNull GraphQLTemplateDefinition templateDefinition) {

src/main/com/intellij/lang/jsgraphql/ide/project/GraphQLInjectionSearchHelper.java

@@ -9,6 +9,7 @@
 
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiFile;
+import com.intellij.psi.PsiLanguageInjectionHost;
 import com.intellij.psi.search.GlobalSearchScope;
 
 import java.util.function.Consumer;
@@ -29,4 +30,12 @@ public interface GraphQLInjectionSearchHelper {
      */
     void processInjectedGraphQLPsiFiles(PsiElement scopedElement, GlobalSearchScope schemaScope, Consumer<PsiFile> consumer);
 
+    /**
+     * Inline-replaces the use of escaped string quotes which delimit GraphQL injections, e.g. an escaped backtick '\`'
+     * in JavaScript tagged template literals, such that the injected GraphQL text represents valid GraphQL
+     * @param rawGraphQLText the raw injected GraphQL text to escape
+     * @return the text with injection-delimiting escaped while preserving text length and token positions, e.g. '\`' becomes ' `'
+     * @see PsiLanguageInjectionHost#createLiteralTextEscaper()
+     */
+    String applyInjectionDelimitingQuotesEscape(String rawGraphQLText);
 }

src/main/com/intellij/lang/jsgraphql/ide/project/javascript/GraphQLJavascriptInjectionSearchHelper.java

@@ -17,6 +17,7 @@
 import com.intellij.psi.PsiRecursiveElementVisitor;
 import com.intellij.psi.search.GlobalSearchScope;
 import com.intellij.util.indexing.FileBasedIndex;
+import org.apache.commons.lang.StringUtils;
 
 import java.util.Collections;
 import java.util.function.Consumer;
@@ -62,4 +63,14 @@ public void visitElement(PsiElement element) {
             // can't search yet (e.g. during project startup)
         }
     }
+
+    @Override
+    public String applyInjectionDelimitingQuotesEscape(String rawGraphQLText) {
+        if (rawGraphQLText != null && rawGraphQLText.contains("\\`")) {
+            // replace escaped backticks in template literals with a whitespace and the backtick to preserve token
+            // positions for error mappings etc.
+            return StringUtils.replace(rawGraphQLText, "\\`", " `");
+        }
+        return rawGraphQLText;
+    }
 }

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

@@ -15,6 +15,7 @@
 import com.intellij.lang.jsgraphql.GraphQLLanguage;
 import com.intellij.lang.jsgraphql.endpoint.ide.project.JSGraphQLEndpointNamedTypeRegistry;
 import com.intellij.lang.jsgraphql.ide.editor.GraphQLIntrospectionHelper;
+import com.intellij.lang.jsgraphql.ide.project.GraphQLInjectionSearchHelper;
 import com.intellij.lang.jsgraphql.ide.project.GraphQLPsiSearchHelper;
 import com.intellij.lang.jsgraphql.ide.project.graphqlconfig.GraphQLConfigManager;
 import com.intellij.lang.jsgraphql.psi.GraphQLDirective;
@@ -60,6 +61,7 @@ public class SchemaIDLTypeDefinitionRegistry {
     private final PsiManager psiManager;
     private final JSGraphQLEndpointNamedTypeRegistry graphQLEndpointNamedTypeRegistry;
     private final GraphQLConfigManager graphQLConfigManager;
+    private final GraphQLInjectionSearchHelper graphQLInjectionSearchHelper;
 
     private final Map<GlobalSearchScope, TypeDefinitionRegistryWithErrors> scopeToRegistry = Maps.newConcurrentMap();
 
@@ -75,6 +77,7 @@ public SchemaIDLTypeDefinitionRegistry(Project project) {
         graphQLEndpointNamedTypeRegistry = JSGraphQLEndpointNamedTypeRegistry.getService(project);
         graphQLPsiSearchHelper = GraphQLPsiSearchHelper.getService(project);
         graphQLConfigManager = GraphQLConfigManager.getService(project);
+        graphQLInjectionSearchHelper = ServiceManager.getService(GraphQLInjectionSearchHelper.class);
         project.getMessageBus().connect().subscribe(GraphQLSchemaChangeListener.TOPIC, new GraphQLSchemaEventListener() {
             @Override
             public void onGraphQLSchemaChanged(Integer schemaVersion) {
@@ -172,7 +175,10 @@ public TypeDefinitionRegistryWithErrors getRegistryWithErrors(PsiElement scopedE
                         }
 
                         try {
-                            final String definitionSourceText = typeSystemDefinition.getText();
+                            String definitionSourceText = typeSystemDefinition.getText();
+                            if (graphQLInjectionSearchHelper != null && psiFile.getContext() instanceof PsiLanguageInjectionHost) {
+                                definitionSourceText = graphQLInjectionSearchHelper.applyInjectionDelimitingQuotesEscape(definitionSourceText);
+                            }
                             final StringBuffer typeSystemDefinitionBuffer = new StringBuffer(definitionPrefix.length() + definitionSourceText.length());
                             typeSystemDefinitionBuffer.append(definitionPrefix).append(definitionSourceText);
                             // if there are syntax errors on optional elements, replace them with whitespace

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

@@ -19,4 +19,9 @@ const schema1 = gql`
             valueFromServer
         }
     }
+    
+    type EscapedBacktick {
+        "Description with escaped backtick \`"
+        field: Foo
+    }
 `;