tangerine 1.5.3 → 1.5.5

package/README.md

@@ -89,8 +89,7 @@ npm install tangerine undici
 
 Our team at [Forward Email](https://forwardemail.net) (100% open-source and privacy-focused email service) needed a better solution for DNS.
 
-<details>
-<summary>After years of using the Node.js internal DNS module, we ran into these recurring patterns:</summary>
+After years of using the Node.js internal DNS module, we ran into these recurring patterns:
 
 * [Cloudflare](https://developers.cloudflare.com/1.1.1.1/encryption/dns-over-https/) and [Google](https://developers.google.com/speed/public-dns/docs/doh/) now have DNS over HTTPS servers ("DoH") available – and browsers such as Mozilla Firefox now have it [enabled by default](https://support.mozilla.org/en-US/kb/firefox-dns-over-https).
 * DNS cache consistency across multiple servers cannot be easily accomplished using packages such as `unbound`, `dnsmasq`, and `bind` – and configuring `/etc/resolv.conf` across multiple Ubuntu versions is not enjoyable (even with Ansible).  Maintaining logic at the application layer is much easier from a development, deployment, and maintenance perspective.
@@ -107,8 +106,6 @@ Our team at [Forward Email](https://forwardemail.net) (100% open-source and priv
 * Writing tests against DNS-related infrastructure requires either hacky DNS mocking or a DNS server (manipulating cache is much easier).
 * <u>**The Node.js community is lacking a high-quality and dummy-proof userland DNS package with sensible defaults.**</u>
 
-</details>
-
 ### Why integrate DNS over HTTPS
 
 > With DNS over HTTPS (DoH), DNS queries and responses are encrypted and sent via the HTTP or HTTP/2 protocols. DoH ensures that attackers cannot forge or alter DNS traffic. DoH uses port 443, which is the standard HTTPS traffic port, to wrap the DNS query in an HTTPS request. DNS queries and responses are camouflaged within other HTTPS traffic, since it all comes and goes from the same port. – [Cloudflare](https://developers.cloudflare.com/1.1.1.1/encryption/dns-over-https/)
@@ -133,8 +130,7 @@ Thanks to the authors of [dohdec](https://github.com/hildjj/dohdec), [dns-packet
 * HTTP error codes are mapped to DNS error codes (the error `code` and `errno` properties will appear as if they're from `dns` usage).  This is a configurable option enabled by default (see `returnHTTPErrors` option).
 * If you need callbacks, then use [util.callbackify](https://nodejs.org/api/util.html#utilcallbackifyoriginal) (e.g. `const resolveTxt = callbackify(tangerine.resolveTxt)`).
 
-<details>
-<summary>We have also added several improvements and new features:</summary>
+We have also added several improvements and new features:
 
 * Default name servers used have been set to [Cloudflare's](https://1.1.1.1/) (`['1.1.1.1', '1.0.0.1']`) (as opposed to the system default – which is often set to a default which is not privacy-focused or simply forgotten to be set by DevOps teams).  You may also want to use [Cloudflare's Malware and Adult Content Blocking](https://blog.cloudflare.com/introducing-1-1-1-1-for-families/) DNS server addresses instead.
 * You can pass a custom `servers` option (as opposed to having to invoke `dns.setServers(...)` or `resolver.setServers(...)`).
@@ -146,10 +142,7 @@ Thanks to the authors of [dohdec](https://github.com/hildjj/dohdec), [dns-packet
 * Debug via `NODE_DEBUG=tangerine node app.js` flag (uses [util.debuglog](https://nodejs.org/api/util.html#utildebuglogsection-callback)).
 * The method `setLocalAddress()` will parse the IP address and port properly to pass along for use with the agent as `localAddress` and `localPort`.  If you require IPv6 addresses with ports, you must encode it as `[IPv6]:PORT` ([similar to RFC 3986](https://serverfault.com/a/205794)).
 
-</details>
-
-<details>
-<summary>All existing <code>syscall</code> values have been preserved:</summary>
+All existing <code>syscall</code> values have been preserved:
 
 * `resolveAny` → `queryAny`
 * `resolve4` → `queryA`
@@ -166,8 +159,6 @@ Thanks to the authors of [dohdec](https://github.com/hildjj/dohdec), [dns-packet
 * `resolveSoa` → `querySoa`
 * `reverse` → `getHostByAddr`
 
-</details>
-
 
 ## Usage and Examples
 

package/index.js

@@ -11,6 +11,7 @@ const autoBind = require('auto-bind');
 const getStream = require('get-stream');
 const hostile = require('hostile');
 const ipaddr = require('ipaddr.js');
+const isStream = require('is-stream');
 const mergeOptions = require('merge-options');
 const pMap = require('p-map');
 const pTimeout = require('p-timeout');
@@ -702,8 +703,8 @@ class Tangerine extends dns.promises.Resolver {
 
     // safeguard (matches c-ares)
     if (lower === 'localhost' || lower === 'localhost.') {
-      if (!resolve4) resolve4 = ['127.0.0.1'];
-      if (!resolve6) resolve6 = ['::1'];
+      resolve4 ||= ['127.0.0.1'];
+      resolve6 ||= ['::1'];
     }
 
     if (isIPv4(name)) {
@@ -1128,22 +1129,41 @@ class Tangerine extends dns.promises.Resolver {
               const statusCode = response.status || response.statusCode;
               debug('response', { statusCode, headers });
 
+              // <https://github.com/nodejs/undici/issues/3353#issuecomment-2184635954>
+              // eslint-disable-next-line max-depth
+              if (body && isStream(body) && typeof body.on === 'function')
+                body.on('error', (err) => {
+                  this.options.logger.error(err, { response });
+                });
+
               // eslint-disable-next-line max-depth
               if (body && statusCode >= 200 && statusCode < 300) {
+                // <https://sindresorhus.com/blog/goodbye-nodejs-buffer>
                 buffer = Buffer.isBuffer(body)
                   ? body
                   : // eslint-disable-next-line no-await-in-loop
                     await getStream.buffer(body);
+                // <https://github.com/nodejs/undici/issues/3353>
+                // eslint-disable-next-line no-await-in-loop, max-depth
+                if (body && typeof body.dump === 'function') await body.dump();
                 // eslint-disable-next-line max-depth
                 if (!abortController.signal.aborted) abortController.abort();
                 break;
               }
 
+              // <https://github.com/nodejs/undici/issues/3353>
+              // eslint-disable-next-line no-await-in-loop, max-depth
+              if (body && typeof body.dump === 'function') await body.dump();
+
+              // <https://github.com/nodejs/undici/blob/00dfd0bd41e73782452aecb728395f354585ca94/lib/core/errors.js#L47-L58>
               const message =
                 http.STATUS_CODES[statusCode] ||
                 this.options.defaultHTTPErrorMessage;
               const err = new Error(message);
+              err.body = body;
+              err.status = statusCode;
               err.statusCode = statusCode;
+              err.headers = headers;
               throw err;
             }
           } catch (err) {
@@ -1202,6 +1222,12 @@ class Tangerine extends dns.promises.Resolver {
       // that one or more dns servers have persistent issues
       if (errors.length > 0)
         this.options.logger.error(this.constructor.combineErrors(errors));
+
+      //
+      // NOTE: dns-packet does not yet support Uint8Array
+      //       (however undici does have body.arrayBuffer() method)
+      //
+      // https://github.com/mafintosh/dns-packet/issues/72
       return packet.decode(buffer);
     } catch (_err) {
       if (!abortController.signal.aborted) abortController.abort();
@@ -1886,8 +1912,8 @@ class Tangerine extends dns.promises.Resolver {
             Buffer.isBuffer(a.data)
               ? a.data.toString()
               : Array.isArray(a.data)
-              ? a.data.map((d) => (Buffer.isBuffer(d) ? d.toString() : d))
-              : a.data
+                ? a.data.map((d) => (Buffer.isBuffer(d) ? d.toString() : d))
+                : a.data
           ];
         });
       }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "tangerine",
   "description": "Tangerine is the best Node.js drop-in replacement for dns.promises.Resolver using DNS over HTTPS (\"DoH\") via undici with built-in retries, timeouts, smart server rotation, AbortControllers, and caching support for multiple backends (with TTL and purge support).",
-  "version": "1.5.3",
+  "version": "1.5.5",
   "author": "Forward Email (https://forwardemail.net)",
   "bugs": {
     "url": "https://github.com/forwardemail/nodejs-dns-over-https-tangerine/issues"
@@ -12,49 +12,50 @@
   "dependencies": {
     "@ungap/structured-clone": "^1.2.0",
     "auto-bind": "4",
-    "dns-packet": "^5.6.0",
+    "dns-packet": "^5.6.1",
     "dohdec": "^5.0.3",
     "get-stream": "6",
-    "hostile": "^1.3.3",
-    "ipaddr.js": "^2.0.1",
+    "hostile": "^1.4.0",
+    "ipaddr.js": "^2.2.0",
+    "is-stream": "2.0.1",
     "merge-options": "3.0.4",
     "p-map": "4",
     "p-timeout": "4",
     "p-wait-for": "3",
     "port-numbers": "6.0.1",
-    "private-ip": "^3.0.0",
-    "punycode": "^2.3.0",
-    "semver": "^7.5.1"
+    "private-ip": "^3.0.2",
+    "punycode": "^2.3.1",
+    "semver": "^7.6.3"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.6.3",
-    "@commitlint/config-conventional": "^17.6.3",
+    "@commitlint/cli": "^19.3.0",
+    "@commitlint/config-conventional": "^19.2.2",
     "ava": "^5.2.0",
-    "axios": "^1.4.0",
+    "axios": "^1.7.3",
     "benchmark": "^2.1.4",
     "cross-env": "^7.0.3",
-    "eslint": "^8.34.0",
+    "eslint": "^9.8.0",
     "eslint-config-xo-lass": "^2.0.1",
-    "fetch-mock": "^9.11.0",
+    "fetch-mock": "^10.1.1",
     "fixpack": "^4.0.0",
     "got": "11",
-    "husky": "^8.0.3",
-    "ioredis": "^5.3.2",
-    "ioredis-mock": "^8.7.0",
+    "husky": "^9.1.4",
+    "ioredis": "^5.4.1",
+    "ioredis-mock": "^8.9.0",
     "is-ci": "^3.0.1",
-    "lint-staged": "^13.2.2",
+    "lint-staged": "^15.2.8",
     "lodash": "^4.17.21",
-    "nock": "^13.3.1",
+    "nock": "^13.5.4",
     "node-fetch": "2",
-    "nyc": "^15.1.0",
-    "phin": "^3.7.0",
-    "remark-cli": "^11.0.0",
+    "nyc": "^17.0.0",
+    "phin": "^3.7.1",
+    "remark-cli": "11.0.0",
     "remark-preset-github": "^4.0.4",
     "request": "^2.88.2",
     "sort-keys": "4.2.0",
-    "superagent": "^8.0.9",
-    "undici": "^5.22.1",
-    "xo": "^0.54.2"
+    "superagent": "^9.0.2",
+    "undici": "^6.19.5",
+    "xo": "^0.58.0"
   },
   "engines": {
     "node": ">=16"