Skip to content

fix(node): mirror webstreams Readable adapter cancel semantics #30526

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
merged 8 commits into from
Sep 1, 2025
Merged

fix(node): mirror webstreams Readable adapter cancel semantics #30526

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
80b8e88
fix(node): handle reader cancellation during stream close in WebStrea…
Aug 26, 2025
54a6500
fix(node): handle stream termination gracefully in WebStreams adapters
Aug 26, 2025
6fb9485
Merge branch 'main' into DENB-29802-9
Aug 28, 2025
74ac150
addressed client review
Aug 28, 2025
251a8c1
Merge branch 'main' into DENB-29802-9
Aug 28, 2025
55c7a1e
update PR title
Aug 28, 2025
21e3923
Add test-stream-readable-from-web-termination.js to config.toml to up…
Aug 28, 2025
9e3947d
Merge branch 'main' into DENB-29802-9
bartlomieju Sep 1, 2025
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
8 changes: 7 additions & 1 deletion ext/node/polyfills/internal/webstreams/adapters.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -516,6 +516,8 @@ export function newReadableStreamFromStreamReadable(

streamReadable.pause();

let isCanceled = false;

const cleanup = finished(streamReadable, (error) => {
if (error?.code === "ERR_STREAM_PREMATURE_CLOSE") {
const err = new AbortError(undefined, { cause: error });
Expand All @@ -529,6 +531,9 @@ export function newReadableStreamFromStreamReadable(
if (error) {
return controller.error(error);
}
if (isCanceled) {
return;
}
controller.close();
});

Expand All @@ -544,7 +549,8 @@ export function newReadableStreamFromStreamReadable(
},

cancel(reason) {
destroy(streamReadable, reason);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It appears that Node.js, keeps track of wasCanceled variable here and then later uses it to decide if the controller should be closed. Have you tried this approach? https://github.com/nodejs/node/blob/886e4b3b534a9f3ad2facbc99097419e06615900/lib/internal/webstreams/adapters.js#L499

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

addressed!

isCanceled = true;
destroy.call(streamReadable, reason);
},
}, strategy);
}
Expand Down
1 change: 1 addition & 0 deletions tests/node_compat/config.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1048,6 +1048,7 @@
"parallel/test-stream-readable-setEncoding-existing-buffers.js" = {}
"parallel/test-stream-readable-setEncoding-null.js" = {}
"parallel/test-stream-readable-strategy-option.js" = {}
"parallel/test-stream-readable-to-web-termination.js" = {}
"parallel/test-stream-readable-unpipe-resume.js" = { flaky = true }
"parallel/test-stream-readable-unshift.js" = {}
"parallel/test-stream-readable-with-unimplemented-_read.js" = {}
Expand Down
Loading