Merge pull request #2471 from graphql-java/escape-multiline-triple-quotes

andimarek · web-flow · commit b525ada641ba · 2021-07-18T06:48:06.000+10:00
Escape triple quotes in multiline descriptions correctly
diff --git a/src/main/java/graphql/schema/idl/SchemaPrinter.java b/src/main/java/graphql/schema/idl/SchemaPrinter.java
@@ -53,6 +53,7 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+import static com.google.common.base.Predicates.not;
 import static graphql.Directives.DeprecatedDirective;
 import static graphql.introspection.Introspection.DirectiveLocation.ARGUMENT_DEFINITION;
 import static graphql.introspection.Introspection.DirectiveLocation.ENUM_VALUE;
@@ -78,6 +79,12 @@ public class SchemaPrinter {
             .validLocations(FIELD_DEFINITION, ENUM_VALUE, ARGUMENT_DEFINITION, INPUT_FIELD_DEFINITION)
             .build();
 
+    /**
+     * This predicate excludes all directives which are specified bt the GraphQL Specification.
+     * Printing these directives is optional.
+     */
+    public static final Predicate<GraphQLDirective> ExcludeGraphQLSpecifiedDirectivesPredicate = not(DirectiveInfo::isGraphqlSpecifiedDirective);
+
     /**
      * Options to use when printing a schema
      */
@@ -989,7 +996,10 @@ private void printMultiLineHashDescription(PrintWriter out, String prefix, List<
 
     private void printMultiLineDescription(PrintWriter out, String prefix, List<String> lines) {
         out.printf("%s\"\"\"\n", prefix);
-        lines.forEach(l -> out.printf("%s%s\n", prefix, l));
+        lines.forEach(l -> {
+            String escapedTripleQuotes = l.replaceAll("\"\"\"", "\\\\\"\"\"");
+            out.printf("%s%s\n", prefix, escapedTripleQuotes);
+        });
         out.printf("%s\"\"\"\n", prefix);
     }
 
diff --git a/src/test/groovy/graphql/schema/idl/SchemaPrinterTest.groovy b/src/test/groovy/graphql/schema/idl/SchemaPrinterTest.groovy
@@ -42,6 +42,7 @@ import static graphql.schema.GraphQLNonNull.nonNull
 import static graphql.schema.GraphQLObjectType.newObject
 import static graphql.schema.GraphQLScalarType.newScalar
 import static graphql.schema.idl.RuntimeWiring.newRuntimeWiring
+import static graphql.schema.idl.SchemaPrinter.ExcludeGraphQLSpecifiedDirectivesPredicate
 import static graphql.schema.idl.SchemaPrinter.Options.defaultOptions
 
 class SchemaPrinterTest extends Specification {
@@ -75,7 +76,7 @@ class SchemaPrinterTest extends Specification {
             throw new UnsupportedOperationException("Not implemented")
         }
     })
-    .build()
+            .build()
 
     def resolver = new TypeResolver() {
 
@@ -514,7 +515,7 @@ type Query {
 
     def "prints scalar description as comment"() {
         given:
-        GraphQLScalarType myScalar = newScalar().name("Scalar").description( "about scalar").coercing(new Coercing() {
+        GraphQLScalarType myScalar = newScalar().name("Scalar").description("about scalar").coercing(new Coercing() {
             @Override
             Object serialize(Object input) {
                 return null
@@ -530,7 +531,7 @@ type Query {
                 return null
             }
         })
-        .build()
+                .build()
         GraphQLFieldDefinition fieldDefinition = newFieldDefinition()
                 .name("field").type(myScalar).build()
         def queryType = newObject().name("Query").field(fieldDefinition).build()
@@ -1648,7 +1649,7 @@ scalar CustomScalar
                 return null
             }
         })
-        .build()
+                .build()
 
         GraphQLFieldDefinition fieldDefinition = newFieldDefinition()
                 .name("scalarType").type(myScalar).build()
@@ -1690,7 +1691,7 @@ scalar RandomScalar
                 return null
             }
         })
-        .build()
+                .build()
 
         GraphQLFieldDefinition fieldDefinition = newFieldDefinition()
                 .name("someType").type(GraphQLInt).build()
@@ -1907,4 +1908,22 @@ type MyQuery {
         result == """directive @foo on FIELD_DEFINITION"""
     }
 
+    def "description printing escapes triple quotes"() {
+        def descriptionWithTripleQuote = 'Hello """ \n World """ """';
+        def field = newFieldDefinition().name("hello").type(GraphQLString).build()
+        def queryType = newObject().name("Query").field(field).description(descriptionWithTripleQuote).build()
+        def schema = GraphQLSchema.newSchema().query(queryType).build()
+        when:
+        def result = new SchemaPrinter(defaultOptions().includeDirectives(ExcludeGraphQLSpecifiedDirectivesPredicate)).print(schema)
+
+        then:
+        result == '''"""
+Hello \\""" 
+ World \\""" \\"""
+"""
+type Query {
+  hello: String
+}
+'''
+    }
 }
