src,stream: improve DoWrite() and Write() #44434

ywave620 · 2022-08-29T11:02:42Z

StreamBase::Write() calls StreamResource::DoTryWrite() and StreamResource::DoWrite() to do the job.
However the interface definition of StreamResource::DoWrite() is error-prone or at least confusing, which I guess leads to an wrong(but no effect fortunately) override, Http2Stream::DoWrite(). This PR takes care of these two issues and make the StreamBase::WriteString() more efficent in the case where the underlying stream is too busy to receive more data.

nodejs-github-bot · 2022-08-29T11:02:46Z

Review requested:

@nodejs/http2
@nodejs/net

RafaelGSS

Could you include a test?

src/stream_base-inl.h

ywave620 · 2022-08-31T06:48:34Z

src/node_http2.cc

@@ -2372,8 +2372,7 @@ int Http2Stream::DoWrite(WriteWrap* req_wrap,
  CHECK_NULL(send_handle);
  Http2Scope h2scope(this);
  if (!is_writable() || is_destroyed()) {
-    req_wrap->Done(UV_EOF);


@RafaelGSS After investigation, I find out that this if statement should be turned to an assertion. Because the JS code make sure that whenever we do a write on a stream, the stream is writable and not destroyed.

Changing it to an assertion (CHECK) will crash the application whenever someone tries to write in a destroyed stream, is that expected?

JS code in /lib will not let this happens. Without misusing the internals, the case that captured by this if can not happen. If you insist keeping this if, then apparently, this function should return an error code immediately and never invoke the cb, because this is what every asynchronous API should do in case an immediate failure.

If that happens when misusing the internals, adding the CHECK make sense to me.

src/stream_base.cc

mcollina

lgtm

nodejs-github-bot · 2022-09-01T08:31:32Z

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

ywave620 · 2022-09-05T02:04:32Z

https://ci.nodejs.org/job/node-test-binary-windows-js-suites/16604/
Two tests failed.

parallel/test-vm-timeout-escape-promise-2
parallel/test-worker-heap-snapshot

The first one failed on many other CI, either, as you can see in nodejs/reliability#368. The second one fails rarely, maybe triggered by some concurrency issue, more details in #44515

ywave620 · 2022-09-13T01:34:50Z

Hello, how should I move this PR forward? @mcollina

Clarify StreamResource::DoWrite() interface definition. Fix error-prone Http2Stream::DoWrite(). Change StreamBase::Write() to allow caller to avoid inefficient write behavior.

nodejs-github-bot · 2022-10-01T04:56:36Z

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

RafaelGSS · 2022-10-01T22:03:52Z

Hi @ywave620, looks like those tests were fixed. Could you please rebase?

nodejs-github-bot · 2022-10-07T14:11:45Z

Commit Queue failed

- Loading data for nodejs/node/pull/44434
✔  Done loading data for nodejs/node/pull/44434
----------------------------------- PR info ------------------------------------
Title      src,stream: improve DoWrite() and Write() (#44434)
   ⚠  Could not retrieve the email or name of the PR author's from user's GitHub profile!
Branch     ywave620:src-stream-improve -> nodejs:main
Labels     c++, lib / src, commit-queue-squash
Commits    2
 - src,stream: improve DoWrite() and Write()
 - src,stream: improve DoWrite() and Write()
Committers 1
 - rogertyang 
PR-URL: https://github.com/nodejs/node/pull/44434
Reviewed-By: Matteo Collina 
Reviewed-By: Stephen Belanger 
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/44434
Reviewed-By: Matteo Collina 
Reviewed-By: Stephen Belanger 
--------------------------------------------------------------------------------
   ⚠  Commits were pushed since the last review:
   ⚠  - src,stream: improve DoWrite() and Write()
   ⚠  - src,stream: improve DoWrite() and Write()
   ℹ  This PR was created on Mon, 29 Aug 2022 11:02:42 GMT
   ✔  Approvals: 2
   ✔  - Matteo Collina (@mcollina) (TSC): https://github.com/nodejs/node/pull/44434#pullrequestreview-1091912155
   ✔  - Stephen Belanger (@Qard): https://github.com/nodejs/node/pull/44434#pullrequestreview-1091998538
   ⚠  GitHub cannot link the author of 'src,stream: improve DoWrite() and Write()' to their GitHub account.
   ⚠  Please suggest them to take a look at https://github.com/nodejs/node/blob/99b1ada/doc/guides/contributing/pull-requests.md#step-1-fork
   ⚠  GitHub cannot link the author of 'src,stream: improve DoWrite() and Write()' to their GitHub account.
   ⚠  Please suggest them to take a look at https://github.com/nodejs/node/blob/99b1ada/doc/guides/contributing/pull-requests.md#step-1-fork
   ✔  Last GitHub CI successful
   ℹ  Last Full PR CI on 2022-10-06T16:58:57Z: https://ci.nodejs.org/job/node-test-pull-request/47105/
- Querying data for job/node-test-pull-request/47105/
   ✔  Last Jenkins CI successful
--------------------------------------------------------------------------------
   ✔  Aborted `git node land` session in /home/runner/work/node/node/.ncu

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

mcollina · 2022-10-07T14:24:50Z

@ywave620 could you please make sure that the email you use to commit is linked to your github account? Our tooling for landing PRs is failing.

Please suggest them to take a look at https://github.com/nodejs/node/blob/99b1ada/doc/guides/contributing/pull-requests.md#step-1-fork

ywave620 · 2022-10-08T02:36:30Z

@mcollina Done :). Please try again.

nodejs-github-bot · 2022-10-08T06:39:55Z

Commit Queue failed

- Loading data for nodejs/node/pull/44434
✔  Done loading data for nodejs/node/pull/44434
----------------------------------- PR info ------------------------------------
Title      src,stream: improve DoWrite() and Write() (#44434)
   ⚠  Could not retrieve the email or name of the PR author's from user's GitHub profile!
Branch     ywave620:src-stream-improve -> nodejs:main
Labels     c++, lib / src, commit-queue-squash
Commits    2
 - src,stream: improve DoWrite() and Write()
 - src,stream: improve DoWrite() and Write()
Committers 1
 - rogertyang 
PR-URL: https://github.com/nodejs/node/pull/44434
Reviewed-By: Matteo Collina 
Reviewed-By: Stephen Belanger 
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/44434
Reviewed-By: Matteo Collina 
Reviewed-By: Stephen Belanger 
--------------------------------------------------------------------------------
   ⚠  Commits were pushed since the last review:
   ⚠  - src,stream: improve DoWrite() and Write()
   ⚠  - src,stream: improve DoWrite() and Write()
   ℹ  This PR was created on Mon, 29 Aug 2022 11:02:42 GMT
   ✔  Approvals: 2
   ✔  - Matteo Collina (@mcollina) (TSC): https://github.com/nodejs/node/pull/44434#pullrequestreview-1091912155
   ✔  - Stephen Belanger (@Qard): https://github.com/nodejs/node/pull/44434#pullrequestreview-1091998538
   ⚠  GitHub cannot link the author of 'src,stream: improve DoWrite() and Write()' to their GitHub account.
   ⚠  Please suggest them to take a look at https://github.com/nodejs/node/blob/99b1ada/doc/guides/contributing/pull-requests.md#step-1-fork
   ✔  Last GitHub CI successful
   ℹ  Last Full PR CI on 2022-10-07T14:11:45Z: https://ci.nodejs.org/job/node-test-pull-request/47105/
- Querying data for job/node-test-pull-request/47105/
   ✔  Last Jenkins CI successful
--------------------------------------------------------------------------------
   ✔  Aborted `git node land` session in /home/runner/work/node/node/.ncu

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

fix comment

ywave620 · 2022-10-08T08:01:12Z

@mcollina Sorry. It turns out that the email used in the latest commit is in bad format, I need to rewrite the author metadata.

ywave620 · 2022-10-08T08:11:23Z

@mcollina No substantial change at all, only the commit email is modified, shall we skip the CI phase?

mcollina

lgtm

mcollina · 2022-10-09T16:39:47Z

@mcollina No substantial change at all, only the commit email is modified, shall we skip the CI phase?

Our automated landing will complain if there are no CI run for the commit.

nodejs-github-bot · 2022-10-09T16:57:29Z

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

ywave620 · 2022-10-10T08:02:59Z

@mcollina CI done. Please help landing this :)

nodejs-github-bot · 2022-10-10T11:00:24Z

Landed in 78d280a

Clarify StreamResource::DoWrite() interface definition. Fix error-prone Http2Stream::DoWrite(). Change StreamBase::Write() to allow caller to avoid inefficient write behavior. PR-URL: #44434 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>

nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. labels Aug 29, 2022

RafaelGSS reviewed Aug 29, 2022

View reviewed changes

ywave620 commented Aug 31, 2022

View reviewed changes

src/stream_base-inl.h Show resolved Hide resolved

ywave620 commented Aug 31, 2022

View reviewed changes

src/stream_base.cc Show resolved Hide resolved

mcollina approved these changes Aug 31, 2022

View reviewed changes

theanarkh added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 31, 2022

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 31, 2022

This comment was marked as outdated.

Sign in to view

Qard approved these changes Aug 31, 2022

View reviewed changes

github-actions bot mentioned this pull request Sep 1, 2022

CI Reliability 2022-09-01 nodejs/reliability#364

Open

28 tasks

This was referenced Sep 2, 2022

CI Reliability 2022-09-02 nodejs/reliability#365

Open

CI Reliability 2022-09-03 nodejs/reliability#366

Open

CI Reliability 2022-09-04 nodejs/reliability#367

Open

CI Reliability 2022-09-05 nodejs/reliability#368

Open

ywave620 mentioned this pull request Sep 5, 2022

test-worker-heap-snapshot crash #44515

Closed

This was referenced Sep 6, 2022

CI Reliability 2022-09-06 nodejs/reliability#369

Open

CI Reliability 2022-09-07 nodejs/reliability#370

Open

src,stream: improve DoWrite() and Write()

2ec39cd

Clarify StreamResource::DoWrite() interface definition. Fix error-prone Http2Stream::DoWrite(). Change StreamBase::Write() to allow caller to avoid inefficient write behavior.

theanarkh added the request-ci Add this label to start a Jenkins CI on a PR. label Oct 1, 2022

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Oct 1, 2022

ywave620 force-pushed the src-stream-improve branch from 28ab1e0 to 858972c Compare October 2, 2022 02:25

mcollina added the commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. label Oct 7, 2022

nodejs-github-bot 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 Oct 7, 2022

mcollina 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 Oct 8, 2022

nodejs-github-bot 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 Oct 8, 2022

src,stream: improve DoWrite() and Write()

9719a8a

fix comment

ywave620 force-pushed the src-stream-improve branch from 858972c to 9719a8a Compare October 8, 2022 08:09

mcollina approved these changes Oct 9, 2022

View reviewed changes

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Oct 9, 2022

mcollina added commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. commit-queue Add this label to land a pull request using GitHub Actions. labels Oct 10, 2022

nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Oct 10, 2022

nodejs-github-bot merged commit 78d280a into nodejs:main Oct 10, 2022

danielleadams mentioned this pull request Oct 11, 2022

v18.11.0 proposal #44968

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

src,stream: improve DoWrite() and Write() #44434

src,stream: improve DoWrite() and Write() #44434

ywave620 commented Aug 29, 2022

nodejs-github-bot commented Aug 29, 2022

RafaelGSS left a comment

ywave620 Aug 31, 2022

RafaelGSS Aug 31, 2022

mcollina Aug 31, 2022

ywave620 Aug 31, 2022 •

edited

Loading

RafaelGSS Aug 31, 2022

mcollina left a comment

This comment was marked as outdated.

nodejs-github-bot commented Sep 1, 2022

ywave620 commented Sep 5, 2022

ywave620 commented Sep 13, 2022

nodejs-github-bot commented Oct 1, 2022

RafaelGSS commented Oct 1, 2022

nodejs-github-bot commented Oct 7, 2022

mcollina commented Oct 7, 2022

ywave620 commented Oct 8, 2022

nodejs-github-bot commented Oct 8, 2022

ywave620 commented Oct 8, 2022

ywave620 commented Oct 8, 2022

mcollina left a comment

mcollina commented Oct 9, 2022

nodejs-github-bot commented Oct 9, 2022

ywave620 commented Oct 10, 2022

nodejs-github-bot commented Oct 10, 2022

src,stream: improve DoWrite() and Write() #44434

src,stream: improve DoWrite() and Write() #44434

Conversation

ywave620 commented Aug 29, 2022

nodejs-github-bot commented Aug 29, 2022

RafaelGSS left a comment

Choose a reason for hiding this comment

ywave620 Aug 31, 2022

Choose a reason for hiding this comment

RafaelGSS Aug 31, 2022

Choose a reason for hiding this comment

mcollina Aug 31, 2022

Choose a reason for hiding this comment

ywave620 Aug 31, 2022 • edited Loading

Choose a reason for hiding this comment

RafaelGSS Aug 31, 2022

Choose a reason for hiding this comment

mcollina left a comment

Choose a reason for hiding this comment

This comment was marked as outdated.

nodejs-github-bot commented Sep 1, 2022

ywave620 commented Sep 5, 2022

ywave620 commented Sep 13, 2022

nodejs-github-bot commented Oct 1, 2022

RafaelGSS commented Oct 1, 2022

nodejs-github-bot commented Oct 7, 2022

mcollina commented Oct 7, 2022

ywave620 commented Oct 8, 2022

nodejs-github-bot commented Oct 8, 2022

ywave620 commented Oct 8, 2022

ywave620 commented Oct 8, 2022

mcollina left a comment

Choose a reason for hiding this comment

mcollina commented Oct 9, 2022

nodejs-github-bot commented Oct 9, 2022

ywave620 commented Oct 10, 2022

nodejs-github-bot commented Oct 10, 2022

ywave620 Aug 31, 2022 •

edited

Loading