Improved execute usage. Added exception logger

Author: syrusakbary

graphql/__init__.py

@@ -34,10 +34,10 @@ def graphql(schema, request='', root=None, args=None, operation_name=None):
             )
         return execute(
             schema,
-            root or object(),
             ast,
-            operation_name,
-            args or {},
+            root or object(),
+            operation_name=operation_name,
+            variable_values=args or {},
         )
     except Exception as e:
         return ExecutionResult(

graphql/execution/__init__.py

@@ -18,11 +18,8 @@
 2) fragment "spreads" e.g. "...c"
 3) inline fragment "spreads" e.g. "...on Type { a }"
 """
-from .execute import execute as _execute
+from .executor import execute
 from .base import ExecutionResult
 
 
-def execute(schema, root, ast, operation_name='', args=None):
-    return _execute(schema, ast, root, variable_values=args, operation_name=operation_name)
-
 __all__ = ['execute', 'ExecutionResult']

graphql/execution/execute.py renamed to graphql/execution/executor.py

@@ -1,5 +1,6 @@
 import collections
 import functools
+import logging
 
 from ..error import GraphQLError
 from ..pyutils.aplus import Promise, is_thenable, promise_for_dict, promisify
@@ -13,6 +14,9 @@
 from .executors.sync import SyncExecutor
 
 
+logger = logging.getLogger(__name__)
+
+
 def execute(schema, document_ast, root_value=None, context_value=None,
             variable_values=None, operation_name=None, executor=None):
     assert schema, 'Must provide schema'
@@ -158,6 +162,9 @@ def resolve_or_error(resolve_fn, source, args, exe_context, info):
         # return resolve_fn(source, args, exe_context, info)
         return exe_context.executor.execute(resolve_fn, source, args, info)
     except Exception as e:
+        logger.exception("An error occurred while resolving field {}.{}".format(
+            info.parent_type.name, info.field_name
+        ))
         return e
 
 

graphql/execution/tests/test_directives.py

@@ -20,7 +20,7 @@ class Data(object):
 
 
 def execute_test_query(doc):
-    return execute(schema, Data, parse(doc))
+    return execute(schema, parse(doc), Data)
 
 
 def test_basic_query_works():

graphql/execution/tests/test_execute_schema.py

@@ -110,7 +110,7 @@ def __init__(self, uid, width, height):
 
     # Note: this is intentionally not validating to ensure appropriate
     # behavior occurs when executing an invalid query.
-    result = execute(BlogSchema, None, parse(request))
+    result = execute(BlogSchema, parse(request))
     assert not result.errors
     assert result.data == \
         {

graphql/execution/tests/test_executor.py

@@ -111,7 +111,7 @@ def deeper(self):
 
     schema = GraphQLSchema(query=DataType)
 
-    result = execute(schema, Data(), ast, 'Example', {'size': 100})
+    result = execute(schema, ast, Data(), operation_name='Example', variable_values={'size': 100})
     assert not result.errors
     assert result.data == expected
 
@@ -142,7 +142,7 @@ def test_merges_parallel_fragments():
     })
 
     schema = GraphQLSchema(query=Type)
-    result = execute(schema, None, ast)
+    result = execute(schema, ast)
     assert not result.errors
     assert result.data == \
         {
@@ -176,7 +176,7 @@ def resolver(context, *_):
         'a': GraphQLField(GraphQLString, resolver=resolver)
     })
 
-    result = execute(GraphQLSchema(Type), Data(), ast, 'Example', {})
+    result = execute(GraphQLSchema(Type), ast, Data(), operation_name='Example')
     assert not result.errors
     assert resolver.got_here
 
@@ -207,7 +207,7 @@ def resolver(_, args, *_args):
             resolver=resolver),
     })
 
-    result = execute(GraphQLSchema(Type), None, doc_ast, 'Example', {})
+    result = execute(GraphQLSchema(Type), doc_ast, None, operation_name='Example')
     assert not result.errors
     assert resolver.got_here
 
@@ -233,7 +233,7 @@ def error(self):
         'error': GraphQLField(GraphQLString),
     })
 
-    result = execute(GraphQLSchema(Type), Data(), doc_ast)
+    result = execute(GraphQLSchema(Type), doc_ast, Data())
     assert result.data == {'ok': 'ok', 'error': None}
     assert len(result.errors) == 1
     assert result.errors[0].message == 'Error getting error'
@@ -250,7 +250,7 @@ class Data(object):
     Type = GraphQLObjectType('Type', {
         'a': GraphQLField(GraphQLString)
     })
-    result = execute(GraphQLSchema(Type), Data(), ast)
+    result = execute(GraphQLSchema(Type), ast, Data())
     assert not result.errors
     assert result.data == {'a': 'b'}
 
@@ -265,7 +265,7 @@ class Data(object):
     Type = GraphQLObjectType('Type', {
         'a': GraphQLField(GraphQLString)
     })
-    result = execute(GraphQLSchema(Type), Data(), ast)
+    result = execute(GraphQLSchema(Type), ast, Data())
     assert not result.errors
     assert result.data == {'a': 'b'}
 
@@ -281,7 +281,7 @@ class Data(object):
         'a': GraphQLField(GraphQLString)
     })
     with raises(GraphQLError) as excinfo:
-        execute(GraphQLSchema(Type), Data(), ast)
+        execute(GraphQLSchema(Type), ast, Data())
     assert 'Must provide operation name if query contains multiple operations' in str(excinfo.value)
 
 
@@ -302,7 +302,7 @@ class Data(object):
     S = GraphQLObjectType('S', {
         'a': GraphQLField(GraphQLString)
     })
-    result = execute(GraphQLSchema(Q, M, S), Data(), ast, 'Q')
+    result = execute(GraphQLSchema(Q, M, S), ast, Data(), operation_name='Q')
     assert not result.errors
     assert result.data == {'a': 'b'}
 
@@ -321,7 +321,7 @@ class Data(object):
     M = GraphQLObjectType('M', {
         'c': GraphQLField(GraphQLString)
     })
-    result = execute(GraphQLSchema(Q, M), Data(), ast, 'M')
+    result = execute(GraphQLSchema(Q, M), ast, Data(), operation_name='M')
     assert not result.errors
     assert result.data == {'c': 'd'}
 
@@ -340,7 +340,7 @@ class Data(object):
     S = GraphQLObjectType('S', {
         'a': GraphQLField(GraphQLString)
     })
-    result = execute(GraphQLSchema(Q, subscription=S), Data(), ast, 'S')
+    result = execute(GraphQLSchema(Q, subscription=S), ast, Data(), operation_name='S')
     assert not result.errors
     assert result.data == {'a': 'b'}
 
@@ -365,7 +365,7 @@ class Data(object):
     Type = GraphQLObjectType('Type', {
         'a': GraphQLField(GraphQLString)
     })
-    result = execute(GraphQLSchema(Type), Data(), ast, 'Q')
+    result = execute(GraphQLSchema(Type), ast, Data(), operation_name='Q')
     assert not result.errors
     assert result.data == {'a': 'b'}
 
@@ -379,7 +379,7 @@ def test_does_not_include_illegal_fields_in_output():
     M = GraphQLObjectType('M', {
         'c': GraphQLField(GraphQLString)
     })
-    result = execute(GraphQLSchema(Q, M), None, ast)
+    result = execute(GraphQLSchema(Q, M), ast)
     assert not result.errors
     assert result.data == {}
 
@@ -403,7 +403,7 @@ def test_does_not_include_arguments_that_were_not_set():
     ))
 
     ast = parse('{ field(a: true, c: false, e: 0) }')
-    result = execute(schema, None, ast)
+    result = execute(schema, ast)
     assert result.data == {
         'field': '{"a":true,"c":false,"e":0}'
     }
@@ -445,7 +445,7 @@ def __init__(self, value):
         'specials': [Special('foo'), NotSpecial('bar')]
     }
 
-    result = execute(schema, value, query)
+    result = execute(schema, query, value)
 
     assert result.data == {
         'specials': [
@@ -474,6 +474,30 @@ def test_fails_to_execute_a_query_containing_a_type_definition():
     )
 
     with raises(GraphQLError) as excinfo:
-        execute(schema, None, query)
+        execute(schema, query)
 
     assert excinfo.value.message == 'GraphQL cannot execute a request containing a ObjectTypeDefinition.'
+
+
+def test_exceptions_are_reraised_if_specified(mocker):
+
+    logger = mocker.patch('graphql.execution.executor.logger')
+
+    query = parse('''
+    { foo }
+    ''')
+
+    def resolver(*_):
+        raise Exception("UH OH!")
+
+    schema = GraphQLSchema(
+        GraphQLObjectType(
+            name='Query',
+            fields={
+                'foo': GraphQLField(GraphQLString, resolver=resolver)
+            }
+        )
+    )
+
+    execute(schema, query)
+    logger.exception.assert_called_with("An error occurred while resolving field Query.foo")

graphql/execution/tests/test_executor_gevent.py

@@ -2,12 +2,12 @@
 import gevent
 
 from graphql.error import format_error
+from graphql.execution import execute
 from graphql.language.location import SourceLocation
 from graphql.language.parser import parse
 from graphql.type import (GraphQLField, GraphQLObjectType, GraphQLSchema,
                           GraphQLString)
 
-from ..execute import execute
 from ..executors.gevent import GeventExecutor
 from .test_mutations import assert_evaluate_mutations_serially
 

graphql/execution/tests/test_executor_thread.py

@@ -1,6 +1,6 @@
 
 from graphql.error import format_error
-from graphql.execution.execute import execute
+from graphql.execution import execute
 from graphql.language.parser import parse
 from graphql.type import (GraphQLArgument, GraphQLField, GraphQLInt,
                           GraphQLList, GraphQLObjectType, GraphQLSchema,

graphql/execution/tests/test_lists.py

@@ -26,7 +26,7 @@ def run_check(self):
         )
 
         schema = GraphQLSchema(query=DataType)
-        response = execute(schema, data, ast)
+        response = execute(schema, ast, data)
 
         if response.errors:
             result = {

graphql/execution/tests/test_mutations.py

@@ -1,4 +1,4 @@
-from graphql.execution.execute import execute
+from graphql.execution import execute
 from graphql.language.parser import parse
 from graphql.type import (GraphQLArgument, GraphQLField, GraphQLInt,
                           GraphQLList, GraphQLObjectType, GraphQLSchema,

graphql/execution/tests/test_nonnull.py

@@ -83,7 +83,7 @@ def nonNullPromiseNest(self):
 
 def check(doc, data, expected):
     ast = parse(doc)
-    response = execute(schema, data, ast)
+    response = execute(schema, ast, data)
 
     if response.errors:
         result = {

graphql/execution/tests/test_union_interface.py

@@ -106,7 +106,7 @@ def test_can_introspect_on_union_and_intersection_types():
         }
     }''')
 
-    result = execute(schema, None, ast)
+    result = execute(schema, ast)
     assert result.data == {
         'Named': {
             'enumValues': None,
@@ -143,7 +143,7 @@ def test_executes_using_union_types():
             }
         }
     ''')
-    result = execute(schema, john, ast)
+    result = execute(schema, ast, john)
     assert not result.errors
     assert result.data == {
         '__typename': 'Person',
@@ -174,7 +174,7 @@ def test_executes_union_types_with_inline_fragment():
         }
       }
     ''')
-    result = execute(schema, john, ast)
+    result = execute(schema, ast, john)
     assert not result.errors
     assert result.data == {
         '__typename': 'Person',
@@ -200,7 +200,7 @@ def test_executes_using_interface_types():
         }
       }
     ''')
-    result = execute(schema, john, ast)
+    result = execute(schema, ast, john)
     assert not result.errors
     assert result.data == {
         '__typename': 'Person',
@@ -230,7 +230,7 @@ def test_executes_interface_types_with_inline_fragment():
         }
       }
     ''')
-    result = execute(schema, john, ast)
+    result = execute(schema, ast, john)
     assert not result.errors
     assert result.data == {
         '__typename': 'Person',
@@ -272,7 +272,7 @@ def test_allows_fragment_conditions_to_be_abstract_types():
         }
       }
     ''')
-    result = execute(schema, john, ast)
+    result = execute(schema, ast, john)
     assert not result.errors
     assert result.data == {
         '__typename': 'Person',
@@ -300,7 +300,7 @@ def test_only_include_fields_from_matching_fragment_condition():
         }
       }
     ''')
-    result = execute(schema, john, ast)
+    result = execute(schema, ast, john)
     assert not result.errors
     assert result.data == {
         'pets': [
@@ -340,7 +340,7 @@ def resolve_type(obj, info):
     john2 = Person('John', [], [liz])
     ast = parse('''{ name, friends { name } }''')
 
-    result = execute(schema2, john2, ast)
+    result = execute(schema2, ast, john2)
     assert result.data == {
         'name': 'John', 'friends': [{'name': 'Liz'}]
     }

graphql/execution/tests/test_variables.py

@@ -91,7 +91,7 @@ def input_to_json(obj, args, info):
 
 def check(doc, expected, args=None):
     ast = parse(doc)
-    response = execute(schema, None, ast, args=args)
+    response = execute(schema, ast, variable_values=args)
 
     if response.errors:
         result = {

graphql/type/tests/test_introspection.py

@@ -590,7 +590,7 @@ def test_supports_the_type_root_field():
     })
     schema = GraphQLSchema(TestType)
     request = '{ __type(name: "TestType") { name } }'
-    result = execute(schema, object(), parse(request))
+    result = execute(schema, parse(request), object())
     assert not result.errors
     assert result.data == {'__type': {'name': 'TestType'}}
 

graphql/utils/tests/test_extend_schema.py

@@ -101,7 +101,7 @@ def test_cannot_be_used_for_execution():
     extended_schema = extend_schema(test_schema, ast)
     clientQuery = parse('{ newField }')
 
-    result = execute(extended_schema, object(), clientQuery)
+    result = execute(extended_schema, clientQuery, object())
     assert result.data['newField'] is None
     assert str(result.errors[0]
                ) == 'Client Schema cannot be used for execution.'