From 573fa724616912424808f846b4fe5f4bea8ddc4a Mon Sep 17 00:00:00 2001
From: Patrick Arminio <patrick.arminio@gmail.com>
Date: Tue, 14 Jan 2025 18:41:35 +0000
Subject: [PATCH] WIP defer support

---
 RELEASE.md                                    |   3 +
 poetry.lock                                   |  16 +--
 pyproject.toml                                |   3 +-
 strawberry/http/async_base_view.py            | 101 +++++++++++++++-
 strawberry/schema/execute.py                  |  49 ++++----
 strawberry/schema/schema.py                   |  12 +-
 strawberry/static/graphiql.html               |   7 +-
 tests/http/incremental/__init__.py            |   0
 tests/http/incremental/conftest.py            |  44 +++++++
 tests/http/incremental/test_defer.py          |  38 ++++++
 .../test_multipart_subscription.py            |  62 ++++++++++
 tests/http/test_multipart_subscription.py     | 113 ------------------
 12 files changed, 291 insertions(+), 157 deletions(-)
 create mode 100644 RELEASE.md
 create mode 100644 tests/http/incremental/__init__.py
 create mode 100644 tests/http/incremental/conftest.py
 create mode 100644 tests/http/incremental/test_defer.py
 create mode 100644 tests/http/incremental/test_multipart_subscription.py
 delete mode 100644 tests/http/test_multipart_subscription.py

diff --git a/RELEASE.md b/RELEASE.md
new file mode 100644
index 0000000000..544e3920ea
--- /dev/null
+++ b/RELEASE.md
@@ -0,0 +1,3 @@
+Release type: minor
+
+@defer 👀
diff --git a/poetry.lock b/poetry.lock
index 22cd41a298..df0c27ff66 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -1,4 +1,4 @@
-# This file is automatically @generated by Poetry 1.8.2 and should not be changed by hand.
+# This file is automatically @generated by Poetry 1.8.5 and should not be changed by hand.
 
 [[package]]
 name = "aiofiles"
@@ -1355,17 +1355,17 @@ files = [
 
 [[package]]
 name = "graphql-core"
-version = "3.2.5"
-description = "GraphQL implementation for Python, a port of GraphQL.js, the JavaScript reference implementation for GraphQL."
+version = "3.3.0a6"
+description = "GraphQL-core is a Python port of GraphQL.js,the JavaScript reference implementation for GraphQL."
 optional = false
-python-versions = "<4,>=3.6"
+python-versions = "<4.0,>=3.7"
 files = [
-    {file = "graphql_core-3.2.5-py3-none-any.whl", hash = "sha256:2f150d5096448aa4f8ab26268567bbfeef823769893b39c1a2e1409590939c8a"},
-    {file = "graphql_core-3.2.5.tar.gz", hash = "sha256:e671b90ed653c808715645e3998b7ab67d382d55467b7e2978549111bbabf8d5"},
+    {file = "graphql_core-3.3.0a6-py3-none-any.whl", hash = "sha256:ad99089e04ad7450956cb5f834986b5d9625ff5d90cee754bfab56da93a062b8"},
+    {file = "graphql_core-3.3.0a6.tar.gz", hash = "sha256:3456712b3e6fd45c0d48bf2c1d87e7a80680da987e29f64563faab0886dab380"},
 ]
 
 [package.dependencies]
-typing-extensions = {version = ">=4,<5", markers = "python_version < \"3.10\""}
+typing-extensions = {version = ">=4.12,<5.0", markers = "python_version >= \"3.8\" and python_version < \"3.10\""}
 
 [[package]]
 name = "h11"
@@ -4774,4 +4774,4 @@ sanic = ["sanic"]
 [metadata]
 lock-version = "2.0"
 python-versions = "^3.9"
-content-hash = "6ccb728661c37d68d045aaae1651fd3f55b6905aa7d9d81711b70da488f7d05f"
+content-hash = "6b3a16c7185b6c7290b727311f16f6ec254c810e39e7db656958f0967ae6dcc0"
diff --git a/pyproject.toml b/pyproject.toml
index 1a177b222f..6ef14b67fc 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -35,7 +35,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry.dependencies]
 python = "^3.9"
-graphql-core = ">=3.2.0,<3.4.0"
+graphql-core = ">=3.2.0"
 typing-extensions = ">=4.5.0"
 python-dateutil = "^2.7.0"
 starlette = {version = ">=0.18.0", optional = true}
@@ -102,6 +102,7 @@ types-deprecated = "^1.2.15.20241117"
 types-six = "^1.17.0.20241205"
 types-pyyaml = "^6.0.12.20240917"
 mypy = "^1.13.0"
+graphql-core = "3.3.0a6"
 
 [tool.poetry.group.integrations]
 optional = true
diff --git a/strawberry/http/async_base_view.py b/strawberry/http/async_base_view.py
index b73eb55181..30fca81383 100644
--- a/strawberry/http/async_base_view.py
+++ b/strawberry/http/async_base_view.py
@@ -17,6 +17,18 @@
 
 from graphql import GraphQLError
 
+# TODO: only import this if exists
+from graphql.execution.execute import (
+    ExperimentalIncrementalExecutionResults,
+    InitialIncrementalExecutionResult,
+)
+from graphql.execution.incremental_publisher import (
+    IncrementalDeferResult,
+    IncrementalResult,
+    IncrementalStreamResult,
+    SubsequentIncrementalExecutionResult,
+)
+
 from strawberry.exceptions import MissingQueryError
 from strawberry.file_uploads.utils import replace_placeholders_with_files
 from strawberry.http import (
@@ -337,6 +349,29 @@ async def run(
         except MissingQueryError as e:
             raise HTTPException(400, "No GraphQL query found in the request") from e
 
+        if isinstance(result, ExperimentalIncrementalExecutionResults):
+
+            async def stream():
+                yield "---"
+                response = await self.process_result(request, result.initial_result)
+                yield self.encode_multipart_data(response, "-")
+
+                async for value in result.subsequent_results:
+                    response = await self.process_subsequent_result(request, value)
+                    yield self.encode_multipart_data(response, "-")
+
+                yield "--\r\n"
+
+            return await self.create_streaming_response(
+                request,
+                stream,
+                sub_response,
+                headers={
+                    "Transfer-Encoding": "chunked",
+                    "Content-Type": 'multipart/mixed; boundary="-"',
+                },
+            )
+
         if isinstance(result, SubscriptionExecutionResult):
             stream = self._get_stream(request, result)
 
@@ -360,12 +395,15 @@ async def run(
         )
 
     def encode_multipart_data(self, data: Any, separator: str) -> str:
+        encoded_data = self.encode_json(data)
+
         return "".join(
             [
-                f"\r\n--{separator}\r\n",
-                "Content-Type: application/json\r\n\r\n",
-                self.encode_json(data),
-                "\n",
+                "\r\n",
+                "Content-Type: application/json; charset=utf-8\r\n",
+                "\r\n",
+                encoded_data,
+                f"\r\n--{separator}",
             ]
         )
 
@@ -475,9 +513,62 @@ async def parse_http_body(
             protocol=protocol,
         )
 
+    def process_incremental_result(
+        self, request: Request, result: IncrementalResult
+    ) -> GraphQLHTTPResponse:
+        if isinstance(result, IncrementalDeferResult):
+            return {
+                "data": result.data,
+                "errors": result.errors,
+                "path": result.path,
+                "label": result.label,
+                "extensions": result.extensions,
+            }
+        if isinstance(result, IncrementalStreamResult):
+            return {
+                "items": result.items,
+                "errors": result.errors,
+                "path": result.path,
+                "label": result.label,
+                "extensions": result.extensions,
+            }
+
+        raise ValueError(f"Unsupported incremental result type: {type(result)}")
+
+    async def process_subsequent_result(
+        self,
+        request: Request,
+        result: SubsequentIncrementalExecutionResult,
+        # TODO: use proper return type
+    ) -> GraphQLHTTPResponse:
+        data = {
+            "incremental": [
+                await self.process_result(request, value)
+                for value in result.incremental
+            ],
+            "hasNext": result.has_next,
+            "extensions": result.extensions,
+        }
+
+        return data
+
     async def process_result(
-        self, request: Request, result: ExecutionResult
+        self,
+        request: Request,
+        result: Union[ExecutionResult, InitialIncrementalExecutionResult],
     ) -> GraphQLHTTPResponse:
+        if isinstance(result, InitialIncrementalExecutionResult):
+            return {
+                "data": result.data,
+                "incremental": [
+                    self.process_incremental_result(request, value)
+                    for value in result.incremental
+                ]
+                if result.incremental
+                else [],
+                "hasNext": result.has_next,
+                "extensions": result.extensions,
+            }
         return process_result(result)
 
     async def on_ws_connect(
diff --git a/strawberry/schema/execute.py b/strawberry/schema/execute.py
index b0e1ebf45d..ac0eca1046 100644
--- a/strawberry/schema/execute.py
+++ b/strawberry/schema/execute.py
@@ -14,7 +14,7 @@
 
 from graphql import ExecutionResult as GraphQLExecutionResult
 from graphql import GraphQLError, parse
-from graphql import execute as original_execute
+from graphql.execution import experimental_execute_incrementally
 from graphql.validation import validate
 
 from strawberry.exceptions import MissingQueryError
@@ -121,16 +121,17 @@ async def _handle_execution_result(
     extensions_runner: SchemaExtensionsRunner,
     process_errors: ProcessErrors | None,
 ) -> ExecutionResult:
-    # Set errors on the context so that it's easier
-    # to access in extensions
-    if result.errors:
-        context.errors = result.errors
-        if process_errors:
-            process_errors(result.errors, context)
-    if isinstance(result, GraphQLExecutionResult):
-        result = ExecutionResult(data=result.data, errors=result.errors)
-    result.extensions = await extensions_runner.get_extensions_results(context)
-    context.result = result  # type: ignore  # mypy failed to deduce correct type.
+    # TODO: deal with this later
+    # # Set errors on the context so that it's easier
+    # # to access in extensions
+    # if result.errors:
+    #     context.errors = result.errors
+    #     if process_errors:
+    #         process_errors(result.errors, context)
+    # if isinstance(result, GraphQLExecutionResult):
+    #     result = ExecutionResult(data=result.data, errors=result.errors)
+    # result.extensions = await extensions_runner.get_extensions_results(context)
+    # context.result = result  # type: ignore  # mypy failed to deduce correct type.
     return result
 
 
@@ -164,7 +165,7 @@ async def execute(
             async with extensions_runner.executing():
                 if not execution_context.result:
                     result = await await_maybe(
-                        original_execute(
+                        experimental_execute_incrementally(
                             schema,
                             execution_context.graphql_document,
                             root_value=execution_context.root_value,
@@ -178,16 +179,18 @@ async def execute(
                     execution_context.result = result
                 else:
                     result = execution_context.result
-                # Also set errors on the execution_context so that it's easier
-                # to access in extensions
-                if result.errors:
-                    execution_context.errors = result.errors
-
-                    # Run the `Schema.process_errors` function here before
-                    # extensions have a chance to modify them (see the MaskErrors
-                    # extension). That way we can log the original errors but
-                    # only return a sanitised version to the client.
-                    process_errors(result.errors, execution_context)
+                # TODO: deal with this later
+                # # Also set errors on the execution_context so that it's easier
+                # # to access in extensions
+                # breakpoint()
+                # if result.errors:
+                #     execution_context.errors = result.errors
+
+                #     # Run the `Schema.process_errors` function here before
+                #     # extensions have a chance to modify them (see the MaskErrors
+                #     # extension). That way we can log the original errors but
+                #     # only return a sanitised version to the client.
+                #     process_errors(result.errors, execution_context)
 
     except (MissingQueryError, InvalidOperationTypeError):
         raise
@@ -252,7 +255,7 @@ def execute_sync(
 
             with extensions_runner.executing():
                 if not execution_context.result:
-                    result = original_execute(
+                    result = experimental_execute_incrementally(
                         schema,
                         execution_context.graphql_document,
                         root_value=execution_context.root_value,
diff --git a/strawberry/schema/schema.py b/strawberry/schema/schema.py
index a7de78c95a..6ee9a1b21c 100644
--- a/strawberry/schema/schema.py
+++ b/strawberry/schema/schema.py
@@ -20,7 +20,11 @@
     validate_schema,
 )
 from graphql.execution.middleware import MiddlewareManager
-from graphql.type.directives import specified_directives
+from graphql.type.directives import (
+    GraphQLDeferDirective,
+    GraphQLStreamDirective,
+    specified_directives,
+)
 
 from strawberry import relay
 from strawberry.annotation import StrawberryAnnotation
@@ -194,7 +198,11 @@ class Query:
                 query=query_type,
                 mutation=mutation_type,
                 subscription=subscription_type if subscription else None,
-                directives=specified_directives + tuple(graphql_directives),
+                directives=(
+                    specified_directives
+                    + tuple(graphql_directives)
+                    + (GraphQLDeferDirective, GraphQLStreamDirective)
+                ),
                 types=graphql_types,
                 extensions={
                     GraphQLCoreConverter.DEFINITION_BACKREF: self,
diff --git a/strawberry/static/graphiql.html b/strawberry/static/graphiql.html
index b66082a97f..9892cf9a36 100644
--- a/strawberry/static/graphiql.html
+++ b/strawberry/static/graphiql.html
@@ -61,8 +61,7 @@
     <link
       crossorigin
       rel="stylesheet"
-      href="https://unpkg.com/graphiql@3.0.9/graphiql.min.css"
-      integrity="sha384-yz3/sqpuplkA7msMo0FE4ekg0xdwdvZ8JX9MVZREsxipqjU4h8IRfmAMRcb1QpUy"
+      href="https://unpkg.com/graphiql@3.8.3/graphiql.min.css"
     />
 
     <link
@@ -77,13 +76,11 @@
     <div id="graphiql" class="graphiql-container">Loading...</div>
     <script
       crossorigin
-      src="https://unpkg.com/graphiql@3.0.9/graphiql.min.js"
-      integrity="sha384-Mjte+vxCWz1ZYCzszGHiJqJa5eAxiqI4mc3BErq7eDXnt+UGLXSEW7+i0wmfPiji"
+      src="https://unpkg.com/graphiql@3.8.3/graphiql.min.js"
     ></script>
     <script
       crossorigin
       src="https://unpkg.com/@graphiql/plugin-explorer@1.0.2/dist/index.umd.js"
-      integrity="sha384-2oonKe47vfHIZnmB6ZZ10vl7T0Y+qrHQF2cmNTaFDuPshpKqpUMGMc9jgj9MLDZ9"
     ></script>
     <script>
       const EXAMPLE_QUERY = `# Welcome to GraphiQL 🍓
diff --git a/tests/http/incremental/__init__.py b/tests/http/incremental/__init__.py
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/tests/http/incremental/conftest.py b/tests/http/incremental/conftest.py
new file mode 100644
index 0000000000..fdcdaf0f29
--- /dev/null
+++ b/tests/http/incremental/conftest.py
@@ -0,0 +1,44 @@
+import contextlib
+
+import pytest
+
+from tests.http.clients.base import HttpClient
+
+
+@pytest.fixture
+def http_client(http_client_class: type[HttpClient]) -> HttpClient:
+    with contextlib.suppress(ImportError):
+        import django
+
+        if django.VERSION < (4, 2):
+            pytest.skip(reason="Django < 4.2 doesn't async streaming responses")
+
+        from tests.http.clients.django import DjangoHttpClient
+
+        if http_client_class is DjangoHttpClient:
+            pytest.skip(reason="(sync) DjangoHttpClient doesn't support streaming")
+
+    with contextlib.suppress(ImportError):
+        from tests.http.clients.channels import SyncChannelsHttpClient
+
+        # TODO: why do we have a sync channels client?
+        if http_client_class is SyncChannelsHttpClient:
+            pytest.skip(reason="SyncChannelsHttpClient doesn't support streaming")
+
+    with contextlib.suppress(ImportError):
+        from tests.http.clients.async_flask import AsyncFlaskHttpClient
+        from tests.http.clients.flask import FlaskHttpClient
+
+        if http_client_class is FlaskHttpClient:
+            pytest.skip(reason="FlaskHttpClient doesn't support streaming")
+
+        if http_client_class is AsyncFlaskHttpClient:
+            pytest.xfail(reason="AsyncFlaskHttpClient doesn't support streaming")
+
+    with contextlib.suppress(ImportError):
+        from tests.http.clients.chalice import ChaliceHttpClient
+
+        if http_client_class is ChaliceHttpClient:
+            pytest.skip(reason="ChaliceHttpClient doesn't support streaming")
+
+    return http_client_class()
diff --git a/tests/http/incremental/test_defer.py b/tests/http/incremental/test_defer.py
new file mode 100644
index 0000000000..f21a4e30f8
--- /dev/null
+++ b/tests/http/incremental/test_defer.py
@@ -0,0 +1,38 @@
+import contextlib
+from typing_extensions import Literal
+
+import pytest
+
+from tests.http.clients.base import HttpClient
+
+
+@pytest.mark.parametrize("method", ["get", "post"])
+async def test_basic_defer(method: Literal["get", "post"], http_client: HttpClient):
+    response = await http_client.query(
+        method=method,
+        query="""{
+            hello
+
+            ... @defer {
+                asyncHello
+            }
+        }""",
+    )
+
+    async with contextlib.aclosing(response.streaming_json()) as stream:
+        initial = await stream.__anext__()
+
+        assert initial == {
+            "data": {"hello": "Hello world"},
+            "incremental": [],
+            "hasNext": True,
+            "extensions": None,
+        }
+
+        subsequent = await stream.__anext__()
+
+        assert subsequent == {
+            "incremental": [{"data": {"asyncHello": "Hello world"}}],
+            "hasNext": False,
+            "extensions": None,
+        }
diff --git a/tests/http/incremental/test_multipart_subscription.py b/tests/http/incremental/test_multipart_subscription.py
new file mode 100644
index 0000000000..3a271e8bbf
--- /dev/null
+++ b/tests/http/incremental/test_multipart_subscription.py
@@ -0,0 +1,62 @@
+from typing_extensions import Literal
+
+import pytest
+
+from strawberry.http.base import BaseView
+from tests.http.clients.base import HttpClient
+
+
+@pytest.mark.parametrize("method", ["get", "post"])
+async def test_multipart_subscription(
+    http_client: HttpClient, method: Literal["get", "post"]
+):
+    response = await http_client.query(
+        method=method,
+        query='subscription { echo(message: "Hello world", delay: 0.2) }',
+        headers={
+            "accept": "multipart/mixed;boundary=graphql;subscriptionSpec=1.0,application/json",
+            "content-type": "application/json",
+        },
+    )
+
+    data = [d async for d in response.streaming_json()]
+
+    assert data == [
+        {
+            "payload": {
+                "data": {"echo": "Hello world"},
+                "extensions": {"example": "example"},
+            }
+        }
+    ]
+
+    assert response.status_code == 200
+
+
+async def test_multipart_subscription_use_the_views_decode_json_method(
+    http_client: HttpClient, mocker
+):
+    spy = mocker.spy(BaseView, "decode_json")
+
+    response = await http_client.query(
+        query='subscription { echo(message: "Hello world", delay: 0.2) }',
+        headers={
+            "accept": "multipart/mixed;boundary=graphql;subscriptionSpec=1.0,application/json",
+            "content-type": "application/json",
+        },
+    )
+
+    data = [d async for d in response.streaming_json()]
+
+    assert data == [
+        {
+            "payload": {
+                "data": {"echo": "Hello world"},
+                "extensions": {"example": "example"},
+            }
+        }
+    ]
+
+    assert response.status_code == 200
+
+    assert spy.call_count == 1
diff --git a/tests/http/test_multipart_subscription.py b/tests/http/test_multipart_subscription.py
deleted file mode 100644
index bb964c2898..0000000000
--- a/tests/http/test_multipart_subscription.py
+++ /dev/null
@@ -1,113 +0,0 @@
-import contextlib
-from typing_extensions import Literal
-
-import pytest
-
-from strawberry.http.base import BaseView
-
-from .clients.base import HttpClient
-
-
-@pytest.fixture
-def http_client(http_client_class: type[HttpClient]) -> HttpClient:
-    with contextlib.suppress(ImportError):
-        import django
-
-        if django.VERSION < (4, 2):
-            pytest.skip(reason="Django < 4.2 doesn't async streaming responses")
-
-        from .clients.django import DjangoHttpClient
-
-        if http_client_class is DjangoHttpClient:
-            pytest.skip(
-                reason="(sync) DjangoHttpClient doesn't support multipart subscriptions"
-            )
-
-    with contextlib.suppress(ImportError):
-        from .clients.channels import SyncChannelsHttpClient
-
-        # TODO: why do we have a sync channels client?
-        if http_client_class is SyncChannelsHttpClient:
-            pytest.skip(
-                reason="SyncChannelsHttpClient doesn't support multipart subscriptions"
-            )
-
-    with contextlib.suppress(ImportError):
-        from .clients.async_flask import AsyncFlaskHttpClient
-        from .clients.flask import FlaskHttpClient
-
-        if http_client_class is FlaskHttpClient:
-            pytest.skip(
-                reason="FlaskHttpClient doesn't support multipart subscriptions"
-            )
-
-        if http_client_class is AsyncFlaskHttpClient:
-            pytest.xfail(
-                reason="AsyncFlaskHttpClient doesn't support multipart subscriptions"
-            )
-
-    with contextlib.suppress(ImportError):
-        from .clients.chalice import ChaliceHttpClient
-
-        if http_client_class is ChaliceHttpClient:
-            pytest.skip(
-                reason="ChaliceHttpClient doesn't support multipart subscriptions"
-            )
-
-    return http_client_class()
-
-
-@pytest.mark.parametrize("method", ["get", "post"])
-async def test_multipart_subscription(
-    http_client: HttpClient, method: Literal["get", "post"]
-):
-    response = await http_client.query(
-        method=method,
-        query='subscription { echo(message: "Hello world", delay: 0.2) }',
-        headers={
-            "accept": "multipart/mixed;boundary=graphql;subscriptionSpec=1.0,application/json",
-            "content-type": "application/json",
-        },
-    )
-
-    data = [d async for d in response.streaming_json()]
-
-    assert data == [
-        {
-            "payload": {
-                "data": {"echo": "Hello world"},
-                "extensions": {"example": "example"},
-            }
-        }
-    ]
-
-    assert response.status_code == 200
-
-
-async def test_multipart_subscription_use_the_views_decode_json_method(
-    http_client: HttpClient, mocker
-):
-    spy = mocker.spy(BaseView, "decode_json")
-
-    response = await http_client.query(
-        query='subscription { echo(message: "Hello world", delay: 0.2) }',
-        headers={
-            "accept": "multipart/mixed;boundary=graphql;subscriptionSpec=1.0,application/json",
-            "content-type": "application/json",
-        },
-    )
-
-    data = [d async for d in response.streaming_json()]
-
-    assert data == [
-        {
-            "payload": {
-                "data": {"echo": "Hello world"},
-                "extensions": {"example": "example"},
-            }
-        }
-    ]
-
-    assert response.status_code == 200
-
-    assert spy.call_count == 1