Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/ypywidgets/comm.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
TransactionEvent,
YMessageType,
YSyncMessageType,
create_awareness_message,
create_sync_message,
create_update_message,
handle_sync_message,
Expand Down Expand Up @@ -51,6 +52,7 @@ def __init__(
self._ydoc = ydoc
self._comm = comm
self._awareness = Awareness(ydoc)
self._awareness_sub_id = self._awareness.observe(self._send_awareness)
msg = create_sync_message(ydoc)
self._comm.send(buffers=[msg])
self._comm.on_msg(self._receive)
Expand All @@ -59,6 +61,12 @@ def __init__(
def awareness(self) -> Awareness:
return self._awareness

# send awareness to the frontend
def _send_awareness(self, topic, data):
update = self._awareness.encode_awareness_update([self._awareness.client_id])
message = create_awareness_message(update)
self._comm.send(buffers=[message])

def _receive(self, msg):
message = bytes(msg["buffers"][0])
match message[0]:
Expand Down
14 changes: 14 additions & 0 deletions tests/test_comm_awareness.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,17 @@ async def test_comm_widget_awareness_observe_and_unobserve():
events.clear()
widget.awareness.set_local_state({"ping": 2})
assert events == []


async def test_comm_provider_sends_awareness_to_frontend(synced_widgets, context):
async with context:
local_widget = await synced_widgets.get_local_widget()

sent_messages = []
local_widget._comm_provider._comm.send = lambda buffers: sent_messages.append(
buffers[0]
)

local_widget.awareness.set_local_state({"role": "python-test"})

assert any(msg[0] == YMessageType.AWARENESS for msg in sent_messages)