better support for Java enums

bbakerman · bbakerman · commit e0fa7f85bbb7 · 2017-06-29T07:52:10.000+10:00
graphql-java#526 better support for Java enums by using a serialisation strategy that knows about how Java Enum<?> have unique String names
diff --git a/src/main/java/graphql/schema/GraphQLEnumType.java b/src/main/java/graphql/schema/GraphQLEnumType.java
@@ -84,12 +84,24 @@ private Object getValueByName(Object value) {
 
     private Object getNameByValue(Object value) {
         for (GraphQLEnumValueDefinition valueDefinition : valueDefinitionMap.values()) {
-            if (value.equals(valueDefinition.getValue())) return valueDefinition.getName();
+            Object definitionValue = valueDefinition.getValue();
+            if (value.equals(definitionValue)) {
+                return valueDefinition.getName();
+            }
+        }
+        // ok we didn't match on pure object.equals().  Lets try the Java enum strategy
+        if (value instanceof Enum) {
+            String enumNameValue = ((Enum<?>) value).name();
+            for (GraphQLEnumValueDefinition valueDefinition : valueDefinitionMap.values()) {
+                Object definitionValue = String.valueOf(valueDefinition.getValue());
+                if (enumNameValue.equals(definitionValue)) {
+                    return valueDefinition.getName();
+                }
+            }
         }
         throw new CoercingSerializeException("Invalid input for Enum '" + name + "'. Unknown value '" + value + "'");
     }
 
-
     public String getName() {
         return name;
     }
diff --git a/src/test/groovy/graphql/Issue526.groovy b/src/test/groovy/graphql/Issue526.groovy
@@ -0,0 +1,92 @@
+package graphql
+
+import graphql.schema.DataFetcher
+import graphql.schema.DataFetchingEnvironment
+import spock.lang.Specification
+
+import static graphql.ExecutionInput.newExecutionInput
+import static graphql.schema.idl.RuntimeWiring.newRuntimeWiring
+import static graphql.schema.idl.TypeRuntimeWiring.newTypeWiring
+
+class Issue526 extends Specification {
+
+    enum Episode {
+        NEWHOPE, EMPIRE, JEDI
+    }
+
+    class Droid {
+        List<Episode> appearsIn = [Episode.NEWHOPE, Episode.EMPIRE]
+
+        List<Episode> getAppearsIn() {
+            return appearsIn
+        }
+
+        Episode getEpisode() {
+            return Episode.NEWHOPE
+        }
+
+        String getName() {
+            return "C3PO"
+        }
+    }
+
+    def "526 - Java enums can match string generated versions of them"() {
+
+        given:
+
+        def spec = """
+            enum Episode {
+                NEWHOPE,                    
+                EMPIRE,
+                JEDI
+            }
+            
+            type Droid {
+                name: String,
+                episode : Episode,
+                appearsIn: [Episode],
+            }
+            
+            type Query {
+                droid :  Droid
+            }
+        """
+
+        def schema = TestUtil.schema(spec, newRuntimeWiring()
+                .type(newTypeWiring("Query").dataFetcher("droid", new DataFetcher() {
+            @Override
+            Object get(DataFetchingEnvironment environment) {
+                return new Droid()
+            }
+        })))
+
+        def graphQL = GraphQL.newGraphQL(schema).build()
+        def query = """
+        {
+            droid {
+                name
+                episode
+                appearsIn
+            }
+        }
+        """
+        def executionInput = newExecutionInput().query(query).build()
+
+        when:
+
+        def executionResult = graphQL.execute(executionInput)
+
+        then:
+
+        executionResult.errors.size() == 0
+        executionResult.data == [
+                droid: [
+                        name     : "C3PO",
+                        episode  : "NEWHOPE",
+                        appearsIn: [
+                                "NEWHOPE", "EMPIRE"
+                        ],
+                ]
+        ]
+    }
+}
diff --git a/src/test/groovy/graphql/schema/GraphQLEnumTypeTest.groovy b/src/test/groovy/graphql/schema/GraphQLEnumTypeTest.groovy
@@ -14,7 +14,7 @@ class GraphQLEnumTypeTest extends Specification {
     def setup() {
         enumType = newEnum().name("TestEnum")
                 .value("NAME", 42)
-                .build();
+                .build()
     }
 
     def "parse throws exception for unknown value"() {
@@ -74,8 +74,42 @@ class GraphQLEnumTypeTest extends Specification {
         newEnum().name("AnotherTestEnum")
                 .value("NAME", 42)
                 .value("NAME", 43)
-                .build();
+                .build()
         then:
         thrown(AssertException)
     }
+
+    enum Episode {
+        NEWHOPE, EMPIRE
+    }
+
+    def "serialize Java enum objects with String definition values"() {
+
+        given:
+        enumType = newEnum().name("Episode")
+                .value("NEWHOPE", "NEWHOPE")
+                .value("EMPIRE", "EMPIRE")
+                .build()
+
+        when:
+        def serialized = enumType.coercing.serialize(Episode.EMPIRE)
+
+        then:
+        serialized == "EMPIRE"
+    }
+
+    def "serialize Java enum objects with Java enum definition values"() {
+
+        given:
+        enumType = newEnum().name("Episode")
+                .value("NEWHOPE", Episode.NEWHOPE)
+                .value("EMPIRE", Episode.EMPIRE)
+                .build()
+
+        when:
+        def serialized = enumType.coercing.serialize(Episode.NEWHOPE)
+
+        then:
+        serialized == "NEWHOPE"
+    }
 }
