tangerine 1.4.1 → 1.4.3

package/index.js

@@ -7,7 +7,7 @@ const { debuglog } = require('node:util');
 const { getEventListeners, setMaxListeners } = require('node:events');
 const { isIP, isIPv4, isIPv6 } = require('node:net');
 
-const { toASCII } = require('punycode/');
+const autoBind = require('auto-bind');
 const getStream = require('get-stream');
 const ipaddr = require('ipaddr.js');
 const mergeOptions = require('merge-options');
@@ -18,6 +18,8 @@ const packet = require('dns-packet');
 const semver = require('semver');
 const structuredClone = require('@ungap/structured-clone').default;
 const { getService } = require('port-numbers');
+// eslint-disable-next-line import/order
+const { toASCII } = require('punycode/');
 
 const pkg = require('./package.json');
 
@@ -363,6 +365,13 @@ class Tangerine extends dns.promises.Resolver {
 
     // manage set of abort controllers
     this.abortControllers = new Set();
+
+    //
+    // NOTE: bind methods so we don't have to programmatically call `.bind`
+    // (e.g. `getDmarcRecord(name, resolver.resolve.bind(resolver))`)
+    // (alternative to `autoBind(this)` is `this[method] = this[method].bind(this)`)
+    //
+    autoBind(this);
   }
 
   setLocalAddress(ipv4, ipv6) {
@@ -1234,7 +1243,7 @@ class Tangerine extends dns.promises.Resolver {
       data = await this.options.cache.get(key);
       // safeguard in case cache pollution
       if (data && typeof data === 'object') {
-        debug('cache retrieved', data);
+        debug('cache retrieved', key);
         const now = Date.now();
         // safeguard in case cache pollution
         if (
@@ -1243,6 +1252,7 @@ class Tangerine extends dns.promises.Resolver {
           !Number.isFinite(data.ttl) ||
           data.ttl < 1
         ) {
+          debug('cache expired', key);
           data = undefined;
         } else if (options?.ttl) {
           // clone the data so that we don't mutate cache (e.g. if it's in-memory)
@@ -1262,6 +1272,7 @@ class Tangerine extends dns.promises.Resolver {
 
               // eslint-disable-next-line max-depth
               if (data.answers[i].ttl <= 0) {
+                debug('answer cache expired', key);
                 data = undefined;
                 break;
               }
@@ -1508,13 +1519,57 @@ class Tangerine extends dns.promises.Resolver {
 
       case 'TXT': {
         // text records `dnsPromises.resolveTxt()`
-        return result.answers.flatMap((a) => [
-          Buffer.isBuffer(a.data)
-            ? a.data.toString()
-            : Array.isArray(a.data)
-            ? a.data.map((d) => (Buffer.isBuffer(d) ? d.toString() : d))
-            : a.data
-        ]);
+        return result.answers.flatMap((a) => {
+          //
+          // NOTE: we need to support buffer conversion
+          //       (e.g. JSON.stringify from most cache stores will convert this as such below)
+          //
+          // a {
+          //   name: 'forwardemail.net',
+          //   type: 'TXT',
+          //   ttl: 3600,
+          //   class: 'IN',
+          //   flush: false,
+          //   data: [ { type: 'Buffer', data: [Array] } ]
+          // }
+          //
+          // (or)
+          //
+          // a {
+          //   name: 'forwardemail.net',
+          //   type: 'TXT',
+          //   ttl: 3600,
+          //   class: 'IN',
+          //   flush: false,
+          //   data: { type: 'Buffer', data: [Array] }
+          // }
+          //
+          if (Array.isArray(a.data)) {
+            a.data = a.data.map((d) => {
+              if (
+                typeof d === 'object' &&
+                d.type === 'Buffer' &&
+                Array.isArray(d.data)
+              )
+                return Buffer.from(d.data);
+              return d;
+            });
+          } else if (
+            typeof a.data === 'object' &&
+            a.data.type === 'Buffer' &&
+            Array.isArray(a.data.data)
+          ) {
+            a.data = Buffer.from(a.data.data);
+          }
+
+          return [
+            Buffer.isBuffer(a.data)
+              ? a.data.toString()
+              : Array.isArray(a.data)
+              ? a.data.map((d) => (Buffer.isBuffer(d) ? d.toString() : d))
+              : a.data
+          ];
+        });
       }
 
       default: {

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.4.1",
+  "version": "1.4.3",
   "author": "Forward Email (https://forwardemail.net)",
   "bugs": {
     "url": "https://github.com/forwardemail/tangerine/issues"
@@ -11,6 +11,7 @@
   ],
   "dependencies": {
     "@ungap/structured-clone": "^1.0.2",
+    "auto-bind": "4",
     "dns-packet": "^5.4.0",
     "dohdec": "^5.0.3",
     "get-stream": "6",