Skip to content

Utilize response from data_track_stream_read request #686

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
stephen-derosa wants to merge 1 commit into
base: main
Choose a base branch
from
+27 −8
Open

Utilize response from data_track_stream_read request #686

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
35 changes: 27 additions & 8 deletions livekit-rtc/livekit/rtc/data_track.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
from __future__ import annotations

from dataclasses import dataclass
from typing import AsyncIterator, Optional
from typing import AsyncIterator, NoReturn, Optional

from ._ffi_client import FfiClient, FfiHandle
from ._proto import ffi_pb2 as proto_ffi
Expand Down Expand Up @@ -231,7 +231,10 @@ async def __anext__(self) -> DataTrackFrame:
if self._closed:
raise StopAsyncIteration

self._send_read_request()
eos = self._send_read_request()
if eos is not None:
self._handle_eos(eos)

event: proto_ffi.FfiEvent = await self._queue.get()
stream_event = event.data_track_stream_event
detail = stream_event.WhichOneof("detail")
Expand All @@ -246,18 +249,34 @@ async def __anext__(self) -> DataTrackFrame:
user_timestamp=user_ts,
)
elif detail == "eos":
self._close()
if stream_event.eos.HasField("error"):
raise SubscribeDataTrackError(stream_event.eos.error.message)
raise StopAsyncIteration
self._handle_eos(stream_event.eos)
else:
self._close()
raise StopAsyncIteration

def _send_read_request(self) -> None:
def _send_read_request(self) -> Optional[proto_data_track.DataTrackStreamEOS]:
req = proto_ffi.FfiRequest()
req.data_track_stream_read.stream_handle = self._ffi_handle.handle
FfiClient.instance.request(req)
resp = FfiClient.instance.request(req)
return self._read_response_eos(resp.data_track_stream_read)

@staticmethod
def _read_response_eos(
read_response: proto_data_track.DataTrackStreamReadResponse,
) -> Optional[proto_data_track.DataTrackStreamEOS]:
try:
if not read_response.HasField("eos"):
return None
except ValueError:
return None

return getattr(read_response, "eos")
Comment on lines +267 to +273
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot May 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔴 Wrong protobuf field name eos used instead of eos_event in _read_response_eos, causing synchronous EOS detection to silently fail

The DataTrackStreamReadResponse protobuf message has a field named eos_event (see data_track_pb2.pyi:700-711), but _read_response_eos checks for "eos" via HasField("eos") and getattr(read_response, "eos"). Since "eos" is not a valid field on this message, HasField("eos") raises ValueError, which is caught by the except ValueError block, causing the method to always return None. This means the synchronous EOS detection path (the entire point of this PR change) never triggers. If the FFI layer returns a synchronous EOS in the read response and does not also send an async event, the code will hang forever on await self._queue.get() at line 238.

Field name in proto vs code

Proto (data_track_pb2.pyi:700-711):

EOS_EVENT_FIELD_NUMBER: builtins.int
def eos_event(self) -> global___DataTrackStreamEOS
def HasField(self, field_name: typing.Literal["eos_event", b"eos_event"]) -> builtins.bool

Code (data_track.py:268,273):

read_response.HasField("eos")  # wrong name
getattr(read_response, "eos")  # wrong name
Suggested change
try:
if not read_response.HasField("eos"):
return None
except ValueError:
return None
return getattr(read_response, "eos")
try:
if not read_response.HasField("eos_event"):
return None
except ValueError:
return None
return getattr(read_response, "eos_event")
Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.


Comment on lines +268 to +274
def _handle_eos(self, eos: proto_data_track.DataTrackStreamEOS) -> NoReturn:
self._close()
if eos.HasField("error"):
raise SubscribeDataTrackError(eos.error.message)
raise StopAsyncIteration

def _close(self) -> None:
if not self._closed:
Expand Down
Loading