Fix enable_async for aiohttp and sanic if graphiql is enabled (#67)

* Fix enable_async=True in aiohttp

Apply the fix suggested by ketanbshah in
#64

* Apply the same fix to sanic

* tests: add tests for graphiql enabled plus async

Co-authored-by: Manuel Bojato <[email protected]>
Co-authored-by: KingDarBoja <[email protected]>

Author: r-owen

graphql_server/aiohttp/graphqlview.py

@@ -4,7 +4,7 @@
 from typing import List
 
 from aiohttp import web
-from graphql import GraphQLError
+from graphql import ExecutionResult, GraphQLError
 from graphql.type.schema import GraphQLSchema
 
 from graphql_server import (
@@ -152,7 +152,10 @@ async def __call__(self, request):
             )
 
             exec_res = (
-                [await ex for ex in execution_results]
+                [
+                    ex if ex is None or isinstance(ex, ExecutionResult) else await ex
+                    for ex in execution_results
+                ]
                 if self.enable_async
                 else execution_results
             )

graphql_server/sanic/graphqlview.py

@@ -4,7 +4,7 @@
 from functools import partial
 from typing import List
 
-from graphql import GraphQLError
+from graphql import ExecutionResult, GraphQLError
 from graphql.type.schema import GraphQLSchema
 from sanic.response import HTTPResponse, html
 from sanic.views import HTTPMethodView
@@ -105,7 +105,12 @@ async def dispatch_request(self, request, *args, **kwargs):
                     middleware=self.get_middleware(),
                 )
                 exec_res = (
-                    [await ex for ex in execution_results]
+                    [
+                        ex
+                        if ex is None or isinstance(ex, ExecutionResult)
+                        else await ex
+                        for ex in execution_results
+                    ]
                     if self.enable_async
                     else execution_results
                 )

tests/aiohttp/schema.py

@@ -91,4 +91,22 @@ def resolver_field_sync(_obj, info):
 )
 
 
+def resolver_field_sync_1(_obj, info):
+    return "synced_one"
+
+
+def resolver_field_sync_2(_obj, info):
+    return "synced_two"
+
+
+SyncQueryType = GraphQLObjectType(
+    "SyncQueryType",
+    {
+        "a": GraphQLField(GraphQLString, resolve=resolver_field_sync_1),
+        "b": GraphQLField(GraphQLString, resolve=resolver_field_sync_2),
+    },
+)
+
+
 AsyncSchema = GraphQLSchema(AsyncQueryType)
+SyncSchema = GraphQLSchema(SyncQueryType)

tests/aiohttp/test_graphiqlview.py

@@ -3,7 +3,7 @@
 from jinja2 import Environment
 
 from tests.aiohttp.app import create_app, url_string
-from tests.aiohttp.schema import AsyncSchema, Schema
+from tests.aiohttp.schema import AsyncSchema, Schema, SyncSchema
 
 
 @pytest.fixture
@@ -102,11 +102,51 @@ async def test_graphiql_get_subscriptions(app, client):
 
 
 @pytest.mark.asyncio
-@pytest.mark.parametrize("app", [create_app(schema=AsyncSchema, enable_async=True)])
-async def test_graphiql_async_schema(app, client):
+@pytest.mark.parametrize(
+    "app", [create_app(schema=AsyncSchema, enable_async=True, graphiql=True)]
+)
+async def test_graphiql_enabled_async_schema(app, client):
     response = await client.get(
         url_string(query="{a,b,c}"), headers={"Accept": "text/html"},
     )
 
+    expected_response = (
+        (
+            "{\n"
+            '  "data": {\n'
+            '    "a": "hey",\n'
+            '    "b": "hey2",\n'
+            '    "c": "hey3"\n'
+            "  }\n"
+            "}"
+        )
+        .replace('"', '\\"')
+        .replace("\n", "\\n")
+    )
+    assert response.status == 200
+    assert expected_response in await response.text()
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "app", [create_app(schema=SyncSchema, enable_async=True, graphiql=True)]
+)
+async def test_graphiql_enabled_sync_schema(app, client):
+    response = await client.get(
+        url_string(query="{a,b}"), headers={"Accept": "text/html"},
+    )
+
+    expected_response = (
+        (
+            "{\n"
+            '  "data": {\n'
+            '    "a": "synced_one",\n'
+            '    "b": "synced_two"\n'
+            "  }\n"
+            "}"
+        )
+        .replace('"', '\\"')
+        .replace("\n", "\\n")
+    )
     assert response.status == 200
-    assert await response.json() == {"data": {"a": "hey", "b": "hey2", "c": "hey3"}}
+    assert expected_response in await response.text()

tests/sanic/schema.py

@@ -78,4 +78,22 @@ def resolver_field_sync(_obj, info):
     },
 )
 
+
+def resolver_field_sync_1(_obj, info):
+    return "synced_one"
+
+
+def resolver_field_sync_2(_obj, info):
+    return "synced_two"
+
+
+SyncQueryType = GraphQLObjectType(
+    "SyncQueryType",
+    {
+        "a": GraphQLField(GraphQLString, resolve=resolver_field_sync_1),
+        "b": GraphQLField(GraphQLString, resolve=resolver_field_sync_2),
+    },
+)
+
 AsyncSchema = GraphQLSchema(AsyncQueryType)
+SyncSchema = GraphQLSchema(SyncQueryType)

tests/sanic/test_graphiqlview.py

@@ -2,7 +2,7 @@
 from jinja2 import Environment
 
 from .app import create_app, url_string
-from .schema import AsyncSchema
+from .schema import AsyncSchema, SyncSchema
 
 
 @pytest.fixture
@@ -62,9 +62,9 @@ def test_graphiql_html_is_not_accepted(app):
 
 
 @pytest.mark.parametrize(
-    "app", [create_app(graphiql=True, schema=AsyncSchema, enable_async=True)]
+    "app", [create_app(schema=AsyncSchema, enable_async=True, graphiql=True)]
 )
-def test_graphiql_asyncio_schema(app):
+def test_graphiql_enabled_async_schema(app):
     query = "{a,b,c}"
     _, response = app.client.get(
         uri=url_string(query=query), headers={"Accept": "text/html"}
@@ -86,3 +86,28 @@ def test_graphiql_asyncio_schema(app):
 
     assert response.status == 200
     assert expected_response in response.body.decode("utf-8")
+
+
+@pytest.mark.parametrize(
+    "app", [create_app(schema=SyncSchema, enable_async=True, graphiql=True)]
+)
+def test_graphiql_enabled_sync_schema(app):
+    query = "{a,b}"
+    _, response = app.client.get(
+        uri=url_string(query=query), headers={"Accept": "text/html"}
+    )
+
+    expected_response = (
+        (
+            "{\n"
+            '  "data": {\n'
+            '    "a": "synced_one",\n'
+            '    "b": "synced_two"\n'
+            "  }\n"
+            "}"
+        )
+        .replace('"', '\\"')
+        .replace("\n", "\\n")
+    )
+    assert response.status == 200
+    assert expected_response in response.body.decode("utf-8")