Skip to content

stream: include strategy options on Readable #43515

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.

Sign up for GitHub

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

Merged
nodejs-github-bot merged 10 commits into from
Jul 13, 2022
Merged

stream: include strategy options on Readable #43515

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
c3050a6
stream: initial approach to include strategy options on Readable.toWeb()
Warkanlock Jun 21, 2022
b48a89d
stream: extend strategy option using an object to allow extensibility
Warkanlock Jun 21, 2022
9eda83e
stream: fix typo on comment and change name of parameter in the docu…
Warkanlock Jun 21, 2022
bcff47a
stream: add unit test for strategy option
Warkanlock Jun 21, 2022
dd15dad
stream: added parameter size to calculate size of chunks if needed
Warkanlock Jun 21, 2022
f0f8798
stream: add better unit test to check if desireSize is being assigned
Warkanlock Jun 21, 2022
faf07cc
stream: remove unused imports
Warkanlock Jun 21, 2022
fa44cbf
stream: remove nested nernary and replace it with an inner function
Warkanlock Jun 21, 2022
93d1582
stream: use an arrow function instead
Warkanlock Jun 21, 2022
293be93
stream: refactor evaluateStrategyOrFallback method inspired by nit su…
Warkanlock Jun 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
stream: extend strategy option using an object to allow extensibility
  • Loading branch information
@Warkanlock
Warkanlock committed Jun 21, 2022
commit b48a89d91cddf6aefd450ec3926fb8589285bb8b
3 changes: 2 additions & 1 deletion doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2816,7 +2816,8 @@ added: v17.0.0
> Stability: 1 - Experimental

* `streamReadable` {stream.Readable}
* `strategy` {queuingstrategies.QueuingStrategy}
* `options` {Object}
* `strategy` {QueuingStrategy}
Comment thread
Warkanlock marked this conversation as resolved.
Outdated
* Returns: {ReadableStream}

### `stream.Writable.fromWeb(writableStream[, options])`
Expand Down
6 changes: 4 additions & 2 deletions lib/internal/streams/readable.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1405,8 +1405,10 @@ Readable.fromWeb = function(readableStream, options) {
options);
};

Readable.toWeb = function(streamReadable, strategy = null) {
return lazyWebStreams().newReadableStreamFromStreamReadable(streamReadable, strategy);
Readable.toWeb = function(streamReadable, options) {
return lazyWebStreams().newReadableStreamFromStreamReadable(
streamReadable,
options);
};

Readable.wrap = function(src, options) {
Expand Down
10 changes: 8 additions & 2 deletions lib/internal/webstreams/adapters.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -361,10 +361,12 @@ function newStreamWritableFromWritableStream(writableStream, options = kEmptyObj
/**
* @typedef {import('./queuingstrategies').QueuingStrategy} QueuingStrategy
* @param {Readable} streamReadable
* @param {QueuingStrategy} [queuingStrategy]
* @param {{
* strategy : QueuingStrategy
* }} [options]
* @returns {ReadableStream}
*/
function newReadableStreamFromStreamReadable(streamReadable, queuingStrategy = null) {
function newReadableStreamFromStreamReadable(streamReadable, options = kEmptyObject) {
// Not using the internal/streams/utils isReadableNodeStream utility
// here because it will return false if streamReadable is a Duplex
// whose readable option is false. For a Duplex that is not readable,
Expand All @@ -388,6 +390,10 @@ function newReadableStreamFromStreamReadable(streamReadable, queuingStrategy = n
// back to a minimal strategy that just specifies the highWaterMark
// and no size algorithm. Using a ByteLengthQueuingStrategy here
// is unnecessary.

// If there is an strategy available, use it. Otherwise, fallback to default behavior
Comment thread
Warkanlock marked this conversation as resolved.
Outdated
const queuingStrategy = options?.strategy;

const strategy = queuingStrategy ?
Comment thread
Warkanlock marked this conversation as resolved.
Outdated
queuingStrategy :
objectMode ?
Expand Down