From 08ebbb31cf57701032ee0111380e588f48922bca Mon Sep 17 00:00:00 2001
From: isaacs <i@izs.me>
Date: Wed, 14 Jun 2017 19:32:18 +0200
Subject: [PATCH] cluster: remove deprecated problematic API

Content Warning: mental health and self-harm triggers.

---

The word "suicide" was used in the cluster API 4 years ago.  This was a
serious mistake for several reasons.  It was deprecated in version 6,
and long past time for full removal now.

First, and most important, casual use of words referring to self-harm
serve to stigmatize mental illness and make it harder for people in our
community to literally stay alive.  It is impossible to claim that we
intend to be inclusive and welcoming, and also casually show such
disrespect for the lives of those in our community.  Some of us have
lost friends or struggled with mental illness.  Leaving this lying
around tells us that we are not welcome.

Second, in addition to being just wildly inappropriate on ethical and
community grounds, the term "suicide" was never even appropriate
technically!  In context, it refers to a case where a child process
exits without receiving a fatal signal from the parent process.  The
"cute" unix joke here is that the process "killed itself".  However, the
"suicide" flag is set regardless of how the process exited, so in
addition to being offensive and harmful, it is also misleading and
incorrect, and has always been so.  (It could've thrown an error, called
`process.exit()` or received a fatal signal from some other process.)

An open source project is not the place for emotional landmines.  It's
distracting and misleading at best, and actively harmful at worst.
There is no justification for it.  The API has already been renamed, and
it's an obscure surface that is unlikely to ever be used outside of
core.
---
 doc/api/cluster.md                            | 34 -------------------
 doc/api/deprecations.md                       | 10 ------
 lib/internal/cluster/worker.js                | 14 --------
 ...st-cluster-disconnect-afterexited-race.js} |  0
 .../test-cluster-worker-constructor.js        |  4 +--
 .../test-cluster-worker-deprecated.js         |  8 ++---
 .../test-cluster-worker-disconnect.js         |  4 ---
 test/parallel/test-cluster-worker-exit.js     |  2 --
 test/parallel/test-regress-GH-3238.js         |  4 +--
 9 files changed, 8 insertions(+), 72 deletions(-)
 rename test/parallel/{test-cluster-disconnect-suicide-race.js => test-cluster-disconnect-afterexited-race.js} (100%)

diff --git a/doc/api/cluster.md b/doc/api/cluster.md
index c7d8359ac0ce93..721b33a7e184f1 100644
--- a/doc/api/cluster.md
+++ b/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
diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md
index 6a7a4a4c7ef59a..bd6141645ce363 100644
--- a/doc/api/deprecations.md
+++ b/doc/api/deprecations.md
@@ -94,14 +94,6 @@ Within the [`child_process`][] module's `spawn()`, `fork()`, and `exec()`
 methods, the `options.customFds` option is deprecated. The `options.stdio`
 option should be used instead.
 
-<a id="DEP0007"></a>
-### DEP0007: cluster worker.suicide
-
-Type: Runtime
-
-Within the `cluster` module, the [`worker.suicide`][] property has been
-deprecated. Please use [`worker.exitedAfterDisconnect`][] instead.
-
 <a id="DEP0008"></a>
 ### DEP0008: require('constants')
 
@@ -688,8 +680,6 @@ Type: Runtime
 [`util.print()`]: util.html#util_util_print_strings
 [`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
diff --git a/lib/internal/cluster/worker.js b/lib/internal/cluster/worker.js
index 687e4c12fecea4..2cf5fc385809c7 100644
--- a/lib/internal/cluster/worker.js
+++ b/lib/internal/cluster/worker.js
@@ -1,10 +1,6 @@
 'use strict';
 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.';
 
 module.exports = Worker;
 
@@ -20,16 +16,6 @@ function Worker(options) {
 
   this.exitedAfterDisconnect = undefined;
 
-  defineProperty(this, 'suicide', {
-    get: internalUtil.deprecate(
-      () => this.exitedAfterDisconnect,
-      suicideDeprecationMessage, 'DEP0007'),
-    set: internalUtil.deprecate(
-      (val) => { this.exitedAfterDisconnect = val; },
-      suicideDeprecationMessage, 'DEP0007'),
-    enumerable: true
-  });
-
   this.state = options.state || 'none';
   this.id = options.id | 0;
 
diff --git a/test/parallel/test-cluster-disconnect-suicide-race.js b/test/parallel/test-cluster-disconnect-afterexited-race.js
similarity index 100%
rename from test/parallel/test-cluster-disconnect-suicide-race.js
rename to test/parallel/test-cluster-disconnect-afterexited-race.js
diff --git a/test/parallel/test-cluster-worker-constructor.js b/test/parallel/test-cluster-worker-constructor.js
index a8094e34df9c72..06a1ad774ccc51 100644
--- a/test/parallel/test-cluster-worker-constructor.js
+++ b/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);
diff --git a/test/parallel/test-cluster-worker-deprecated.js b/test/parallel/test-cluster-worker-deprecated.js
index 2f433aae797ccc..fbace234143fa1 100644
--- a/test/parallel/test-cluster-worker-deprecated.js
+++ b/test/parallel/test-cluster-worker-deprecated.js
@@ -7,12 +7,12 @@ const cluster = require('cluster');
 const worker = new cluster.Worker();
 
 assert.strictEqual(worker.exitedAfterDisconnect, undefined);
-assert.strictEqual(worker.suicide, undefined);
+assert.strictEqual(worker.exitedAfterDisconnect, undefined);
 
 worker.exitedAfterDisconnect = 'recommended';
 assert.strictEqual(worker.exitedAfterDisconnect, 'recommended');
-assert.strictEqual(worker.suicide, 'recommended');
+assert.strictEqual(worker.exitedAfterDisconnect, 'recommended');
 
-worker.suicide = 'deprecated';
+worker.exitedAfterDisconnect = 'deprecated';
+assert.strictEqual(worker.exitedAfterDisconnect, 'deprecated');
 assert.strictEqual(worker.exitedAfterDisconnect, 'deprecated');
-assert.strictEqual(worker.suicide, 'deprecated');
diff --git a/test/parallel/test-cluster-worker-disconnect.js b/test/parallel/test-cluster-worker-disconnect.js
index 0554671fea3b61..1c5a7fc3ae51f9 100644
--- a/test/parallel/test-cluster-worker-disconnect.js
+++ b/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);
   }));
 
diff --git a/test/parallel/test-cluster-worker-exit.js b/test/parallel/test-cluster-worker-exit.js
index 75a271278f6d30..ba9c4f8775760e 100644
--- a/test/parallel/test-cluster-worker-exit.js
+++ b/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) {
diff --git a/test/parallel/test-regress-GH-3238.js b/test/parallel/test-regress-GH-3238.js
index e6fe030bda9a10..dd65d849d57503 100644
--- a/test/parallel/test-regress-GH-3238.js
+++ b/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);
     }));
   }