http: add default argument for Agent.prototype.getName

PR-URL: nodejs#41906 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Ricky Zhou <[email protected]> Reviewed-By: Mestery <[email protected]>
danielleadams · Apr 21, 2022 · 3470169 · 3470169
1 parent d882bfd
commit 3470169
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 4 deletions.
diff --git a/doc/api/http.md b/doc/api/http.md
@@ -294,10 +294,14 @@ the agent when `keepAlive` is enabled. Do not modify.
 Sockets in the `freeSockets` list will be automatically destroyed and
 removed from the array on `'timeout'`.
 
-### `agent.getName(options)`
+### `agent.getName([options])`
 
 <!-- YAML
 added: v0.11.4
+changes:
+  - version: REPLACEME
+    pr-url: https://github.com/nodejs/node/pull/41906
+    description: The `options` parameter is now optional.
 -->
 
 * `options` {Object} A set of options providing information for name generation

diff --git a/lib/_http_agent.js b/lib/_http_agent.js
@@ -217,7 +217,7 @@ Agent.defaultMaxSockets = Infinity;
 Agent.prototype.createConnection = net.createConnection;
 
 // Get the key for a given set of request options
-Agent.prototype.getName = function getName(options) {
+Agent.prototype.getName = function getName(options = {}) {
   let name = options.host || 'localhost';
 
   name += ':';

diff --git a/lib/https.js b/lib/https.js
@@ -203,7 +203,7 @@ Agent.prototype.createConnection = createConnection;
  *   }} [options]
  * @returns {string}
  */
-Agent.prototype.getName = function getName(options) {
+Agent.prototype.getName = function getName(options = {}) {
   let name = FunctionPrototypeCall(HttpAgent.prototype.getName, this, options);
 
   name += ':';

diff --git a/test/parallel/test-http-agent-getname.js b/test/parallel/test-http-agent-getname.js
@@ -18,7 +18,13 @@ assert.strictEqual(
   'localhost:80:192.168.1.1'
 );
 
-// empty
+// empty argument
+assert.strictEqual(
+  agent.getName(),
+  'localhost::'
+);
+
+// empty options
 assert.strictEqual(
   agent.getName({}),
   'localhost::'

diff --git a/test/parallel/test-https-agent-getname.js b/test/parallel/test-https-agent-getname.js
@@ -9,6 +9,12 @@ const https = require('https');
 
 const agent = new https.Agent();
 
+// empty argument
+assert.strictEqual(
+  agent.getName(),
+  'localhost::::::::::::::::::::::'
+);
+
 // empty options
 assert.strictEqual(
   agent.getName({}),