From cdcf00a0b9016982d1d20cce00003e397c302723 Mon Sep 17 00:00:00 2001
From: Rich Trott <rtrott@gmail.com>
Date: Sun, 25 Oct 2015 11:48:41 -0700
Subject: [PATCH] lib,doc: return boolean from child.send()

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: https://github.com/nodejs/node/pull/3516
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
---
 doc/api/child_process.markdown                           | 5 +++--
 lib/internal/child_process.js                            | 6 +++---
 test/parallel/test-child-process-send-returns-boolean.js | 9 +++++++++
 3 files changed, 15 insertions(+), 5 deletions(-)
 create mode 100644 test/parallel/test-child-process-send-returns-boolean.js

diff --git a/doc/api/child_process.markdown b/doc/api/child_process.markdown
index 13997d6545..954354cc32 100644
--- a/doc/api/child_process.markdown
+++ b/doc/api/child_process.markdown
@@ -266,9 +266,10 @@ argument: `null` on success, or an `Error` object on failure.
 `child.send()` emits an `'error'` event if no callback was given and the message
 cannot be sent, for example because the child process has already exited.
 
-Returns `true` under normal circumstances or `false` when the backlog of
+`child.send()` returns `false` if the channel has closed or when the backlog of
 unsent messages exceeds a threshold that makes it unwise to send more.
-Use the callback mechanism to implement flow control.
+Otherwise, it returns `true`. Use the callback mechanism to implement flow
+control.
 
 #### Example: sending server object
 
diff --git a/lib/internal/child_process.js b/lib/internal/child_process.js
index 8c1abc5f74..da213955a5 100644
--- a/lib/internal/child_process.js
+++ b/lib/internal/child_process.js
@@ -504,8 +504,7 @@ function setupChannel(target, channel) {
       handle = undefined;
     }
     if (this.connected) {
-      this._send(message, handle, false, callback);
-      return;
+      return this._send(message, handle, false, callback);
     }
     const ex = new Error('channel closed');
     if (typeof callback === 'function') {
@@ -513,6 +512,7 @@ function setupChannel(target, channel) {
     } else {
       this.emit('error', ex);  // FIXME(bnoordhuis) Defer to next tick.
     }
+    return false;
   };
 
   target._send = function(message, handle, swallowErrors, callback) {
@@ -577,7 +577,7 @@ function setupChannel(target, channel) {
         handle: null,
         message: message,
       });
-      return;
+      return this._handleQueue.length === 1;
     }
 
     var req = new WriteWrap();
diff --git a/test/parallel/test-child-process-send-returns-boolean.js b/test/parallel/test-child-process-send-returns-boolean.js
new file mode 100644
index 0000000000..b751846947
--- /dev/null
+++ b/test/parallel/test-child-process-send-returns-boolean.js
@@ -0,0 +1,9 @@
+'use strict';
+const common = require('../common');
+const assert = require('assert');
+const fork = require('child_process').fork;
+
+const n = fork(common.fixturesDir + '/empty.js');
+
+const rv = n.send({ hello: 'world' });
+assert.strictEqual(rv, true);