fix: cancel losing timeout in AudioMixer race to prevent timer leak#641
Open
LautaroPetaccio wants to merge 3 commits intolivekit:mainfrom
Open
fix: cancel losing timeout in AudioMixer race to prevent timer leak#641LautaroPetaccio wants to merge 3 commits intolivekit:mainfrom
LautaroPetaccio wants to merge 3 commits intolivekit:mainfrom
Conversation
🦋 Changeset detectedLatest commit: 54d5d36 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
AudioMixer.getContribution()usesPromise.race([iterator.next(), this.timeout(ms)])to race each stream against a deadline. When the iterator wins (the normal case), the losing timeout'ssetTimeoutis never cleared. It fires harmlessly but creates an orphaned timer on every mixing iteration. Under sustained mixing this creates a steady stream of wasted work, and in pathological cases can pressure the timer heap.How
Replace the old
timeout()method (which returned an uncancellable promise) withtimeoutRace(), which returns both the race promise and aclearTimeouthandle. After the race resolves ingetContribution(),cancel()is called immediately to clear the losing timer.Test coverage
Three new unit tests in
audio_mixer.test.ts:completes mixing without lingering timers when iterator is fast— verifies mixing works correctly with a long timeout that always loses the raceproduces frames even with many race iterations— stress test with more frames and iterationshandles slow streams via timeout path— uses a 1ms timeout with a slow stream to verify the timeout path works and logs the expected warning