Skip to content

Fixes a race where await room.sid could hang even after the room SID was available in room._info.sid. #713

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
xianshijing-lk wants to merge 1 commit into
base: main
Choose a base branch
from
+14 −3
Open

Fixes a race where await room.sid could hang even after the room SID was available in room._info.sid. #713

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 14 additions & 3 deletions livekit-rtc/livekit/rtc/room.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,16 @@ async def sid(self) -> str:
if self._info.sid:
return self._info.sid

return await self._first_sid_future
# This future is shared state for the Room. Caller-side timeouts, e.g.
# asyncio.wait_for(room.sid, ...), should not cancel it for future waiters.
return await asyncio.shield(self._first_sid_future)

def _resolve_first_sid(self, sid: str) -> None:
# The room SID can arrive through the initial connect result or later
# room update events. Resolve the first-SID waiter from any source that
# carries it so waiters do not depend on event ordering.
if sid and not self._first_sid_future.done():
self._first_sid_future.set_result(sid)

@property
def local_participant(self) -> LocalParticipant:
Expand Down Expand Up @@ -545,6 +554,7 @@ def on_participant_connected(participant):
)

self._info = cb.connect.result.room.info
self._resolve_first_sid(self._info.sid)
self._connection_state = ConnectionState.CONN_CONNECTED

self._local_participant = LocalParticipant(
Expand Down Expand Up @@ -859,8 +869,7 @@ def _on_room_event(self, event: proto_room.RoomEvent) -> None:
self._info.metadata = event.room_metadata_changed.metadata
self.emit("room_metadata_changed", old_metadata, self.metadata)
elif which == "room_sid_changed":
if not self._info.sid:
self._first_sid_future.set_result(event.room_sid_changed.sid)
self._resolve_first_sid(event.room_sid_changed.sid)
self._info.sid = event.room_sid_changed.sid
# This is an internal event, not exposed to users
elif which == "participant_metadata_changed":
Expand Down Expand Up @@ -1019,10 +1028,12 @@ def _on_room_event(self, event: proto_room.RoomEvent) -> None:

elif which == "room_updated":
self._info = event.room_updated
self._resolve_first_sid(self._info.sid)
self.emit("room_updated")

elif which == "moved":
self._info = event.moved
self._resolve_first_sid(self._info.sid)
self.emit("moved")

elif which == "participants_updated":
Expand Down
Loading