1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
|
from __future__ import annotations
from contextlib import ExitStack
from queue import Queue
from typing import TYPE_CHECKING, Any, Literal, cast
from anyio import sleep
from litestar.exceptions import WebSocketDisconnect
from litestar.serialization import decode_json, decode_msgpack, encode_json, encode_msgpack
from litestar.status_codes import WS_1000_NORMAL_CLOSURE
if TYPE_CHECKING:
from litestar.testing.client.sync_client import TestClient
from litestar.types import (
WebSocketConnectEvent,
WebSocketDisconnectEvent,
WebSocketReceiveMessage,
WebSocketScope,
WebSocketSendMessage,
)
__all__ = ("WebSocketTestSession",)
class WebSocketTestSession:
exit_stack: ExitStack
def __init__(
self,
client: TestClient[Any],
scope: WebSocketScope,
) -> None:
self.client = client
self.scope = scope
self.accepted_subprotocol: str | None = None
self.receive_queue: Queue[WebSocketReceiveMessage] = Queue()
self.send_queue: Queue[WebSocketSendMessage | BaseException] = Queue()
self.extra_headers: list[tuple[bytes, bytes]] | None = None
def __enter__(self) -> WebSocketTestSession:
self.exit_stack = ExitStack()
portal = self.exit_stack.enter_context(self.client.portal())
try:
portal.start_task_soon(self.do_asgi_call)
event: WebSocketConnectEvent = {"type": "websocket.connect"}
self.receive_queue.put(event)
message = self.receive(timeout=self.client.timeout.read)
self.accepted_subprotocol = cast("str | None", message.get("subprotocol", None))
self.extra_headers = cast("list[tuple[bytes, bytes]] | None", message.get("headers", None))
return self
except Exception:
self.exit_stack.close()
raise
def __exit__(self, *args: Any) -> None:
try:
self.close()
finally:
self.exit_stack.close()
while not self.send_queue.empty():
message = self.send_queue.get()
if isinstance(message, BaseException):
raise message
async def do_asgi_call(self) -> None:
"""The sub-thread in which the websocket session runs."""
async def receive() -> WebSocketReceiveMessage:
while self.receive_queue.empty():
await sleep(0)
return self.receive_queue.get()
async def send(message: WebSocketSendMessage) -> None:
if message["type"] == "websocket.accept":
headers = message.get("headers", [])
if headers:
headers_list = list(self.scope["headers"])
headers_list.extend(headers)
self.scope["headers"] = headers_list
subprotocols = cast("str | None", message.get("subprotocols"))
if subprotocols: # pragma: no cover
self.scope["subprotocols"].append(subprotocols)
self.send_queue.put(message)
try:
await self.client.app(self.scope, receive, send)
except BaseException as exc:
self.send_queue.put(exc)
raise
def send(self, data: str | bytes, mode: Literal["text", "binary"] = "text", encoding: str = "utf-8") -> None:
"""Sends a "receive" event. This is the inverse of the ASGI send method.
Args:
data: Either a string or a byte string.
mode: The key to use - ``text`` or ``bytes``
encoding: The encoding to use when encoding or decoding data.
Returns:
None.
"""
if mode == "text":
data = data.decode(encoding) if isinstance(data, bytes) else data
text_event: WebSocketReceiveMessage = {"type": "websocket.receive", "text": data} # type: ignore[assignment]
self.receive_queue.put(text_event)
else:
data = data if isinstance(data, bytes) else data.encode(encoding)
binary_event: WebSocketReceiveMessage = {"type": "websocket.receive", "bytes": data} # type: ignore[assignment]
self.receive_queue.put(binary_event)
def send_text(self, data: str, encoding: str = "utf-8") -> None:
"""Sends the data using the ``text`` key.
Args:
data: Data to send.
encoding: Encoding to use.
Returns:
None
"""
self.send(data=data, encoding=encoding)
def send_bytes(self, data: bytes, encoding: str = "utf-8") -> None:
"""Sends the data using the ``bytes`` key.
Args:
data: Data to send.
encoding: Encoding to use.
Returns:
None
"""
self.send(data=data, mode="binary", encoding=encoding)
def send_json(self, data: Any, mode: Literal["text", "binary"] = "text") -> None:
"""Sends the given data as JSON.
Args:
data: The data to send.
mode: Either ``text`` or ``binary``
Returns:
None
"""
self.send(encode_json(data), mode=mode)
def send_msgpack(self, data: Any) -> None:
"""Sends the given data as MessagePack.
Args:
data: The data to send.
Returns:
None
"""
self.send(encode_msgpack(data), mode="binary")
def close(self, code: int = WS_1000_NORMAL_CLOSURE) -> None:
"""Sends an 'websocket.disconnect' event.
Args:
code: status code for closing the connection.
Returns:
None.
"""
event: WebSocketDisconnectEvent = {"type": "websocket.disconnect", "code": code}
self.receive_queue.put(event)
def receive(self, block: bool = True, timeout: float | None = None) -> WebSocketSendMessage:
"""This is the base receive method.
Args:
block: Block until a message is received
timeout: If ``block`` is ``True``, block at most ``timeout`` seconds
Notes:
- you can use one of the other receive methods to extract the data from the message.
Returns:
A websocket message.
"""
message = cast("WebSocketSendMessage", self.send_queue.get(block=block, timeout=timeout))
if isinstance(message, BaseException):
raise message
if message["type"] == "websocket.close":
raise WebSocketDisconnect(
detail=cast("str", message.get("reason", "")),
code=message.get("code", WS_1000_NORMAL_CLOSURE),
)
return message
def receive_text(self, block: bool = True, timeout: float | None = None) -> str:
"""Receive data in ``text`` mode and return a string
Args:
block: Block until a message is received
timeout: If ``block`` is ``True``, block at most ``timeout`` seconds
Returns:
A string value.
"""
message = self.receive(block=block, timeout=timeout)
return cast("str", message.get("text", ""))
def receive_bytes(self, block: bool = True, timeout: float | None = None) -> bytes:
"""Receive data in ``binary`` mode and return bytes
Args:
block: Block until a message is received
timeout: If ``block`` is ``True``, block at most ``timeout`` seconds
Returns:
A string value.
"""
message = self.receive(block=block, timeout=timeout)
return cast("bytes", message.get("bytes", b""))
def receive_json(
self, mode: Literal["text", "binary"] = "text", block: bool = True, timeout: float | None = None
) -> Any:
"""Receive data in either ``text`` or ``binary`` mode and decode it as JSON.
Args:
mode: Either ``text`` or ``binary``
block: Block until a message is received
timeout: If ``block`` is ``True``, block at most ``timeout`` seconds
Returns:
An arbitrary value
"""
message = self.receive(block=block, timeout=timeout)
if mode == "text":
return decode_json(cast("str", message.get("text", "")))
return decode_json(cast("bytes", message.get("bytes", b"")))
def receive_msgpack(self, block: bool = True, timeout: float | None = None) -> Any:
message = self.receive(block=block, timeout=timeout)
return decode_msgpack(cast("bytes", message.get("bytes", b"")))
|
