feat: Allow disabling autoSelectFamily in an Agent (#4070)

* Allow disabling autoSelectFamily in an Agent

Currently the options are only passed if they enable autoSelectFamily. However, if autoSelectFamily is the default, we want to be able to disable it too.

* Fix the autoSelectFamily error in client too.

- Also add tests.
- Fix types so that partial options can be passed
  to buildConnector without violating the TypeScript.
  For example, TcpNet options require 'port' but the options
  we pass should not.

---------

Co-authored-by: Carlos Fuentes <[email protected]>

Author: hitsthings

lib/dispatcher/client.js

@@ -207,7 +207,7 @@ class Client extends DispatcherBase {
         allowH2,
         socketPath,
         timeout: connectTimeout,
-        ...(autoSelectFamily ? { autoSelectFamily, autoSelectFamilyAttemptTimeout } : undefined),
+        ...(typeof autoSelectFamily === 'boolean' ? { autoSelectFamily, autoSelectFamilyAttemptTimeout } : undefined),
         ...connect
       })
     }

lib/dispatcher/pool.js

@@ -58,7 +58,7 @@ class Pool extends PoolBase {
         allowH2,
         socketPath,
         timeout: connectTimeout,
-        ...(autoSelectFamily ? { autoSelectFamily, autoSelectFamilyAttemptTimeout } : undefined),
+        ...(typeof autoSelectFamily === 'boolean' ? { autoSelectFamily, autoSelectFamilyAttemptTimeout } : undefined),
         ...connect
       })
     }

test/node-test/autoselectfamily.js

@@ -172,6 +172,34 @@ test('with autoSelectFamily disabled the request fails when using request', { sk
   await p.completed
 })
 
+test('with autoSelectFamily disabled via Agent.Options["autoSelectFamily"] the request fails when using request', { skip }, async (t) => {
+  const p = tspl(t, { plan: 1 })
+
+  createDnsServer('::1', '127.0.0.1', function (_, { dnsServer, lookup }) {
+    const server = createServer((req, res) => {
+      res.end('hello')
+    })
+
+    t.after(() => {
+      server.close()
+      dnsServer.close()
+    })
+
+    server.listen(0, '127.0.0.1', () => {
+      const agent = new Agent({ autoSelectFamily: false, connect: { lookup } })
+
+      request(`http://example.org:${server.address().port}`, {
+        method: 'GET',
+        dispatcher: agent
+      }, (err, { statusCode, body }) => {
+        p.ok(['ECONNREFUSED', 'EAFNOSUPPORT'].includes(err.code))
+      })
+    })
+  })
+
+  await p.completed
+})
+
 test('with autoSelectFamily disabled the request fails when using a client', { skip }, async (t) => {
   const p = tspl(t, { plan: 1 })
 
@@ -200,3 +228,32 @@ test('with autoSelectFamily disabled the request fails when using a client', { s
 
   await p.completed
 })
+
+test('with autoSelectFamily disabled via Client.Options["autoSelectFamily"] the request fails when using a client', { skip }, async (t) => {
+  const p = tspl(t, { plan: 1 })
+
+  createDnsServer('::1', '127.0.0.1', function (_, { dnsServer, lookup }) {
+    const server = createServer((req, res) => {
+      res.end('hello')
+    })
+
+    t.after(() => {
+      server.close()
+      dnsServer.close()
+    })
+
+    server.listen(0, '127.0.0.1', () => {
+      const client = new Client(`http://example.org:${server.address().port}`, { autoSelectFamily: false, connect: { lookup } })
+      t.after(client.destroy.bind(client))
+
+      client.request({
+        path: '/',
+        method: 'GET'
+      }, (err, { statusCode, body }) => {
+        p.ok(['ECONNREFUSED', 'EAFNOSUPPORT'].includes(err.code))
+      })
+    })
+  })
+
+  await p.completed
+})

types/client.d.ts

@@ -70,7 +70,7 @@ export declare namespace Client {
     /** TODO */
     maxRedirections?: number;
     /** TODO */
-    connect?: buildConnector.BuildOptions | buildConnector.connector;
+    connect?: Partial<buildConnector.BuildOptions> | buildConnector.connector;
     /** TODO */
     maxRequestsPerClient?: number;
     /** TODO */