cluster: expose result of send()

cjihrig · Myles Borins · commit b902fdab5817 · 2016-07-14T12:47:40.000-07:00
There are several places in the cluster module where a version of process.send() is called, but the result is swallowed. Most of these cases are internal, but Worker.prototype.send(), which is publicly documented, also suffers from this problem. This commit exposes the return value to facilitate better error handling, and bring Worker.prototype.send() into compliance with the documentation. PR-URL: #6998 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ron Korving <ron@ronkorving.nl> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
diff --git a/lib/cluster.js b/lib/cluster.js
@@ -48,7 +48,7 @@ Worker.prototype.kill = function() {
 };
 
 Worker.prototype.send = function() {
-  this.process.send.apply(this.process, arguments);
+  return this.process.send.apply(this.process, arguments);
 };
 
 Worker.prototype.isDead = function isDead() {
@@ -518,7 +518,7 @@ function masterInit() {
   }
 
   function send(worker, message, handle, cb) {
-    sendHelper(worker.process, message, handle, cb);
+    return sendHelper(worker.process, message, handle, cb);
   }
 }
 
@@ -684,7 +684,7 @@ function workerInit() {
   };
 
   function send(message, cb) {
-    sendHelper(process, message, null, cb);
+    return sendHelper(process, message, null, cb);
   }
 
   function _disconnect(masterInitiated) {
@@ -732,7 +732,7 @@ function sendHelper(proc, message, handle, cb) {
   if (cb) callbacks[seq] = cb;
   message.seq = seq;
   seq += 1;
-  proc.send(message, handle);
+  return proc.send(message, handle);
 }
 
 
diff --git a/test/parallel/test-cluster-fork-env.js b/test/parallel/test-cluster-fork-env.js
@@ -4,11 +4,12 @@ var assert = require('assert');
 var cluster = require('cluster');
 
 if (cluster.isWorker) {
-  cluster.worker.send({
+  const result = cluster.worker.send({
     prop: process.env['cluster_test_prop'],
     overwrite: process.env['cluster_test_overwrite']
   });
 
+  assert.strictEqual(result, true);
 } else if (cluster.isMaster) {
 
   var checks = {
diff --git a/test/parallel/test-cluster-worker-events.js b/test/parallel/test-cluster-worker-events.js
@@ -14,7 +14,8 @@ if (cluster.isMaster) {
     process.exit(0);
   });
 
-  worker.send('SOME MESSAGE');
+  const result = worker.send('SOME MESSAGE');
+  assert.strictEqual(result, true);
 
   return;
 }

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ Worker.prototype.kill = function() {`
`48`	`48`	`};`
`49`	`49`
`50`	`50`	`Worker.prototype.send = function() {`
`51`		`- this.process.send.apply(this.process, arguments);`
	`51`	`+ return this.process.send.apply(this.process, arguments);`
`52`	`52`	`};`
`53`	`53`
`54`	`54`	`Worker.prototype.isDead = function isDead() {`
`@@ -518,7 +518,7 @@ function masterInit() {`
`518`	`518`	`}`
`519`	`519`
`520`	`520`	`function send(worker, message, handle, cb) {`
`521`		`- sendHelper(worker.process, message, handle, cb);`
	`521`	`+ return sendHelper(worker.process, message, handle, cb);`
`522`	`522`	`}`
`523`	`523`	`}`
`524`	`524`
`@@ -684,7 +684,7 @@ function workerInit() {`
`684`	`684`	`};`
`685`	`685`
`686`	`686`	`function send(message, cb) {`
`687`		`- sendHelper(process, message, null, cb);`
	`687`	`+ return sendHelper(process, message, null, cb);`
`688`	`688`	`}`
`689`	`689`
`690`	`690`	`function _disconnect(masterInitiated) {`
`@@ -732,7 +732,7 @@ function sendHelper(proc, message, handle, cb) {`
`732`	`732`	`if (cb) callbacks[seq] = cb;`
`733`	`733`	`message.seq = seq;`
`734`	`734`	`seq += 1;`
`735`		`- proc.send(message, handle);`
	`735`	`+ return proc.send(message, handle);`
`736`	`736`	`}`
`737`	`737`
`738`	`738`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,8 @@ if (cluster.isMaster) {`
`14`	`14`	`process.exit(0);`
`15`	`15`	`});`
`16`	`16`
`17`		`- worker.send('SOME MESSAGE');`
	`17`	`+ const result = worker.send('SOME MESSAGE');`
	`18`	`+ assert.strictEqual(result, true);`
`18`	`19`
`19`	`20`	`return;`
`20`	`21`	`}`