doc: update write callback documentation#38959

simoneb · 2021-06-07T14:02:22Z

replace may or may not be called with will be called because the callback is always called
remove To reliably detect write errors, add a listener for the 'error' event because the error event will NOT be emitted if a write occurs after the stream has been closed

- replace _*may or may not* be called_ with _will be called_ because the callback is always called - remove _To reliably detect write errors, add a listener for the `'error'` event_ because the `error` event will NOT be emitted if a write occurs after the stream has been closed

aduh95 · 2021-06-07T16:56:36Z

If I understand the linked issue correctly, this is true only for Node.js v15+. Adding the labels so it doesn't get backported, feel free to remove them if I misunderstood the situation.

benjamingr · 2021-06-07T20:14:10Z

@nodejs/streams

mcollina

lgtm

github-actions · 2021-06-10T19:36:23Z

Commit Queue failed

- Loading data for nodejs/node/pull/38959 ✔ Done loading data for nodejs/node/pull/38959 ----------------------------------- PR info ------------------------------------ Title doc: update write callback documentation (#38959) ⚠ Could not retrieve the email or name of the PR author's from user's GitHub profile! Branch simoneb:patch-1 -> nodejs:master Labels author ready, doc, dont-land-on-v12.x, dont-land-on-v14.x, stream Commits 1 - doc: update write callback documentation Committers 1 - GitHub PR-URL: https://github.com/nodejs/node/pull/38959 Fixes: https://github.com/nodejs/node/issues/38704 Reviewed-By: James M Snell Reviewed-By: Antoine du Hamel Reviewed-By: Benjamin Gruenbaum Reviewed-By: Robert Nagy Reviewed-By: Matteo Collina ------------------------------ Generated metadata ------------------------------ PR-URL: https://github.com/nodejs/node/pull/38959 Fixes: https://github.com/nodejs/node/issues/38704 Reviewed-By: James M Snell Reviewed-By: Antoine du Hamel Reviewed-By: Benjamin Gruenbaum Reviewed-By: Robert Nagy Reviewed-By: Matteo Collina -------------------------------------------------------------------------------- ℹ This PR was created on Mon, 07 Jun 2021 14:02:22 GMT ✔ Approvals: 5 ✔ - James M Snell (@jasnell) (TSC): https://github.com/nodejs/node/pull/38959#pullrequestreview-677503321 ✔ - Antoine du Hamel (@aduh95) (TSC): https://github.com/nodejs/node/pull/38959#pullrequestreview-677663819 ✔ - Benjamin Gruenbaum (@benjamingr): https://github.com/nodejs/node/pull/38959#pullrequestreview-677841411 ✔ - Robert Nagy (@ronag) (TSC): https://github.com/nodejs/node/pull/38959#pullrequestreview-677850823 ✔ - Matteo Collina (@mcollina) (TSC): https://github.com/nodejs/node/pull/38959#pullrequestreview-678297907 ✖ Last GitHub CI failed ℹ Green GitHub Actions CI is sufficient -------------------------------------------------------------------------------- ✔ Aborted `git node land` session in /home/runner/work/node/node/.ncu

https://github.com/nodejs/node/actions/runs/926267471

github-actions · 2021-06-10T20:33:01Z

Commit Queue failed

- Loading data for nodejs/node/pull/38959 ✔ Done loading data for nodejs/node/pull/38959 ----------------------------------- PR info ------------------------------------ Title doc: update write callback documentation (#38959) ⚠ Could not retrieve the email or name of the PR author's from user's GitHub profile! Branch simoneb:patch-1 -> nodejs:master Labels author ready, doc, dont-land-on-v12.x, dont-land-on-v14.x, stream Commits 1 - doc: update write callback documentation Committers 1 - GitHub PR-URL: https://github.com/nodejs/node/pull/38959 Fixes: https://github.com/nodejs/node/issues/38704 Reviewed-By: James M Snell Reviewed-By: Antoine du Hamel Reviewed-By: Benjamin Gruenbaum Reviewed-By: Robert Nagy Reviewed-By: Matteo Collina ------------------------------ Generated metadata ------------------------------ PR-URL: https://github.com/nodejs/node/pull/38959 Fixes: https://github.com/nodejs/node/issues/38704 Reviewed-By: James M Snell Reviewed-By: Antoine du Hamel Reviewed-By: Benjamin Gruenbaum Reviewed-By: Robert Nagy Reviewed-By: Matteo Collina -------------------------------------------------------------------------------- ℹ This PR was created on Mon, 07 Jun 2021 14:02:22 GMT ✔ Approvals: 5 ✔ - James M Snell (@jasnell) (TSC): https://github.com/nodejs/node/pull/38959#pullrequestreview-677503321 ✔ - Antoine du Hamel (@aduh95) (TSC): https://github.com/nodejs/node/pull/38959#pullrequestreview-677663819 ✔ - Benjamin Gruenbaum (@benjamingr): https://github.com/nodejs/node/pull/38959#pullrequestreview-677841411 ✔ - Robert Nagy (@ronag) (TSC): https://github.com/nodejs/node/pull/38959#pullrequestreview-677850823 ✔ - Matteo Collina (@mcollina) (TSC): https://github.com/nodejs/node/pull/38959#pullrequestreview-678297907 ✔ Last GitHub Actions successful ℹ Green GitHub Actions CI is sufficient -------------------------------------------------------------------------------- ✔ No git cherry-pick in progress ✔ No git am in progress ✔ No git rebase in progress -------------------------------------------------------------------------------- - Bringing origin/master up to date... From https://github.com/nodejs/node * branch master -> FETCH_HEAD ✔ origin/master is now up-to-date - Downloading patch for 38959 From https://github.com/nodejs/node * branch refs/pull/38959/merge -> FETCH_HEAD ✔ Fetched commits as 52f8471b5281..453d7dbcbd99 -------------------------------------------------------------------------------- [master d77e235f62] doc: update write callback documentation Author: Simone Busoli Date: Mon Jun 7 16:01:49 2021 +0200 1 file changed, 2 insertions(+), 3 deletions(-) ✔ Patches applied -------------------------------------------------------------------------------- --------------------------------- New Message ---------------------------------- doc: update write callback documentation

replace may or may not be called with will be called because the callback is always called
remove To reliably detect write errors, add a listener for the 'error' event because the error event will NOT be emitted if a write occurs after the stream has been closed

PR-URL: #38959
Fixes: #38704
Reviewed-By: James M Snell [email protected]
Reviewed-By: Antoine du Hamel [email protected]
Reviewed-By: Benjamin Gruenbaum [email protected]
Reviewed-By: Robert Nagy [email protected]
Reviewed-By: Matteo Collina [email protected]

[master 8806c955a2] doc: update write callback documentation
Author: Simone Busoli [email protected]
Date: Mon Jun 7 16:01:49 2021 +0200
1 file changed, 2 insertions(+), 3 deletions(-)
✖ 8806c955a270b602ab78330502cd8694e756ec8b
✔ 5:7 Valid fixes URL. fixes-url
✔ 0:0 blank line after title line-after-title
✖ 1:72 Line should be <= 72 columns. line-length
✖ 2:72 Line should be <= 72 columns. line-length
✔ 0:0 metadata is at end of message metadata-end
✔ 4:8 PR-URL is valid. pr-url
✔ 0:0 reviewers are valid reviewers
✔ 0:0 valid subsystems subsystem
✔ 0:0 Title is formatted correctly. title-format
✔ 0:0 Title is <= 50 columns. title-length
ℹ Please fix the commit message and try again.

https://github.com/nodejs/node/actions/runs/926415209

- replace _*may or may not* be called_ with _will be called_ because the callback is always called - remove _To reliably detect write errors, add a listener for the `'error'` event_ because the `error` event will NOT be emitted if a write occurs after the stream has been closed PR-URL: #38959Fixes: #38704 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Robert Nagy <[email protected]> Reviewed-By: Matteo Collina <[email protected]>

mmarchini · 2021-06-10T20:38:26Z

Landed in cf609cc

- replace _*may or may not* be called_ with _will be called_ because the callback is always called - remove _To reliably detect write errors, add a listener for the `'error'` event_ because the `error` event will NOT be emitted if a write occurs after the stream has been closed PR-URL: #38959Fixes: #38704 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Robert Nagy <[email protected]> Reviewed-By: Matteo Collina <[email protected]>

github-actionsbot added doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem. labels Jun 7, 2021

simoneb mentioned this pull request Jun 7, 2021
node 16.x does not raise error on write when server closes connection #38704
Closed

jasnell approved these changes Jun 7, 2021
View reviewed changes

aduh95 approved these changes Jun 7, 2021
View reviewed changes

aduh95 added dont-land-on-v12.x author ready PRs that have at least one approval, no pending requests for changes, and a CI started. labels Jun 7, 2021

benjamingr approved these changes Jun 7, 2021
View reviewed changes

ronag approved these changes Jun 7, 2021
View reviewed changes

mcollina approved these changes Jun 8, 2021
View reviewed changes

mmarchini added the commit-queue Add this label to land a pull request using GitHub Actions. label Jun 10, 2021

github-actionsbot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Jun 10, 2021

github-actionsbot added the commit-queue-failed An error occurred while landing this pull request using GitHub Actions. label Jun 10, 2021

mmarchini added commit-queue Add this label to land a pull request using GitHub Actions. and removed commit-queue-failed An error occurred while landing this pull request using GitHub Actions. labels Jun 10, 2021

github-actionsbot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Jun 10, 2021

mmarchini closed this Jun 10, 2021

danielleadams mentioned this pull request Jun 14, 2021
v16.4.0 proposal #39031
Merged

targos removed the commit-queue-failed An error occurred while landing this pull request using GitHub Actions. label Sep 5, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

doc: update write callback documentation#38959

doc: update write callback documentation #38959

Uh oh!

simoneb commented Jun 7, 2021•
edited by aduh95
Loading

Uh oh!

aduh95 commented Jun 7, 2021

Uh oh!

benjamingr commented Jun 7, 2021

Uh oh!

mcollina left a comment

Uh oh!

github-actionsbot commented Jun 10, 2021

Uh oh!

github-actionsbot commented Jun 10, 2021

PR-URL: #38959
Fixes: #38704
Reviewed-By: James M Snell [email protected]
Reviewed-By: Antoine du Hamel [email protected]
Reviewed-By: Benjamin Gruenbaum [email protected]
Reviewed-By: Robert Nagy [email protected]
Reviewed-By: Matteo Collina [email protected]

Uh oh!

mmarchini commented Jun 10, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Uh oh!

doc: update write callback documentation#38959

doc: update write callback documentation #38959

Uh oh!

Conversation

simoneb commented Jun 7, 2021• edited by aduh95 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aduh95 commented Jun 7, 2021

Uh oh!

benjamingr commented Jun 7, 2021

Uh oh!

mcollina left a comment

Choose a reason for hiding this comment

Uh oh!

github-actionsbot commented Jun 10, 2021

Uh oh!

github-actionsbot commented Jun 10, 2021

PR-URL: #38959 Fixes: #38704 Reviewed-By: James M Snell [email protected] Reviewed-By: Antoine du Hamel [email protected] Reviewed-By: Benjamin Gruenbaum [email protected] Reviewed-By: Robert Nagy [email protected] Reviewed-By: Matteo Collina [email protected]

Uh oh!

mmarchini commented Jun 10, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

simoneb commented Jun 7, 2021•
edited by aduh95
Loading

PR-URL: #38959
Fixes: #38704
Reviewed-By: James M Snell [email protected]
Reviewed-By: Antoine du Hamel [email protected]
Reviewed-By: Benjamin Gruenbaum [email protected]
Reviewed-By: Robert Nagy [email protected]
Reviewed-By: Matteo Collina [email protected]