fix: release reader lock and clear receivedChunks in stream iterators#640
Merged
lukasIO merged 2 commits intolivekit:mainfrom Apr 7, 2026
Merged
Conversation
🦋 Changeset detectedLatest commit: 96c4cbf 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 |
Merged
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
Reader lock not released (FD leak)
Both
ByteStreamReaderandTextStreamReaderasync iterators only released the reader lock in the explicitreturn()method. If the stream completed normally (done: true) or an error was caught innext(), the lock stayed held. Consumers that don't callreturn()(e.g.for-awaitloops that break on a condition, orreadAll()which runs to completion) would leave the underlyingReadableStreamlocked and unable to be garbage-collected.receivedChunks never cleared (memory leak)
The
TextStreamReader.receivedChunksMap stores every chunk received during the stream's lifetime for version-based deduplication and progress tracking. It is never cleared — not when the stream is fully consumed, not on error, and not when the consumer breaks out of iteration. For large or frequent text streams, this keeps all chunk data in memory for the lifetime of the reader object.How
Reader lock fix
Add
reader.releaseLock()in both thedoneandcatchpaths ofnext()for bothByteStreamReaderandTextStreamReaderiterators. This ensures the lock is released regardless of how the iteration ends.receivedChunks fix
Capture the
receivedChunksreference into a local variable at the top of the async iterator (sincereturn()is a regular function wherethisrefers to the iterator object, not the class instance). Then callreceivedChunks.clear()in all three termination paths:done,catch, andreturn().