zgrzyt 2.1.0 → 2.2.0

package/Readme.md

@@ -36,6 +36,7 @@ zgrzyt --force
 ; list of potential servers configured for this domain CNAME record
 servers[]=alfa.example.net
 servers[]=beta.example.net
+ipv6=true          ; by default ipv4 is true and ipv6 is false
 
 [cloudflare]
 ; cloudflare API token
@@ -51,7 +52,7 @@ method=HEAD        ; optional, HTTP method used by zgrzyt
 ```
 
 If `api.domain` is not specified its value is deduced from `api.url`.
-If `api.method` is not specified zgrzyt will send `HEAD` requests to poll the servers. `api.method` can be set to `GET` if needed. `retry` and `timeout` can be either configured globally or separately for each API.
+If `api.method` is not specified zgrzyt will send `HEAD` requests to poll the servers. `api.method` can be set to `GET` if needed. `retry`, `timeout`, `ipv4`, and `ipv6` can be either configured globally or separately for each API.
 
 ### Multiple checks
 

package/lib/check.js

@@ -23,25 +23,39 @@ export {
 };
 
 async function checkService(server, api) {
-  const address = await resolve(server);
-  debug('Resolved %s to %s', server, address);
-  const ok = await checkApi(api, address);
+  const { ipv4 = true, ipv6 = false } = api;
+  const addresses = await resolve(server, { ipv4, ipv6 });
+  if (debug.enabled) {
+    debug('Resolved %s to %s', server, addresses.map(a => a.address).join(', '));
+  }
+  const oks = await Promise.all(addresses.map(a => checkApi(api, a)));
+  // collate results
+  const ok = oks.every(ok => ok);
   const health = await updateHealth(api, server, ok);
   return {
-    address,
+    address: addresses[0].address,
     server,
     health,
     ok
   };
 }
 
-async function checkApi({ url, timeout, method = 'HEAD', headers = {}, retry = 2, family = 4 }, address) {
+async function checkApi(api, { address, family }) {
+
+  const {
+    url,
+    method = 'HEAD',
+    timeout = 5000,
+    headers = {}
+  } = api;
+
   debug('Checking %s on %s with timeout %dms', url, address, timeout);
 
   const { protocol } = new URL(url);
   const { request } = 'https:' === protocol ? https : http;
 
   let result;
+  let retry = api.retry || 3;
   do {
     result = await makeRequest();
     if (result) {
@@ -54,15 +68,15 @@ async function checkApi({ url, timeout, method = 'HEAD', headers = {}, retry = 2
 
   function makeRequest() {
     return new Promise(resolve => request(url, {
-        method,
-        family,
-        lookup,
-        timeout,
-        headers: {
-          'User-Agent': USER_AGENT,
-          ...headers
-        }
-      })
+      method,
+      family,
+      lookup,
+      timeout,
+      headers: {
+        'User-Agent': USER_AGENT,
+        ...headers
+      }
+    })
       .on('timeout', function () {
         debug('Timeout for %s on %s', url, address);
         this.destroy(new Error('Request timeout.'));
@@ -82,7 +96,11 @@ async function checkApi({ url, timeout, method = 'HEAD', headers = {}, retry = 2
   }
 
   function lookup(domain, options, fn) {
-    fn(null, address, family);
+    debug('lookup', domain, address, options);
+    if (options.all) {
+      address = [address];
+    }
+    setImmediate(fn, null, address, options.family);
   }
 }
 

package/lib/config.js

@@ -21,10 +21,16 @@ function prepareConfig(config) {
     cluster = {}
   } = config;
 
-  if (!cloudflare || !cloudflare.token) {
+  if (!cloudflare?.token) {
     console.error('Cloudflare API token not configured');
     return;
   }
+  if (typeof cloudflare.timeout === 'string') {
+    cloudflare.timeout = parseInt(cloudflare.timeout);
+  }
+  if (typeof cloudflare.retry === 'string') {
+    cloudflare.retry = parseInt(cloudflare.retry);
+  }
 
   // collect all APIs
   const apis = [
@@ -47,6 +53,8 @@ function prepareConfig(config) {
     const retry = parseInt(api.retry || config.retry, 10) || 2;
     const force = 'force' in api ? api.force : config.force;
     const repair = parseInt(api.repair || config.repair, 10) || 5;
+    const ipv6 = Boolean(api.ipv6 ?? config.ipv6);
+    const ipv4 = Boolean(api.ipv4 ?? config.ipv4 ?? true);
 
     const { servers } = api.cluster in cluster ? cluster[api.cluster] : config;
     if (!servers || !servers.length) {
@@ -72,6 +80,8 @@ function prepareConfig(config) {
         timeout,
         retry,
         domain,
+        ipv4,
+        ipv6,
         zone
       },
       client,

package/lib/dns.js

@@ -1,22 +1,48 @@
 import { Resolver } from 'node:dns/promises';
 import makeDebug from 'debug';
 
-const resolver = new Resolver();
 const debug = makeDebug('dns:zgrzyt');
 
 const cache = Object.create(null);
 
-export function resolve(domain) {
+const resolver = new Resolver();
+
+/**
+ * Resolve domain to IP addresses
+ *
+ * @param {String} domain
+ * @param { ipv4, ipv6 } type of addresses to resolve
+ * @returns {Promise<Array<{address: String, family: String}>>} list of resolved addresses
+ */
+export async function resolve(domain, { ipv4, ipv6 }) {
   let p = cache[domain];
   if (!p) {
     cache[domain] = p = doResolve(domain);
   }
-  return p;
+  const addresses = await p;
+  return addresses.filter(
+    a => (a.family === 4 && ipv4) || (a.family === 6 && ipv6)
+  );
 }
 
+const RRTYPE_TO_FAMILY = {
+  A: 4,
+  AAAA: 6
+};
+
 async function doResolve(domain) {
   debug('Resolving %s', domain);
-  // const r6 = await resolver.resolve6(domain);
-  const [addr4] = await resolver.resolve4(domain);
-  return addr4;
+
+  const addresses = await Promise.all(['A', 'AAAA'].map(resolveWithFamily));
+  return addresses.flat();
+
+  async function resolveWithFamily(rrtype) {
+    try {
+      const addresses = await resolver.resolve(domain, rrtype);
+      return addresses.map(address => ({ address, family: RRTYPE_TO_FAMILY[rrtype] }));
+    } catch (error) {
+      debug('Failed to resolve %s with type %s: %s', domain, rrtype, error);
+      return [];
+    }
+  }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zgrzyt",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Poor man's load balancing DNS switcher.",
   "type": "module",
   "author": {
@@ -27,8 +27,8 @@
   },
   "dependencies": {
     "debug": "~4",
-    "got": "~13",
-    "parse-domain": "~7",
+    "got": "~14",
+    "parse-domain": "~8",
     "rc": "^1.2.8",
     "sprintfjs": "^1.2.16"
   },