Add specific UnknownOperationException when operation name is missing

tinnou · bbakerman · commit c4e0f3bc650f · 2018-05-22T19:47:17.000+10:00
diff --git a/docs/exceptions.rst b/docs/exceptions.rst
@@ -42,6 +42,11 @@ These are not graphql errors in execution but rather totally unacceptable condit
  is thrown if the schema is not valid when built via
   graphql.schema.GraphQLSchema.Builder#build()`
 
+ -  `graphql.execution.UnknownOperationException`
+
+if multiple operations are defined in the query and
+the operation name is missing or there is no matching operation name
+contained in the GraphQL query.
 
  -  `graphql.GraphQLException`
 
diff --git a/src/main/java/graphql/execution/UnknownOperationException.java b/src/main/java/graphql/execution/UnknownOperationException.java
@@ -0,0 +1,17 @@
+package graphql.execution;
+
+import graphql.GraphQLException;
+import graphql.PublicApi;
+
+/**
+ * This is thrown if multiple operations are defined in the query and
+ * the operation name is missing or there is no matching operation name
+ * contained in the GraphQL query.
+ */
+@PublicApi
+public class UnknownOperationException extends GraphQLException {
+
+    public UnknownOperationException(String message) {
+        super(message);
+    }
+}
diff --git a/src/main/java/graphql/language/NodeUtil.java b/src/main/java/graphql/language/NodeUtil.java
@@ -1,7 +1,7 @@
 package graphql.language;
 
-import graphql.GraphQLException;
 import graphql.Internal;
+import graphql.execution.UnknownOperationException;
 import graphql.util.FpKit;
 
 import java.util.LinkedHashMap;
@@ -59,7 +59,7 @@ public static GetOperationResult getOperation(Document document, String operatio
             }
         }
         if (operationName == null && operationsByName.size() > 1) {
-            throw new GraphQLException("missing operation name");
+            throw new UnknownOperationException("Must provide operation name if query contains multiple operations.");
         }
         OperationDefinition operation;
 
@@ -69,7 +69,7 @@ public static GetOperationResult getOperation(Document document, String operatio
             operation = operationsByName.get(operationName);
         }
         if (operation == null) {
-            throw new GraphQLException("no operation found");
+            throw new UnknownOperationException(String.format("Unknown operation named '%s'.", operationName));
         }
         GetOperationResult result = new GetOperationResult();
         result.fragmentsByName = fragmentsByName;
diff --git a/src/test/groovy/graphql/language/NodeUtilTest.groovy b/src/test/groovy/graphql/language/NodeUtilTest.groovy
@@ -0,0 +1,38 @@
+package graphql.language
+
+import graphql.TestUtil
+import graphql.execution.UnknownOperationException
+import spock.lang.Specification
+
+class NodeUtilTest extends Specification {
+
+    def "getOperation: when multiple operations are defined in the query and operation name is missing then it should throw UnknownOperationException"() {
+        setup:
+        def doc = TestUtil.parseQuery('''
+            query Q1 { id }
+            query Q2 { id }
+        ''')
+
+        when:
+        NodeUtil.getOperation(doc, null)
+
+        then:
+        def ex = thrown(UnknownOperationException)
+        ex.message == "Must provide operation name if query contains multiple operations."
+    }
+
+    def "getOperation: when multiple operations are defined in the query and operation name doesn't match any of the query operations then it should throw UnknownOperationException"() {
+        setup:
+        def doc = TestUtil.parseQuery('''
+            query Q1 { id }
+            query Q2 { id }
+        ''')
+
+        when:
+        NodeUtil.getOperation(doc, 'Unknown')
+
+        then:
+        def ex = thrown(UnknownOperationException)
+        ex.message == "Unknown operation named 'Unknown'."
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`package graphql.language;`
`2`	`2`
`3`		`-import graphql.GraphQLException;`
`4`	`3`	`import graphql.Internal;`
	`4`	`+import graphql.execution.UnknownOperationException;`
`5`	`5`	`import graphql.util.FpKit;`
`6`	`6`
`7`	`7`	`import java.util.LinkedHashMap;`
`@@ -59,7 +59,7 @@ public static GetOperationResult getOperation(Document document, String operatio`
`59`	`59`	`}`
`60`	`60`	`}`
`61`	`61`	`if (operationName == null && operationsByName.size() > 1) {`
`62`		`- throw new GraphQLException("missing operation name");`
	`62`	`+ throw new UnknownOperationException("Must provide operation name if query contains multiple operations.");`
`63`	`63`	`}`
`64`	`64`	`OperationDefinition operation;`
`65`	`65`
`@@ -69,7 +69,7 @@ public static GetOperationResult getOperation(Document document, String operatio`
`69`	`69`	`operation = operationsByName.get(operationName);`
`70`	`70`	`}`
`71`	`71`	`if (operation == null) {`
`72`		`- throw new GraphQLException("no operation found");`
	`72`	`+ throw new UnknownOperationException(String.format("Unknown operation named '%s'.", operationName));`
`73`	`73`	`}`
`74`	`74`	`GetOperationResult result = new GetOperationResult();`
`75`	`75`	`result.fragmentsByName = fragmentsByName;`