Added support for options/cors

Author: syrusakbary

src/graphql_server/fastapi/router.py

@@ -254,6 +254,13 @@ async def handle_http_post(  # pyright: ignore
                     status_code=e.status_code,
                 )
 
+        @self.options(path)
+        async def handle_http_options(  # pyright: ignore
+            request: Request,
+            response: Response,
+        ) -> Response:
+            return Response(status_code=200)
+
         @self.websocket(path)
         async def websocket_endpoint(  # pyright: ignore
             websocket: WebSocket,

src/graphql_server/http/async_base_view.py

@@ -198,14 +198,12 @@ async def create_websocket_response(
 
     async def execute_operation(
         self,
-        request: Request,
+        request_adapter: AsyncHTTPRequestAdapter,
         request_data: GraphQLRequestData,
         context: Context,
         root_value: Optional[RootValue],
         allowed_operation_types: set[OperationType],
     ) -> ExecutionResult:
-        request_adapter = self.request_adapter_class(request)
-
         assert self.schema
 
         if request_data.protocol == "multipart-subscription":
@@ -279,17 +277,18 @@ async def run(
         context: Context = UNSET,
         root_value: Optional[RootValue] = UNSET,
     ) -> Union[Response, WebSocketResponse]:
-        root_value = (
-            await self.get_root_value(request) if root_value is UNSET else root_value
-        )
-
         if self.is_websocket_request(request):
             websocket_subprotocol = await self.pick_websocket_subprotocol(request)
             websocket_response = await self.create_websocket_response(
                 request, websocket_subprotocol
             )
             websocket = self.websocket_adapter_class(self, request, websocket_response)
 
+            root_value = (
+                await self.get_root_value(request)
+                if root_value is UNSET
+                else root_value
+            )
             context = (
                 await self.get_context(request, response=websocket_response)
                 if context is UNSET
@@ -324,7 +323,16 @@ async def run(
         request = cast("Request", request)
 
         request_adapter = self.request_adapter_class(request)
+        if request_adapter.method == "OPTIONS":
+            # We are in a CORS preflight request, we can return a 200 OK by default
+            # as further checks will need to be done by the middleware
+            raise HTTPException(200, "")
+
         sub_response = await self.get_sub_response(request)
+
+        root_value = (
+            await self.get_root_value(request) if root_value is UNSET else root_value
+        )
         context = (
             await self.get_context(request, response=sub_response)
             if context is UNSET
@@ -366,7 +374,7 @@ async def run(
         is_strict = request_data.protocol == "http-strict"
         try:
             result = await self.execute_operation(
-                request=request,
+                request_adapter=request_adapter,
                 request_data=request_data,
                 context=context,
                 root_value=root_value,

src/graphql_server/http/sync_base_view.py

@@ -100,14 +100,12 @@ def render_graphql_ide(
 
     def execute_operation(
         self,
-        request: Request,
+        request_adapter: SyncHTTPRequestAdapter,
         request_data: GraphQLRequestData,
         context: Context,
         root_value: Optional[RootValue],
         allowed_operation_types: set[OperationType],
     ) -> ExecutionResult:
-        request_adapter = self.request_adapter_class(request)
-
         assert self.schema
 
         return execute_sync(
@@ -188,6 +186,10 @@ def run(
         root_value: Optional[RootValue] = UNSET,
     ) -> Response:
         request_adapter = self.request_adapter_class(request)
+        if request_adapter.method == "OPTIONS":
+            # We are in a CORS preflight request, we can return a 200 OK by default
+            # as further checks will need to be done by the middleware
+            raise HTTPException(200, "")
 
         if not self.is_request_allowed(request_adapter):
             raise HTTPException(405, "GraphQL only supports GET and POST requests.")
@@ -232,7 +234,7 @@ def run(
         is_strict = request_data.protocol == "http-strict"
         try:
             result = self.execute_operation(
-                request=request,
+                request_adapter=request_adapter,
                 request_data=request_data,
                 context=context,
                 root_value=root_value,

src/graphql_server/litestar/controller.py

@@ -374,19 +374,6 @@ async def handle_http_post(
             root_value=root_value,
         )
 
-    @websocket()
-    async def websocket_endpoint(
-        self,
-        socket: WebSocket,
-        context_ws: Any,
-        root_value: Any,
-    ) -> None:
-        await self.run(
-            request=socket,
-            context=context_ws,
-            root_value=root_value,
-        )
-
     async def get_context(
         self,
         request: Union[Request[Any, Any, Any], WebSocket],

src/graphql_server/sanic/views.py

@@ -194,6 +194,9 @@ async def get(self, request: Request) -> HTTPResponse:
         except HTTPException as e:
             return HTTPResponse(e.reason, status=e.status_code)
 
+    async def options(self, request: Request) -> HTTPResponse:
+        return HTTPResponse(status=200)
+
     async def create_streaming_response(
         self,
         request: Request,

src/tests/http/test_http.py

@@ -30,3 +30,10 @@ async def test_the_http_handler_uses_the_views_decode_json_method(
     assert data["hello"] == "Hello world"
 
     assert spy.call_count == 1
+
+
+async def test_does_allow_http_options(
+    http_client: HttpClient,
+):
+    response = await http_client.request(url="/graphql", method="options")
+    assert response.status_code in (200, 204)

src/tests/litestar/app.py

@@ -3,6 +3,8 @@
 from graphql_server.litestar import make_graphql_controller
 from litestar import Litestar, Request
 from litestar.di import Provide
+from litestar.config.cors import CORSConfig
+
 from tests.views.schema import schema
 
 
@@ -27,9 +29,12 @@ def create_app(schema=schema, **kwargs: Any):
         **kwargs,
     )
 
+    cors_config = CORSConfig(allow_origins=["*"])
+
     return Litestar(
         route_handlers=[GraphQLController],
         dependencies={
             "app_dependency": Provide(custom_context_dependency, sync_to_thread=True)
         },
+        cors_config=cors_config,
     )