From ebcb8306a53182af61aa9ecf50d4c58ad457f7f4 Mon Sep 17 00:00:00 2001
From: gpotter2 <gabriel@potter.fr>
Date: Sat, 2 Jun 2018 22:21:50 +0200
Subject: [PATCH] process: make getActive{Handles,Requests} official

Make process.getActiveHandles() and make.getActiveRequests() official
and deprecate the older process._getActiveHandles() and
process._getActiveRequests(). Also add a small documentation
---
 doc/api/deprecations.md                       |  9 ++++++
 doc/api/process.md                            | 29 +++++++++++++++++++
 lib/internal/bootstrap/node.js                | 14 +++++++++
 src/node.cc                                   |  4 +--
 .../parallel/test-process-getactivehandles.js |  2 +-
 test/pseudo-tty/ref_keeps_node_running.js     |  2 +-
 test/pummel/test-net-connect-econnrefused.js  |  4 +--
 7 files changed, 58 insertions(+), 6 deletions(-)

diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md
index 0b4d4986e16e64..b65bf0c72ffe6a 100644
--- a/doc/api/deprecations.md
+++ b/doc/api/deprecations.md
@@ -1005,6 +1005,15 @@ accepted by the legacy `url.parse()` API. The mentioned APIs now use the WHATWG
 URL parser that requires strictly valid URLs. Passing an invalid URL is
 deprecated and support will be removed in the future.
 
+<a id="DEP0110"></a>
+### DEP0110: _getActiveHandles and _getActiveRequests
+
+Type: Runtime
+
+As `process.getActiveHandles()` and `process.getActiveRequests()` are
+officially supported and documented, their previous names are now deprecated,
+and will be removed in the future.
+
 [`--pending-deprecation`]: cli.html#cli_pending_deprecation
 [`Buffer.allocUnsafeSlow(size)`]: buffer.html#buffer_class_method_buffer_allocunsafeslow_size
 [`Buffer.from(array)`]: buffer.html#buffer_class_method_buffer_from_array
diff --git a/doc/api/process.md b/doc/api/process.md
index e6612278b6bc4a..d6b50ee5febeed 100644
--- a/doc/api/process.md
+++ b/doc/api/process.md
@@ -1053,6 +1053,35 @@ a code.
 Specifying a code to [`process.exit(code)`][`process.exit()`] will override any
 previous setting of `process.exitCode`.
 
+## process.getActiveHandles()
+<!-- YAML
+added: REPLACEME
+-->
+
+* Returns: {Array}
+
+Returns an array containing all handles that are preventing the Node.js process
+from exiting. Be aware that the returned handles may not always correspond to
+the user-created handles, but instead to an internal one.
+
+```js
+console.log(`Active handles: ${util.inspect(process.getActiveHandles())}`);
+```
+
+## process.getActiveRequests()
+<!-- YAML
+added: REPLACEME
+-->
+
+* Returns: {Array}
+
+Returns an array containing all requests that are preventing the Node.js process
+from exiting.
+
+```js
+console.log(`Active requests: ${util.inspect(process.getActiveRequests())}`);
+```
+
 ## process.getegid()
 <!-- YAML
 added: v2.0.0
diff --git a/lib/internal/bootstrap/node.js b/lib/internal/bootstrap/node.js
index b6233b17e24fa6..e70f9046d74de4 100644
--- a/lib/internal/bootstrap/node.js
+++ b/lib/internal/bootstrap/node.js
@@ -289,6 +289,20 @@
   function setupProcessObject() {
     _setupProcessObject(pushValueToArray);
 
+    const util = NativeModule.require('util');
+    process._getActiveHandles = util.deprecate(
+      process.getActiveHandles,
+      "'process._getActiveHandles' is deprecated, " +
+      "use 'process.getActiveHandles' instead",
+      'DEP0110'
+    );
+    process._getActiveRequests = util.deprecate(
+      process.getActiveRequests,
+      "'process._getActiveRequests' is deprecated, " +
+      "use 'process.getActiveRequests' instead",
+      'DEP0110'
+    );
+
     function pushValueToArray() {
       for (var i = 0; i < arguments.length; i++)
         this.push(arguments[i]);
diff --git a/src/node.cc b/src/node.cc
index 292307e9dae788..881fb5d1d934c6 100644
--- a/src/node.cc
+++ b/src/node.cc
@@ -2248,8 +2248,8 @@ void SetupProcessObject(Environment* env,
     env->SetMethod(process, "chdir", Chdir);
     env->SetMethod(process, "umask", Umask);
   }
-  env->SetMethod(process, "_getActiveRequests", GetActiveRequests);
-  env->SetMethod(process, "_getActiveHandles", GetActiveHandles);
+  env->SetMethod(process, "getActiveRequests", GetActiveRequests);
+  env->SetMethod(process, "getActiveHandles", GetActiveHandles);
   env->SetMethod(process, "_kill", Kill);
 
   env->SetMethod(process, "cwd", Cwd);
diff --git a/test/parallel/test-process-getactivehandles.js b/test/parallel/test-process-getactivehandles.js
index 2db3da3c563e6e..eb58c06f4cf4c4 100644
--- a/test/parallel/test-process-getactivehandles.js
+++ b/test/parallel/test-process-getactivehandles.js
@@ -30,7 +30,7 @@ function clientConnected(client) {
 
 
 function checkAll() {
-  const handles = process._getActiveHandles();
+  const handles = process.getActiveHandles();
 
   clients.forEach(function(item) {
     assert.ok(handles.includes(item));
diff --git a/test/pseudo-tty/ref_keeps_node_running.js b/test/pseudo-tty/ref_keeps_node_running.js
index 7832e9ee21ba26..4e50b0d8a9975f 100644
--- a/test/pseudo-tty/ref_keeps_node_running.js
+++ b/test/pseudo-tty/ref_keeps_node_running.js
@@ -12,7 +12,7 @@ handle.readStart();
 handle.onread = () => {};
 
 function isHandleActive(handle) {
-  return process._getActiveHandles().some((active) => active === handle);
+  return process.getActiveHandles().some((active) => active === handle);
 }
 
 strictEqual(isHandleActive(handle), true, 'TTY handle not initially active');
diff --git a/test/pummel/test-net-connect-econnrefused.js b/test/pummel/test-net-connect-econnrefused.js
index 4f9110172af8e3..3355b8323b0d55 100644
--- a/test/pummel/test-net-connect-econnrefused.js
+++ b/test/pummel/test-net-connect-econnrefused.js
@@ -51,8 +51,8 @@ function pummel() {
 
 function check() {
   setTimeout(function() {
-    assert.strictEqual(process._getActiveRequests().length, 0);
-    assert.strictEqual(process._getActiveHandles().length, 1); // the timer
+    assert.strictEqual(process.getActiveRequests().length, 0);
+    assert.strictEqual(process.getActiveHandles().length, 1); // the timer
     check_called = true;
   }, 0);
 }