Add support for subscriptions (#4)

Cito · Cito · commit 00c379a3bddc · 2020-01-24T19:36:34.000+01:00
diff --git a/README.md b/README.md
@@ -52,6 +52,7 @@ gql_view(request)  # <-- the instance is callable and expects a `aiohttp.web.Req
 -   `encoder`: the encoder to use for responses (sensibly defaults to `graphql_server.json_encode`)
 -   `error_formatter`: the error formatter to use for responses (sensibly defaults to `graphql_server.default_format_error`)
 -   `enable_async`: whether `async` mode will be enabled.
+-   `subscriptions`: The [GraphiQL] socket endpoint for using subscriptions in [graphql-ws].
 
 
 ## Testing
@@ -85,3 +86,4 @@ This project is licensed under the MIT License.
   [Apollo-Client]: http://dev.apollodata.com/core/network.html#query-batching
   [Devin Fee]: https://github.com/dfee
   [aiohttp-graphql]: https://github.com/graphql-python/aiohttp-graphql
+  [graphql-ws]: https://github.com/graphql-python/graphql-ws
diff --git a/aiohttp_graphql/graphqlview.py b/aiohttp_graphql/graphqlview.py
@@ -35,6 +35,7 @@ def __init__(
         encoder=None,
         error_formatter=None,
         enable_async=True,
+        subscriptions=None,
         **execution_options,
     ):
         # pylint: disable=too-many-arguments
@@ -55,6 +56,7 @@ def __init__(
         self.encoder = encoder or json_encode
         self.error_formatter = error_formatter or default_format_error
         self.enable_async = enable_async and isinstance(self.executor, AsyncioExecutor)
+        self.subscriptions = subscriptions
         self.execution_options = execution_options
         assert isinstance(
             self.schema, GraphQLSchema
@@ -97,6 +99,7 @@ def render_graphiql(self, params, result):
             result=result,
             graphiql_version=self.graphiql_version,
             graphiql_template=self.graphiql_template,
+            subscriptions=self.subscriptions,
         )
 
     def is_graphiql(self, request):
diff --git a/aiohttp_graphql/render_graphiql.py b/aiohttp_graphql/render_graphiql.py
@@ -29,6 +29,8 @@
   <script src="//cdn.jsdelivr.net/npm/react@16.12.0/umd/react.production.min.js"></script>
   <script src="//cdn.jsdelivr.net/npm/react-dom@16.12.0/umd/react-dom.production.min.js"></script>
   <script src="//cdn.jsdelivr.net/npm/graphiql@{{graphiql_version}}/graphiql.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/subscriptions-transport-ws@0.9.16/browser/client.js"></script>
+  <script src="//cdn.jsdelivr.net//npm/graphiql-subscriptions-fetcher@0.0.2/browser/client.js"></script>
 </head>
 <body>
   <script>
@@ -63,6 +65,20 @@
         otherParams[k] = parameters[k];
       }
     }
+
+    var subscriptionsFetcher;
+    if ('{{subscriptions}}') {
+      const subscriptionsClient = new SubscriptionsTransportWs.SubscriptionClient(
+        '{{ subscriptions }}',
+        {reconnect: true}
+      );
+
+      subscriptionsFetcher = GraphiQLSubscriptionsFetcher.graphQLFetcher(
+        subscriptionsClient,
+        graphQLFetcher
+      );
+    }
+
     var fetchURL = locationQuery(otherParams);
 
     // Defines a GraphQL fetcher using the fetch API.
@@ -110,7 +126,7 @@
     // Render <GraphiQL /> into the body.
     ReactDOM.render(
       React.createElement(GraphiQL, {
-        fetcher: graphQLFetcher,
+        fetcher: subscriptionsFetcher || graphQLFetcher,
         onEditQuery: onEditQuery,
         onEditVariables: onEditVariables,
         onEditOperationName: onEditOperationName,
@@ -149,7 +165,7 @@ def process_var(template, name, value, jsonify=False):
 
 
 def simple_renderer(template, **values):
-    replace = ["graphiql_version"]
+    replace = ["graphiql_version", "subscriptions"]
     replace_jsonify = ["query", "result", "variables", "operation_name"]
 
     for rep in replace:
@@ -167,6 +183,7 @@ async def render_graphiql(
     graphiql_template=None,
     params=None,
     result=None,
+    subscriptions=None,
 ):
     graphiql_version = graphiql_version or GRAPHIQL_VERSION
     template = graphiql_template or TEMPLATE
@@ -176,6 +193,7 @@ async def render_graphiql(
         "variables": params and params.variables,
         "operation_name": params and params.operation_name,
         "result": result,
+        "subscriptions": subscriptions or "",
     }
 
     if jinja_env:
diff --git a/tests/schema.py b/tests/schema.py
@@ -49,8 +49,16 @@ def resolve_raises(*args):
     },
 )
 
+SubscriptionsRootType = GraphQLObjectType(
+    name="SubscriptionsRoot",
+    fields={
+        "subscriptionsTest": GraphQLField(
+            type=QueryRootType, resolver=lambda *args: QueryRootType
+        )
+    },
+)
 
-Schema = GraphQLSchema(QueryRootType, MutationRootType)
+Schema = GraphQLSchema(QueryRootType, MutationRootType, SubscriptionsRootType)
 
 
 # Schema with async methods
diff --git a/tests/test_graphiqlview.py b/tests/test_graphiqlview.py
@@ -78,6 +78,18 @@ async def test_graphiql_get_mutation(client, url_builder):
     assert "response: null" in await response.text()
 
 
+@pytest.mark.asyncio
+async def test_graphiql_get_subscriptions(client, url_builder):
+    response = await client.get(
+        url_builder(
+            query=("subscription TestSubscriptions { subscriptionsTest { test } }")
+        ),
+        headers={"Accept": "text/html"},
+    )
+    assert response.status == 200
+    assert "response: null" in await response.text()
+
+
 class TestAsyncSchema:
     @pytest.fixture
     def executor(self, event_loop):
diff --git a/tests/test_graphqlview.py b/tests/test_graphqlview.py
@@ -102,6 +102,7 @@ async def test_errors_when_missing_operation_name(client, url_builder):
             query="""
         query TestQuery { test }
         mutation TestMutation { writeTest { test } }
+        subscription TestSubscriptions { subscriptionsTest { test } }
         """
         )
     )
@@ -156,6 +157,31 @@ async def test_errors_when_selecting_a_mutation_within_a_get(client, url_builder
     }
 
 
+@pytest.mark.asyncio
+async def test_errors_when_selecting_a_subscription_within_a_get(
+    client, url_builder,
+):
+    response = await client.get(
+        url_builder(
+            query="""
+        subscription TestSubscriptions { subscriptionsTest { test } }
+        """,
+            operationName="TestSubscriptions",
+        )
+    )
+
+    assert response.status == 405
+    assert await response.json() == {
+        "errors": [
+            {
+                "message": (
+                    "Can only perform a subscription operation from a POST " "request."
+                )
+            },
+        ],
+    }
+
+
 @pytest.mark.asyncio
 async def test_allows_mutation_to_exist_within_a_get(client, url_builder):
     response = await client.get(
@@ -196,6 +222,33 @@ async def test_allows_sending_a_mutation_via_post(client, base_url):
     assert await response.json() == {"data": {"writeTest": {"test": "Hello World"}}}
 
 
+@pytest.mark.asyncio
+async def test_errors_when_sending_a_subscription_without_allow(client, base_url):
+    response = await client.post(
+        base_url,
+        data=json.dumps(
+            dict(
+                query="""
+            subscription TestSubscriptions { subscriptionsTest { test } }
+            """,
+            )
+        ),
+        headers={"content-type": "application/json"},
+    )
+
+    assert response.status == 200
+    assert await response.json() == {
+        "data": None,
+        "errors": [
+            {
+                "message": "Subscriptions are not allowed. You will need to "
+                "either use the subscribe function or pass "
+                "allow_subscriptions=True"
+            },
+        ],
+    }
+
+
 @pytest.mark.asyncio
 async def test_allows_post_with_url_encoding(client, base_url):
     data = FormData()
