-
Notifications
You must be signed in to change notification settings - Fork 285
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(playground): ensure chat completion subscription unit tests run o…
…n all os and on postgres (#5205) Co-authored-by: Dustin Ngo <dustin.ngo@gmail.com>
- Loading branch information
1 parent
cb55790
commit 78942cd
Showing
3 changed files
with
277 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,256 @@ | ||
""" | ||
This file contains a copy of [httpx-ws](https://github.com/frankie567/httpx-ws), | ||
which is published under an [MIT | ||
license](https://github.com/frankie567/httpx-ws/blob/main/LICENSE). | ||
Modifications have been made to better support the concurrency paradigm used in | ||
our unit test suite. | ||
""" | ||
|
||
import asyncio | ||
import contextlib | ||
import typing | ||
|
||
import wsproto | ||
from httpcore import AsyncNetworkStream | ||
from httpx import ASGITransport, AsyncByteStream, Request, Response | ||
from wsproto.frame_protocol import CloseReason | ||
|
||
Scope = dict[str, typing.Any] | ||
Message = dict[str, typing.Any] | ||
Receive = typing.Callable[[], typing.Awaitable[Message]] | ||
Send = typing.Callable[[Scope], typing.Coroutine[None, None, None]] | ||
ASGIApp = typing.Callable[[Scope, Receive, Send], typing.Coroutine[None, None, None]] | ||
|
||
|
||
class HTTPXWSException(Exception): | ||
""" | ||
Base exception class for HTTPX WS. | ||
""" | ||
|
||
pass | ||
|
||
|
||
class WebSocketDisconnect(HTTPXWSException): | ||
""" | ||
Raised when the server closed the WebSocket session. | ||
Args: | ||
code: | ||
The integer close code to indicate why the connection has closed. | ||
reason: | ||
Additional reasoning for why the connection has closed. | ||
""" | ||
|
||
def __init__(self, code: int = 1000, reason: typing.Optional[str] = None) -> None: | ||
self.code = code | ||
self.reason = reason or "" | ||
|
||
|
||
class ASGIWebSocketTransportError(Exception): | ||
pass | ||
|
||
|
||
class UnhandledASGIMessageType(ASGIWebSocketTransportError): | ||
def __init__(self, message: Message) -> None: | ||
self.message = message | ||
|
||
|
||
class UnhandledWebSocketEvent(ASGIWebSocketTransportError): | ||
def __init__(self, event: wsproto.events.Event) -> None: | ||
self.event = event | ||
|
||
|
||
class ASGIWebSocketAsyncNetworkStream(AsyncNetworkStream): | ||
def __init__(self, app: ASGIApp, scope: Scope) -> None: | ||
self.app = app | ||
self.scope = scope | ||
self._receive_queue: asyncio.Queue[Message] = asyncio.Queue() | ||
self._send_queue: asyncio.Queue[Message] = asyncio.Queue() | ||
self.connection = wsproto.WSConnection(wsproto.ConnectionType.SERVER) | ||
self.connection.initiate_upgrade_connection(scope["headers"], scope["path"]) | ||
self.tasks: list[asyncio.Task[None]] = [] | ||
|
||
async def __aenter__( | ||
self, | ||
) -> tuple["ASGIWebSocketAsyncNetworkStream", bytes]: | ||
self.exit_stack = contextlib.AsyncExitStack() | ||
await self.exit_stack.__aenter__() | ||
|
||
# Start the _run coroutine as a task | ||
self._run_task = asyncio.create_task(self._run()) | ||
self.tasks.append(self._run_task) | ||
self.exit_stack.push_async_callback(self._cancel_tasks) | ||
|
||
await self.send({"type": "websocket.connect"}) | ||
message = await self.receive() | ||
|
||
if message["type"] == "websocket.close": | ||
await self.aclose() | ||
raise WebSocketDisconnect(message["code"], message.get("reason")) | ||
|
||
assert message["type"] == "websocket.accept" | ||
return self, self._build_accept_response(message) | ||
|
||
async def __aexit__(self, *args: typing.Any) -> None: | ||
await self.aclose() | ||
await self.exit_stack.aclose() | ||
|
||
async def _cancel_tasks(self) -> None: | ||
# Cancel all running tasks | ||
for task in self.tasks: | ||
task.cancel() | ||
# Wait for tasks to be cancelled | ||
await asyncio.gather(*self.tasks, return_exceptions=True) | ||
|
||
async def read(self, max_bytes: int, timeout: typing.Optional[float] = None) -> bytes: | ||
message: Message = await self.receive() | ||
message_type = message["type"] | ||
|
||
if message_type not in {"websocket.send", "websocket.close"}: | ||
raise UnhandledASGIMessageType(message) | ||
|
||
event: wsproto.events.Event | ||
if message_type == "websocket.send": | ||
data_str: typing.Optional[str] = message.get("text") | ||
if data_str is not None: | ||
event = wsproto.events.TextMessage(data_str) | ||
else: | ||
data_bytes: typing.Optional[bytes] = message.get("bytes") | ||
if data_bytes is not None: | ||
event = wsproto.events.BytesMessage(data_bytes) | ||
else: | ||
# If neither text nor bytes are provided, raise an error | ||
raise ValueError("websocket.send message missing 'text' or 'bytes'") | ||
elif message_type == "websocket.close": | ||
event = wsproto.events.CloseConnection(message["code"], message.get("reason")) | ||
|
||
return self.connection.send(event) | ||
|
||
async def write(self, buffer: bytes, timeout: typing.Optional[float] = None) -> None: | ||
self.connection.receive_data(buffer) | ||
for event in self.connection.events(): | ||
if isinstance(event, wsproto.events.Request): | ||
pass # Already handled in __init__ | ||
elif isinstance(event, wsproto.events.CloseConnection): | ||
await self.send( | ||
{ | ||
"type": "websocket.close", | ||
"code": event.code, | ||
"reason": event.reason, | ||
} | ||
) | ||
elif isinstance(event, wsproto.events.TextMessage): | ||
await self.send({"type": "websocket.receive", "text": event.data}) | ||
elif isinstance(event, wsproto.events.BytesMessage): | ||
await self.send({"type": "websocket.receive", "bytes": event.data}) | ||
else: | ||
raise UnhandledWebSocketEvent(event) | ||
|
||
async def aclose(self) -> None: | ||
await self.send({"type": "websocket.close"}) | ||
# Ensure tasks are cancelled and cleaned up | ||
await self._cancel_tasks() | ||
|
||
async def send(self, message: Message) -> None: | ||
await self._receive_queue.put(message) | ||
|
||
async def receive(self, timeout: typing.Optional[float] = None) -> Message: | ||
try: | ||
message = await asyncio.wait_for(self._send_queue.get(), timeout) | ||
return message | ||
except asyncio.TimeoutError: | ||
raise TimeoutError("Timed out waiting for message") | ||
|
||
async def _run(self) -> None: | ||
""" | ||
The coroutine in which the websocket session runs. | ||
""" | ||
scope = self.scope | ||
receive = self._asgi_receive | ||
send = self._asgi_send | ||
try: | ||
await self.app(scope, receive, send) | ||
except Exception as e: | ||
message = { | ||
"type": "websocket.close", | ||
"code": CloseReason.INTERNAL_ERROR, | ||
"reason": str(e), | ||
} | ||
await self._asgi_send(message) | ||
|
||
async def _asgi_receive(self) -> Message: | ||
return await self._receive_queue.get() | ||
|
||
async def _asgi_send(self, message: Message) -> None: | ||
await self._send_queue.put(message) | ||
|
||
def _build_accept_response(self, message: Message) -> bytes: | ||
subprotocol = message.get("subprotocol", None) | ||
headers = message.get("headers", []) | ||
return self.connection.send( | ||
wsproto.events.AcceptConnection( | ||
subprotocol=subprotocol, | ||
extra_headers=headers, | ||
) | ||
) | ||
|
||
|
||
class ASGIWebSocketTransport(ASGITransport): | ||
def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: | ||
super().__init__(*args, **kwargs) | ||
self.exit_stack: typing.Optional[contextlib.AsyncExitStack] = None | ||
|
||
async def handle_async_request(self, request: Request) -> Response: | ||
scheme = request.url.scheme | ||
headers = request.headers | ||
|
||
if scheme in {"ws", "wss"} or headers.get("upgrade") == "websocket": | ||
subprotocols: list[str] = [] | ||
if (subprotocols_header := headers.get("sec-websocket-protocol")) is not None: | ||
subprotocols = subprotocols_header.split(",") | ||
|
||
scope = { | ||
"type": "websocket", | ||
"path": request.url.path, | ||
"raw_path": request.url.raw_path, | ||
"root_path": self.root_path, | ||
"scheme": scheme, | ||
"query_string": request.url.query, | ||
"headers": [(k.lower(), v) for (k, v) in request.headers.raw], | ||
"client": self.client, | ||
"server": (request.url.host, request.url.port), | ||
"subprotocols": subprotocols, | ||
} | ||
return await self._handle_ws_request(request, scope) | ||
|
||
return await super().handle_async_request(request) | ||
|
||
async def _handle_ws_request( | ||
self, | ||
request: Request, | ||
scope: Scope, | ||
) -> Response: | ||
assert isinstance(request.stream, AsyncByteStream) | ||
|
||
self.scope = scope | ||
self.exit_stack = contextlib.AsyncExitStack() | ||
stream, accept_response = await self.exit_stack.enter_async_context( | ||
ASGIWebSocketAsyncNetworkStream(self.app, self.scope) # type: ignore[arg-type] | ||
) | ||
|
||
accept_response_lines = accept_response.decode("utf-8").splitlines() | ||
headers = [ | ||
typing.cast(tuple[str, str], line.split(": ", 1)) | ||
for line in accept_response_lines[1:] | ||
if line.strip() != "" | ||
] | ||
|
||
return Response( | ||
status_code=101, | ||
headers=headers, | ||
extensions={"network_stream": stream}, | ||
) | ||
|
||
async def aclose(self) -> None: | ||
if self.exit_stack: | ||
await self.exit_stack.aclose() |