From 3c23a6d8938ee75dae7b015bb417359200febd14 Mon Sep 17 00:00:00 2001
From: Ben Noordhuis <info@bnoordhuis.nl>
Date: Wed, 29 Jan 2020 13:12:15 +0100
Subject: [PATCH] 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: https://github.com/nodejs/node/issues/31566
Refs: https://github.com/nodejs/node/issues/6307
Refs: https://github.com/nodejs/node/pull/20710
Reissue of https://github.com/nodejs/node/pull/31567
---
 doc/api/dns.md                                         | 7 ++++---
 lib/dns.js                                             | 4 ++--
 lib/internal/dns/promises.js                           | 4 ++--
 test/sequential/test-net-better-error-messages-port.js | 2 +-
 4 files changed, 9 insertions(+), 8 deletions(-)

diff --git a/doc/api/dns.md b/doc/api/dns.md
index cdb948309f173f..868a5039bf237e 100644
--- 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
index b75ca1ca7da082..6d631bd2600571 100644
--- 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
index e0158eef81307e..6e08ff343180d8 100644
--- 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
index 789b2e31801da1..e8756838063e72 100644
--- 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$/');
 }));