-
Notifications
You must be signed in to change notification settings - Fork 3.7k
fix(voice): shield transcript rotation from cancellation #7300
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.
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
DeepanshuPal
wants to merge
1
commit into
livekit:main
Choose a base branch
from
DeepanshuPal:fix/transcript-barrier-cancellation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+64
−1
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,63 @@ | ||
| import asyncio | ||
|
|
||
| import pytest | ||
|
|
||
| from livekit.agents import io | ||
| from livekit.agents.voice.transcription.synchronizer import TranscriptSynchronizer | ||
|
|
||
| pytestmark = pytest.mark.unit | ||
|
|
||
|
|
||
| class _TextOutput(io.TextOutput): | ||
| def __init__(self) -> None: | ||
| super().__init__(label="test", next_in_chain=None) | ||
|
|
||
| async def capture_text(self, text: str) -> None: | ||
| pass | ||
|
|
||
| def flush(self) -> None: | ||
| pass | ||
|
|
||
|
|
||
| class _AudioOutput(io.AudioOutput): | ||
| def __init__(self) -> None: | ||
| super().__init__(label="test", capabilities=io.AudioOutputCapabilities(pause=False)) | ||
|
|
||
| async def capture_frame(self, frame) -> None: | ||
| pass | ||
|
|
||
| def flush(self) -> None: | ||
| pass | ||
|
|
||
| def clear_buffer(self) -> None: | ||
| pass | ||
|
|
||
| def pause(self) -> None: | ||
| pass | ||
|
|
||
| def resume(self) -> None: | ||
| pass | ||
|
|
||
|
|
||
| def test_barrier_cancellation_does_not_cancel_segment_rotation() -> None: | ||
| async def run() -> None: | ||
| sync = TranscriptSynchronizer( | ||
| next_in_chain_text=_TextOutput(), next_in_chain_audio=_AudioOutput() | ||
| ) | ||
| release = asyncio.Event() | ||
|
|
||
| async def rotate() -> None: | ||
| await release.wait() | ||
|
|
||
| rotation = asyncio.create_task(rotate()) | ||
| sync._rotate_segment_atask = rotation | ||
| waiter = asyncio.create_task(sync.barrier()) | ||
| await asyncio.sleep(0) | ||
| waiter.cancel() | ||
| with pytest.raises(asyncio.CancelledError): | ||
| await waiter | ||
| assert not rotation.cancelled() | ||
| release.set() | ||
| await sync.barrier() | ||
|
|
||
| asyncio.run(run()) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟡 Cancelled shutdown leaks synchronizer tasks
Cancelling
aclose()during rotation leaves the shielded task running after shutdown exits._rotate_segment_taskcreates a new implementation whose background tasks remain open.Learn more
aclose()marks the synchronizer closed and then waits at this barrier. Cancellation now exitsaclose()without cancelling the rotation. The surviving rotation closes the old implementation, then _rotate_segment_task unconditionally constructs a new implementation with three background tasks. Since the synchronizer is already closed andaclose()has exited, nothing closes that new implementation.Example: A session starts rotating a transcript segment and then shutdown calls
aclose(). If shutdown cancellation arrives before rotation finishes,aclose()exits while rotation continues. Rotation creates a fresh closed-session implementation, leaving its main, capture, and speaking-rate tasks alive.Recommended fix: Make cancelled shutdown retain ownership of the protected rotation and close whichever implementation it creates. One option is a dedicated close task that awaits rotation and closes the final
_impl, withaclose()shielding that task so later cleanup can still await it.Was this helpful? React with 👍 or 👎 to provide feedback.