Consolidate clean up tasks for voice audio resources#318
Merged
Conversation
Contributor
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
francamps
changed the title
francamps
requested review from
a team,
chrismanahan,
christinapeng1,
hume-bot,
klaudiuszmiotk,
twitchard,
vpicone,
yinishi,
zachkrall and
zgreathouse
and removed request for
a team
yinishi
approved these changes
May 7, 2025
yinishi
approved these changes
May 7, 2025
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Context
Websocket connections can close both expectedly and unexpectedly; in the React SDK, there are multiple resources which are dependent on this connection state: microphone, player and the voice provider state itself. Depending on the path by which this connection is closed, either manually, server-side or erroneously, there can exist race conditions that leave some of these resources in unfitting state.
Change
This PR implements a consolidated
handleResourceCleanupfunction that orchestrates cleanup of player, microphone, and application state. Using refs to track microphone, the consolidated function can then be used in theonClosecallback of the voice client, ensuring that all cleanup tasks properly run on different cases: manual disconnections, connection being closed server-side, or any type of errors occurring.