fix: graphql response status code

Author: KarolJagodzinski

ariadne/asgi/handlers/http.py

@@ -443,18 +443,22 @@ async def create_json_response(
         """Creates JSON response from GraphQL's query result.
 
         Returns Starlette's `JSONResponse` instance that's also compatible
-        with FastAPI. If `success` is `True`, response's status code is 200.
-        Status code 400 is used otherwise.
+        with FastAPI. If `success` is `True` or the result contains non-null
+        'data' (indicating execution was attempted and produced results),
+        response's status code is 200. Status code 400 is used otherwise.
 
         # Required arguments
 
         `request`: the `Request` instance from Starlette or FastAPI.
 
         `result`: a JSON-serializable `dict` with query result.
 
-        `success`: a `bool` specifying if
+        `success`: a `bool` specifying if query execution was successful.
         """
-        status_code = HTTPStatus.OK if success else HTTPStatus.BAD_REQUEST
+        if success or result.get("data") is not None:
+            status_code = HTTPStatus.OK
+        else:
+            status_code = HTTPStatus.BAD_REQUEST
         return JSONResponse(result, status_code=status_code)
 
     def handle_not_allowed_method(self, request: Request):

ariadne/graphql.py

@@ -567,7 +567,7 @@ def handle_query_result(
         if result.errors:
             extension_manager.has_errors(result.errors)
         add_extensions_to_response(extension_manager, response)
-    return not result.errors, response
+    return result.data is not None, response
 
 
 def handle_graphql_errors(

ariadne/wsgi.py

@@ -546,11 +546,10 @@ def return_response_from_result(
         `result`: a `GraphQLResult` for this request.
         """
         success, response = result
-        status_str = (
-            HttpStatusResponse.OK.value
-            if success
-            else HttpStatusResponse.BAD_REQUEST.value
-        )
+        if success or response.get("data") is not None:
+            status_str = HttpStatusResponse.OK.value
+        else:
+            status_str = HttpStatusResponse.BAD_REQUEST.value
         start_response(status_str, [("Content-Type", CONTENT_TYPE_JSON)])
         return [json.dumps(response).encode("utf-8")]
 

tests/asgi/__snapshots__/test_query_execution.ambr

@@ -138,3 +138,24 @@
     }),
   })
 # ---
+# name: test_query_with_execution_errors_returns_200_status_code
+  dict({
+    'data': dict({
+      'testError': None,
+    }),
+    'errors': list([
+      dict({
+        'locations': list([
+          dict({
+            'column': 3,
+            'line': 1,
+          }),
+        ]),
+        'message': 'Test exception',
+        'path': list([
+          'testError',
+        ]),
+      }),
+    ]),
+  })
+# ---

tests/asgi/test_query_execution.py

@@ -228,6 +228,20 @@ def test_middleware(next_fn, *args, **kwargs):
     assert response.json() == {"data": {"hello": "=*Hello, BOB!*="}}
 
 
+def test_query_with_execution_errors_returns_200_status_code(client, snapshot):
+    response = client.post("/", json={"query": "{ testError }"})
+    assert response.status_code == HTTPStatus.OK
+    assert snapshot == response.json()
+
+
+def test_query_with_syntax_error_returns_400_status_code(client):
+    """Unparseable query produces no data entry → 400 per GraphQL over HTTP spec."""
+    response = client.post("/", json={"query": "{ invalid syntax !!@ }"})
+    assert response.status_code == HTTPStatus.BAD_REQUEST
+    assert "data" not in response.json()
+    assert response.json()["errors"]
+
+
 def test_schema_not_set(client, snapshot):
     client.app.http_handler.schema = None
     with pytest.raises(TypeError):

tests/test_graphql.py

@@ -126,16 +126,18 @@ async def test_graphql_executes_the_query_using_result_update_obj(schema):
     }
 
 
-def test_graphql_sync_returns_false_success_when_execution_produces_errors(schema):
+def test_graphql_sync_returns_true_success_when_execution_produces_errors(schema):
     success, result = graphql_sync(schema, {"query": "{ testError }"})
-    assert not success
+    assert success
+    assert result["data"] is not None
     assert result["errors"]
 
 
 @pytest.mark.asyncio
-async def test_graphql_returns_false_success_when_execution_produces_errors(schema):
+async def test_graphql_returns_true_success_when_execution_produces_errors(schema):
     success, result = await graphql(schema, {"query": "{ testError }"})
-    assert not success
+    assert success
+    assert result["data"] is not None
     assert result["errors"]
 
 

tests/wsgi/test_request_data_reading.py

@@ -126,7 +126,7 @@ def test_attempt_parse_json_scalar_request_raises_graphql_bad_request_error(
     request = graphql_query_request_factory(raw_data=json.dumps("json string"))
     result = middleware(request, start_response)
     start_response.assert_called_once_with(
-        HttpBadRequestError().status, graphql_response_headers
+        HttpStatusResponse.BAD_REQUEST.value, graphql_response_headers
     )
     assert_json_response_equals_snapshot(result)
 
@@ -141,7 +141,7 @@ def test_attempt_parse_json_array_request_raises_graphql_bad_request_error(
     request = graphql_query_request_factory(raw_data=json.dumps([1, 2, 3]))
     result = middleware(request, start_response)
     start_response.assert_called_once_with(
-        HttpBadRequestError().status, graphql_response_headers
+        HttpStatusResponse.BAD_REQUEST.value, graphql_response_headers
     )
     assert_json_response_equals_snapshot(result)