dns: default to verbatim=true in dns.lookup()

Switch the default from false (reorder the result so that IPv4 addresses come before IPv6 addresses) to true (return them exactly as the resolver sent them to us.) Fixes: #31566 Refs: #6307 Refs: #20710 Reissue of #31567 Reissue of #37681
nodejs · treysis · Jan 29, 2020 · Mar 27, 2021 · Mar 27, 2021 · Mar 27, 2021
commit 90a5e9389633055e9359b8099ddd0132eb86933b
diff --git a/doc/api/dns.md b/doc/api/dns.md
@@ -163,6 +163,9 @@ section if a custom port is used.
 <!-- YAML
 added: v0.1.90
 changes:
+  - version: REPLACEME
+    pr-url: https://github.com/nodejs/node/pull/37681
+    description: The `verbatim` options defaults to `true` now.
   - version: v8.5.0
     pr-url: https://github.com/nodejs/node/pull/14731
     description: The `verbatim` option is supported now.
@@ -183,9 +186,7 @@ changes:
   * `verbatim` {boolean} When `true`, the callback receives IPv4 and IPv6
     addresses in the order the DNS resolver returned them. When `false`,
     IPv4 addresses are placed before IPv6 addresses.
-    **Default:** currently `false` (addresses are reordered) but this is
-    expected to change in the not too distant future.
-    New code should use `{ verbatim: true }`.
+    **Default:** `true`.
 * `callback` {Function}
   * `err` {Error}
   * `address` {string} A string representation of an IPv4 or IPv6 address.

diff --git a/lib/dns.js b/lib/dns.js
@@ -96,7 +96,7 @@ function lookup(hostname, options, callback) {
   let hints = 0;
   let family = -1;
   let all = false;
-  let verbatim = false;
+  let verbatim = true;
 
   // Parse arguments
   if (hostname) {
@@ -113,7 +113,7 @@ function lookup(hostname, options, callback) {
       hints = options.hints >>> 0;
       family = options.family >>> 0;
       all = options.all === true;
-      verbatim = options.verbatim === true;
+      verbatim = options.verbatim !== false;
 
       validateHints(hints);
     } else {

diff --git a/lib/internal/dns/promises.js b/lib/internal/dns/promises.js
@@ -103,7 +103,7 @@ function lookup(hostname, options) {
   var hints = 0;
   var family = -1;
   var all = false;
-  var verbatim = false;
+  var verbatim = true;
 
   // Parse arguments
   if (hostname && typeof hostname !== 'string') {
@@ -112,7 +112,7 @@ function lookup(hostname, options) {
     hints = options.hints >>> 0;
     family = options.family >>> 0;
     all = options.all === true;
-    verbatim = options.verbatim === true;
+    verbatim = options.verbatim !== false;
 
     validateHints(hints);
   } else {

diff --git a/test/sequential/test-net-better-error-messages-port.js b/test/sequential/test-net-better-error-messages-port.js
@@ -10,5 +10,5 @@ c.on('connect', common.mustNotCall());
 c.on('error', common.mustCall(function(e) {
   assert.strictEqual(e.code, 'ECONNREFUSED');
   assert.strictEqual(e.port, common.PORT);
-  assert.strictEqual(e.address, '127.0.0.1');
+  assert.match(e.address, /^(127\.0\.0\.1|::1)$/);
 }));