test_executor.py

# type: ignore
import json

from pytest import raises

from graphql.error import GraphQLError
from graphql.execution import execute
from graphql.language.ast import ObjectTypeDefinition
from graphql.language.parser import parse
from graphql.type import (
    GraphQLArgument,
    GraphQLBoolean,
    GraphQLField,
    GraphQLInt,
    GraphQLList,
    GraphQLObjectType,
    GraphQLSchema,
    GraphQLString,
    GraphQLNonNull,
    GraphQLID,
)
from promise import Promise


def test_executes_arbitary_code():
    # type: () -> None
    class Data(object):
        a = "Apple"
        b = "Banana"
        c = "Cookie"
        d = "Donut"
        e = "Egg"
        f = "Fish"

        def pic(self, size=50):
            # type: (int) -> str
            return "Pic of size: {}".format(size)

        def deep(self):
            # type: () -> DeepData
            return DeepData()

        def promise(self):
            # type: () -> Data
            # FIXME: promise is unsupported
            return Data()

    class DeepData(object):
        a = "Already Been Done"
        b = "Boring"
        c = ["Contrived", None, "Confusing"]

        def deeper(self):
            # type: () -> List[Optional[Data]]
            return [Data(), None, Data()]

    doc = """
        query Example($size: Int) {
            a,
            b,
            x: c
            ...c
            f
            ...on DataType {
                pic(size: $size)
                promise {
                    a
                }
            }
            deep {
                a
                b
                c
                deeper {
                    a
                    b
                }
            }
        }
        fragment c on DataType {
            d
            e
        }
    """

    ast = parse(doc)
    expected = {
        "a": "Apple",
        "b": "Banana",
        "x": "Cookie",
        "d": "Donut",
        "e": "Egg",
        "f": "Fish",
        "pic": "Pic of size: 100",
        "promise": {"a": "Apple"},
        "deep": {
            "a": "Already Been Done",
            "b": "Boring",
            "c": ["Contrived", None, "Confusing"],
            "deeper": [
                {"a": "Apple", "b": "Banana"},
                None,
                {"a": "Apple", "b": "Banana"},
            ],
        },
    }

    DataType = GraphQLObjectType(
        "DataType",
        lambda: {
            "a": GraphQLField(GraphQLString),
            "b": GraphQLField(GraphQLString),
            "c": GraphQLField(GraphQLString),
            "d": GraphQLField(GraphQLString),
            "e": GraphQLField(GraphQLString),
            "f": GraphQLField(GraphQLString),
            "pic": GraphQLField(
                args={"size": GraphQLArgument(GraphQLInt)},
                type_=GraphQLString,
                resolver=lambda obj, info, size: obj.pic(size),
            ),
            "deep": GraphQLField(DeepDataType),
            "promise": GraphQLField(DataType),
        },
    )

    DeepDataType = GraphQLObjectType(
        "DeepDataType",
        {
            "a": GraphQLField(GraphQLString),
            "b": GraphQLField(GraphQLString),
            "c": GraphQLField(GraphQLList(GraphQLString)),
            "deeper": GraphQLField(GraphQLList(DataType)),
        },
    )

    schema = GraphQLSchema(query=DataType)

    result = execute(
        schema, ast, Data(), operation_name="Example", variable_values={"size": 100}
    )
    assert not result.errors
    assert result.data == expected


def test_merges_parallel_fragments():
    # type: () -> None
    ast = parse(
        """
        { a, deep {...FragOne, ...FragTwo} }

        fragment FragOne on Type {
            b
            deep { b, deeper: deep { b } }
        }

        fragment FragTwo on Type {
            c
            deep { c, deeper: deep { c } }
        }
    """
    )

    Type = GraphQLObjectType(
        "Type",
        lambda: {
            "a": GraphQLField(GraphQLString, resolver=lambda *_: "Apple"),
            "b": GraphQLField(GraphQLString, resolver=lambda *_: "Banana"),
            "c": GraphQLField(GraphQLString, resolver=lambda *_: "Cherry"),
            "deep": GraphQLField(Type, resolver=lambda *_: {}),
        },
    )

    schema = GraphQLSchema(query=Type)
    result = execute(schema, ast)
    assert not result.errors
    assert result.data == {
        "a": "Apple",
        "deep": {
            "b": "Banana",
            "c": "Cherry",
            "deep": {
                "b": "Banana",
                "c": "Cherry",
                "deeper": {"b": "Banana", "c": "Cherry"},
            },
        },
    }


def test_threads_root_value_context_correctly():
    # type: () -> None
    doc = "query Example { a }"

    class Data(object):
        context_thing = "thing"

    ast = parse(doc)

    def resolver(root_value, *_):
        # type: (Data, *ResolveInfo) -> None
        assert root_value.context_thing == "thing"
        resolver.got_here = True

    resolver.got_here = False

    Type = GraphQLObjectType(
        "Type", {"a": GraphQLField(GraphQLString, resolver=resolver)}
    )

    result = execute(GraphQLSchema(Type), ast, Data(), operation_name="Example")
    assert not result.errors
    assert resolver.got_here


def test_correctly_threads_arguments():
    # type: () -> None
    doc = """
        query Example {
            b(numArg: 123, stringArg: "foo")
        }
    """

    def resolver(source, info, numArg, stringArg):
        # type: (Optional[Any], ResolveInfo, int, str) -> None
        assert numArg == 123
        assert stringArg == "foo"
        resolver.got_here = True

    resolver.got_here = False

    doc_ast = parse(doc)

    Type = GraphQLObjectType(
        "Type",
        {
            "b": GraphQLField(
                GraphQLString,
                args={
                    "numArg": GraphQLArgument(GraphQLInt),
                    "stringArg": GraphQLArgument(GraphQLString),
                },
                resolver=resolver,
            )
        },
    )

    result = execute(GraphQLSchema(Type), doc_ast, None, operation_name="Example")
    assert not result.errors
    assert resolver.got_here


def test_nulls_out_error_subtrees():
    # type: () -> None
    doc = """{
        ok,
        error
    }"""

    class Data(object):
        def ok(self):
            # type: () -> str
            return "ok"

        def error(self):
            # type: () -> NoReturn
            raise GraphQLError("Error getting error")

    doc_ast = parse(doc)

    Type = GraphQLObjectType(
        "Type",
        {"ok": GraphQLField(GraphQLString), "error": GraphQLField(GraphQLString)},
    )

    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"
    # TODO: check error location


def test_uses_the_inline_operation_if_no_operation_name_is_provided():
    # type: () -> None
    doc = "{ a }"

    class Data(object):
        a = "b"

    ast = parse(doc)
    Type = GraphQLObjectType("Type", {"a": GraphQLField(GraphQLString)})
    result = execute(GraphQLSchema(Type), ast, Data())
    assert not result.errors
    assert result.data == {"a": "b"}


def test_uses_the_only_operation_if_no_operation_name_is_provided():
    # type: () -> None
    doc = "query Example { a }"

    class Data(object):
        a = "b"

    ast = parse(doc)
    Type = GraphQLObjectType("Type", {"a": GraphQLField(GraphQLString)})
    result = execute(GraphQLSchema(Type), ast, Data())
    assert not result.errors
    assert result.data == {"a": "b"}


def test_uses_the_named_operation_if_operation_name_is_provided():
    # type: () -> None
    doc = "query Example { first: a } query OtherExample { second: a }"

    class Data(object):
        a = "b"

    ast = parse(doc)
    Type = GraphQLObjectType("Type", {"a": GraphQLField(GraphQLString)})
    result = execute(GraphQLSchema(Type), ast, Data(), operation_name="OtherExample")
    assert not result.errors
    assert result.data == {"second": "b"}


def test_raises_if_no_operation_is_provided():
    # type: () -> None
    doc = "fragment Example on Type { a }"

    class Data(object):
        a = "b"

    ast = parse(doc)
    Type = GraphQLObjectType("Type", {"a": GraphQLField(GraphQLString)})
    with raises(GraphQLError) as excinfo:
        execute(GraphQLSchema(Type), ast, Data())
    assert "Must provide an operation." == str(excinfo.value)


def test_raises_if_no_operation_name_is_provided_with_multiple_operations():
    # type: () -> None
    doc = "query Example { a } query OtherExample { a }"

    class Data(object):
        a = "b"

    ast = parse(doc)
    Type = GraphQLObjectType("Type", {"a": GraphQLField(GraphQLString)})
    with raises(GraphQLError) as excinfo:
        execute(GraphQLSchema(Type), ast, Data(), operation_name="UnknownExample")
    assert 'Unknown operation named "UnknownExample".' == str(excinfo.value)


def test_raises_if_unknown_operation_name_is_provided():
    # type: () -> None
    doc = "query Example { a } query OtherExample { a }"

    class Data(object):
        a = "b"

    ast = parse(doc)
    Type = GraphQLObjectType("Type", {"a": GraphQLField(GraphQLString)})
    with raises(GraphQLError) as excinfo:
        execute(GraphQLSchema(Type), ast, Data())
    assert "Must provide operation name if query contains multiple operations." == str(
        excinfo.value
    )


def test_uses_the_query_schema_for_queries():
    # type: () -> None
    doc = "query Q { a } mutation M { c } subscription S { a }"

    class Data(object):
        a = "b"
        c = "d"

    ast = parse(doc)
    Q = GraphQLObjectType("Q", {"a": GraphQLField(GraphQLString)})
    M = GraphQLObjectType("M", {"c": GraphQLField(GraphQLString)})
    S = GraphQLObjectType("S", {"a": GraphQLField(GraphQLString)})
    result = execute(GraphQLSchema(Q, M, S), ast, Data(), operation_name="Q")
    assert not result.errors
    assert result.data == {"a": "b"}


def test_uses_the_mutation_schema_for_queries():
    # type: () -> None
    doc = "query Q { a } mutation M { c }"

    class Data(object):
        a = "b"
        c = "d"

    ast = parse(doc)
    Q = GraphQLObjectType("Q", {"a": GraphQLField(GraphQLString)})
    M = GraphQLObjectType("M", {"c": GraphQLField(GraphQLString)})
    result = execute(GraphQLSchema(Q, M), ast, Data(), operation_name="M")
    assert not result.errors
    assert result.data == {"c": "d"}


def test_uses_the_subscription_schema_for_subscriptions():
    # type: () -> None
    from rx import Observable

    doc = "query Q { a } subscription S { a }"

    class Data(object):
        a = "b"
        c = "d"

    ast = parse(doc)
    Q = GraphQLObjectType("Q", {"a": GraphQLField(GraphQLString)})
    S = GraphQLObjectType(
        "S",
        {
            "a": GraphQLField(
                GraphQLString, resolver=lambda root, info: Observable.from_(["b"])
            )
        },
    )
    result = execute(
        GraphQLSchema(Q, subscription=S),
        ast,
        Data(),
        operation_name="S",
        allow_subscriptions=True,
    )
    assert isinstance(result, Observable)
    l = []
    result.subscribe(l.append)
    result = l[0]
    assert not result.errors
    assert result.data == {"a": "b"}


def test_avoids_recursion():
    # type: () -> None
    doc = """
        query Q {
            a
            ...Frag
            ...Frag
        }
        fragment Frag on Type {
            a,
            ...Frag
        }
    """

    class Data(object):
        a = "b"

    ast = parse(doc)
    Type = GraphQLObjectType("Type", {"a": GraphQLField(GraphQLString)})
    result = execute(GraphQLSchema(Type), ast, Data(), operation_name="Q")
    assert not result.errors
    assert result.data == {"a": "b"}


def test_does_not_include_illegal_fields_in_output():
    # type: () -> None
    doc = "mutation M { thisIsIllegalDontIncludeMe }"
    ast = parse(doc)
    Q = GraphQLObjectType("Q", {"a": GraphQLField(GraphQLString)})
    M = GraphQLObjectType("M", {"c": GraphQLField(GraphQLString)})
    result = execute(GraphQLSchema(Q, M), ast)
    assert not result.errors
    assert result.data == {}


def test_does_not_include_arguments_that_were_not_set():
    # type: () -> None
    schema = GraphQLSchema(
        GraphQLObjectType(
            "Type",
            {
                "field": GraphQLField(
                    GraphQLString,
                    resolver=lambda source, info, **args: args
                    and json.dumps(args, sort_keys=True, separators=(",", ":")),
                    args={
                        "a": GraphQLArgument(GraphQLBoolean),
                        "b": GraphQLArgument(GraphQLBoolean),
                        "c": GraphQLArgument(GraphQLBoolean),
                        "d": GraphQLArgument(GraphQLInt),
                        "e": GraphQLArgument(GraphQLInt),
                    },
                )
            },
        )
    )

    ast = parse("{ field(a: true, c: false, e: 0) }")
    result = execute(schema, ast)
    assert result.data == {"field": '{"a":true,"c":false,"e":0}'}


def test_fails_when_an_is_type_of_check_is_not_met():
    # type: () -> None
    class Special(object):
        def __init__(self, value):
            # type: (str) -> None
            self.value = value

    class NotSpecial(object):
        def __init__(self, value):
            # type: (str) -> None
            self.value = value

    SpecialType = GraphQLObjectType(
        "SpecialType",
        fields={"value": GraphQLField(GraphQLString)},
        is_type_of=lambda obj, info: isinstance(obj, Special),
    )

    schema = GraphQLSchema(
        GraphQLObjectType(
            name="Query",
            fields={
                "specials": GraphQLField(
                    GraphQLList(SpecialType), resolver=lambda root, *_: root["specials"]
                )
            },
        )
    )

    query = parse("{ specials { value } }")
    value = {"specials": [Special("foo"), NotSpecial("bar")]}

    result = execute(schema, query, value)

    assert result.data == {"specials": [{"value": "foo"}, None]}

    assert 'Expected value of type "SpecialType" but got: NotSpecial.' in [
        str(e) for e in result.errors
    ]


def test_fails_to_execute_a_query_containing_a_type_definition():
    # type: () -> None
    query = parse(
        """
    { foo }

    type Query { foo: String }
    """
    )

    schema = GraphQLSchema(
        GraphQLObjectType(name="Query", fields={"foo": GraphQLField(GraphQLString)})
    )

    with raises(GraphQLError) as excinfo:
        execute(schema, query)

    error = excinfo.value

    assert (
        error.message
        == "GraphQL cannot execute a request containing a ObjectTypeDefinition."
    )

    nodes = error.nodes
    assert type(nodes) is list
    assert len(nodes) == 1
    assert isinstance(nodes[0], ObjectTypeDefinition)


def test_exceptions_are_reraised():
    # type: () -> None

    query = parse(
        """
    { foo }
    """
    )

    class Error(Exception):
        pass

    def resolver(*_):
        # type: (*Any) -> NoReturn
        raise Error("UH OH!")

    schema = GraphQLSchema(
        GraphQLObjectType(
            name="Query", fields={"foo": GraphQLField(GraphQLString, resolver=resolver)}
        )
    )

    with raises(Error):
        execute(schema, query)


def test_exceptions_are_reraised_promise():
    # type: () -> None

    query = parse(
        """
    { foo }
    """
    )

    class Error(Exception):
        pass

    @Promise.promisify
    def resolver(*_):
        # type: (*Any) -> NoReturn
        raise Error("UH OH!")

    schema = GraphQLSchema(
        GraphQLObjectType(
            name="Query", fields={"foo": GraphQLField(GraphQLString, resolver=resolver)}
        )
    )

    with raises(Error):
        execute(schema, query)


def test_executor_properly_propogates_path_data(mocker):
    # type: (MockFixture) -> None
    time_mock = mocker.patch("time.time")
    time_mock.side_effect = range(0, 10000)

    BlogImage = GraphQLObjectType(
        "BlogImage",
        {
            "url": GraphQLField(GraphQLString),
            "width": GraphQLField(GraphQLInt),
            "height": GraphQLField(GraphQLInt),
        },
    )

    BlogAuthor = GraphQLObjectType(
        "Author",
        lambda: {
            "id": GraphQLField(GraphQLString),
            "name": GraphQLField(GraphQLString),
            "pic": GraphQLField(
                BlogImage,
                args={
                    "width": GraphQLArgument(GraphQLInt),
                    "height": GraphQLArgument(GraphQLInt),
                },
                resolver=lambda obj, info, **args: obj.pic(
                    args["width"], args["height"]
                ),
            ),
            "recentArticle": GraphQLField(BlogArticle),
        },
    )

    BlogArticle = GraphQLObjectType(
        "Article",
        {
            "id": GraphQLField(GraphQLNonNull(GraphQLString)),
            "isPublished": GraphQLField(GraphQLBoolean),
            "author": GraphQLField(BlogAuthor),
            "title": GraphQLField(GraphQLString),
            "body": GraphQLField(GraphQLString),
            "keywords": GraphQLField(GraphQLList(GraphQLString)),
        },
    )

    BlogQuery = GraphQLObjectType(
        "Query",
        {
            "article": GraphQLField(
                BlogArticle,
                args={"id": GraphQLArgument(GraphQLID)},
                resolver=lambda obj, info, **args: Article(args["id"]),
            ),
            "feed": GraphQLField(
                GraphQLList(BlogArticle),
                resolver=lambda *_: map(Article, range(1, 2 + 1)),
            ),
        },
    )

    BlogSchema = GraphQLSchema(BlogQuery)

    class Article(object):
        def __init__(self, id):
            # type: (int) -> None
            self.id = id
            self.isPublished = True
            self.author = Author()
            self.title = "My Article {}".format(id)
            self.body = "This is a post"
            self.hidden = "This data is not exposed in the schema"
            self.keywords = ["foo", "bar", 1, True, None]

    class Author(object):
        id = 123
        name = "John Smith"

        def pic(self, width, height):
            return Pic(123, width, height)

        @property
        def recentArticle(self):
            return Article(1)

    class Pic(object):
        def __init__(self, uid, width, height):
            self.url = "cdn://{}".format(uid)
            self.width = str(width)
            self.height = str(height)

    class PathCollectorMiddleware(object):
        def __init__(self):
            # type: () -> None
            self.paths = []

        def resolve(
            self,
            _next,  # type: Callable
            root,  # type: Optional[Article]
            info,  # type: ResolveInfo
            *args,  # type: Any
            **kwargs  # type: Any
        ):
            # type: (...) -> Promise
            self.paths.append(info.path)
            return _next(root, info, *args, **kwargs)

    request = """
    {
        feed {
          id
          ...articleFields
          author {
            id
            name
            nameAlias: name
          }
        },
    }
    fragment articleFields on Article {
        title,
        body,
        hidden,
    }
    """

    paths_middleware = PathCollectorMiddleware()

    result = execute(BlogSchema, parse(request), middleware=(paths_middleware,))
    assert not result.errors
    assert result.data == {
        "feed": [
            {
                "id": "1",
                "title": "My Article 1",
                "body": "This is a post",
                "author": {
                    "id": "123",
                    "name": "John Smith",
                    "nameAlias": "John Smith",
                },
            },
            {
                "id": "2",
                "title": "My Article 2",
                "body": "This is a post",
                "author": {
                    "id": "123",
                    "name": "John Smith",
                    "nameAlias": "John Smith",
                },
            },
        ]
    }

    traversed_paths = paths_middleware.paths
    assert traversed_paths == [
        ["feed"],
        ["feed", 0, "id"],
        ["feed", 0, "title"],
        ["feed", 0, "body"],
        ["feed", 0, "author"],
        ["feed", 1, "id"],
        ["feed", 1, "title"],
        ["feed", 1, "body"],
        ["feed", 1, "author"],
        ["feed", 0, "author", "id"],
        ["feed", 0, "author", "name"],
        ["feed", 0, "author", "nameAlias"],
        ["feed", 1, "author", "id"],
        ["feed", 1, "author", "name"],
        ["feed", 1, "author", "nameAlias"],
    ]