Allow empty custom context in GraphQLView (graphql-python#106)

* Allow empty custom context in GraphQLView * chore: black --------- Co-authored-by: Kien Dang <[email protected]>
wavemm · Apr 13, 2023 · d76450a · d76450a
1 parent 8b9639e
commit d76450a
Show file tree

Hide file tree

Showing 15 changed files with 110 additions and 5 deletions.
diff --git a/graphql_server/aiohttp/graphqlview.py b/graphql_server/aiohttp/graphqlview.py
@@ -76,7 +76,7 @@ def get_root_value(self):
     def get_context(self, request):
         context = (
             copy.copy(self.context)
-            if self.context and isinstance(self.context, MutableMapping)
+            if self.context is not None and isinstance(self.context, MutableMapping)
             else {}
         )
         if isinstance(context, MutableMapping) and "request" not in context:

diff --git a/graphql_server/flask/graphqlview.py b/graphql_server/flask/graphqlview.py
@@ -73,7 +73,7 @@ def get_root_value(self):
     def get_context(self):
         context = (
             copy.copy(self.context)
-            if self.context and isinstance(self.context, MutableMapping)
+            if self.context is not None and isinstance(self.context, MutableMapping)
             else {}
         )
         if isinstance(context, MutableMapping) and "request" not in context:

diff --git a/graphql_server/quart/graphqlview.py b/graphql_server/quart/graphqlview.py
@@ -77,7 +77,7 @@ def get_root_value(self):
     def get_context(self):
         context = (
             copy.copy(self.context)
-            if self.context and isinstance(self.context, MutableMapping)
+            if self.context is not None and isinstance(self.context, MutableMapping)
             else {}
         )
         if isinstance(context, MutableMapping) and "request" not in context:

diff --git a/graphql_server/sanic/graphqlview.py b/graphql_server/sanic/graphqlview.py
@@ -78,7 +78,7 @@ def get_root_value(self):
     def get_context(self, request):
         context = (
             copy.copy(self.context)
-            if self.context and isinstance(self.context, MutableMapping)
+            if self.context is not None and isinstance(self.context, MutableMapping)
             else {}
         )
         if isinstance(context, MutableMapping) and "request" not in context:

diff --git a/graphql_server/webob/graphqlview.py b/graphql_server/webob/graphqlview.py
@@ -72,7 +72,7 @@ def get_root_value(self):
     def get_context(self, request):
         context = (
             copy.copy(self.context)
-            if self.context and isinstance(self.context, MutableMapping)
+            if self.context is not None and isinstance(self.context, MutableMapping)
             else {}
         )
         if isinstance(context, MutableMapping) and "request" not in context:

diff --git a/tests/aiohttp/schema.py b/tests/aiohttp/schema.py
@@ -35,6 +35,9 @@ def resolve_raises(*_):
                         GraphQLNonNull(GraphQLString),
                         resolve=lambda obj, info: info.context["request"],
                     ),
+                    "property": GraphQLField(
+                        GraphQLString, resolve=lambda obj, info: info.context.property
+                    ),
                 },
             ),
             resolve=lambda obj, info: info.context,

diff --git a/tests/aiohttp/test_graphqlview.py b/tests/aiohttp/test_graphqlview.py
@@ -539,6 +539,24 @@ async def test_context_remapped_if_not_mapping(app, client):
     assert "Request" in _json["data"]["context"]["request"]
 
 
+class CustomContext(dict):
+    property = "A custom property"
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize("app", [create_app(context=CustomContext())])
+async def test_allow_empty_custom_context(app, client):
+    response = await client.get(url_string(query="{context { property request }}"))
+
+    _json = await response.json()
+    assert response.status == 200
+    assert "data" in _json
+    assert "request" in _json["data"]["context"]
+    assert "property" in _json["data"]["context"]
+    assert "A custom property" == _json["data"]["context"]["property"]
+    assert "Request" in _json["data"]["context"]["request"]
+
+
 @pytest.mark.asyncio
 @pytest.mark.parametrize("app", [create_app(context={"request": "test"})])
 async def test_request_not_replaced(app, client):

diff --git a/tests/flask/schema.py b/tests/flask/schema.py
@@ -29,6 +29,9 @@ def resolve_raises(*_):
                         GraphQLNonNull(GraphQLString),
                         resolve=lambda obj, info: info.context["request"],
                     ),
+                    "property": GraphQLField(
+                        GraphQLString, resolve=lambda obj, info: info.context.property
+                    ),
                 },
             ),
             resolve=lambda obj, info: info.context,

diff --git a/tests/flask/test_graphqlview.py b/tests/flask/test_graphqlview.py
@@ -499,6 +499,23 @@ def test_context_remapped_if_not_mapping(app, client):
     assert "Request" in res["data"]["context"]["request"]
 
 
+class CustomContext(dict):
+    property = "A custom property"
+
+
+@pytest.mark.parametrize("app", [create_app(context=CustomContext())])
+def test_allow_empty_custom_context(app, client):
+    response = client.get(url_string(app, query="{context { property request }}"))
+
+    assert response.status_code == 200
+    res = response_json(response)
+    assert "data" in res
+    assert "request" in res["data"]["context"]
+    assert "property" in res["data"]["context"]
+    assert "A custom property" == res["data"]["context"]["property"]
+    assert "Request" in res["data"]["context"]["request"]
+
+
 def test_post_multipart_data(app, client):
     query = "mutation TestMutation { writeTest { test } }"
     response = client.post(

diff --git a/tests/quart/schema.py b/tests/quart/schema.py
@@ -32,6 +32,9 @@ def resolve_raises(*_):
                         GraphQLNonNull(GraphQLString),
                         resolve=lambda obj, info: info.context["request"],
                     ),
+                    "property": GraphQLField(
+                        GraphQLString, resolve=lambda obj, info: info.context.property
+                    ),
                 },
             ),
             resolve=lambda obj, info: info.context,

diff --git a/tests/quart/test_graphqlview.py b/tests/quart/test_graphqlview.py
@@ -633,6 +633,25 @@ async def test_context_remapped_if_not_mapping(app: Quart, client: TestClientPro
     assert "Request" in res["data"]["context"]["request"]
 
 
+class CustomContext(dict):
+    property = "A custom property"
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize("app", [create_app(context=CustomContext())])
+async def test_allow_empty_custom_context(app: Quart, client: TestClientProtocol):
+    response = await execute_client(app, client, query="{context { property request }}")
+
+    assert response.status_code == 200
+    result = await response.get_data(as_text=True)
+    res = response_json(result)
+    assert "data" in res
+    assert "request" in res["data"]["context"]
+    assert "property" in res["data"]["context"]
+    assert "A custom property" == res["data"]["context"]["property"]
+    assert "Request" in res["data"]["context"]["request"]
+
+
 # @pytest.mark.asyncio
 # async def test_post_multipart_data(app: Quart, client: TestClientProtocol):
 #     query = "mutation TestMutation { writeTest { test } }"

diff --git a/tests/sanic/schema.py b/tests/sanic/schema.py
@@ -32,6 +32,9 @@ def resolve_raises(*_):
                         GraphQLNonNull(GraphQLString),
                         resolve=lambda obj, info: info.context["request"],
                     ),
+                    "property": GraphQLField(
+                        GraphQLString, resolve=lambda obj, info: info.context.property
+                    ),
                 },
             ),
             resolve=lambda obj, info: info.context,

diff --git a/tests/sanic/test_graphqlview.py b/tests/sanic/test_graphqlview.py
@@ -469,6 +469,25 @@ def test_passes_custom_context_into_context(app):
     assert "Request" in res["data"]["context"]["request"]
 
 
+class CustomContext(dict):
+    property = "A custom property"
+
+
+@pytest.mark.parametrize("app", [create_app(context=CustomContext())])
+def test_allow_empty_custom_context(app):
+    _, response = app.test_client.get(
+        uri=url_string(query="{context { property request }}")
+    )
+
+    assert response.status_code == 200
+    res = response_json(response)
+    assert "data" in res
+    assert "request" in res["data"]["context"]
+    assert "property" in res["data"]["context"]
+    assert "A custom property" == res["data"]["context"]["property"]
+    assert "Request" in res["data"]["context"]["request"]
+
+
 @pytest.mark.parametrize("app", [create_app(context="CUSTOM CONTEXT")])
 def test_context_remapped_if_not_mapping(app):
     _, response = app.test_client.get(

diff --git a/tests/webob/schema.py b/tests/webob/schema.py
@@ -30,6 +30,9 @@ def resolve_raises(*_):
                         GraphQLNonNull(GraphQLString),
                         resolve=lambda obj, info: info.context["request"],
                     ),
+                    "property": GraphQLField(
+                        GraphQLString, resolve=lambda obj, info: info.context.property
+                    ),
                 },
             ),
             resolve=lambda obj, info: info.context,

diff --git a/tests/webob/test_graphqlview.py b/tests/webob/test_graphqlview.py
@@ -461,6 +461,23 @@ def test_context_remapped_if_not_mapping(client, settings):
     assert "request" in res["data"]["context"]["request"]
 
 
+class CustomContext(dict):
+    property = "A custom property"
+
+
+@pytest.mark.parametrize("settings", [dict(context=CustomContext())])
+def test_allow_empty_custom_context(client, settings):
+    response = client.get(url_string(query="{context { property request }}"))
+
+    assert response.status_code == 200
+    res = response_json(response)
+    assert "data" in res
+    assert "request" in res["data"]["context"]
+    assert "property" in res["data"]["context"]
+    assert "A custom property" == res["data"]["context"]["property"]
+    assert "request" in res["data"]["context"]["request"]
+
+
 def test_post_multipart_data(client):
     query = "mutation TestMutation { writeTest { test } }"
     data = (