Repository navigation
fix(utils): do not chain a promise per chunk while streaming a response - #417
Open
TonyTech404 wants to merge 1 commit into
Open
TonyTech404 wants to merge 1 commit into
TonyTech404 wants to merge 1 commit into
Conversation
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.
Fixes #407
Problem
In
writeFromReadableStreamDefaultReader,flowreturns the promise of the next read from inside athencallback. A promise returned from athencallback makes the promise of thatthenwait for it, so whilewrite()keeps returningtrueeach chunk adds one pending promise to a chain. The chain only settles when the stream ends,write()returnsfalse, or an error occurs. For a paced stream that never fills the socket (live audio, SSE) the number of live promises, and the memory, grows without bound while the response is open.The analysis and the one-line fix come from @Mheaus in #407, who also supplied a reproduction. I reproduced it independently and wrote the regression test below.
Fix
Start the next read without returning its promise. Nothing uses the value
flowreturns (it is only passed tothen), and errors still reachhandleStreamError, so behaviour is otherwise unchanged. The return type offlowbecomesvoid.Verification
test/utils.test.ts: a pacedReadableStreamis written to aWritablewhosewrite()always returnstrue, and the number of livePromiseobjects (v8.queryObjects) is sampled at two points of the same open stream. Without the fix the test fails withexpected 899 to be less than 100; with it, it passes.pnpm format,pnpm lintandpnpm typecheckpass.test/server.test.ts(GET /readable-stream) andtest/request.test.ts(stream closes mid-read), which also fail on an unmodifiedmain; they are unrelated to this change.v8.queryObjectsprints anExperimentalWarningonce during the test run.