Skip to content
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

Jump to bottom

stream: callback should be called when pendingcb is 0 #53438

Merged
merged 5 commits into from
Jun 15, 2024
Merged

stream: callback should be called when pendingcb is 0 #53438

merged 5 commits into from
Jun 15, 2024

Conversation

jakecastelli
Copy link
Member

@jakecastelli jakecastelli commented Jun 13, 2024 •
edited
Loading

The callback should be called when the pendingcb is 0.

Time spent on this issue: 12 hours+, I would appreciate any comment or feedback on this 🙏

Fixes: #46170

@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/streams

@nodejs-github-bot nodejs-github-bot added needs-ci PRs that need a full CI run. stream Issues and PRs related to the stream subsystem. labels Jun 13, 2024
@jakecastelli jakecastelli changed the title stream: callback should be called when there pendingcb is 0 stream: callback should be called when pendingcb is 0 Jun 13, 2024
@jakecastelli jakecastelli marked this pull request as ready for review June 13, 2024 07:28
mcollina
mcollina reviewed Jun 13, 2024
View reviewed changes
test/parallel/test-stream-finished.js
@@ -679,5 +679,6 @@ testClosed((opts) => new Writable({ write() {}, ...opts }));

finished(stream, { readable: false }, common.mustCall((err) => {
assert(!err);
assert.strictEqual(stream._writableState.pendingcb, 0);
Copy link
Member

Choose a reason for hiding this comment

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

Can you add a test that does not look into _writableState? Why are you doing this change?

Copy link
Member Author

Choose a reason for hiding this comment

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

sure, I will add a new test to address it, thanks!

Why are you doing this change?

Do you mean the change to the test? If so, it is because when the callback function is called in stream.finished it won't wait for the callback in the writable._write (if any async action is performed) and one of the indication is stream._writableState.pendingcb is not 0.

Copy link
Member Author

Choose a reason for hiding this comment

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

I have expanded the test to make sure the cb in _write is called before the cb in finished is called. PTAL @mcollina 🙏

@jakecastelli
fixup! expand the test
b052a0c 
Make sure the callback in `write` is called before the callback in
finished
@ronag ronag added the request-ci Add this label to start a Jenkins CI on a PR. label Jun 13, 2024
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Jun 13, 2024
@nodejs-github-bot

This comment was marked as outdated.

Sign in to view
@atlowChemi atlowChemi added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. labels Jun 13, 2024
mcollina
mcollina approved these changes Jun 14, 2024
View reviewed changes
Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

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

lgtm

@mcollina mcollina added the request-ci Add this label to start a Jenkins CI on a PR. label Jun 14, 2024
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Jun 14, 2024
@nodejs-github-bot

This comment was marked as outdated.

Sign in to view
@nodejs-github-bot

This comment was marked as outdated.

Sign in to view
@jakecastelli jakecastelli mentioned this pull request Jun 14, 2024
Open
@nodejs-github-bot
Copy link
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/59779/

@mcollina mcollina added commit-queue Add this label to land a pull request using GitHub Actions. and removed needs-ci PRs that need a full CI run. labels Jun 14, 2024
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Jun 15, 2024
@nodejs-github-bot nodejs-github-bot merged commit 177d63f into nodejs:main Jun 15, 2024
54 checks passed
@nodejs-github-bot
Copy link
Collaborator

Landed in 177d63f

targos pushed a commit that referenced this pull request Jun 20, 2024
@jakecastelli @targos
stream: callback should be called when pendingcb is 0
b3372a8 
Fixes: #46170
PR-URL: #53438
Reviewed-By: Robert Nagy <[email protected]>
Reviewed-By: Chemi Atlow <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
eliphazbouye pushed a commit to eliphazbouye/node that referenced this pull request Jun 20, 2024
@jakecastelli @eliphazbouye
stream: callback should be called when pendingcb is 0
4b08951 
Fixes: nodejs#46170
PR-URL: nodejs#53438
Reviewed-By: Robert Nagy <[email protected]>
Reviewed-By: Chemi Atlow <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
bmeck pushed a commit to bmeck/node that referenced this pull request Jun 22, 2024
@jakecastelli @bmeck
stream: callback should be called when pendingcb is 0
b6bd60b 
Fixes: nodejs#46170
PR-URL: nodejs#53438
Reviewed-By: Robert Nagy <[email protected]>
Reviewed-By: Chemi Atlow <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
@targos targos mentioned this pull request Jun 25, 2024
Merged
@Karliz24 Karliz24 mentioned this pull request Jul 9, 2024
Open
marco-ippolito pushed a commit that referenced this pull request Jul 19, 2024
@jakecastelli @marco-ippolito
stream: callback should be called when pendingcb is 0
f89f653 
Fixes: #46170
PR-URL: #53438
Reviewed-By: Robert Nagy <[email protected]>
Reviewed-By: Chemi Atlow <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
marco-ippolito pushed a commit that referenced this pull request Jul 19, 2024
@jakecastelli @marco-ippolito
stream: callback should be called when pendingcb is 0
33a15be 
Fixes: #46170
PR-URL: #53438
Reviewed-By: Robert Nagy <[email protected]>
Reviewed-By: Chemi Atlow <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
@marco-ippolito marco-ippolito mentioned this pull request Jul 19, 2024
Merged
@jakecastelli jakecastelli mentioned this pull request Jul 31, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@VoltrexKeyva VoltrexKeyva VoltrexKeyva left review comments

@atlowChemi atlowChemi atlowChemi approved these changes

@ronag ronag ronag approved these changes

@jasnell jasnell jasnell approved these changes

@mcollina mcollina mcollina approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. stream Issues and PRs related to the stream subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

stream.finished calls callback when writable stream still has pending callbacks
7 participants
@jakecastelli @nodejs-github-bot @mcollina @jasnell @ronag @VoltrexKeyva @atlowChemi