-
-
Notifications
You must be signed in to change notification settings - Fork 34.7k
stream: add fast paths for webstreams read and pipeTo #61807
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
mcollina
wants to merge
1
commit into
nodejs:main
Choose a base branch
from
mcollina:webstreams-fast-paths
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+137
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| 'use strict'; | ||
| const common = require('../common.js'); | ||
| const { ReadableStream } = require('node:stream/web'); | ||
|
|
||
| // Benchmark for reading from a pre-buffered ReadableStream. | ||
| // This measures the fast path optimization where data is already | ||
| // queued in the controller, avoiding DefaultReadRequest allocation. | ||
|
|
||
| const bench = common.createBenchmark(main, { | ||
| n: [1e5], | ||
| bufferSize: [1, 10, 100, 1000], | ||
| }); | ||
|
|
||
| async function main({ n, bufferSize }) { | ||
| let enqueued = 0; | ||
|
|
||
| const rs = new ReadableStream({ | ||
| start(controller) { | ||
| // Pre-fill the buffer | ||
| for (let i = 0; i < bufferSize; i++) { | ||
| controller.enqueue('a'); | ||
| enqueued++; | ||
| } | ||
| }, | ||
| pull(controller) { | ||
| // Refill buffer when pulled | ||
| const toEnqueue = Math.min(bufferSize, n - enqueued); | ||
| for (let i = 0; i < toEnqueue; i++) { | ||
| controller.enqueue('a'); | ||
| enqueued++; | ||
| } | ||
| if (enqueued >= n) { | ||
| controller.close(); | ||
| } | ||
| }, | ||
| }, { | ||
| // Use buffer size as high water mark to allow pre-buffering | ||
| highWaterMark: bufferSize, | ||
| }); | ||
|
|
||
| const reader = rs.getReader(); | ||
| let x = null; | ||
| let reads = 0; | ||
|
|
||
| bench.start(); | ||
| while (reads < n) { | ||
| const { value, done } = await reader.read(); | ||
| if (done) break; | ||
| x = value; | ||
| reads++; | ||
| } | ||
| bench.end(reads); | ||
| console.assert(x); | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -860,6 +860,31 @@ class ReadableStreamDefaultReader { | |
| new ERR_INVALID_STATE.TypeError( | ||
| 'The reader is not attached to a stream')); | ||
| } | ||
|
|
||
| const stream = this[kState].stream; | ||
| const controller = stream[kState].controller; | ||
|
|
||
| // Fast path: if data is already buffered in a default controller, | ||
| // return a resolved promise immediately without creating a read request. | ||
| // This is spec-compliant because read() returns a Promise, and | ||
| // Promise.resolve() callbacks still run in the microtask queue. | ||
| if (stream[kState].state === 'readable' && | ||
| isReadableStreamDefaultController(controller) && | ||
| controller[kState].queue.length > 0) { | ||
| stream[kState].disturbed = true; | ||
| const chunk = dequeueValue(controller); | ||
|
|
||
| if (controller[kState].closeRequested && !controller[kState].queue.length) { | ||
| readableStreamDefaultControllerClearAlgorithms(controller); | ||
| readableStreamClose(stream); | ||
| } else { | ||
| readableStreamDefaultControllerCallPullIfNeeded(controller); | ||
| } | ||
|
|
||
| return PromiseResolve({ value: chunk, done: false }); | ||
| } | ||
|
|
||
| // Slow path: create request and go through normal flow | ||
| const readRequest = new DefaultReadRequest(); | ||
| readableStreamDefaultReaderRead(this, readRequest); | ||
| return readRequest.promise; | ||
|
|
@@ -1286,6 +1311,8 @@ const isReadableStream = | |
| isBrandCheck('ReadableStream'); | ||
| const isReadableByteStreamController = | ||
| isBrandCheck('ReadableByteStreamController'); | ||
| const isReadableStreamDefaultController = | ||
| isBrandCheck('ReadableStreamDefaultController'); | ||
| const isReadableStreamBYOBRequest = | ||
| isBrandCheck('ReadableStreamBYOBRequest'); | ||
| const isReadableStreamDefaultReader = | ||
|
|
@@ -1510,6 +1537,62 @@ function readableStreamPipeTo( | |
|
|
||
| await writer[kState].ready.promise; | ||
|
|
||
| const controller = source[kState].controller; | ||
|
|
||
| // Fast path: batch reads when data is buffered in a default controller. | ||
| // This avoids creating PipeToReadableStreamReadRequest objects and | ||
| // reduces promise allocation overhead. | ||
| if (source[kState].state === 'readable' && | ||
| isReadableStreamDefaultController(controller) && | ||
| controller[kState].queue.length > 0) { | ||
| let batchCount = 0; | ||
| const hwm = controller[kState].highWaterMark || 1; | ||
|
|
||
| while (controller[kState].queue.length > 0 && batchCount < hwm) { | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Comparing We should add a test that uses a custom size algorithm. |
||
| if (shuttingDown) return true; | ||
|
|
||
| source[kState].disturbed = true; | ||
| const chunk = dequeueValue(controller); | ||
|
|
||
| if (controller[kState].closeRequested && !controller[kState].queue.length) { | ||
| readableStreamDefaultControllerClearAlgorithms(controller); | ||
| readableStreamClose(source); | ||
| } | ||
|
|
||
| // Write the chunk - we're already in a separate microtask from enqueue | ||
| // because we awaited writer[kState].ready.promise above | ||
| state.currentWrite = writableStreamDefaultWriterWrite(writer, chunk); | ||
| setPromiseHandled(state.currentWrite); | ||
|
|
||
| batchCount++; | ||
|
|
||
| // Check backpressure after each write | ||
| if (writer[kState].ready.promise !== undefined && | ||
| dest[kState].state === 'writable') { | ||
| const desiredSize = writer.desiredSize; | ||
| if (desiredSize !== null && desiredSize <= 0) { | ||
| // Backpressure - stop batch and wait for ready | ||
| break; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Trigger pull if needed after batch | ||
| if (source[kState].state === 'readable' && | ||
| !controller[kState].closeRequested) { | ||
| readableStreamDefaultControllerCallPullIfNeeded(controller); | ||
| } | ||
|
|
||
| // Check if stream closed during batch | ||
| if (source[kState].state === 'closed') { | ||
| return true; | ||
| } | ||
|
|
||
| // Yield to microtask queue between batches to allow events/signals to fire | ||
| return false; | ||
| } | ||
|
|
||
| // Slow path: use read request for async reads | ||
| const promise = PromiseWithResolvers(); | ||
| // eslint-disable-next-line no-use-before-define | ||
| readableStreamDefaultReaderRead(reader, new PipeToReadableStreamReadRequest(writer, state, promise)); | ||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why
|| 1? An HWM of 0 is valid.