print union descriptions

andimarek · bbakerman · commit 2fd253d7645e · 2017-06-05T09:32:20.000+10:00
diff --git a/src/main/java/graphql/schema/idl/SchemaPrinter.java b/src/main/java/graphql/schema/idl/SchemaPrinter.java
@@ -176,6 +176,7 @@ private TypePrinter<GraphQLUnionType> unionPrinter() {
             if (isIntrospectionType(type)) {
                 return;
             }
+            printComments(out, type, "");
             out.format("union %s = ", type.getName());
             List<GraphQLOutputType> types = type.getTypes();
             for (int i = 0; i < types.size(); i++) {
@@ -185,7 +186,7 @@ private TypePrinter<GraphQLUnionType> unionPrinter() {
                 }
                 out.format("%s", objectType.getName());
             }
-            out.format("}\n\n");
+            out.format("\n\n");
         };
     }
 
@@ -356,6 +357,8 @@ private String getDescription(Object descriptionHolder) {
             return ((GraphQLFieldDefinition) descriptionHolder).getDescription();
         } else if (descriptionHolder instanceof GraphQLEnumValueDefinition) {
             return ((GraphQLEnumValueDefinition) descriptionHolder).getDescription();
+        } else if (descriptionHolder instanceof GraphQLUnionType) {
+            return ((GraphQLUnionType) descriptionHolder).getDescription();
         } else {
             return Assert.assertShouldNeverHappen();
         }
diff --git a/src/test/groovy/graphql/schema/idl/SchemaPrinterTest.groovy b/src/test/groovy/graphql/schema/idl/SchemaPrinterTest.groovy
@@ -12,11 +12,14 @@ import graphql.schema.GraphQLObjectType
 import graphql.schema.GraphQLScalarType
 import graphql.schema.GraphQLSchema
 import graphql.schema.GraphQLType
+import graphql.schema.GraphQLUnionType
 import graphql.schema.TypeResolver
 import spock.lang.Specification
 
 import java.util.function.UnaryOperator
 
+import static graphql.schema.GraphQLFieldDefinition.newFieldDefinition
+
 class SchemaPrinterTest extends Specification {
 
     def nonNull(GraphQLType type) {
@@ -228,7 +231,7 @@ type Subscription {
 
     def "prints object description as comment"() {
         given:
-        GraphQLFieldDefinition fieldDefinition = GraphQLFieldDefinition.newFieldDefinition()
+        GraphQLFieldDefinition fieldDefinition = newFieldDefinition()
                 .name("field").type(Scalars.GraphQLString).build()
         def queryType = GraphQLObjectType.newObject().name("Query").description("About Query\nSecond Line").field(fieldDefinition).build()
         def schema = GraphQLSchema.newSchema().query(queryType).build()
@@ -247,7 +250,7 @@ type Query {
 
     def "prints field description as comment"() {
         given:
-        GraphQLFieldDefinition fieldDefinition = GraphQLFieldDefinition.newFieldDefinition()
+        GraphQLFieldDefinition fieldDefinition = newFieldDefinition()
                 .name("field").description("About field\nsecond").type(Scalars.GraphQLString).build()
         def queryType = GraphQLObjectType.newObject().name("Query").field(fieldDefinition).build()
         def schema = GraphQLSchema.newSchema().query(queryType).build()
@@ -272,7 +275,7 @@ type Query {
                 .description("About enum")
                 .value("value", "value", "value desc")
                 .build()
-        GraphQLFieldDefinition fieldDefinition = GraphQLFieldDefinition.newFieldDefinition()
+        GraphQLFieldDefinition fieldDefinition = newFieldDefinition()
                 .name("field").type(graphQLEnumType).build()
         def queryType = GraphQLObjectType.newObject().name("Query").field(fieldDefinition).build()
         def schema = GraphQLSchema.newSchema().query(queryType).build()
@@ -290,6 +293,79 @@ enum Enum {
    value
 }
 
+"""
+
+    }
+
+    def "prints union description as comment"() {
+        given:
+        GraphQLFieldDefinition fieldDefinition = newFieldDefinition()
+                .name("field").type(Scalars.GraphQLString).build()
+        def possibleType = GraphQLObjectType.newObject().name("PossibleType").field(fieldDefinition).build()
+        GraphQLUnionType unionType = GraphQLUnionType.newUnionType()
+                .name("Union")
+                .description("About union")
+                .possibleType(possibleType)
+                .typeResolver({ it -> null })
+                .build()
+        GraphQLFieldDefinition fieldDefinition2 = newFieldDefinition()
+                .name("field").type(unionType).build()
+        def queryType = GraphQLObjectType.newObject().name("Query").field(fieldDefinition2).build()
+        def schema = GraphQLSchema.newSchema().query(queryType).build()
+        when:
+        def result = new SchemaPrinter().print(schema)
+
+        then:
+        result == """#About union
+union Union = PossibleType
+
+type PossibleType {
+   field : String
+}
+
+type Query {
+   field : Union
+}
+
+"""
+
+    }
+
+    def "prints union"() {
+        def possibleType1 = GraphQLObjectType.newObject().name("PossibleType1").field(
+                newFieldDefinition().name("field").type(Scalars.GraphQLString).build()
+        ).build()
+        def possibleType2 = GraphQLObjectType.newObject().name("PossibleType2").field(
+                newFieldDefinition().name("field").type(Scalars.GraphQLString).build()
+        ).build()
+        GraphQLUnionType unionType = GraphQLUnionType.newUnionType()
+                .name("Union")
+                .possibleType(possibleType1)
+                .possibleType(possibleType2)
+                .typeResolver({ it -> null })
+                .build()
+        GraphQLFieldDefinition fieldDefinition2 = newFieldDefinition()
+                .name("field").type(unionType).build()
+        def queryType = GraphQLObjectType.newObject().name("Query").field(fieldDefinition2).build()
+        def schema = GraphQLSchema.newSchema().query(queryType).build()
+        when:
+        def result = new SchemaPrinter().print(schema)
+
+        then:
+        result == """union Union = PossibleType1 | PossibleType2
+
+type PossibleType1 {
+   field : String
+}
+
+type PossibleType2 {
+   field : String
+}
+
+type Query {
+   field : Union
+}
+
 """
 
     }

Original file line number	Diff line number	Diff line change
`@@ -176,6 +176,7 @@ private TypePrinter<GraphQLUnionType> unionPrinter() {`
`176`	`176`	`if (isIntrospectionType(type)) {`
`177`	`177`	`return;`
`178`	`178`	`}`
	`179`	`+ printComments(out, type, "");`
`179`	`180`	`out.format("union %s = ", type.getName());`
`180`	`181`	`List<GraphQLOutputType> types = type.getTypes();`
`181`	`182`	`for (int i = 0; i < types.size(); i++) {`
`@@ -185,7 +186,7 @@ private TypePrinter<GraphQLUnionType> unionPrinter() {`
`185`	`186`	`}`
`186`	`187`	`out.format("%s", objectType.getName());`
`187`	`188`	`}`
`188`		`- out.format("}\n\n");`
	`189`	`+ out.format("\n\n");`
`189`	`190`	`};`
`190`	`191`	`}`
`191`	`192`
`@@ -356,6 +357,8 @@ private String getDescription(Object descriptionHolder) {`
`356`	`357`	`return ((GraphQLFieldDefinition) descriptionHolder).getDescription();`
`357`	`358`	`} else if (descriptionHolder instanceof GraphQLEnumValueDefinition) {`
`358`	`359`	`return ((GraphQLEnumValueDefinition) descriptionHolder).getDescription();`
	`360`	`+ } else if (descriptionHolder instanceof GraphQLUnionType) {`
	`361`	`+ return ((GraphQLUnionType) descriptionHolder).getDescription();`
`359`	`362`	`} else {`
`360`	`363`	`return Assert.assertShouldNeverHappen();`
`361`	`364`	`}`