From 02083f6acffec12a835047389bb558baaa008e04 Mon Sep 17 00:00:00 2001
From: Kien Dang <mail@kien.ai>
Date: Sat, 31 Dec 2022 17:17:22 +0800
Subject: [PATCH 01/10] feat: add support for jinja renderer

---
 graphql_server/render_graphiql.py | 32 ++++++++++++++-----------------
 tests/sanic/app.py                | 10 ++--------
 tests/test_query.py               | 23 ++++++++++++++++++++++
 3 files changed, 39 insertions(+), 26 deletions(-)

diff --git a/graphql_server/render_graphiql.py b/graphql_server/render_graphiql.py
index 498f53b..13d0f48 100644
--- a/graphql_server/render_graphiql.py
+++ b/graphql_server/render_graphiql.py
@@ -1,5 +1,5 @@
 """Based on (express-graphql)[https://github.com/graphql/express-graphql/blob/main/src/renderGraphiQL.ts] and
-(subscriptions-transport-ws)[https://github.com/apollographql/subscriptions-transport-ws]"""
+(graphql-ws)[https://github.com/enisdenjo/graphql-ws]"""
 import json
 import re
 from typing import Any, Dict, Optional, Tuple
@@ -216,24 +216,12 @@ class GraphiQLOptions(TypedDict):
     should_persist_headers: Optional[bool]
 
 
-def escape_js_value(value: Any) -> Any:
-    quotation = False
-    if value.startswith('"') and value.endswith('"'):
-        quotation = True
-        value = value[1 : len(value) - 1]
-
-    value = value.replace("\\\\n", "\\\\\\n").replace("\\n", "\\\\n")
-    if quotation:
-        value = '"' + value.replace('\\\\"', '"').replace('"', '\\"') + '"'
-
-    return value
-
-
 def process_var(template: str, name: str, value: Any, jsonify=False) -> str:
-    pattern = r"{{\s*" + name + r"(\s*|[^}]+)*\s*}}"
+    pattern = r"{{\s*" + name.replace("\\", r"\\") + r"(\s*|[^}]+)*\s*}}"
     if jsonify and value not in ["null", "undefined"]:
         value = json.dumps(value)
-        value = escape_js_value(value)
+
+    value = value.replace("\\", r"\\")
 
     return re.sub(pattern, value, template)
 
@@ -296,6 +284,9 @@ def _render_graphiql(
         or "false",
     }
 
+    if template_vars["result"] in ("null"):
+        template_vars["result"] = None
+
     return graphiql_template, template_vars
 
 
@@ -305,7 +296,7 @@ async def render_graphiql_async(
     options: Optional[GraphiQLOptions] = None,
 ) -> str:
     graphiql_template, template_vars = _render_graphiql(data, config, options)
-    jinja_env: Optional[Environment] = config.get("jinja_env")
+    jinja_env = config.get("jinja_env")
 
     if jinja_env:
         template = jinja_env.from_string(graphiql_template)
@@ -324,6 +315,11 @@ def render_graphiql_sync(
     options: Optional[GraphiQLOptions] = None,
 ) -> str:
     graphiql_template, template_vars = _render_graphiql(data, config, options)
+    jinja_env = config.get("jinja_env")
 
-    source = simple_renderer(graphiql_template, **template_vars)
+    if jinja_env:
+        template = jinja_env.from_string(graphiql_template)
+        source = template.render(**template_vars)
+    else:
+        source = simple_renderer(graphiql_template, **template_vars)
     return source
diff --git a/tests/sanic/app.py b/tests/sanic/app.py
index f70dd8a..5387b97 100644
--- a/tests/sanic/app.py
+++ b/tests/sanic/app.py
@@ -8,20 +8,14 @@
 from .schema import Schema
 
 
-def create_app(path="/graphql", **kwargs):
+def create_app(path="/graphql", schema=Schema, **kwargs):
     random_valid_app_name = f"App{uuid.uuid4().hex}"
     app = Sanic(random_valid_app_name)
 
-    schema = kwargs.pop("schema", None) or Schema
     app.add_route(GraphQLView.as_view(schema=schema, **kwargs), path)
 
     return app
 
 
 def url_string(uri="/graphql", **url_params):
-    string = "/graphql"
-
-    if url_params:
-        string += "?" + urlencode(url_params)
-
-    return string
+    return f"{uri}?{urlencode(url_params)}" if url_params else uri
diff --git a/tests/test_query.py b/tests/test_query.py
index a1352cc..1ae3526 100644
--- a/tests/test_query.py
+++ b/tests/test_query.py
@@ -15,6 +15,11 @@
     load_json_body,
     run_http_query,
 )
+from graphql_server.render_graphiql import (
+    GraphiQLConfig,
+    GraphiQLData,
+    render_graphiql_sync,
+)
 
 from .schema import invalid_schema, schema
 from .utils import as_dicts
@@ -653,3 +658,21 @@ def test_batch_allows_post_with_operation_name():
     results, params = run_http_query(schema, "post", data, batch_enabled=True)
 
     assert results == [({"test": "Hello World", "shared": "Hello Everyone"}, None)]
+
+
+def test_graphiql_render_umlaut():
+    results, params = run_http_query(
+        schema,
+        "get",
+        data=dict(query="query helloWho($who: String){ test(who: $who) }"),
+        query_data=dict(variables='{"who": "Björn"}'),
+        catch=True,
+    )
+    result, status_code = encode_execution_results(results)
+
+    assert status_code == 200
+
+    graphiql_data = GraphiQLData(result=result, query=params[0].query)
+    source = render_graphiql_sync(data=graphiql_data, config=GraphiQLConfig())
+
+    assert "Hello Bj\\\\u00f6rn" in source

From 881f8e27709fd6a8472c6e7727fc998065a1db05 Mon Sep 17 00:00:00 2001
From: Kien Dang <mail@kien.ai>
Date: Sat, 31 Dec 2022 22:53:36 +0800
Subject: [PATCH 02/10] chore: update GraphiQL to 2.2.0

---
 graphql_server/render_graphiql.py | 52 ++++++++++---------------------
 1 file changed, 16 insertions(+), 36 deletions(-)

diff --git a/graphql_server/render_graphiql.py b/graphql_server/render_graphiql.py
index 13d0f48..195603d 100644
--- a/graphql_server/render_graphiql.py
+++ b/graphql_server/render_graphiql.py
@@ -7,7 +7,7 @@
 from jinja2 import Environment
 from typing_extensions import TypedDict
 
-GRAPHIQL_VERSION = "1.4.7"
+GRAPHIQL_VERSION = "2.2.0"
 
 GRAPHIQL_TEMPLATE = """<!--
 The request to this GraphQL server provided the header "Accept: text/html"
@@ -34,13 +34,12 @@
     }
   </style>
   <link href="//cdn.jsdelivr.net/npm/graphiql@{{graphiql_version}}/graphiql.css" rel="stylesheet" />
-  <script src="//cdn.jsdelivr.net/npm/promise-polyfill@8.2.0/dist/polyfill.min.js"></script>
-  <script src="//cdn.jsdelivr.net/npm/unfetch@4.2.0/dist/unfetch.umd.js"></script>
-  <script src="//cdn.jsdelivr.net/npm/react@16.14.0/umd/react.production.min.js"></script>
-  <script src="//cdn.jsdelivr.net/npm/react-dom@16.14.0/umd/react-dom.production.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/promise-polyfill@8.2.3/dist/polyfill.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/unfetch@5.0.0/dist/unfetch.umd.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/react@18.2.0/umd/react.production.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/react-dom@18.2.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.18/browser/client.js"></script>
-  <script src="//cdn.jsdelivr.net/npm/graphiql-subscriptions-fetcher@0.0.2/browser/client.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/graphql-ws@5.11.2/umd/graphql-ws.min.js"></script>
 </head>
 <body>
   <div id="graphiql">Loading...</div>
@@ -75,35 +74,16 @@
         otherParams[k] = parameters[k];
       }
     }
-    // Configure the subscription client
-    let subscriptionsFetcher = null;
-    if ('{{subscription_url}}') {
-      let subscriptionsClient = new SubscriptionsTransportWs.SubscriptionClient(
-        '{{ subscription_url }}',
-        { reconnect: true }
-      );
-      subscriptionsFetcher = GraphiQLSubscriptionsFetcher.graphQLFetcher(
-        subscriptionsClient,
-        graphQLFetcher
-      );
-    }
     var fetchURL = locationQuery(otherParams);
-    // Defines a GraphQL fetcher using the fetch API.
-    function graphQLFetcher(graphQLParams, opts) {
-      return fetch(fetchURL, {
-        method: 'post',
-        headers: Object.assign(
-          {
-            'Accept': 'application/json',
-            'Content-Type': 'application/json'
-          },
-          opts && opts.headers,
-        ),
-        body: JSON.stringify(graphQLParams),
-        credentials: 'include',
-      }).then(function (response) {
-        return response.json();
+    // Defines a GraphQL fetcher.
+    var graphQLFetcher;
+    if ('{{subscription_url}}') {
+      graphQLFetcher = GraphiQL.createFetcher({
+        url: fetchURL,
+        subscription_url: '{{subscription_url}}'
       });
+    } else {
+      graphQLFetcher = GraphiQL.createFetcher({ url: fetchURL });
     }
     // When the query and variables string is edited, update the URL bar so
     // that it can be easily shared.
@@ -129,7 +109,7 @@
     // Render <GraphiQL /> into the body.
     ReactDOM.render(
       React.createElement(GraphiQL, {
-        fetcher: subscriptionsFetcher || graphQLFetcher,
+        fetcher: graphQLFetcher,
         onEditQuery: onEditQuery,
         onEditVariables: onEditVariables,
         onEditHeaders: onEditHeaders,
@@ -140,7 +120,7 @@
         headers: {{headers|tojson}},
         operationName: {{operation_name|tojson}},
         defaultQuery: {{default_query|tojson}},
-        headerEditorEnabled: {{header_editor_enabled|tojson}},
+        isHeadersEditorEnabled: {{header_editor_enabled|tojson}},
         shouldPersistHeaders: {{should_persist_headers|tojson}}
       }),
       document.getElementById('graphiql')

From 2ec12f513b384b3f260ef3bfb2a86e626de7c628 Mon Sep 17 00:00:00 2001
From: Kien Dang <mail@kien.ai>
Date: Fri, 6 Jan 2023 11:40:01 +0800
Subject: [PATCH 03/10] chore: add tests for sanic and aiohttp jinja graphiql
 render

---
 tests/aiohttp/app.py               |  12 ++--
 tests/aiohttp/conftest.py          |  18 +++++
 tests/aiohttp/test_graphiqlview.py | 107 ++++++++++++-----------------
 tests/aiohttp/test_graphqlview.py  |  16 -----
 tests/sanic/app.py                 |   4 +-
 tests/sanic/conftest.py            |   8 +++
 tests/sanic/test_graphiqlview.py   |  50 ++++----------
 tests/sanic/test_graphqlview.py    |  32 ---------
 8 files changed, 89 insertions(+), 158 deletions(-)
 create mode 100644 tests/aiohttp/conftest.py
 create mode 100644 tests/sanic/conftest.py

diff --git a/tests/aiohttp/app.py b/tests/aiohttp/app.py
index 36d7de6..c4b5110 100644
--- a/tests/aiohttp/app.py
+++ b/tests/aiohttp/app.py
@@ -3,7 +3,8 @@
 from aiohttp import web
 
 from graphql_server.aiohttp import GraphQLView
-from tests.aiohttp.schema import Schema
+
+from .schema import Schema
 
 
 def create_app(schema=Schema, **kwargs):
@@ -13,10 +14,5 @@ def create_app(schema=Schema, **kwargs):
     return app
 
 
-def url_string(**url_params):
-    base_url = "/graphql"
-
-    if url_params:
-        return f"{base_url}?{urlencode(url_params)}"
-
-    return base_url
+def url_string(url="/graphql", **url_params):
+    return f"{url}?{urlencode(url_params)}" if url_params else url
diff --git a/tests/aiohttp/conftest.py b/tests/aiohttp/conftest.py
new file mode 100644
index 0000000..8adfd0a
--- /dev/null
+++ b/tests/aiohttp/conftest.py
@@ -0,0 +1,18 @@
+import pytest
+import pytest_asyncio
+from aiohttp.test_utils import TestClient, TestServer
+
+from .app import create_app
+
+
+@pytest.fixture
+def app():
+    return create_app()
+
+
+@pytest_asyncio.fixture
+async def client(app):
+    client = TestClient(TestServer(app))
+    await client.start_server()
+    yield client
+    await client.close()
diff --git a/tests/aiohttp/test_graphiqlview.py b/tests/aiohttp/test_graphiqlview.py
index 1dd30e0..a3bd2fd 100644
--- a/tests/aiohttp/test_graphiqlview.py
+++ b/tests/aiohttp/test_graphiqlview.py
@@ -1,77 +1,35 @@
 import pytest
-import pytest_asyncio
-from aiohttp.test_utils import TestClient, TestServer
 from jinja2 import Environment
 
-from tests.aiohttp.app import create_app, url_string
-from tests.aiohttp.schema import AsyncSchema, Schema, SyncSchema
-
-
-@pytest.fixture
-def app():
-    app = create_app()
-    return app
-
-
-@pytest_asyncio.fixture
-async def client(app):
-    client = TestClient(TestServer(app))
-    await client.start_server()
-    yield client
-    await client.close()
-
-
-@pytest.fixture
-def view_kwargs():
-    return {
-        "schema": Schema,
-        "graphiql": True,
-    }
-
-
-@pytest.fixture
-def pretty_response():
-    return (
-        "{\n"
-        '  "data": {\n'
-        '    "test": "Hello World"\n'
-        "  }\n"
-        "}".replace('"', '\\"').replace("\n", "\\n")
-    )
+from .app import create_app, url_string
+from .schema import AsyncSchema, SyncSchema
 
 
 @pytest.mark.asyncio
-@pytest.mark.parametrize("app", [create_app(graphiql=True)])
+@pytest.mark.parametrize(
+    "app",
+    [
+        create_app(graphiql=True),
+        create_app(graphiql=True, jinja_env=Environment()),
+        create_app(graphiql=True, jinja_env=Environment(enable_async=True)),
+    ],
+)
 async def test_graphiql_is_enabled(app, client):
-    response = await client.get(
-        url_string(query="{test}"), headers={"Accept": "text/html"}
-    )
-    assert response.status == 200
-
-
-@pytest.mark.asyncio
-@pytest.mark.parametrize("app", [create_app(graphiql=True)])
-async def test_graphiql_simple_renderer(app, client, pretty_response):
     response = await client.get(
         url_string(query="{test}"),
         headers={"Accept": "text/html"},
     )
     assert response.status == 200
-    assert pretty_response in await response.text()
-
 
-class TestJinjaEnv:
-    @pytest.mark.asyncio
-    @pytest.mark.parametrize(
-        "app", [create_app(graphiql=True, jinja_env=Environment(enable_async=True))]
+    pretty_response = (
+        "{\n"
+        '  "data": {\n'
+        '    "test": "Hello World"\n'
+        "  }\n"
+        "}".replace('"', '\\"').replace("\n", "\\n")
     )
-    async def test_graphiql_jinja_renderer_async(self, app, client, pretty_response):
-        response = await client.get(
-            url_string(query="{test}"),
-            headers={"Accept": "text/html"},
-        )
-        assert response.status == 200
-        assert pretty_response in await response.text()
+
+    assert pretty_response in await response.text()
 
 
 @pytest.mark.asyncio
@@ -84,7 +42,10 @@ async def test_graphiql_html_is_not_accepted(client):
 
 
 @pytest.mark.asyncio
-@pytest.mark.parametrize("app", [create_app(graphiql=True)])
+@pytest.mark.parametrize(
+    "app",
+    [create_app(graphiql=True), create_app(graphiql=True, jinja_env=Environment())],
+)
 async def test_graphiql_get_mutation(app, client):
     response = await client.get(
         url_string(query="mutation TestMutation { writeTest { test } }"),
@@ -95,7 +56,10 @@ async def test_graphiql_get_mutation(app, client):
 
 
 @pytest.mark.asyncio
-@pytest.mark.parametrize("app", [create_app(graphiql=True)])
+@pytest.mark.parametrize(
+    "app",
+    [create_app(graphiql=True), create_app(graphiql=True, jinja_env=Environment())],
+)
 async def test_graphiql_get_subscriptions(app, client):
     response = await client.get(
         url_string(
@@ -109,7 +73,16 @@ async def test_graphiql_get_subscriptions(app, client):
 
 @pytest.mark.asyncio
 @pytest.mark.parametrize(
-    "app", [create_app(schema=AsyncSchema, enable_async=True, graphiql=True)]
+    "app",
+    [
+        create_app(schema=AsyncSchema, enable_async=True, graphiql=True),
+        create_app(
+            schema=AsyncSchema,
+            enable_async=True,
+            graphiql=True,
+            jinja_env=Environment(),
+        ),
+    ],
 )
 async def test_graphiql_enabled_async_schema(app, client):
     response = await client.get(
@@ -136,7 +109,13 @@ async def test_graphiql_enabled_async_schema(app, client):
 
 @pytest.mark.asyncio
 @pytest.mark.parametrize(
-    "app", [create_app(schema=SyncSchema, enable_async=True, graphiql=True)]
+    "app",
+    [
+        create_app(schema=SyncSchema, enable_async=True, graphiql=True),
+        create_app(
+            schema=SyncSchema, enable_async=True, graphiql=True, jinja_env=Environment()
+        ),
+    ],
 )
 async def test_graphiql_enabled_sync_schema(app, client):
     response = await client.get(
diff --git a/tests/aiohttp/test_graphqlview.py b/tests/aiohttp/test_graphqlview.py
index 41e31d3..f90c95f 100644
--- a/tests/aiohttp/test_graphqlview.py
+++ b/tests/aiohttp/test_graphqlview.py
@@ -2,29 +2,13 @@
 from urllib.parse import urlencode
 
 import pytest
-import pytest_asyncio
 from aiohttp import FormData
-from aiohttp.test_utils import TestClient, TestServer
 
 from ..utils import RepeatExecutionContext
 from .app import create_app, url_string
 from .schema import AsyncSchema
 
 
-@pytest.fixture
-def app():
-    app = create_app()
-    return app
-
-
-@pytest_asyncio.fixture
-async def client(app):
-    client = TestClient(TestServer(app))
-    await client.start_server()
-    yield client
-    await client.close()
-
-
 @pytest.mark.asyncio
 async def test_allows_get_with_query_param(client):
     response = await client.get(url_string(query="{test}"))
diff --git a/tests/sanic/app.py b/tests/sanic/app.py
index 5387b97..2cabd73 100644
--- a/tests/sanic/app.py
+++ b/tests/sanic/app.py
@@ -17,5 +17,5 @@ def create_app(path="/graphql", schema=Schema, **kwargs):
     return app
 
 
-def url_string(uri="/graphql", **url_params):
-    return f"{uri}?{urlencode(url_params)}" if url_params else uri
+def url_string(url="/graphql", **url_params):
+    return f"{url}?{urlencode(url_params)}" if url_params else url
diff --git a/tests/sanic/conftest.py b/tests/sanic/conftest.py
new file mode 100644
index 0000000..2ba7d3c
--- /dev/null
+++ b/tests/sanic/conftest.py
@@ -0,0 +1,8 @@
+import pytest
+
+from .app import create_app
+
+
+@pytest.fixture
+def app():
+    return create_app()
diff --git a/tests/sanic/test_graphiqlview.py b/tests/sanic/test_graphiqlview.py
index 06dbe27..a9da869 100644
--- a/tests/sanic/test_graphiqlview.py
+++ b/tests/sanic/test_graphiqlview.py
@@ -5,51 +5,29 @@
 from .schema import AsyncSchema, SyncSchema
 
 
-@pytest.fixture
-def pretty_response():
-    return (
-        "{\n"
-        '  "data": {\n'
-        '    "test": "Hello World"\n'
-        "  }\n"
-        "}".replace('"', '\\"').replace("\n", "\\n")
-    )
-
-
-@pytest.mark.parametrize("app", [create_app(graphiql=True)])
+@pytest.mark.parametrize(
+    "app",
+    [
+        create_app(graphiql=True),
+        create_app(graphiql=True, jinja_env=Environment()),
+        create_app(graphiql=True, jinja_env=Environment(enable_async=True)),
+    ],
+)
 def test_graphiql_is_enabled(app):
     _, response = app.test_client.get(
         uri=url_string(query="{test}"), headers={"Accept": "text/html"}
     )
-    assert response.status == 200
 
-
-@pytest.mark.parametrize("app", [create_app(graphiql=True)])
-def test_graphiql_simple_renderer(app, pretty_response):
-    _, response = app.test_client.get(
-        uri=url_string(query="{test}"), headers={"Accept": "text/html"}
-    )
     assert response.status == 200
-    assert pretty_response in response.body.decode("utf-8")
 
-
-@pytest.mark.parametrize("app", [create_app(graphiql=True, jinja_env=Environment())])
-def test_graphiql_jinja_renderer(app, pretty_response):
-    _, response = app.test_client.get(
-        uri=url_string(query="{test}"), headers={"Accept": "text/html"}
+    pretty_response = (
+        "{\n"
+        '  "data": {\n'
+        '    "test": "Hello World"\n'
+        "  }\n"
+        "}".replace('"', '\\"').replace("\n", "\\n")
     )
-    assert response.status == 200
-    assert pretty_response in response.body.decode("utf-8")
-
 
-@pytest.mark.parametrize(
-    "app", [create_app(graphiql=True, jinja_env=Environment(enable_async=True))]
-)
-def test_graphiql_jinja_async_renderer(app, pretty_response):
-    _, response = app.test_client.get(
-        uri=url_string(query="{test}"), headers={"Accept": "text/html"}
-    )
-    assert response.status == 200
     assert pretty_response in response.body.decode("utf-8")
 
 
diff --git a/tests/sanic/test_graphqlview.py b/tests/sanic/test_graphqlview.py
index d71fa62..c469c95 100644
--- a/tests/sanic/test_graphqlview.py
+++ b/tests/sanic/test_graphqlview.py
@@ -20,7 +20,6 @@ def json_dump_kwarg_list(**kwargs):
     return json.dumps([kwargs])
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_allows_get_with_query_param(app):
     _, response = app.test_client.get(uri=url_string(query="{test}"))
 
@@ -28,7 +27,6 @@ def test_allows_get_with_query_param(app):
     assert response_json(response) == {"data": {"test": "Hello World"}}
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_allows_get_with_variable_values(app):
     _, response = app.test_client.get(
         uri=url_string(
@@ -41,7 +39,6 @@ def test_allows_get_with_variable_values(app):
     assert response_json(response) == {"data": {"test": "Hello Dolly"}}
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_allows_get_with_operation_name(app):
     _, response = app.test_client.get(
         uri=url_string(
@@ -63,7 +60,6 @@ def test_allows_get_with_operation_name(app):
     }
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_reports_validation_errors(app):
     _, response = app.test_client.get(
         uri=url_string(query="{ test, unknownOne, unknownTwo }")
@@ -84,7 +80,6 @@ def test_reports_validation_errors(app):
     }
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_errors_when_missing_operation_name(app):
     _, response = app.test_client.get(
         uri=url_string(
@@ -106,7 +101,6 @@ def test_errors_when_missing_operation_name(app):
     }
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_errors_when_sending_a_mutation_via_get(app):
     _, response = app.test_client.get(
         uri=url_string(
@@ -125,7 +119,6 @@ def test_errors_when_sending_a_mutation_via_get(app):
     }
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_errors_when_selecting_a_mutation_within_a_get(app):
     _, response = app.test_client.get(
         uri=url_string(
@@ -147,7 +140,6 @@ def test_errors_when_selecting_a_mutation_within_a_get(app):
     }
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_allows_mutation_to_exist_within_a_get(app):
     _, response = app.test_client.get(
         uri=url_string(
@@ -163,7 +155,6 @@ def test_allows_mutation_to_exist_within_a_get(app):
     assert response_json(response) == {"data": {"test": "Hello World"}}
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_allows_post_with_json_encoding(app):
     _, response = app.test_client.post(
         uri=url_string(),
@@ -175,7 +166,6 @@ def test_allows_post_with_json_encoding(app):
     assert response_json(response) == {"data": {"test": "Hello World"}}
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_allows_sending_a_mutation_via_post(app):
     _, response = app.test_client.post(
         uri=url_string(),
@@ -187,7 +177,6 @@ def test_allows_sending_a_mutation_via_post(app):
     assert response_json(response) == {"data": {"writeTest": {"test": "Hello World"}}}
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_allows_post_with_url_encoding(app):
     # Example of how sanic does send data using url enconding
     # can be found at their repo.
@@ -203,7 +192,6 @@ def test_allows_post_with_url_encoding(app):
     assert response_json(response) == {"data": {"test": "Hello World"}}
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_supports_post_json_query_with_string_variables(app):
     _, response = app.test_client.post(
         uri=url_string(),
@@ -218,7 +206,6 @@ def test_supports_post_json_query_with_string_variables(app):
     assert response_json(response) == {"data": {"test": "Hello Dolly"}}
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_supports_post_json_query_with_json_variables(app):
     _, response = app.test_client.post(
         uri=url_string(),
@@ -233,7 +220,6 @@ def test_supports_post_json_query_with_json_variables(app):
     assert response_json(response) == {"data": {"test": "Hello Dolly"}}
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_supports_post_url_encoded_query_with_string_variables(app):
     _, response = app.test_client.post(
         uri=url_string(),
@@ -250,7 +236,6 @@ def test_supports_post_url_encoded_query_with_string_variables(app):
     assert response_json(response) == {"data": {"test": "Hello Dolly"}}
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_supports_post_json_query_with_get_variable_values(app):
     _, response = app.test_client.post(
         uri=url_string(variables=json.dumps({"who": "Dolly"})),
@@ -264,7 +249,6 @@ def test_supports_post_json_query_with_get_variable_values(app):
     assert response_json(response) == {"data": {"test": "Hello Dolly"}}
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_post_url_encoded_query_with_get_variable_values(app):
     _, response = app.test_client.post(
         uri=url_string(variables=json.dumps({"who": "Dolly"})),
@@ -280,7 +264,6 @@ def test_post_url_encoded_query_with_get_variable_values(app):
     assert response_json(response) == {"data": {"test": "Hello Dolly"}}
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_supports_post_raw_text_query_with_get_variable_values(app):
     _, response = app.test_client.post(
         uri=url_string(variables=json.dumps({"who": "Dolly"})),
@@ -292,7 +275,6 @@ def test_supports_post_raw_text_query_with_get_variable_values(app):
     assert response_json(response) == {"data": {"test": "Hello Dolly"}}
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_allows_post_with_operation_name(app):
     _, response = app.test_client.post(
         uri=url_string(),
@@ -316,7 +298,6 @@ def test_allows_post_with_operation_name(app):
     }
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_allows_post_with_get_operation_name(app):
     _, response = app.test_client.post(
         uri=url_string(operationName="helloWorld"),
@@ -353,7 +334,6 @@ def test_not_pretty_by_default(app):
     assert response.body.decode() == '{"data":{"test":"Hello World"}}'
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_supports_pretty_printing_by_request(app):
     _, response = app.test_client.get(uri=url_string(query="{test}", pretty="1"))
 
@@ -362,7 +342,6 @@ def test_supports_pretty_printing_by_request(app):
     )
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_handles_field_errors_caught_by_graphql(app):
     _, response = app.test_client.get(uri=url_string(query="{thrower}"))
     assert response.status == 200
@@ -378,7 +357,6 @@ def test_handles_field_errors_caught_by_graphql(app):
     }
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_handles_syntax_errors_caught_by_graphql(app):
     _, response = app.test_client.get(uri=url_string(query="syntaxerror"))
     assert response.status == 400
@@ -392,7 +370,6 @@ def test_handles_syntax_errors_caught_by_graphql(app):
     }
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_handles_errors_caused_by_a_lack_of_query(app):
     _, response = app.test_client.get(uri=url_string())
 
@@ -402,7 +379,6 @@ def test_handles_errors_caused_by_a_lack_of_query(app):
     }
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_handles_batch_correctly_if_is_disabled(app):
     _, response = app.test_client.post(
         uri=url_string(), content="[]", headers={"content-type": "application/json"}
@@ -418,7 +394,6 @@ def test_handles_batch_correctly_if_is_disabled(app):
     }
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_handles_incomplete_json_bodies(app):
     _, response = app.test_client.post(
         uri=url_string(),
@@ -432,7 +407,6 @@ def test_handles_incomplete_json_bodies(app):
     }
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_handles_plain_post_text(app):
     _, response = app.test_client.post(
         uri=url_string(variables=json.dumps({"who": "Dolly"})),
@@ -445,7 +419,6 @@ def test_handles_plain_post_text(app):
     }
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_handles_poorly_formed_variables(app):
     _, response = app.test_client.get(
         uri=url_string(
@@ -458,7 +431,6 @@ def test_handles_poorly_formed_variables(app):
     }
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_handles_unsupported_http_methods(app):
     _, response = app.test_client.put(uri=url_string(query="{test}"))
     assert response.status == 405
@@ -475,7 +447,6 @@ def test_handles_unsupported_http_methods(app):
     }
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_passes_request_into_request_context(app):
     _, response = app.test_client.get(uri=url_string(query="{request}", q="testing"))
 
@@ -513,7 +484,6 @@ def test_context_remapped_if_not_mapping(app):
     assert "Request" in res["data"]["context"]["request"]
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_post_multipart_data(app):
     query = "mutation TestMutation { writeTest { test } }"
 
@@ -603,7 +573,6 @@ def test_async_schema(app):
     assert response_json(response) == {"data": {"a": "hey", "b": "hey2", "c": "hey3"}}
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_preflight_request(app):
     _, response = app.test_client.options(
         uri=url_string(), headers={"Access-Control-Request-Method": "POST"}
@@ -612,7 +581,6 @@ def test_preflight_request(app):
     assert response.status == 200
 
 
-@pytest.mark.parametrize("app", [create_app()])
 def test_preflight_incorrect_request(app):
     _, response = app.test_client.options(
         uri=url_string(), headers={"Access-Control-Request-Method": "OPTIONS"}

From 7d339273ba80ce27229b57c02dd6c32ef3fdf5bb Mon Sep 17 00:00:00 2001
From: Kien Dang <mail@kien.ai>
Date: Fri, 6 Jan 2023 11:59:56 +0800
Subject: [PATCH 04/10] feat: add support for jinja graphigl render for flask,
 quart and webob

---
 graphql_server/flask/graphqlview.py |  3 +-
 graphql_server/quart/graphqlview.py |  3 +-
 graphql_server/webob/graphqlview.py |  3 +-
 tests/flask/conftest.py             | 19 ++++++++++++
 tests/flask/test_graphiqlview.py    | 37 +++++++++++++-----------
 tests/flask/test_graphqlview.py     | 23 ++-------------
 tests/quart/conftest.py             | 20 +++++++++++++
 tests/quart/test_graphiqlview.py    | 37 +++++++++++++-----------
 tests/quart/test_graphqlview.py     | 16 ----------
 tests/webob/app.py                  | 10 ++-----
 tests/webob/conftest.py             | 13 +++++++++
 tests/webob/test_graphiqlview.py    | 45 ++++++++++++-----------------
 tests/webob/test_graphqlview.py     | 12 +-------
 13 files changed, 123 insertions(+), 118 deletions(-)
 create mode 100644 tests/flask/conftest.py
 create mode 100644 tests/webob/conftest.py

diff --git a/graphql_server/flask/graphqlview.py b/graphql_server/flask/graphqlview.py
index 4bb4665..275d033 100644
--- a/graphql_server/flask/graphqlview.py
+++ b/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,
diff --git a/graphql_server/quart/graphqlview.py b/graphql_server/quart/graphqlview.py
index d7b209f..32fc5dd 100644
--- a/graphql_server/quart/graphqlview.py
+++ b/graphql_server/quart/graphqlview.py
@@ -42,6 +42,7 @@ class GraphQLView(View):
     validation_rules = None
     execution_context_class = None
     batch = False
+    jinja_env = None
     enable_async = False
     subscriptions = None
     headers = None
@@ -147,7 +148,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,
diff --git a/graphql_server/webob/graphqlview.py b/graphql_server/webob/graphqlview.py
index 1048e49..713f653 100644
--- a/graphql_server/webob/graphqlview.py
+++ b/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,
diff --git a/tests/flask/conftest.py b/tests/flask/conftest.py
new file mode 100644
index 0000000..5944b2e
--- /dev/null
+++ b/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()
diff --git a/tests/flask/test_graphiqlview.py b/tests/flask/test_graphiqlview.py
index 4a55710..bca747c 100644
--- a/tests/flask/test_graphiqlview.py
+++ b/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,6 +38,10 @@ 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"})
@@ -52,7 +49,13 @@ def test_graphiql_default_title(app, client):
 
 
 @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():
diff --git a/tests/flask/test_graphqlview.py b/tests/flask/test_graphqlview.py
index 5dc3be0..358ec3b 100644
--- a/tests/flask/test_graphqlview.py
+++ b/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):
diff --git a/tests/quart/conftest.py b/tests/quart/conftest.py
index 5615618..bb5a38c 100644
--- a/tests/quart/conftest.py
+++ b/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()
diff --git a/tests/quart/test_graphiqlview.py b/tests/quart/test_graphiqlview.py
index d183366..17c72d6 100644
--- a/tests/quart/test_graphiqlview.py
+++ b/tests/quart/test_graphiqlview.py
@@ -1,6 +1,7 @@
 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
@@ -8,22 +9,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,
@@ -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(
diff --git a/tests/quart/test_graphqlview.py b/tests/quart/test_graphqlview.py
index 9b2daa2..e8fef3b 100644
--- a/tests/quart/test_graphqlview.py
+++ b/tests/quart/test_graphqlview.py
@@ -12,22 +12,6 @@
 from .schema import AsyncSchema
 
 
-@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,
diff --git a/tests/webob/app.py b/tests/webob/app.py
index c490515..083d179 100644
--- a/tests/webob/app.py
+++ b/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):
diff --git a/tests/webob/conftest.py b/tests/webob/conftest.py
new file mode 100644
index 0000000..12897d1
--- /dev/null
+++ b/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)
diff --git a/tests/webob/test_graphiqlview.py b/tests/webob/test_graphiqlview.py
index dbfe627..b456b60 100644
--- a/tests/webob/test_graphiqlview.py
+++ b/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
diff --git a/tests/webob/test_graphqlview.py b/tests/webob/test_graphqlview.py
index 53e9680..c166f81 100644
--- a/tests/webob/test_graphqlview.py
+++ b/tests/webob/test_graphqlview.py
@@ -4,17 +4,7 @@
 import pytest
 
 from ..utils import RepeatExecutionContext
-from .app import Client, url_string
-
-
-@pytest.fixture
-def settings():
-    return {}
-
-
-@pytest.fixture
-def client(settings):
-    return Client(settings=settings)
+from .app import url_string
 
 
 def response_json(response):

From 9f3f07cf1166dab4d96a8ea4fe7a5f372fd80dd7 Mon Sep 17 00:00:00 2001
From: Kien Dang <mail@kien.ai>
Date: Fri, 6 Jan 2023 12:21:25 +0800
Subject: [PATCH 05/10] chore: check jinja_env type during runtime

---
 graphql_server/__init__.py            | 14 ++++++++++++++
 graphql_server/aiohttp/graphqlview.py |  4 ++++
 graphql_server/flask/graphqlview.py   |  4 ++++
 graphql_server/quart/graphqlview.py   |  4 ++++
 graphql_server/sanic/graphqlview.py   |  4 ++++
 graphql_server/webob/graphqlview.py   |  4 ++++
 6 files changed, 34 insertions(+)

diff --git a/graphql_server/__init__.py b/graphql_server/__init__.py
index 9a58a9f..8fbb1c9 100644
--- a/graphql_server/__init__.py
+++ b/graphql_server/__init__.py
@@ -335,3 +335,17 @@ def format_execution_result(
             response = {"data": execution_result.data}
 
     return FormattedResult(response, status_code)
+
+
+def _check_jinja(jinja_env: Any) -> None:
+    try:
+        from jinja2 import Environment
+    except ImportError:
+        raise RuntimeError(
+            "Attempt to set 'jinja_env' to a value other than None while Jinja2 is not installed.\n"
+            "Please install Jinja2 to render GraphiQL with Jinja2.\n"
+            "Otherwise set 'jinja_env' to None to use the simple regex renderer."
+        )
+
+    if not isinstance(jinja_env, Environment):
+        raise TypeError("'jinja_env' has to be of type jinja2.Environment.")
diff --git a/graphql_server/aiohttp/graphqlview.py b/graphql_server/aiohttp/graphqlview.py
index b5891d1..8e0dbd5 100644
--- a/graphql_server/aiohttp/graphqlview.py
+++ b/graphql_server/aiohttp/graphqlview.py
@@ -12,6 +12,7 @@
 from graphql_server import (
     GraphQLParams,
     HttpQueryError,
+    _check_jinja,
     encode_execution_results,
     format_error_default,
     json_encode,
@@ -66,6 +67,9 @@ def __init__(self, **kwargs):
             if not isinstance(self.schema, GraphQLSchema):
                 raise TypeError("A Schema is required to be provided to GraphQLView.")
 
+        if self.jinja_env is not None:
+            _check_jinja(self.jinja_env)
+
     def get_root_value(self):
         return self.root_value
 
diff --git a/graphql_server/flask/graphqlview.py b/graphql_server/flask/graphqlview.py
index 275d033..6132b61 100644
--- a/graphql_server/flask/graphqlview.py
+++ b/graphql_server/flask/graphqlview.py
@@ -12,6 +12,7 @@
 from graphql_server import (
     GraphQLParams,
     HttpQueryError,
+    _check_jinja,
     encode_execution_results,
     format_error_default,
     json_encode,
@@ -63,6 +64,9 @@ def __init__(self, **kwargs):
             if not isinstance(self.schema, GraphQLSchema):
                 raise TypeError("A Schema is required to be provided to GraphQLView.")
 
+        if self.jinja_env is not None:
+            _check_jinja(self.jinja_env)
+
     def get_root_value(self):
         return self.root_value
 
diff --git a/graphql_server/quart/graphqlview.py b/graphql_server/quart/graphqlview.py
index 32fc5dd..acf90f4 100644
--- a/graphql_server/quart/graphqlview.py
+++ b/graphql_server/quart/graphqlview.py
@@ -14,6 +14,7 @@
 from graphql_server import (
     GraphQLParams,
     HttpQueryError,
+    _check_jinja,
     encode_execution_results,
     format_error_default,
     json_encode,
@@ -67,6 +68,9 @@ def __init__(self, **kwargs):
             if not isinstance(self.schema, GraphQLSchema):
                 raise TypeError("A Schema is required to be provided to GraphQLView.")
 
+        if self.jinja_env is not None:
+            _check_jinja(self.jinja_env)
+
     def get_root_value(self):
         return self.root_value
 
diff --git a/graphql_server/sanic/graphqlview.py b/graphql_server/sanic/graphqlview.py
index 814d489..c79c46b 100644
--- a/graphql_server/sanic/graphqlview.py
+++ b/graphql_server/sanic/graphqlview.py
@@ -14,6 +14,7 @@
 from graphql_server import (
     GraphQLParams,
     HttpQueryError,
+    _check_jinja,
     encode_execution_results,
     format_error_default,
     json_encode,
@@ -68,6 +69,9 @@ def __init__(self, **kwargs):
             if not isinstance(self.schema, GraphQLSchema):
                 raise TypeError("A Schema is required to be provided to GraphQLView.")
 
+        if self.jinja_env is not None:
+            _check_jinja(self.jinja_env)
+
     def get_root_value(self):
         return self.root_value
 
diff --git a/graphql_server/webob/graphqlview.py b/graphql_server/webob/graphqlview.py
index 713f653..e99ecbb 100644
--- a/graphql_server/webob/graphqlview.py
+++ b/graphql_server/webob/graphqlview.py
@@ -11,6 +11,7 @@
 from graphql_server import (
     GraphQLParams,
     HttpQueryError,
+    _check_jinja,
     encode_execution_results,
     format_error_default,
     json_encode,
@@ -62,6 +63,9 @@ def __init__(self, **kwargs):
             if not isinstance(self.schema, GraphQLSchema):
                 raise TypeError("A Schema is required to be provided to GraphQLView.")
 
+        if self.jinja_env is not None:
+            _check_jinja(self.jinja_env)
+
     def get_root_value(self):
         return self.root_value
 

From 181bc03c261ff43406e233904aa7d2fe36961aae Mon Sep 17 00:00:00 2001
From: Kien Dang <mail@kien.ai>
Date: Fri, 6 Jan 2023 12:35:37 +0800
Subject: [PATCH 06/10] chore: not depend on Jinja2 if use simple renderer

---
 graphql_server/render_graphiql.py | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/graphql_server/render_graphiql.py b/graphql_server/render_graphiql.py
index 195603d..5271279 100644
--- a/graphql_server/render_graphiql.py
+++ b/graphql_server/render_graphiql.py
@@ -4,7 +4,11 @@
 import re
 from typing import Any, Dict, Optional, Tuple
 
-from jinja2 import Environment
+try:
+    from jinja2 import Environment
+except ImportError:
+    pass
+
 from typing_extensions import TypedDict
 
 GRAPHIQL_VERSION = "2.2.0"

From 5e0f6e709b18fd4ae94bb62d1f386b34b5df75f4 Mon Sep 17 00:00:00 2001
From: Kien Dang <mail@kien.ai>
Date: Mon, 9 Jan 2023 09:45:06 +0800
Subject: [PATCH 07/10] docs: add flask and webob doc on jinja_env

---
 docs/flask.md | 3 ++-
 docs/webob.md | 3 ++-
 2 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/docs/flask.md b/docs/flask.md
index 0c4125f..dfe0aa7 100644
--- a/docs/flask.md
+++ b/docs/flask.md
@@ -46,9 +46,10 @@ This will add `/graphql` endpoint to your app and enable the GraphiQL IDE.
  * `root_value`: The `root_value` you want to provide to graphql `execute`.
  * `pretty`: Whether or not you want the response to be pretty printed JSON.
  * `graphiql`: If `True`, may present [GraphiQL](https://github.com/graphql/graphiql) when loaded directly from a browser (a useful tool for debugging and exploration).
- * `graphiql_version`: The graphiql version to load. Defaults to **"1.4.7"**.
+ * `graphiql_version`: The graphiql version to load. Defaults to **"2.2.0"**.
  * `graphiql_template`: Inject a Jinja template string to customize GraphiQL.
  * `graphiql_html_title`: The graphiql title to display. Defaults to **"GraphiQL"**.
+ * `jinja_env`: Sets jinja environment to be used to process GraphiQL template. If environment is not set, fallbacks to simple regex-based renderer.
  * `batch`: Set the GraphQL view as batch (for using in [Apollo-Client](http://dev.apollodata.com/core/network.html#query-batching) or [ReactRelayNetworkLayer](https://github.com/nodkz/react-relay-network-layer))
  * `middleware`: A list of graphql [middlewares](http://docs.graphene-python.org/en/latest/execution/middleware/).
  * `validation_rules`: A list of graphql validation rules.
diff --git a/docs/webob.md b/docs/webob.md
index d84e07d..2f88a31 100644
--- a/docs/webob.md
+++ b/docs/webob.md
@@ -43,9 +43,10 @@ This will add `/graphql` endpoint to your app and enable the GraphiQL IDE.
  * `root_value`: The `root_value` you want to provide to graphql `execute`.
  * `pretty`: Whether or not you want the response to be pretty printed JSON.
  * `graphiql`: If `True`, may present [GraphiQL](https://github.com/graphql/graphiql) when loaded directly from a browser (a useful tool for debugging and exploration).
- * `graphiql_version`: The graphiql version to load. Defaults to **"1.4.7"**.
+ * `graphiql_version`: The graphiql version to load. Defaults to **"2.2.0"**.
  * `graphiql_template`: Inject a Jinja template string to customize GraphiQL.
  * `graphiql_html_title`: The graphiql title to display. Defaults to **"GraphiQL"**.
+ * `jinja_env`: Sets jinja environment to be used to process GraphiQL template. If environment is not set, fallbacks to simple regex-based renderer.
  * `batch`: Set the GraphQL view as batch (for using in [Apollo-Client](http://dev.apollodata.com/core/network.html#query-batching) or [ReactRelayNetworkLayer](https://github.com/nodkz/react-relay-network-layer))
  * `middleware`: A list of graphql [middlewares](http://docs.graphene-python.org/en/latest/execution/middleware/).
  * `validation_rules`: A list of graphql validation rules.

From 27a25e4f73ba665729c6c381e9c41d581334c114 Mon Sep 17 00:00:00 2001
From: Kien Dang <mail@kien.ai>
Date: Tue, 7 Feb 2023 11:21:24 +0800
Subject: [PATCH 08/10] chore: add clarifying comment on jinja2.Environment
 import

---
 graphql_server/render_graphiql.py | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/graphql_server/render_graphiql.py b/graphql_server/render_graphiql.py
index 5271279..bcd2c69 100644
--- a/graphql_server/render_graphiql.py
+++ b/graphql_server/render_graphiql.py
@@ -4,6 +4,8 @@
 import re
 from typing import Any, Dict, Optional, Tuple
 
+# This Environment import is only for type checking purpose,
+# and only relevant if rendering GraphiQL with Jinja
 try:
     from jinja2 import Environment
 except ImportError:

From 7616f7f045ef6c3bbf961796b102ef06a6f90364 Mon Sep 17 00:00:00 2001
From: Kien Dang <mail@kien.ai>
Date: Tue, 7 Feb 2023 11:30:20 +0800
Subject: [PATCH 09/10] docs: update GraphiQL default version in aiohttp and
 sanic doc

---
 docs/aiohttp.md | 2 +-
 docs/sanic.md   | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/aiohttp.md b/docs/aiohttp.md
index be38ff5..b301855 100644
--- a/docs/aiohttp.md
+++ b/docs/aiohttp.md
@@ -52,7 +52,7 @@ gql_view(request)  # <-- the instance is callable and expects a `aiohttp.web.Req
  * `root_value`: The `root_value` you want to provide to graphql `execute`.
  * `pretty`: Whether or not you want the response to be pretty printed JSON.
  * `graphiql`: If `True`, may present [GraphiQL](https://github.com/graphql/graphiql) when loaded directly from a browser (a useful tool for debugging and exploration).
- * `graphiql_version`: The graphiql version to load. Defaults to **"1.4.7"**.
+ * `graphiql_version`: The graphiql version to load. Defaults to **"2.2.0"**.
  * `graphiql_template`: Inject a Jinja template string to customize GraphiQL.
  * `graphiql_html_title`: The graphiql title to display. Defaults to **"GraphiQL"**.
  * `jinja_env`: Sets jinja environment to be used to process GraphiQL template. If Jinja’s async mode is enabled (by `enable_async=True`), uses `Template.render_async` instead of `Template.render`. If environment is not set, fallbacks to simple regex-based renderer.
diff --git a/docs/sanic.md b/docs/sanic.md
index 39c20af..102e38d 100644
--- a/docs/sanic.md
+++ b/docs/sanic.md
@@ -44,7 +44,7 @@ This will add `/graphql` endpoint to your app and enable the GraphiQL IDE.
  * `root_value`: The `root_value` you want to provide to graphql `execute`.
  * `pretty`: Whether or not you want the response to be pretty printed JSON.
  * `graphiql`: If `True`, may present [GraphiQL](https://github.com/graphql/graphiql) when loaded directly from a browser (a useful tool for debugging and exploration).
- * `graphiql_version`: The graphiql version to load. Defaults to **"1.4.7"**.
+ * `graphiql_version`: The graphiql version to load. Defaults to **"2.2.0"**.
  * `graphiql_template`: Inject a Jinja template string to customize GraphiQL.
  * `graphiql_html_title`: The graphiql title to display. Defaults to **"GraphiQL"**.
  * `jinja_env`: Sets jinja environment to be used to process GraphiQL template. If Jinja’s async mode is enabled (by `enable_async=True`), uses `Template.render_async` instead of `Template.render`. If environment is not set, fallbacks to simple regex-based renderer.

From a57d3310a02f662b3ab68bebd2abcf60b8c091a9 Mon Sep 17 00:00:00 2001
From: Kien Dang <mail@kien.ai>
Date: Wed, 15 Feb 2023 19:44:30 +0800
Subject: [PATCH 10/10] chore: coverage workaround

---
 graphql_server/__init__.py        | 4 ++--
 graphql_server/render_graphiql.py | 2 +-
 graphql_server/utils.py           | 2 +-
 3 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/graphql_server/__init__.py b/graphql_server/__init__.py
index 8fbb1c9..f8456de 100644
--- a/graphql_server/__init__.py
+++ b/graphql_server/__init__.py
@@ -340,12 +340,12 @@ def format_execution_result(
 def _check_jinja(jinja_env: Any) -> None:
     try:
         from jinja2 import Environment
-    except ImportError:
+    except ImportError:  # pragma: no cover
         raise RuntimeError(
             "Attempt to set 'jinja_env' to a value other than None while Jinja2 is not installed.\n"
             "Please install Jinja2 to render GraphiQL with Jinja2.\n"
             "Otherwise set 'jinja_env' to None to use the simple regex renderer."
         )
 
-    if not isinstance(jinja_env, Environment):
+    if not isinstance(jinja_env, Environment):  # pragma: no cover
         raise TypeError("'jinja_env' has to be of type jinja2.Environment.")
diff --git a/graphql_server/render_graphiql.py b/graphql_server/render_graphiql.py
index bcd2c69..0da06b9 100644
--- a/graphql_server/render_graphiql.py
+++ b/graphql_server/render_graphiql.py
@@ -8,7 +8,7 @@
 # and only relevant if rendering GraphiQL with Jinja
 try:
     from jinja2 import Environment
-except ImportError:
+except ImportError:  # pragma: no cover
     pass
 
 from typing_extensions import TypedDict
diff --git a/graphql_server/utils.py b/graphql_server/utils.py
index c52a24b..d1920d2 100644
--- a/graphql_server/utils.py
+++ b/graphql_server/utils.py
@@ -3,7 +3,7 @@
 
 if sys.version_info >= (3, 10):
     from typing import ParamSpec
-else:
+else:  # pragma: no cover
     from typing_extensions import ParamSpec