cluster: update deprecated API

doc/api/cluster.md

@@ -451,40 +451,6 @@ if (cluster.isMaster) {
 }
 ```
 
-### worker.suicide
-<!-- YAML
-added: v0.7.0
-deprecated: v6.0.0
-changes:
-  - version: v7.0.0
-    pr-url: https://github.com/nodejs/node/pull/3747
-    description: Accessing this property will now emit a deprecation warning.
--->
-
-> Stability: 0 - Deprecated: Use [`worker.exitedAfterDisconnect`][] instead.
-
-An alias to [`worker.exitedAfterDisconnect`][].
-
-Set by calling `.kill()` or `.disconnect()`. Until then, it is `undefined`.
-
-The boolean `worker.suicide` is used to distinguish between voluntary
-and accidental exit, the master may choose not to respawn a worker based on
-this value.
-
-```js
-cluster.on('exit', (worker, code, signal) => {
-  if (worker.suicide === true) {
-    console.log('Oh, it was just voluntary – no need to worry');
-  }
-});
-
-// kill worker
-worker.kill();
-```
-
-This API only exists for backwards compatibility and will be removed in the
-future.
-
 ## Event: 'disconnect'
 <!-- YAML
 added: v0.7.9

doc/api/deprecations.md

@@ -95,12 +95,16 @@ methods, the `options.customFds` option is deprecated. The `options.stdio`
 option should be used instead.
 
 <a id="DEP0007"></a>
-### DEP0007: cluster worker.suicide
+### DEP0007: Replace cluster worker.suicide with worker.exitedAfterDisconnect
 
-Type: Runtime
+Type: End-of-Life
 
-Within the `cluster` module, the [`worker.suicide`][] property has been
-deprecated. Please use [`worker.exitedAfterDisconnect`][] instead.
+In an earlier version of the Node.js `cluster`, a boolean property with the name
+`suicide` was added to the `Worker` object. The intent of this property was to
+provide an indication of how and why the `Worker` instance exited. In Node.js
+6.0.0, the old property was deprecated and replaced with a new
+[worker.exitedAfterDisconnect][] property. The old property name did not
+precisely describe the actual semantics and was unnecessarily emotion-laden.
 
 <a id="DEP0008"></a>
 ### DEP0008: require('constants')
@@ -689,7 +693,6 @@ Type: Runtime
 [`util.puts()`]: util.html#util_util_puts_strings
 [`util`]: util.html
 [`worker.exitedAfterDisconnect`]: cluster.html#cluster_worker_exitedafterdisconnect
-[`worker.suicide`]: cluster.html#cluster_worker_suicide
 [alloc]: buffer.html#buffer_class_method_buffer_alloc_size_fill_encoding
 [alloc_unsafe_size]: buffer.html#buffer_class_method_buffer_allocunsafe_size
 [from_arraybuffer]: buffer.html#buffer_class_method_buffer_from_arraybuffer_byteoffset_length

lib/internal/cluster/worker.js

@@ -3,8 +3,7 @@ const EventEmitter = require('events');
 const internalUtil = require('internal/util');
 const util = require('util');
 const defineProperty = Object.defineProperty;
-const suicideDeprecationMessage =
-    'worker.suicide is deprecated. Please use worker.exitedAfterDisconnect.';
+const deprecationMessage = 'Please use worker.exitedAfterDisconnect.';
 
 module.exports = Worker;
 
@@ -23,11 +22,11 @@ function Worker(options) {
   defineProperty(this, 'suicide', {
     get: internalUtil.deprecate(
       () => this.exitedAfterDisconnect,
-      suicideDeprecationMessage, 'DEP0007'),
+      deprecationMessage, 'DEP0007'),
     set: internalUtil.deprecate(
       (val) => { this.exitedAfterDisconnect = val; },
-      suicideDeprecationMessage, 'DEP0007'),
-    enumerable: true
+      deprecationMessage, 'DEP0007'),
+    enumerable: false
   });
 
   this.state = options.state || 'none';

test/parallel/test-cluster-worker-constructor.js

@@ -29,7 +29,7 @@ const cluster = require('cluster');
 let worker;
 
 worker = new cluster.Worker();
-assert.strictEqual(worker.suicide, undefined);
+assert.strictEqual(worker.exitedAfterDisconnect, undefined);
 assert.strictEqual(worker.state, 'none');
 assert.strictEqual(worker.id, 0);
 assert.strictEqual(worker.process, undefined);
@@ -39,7 +39,7 @@ worker = new cluster.Worker({
   state: 'online',
   process: process
 });
-assert.strictEqual(worker.suicide, undefined);
+assert.strictEqual(worker.exitedAfterDisconnect, undefined);
 assert.strictEqual(worker.state, 'online');
 assert.strictEqual(worker.id, 3);
 assert.strictEqual(worker.process, process);

test/parallel/test-cluster-worker-disconnect.js

@@ -29,12 +29,8 @@ if (cluster.isWorker) {
   http.Server(() => {
 
   }).listen(0, '127.0.0.1');
-  const worker = cluster.worker;
-  assert.strictEqual(worker.exitedAfterDisconnect, worker.suicide);
 
   cluster.worker.on('disconnect', common.mustCall(() => {
-    assert.strictEqual(cluster.worker.exitedAfterDisconnect,
-                       cluster.worker.suicide);
     process.exit(42);
   }));
 

test/parallel/test-cluster-worker-exit.js

@@ -52,7 +52,6 @@ if (cluster.isWorker) {
     worker_emitDisconnect: [1, "the worker did not emit 'disconnect'"],
     worker_emitExit: [1, "the worker did not emit 'exit'"],
     worker_state: ['disconnected', 'the worker state is incorrect'],
-    worker_suicideMode: [false, 'the worker.suicide flag is incorrect'],
     worker_exitedAfterDisconnect: [
       false, 'the .exitedAfterDisconnect flag is incorrect'
     ],
@@ -84,7 +83,6 @@ if (cluster.isWorker) {
   // Check worker events and properties
   worker.on('disconnect', common.mustCall(() => {
     results.worker_emitDisconnect += 1;
-    results.worker_suicideMode = worker.suicide;
     results.worker_exitedAfterDisconnect = worker.exitedAfterDisconnect;
     results.worker_state = worker.state;
     if (results.worker_emitExit > 0) {

test/parallel/test-regress-GH-3238.js

@@ -7,11 +7,11 @@ if (cluster.isMaster) {
   function forkWorker(action) {
     const worker = cluster.fork({ action });
     worker.on('disconnect', common.mustCall(() => {
-      assert.strictEqual(worker.suicide, true);
+      assert.strictEqual(worker.exitedAfterDisconnect, true);
     }));
 
     worker.on('exit', common.mustCall(() => {
-      assert.strictEqual(worker.suicide, true);
+      assert.strictEqual(worker.exitedAfterDisconnect, true);
     }));
   }