Merge pull request #3506 from bhabegger/fix-issue-3434

bbakerman · web-flow · commit 768e507c600e · 2024-03-10T00:06:17.000Z
Fix printing of union types
diff --git a/src/main/java/graphql/schema/DefaultGraphqlTypeComparatorRegistry.java b/src/main/java/graphql/schema/DefaultGraphqlTypeComparatorRegistry.java
@@ -10,7 +10,7 @@
 import java.util.function.UnaryOperator;
 
 import static graphql.Assert.assertNotNull;
-import static graphql.schema.GraphQLTypeUtil.unwrapAll;
+import static graphql.schema.GraphQLTypeUtil.unwrapAllAs;
 import static graphql.schema.GraphqlTypeComparatorEnvironment.newEnvironment;
 
 /**
@@ -33,6 +33,7 @@ public class DefaultGraphqlTypeComparatorRegistry implements GraphqlTypeComparat
 
     /**
      * This orders the schema into a sensible grouped order
+     *
      * @return a comparator that allows for sensible grouped order
      */
     public static Comparator<GraphQLSchemaElement> sensibleGroupedOrder() {
@@ -51,15 +52,19 @@ public static Comparator<GraphQLSchemaElement> sensibleGroupedOrder() {
 
     private static GraphQLSchemaElement unwrapElement(GraphQLSchemaElement element) {
         if (element instanceof GraphQLType) {
-            element = unwrapAll((GraphQLType) element);
+            GraphQLType castElement = (GraphQLType) element;
+            // We need to unwrap as GraphQLType to support GraphQLTypeReferences which is not an GraphQLUnmodifiedType
+            // as returned by unwrapAll.
+            castElement = unwrapAllAs(castElement);
+            element = castElement;
         }
         return element;
     }
 
     private static int compareByName(GraphQLSchemaElement o1, GraphQLSchemaElement o2) {
         return Comparator.comparing(element -> {
             if (element instanceof GraphQLType) {
-                element = unwrapAll((GraphQLType) element);
+                element = unwrapElement((GraphQLType) element);
             }
             if (element instanceof GraphQLNamedSchemaElement) {
                 return ((GraphQLNamedSchemaElement) element).getName();
diff --git a/src/main/java/graphql/schema/GraphQLTypeUtil.java b/src/main/java/graphql/schema/GraphQLTypeUtil.java
@@ -184,6 +184,7 @@ public static <T extends GraphQLType> T unwrapOneAs(GraphQLType type) {
 
     /**
      * Unwraps all layers of the type or just returns the type again if it's not a wrapped type
+     * NOTE: This method does not support GraphQLTypeReference as input and will lead to a ClassCastException
      *
      * @param type the type to unwrapOne
      *
diff --git a/src/test/groovy/graphql/Issue3434.groovy b/src/test/groovy/graphql/Issue3434.groovy
@@ -0,0 +1,26 @@
+package graphql
+
+import static graphql.schema.GraphQLUnionType.newUnionType
+import static graphql.schema.GraphQLTypeReference.typeRef
+import graphql.schema.idl.SchemaPrinter
+
+import spock.lang.Specification
+
+class Issue3434 extends Specification {
+
+    def "allow printing of union types"() {
+        given:
+        def schema = newUnionType().name("Shape")
+                .possibleType(typeRef("Circle"))
+                .possibleType(typeRef("Square"))
+                .build()
+
+        when:
+        def printer = new SchemaPrinter()
+        def result = printer.print(schema)
+
+        then:
+        result.trim() == "union Shape = Circle | Square"
+    }
+}
+

Original file line number	Diff line number	Diff line change
`@@ -184,6 +184,7 @@ public static <T extends GraphQLType> T unwrapOneAs(GraphQLType type) {`
`184`	`184`
`185`	`185`	`/**`
`186`	`186`	`* Unwraps all layers of the type or just returns the type again if it's not a wrapped type`
	`187`	`+ * NOTE: This method does not support GraphQLTypeReference as input and will lead to a ClassCastException`
`187`	`188`	`*`
`188`	`189`	`* @param type the type to unwrapOne`
`189`	`190`	`*`