Let WS and HTTP use the same JSON encoder

RELEASE.md

@@ -0,0 +1,7 @@
+Release type: minor
+
+Starting with this release, the same JSON encoder is used to encode HTTP
+responses and WebSocket messages.
+
+This enables developers to override the `encode_json` method on their views to
+customize the JSON encoder used by all web protocols.

docs/breaking-changes/0.251.0.md

@@ -0,0 +1,25 @@
+---
+title: 0.251.0 Breaking Changes
+slug: breaking-changes/0.251.0
+---
+
+# v0.251.0 Breaking Changes
+
+We slightly changed the signature of the `encode_json` method used to customize
+the JSON encoder used by our HTTP views.
+
+Originally, the method was only meant to encode HTTP response data. Starting
+with this release, it's also used to encode WebSocket messages.
+
+Previously, the method signature was:
+
+```python
+def encode_json(self, response_data: GraphQLHTTPResponse) -> str: ...
+```
+
+To upgrade your code, change the method signature to the following and make sure
+your method can handle the same inputs as the built-in `json.dumps` method:
+
+```python
+def encode_json(self, data: object) -> str: ...
+```

docs/integrations/aiohttp.md

@@ -50,7 +50,7 @@ methods:
 - `async get_context(self, request: aiohttp.web.Request, response: aiohttp.web.StreamResponse) -> object`
 - `async get_root_value(self, request: aiohttp.web.Request) -> object`
 - `async process_result(self, request: aiohttp.web.Request, result: ExecutionResult) -> GraphQLHTTPResponse`
-- `def encode_json(self, data: GraphQLHTTPResponse) -> str`
+- `def encode_json(self, data: object) -> str`
 - `async def render_graphql_ide(self, request: aiohttp.web.Request) -> aiohttp.web.Response`
 
 ### get_context
@@ -144,12 +144,13 @@ tweaked based on your needs.
 
 ### encode_json
 
-`encode_json` allows to customize the encoding of the JSON response. By default
-we use `json.dumps` but you can override this method to use a different encoder.
+`encode_json` allows to customize the encoding of HTTP and WebSocket JSON
+responses. By default we use `json.dumps` but you can override this method to
+use a different encoder.
 
 ```python
 class MyGraphQLView(GraphQLView):
-    def encode_json(self, data: GraphQLHTTPResponse) -> str:
+    def encode_json(self, data: object) -> str:
         return json.dumps(data, indent=2)
 ```
 

docs/integrations/asgi.md

@@ -49,7 +49,7 @@ We allow to extend the base `GraphQL` app, by overriding the following methods:
 - `async get_context(self, request: Union[Request, WebSocket], response: Optional[Response] = None) -> Any`
 - `async get_root_value(self, request: Request) -> Any`
 - `async process_result(self, request: Request, result: ExecutionResult) -> GraphQLHTTPResponse`
-- `def encode_json(self, response_data: GraphQLHTTPResponse) -> str`
+- `def encode_json(self, response_data: object) -> str`
 - `async def render_graphql_ide(self, request: Request) -> Response`
 
 ### get_context
@@ -169,12 +169,13 @@ tweaked based on your needs.
 
 ### encode_json
 
-`encode_json` allows to customize the encoding of the JSON response. By default
-we use `json.dumps` but you can override this method to use a different encoder.
+`encode_json` allows to customize the encoding of HTTP and WebSocket JSON
+responses. By default we use `json.dumps` but you can override this method to
+use a different encoder.
 
 ```python
 class MyGraphQLView(GraphQL):
-    def encode_json(self, data: GraphQLHTTPResponse) -> str:
+    def encode_json(self, data: object) -> str:
         return json.dumps(data, indent=2)
 ```
 

docs/integrations/chalice.md

@@ -75,7 +75,7 @@ We allow to extend the base `GraphQLView`, by overriding the following methods:
 - `get_context(self, request: Request, response: TemporalResponse) -> Any`
 - `get_root_value(self, request: Request) -> Any`
 - `process_result(self, request: Request, result: ExecutionResult) -> GraphQLHTTPResponse`
-- `encode_json(self, response_data: GraphQLHTTPResponse) -> str`
+- `encode_json(self, response_data: object) -> str`
 - `def render_graphql_ide(self, request: Request) -> Response`
 
 ### get_context
@@ -154,12 +154,13 @@ tweaked based on your needs.
 
 ### encode_json
 
-`encode_json` allows to customize the encoding of the JSON response. By default
-we use `json.dumps` but you can override this method to use a different encoder.
+`encode_json` allows to customize the encoding of HTTP and WebSocket JSON
+responses. By default we use `json.dumps` but you can override this method to
+use a different encoder.
 
 ```python
 class MyGraphQLView(GraphQLView):
-    def encode_json(self, data: GraphQLHTTPResponse) -> str:
+    def encode_json(self, data: object) -> str:
         return json.dumps(data, indent=2)
 ```
 

docs/integrations/django.md

@@ -208,7 +208,7 @@ methods:
 - `async get_context(self, request: HttpRequest) -> Any`
 - `async get_root_value(self, request: HttpRequest) -> Any`
 - `async process_result(self, request: HttpRequest, result: ExecutionResult) -> GraphQLHTTPResponse`
-- `def encode_json(self, data: GraphQLHTTPResponse) -> str`
+- `def encode_json(self, data: object) -> str`
 - `async def render_graphql_ide(self, request: HttpRequest) -> HttpResponse`
 
 ### get_context
@@ -288,12 +288,13 @@ tweaked based on your needs.
 
 ### encode_json
 
-`encode_json` allows to customize the encoding of the JSON response. By default
-we use `json.dumps` but you can override this method to use a different encoder.
+`encode_json` allows to customize the encoding of HTTP and WebSocket JSON
+responses. By default we use `json.dumps` but you can override this method to
+use a different encoder.
 
 ```python
 class MyGraphQLView(AsyncGraphQLView):
-    def encode_json(self, data: GraphQLHTTPResponse) -> str:
+    def encode_json(self, data: object) -> str:
         return json.dumps(data, indent=2)
 ```
 

docs/integrations/fastapi.md

@@ -292,14 +292,14 @@ tweaked based on your needs.
 
 ### encode_json
 
-`encode_json` allows to customize the encoding of the JSON response. By default
-we use `json.dumps` but you can override this method to use a different encoder.
-For example, the `orjson` library from pypi has blazing fast speeds.
+`encode_json` allows to customize the encoding of HTTP and WebSocket JSON
+responses. By default we use `json.dumps` but you can override this method to
+use a different encoder.
 
 ```python
 class MyGraphQLRouter(GraphQLRouter):
-    def encode_json(self, data: GraphQLHTTPResponse) -> bytes:
-        return orjson.dumps(data)
+    def encode_json(self, data: object) -> bytes:
+        return json.dumps(data, indent=2)
 ```
 
 ### render_graphql_ide

docs/integrations/flask.md

@@ -54,7 +54,7 @@ We allow to extend the base `GraphQLView`, by overriding the following methods:
 - `def get_context(self, request: Request, response: Response) -> Any`
 - `def get_root_value(self, request: Request) -> Any`
 - `def process_result(self, result: ExecutionResult) -> GraphQLHTTPResponse`
-- `def encode_json(self, response_data: GraphQLHTTPResponse) -> str`
+- `def encode_json(self, response_data: object) -> str`
 - `def render_graphql_ide(self, request: Request) -> Response`
 
 <Note>
@@ -141,12 +141,13 @@ tweaked based on your needs.
 
 ### encode_json
 
-`encode_json` allows to customize the encoding of the JSON response. By default
-we use `json.dumps` but you can override this method to use a different encoder.
+`encode_json` allows to customize the encoding of HTTP and WebSocket JSON
+responses. By default we use `json.dumps` but you can override this method to
+use a different encoder.
 
 ```python
 class MyGraphQLView(GraphQLView):
-    def encode_json(self, data: GraphQLHTTPResponse) -> str:
+    def encode_json(self, data: object) -> str:
         return json.dumps(data, indent=2)
 ```
 

docs/integrations/quart.md

@@ -46,7 +46,7 @@ We allow to extend the base `GraphQLView`, by overriding the following methods:
 - `async def get_context(self, request: Request, response: Response) -> Any`
 - `async def get_root_value(self, request: Request) -> Any`
 - `async def process_result(self, result: ExecutionResult) -> GraphQLHTTPResponse`
-- `def encode_json(self, response_data: GraphQLHTTPResponse) -> str`
+- `def encode_json(self, response_data: object) -> str`
 - `async def render_graphql_ide(self, request: Request) -> Response`
 
 ### get_context
@@ -125,12 +125,13 @@ tweaked based on your needs.
 
 ### encode_json
 
-`encode_json` allows to customize the encoding of the JSON response. By default
-we use `json.dumps` but you can override this method to use a different encoder.
+`encode_json` allows to customize the encoding of HTTP and WebSocket JSON
+responses. By default we use `json.dumps` but you can override this method to
+use a different encoder.
 
 ```python
 class MyGraphQLView(GraphQLView):
-    def encode_json(self, data: GraphQLHTTPResponse) -> str:
+    def encode_json(self, data: object) -> str:
         return json.dumps(data, indent=2)
 ```
 

docs/integrations/sanic.md

@@ -123,12 +123,13 @@ tweaked based on your needs.
 
 ### encode_json
 
-`encode_json` allows to customize the encoding of the JSON response. By default
-we use `json.dumps` but you can override this method to use a different encoder.
+`encode_json` allows to customize the encoding of HTTP and WebSocket JSON
+responses. By default we use `json.dumps` but you can override this method to
+use a different encoder.
 
 ```python
 class MyGraphQLView(GraphQLView):
-    def encode_json(self, data: GraphQLHTTPResponse) -> str:
+    def encode_json(self, data: object) -> str:
         return json.dumps(data, indent=2)
 ```
 

strawberry/aiohttp/views.py

@@ -87,7 +87,10 @@ def content_type(self) -> Optional[str]:
 
 
 class AioHTTPWebSocketAdapter(AsyncWebSocketAdapter):
-    def __init__(self, request: web.Request, ws: web.WebSocketResponse) -> None:
+    def __init__(
+        self, view: AsyncBaseHTTPView, request: web.Request, ws: web.WebSocketResponse
+    ) -> None:
+        super().__init__(view)
         self.request = request
         self.ws = ws
 
@@ -107,7 +110,7 @@ async def iter_json(
 
     async def send_json(self, message: Mapping[str, object]) -> None:
         try:
-            await self.ws.send_json(message)
+            await self.ws.send_str(self.view.encode_json(message))
         except RuntimeError as exc:
             raise WebSocketDisconnected from exc
 

strawberry/asgi/__init__.py

@@ -87,7 +87,10 @@ async def get_form_data(self) -> FormData:
 
 
 class ASGIWebSocketAdapter(AsyncWebSocketAdapter):
-    def __init__(self, request: WebSocket, response: WebSocket) -> None:
+    def __init__(
+        self, view: AsyncBaseHTTPView, request: WebSocket, response: WebSocket
+    ) -> None:
+        super().__init__(view)
         self.ws = response
 
     async def iter_json(
@@ -107,7 +110,7 @@ async def iter_json(
 
     async def send_json(self, message: Mapping[str, object]) -> None:
         try:
-            await self.ws.send_json(message)
+            await self.ws.send_text(self.view.encode_json(message))
         except WebSocketDisconnect as exc:
             raise WebSocketDisconnected from exc
 

strawberry/channels/handlers/ws_handler.py

@@ -28,7 +28,13 @@
 
 
 class ChannelsWebSocketAdapter(AsyncWebSocketAdapter):
-    def __init__(self, request: GraphQLWSConsumer, response: GraphQLWSConsumer) -> None:
+    def __init__(
+        self,
+        view: AsyncBaseHTTPView,
+        request: GraphQLWSConsumer,
+        response: GraphQLWSConsumer,
+    ) -> None:
+        super().__init__(view)
         self.ws_consumer = response
 
     async def iter_json(
@@ -50,7 +56,7 @@ async def iter_json(
                     raise NonJsonMessageReceived()
 
     async def send_json(self, message: Mapping[str, object]) -> None:
-        serialized_message = json.dumps(message)
+        serialized_message = self.view.encode_json(message)
         await self.ws_consumer.send(serialized_message)
 
     async def close(self, code: int, reason: str) -> None:

strawberry/django/views.py

@@ -201,8 +201,8 @@ async def create_streaming_response(
             },
         )
 
-    def encode_json(self, response_data: GraphQLHTTPResponse) -> str:
-        return json.dumps(response_data, cls=DjangoJSONEncoder)
+    def encode_json(self, data: object) -> str:
+        return json.dumps(data, cls=DjangoJSONEncoder)
 
 
 class GraphQLView(

strawberry/http/async_base_view.py

@@ -80,6 +80,9 @@ async def get_form_data(self) -> FormData: ...
 
 
 class AsyncWebSocketAdapter(abc.ABC):
+    def __init__(self, view: "AsyncBaseHTTPView") -> None:
+        self.view = view
+
     @abc.abstractmethod
     def iter_json(
         self, *, ignore_parsing_errors: bool = False
@@ -113,7 +116,8 @@ class AsyncBaseHTTPView(
     connection_init_wait_timeout: timedelta = timedelta(minutes=1)
     request_adapter_class: Callable[[Request], AsyncHTTPRequestAdapter]
     websocket_adapter_class: Callable[
-        [WebSocketRequest, WebSocketResponse], AsyncWebSocketAdapter
+        ["AsyncBaseHTTPView", WebSocketRequest, WebSocketResponse],
+        AsyncWebSocketAdapter,
     ]
     graphql_transport_ws_handler_class = BaseGraphQLTransportWSHandler
     graphql_ws_handler_class = BaseGraphQLWSHandler
@@ -265,7 +269,7 @@ async def run(
             websocket_response = await self.create_websocket_response(
                 request, websocket_subprotocol
             )
-            websocket = self.websocket_adapter_class(request, websocket_response)
+            websocket = self.websocket_adapter_class(self, request, websocket_response)
 
             context = (
                 await self.get_context(request, response=websocket_response)

strawberry/http/base.py

@@ -2,7 +2,6 @@
 from typing import Any, Dict, Generic, List, Mapping, Optional, Union
 from typing_extensions import Protocol
 
-from strawberry.http import GraphQLHTTPResponse
 from strawberry.http.ides import GraphQL_IDE, get_graphql_ide_html
 from strawberry.http.types import HTTPMethod, QueryParams
 
@@ -44,8 +43,8 @@ def parse_json(self, data: Union[str, bytes]) -> Any:
         except json.JSONDecodeError as e:
             raise HTTPException(400, "Unable to parse request body as JSON") from e
 
-    def encode_json(self, response_data: GraphQLHTTPResponse) -> str:
-        return json.dumps(response_data)
+    def encode_json(self, data: object) -> str:
+        return json.dumps(data)
 
     def parse_query_params(self, params: QueryParams) -> Dict[str, Any]:
         params = dict(params)

strawberry/litestar/controller.py

@@ -194,7 +194,10 @@ async def get_form_data(self) -> FormData:
 
 
 class LitestarWebSocketAdapter(AsyncWebSocketAdapter):
-    def __init__(self, request: WebSocket, response: WebSocket) -> None:
+    def __init__(
+        self, view: AsyncBaseHTTPView, request: WebSocket, response: WebSocket
+    ) -> None:
+        super().__init__(view)
         self.ws = response
 
     async def iter_json(
@@ -218,7 +221,7 @@ async def iter_json(
 
     async def send_json(self, message: Mapping[str, object]) -> None:
         try:
-            await self.ws.send_json(message)
+            await self.ws.send_data(data=self.view.encode_json(message))
         except WebSocketDisconnect as exc:
             raise WebSocketDisconnected from exc