lib,doc: return boolean from child.send() #3516

Trott · 2015-10-25T18:55:13Z

The documentation indicates that child.send() returns a boolean but it
has returned undefined at least since io.js v1. This PR makes it so it returns a
boolean per the (slightly updated) documentation.

Trott · 2015-10-25T18:56:14Z

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

Fishrock123 · 2015-10-26T17:33:00Z

Seems fine to me, is this Major? I can't imagine anyone doing anything other than if (returnVal) checking it.

Trott · 2015-10-27T18:21:30Z

A more cautious alternative is #3518. While this one updates the code to conform to the documentation, that one updates the documentation to conform to the code. Which is the right path? ¯\_(ツ)_/¯

Trott · 2015-10-28T02:19:58Z

/cc @rvagg @jasnell for help with semver determination

rvagg · 2015-10-28T04:25:54Z

semver-minor IMO

bnoordhuis · 2015-10-28T11:21:04Z

lib/internal/child_process.js

@@ -577,7 +577,7 @@ function setupChannel(target, channel) {
        handle: null,
        message: message,
      });
-      return;
+      return this._handleQueue.length < (65536 * 2);


128k queued messages is perhaps a bit much. Maybe return false when the length is > 1?

Sure. If the threshold is 1, I should probably add a test for that if it's possible to induce it without a ton of load or anything.

The documentation indicates that child.send() returns a boolean but it has returned undefinined at least since io.js v1. It now returns a boolean per the (slightly updated) documentation.

jasnell · 2015-10-28T16:12:57Z

I'd agree with semver-minor as @rvagg indicates (which, of course, takes it out of the v4.x queue)

bnoordhuis · 2015-10-28T16:36:53Z

lib/internal/child_process.js

@@ -577,7 +577,7 @@ function setupChannel(target, channel) {
        handle: null,
        message: message,
      });
-      return;
+      return this._handleQueue.length < 1;


This is logically always false. :-)

Doh! Fixed.

bnoordhuis · 2015-10-28T17:11:58Z

LGTM

Trott · 2015-10-28T17:44:13Z

I'll land this and close #3518 in about six hours unless there's an objection.

The documentation indicates that child.send() returns a boolean but it has returned undefinined at since v0.12.0. It now returns a boolean per the (slightly updated) documentation. PR-URL: #3516 Reviewed-By: Ben Noordhuis <[email protected]>

Trott · 2015-10-28T23:22:53Z

Landed in cdcf00a

The documentation indicates that child.send() returns a boolean but it has returned undefinined at since v0.12.0. It now returns a boolean per the (slightly updated) documentation. PR-URL: nodejs#3516 Reviewed-By: Ben Noordhuis <[email protected]>

MylesBorins · 2016-07-14T19:00:46Z

@nodejs/lts should we consider including this in v4.5.0?

The documentation indicates that child.send() returns a boolean but it has returned undefinined at since v0.12.0. It now returns a boolean per the (slightly updated) documentation. PR-URL: nodejs#3516 Reviewed-By: Ben Noordhuis <[email protected]>

rvagg · 2016-07-18T05:55:25Z

a soft -1 on LTS for this from me @thealphanerd

MylesBorins · 2016-07-18T06:09:28Z

thanks @rvagg would you be willing to drop the sentiment in #7739

Trott added child_process Issues and PRs related to the child_process subsystem. doc Issues and PRs related to the documentations. labels Oct 25, 2015

Trott mentioned this pull request Oct 25, 2015

doc,lib: correct child.send() return value docs #3518

Closed

jasnell added the lts-watch-v4.x label Oct 26, 2015

rvagg added the semver-minor PRs that contain new features and should be released in the next minor version. label Oct 28, 2015

bnoordhuis reviewed Oct 28, 2015
View reviewed changes

Trott added 2 commits October 28, 2015 08:49

lib,doc: return boolean from child.send()

4456a33

The documentation indicates that child.send() returns a boolean but it has returned undefinined at least since io.js v1. It now returns a boolean per the (slightly updated) documentation.

fixup: it is going to be true

2779bfb

jasnell removed the lts-watch-v4.x label Oct 28, 2015

fixup: 128K -> 1

0f09b7c

Trott force-pushed the child-send branch from 259454d to 0f09b7c Compare October 28, 2015 16:35

bnoordhuis reviewed Oct 28, 2015
View reviewed changes

fixup: doh!

08ccde9

fixup: rename test file to conform to other files

eba271a

bnoordhuis mentioned this pull request Oct 28, 2015

child_process: fork() from -e does not exit #3574

Closed

Trott closed this Oct 28, 2015

rvagg mentioned this pull request Oct 29, 2015

Release proposal: v5.0.0 #3466

Merged

MylesBorins mentioned this pull request Jan 6, 2016

lib: return boolean from child.send() #3577

Closed

cjihrig mentioned this pull request Jul 12, 2016

cluster: expose result of send() #6998

Merged

3 tasks

MylesBorins added the dont-land-on-v4.x label Jul 14, 2016

MylesBorins mentioned this pull request Jul 14, 2016

Child.send boolean #7739

Closed

4 tasks

Trott deleted the child-send branch January 13, 2022 22:29

Uh oh!

lib,doc: return boolean from child.send() #3516

lib,doc: return boolean from child.send() #3516

Uh oh!

Conversation

Trott commented Oct 25, 2015

Uh oh!

Trott commented Oct 25, 2015

Uh oh!

Fishrock123 commented Oct 26, 2015

Uh oh!

Trott commented Oct 27, 2015

Uh oh!

Trott commented Oct 28, 2015

Uh oh!

rvagg commented Oct 28, 2015

Uh oh!

bnoordhuis Oct 28, 2015

Choose a reason for hiding this comment

Uh oh!

Trott Oct 28, 2015

Choose a reason for hiding this comment

Uh oh!

jasnell commented Oct 28, 2015

Uh oh!

bnoordhuis Oct 28, 2015

Choose a reason for hiding this comment

Uh oh!

Trott Oct 28, 2015

Choose a reason for hiding this comment

Uh oh!

bnoordhuis commented Oct 28, 2015

Uh oh!

Trott commented Oct 28, 2015

Uh oh!

Trott commented Oct 28, 2015

Uh oh!

MylesBorins commented Jul 14, 2016

Uh oh!

rvagg commented Jul 18, 2016

Uh oh!

MylesBorins commented Jul 18, 2016

Uh oh!

Uh oh!