strawberry-graphql 0.247.1__tar.gz → 0.248.0__tar.gz

{strawberry_graphql-0.247.1 → strawberry_graphql-0.248.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: strawberry-graphql
-Version: 0.247.1
+Version: 0.248.0
 Summary: A library for creating GraphQL APIs
 Home-page: https://strawberry.rocks/
 License: MIT

{strawberry_graphql-0.247.1 → strawberry_graphql-0.248.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "strawberry-graphql"
 packages = [ { include = "strawberry" } ]
-version = "0.247.1"
+version = "0.248.0"
 description = "A library for creating GraphQL APIs"
 authors = ["Patrick Arminio <patrick.arminio@gmail.com>"]
 license = "MIT"

{strawberry_graphql-0.247.1 → strawberry_graphql-0.248.0}/strawberry/channels/testing.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-import dataclasses
 import uuid
 from typing import (
     TYPE_CHECKING,
@@ -26,10 +25,14 @@ from strawberry.subscriptions.protocols.graphql_transport_ws.types import (
     SubscribeMessage,
     SubscribeMessagePayload,
 )
-from strawberry.subscriptions.protocols.graphql_ws import (
-    GQL_CONNECTION_ACK,
-    GQL_CONNECTION_INIT,
-    GQL_START,
+from strawberry.subscriptions.protocols.graphql_ws.types import (
+    ConnectionAckMessage as GraphQLWSConnectionAckMessage,
+)
+from strawberry.subscriptions.protocols.graphql_ws.types import (
+    ConnectionInitMessage as GraphQLWSConnectionInitMessage,
+)
+from strawberry.subscriptions.protocols.graphql_ws.types import (
+    StartMessage as GraphQLWSStartMessage,
 )
 from strawberry.types import ExecutionResult
 
@@ -112,9 +115,11 @@ class GraphQLWebsocketCommunicator(WebsocketCommunicator):
             assert response == ConnectionAckMessage().as_dict()
         else:
             assert res == (True, GRAPHQL_WS_PROTOCOL)
-            await self.send_json_to({"type": GQL_CONNECTION_INIT})
-            response = await self.receive_json_from()
-            assert response["type"] == GQL_CONNECTION_ACK
+            await self.send_json_to(
+                GraphQLWSConnectionInitMessage({"type": "connection_init"})
+            )
+            response: GraphQLWSConnectionAckMessage = await self.receive_json_from()
+            assert response["type"] == "connection_ack"
 
     # Actual `ExecutionResult`` objects are not available client-side, since they
     # get transformed into `FormattedExecutionResult` on the wire, but we attempt
@@ -123,22 +128,28 @@ class GraphQLWebsocketCommunicator(WebsocketCommunicator):
         self, query: str, variables: Optional[Dict] = None
     ) -> Union[ExecutionResult, AsyncIterator[ExecutionResult]]:
         id_ = uuid.uuid4().hex
-        sub_payload = SubscribeMessagePayload(query=query, variables=variables)
+
         if self.protocol == GRAPHQL_TRANSPORT_WS_PROTOCOL:
             await self.send_json_to(
                 SubscribeMessage(
                     id=id_,
-                    payload=sub_payload,
+                    payload=SubscribeMessagePayload(query=query, variables=variables),
                 ).as_dict()
             )
         else:
-            await self.send_json_to(
-                {
-                    "type": GQL_START,
-                    "id": id_,
-                    "payload": dataclasses.asdict(sub_payload),
-                }
-            )
+            start_message: GraphQLWSStartMessage = {
+                "type": "start",
+                "id": id_,
+                "payload": {
+                    "query": query,
+                },
+            }
+
+            if variables is not None:
+                start_message["payload"]["variables"] = variables
+
+            await self.send_json_to(start_message)
+
         while True:
             response = await self.receive_json_from(timeout=5)
             message_type = response["type"]

{strawberry_graphql-0.247.1 → strawberry_graphql-0.248.0}/strawberry/subscriptions/protocols/graphql_transport_ws/handlers.py

@@ -245,41 +245,42 @@ class BaseGraphQLTransportWSHandler:
         elif hasattr(self.context, "connection_params"):
             self.context.connection_params = self.connection_params
 
+        operation = Operation(
+            self,
+            message.id,
+            operation_type,
+            message.payload.query,
+            message.payload.variables,
+            message.payload.operationName,
+        )
+
+        operation.task = asyncio.create_task(self.run_operation(operation))
+        self.operations[message.id] = operation
+
+    async def run_operation(self, operation: Operation) -> None:
+        """The operation task's top level method. Cleans-up and de-registers the operation once it is done."""
+        # TODO: Handle errors in this method using self.handle_task_exception()
+
         result_source: Awaitable[ExecutionResult] | Awaitable[SubscriptionResult]
 
         # Get an AsyncGenerator yielding the results
-        if operation_type == OperationType.SUBSCRIPTION:
+        if operation.operation_type == OperationType.SUBSCRIPTION:
             result_source = self.schema.subscribe(
-                query=message.payload.query,
-                variable_values=message.payload.variables,
-                operation_name=message.payload.operationName,
+                query=operation.query,
+                variable_values=operation.variables,
+                operation_name=operation.operation_name,
                 context_value=self.context,
                 root_value=self.root_value,
             )
         else:
             result_source = self.schema.execute(
-                query=message.payload.query,
-                variable_values=message.payload.variables,
+                query=operation.query,
+                variable_values=operation.variables,
                 context_value=self.context,
                 root_value=self.root_value,
-                operation_name=message.payload.operationName,
+                operation_name=operation.operation_name,
             )
 
-        operation = Operation(self, message.id, operation_type)
-
-        # Create task to handle this subscription, reserve the operation ID
-        operation.task = asyncio.create_task(
-            self.operation_task(result_source, operation)
-        )
-        self.operations[message.id] = operation
-
-    async def operation_task(
-        self,
-        result_source: Awaitable[ExecutionResult] | Awaitable[SubscriptionResult],
-        operation: Operation,
-    ) -> None:
-        """The operation task's top level method. Cleans-up and de-registers the operation once it is done."""
-        # TODO: Handle errors in this method using self.handle_task_exception()
         try:
             first_res_or_agen = await result_source
             # that's an immediate error we should end the operation
@@ -340,17 +341,32 @@ class BaseGraphQLTransportWSHandler:
 class Operation:
     """A class encapsulating a single operation with its id. Helps enforce protocol state transition."""
 
-    __slots__ = ["handler", "id", "operation_type", "completed", "task"]
+    __slots__ = [
+        "handler",
+        "id",
+        "operation_type",
+        "query",
+        "variables",
+        "operation_name",
+        "completed",
+        "task",
+    ]
 
     def __init__(
         self,
         handler: BaseGraphQLTransportWSHandler,
         id: str,
         operation_type: OperationType,
+        query: str,
+        variables: Optional[Dict[str, Any]],
+        operation_name: Optional[str],
     ) -> None:
         self.handler = handler
         self.id = id
         self.operation_type = operation_type
+        self.query = query
+        self.variables = variables
+        self.operation_name = operation_name
         self.completed = False
         self.task: Optional[asyncio.Task] = None
 

{strawberry_graphql-0.247.1 → strawberry_graphql-0.248.0}/strawberry/subscriptions/protocols/graphql_ws/handlers.py

@@ -5,31 +5,24 @@ from contextlib import suppress
 from typing import (
     TYPE_CHECKING,
     AsyncGenerator,
-    Awaitable,
     Dict,
     Optional,
     cast,
 )
 
 from strawberry.http.exceptions import NonTextMessageReceived, WebSocketDisconnected
-from strawberry.subscriptions.protocols.graphql_ws import (
-    GQL_COMPLETE,
-    GQL_CONNECTION_ACK,
-    GQL_CONNECTION_ERROR,
-    GQL_CONNECTION_INIT,
-    GQL_CONNECTION_KEEP_ALIVE,
-    GQL_CONNECTION_TERMINATE,
-    GQL_DATA,
-    GQL_ERROR,
-    GQL_START,
-    GQL_STOP,
-)
 from strawberry.subscriptions.protocols.graphql_ws.types import (
-    ConnectionInitPayload,
-    DataPayload,
+    CompleteMessage,
+    ConnectionAckMessage,
+    ConnectionErrorMessage,
+    ConnectionInitMessage,
+    ConnectionKeepAliveMessage,
+    ConnectionTerminateMessage,
+    DataMessage,
+    ErrorMessage,
     OperationMessage,
-    OperationMessagePayload,
-    StartPayload,
+    StartMessage,
+    StopMessage,
 )
 from strawberry.types.execution import ExecutionResult, PreExecutionError
 from strawberry.utils.debug import pretty_print_graphql_operation
@@ -37,7 +30,6 @@ from strawberry.utils.debug import pretty_print_graphql_operation
 if TYPE_CHECKING:
     from strawberry.http.async_base_view import AsyncWebSocketAdapter
     from strawberry.schema import BaseSchema
-    from strawberry.schema.subscribe import SubscriptionResult
 
 
 class BaseGraphQLWSHandler:
@@ -61,7 +53,7 @@ class BaseGraphQLWSHandler:
         self.keep_alive_task: Optional[asyncio.Task] = None
         self.subscriptions: Dict[str, AsyncGenerator] = {}
         self.tasks: Dict[str, asyncio.Task] = {}
-        self.connection_params: Optional[ConnectionInitPayload] = None
+        self.connection_params: Optional[Dict[str, object]] = None
 
     async def handle(self) -> None:
         try:
@@ -89,41 +81,40 @@ class BaseGraphQLWSHandler:
         self,
         message: OperationMessage,
     ) -> None:
-        message_type = message["type"]
-
-        if message_type == GQL_CONNECTION_INIT:
+        if message["type"] == "connection_init":
             await self.handle_connection_init(message)
-        elif message_type == GQL_CONNECTION_TERMINATE:
+        elif message["type"] == "connection_terminate":
             await self.handle_connection_terminate(message)
-        elif message_type == GQL_START:
+        elif message["type"] == "start":
             await self.handle_start(message)
-        elif message_type == GQL_STOP:
+        elif message["type"] == "stop":
             await self.handle_stop(message)
 
-    async def handle_connection_init(self, message: OperationMessage) -> None:
+    async def handle_connection_init(self, message: ConnectionInitMessage) -> None:
         payload = message.get("payload")
         if payload is not None and not isinstance(payload, dict):
-            error_message: OperationMessage = {"type": GQL_CONNECTION_ERROR}
+            error_message: ConnectionErrorMessage = {"type": "connection_error"}
             await self.websocket.send_json(error_message)
             await self.websocket.close(code=1000, reason="")
             return
 
-        payload = cast(Optional["ConnectionInitPayload"], payload)
         self.connection_params = payload
 
-        acknowledge_message: OperationMessage = {"type": GQL_CONNECTION_ACK}
-        await self.websocket.send_json(acknowledge_message)
+        connection_ack_message: ConnectionAckMessage = {"type": "connection_ack"}
+        await self.websocket.send_json(connection_ack_message)
 
         if self.keep_alive:
             keep_alive_handler = self.handle_keep_alive()
             self.keep_alive_task = asyncio.create_task(keep_alive_handler)
 
-    async def handle_connection_terminate(self, message: OperationMessage) -> None:
+    async def handle_connection_terminate(
+        self, message: ConnectionTerminateMessage
+    ) -> None:
         await self.websocket.close(code=1000, reason="")
 
-    async def handle_start(self, message: OperationMessage) -> None:
+    async def handle_start(self, message: StartMessage) -> None:
         operation_id = message["id"]
-        payload = cast("StartPayload", message["payload"])
+        payload = message["payload"]
         query = payload["query"]
         operation_name = payload.get("operationName")
         variables = payload.get("variables")
@@ -136,46 +127,58 @@ class BaseGraphQLWSHandler:
         if self.debug:
             pretty_print_graphql_operation(operation_name, query, variables)
 
-        result_source = self.schema.subscribe(
-            query=query,
-            variable_values=variables,
-            operation_name=operation_name,
-            context_value=self.context,
-            root_value=self.root_value,
+        result_handler = self.handle_async_results(
+            operation_id, query, operation_name, variables
         )
-
-        result_handler = self.handle_async_results(result_source, operation_id)
         self.tasks[operation_id] = asyncio.create_task(result_handler)
 
-    async def handle_stop(self, message: OperationMessage) -> None:
+    async def handle_stop(self, message: StopMessage) -> None:
         operation_id = message["id"]
         await self.cleanup_operation(operation_id)
 
     async def handle_keep_alive(self) -> None:
         assert self.keep_alive_interval
         while True:
-            data: OperationMessage = {"type": GQL_CONNECTION_KEEP_ALIVE}
+            data: ConnectionKeepAliveMessage = {"type": "ka"}
             await self.websocket.send_json(data)
             await asyncio.sleep(self.keep_alive_interval)
 
     async def handle_async_results(
         self,
-        result_source: Awaitable[SubscriptionResult],
         operation_id: str,
+        query: str,
+        operation_name: Optional[str],
+        variables: Optional[Dict[str, object]],
     ) -> None:
         try:
-            agen_or_err = await result_source
+            agen_or_err = await self.schema.subscribe(
+                query=query,
+                variable_values=variables,
+                operation_name=operation_name,
+                context_value=self.context,
+                root_value=self.root_value,
+            )
             if isinstance(agen_or_err, PreExecutionError):
                 assert agen_or_err.errors
                 error_payload = agen_or_err.errors[0].formatted
-                await self.send_message(GQL_ERROR, operation_id, error_payload)
+                error_message: ErrorMessage = {
+                    "type": "error",
+                    "id": operation_id,
+                    "payload": error_payload,
+                }
+                await self.websocket.send_json(error_message)
             else:
                 self.subscriptions[operation_id] = agen_or_err
                 async for result in agen_or_err:
                     await self.send_data(result, operation_id)
-                await self.send_message(GQL_COMPLETE, operation_id, None)
+                complete_message: CompleteMessage = {
+                    "type": "complete",
+                    "id": operation_id,
+                }
+                await self.websocket.send_json(complete_message)
         except asyncio.CancelledError:
-            await self.send_message(GQL_COMPLETE, operation_id, None)
+            complete_message: CompleteMessage = {"type": "complete", "id": operation_id}
+            await self.websocket.send_json(complete_message)
 
     async def cleanup_operation(self, operation_id: str) -> None:
         if operation_id in self.subscriptions:
@@ -188,26 +191,24 @@ class BaseGraphQLWSHandler:
             await self.tasks[operation_id]
         del self.tasks[operation_id]
 
-    async def send_message(
-        self,
-        type_: str,
-        operation_id: str,
-        payload: Optional[OperationMessagePayload] = None,
-    ) -> None:
-        data: OperationMessage = {"type": type_, "id": operation_id}
-        if payload is not None:
-            data["payload"] = payload
-        await self.websocket.send_json(data)
-
     async def send_data(
         self, execution_result: ExecutionResult, operation_id: str
     ) -> None:
-        payload: DataPayload = {"data": execution_result.data}
+        data_message: DataMessage = {
+            "type": "data",
+            "id": operation_id,
+            "payload": {"data": execution_result.data},
+        }
+
         if execution_result.errors:
-            payload["errors"] = [err.formatted for err in execution_result.errors]
+            data_message["payload"]["errors"] = [
+                err.formatted for err in execution_result.errors
+            ]
+
         if execution_result.extensions:
-            payload["extensions"] = execution_result.extensions
-        await self.send_message(GQL_DATA, operation_id, payload)
+            data_message["payload"]["extensions"] = execution_result.extensions
+
+        await self.websocket.send_json(data_message)
 
 
 __all__ = ["BaseGraphQLWSHandler"]

strawberry_graphql-0.248.0/strawberry/subscriptions/protocols/graphql_ws/types.py

@@ -0,0 +1,96 @@
+from typing import Dict, List, TypedDict, Union
+from typing_extensions import Literal, NotRequired
+
+from graphql import GraphQLFormattedError
+
+
+class ConnectionInitMessage(TypedDict):
+    type: Literal["connection_init"]
+    payload: NotRequired[Dict[str, object]]
+
+
+class StartMessagePayload(TypedDict):
+    query: str
+    variables: NotRequired[Dict[str, object]]
+    operationName: NotRequired[str]
+
+
+class StartMessage(TypedDict):
+    type: Literal["start"]
+    id: str
+    payload: StartMessagePayload
+
+
+class StopMessage(TypedDict):
+    type: Literal["stop"]
+    id: str
+
+
+class ConnectionTerminateMessage(TypedDict):
+    type: Literal["connection_terminate"]
+
+
+class ConnectionErrorMessage(TypedDict):
+    type: Literal["connection_error"]
+    payload: NotRequired[Dict[str, object]]
+
+
+class ConnectionAckMessage(TypedDict):
+    type: Literal["connection_ack"]
+
+
+class DataMessagePayload(TypedDict):
+    data: object
+    errors: NotRequired[List[GraphQLFormattedError]]
+
+    # Non-standard field:
+    extensions: NotRequired[Dict[str, object]]
+
+
+class DataMessage(TypedDict):
+    type: Literal["data"]
+    id: str
+    payload: DataMessagePayload
+
+
+class ErrorMessage(TypedDict):
+    type: Literal["error"]
+    id: str
+    payload: GraphQLFormattedError
+
+
+class CompleteMessage(TypedDict):
+    type: Literal["complete"]
+    id: str
+
+
+class ConnectionKeepAliveMessage(TypedDict):
+    type: Literal["ka"]
+
+
+OperationMessage = Union[
+    ConnectionInitMessage,
+    StartMessage,
+    StopMessage,
+    ConnectionTerminateMessage,
+    ConnectionErrorMessage,
+    ConnectionAckMessage,
+    DataMessage,
+    ErrorMessage,
+    CompleteMessage,
+]
+
+
+__all__ = [
+    "ConnectionInitMessage",
+    "StartMessage",
+    "StopMessage",
+    "ConnectionTerminateMessage",
+    "ConnectionErrorMessage",
+    "ConnectionAckMessage",
+    "DataMessage",
+    "ErrorMessage",
+    "CompleteMessage",
+    "ConnectionKeepAliveMessage",
+    "OperationMessage",
+]

strawberry_graphql-0.247.1/strawberry/subscriptions/protocols/graphql_ws/__init__.py

@@ -1,24 +0,0 @@
-GQL_CONNECTION_INIT = "connection_init"
-GQL_CONNECTION_ACK = "connection_ack"
-GQL_CONNECTION_ERROR = "connection_error"
-GQL_CONNECTION_TERMINATE = "connection_terminate"
-GQL_CONNECTION_KEEP_ALIVE = "ka"
-GQL_START = "start"
-GQL_DATA = "data"
-GQL_ERROR = "error"
-GQL_COMPLETE = "complete"
-GQL_STOP = "stop"
-
-
-__all__ = [
-    "GQL_CONNECTION_INIT",
-    "GQL_CONNECTION_ACK",
-    "GQL_CONNECTION_ERROR",
-    "GQL_CONNECTION_TERMINATE",
-    "GQL_CONNECTION_KEEP_ALIVE",
-    "GQL_START",
-    "GQL_DATA",
-    "GQL_ERROR",
-    "GQL_COMPLETE",
-    "GQL_STOP",
-]

strawberry_graphql-0.247.1/strawberry/subscriptions/protocols/graphql_ws/types.py

@@ -1,52 +0,0 @@
-from typing import Any, Dict, List, Optional, Union
-from typing_extensions import TypedDict
-
-from graphql import GraphQLFormattedError
-
-ConnectionInitPayload = Dict[str, Any]
-
-
-ConnectionErrorPayload = Dict[str, Any]
-
-
-class StartPayload(TypedDict, total=False):
-    query: str
-    variables: Optional[Dict[str, Any]]
-    operationName: Optional[str]
-
-
-class DataPayload(TypedDict, total=False):
-    data: Any
-
-    # Optional list of formatted graphql.GraphQLError objects
-    errors: Optional[List[GraphQLFormattedError]]
-    extensions: Optional[Dict[str, Any]]
-
-
-ErrorPayload = GraphQLFormattedError
-
-
-OperationMessagePayload = Union[
-    ConnectionInitPayload,
-    ConnectionErrorPayload,
-    StartPayload,
-    DataPayload,
-    ErrorPayload,
-]
-
-
-class OperationMessage(TypedDict, total=False):
-    type: str
-    id: str
-    payload: OperationMessagePayload
-
-
-__all__ = [
-    "ConnectionInitPayload",
-    "ConnectionErrorPayload",
-    "StartPayload",
-    "DataPayload",
-    "ErrorPayload",
-    "OperationMessagePayload",
-    "OperationMessage",
-]