Added GraphQLRequestData argument to the render_graphql_ide method

Author: syrusakbary

src/graphql_server/aiohttp/views.py

@@ -28,6 +28,7 @@
     NonTextMessageReceived,
     WebSocketDisconnected,
 )
+from graphql_server.http import GraphQLRequestData
 from graphql_server.http.types import FormData, HTTPMethod, QueryParams
 from graphql_server.http.typevars import (
     Context,
@@ -174,7 +175,9 @@ def __init__(
         else:
             self.graphql_ide = graphql_ide
 
-    async def render_graphql_ide(self, request: web.Request) -> web.Response:
+    async def render_graphql_ide(
+        self, request: web.Request, request_data: GraphQLRequestData
+    ) -> web.Response:
         return web.Response(text=self.graphql_ide_html, content_type="text/html")
 
     async def get_sub_response(self, request: web.Request) -> web.Response:

src/graphql_server/asgi/__init__.py

@@ -22,6 +22,7 @@
 )
 from starlette.websockets import WebSocket, WebSocketDisconnect, WebSocketState
 
+from graphql_server.http import GraphQLRequestData
 from graphql_server.http.async_base_view import (
     AsyncBaseHTTPView,
     AsyncHTTPRequestAdapter,
@@ -204,7 +205,9 @@ async def get_sub_response(
 
         return sub_response
 
-    async def render_graphql_ide(self, request: Request) -> Response:
+    async def render_graphql_ide(
+        self, request: Request, request_data: GraphQLRequestData
+    ) -> Response:
         return HTMLResponse(self.graphql_ide_html)
 
     def create_response(

src/graphql_server/chalice/views.py

@@ -4,6 +4,7 @@
 from typing import TYPE_CHECKING, Any, Optional, Union, cast
 
 from chalice.app import Request, Response
+from graphql_server.http import GraphQLRequestData
 from graphql_server.http.exceptions import HTTPException
 from graphql_server.http.sync_base_view import SyncBaseHTTPView, SyncHTTPRequestAdapter
 from graphql_server.http.temporal_response import TemporalResponse
@@ -80,7 +81,9 @@ def __init__(
     def get_root_value(self, request: Request) -> Optional[RootValue]:
         return None
 
-    def render_graphql_ide(self, request: Request) -> Response:
+    def render_graphql_ide(
+        self, request: Request, request_data: GraphQLRequestData
+    ) -> Response:
         return Response(
             self.graphql_ide_html,
             headers={"Content-Type": "text/html"},

src/graphql_server/channels/handlers/http_handler.py

@@ -25,6 +25,7 @@
     AsyncBaseHTTPView,
     AsyncHTTPRequestAdapter,
 )
+from graphql_server.http import GraphQLRequestData
 from graphql_server.http.exceptions import HTTPException
 from graphql_server.http.sync_base_view import SyncBaseHTTPView, SyncHTTPRequestAdapter
 from graphql_server.http.temporal_response import TemporalResponse
@@ -295,7 +296,9 @@ async def create_streaming_response(
             stream=stream, status=status, headers=response_headers
         )
 
-    async def render_graphql_ide(self, request: ChannelsRequest) -> ChannelsResponse:
+    async def render_graphql_ide(
+        self, request: ChannelsRequest, request_data: GraphQLRequestData
+    ) -> ChannelsResponse:
         return ChannelsResponse(
             content=self.graphql_ide_html.encode(),
             content_type="text/html; charset=utf-8",
@@ -351,7 +354,9 @@ def get_context(
     def get_sub_response(self, request: ChannelsRequest) -> TemporalResponse:
         return TemporalResponse()
 
-    def render_graphql_ide(self, request: ChannelsRequest) -> ChannelsResponse:
+    def render_graphql_ide(
+        self, request: ChannelsRequest, request_data: GraphQLRequestData
+    ) -> ChannelsResponse:
         return ChannelsResponse(
             content=self.graphql_ide_html.encode(),
             content_type="text/html; charset=utf-8",

src/graphql_server/channels/handlers/ws_handler.py

@@ -11,6 +11,7 @@
 )
 from typing_extensions import TypeGuard
 
+from graphql_server.http import GraphQLRequestData
 from graphql_server.http.async_base_view import AsyncBaseHTTPView, AsyncWebSocketAdapter
 from graphql_server.http.exceptions import (
     NonJsonMessageReceived,
@@ -175,7 +176,9 @@ def create_response(
     ) -> GraphQLWSConsumer:
         raise NotImplementedError
 
-    async def render_graphql_ide(self, request: GraphQLWSConsumer) -> GraphQLWSConsumer:
+    async def render_graphql_ide(
+        self, request: GraphQLWSConsumer, request_data: GraphQLRequestData
+    ) -> GraphQLWSConsumer:
         raise NotImplementedError
 
     def is_websocket_request(

src/graphql_server/django/views.py

@@ -27,6 +27,7 @@
 from django.utils.decorators import classonlymethod
 from django.views.generic import View
 
+from graphql_server.http import GraphQLRequestData
 from graphql_server.http.async_base_view import (
     AsyncBaseHTTPView,
     AsyncHTTPRequestAdapter,
@@ -240,7 +241,9 @@ def dispatch(
                 status=e.status_code,
             )
 
-    def render_graphql_ide(self, request: HttpRequest) -> HttpResponse:
+    def render_graphql_ide(
+        self, request: HttpRequest, request_data: GraphQLRequestData
+    ) -> HttpResponse:
         try:
             content = render_to_string("graphql/graphiql.html", request=request)
         except TemplateDoesNotExist:
@@ -300,7 +303,9 @@ async def dispatch(  # pyright: ignore
                 status=e.status_code,
             )
 
-    async def render_graphql_ide(self, request: HttpRequest) -> HttpResponse:
+    async def render_graphql_ide(
+        self, request: HttpRequest, request_data: GraphQLRequestData
+    ) -> HttpResponse:
         try:
             content = render_to_string("graphql/graphiql.html", request=request)
         except TemplateDoesNotExist:

src/graphql_server/fastapi/router.py

@@ -29,6 +29,7 @@
 from fastapi.datastructures import Default
 from fastapi.routing import APIRoute
 from fastapi.utils import generate_unique_id
+from graphql_server.http import GraphQLRequestData
 from graphql_server.asgi import ASGIRequestAdapter, ASGIWebSocketAdapter
 from graphql_server.fastapi.context import BaseContext, CustomContext
 from graphql_server.http.async_base_view import AsyncBaseHTTPView
@@ -261,7 +262,9 @@ async def websocket_endpoint(  # pyright: ignore
         ) -> None:
             await self.run(request=websocket, context=context, root_value=root_value)
 
-    async def render_graphql_ide(self, request: Request) -> HTMLResponse:
+    async def render_graphql_ide(
+        self, request: Request, request_data: GraphQLRequestData
+    ) -> HTMLResponse:
         return HTMLResponse(self.graphql_ide_html)
 
     async def get_context(

src/graphql_server/flask/views.py

@@ -13,6 +13,7 @@
 
 from flask import Request, Response, render_template_string, request
 from flask.views import View
+from graphql_server.http import GraphQLRequestData
 from graphql_server.http.async_base_view import (
     AsyncBaseHTTPView,
     AsyncHTTPRequestAdapter,
@@ -129,7 +130,9 @@ def dispatch_request(self) -> ResponseReturnValue:
                 status=e.status_code,
             )
 
-    def render_graphql_ide(self, request: Request) -> Response:
+    def render_graphql_ide(
+        self, request: Request, request_data: GraphQLRequestData
+    ) -> Response:
         return render_template_string(self.graphql_ide_html)  # type: ignore
 
 
@@ -192,7 +195,9 @@ async def dispatch_request(self) -> ResponseReturnValue:  # type: ignore
                 status=e.status_code,
             )
 
-    async def render_graphql_ide(self, request: Request) -> Response:
+    async def render_graphql_ide(
+        self, request: Request, request_data: GraphQLRequestData
+    ) -> Response:
         content = render_template_string(self.graphql_ide_html)
         return Response(content, status=200, content_type="text/html")
 

src/graphql_server/http/async_base_view.py

@@ -16,7 +16,7 @@
 from typing_extensions import Literal, TypeGuard
 
 from graphql import ExecutionResult, GraphQLError
-from graphql.language import OperationType
+from graphql.language import OperationType, DocumentNode
 from graphql.type import GraphQLSchema
 
 from graphql_server import execute, subscribe
@@ -171,7 +171,9 @@ def create_response(
     ) -> Response: ...
 
     @abc.abstractmethod
-    async def render_graphql_ide(self, request: Request) -> Response: ...
+    async def render_graphql_ide(
+        self, request: Request, request_data: GraphQLRequestData
+    ) -> Response: ...
 
     async def create_streaming_response(
         self,
@@ -198,18 +200,14 @@ async def create_websocket_response(
     ) -> WebSocketResponse: ...
 
     async def execute_operation(
-        self, request: Request, context: Context, root_value: Optional[RootValue]
+        self,
+        request: Request,
+        request_data: GraphQLRequestData,
+        context: Context,
+        root_value: Optional[RootValue],
     ) -> ExecutionResult:
         request_adapter = self.request_adapter_class(request)
 
-        try:
-            request_data = await self.parse_http_body(request_adapter)
-        except json.decoder.JSONDecodeError as e:
-            raise HTTPException(400, "Unable to parse request body as JSON") from e
-            # DO this only when doing files
-        except KeyError as e:
-            raise HTTPException(400, "File(s) missing in form data") from e
-
         allowed_operation_types = operation_type_from_http(request_adapter.method)
 
         if not self.allow_queries_via_get and request_adapter.method == "GET":
@@ -343,14 +341,25 @@ async def run(
         if not self.is_request_allowed(request_adapter):
             raise HTTPException(405, "GraphQL only supports GET and POST requests.")
 
+        try:
+            request_data = await self.parse_http_body(request_adapter)
+        except json.decoder.JSONDecodeError as e:
+            raise HTTPException(400, "Unable to parse request body as JSON") from e
+            # DO this only when doing files
+        except KeyError as e:
+            raise HTTPException(400, "File(s) missing in form data") from e
+
         if self.should_render_graphql_ide(request_adapter):
             if self.graphql_ide:
-                return await self.render_graphql_ide(request)
+                return await self.render_graphql_ide(request, request_data)
             raise HTTPException(404, "Not Found")
 
         try:
             result = await self.execute_operation(
-                request=request, context=context, root_value=root_value
+                request=request,
+                request_data=request_data,
+                context=context,
+                root_value=root_value,
             )
         except GraphQLValidationError as e:
             result = ExecutionResult(data=None, errors=e.errors)
@@ -529,6 +538,17 @@ async def parse_multipart_subscriptions(
 
         return self.parse_json(await request.get_body())
 
+    async def get_graphql_request_data(
+        self, data: dict[str, Any], protocol: Literal["http", "multipart-subscription"]
+    ) -> GraphQLRequestData:
+        return GraphQLRequestData(
+            query=data.get("query"),
+            variables=data.get("variables"),
+            operation_name=data.get("operationName"),
+            extensions=data.get("extensions"),
+            protocol=protocol,
+        )
+
     async def parse_http_body(
         self, request: AsyncHTTPRequestAdapter
     ) -> GraphQLRequestData:
@@ -550,13 +570,7 @@ async def parse_http_body(
         else:
             raise HTTPException(400, "Unsupported content type")
 
-        return GraphQLRequestData(
-            query=data.get("query"),
-            variables=data.get("variables"),
-            operation_name=data.get("operationName"),
-            extensions=data.get("extensions"),
-            protocol=protocol,
-        )
+        return await self.get_graphql_request_data(data, protocol)
 
     async def process_result(
         self, request: Request, result: ExecutionResult

src/graphql_server/http/sync_base_view.py

@@ -7,6 +7,7 @@
     Generic,
     Optional,
     Union,
+    Literal,
 )
 
 from graphql import ExecutionResult, GraphQLError
@@ -93,21 +94,19 @@ def create_response(
     ) -> Response: ...
 
     @abc.abstractmethod
-    def render_graphql_ide(self, request: Request) -> Response: ...
+    def render_graphql_ide(
+        self, request: Request, request_data: GraphQLRequestData
+    ) -> Response: ...
 
     def execute_operation(
-        self, request: Request, context: Context, root_value: Optional[RootValue]
+        self,
+        request: Request,
+        request_data: GraphQLRequestData,
+        context: Context,
+        root_value: Optional[RootValue],
     ) -> ExecutionResult:
         request_adapter = self.request_adapter_class(request)
 
-        try:
-            request_data = self.parse_http_body(request_adapter)
-        except json.decoder.JSONDecodeError as e:
-            raise HTTPException(400, "Unable to parse request body as JSON") from e
-            # DO this only when doing files
-        except KeyError as e:
-            raise HTTPException(400, "File(s) missing in form data") from e
-
         allowed_operation_types = operation_type_from_http(request_adapter.method)
 
         if not self.allow_queries_via_get and request_adapter.method == "GET":
@@ -135,6 +134,17 @@ def parse_multipart(self, request: SyncHTTPRequestAdapter) -> dict[str, str]:
         except KeyError as e:
             raise HTTPException(400, "File(s) missing in form data") from e
 
+    def get_graphql_request_data(
+        self, data: dict[str, Any], protocol: Literal["http", "multipart-subscription"]
+    ) -> GraphQLRequestData:
+        return GraphQLRequestData(
+            query=data.get("query"),
+            variables=data.get("variables"),
+            operation_name=data.get("operationName"),
+            extensions=data.get("extensions"),
+            protocol=protocol,
+        )
+
     def parse_http_body(self, request: SyncHTTPRequestAdapter) -> GraphQLRequestData:
         content_type, params = parse_content_type(request.content_type or "")
 
@@ -152,12 +162,7 @@ def parse_http_body(self, request: SyncHTTPRequestAdapter) -> GraphQLRequestData
         else:
             raise HTTPException(400, "Unsupported content type")
 
-        return GraphQLRequestData(
-            query=data.get("query"),
-            variables=data.get("variables"),
-            operation_name=data.get("operationName"),
-            extensions=data.get("extensions"),
-        )
+        return self.get_graphql_request_data(data, "http")
 
     def _handle_errors(
         self, errors: list[GraphQLError], response_data: GraphQLHTTPResponse
@@ -175,9 +180,17 @@ def run(
         if not self.is_request_allowed(request_adapter):
             raise HTTPException(405, "GraphQL only supports GET and POST requests.")
 
+        try:
+            request_data = self.parse_http_body(request_adapter)
+        except json.decoder.JSONDecodeError as e:
+            raise HTTPException(400, "Unable to parse request body as JSON") from e
+            # DO this only when doing files
+        except KeyError as e:
+            raise HTTPException(400, "File(s) missing in form data") from e
+
         if self.should_render_graphql_ide(request_adapter):
             if self.graphql_ide:
-                return self.render_graphql_ide(request)
+                return self.render_graphql_ide(request, request_data)
             raise HTTPException(404, "Not Found")
 
         sub_response = self.get_sub_response(request)
@@ -191,6 +204,7 @@ def run(
         try:
             result = self.execute_operation(
                 request=request,
+                request_data=request_data,
                 context=context,
                 root_value=root_value,
             )