|
1 | | -import asyncio |
| 1 | +import math |
2 | 2 | import time |
3 | | -from typing import Optional |
| 3 | +from contextlib import AsyncExitStack |
| 4 | +from functools import partial |
| 5 | +from typing import Any, cast |
4 | 6 |
|
5 | 7 | import comm |
6 | 8 | import pytest |
| 9 | +from anyio import Event, create_memory_object_stream, create_task_group, fail_after |
| 10 | +from anyio.abc import TaskGroup |
| 11 | +from anyio.streams.memory import MemoryObjectReceiveStream, MemoryObjectSendStream |
7 | 12 | from pycrdt import ( |
8 | 13 | Awareness, |
9 | 14 | YMessageType, |
|
17 | 22 | from ypywidgets import Widget |
18 | 23 | from ypywidgets.comm import CommWidget |
19 | 24 |
|
| 25 | +pytestmark = pytest.mark.anyio |
| 26 | + |
20 | 27 |
|
21 | 28 | class MockComm(comm.base_comm.BaseComm): |
22 | 29 |
|
23 | 30 | def __init__( |
24 | | - self, |
25 | | - comm_id=None, |
26 | | - target_name=None, |
27 | | - data=None, |
28 | | - metadata=None, |
29 | | - ): |
30 | | - self.send_queue = asyncio.Queue() |
31 | | - self.recv_queue = asyncio.Queue() |
| 31 | + self, |
| 32 | + task_group: TaskGroup, |
| 33 | + send_send_stream: MemoryObjectSendStream, |
| 34 | + send_recv_stream: MemoryObjectReceiveStream, |
| 35 | + recv_send_stream: MemoryObjectSendStream, |
| 36 | + recv_recv_stream: MemoryObjectReceiveStream, |
| 37 | + comm_id: str = "", |
| 38 | + target_name: str = "", |
| 39 | + data=None, |
| 40 | + metadata=None, |
| 41 | + ) -> None: |
| 42 | + self.send_send_stream = send_send_stream |
| 43 | + self.send_recv_stream = send_recv_stream |
| 44 | + self.recv_send_stream = recv_send_stream |
| 45 | + self.recv_recv_stream = recv_recv_stream |
32 | 46 | super().__init__(comm_id=comm_id, target_name=target_name, data=data, metadata=metadata) |
33 | | - self.receive_task = asyncio.create_task(self.receive()) |
| 47 | + task_group.start_soon(self.receive) |
34 | 48 |
|
35 | 49 | def publish_msg(self, msg_type, data, metadata, buffers, target_name=None, target_module=None): |
36 | | - self.send_queue.put_nowait((msg_type, data, metadata, buffers, target_name, target_module)) |
| 50 | + self.send_send_stream.send_nowait((msg_type, data, metadata, buffers, target_name, target_module)) |
37 | 51 |
|
38 | 52 | def handle_msg(self, msg): |
39 | 53 | self._msg_callback(msg) |
40 | 54 |
|
41 | | - async def receive(self): |
| 55 | + async def receive(self) -> None: |
42 | 56 | while True: |
43 | | - msg = await self.recv_queue.get() |
| 57 | + msg = await self.recv_recv_stream.receive() |
44 | 58 | self.handle_msg(msg) |
45 | 59 |
|
46 | 60 |
|
47 | | -comm.create_comm = MockComm |
| 61 | +class Context: |
| 62 | + def __init__(self): |
| 63 | + self.tasks = [] |
48 | 64 |
|
| 65 | + def add_task(self, task): |
| 66 | + self.tasks.append(task) |
49 | 67 |
|
50 | | -@pytest.fixture |
51 | | -def widget_factories(): |
52 | | - return CommWidget, Widget |
| 68 | + async def __aenter__(self) -> Context: |
| 69 | + send_send_stream, send_recv_stream = create_memory_object_stream(max_buffer_size=math.inf) |
| 70 | + recv_send_stream, recv_recv_stream = create_memory_object_stream(max_buffer_size=math.inf) |
| 71 | + async with AsyncExitStack() as stack: |
| 72 | + await stack.enter_async_context(send_send_stream) |
| 73 | + await stack.enter_async_context(recv_send_stream) |
| 74 | + await stack.enter_async_context(send_recv_stream) |
| 75 | + await stack.enter_async_context(recv_recv_stream) |
| 76 | + self.task_group = await stack.enter_async_context(create_task_group()) |
| 77 | + comm.create_comm = partial(MockComm, self.task_group, send_send_stream, send_recv_stream, recv_send_stream, recv_recv_stream) |
| 78 | + for task in self.tasks: |
| 79 | + self.task_group.start_soon(task) |
| 80 | + self.stack = stack.pop_all() |
| 81 | + return self |
53 | 82 |
|
| 83 | + async def __aexit__(self, *exc) -> bool | None: |
| 84 | + self.task_group.cancel_scope.cancel() |
| 85 | + comm.create_comm = _create_comm |
| 86 | + return await self.stack.__aexit__(*exc) |
54 | 87 |
|
55 | | -@pytest.fixture |
56 | | -async def synced_widgets(widget_factories): |
57 | | - local_widget = widget_factories[0]() |
58 | | - remote_widget_manager = RemoteWidgetManager(widget_factories[1], local_widget._comm) |
59 | | - remote_widget = await remote_widget_manager.get_widget() |
60 | | - return local_widget, remote_widget |
61 | 88 |
|
| 89 | +def _create_comm(*args: Any, **kwargs: Any) -> comm.BaseComm: |
| 90 | + return comm.DummyComm(*args, **kwargs) |
62 | 91 |
|
63 | | -class RemoteWidgetManager: |
64 | 92 |
|
65 | | - comm: Optional[MockComm] |
66 | | - widget: Optional[Widget] |
| 93 | +class SyncedWidgets: |
67 | 94 |
|
68 | | - def __init__(self, widget_factory, comm): |
69 | | - self.widget_factory = widget_factory |
70 | | - self.comm = comm |
71 | | - self.widget = None |
72 | | - self._remote_awareness: Optional[Awareness] = None |
73 | | - self.receive_task = asyncio.create_task(self.receive()) |
| 95 | + def __init__(self, widget_factories: tuple[type[CommWidget], type[Widget]], context: Context) -> None: |
| 96 | + self.local_widget_factory, self.remote_widget_factory = widget_factories |
| 97 | + self.local_widget: CommWidget | None = None |
| 98 | + self.remote_widget: Widget | None = None |
| 99 | + self._remote_awareness: Awareness | None = None |
| 100 | + self.local_widget_created = Event() |
| 101 | + self.remote_widget_created = Event() |
| 102 | + context.add_task(self.receive) |
74 | 103 |
|
75 | | - def send(self, event: TransactionEvent): |
| 104 | + def send(self, event: TransactionEvent) -> None: |
76 | 105 | update = event.update |
77 | 106 | message = create_update_message(update) |
78 | | - self.comm.recv_queue.put_nowait({"buffers": [message]}) |
| 107 | + self.comm.recv_send_stream.send_nowait({"buffers": [message]}) |
79 | 108 |
|
80 | | - async def receive(self): |
| 109 | + async def receive(self) -> None: |
| 110 | + self.local_widget = self.local_widget_factory() |
| 111 | + self.local_widget_created.set() |
| 112 | + self.comm = cast(MockComm, self.local_widget._comm) |
81 | 113 | while True: |
82 | | - msg_type, data, metadata, buffers, target_name, target_module = await self.comm.send_queue.get() |
83 | | - if msg_type == "comm_open": |
84 | | - self.widget = self.widget_factory() |
85 | | - msg = create_sync_message(self.widget.ydoc) |
86 | | - self.comm.handle_msg({"buffers": [msg]}) |
87 | | - elif msg_type == "comm_msg": |
88 | | - message = buffers[0] |
89 | | - if message[0] == YMessageType.SYNC: |
90 | | - reply = handle_sync_message(message[1:], self.widget.ydoc) |
91 | | - if reply is not None: |
92 | | - self.comm.handle_msg({"buffers": [reply]}) |
93 | | - if message[1] == YSyncMessageType.SYNC_STEP2: |
94 | | - self.widget.ydoc.observe(self.send) |
95 | | - elif message[0] == YMessageType.AWARENESS: |
96 | | - if self._remote_awareness is None: |
97 | | - self._remote_awareness = Awareness(self.widget.ydoc) |
98 | | - payload = read_message(bytes(message[1:])) |
99 | | - self._remote_awareness.apply_awareness_update(payload, None) |
100 | | - |
101 | | - async def get_widget(self, timeout=0.1): |
102 | | - t = time.monotonic() |
103 | | - while True: |
104 | | - if self.widget: |
105 | | - return self.widget |
106 | | - await asyncio.sleep(0) |
107 | | - if time.monotonic() - t > timeout: # pragma: nocover |
108 | | - raise TimeoutError("Timeout waiting for widget") |
| 114 | + msg_type, data, metadata, buffers, target_name, target_module = await self.comm.send_recv_stream.receive() |
| 115 | + match msg_type: |
| 116 | + case "comm_open": |
| 117 | + self.remote_widget = self.remote_widget_factory() |
| 118 | + msg = create_sync_message(self.remote_widget.ydoc) |
| 119 | + self.comm.handle_msg({"buffers": [msg]}) |
| 120 | + case "comm_msg": |
| 121 | + assert self.remote_widget is not None |
| 122 | + message = buffers[0] |
| 123 | + match message[0]: |
| 124 | + case YMessageType.SYNC: |
| 125 | + reply = handle_sync_message(message[1:], self.remote_widget.ydoc) |
| 126 | + if reply is not None: |
| 127 | + self.comm.handle_msg({"buffers": [reply]}) |
| 128 | + if message[1] == YSyncMessageType.SYNC_STEP2: |
| 129 | + self.sub = self.remote_widget.ydoc.observe(self.send) |
| 130 | + self.remote_widget_created.set() |
| 131 | + case YMessageType.AWARENESS: |
| 132 | + if self._remote_awareness is None: |
| 133 | + self._remote_awareness = Awareness(self.remote_widget.ydoc) |
| 134 | + payload = read_message(bytes(message[1:])) |
| 135 | + self._remote_awareness.apply_awareness_update(payload, None) |
| 136 | + |
| 137 | + async def get_local_widget(self, timeout: float =0.2) -> CommWidget: |
| 138 | + with fail_after(timeout): |
| 139 | + await self.local_widget_created.wait() |
| 140 | + assert self.local_widget is not None |
| 141 | + return self.local_widget |
| 142 | + |
| 143 | + async def get_remote_widget(self, timeout: float =0.2) -> Widget: |
| 144 | + with fail_after(timeout): |
| 145 | + await self.remote_widget_created.wait() |
| 146 | + assert self.remote_widget is not None |
| 147 | + return self.remote_widget |
| 148 | + |
| 149 | + |
| 150 | +@pytest.fixture |
| 151 | +def context() -> Context: |
| 152 | + return Context() |
| 153 | + |
| 154 | + |
| 155 | +@pytest.fixture |
| 156 | +def widget_factories() -> tuple[type[CommWidget], type[Widget]]: |
| 157 | + return CommWidget, Widget |
| 158 | + |
| 159 | + |
| 160 | +@pytest.fixture |
| 161 | +def synced_widgets(widget_factories: tuple[type[CommWidget], type[Widget]], context: Context) -> SyncedWidgets: |
| 162 | + return SyncedWidgets(widget_factories, context) |
0 commit comments