feat: add support for jinja graphigl render for flask, quart and webob

Author: kiendang

graphql_server/flask/graphqlview.py

@@ -39,6 +39,7 @@ class GraphQLView(View):
     validation_rules = None
     execution_context_class = None
     batch = False
+    jinja_env = None
     subscriptions = None
     headers = None
     default_query = None
@@ -131,7 +132,7 @@ def dispatch_request(self):
                     graphiql_version=self.graphiql_version,
                     graphiql_template=self.graphiql_template,
                     graphiql_html_title=self.graphiql_html_title,
-                    jinja_env=None,
+                    jinja_env=self.jinja_env,
                 )
                 graphiql_options = GraphiQLOptions(
                     default_query=self.default_query,

graphql_server/quart/graphqlview.py

@@ -39,6 +39,7 @@ class GraphQLView(View):
     validation_rules = None
     execution_context_class = None
     batch = False
+    jinja_env = None
     enable_async = False
     subscriptions = None
     headers = None
@@ -140,7 +141,7 @@ async def dispatch_request(self):
                     graphiql_version=self.graphiql_version,
                     graphiql_template=self.graphiql_template,
                     graphiql_html_title=self.graphiql_html_title,
-                    jinja_env=None,
+                    jinja_env=self.jinja_env,
                 )
                 graphiql_options = GraphiQLOptions(
                     default_query=self.default_query,

graphql_server/webob/graphqlview.py

@@ -38,6 +38,7 @@ class GraphQLView:
     validation_rules = None
     execution_context_class = None
     batch = False
+    jinja_env = None
     enable_async = False
     subscriptions = None
     headers = None
@@ -133,7 +134,7 @@ def dispatch_request(self, request):
                     graphiql_version=self.graphiql_version,
                     graphiql_template=self.graphiql_template,
                     graphiql_html_title=self.graphiql_html_title,
-                    jinja_env=None,
+                    jinja_env=self.jinja_env,
                 )
                 graphiql_options = GraphiQLOptions(
                     default_query=self.default_query,

tests/flask/conftest.py

@@ -0,0 +1,19 @@
+import pytest
+
+from .app import create_app
+
+
+@pytest.fixture
+def app():
+    # import app factory pattern
+    app = create_app()
+
+    # pushes an application context manually
+    ctx = app.app_context()
+    ctx.push()
+    return app
+
+
+@pytest.fixture
+def client(app):
+    return app.test_client()

tests/flask/test_graphiqlview.py

@@ -1,25 +1,14 @@
 import pytest
 from flask import url_for
+from jinja2 import Environment
 
 from .app import create_app
 
 
-@pytest.fixture
-def app():
-    # import app factory pattern
-    app = create_app(graphiql=True)
-
-    # pushes an application context manually
-    ctx = app.app_context()
-    ctx.push()
-    return app
-
-
-@pytest.fixture
-def client(app):
-    return app.test_client()
-
-
+@pytest.mark.parametrize(
+    "app",
+    [create_app(graphiql=True), create_app(graphiql=True, jinja_env=Environment())],
+)
 def test_graphiql_is_enabled(app, client):
     with app.test_request_context():
         response = client.get(
@@ -28,6 +17,10 @@ def test_graphiql_is_enabled(app, client):
     assert response.status_code == 200
 
 
+@pytest.mark.parametrize(
+    "app",
+    [create_app(graphiql=True), create_app(graphiql=True, jinja_env=Environment())],
+)
 def test_graphiql_renders_pretty(app, client):
     with app.test_request_context():
         response = client.get(
@@ -45,14 +38,24 @@ def test_graphiql_renders_pretty(app, client):
     assert pretty_response in response.data.decode("utf-8")
 
 
+@pytest.mark.parametrize(
+    "app",
+    [create_app(graphiql=True), create_app(graphiql=True, jinja_env=Environment())],
+)
 def test_graphiql_default_title(app, client):
     with app.test_request_context():
         response = client.get(url_for("graphql"), headers={"Accept": "text/html"})
     assert "<title>GraphiQL</title>" in response.data.decode("utf-8")
 
 
 @pytest.mark.parametrize(
-    "app", [create_app(graphiql=True, graphiql_html_title="Awesome")]
+    "app",
+    [
+        create_app(graphiql=True, graphiql_html_title="Awesome"),
+        create_app(
+            graphiql=True, graphiql_html_title="Awesome", jinja_env=Environment()
+        ),
+    ],
 )
 def test_graphiql_custom_title(app, client):
     with app.test_request_context():

tests/flask/test_graphqlview.py

@@ -9,30 +9,11 @@
 from .app import create_app
 
 
-@pytest.fixture
-def app():
-    # import app factory pattern
-    app = create_app()
-
-    # pushes an application context manually
-    ctx = app.app_context()
-    ctx.push()
-    return app
-
-
-@pytest.fixture
-def client(app):
-    return app.test_client()
-
-
 def url_string(app, **url_params):
     with app.test_request_context():
-        string = url_for("graphql")
-
-    if url_params:
-        string += "?" + urlencode(url_params)
+        url = url_for("graphql")
 
-    return string
+    return f"{url}?{urlencode(url_params)}" if url_params else url
 
 
 def response_json(response):

tests/quart/conftest.py

@@ -1,3 +1,23 @@
+import pytest
+from quart import Quart
 from quart.typing import TestClientProtocol
 
+from .app import create_app
+
 TestClientProtocol.__test__ = False  # type: ignore
+
+
+@pytest.fixture
+def app() -> Quart:
+    # import app factory pattern
+    app = create_app()
+
+    # pushes an application context manually
+    # ctx = app.app_context()
+    # await ctx.push()
+    return app
+
+
+@pytest.fixture
+def client(app: Quart) -> TestClientProtocol:
+    return app.test_client()

tests/quart/test_graphiqlview.py

@@ -1,29 +1,14 @@
 from typing import Optional
 
 import pytest
+from jinja2 import Environment
 from quart import Quart, Response, url_for
 from quart.typing import TestClientProtocol
 from werkzeug.datastructures import Headers
 
 from .app import create_app
 
 
-@pytest.fixture
-def app() -> Quart:
-    # import app factory pattern
-    app = create_app(graphiql=True)
-
-    # pushes an application context manually
-    # ctx = app.app_context()
-    # await ctx.push()
-    return app
-
-
-@pytest.fixture
-def client(app: Quart) -> TestClientProtocol:
-    return app.test_client()
-
-
 @pytest.mark.asyncio
 async def execute_client(
     app: Quart,
@@ -39,6 +24,10 @@ async def execute_client(
 
 
 @pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "app",
+    [create_app(graphiql=True), create_app(graphiql=True, jinja_env=Environment())],
+)
 async def test_graphiql_is_enabled(app: Quart, client: TestClientProtocol):
     response = await execute_client(
         app, client, headers=Headers({"Accept": "text/html"}), externals=False
@@ -47,6 +36,10 @@ async def test_graphiql_is_enabled(app: Quart, client: TestClientProtocol):
 
 
 @pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "app",
+    [create_app(graphiql=True), create_app(graphiql=True, jinja_env=Environment())],
+)
 async def test_graphiql_renders_pretty(app: Quart, client: TestClientProtocol):
     response = await execute_client(
         app, client, headers=Headers({"Accept": "text/html"}), query="{test}"
@@ -64,6 +57,10 @@ async def test_graphiql_renders_pretty(app: Quart, client: TestClientProtocol):
 
 
 @pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "app",
+    [create_app(graphiql=True), create_app(graphiql=True, jinja_env=Environment())],
+)
 async def test_graphiql_default_title(app: Quart, client: TestClientProtocol):
     response = await execute_client(
         app, client, headers=Headers({"Accept": "text/html"})
@@ -74,7 +71,13 @@ async def test_graphiql_default_title(app: Quart, client: TestClientProtocol):
 
 @pytest.mark.asyncio
 @pytest.mark.parametrize(
-    "app", [create_app(graphiql=True, graphiql_html_title="Awesome")]
+    "app",
+    [
+        create_app(graphiql=True, graphiql_html_title="Awesome"),
+        create_app(
+            graphiql=True, graphiql_html_title="Awesome", jinja_env=Environment()
+        ),
+    ],
 )
 async def test_graphiql_custom_title(app: Quart, client: TestClientProtocol):
     response = await execute_client(

tests/quart/test_graphqlview.py

@@ -11,22 +11,6 @@
 from .app import create_app
 
 
-@pytest.fixture
-def app() -> Quart:
-    # import app factory pattern
-    app = create_app(graphiql=True)
-
-    # pushes an application context manually
-    # ctx = app.app_context()
-    # await ctx.push()
-    return app
-
-
-@pytest.fixture
-def client(app: Quart) -> TestClientProtocol:
-    return app.test_client()
-
-
 @pytest.mark.asyncio
 async def execute_client(
     app: Quart,

tests/webob/app.py

@@ -3,16 +3,12 @@
 from webob import Request
 
 from graphql_server.webob import GraphQLView
-from tests.webob.schema import Schema
 
+from .schema import Schema
 
-def url_string(**url_params):
-    string = "/graphql"
 
-    if url_params:
-        string += "?" + urlencode(url_params)
-
-    return string
+def url_string(url="/graphql", **url_params):
+    return f"{url}?{urlencode(url_params)}" if url_params else url
 
 
 class Client(object):

tests/webob/conftest.py

@@ -0,0 +1,13 @@
+import pytest
+
+from .app import Client
+
+
+@pytest.fixture
+def settings():
+    return {}
+
+
+@pytest.fixture
+def client(settings):
+    return Client(settings=settings)

tests/webob/test_graphiqlview.py

@@ -1,43 +1,36 @@
 import pytest
+from jinja2 import Environment
 
-from .app import Client, url_string
+from .app import url_string
 
 
-@pytest.fixture
-def settings():
-    return {}
-
-
-@pytest.fixture
-def client(settings):
-    return Client(settings=settings)
+@pytest.mark.parametrize(
+    "settings", [dict(graphiql=True), dict(graphiql=True, jinja_env=Environment())]
+)
+def test_graphiql_is_enabled(client):
+    response = client.get(url_string(query="{test}"), headers={"Accept": "text/html"})
+    assert response.status_code == 200
 
 
-@pytest.fixture
-def pretty_response():
-    return (
+@pytest.mark.parametrize(
+    "settings", [dict(graphiql=True), dict(graphiql=True, jinja_env=Environment())]
+)
+def test_graphiql_simple_renderer(client):
+    response = client.get(url_string(query="{test}"), headers={"Accept": "text/html"})
+    assert response.status_code == 200
+    pretty_response = (
         "{\n"
         '  "data": {\n'
         '    "test": "Hello World"\n'
         "  }\n"
         "}".replace('"', '\\"').replace("\n", "\\n")
     )
-
-
-@pytest.mark.parametrize("settings", [dict(graphiql=True)])
-def test_graphiql_is_enabled(client, settings):
-    response = client.get(url_string(query="{test}"), headers={"Accept": "text/html"})
-    assert response.status_code == 200
-
-
-@pytest.mark.parametrize("settings", [dict(graphiql=True)])
-def test_graphiql_simple_renderer(client, settings, pretty_response):
-    response = client.get(url_string(query="{test}"), headers={"Accept": "text/html"})
-    assert response.status_code == 200
     assert pretty_response in response.body.decode("utf-8")
 
 
-@pytest.mark.parametrize("settings", [dict(graphiql=True)])
-def test_graphiql_html_is_not_accepted(client, settings):
+@pytest.mark.parametrize(
+    "settings", [dict(graphiql=True), dict(graphiql=True, jinja_env=Environment())]
+)
+def test_graphiql_html_is_not_accepted(client):
     response = client.get(url_string(), headers={"Accept": "application/json"})
     assert response.status_code == 400