fix: deduplicate getSid() listeners to prevent leak on concurrent calls#635
Open
LautaroPetaccio wants to merge 6 commits intolivekit:mainfrom
Open
fix: deduplicate getSid() listeners to prevent leak on concurrent calls#635LautaroPetaccio wants to merge 6 commits intolivekit:mainfrom
LautaroPetaccio wants to merge 6 commits intolivekit:mainfrom
Conversation
🦋 Changeset detectedLatest commit: 9e38994 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 |
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
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.
Why
Each
getSid()call creates its ownRoomSidChanged+Disconnectedlistener pair. If multiple calls race, only one resolves the SID and cleans up itsRoomSidChangedlistener — the rest stay attached. Additionally, theDisconnectedlistener registered viaonce()was never removed on the success path, persisting until a disconnect event orremoveAllListeners().How
Add a
private sidPromise?: Promise<string>field. On the firstgetSid()call that needs to wait, create the promise and store it. Subsequent concurrent calls return the same promise. When the promise resolves or rejects,sidPromiseis cleared so future calls after a reconnect work normally. Both the resolve and reject paths now clean up both listeners — on success,handleDisconnectis removed; on disconnect,handleRoomUpdateis removed.Test coverage
New E2E test
concurrent getSid() calls share a single listener and resolve consistently— fires 3 concurrentgetSid()calls, asserts all return the same SID.