fix(leak): Memory leak when Room.connect() fails#652
Open
LautaroPetaccio wants to merge 1 commit intolivekit:mainfrom
Open
fix(leak): Memory leak when Room.connect() fails#652LautaroPetaccio wants to merge 1 commit intolivekit:mainfrom
LautaroPetaccio wants to merge 1 commit intolivekit:mainfrom
Conversation
When connect() throws (either from a ConnectError or a rejected waitFor), the onFfiEvent listener registered on the global FfiClient singleton was never removed. This prevents the Room from being GC'd and causes preConnectEvents to grow unboundedly because the handler keeps pushing events into a Room that never finished connecting. Wrap the connect logic in try/catch so the listener and stale preConnectEvents are cleaned up on any error path.
🦋 Changeset detectedLatest commit: a132b5a The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
LautaroPetaccio
changed the title
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
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
1 participant
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.
Summary
When
Room.connect()fails, theonFfiEventlistener registered on the globalFfiClientsingleton is never removed. This causes two problems:FfiClientholds a reference tothis.onFfiEvent, which closes over the Room.preConnectEventsgrows unboundedly becauseonFfiEventkeeps pushing everyFfiEventinto the array — the guard!this.localParticipant || !this.ffiHandle || !this.infois always true for a Room that never finished connecting.connect()on the same Room multiplies the leak, since each failed attempt adds another copy of the listener.The fix wraps the connect logic in a
try/catchso that on any error (whether fromwaitForrejection or theConnectErrorthrown on the'error'case), we:onFfiEventlistener fromFfiClientpreConnectEventsarrayThe listener is intentionally not removed on the success path — it must stay attached for the room to function normally.