zgrzyt 1.3.5 → 1.6.0

package/Readme.md

@@ -1,7 +1,5 @@
 [![NPM version][npm-image]][npm-url]
-[![Build Status][travis-image]][travis-url]
-[![Dependency Status][deps-image]][deps-url]
-[![Dev Dependency Status][deps-dev-image]][deps-dev-url]
+[![Build Status][build-image]][build-url]
 
 # zgrzyt
 
@@ -47,12 +45,13 @@ token=XXXXXX
 ; API URL to be tested on each of the servers
 url=https://api.example.net/status
 timeout=250        ; optional, in millis
+retry=2            ; optional, by default zgrzyt retries 2 times before assuming API endpoint is down 
 domain=example.net ; optional, domain for which zgrzyt will update DNS record
 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.
+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.
 
 ### Multiple checks
 
@@ -88,11 +87,5 @@ MIT © [Damian Krzeminski](https://pirxpilot.me)
 [npm-image]: https://img.shields.io/npm/v/zgrzyt.svg
 [npm-url]: https://npmjs.org/package/zgrzyt
 
-[travis-url]: https://travis-ci.com/pirxpilot/zgrzyt
-[travis-image]: https://img.shields.io/travis/com/pirxpilot/zgrzyt.svg
-
-[deps-image]: https://img.shields.io/david/pirxpilot/zgrzyt.svg
-[deps-url]: https://david-dm.org/pirxpilot/zgrzyt
-
-[deps-dev-image]: https://img.shields.io/david/dev/pirxpilot/zgrzyt.svg
-[deps-dev-url]: https://david-dm.org/pirxpilot/zgrzyt?type=dev
+[build-url]: https://github.com/pirxpilot/zgrzyt/actions/workflows/check.yaml
+[build-image]: https://img.shields.io/github/workflow/status/pirxpilot/zgrzyt/check

package/index.js

@@ -2,6 +2,7 @@ const conf = require('rc')('zgrzyt');
 const prepareConfig = require('./lib/config');
 const zgrzyt = require('./lib/zgrzyt');
 const report = require('./lib/report');
+const { onExit } = require('./lib/state');
 
 const apis = prepareConfig(conf);
 
@@ -17,6 +18,7 @@ main(apis).catch(e => {
 async function main(apis) {
   const results = await Promise.all(apis.map(zgrzyt));
   const { exitCode, lines }  = report(results);
-  lines.forEach(l => console.log(l));
+  console.log(lines.join('\n'));
+  await onExit();
   process.exit(exitCode);
 }

package/lib/check.js

@@ -3,6 +3,7 @@ const https = require('https');
 const debug = require('debug')('zgrzyt:check');
 
 const { resolve } = require('./dns');
+const { updateHealth } = require('./state');
 
 const {
   name,
@@ -21,14 +22,17 @@ module.exports = {
 async function checkService(server, api) {
   const address = await resolve(server) ;
   debug('Resolved %s to %s', server, address);
+  const ok = await checkApi(api, address);
+  const health = await updateHealth(api, server, ok);
   return {
     address,
     server,
-    ok: await checkApi(api, address)
+    health,
+    ok
   };
 }
 
-function checkApi({ url, timeout, method = 'HEAD' }, address) {
+async function checkApi({ url, timeout, method = 'HEAD', headers = {}, retry = 2 }, address) {
   debug('Checking %s on %s with timeout %dms', url, address, timeout);
 
   const { protocol } = new URL(url);
@@ -37,23 +41,41 @@ function checkApi({ url, timeout, method = 'HEAD' }, address) {
   const agent = new Agent({
     lookup: makeLookup(address)
   });
-  return new Promise(resolve => request(url, {
+
+  let result;
+  do {
+    result = await makeRequest();
+    if (result) {
+      break;
+    }
+    await waitRandom(timeout);
+  } while(--retry);
+
+  return result;
+
+  function makeRequest() {
+    return new Promise(resolve => request(url, {
       method,
       agent,
       timeout,
-      headers: { 'User-Agent': USER_AGENT }
+      headers: {
+        'User-Agent': USER_AGENT,
+        ...headers
+      }
     })
-    .on('timeout', function() {
+    .on('timeout', function () {
       debug('Timeout for %s on %s', url, address);
       this.destroy(new Error('Request timeout.'));
     })
     .on('response', res => resolve(isOk(res)))
     .on('error', () => resolve(false))
-    .end()
-  );
+    .end());
 
-  function isOk({ statusCode }) {
-    return statusCode >= 200 && statusCode < 300;
+    function isOk({ statusCode }) {
+      const ok = statusCode >= 200 && statusCode < 300;
+      debug('Result for %s on %s is %s', url, address, ok);
+      return ok;
+    }
   }
 
   function makeLookup(address) {
@@ -61,12 +83,20 @@ function checkApi({ url, timeout, method = 'HEAD' }, address) {
   }
 }
 
-async function checkServices(servers, selected, api, force) {
+async function checkServices(servers, selected, api, { force, repair }) {
   const items = await Promise.all(servers.map(s => checkService(s, api)));
   const okItems = items.filter(item => item.ok);
   if (force) {
     return okItems[0];
   }
+  if (repair && okItems[0].health >= repair) {
+    return okItems[0];
+  }
   const best = okItems.find(item => item.server === selected);
   return best ? best : okItems[0];
 }
+
+function waitRandom(millisMax) {
+  const millis = Math.floor(millisMax * Math.random());
+  return new Promise(resolve => setTimeout(resolve, millis));
+}

package/lib/config.js

@@ -18,7 +18,6 @@ function prepareConfig(config) {
   const {
     cloudflare,
     api = {},
-    force,
     cluster = {}
   } = config;
 
@@ -44,7 +43,10 @@ function prepareConfig(config) {
     }
 
     const { domain, zone } = getDomainAndZone(api);
-    const timeout = parseInt(api.timeout, 10) || 250;
+    const timeout = parseInt(api.timeout || config.timeout, 10) || 250;
+    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 { servers } = api.cluster in cluster ? cluster[api.cluster] : config;
     if (!servers || !servers.length) {
@@ -52,17 +54,29 @@ function prepareConfig(config) {
       return;
     }
 
+    if (api.header && !Array.isArray(api.header)) {
+      api.header = [ api.header ];
+    }
+    const headers = (api.header || []).reduce((headers, str) => {
+      const [ name, value ] = str.split('=', 2);
+      headers[name] = value;
+      return headers;
+    }, {});
+
     return {
       servers,
       api: {
         url: api.url,
         method: api.method || 'HEAD',
+        headers,
         timeout,
+        retry,
         domain,
         zone
       },
       client,
-      force
+      force,
+      repair
     };
 
   }

package/lib/report.js

@@ -34,19 +34,16 @@ function reportAll(collected) {
   let exitCode = 0;
   const lines = [];
 
-  if (noops.length > 0) {
-    console.log('No changes:\n');
-    lines.push(...noops, '\n');
+  if (missing.length > 0) {
+    lines.push('No good servers for:\n', ...missing, '\n');
+    exitCode += 2;
   }
   if (switched.length > 0) {
-    console.log('Switched DNS for:\n');
-    lines.push(...switched, '\n');
+    lines.push('Switched DNS for:\n', ...switched, '\n');
     exitCode += 1;
   }
-  if (missing.length > 0) {
-    lines.push('No good servers for:\n');
-    lines.push(...missing, '\n');
-    exitCode += 2;
+  if (noops.length > 0) {
+    lines.push('No changes:\n', ...noops, '\n');
   }
 
   return { exitCode, lines: lines.slice(0, -1) };

package/lib/state.js

@@ -0,0 +1,62 @@
+const {
+  readFile,
+  writeFile,
+} = require('fs').promises;
+
+module.exports = {
+  updateHealth,
+  onExit
+};
+
+const {
+  ZGRZYT_STATE = '/var/lib/zgrzyt/state.json'
+} = process.env;
+
+
+const state_p = read();
+let hook;
+
+async function onExit() {
+  if(hook) {
+    await hook();
+  }
+}
+
+async function updateHealth({ url }, serverName, ok) {
+  const state = await peak(url, serverName);
+  let health = 0;
+  if (ok) {
+    health = (state.health || 0) + 1;
+  }
+  state.health = health;
+  return health;
+}
+
+async function peak(url, serverName) {
+  const state = await state_p;
+  if (!hook) {
+    hook = async () => await write(state);
+  }
+  let api = state[url];
+  if (!api) {
+    api = state[url] = Object.create(null);
+  }
+  let server = api[serverName];
+  if (!server) {
+    server = api[serverName] = Object.create(null);
+  }
+  return server;
+}
+
+async function read(path = ZGRZYT_STATE) {
+  try {
+    const str = await readFile(path);
+    return JSON.parse(str);
+  } catch(e) {
+    return Object.create(null);
+  }
+}
+
+async function write(state, path = ZGRZYT_STATE) {
+  await writeFile(path, JSON.stringify(state, null, 2));
+}

package/lib/zgrzyt.js

@@ -4,10 +4,10 @@ const { checkServices } = require('./check');
 module.exports = zgrzyt;
 
 
-async function zgrzyt({ servers, api, client, force }) {
+async function zgrzyt({ servers, api, client, force, repair }) {
   const { domain, zone } = api;
   const record = await client.listRecords(zone, domain);
-  const good = await checkServices(servers, record.content, api, force);
+  const good = await checkServices(servers, record.content, api, { force, repair });
   const result = {
     url: api.url,
     domain,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zgrzyt",
-  "version": "1.3.5",
+  "version": "1.6.0",
   "description": "Poor man's load balancing DNS switcher.",
   "author": {
     "name": "Damian Krzeminski",
@@ -19,7 +19,7 @@
   "dependencies": {
     "debug": "~4",
     "got": "^11.8.0",
-    "parse-domain": "^3.0.2",
+    "parse-domain": "~4",
     "rc": "^1.2.8",
     "sprintfjs": "^1.2.16"
   },

package/History.md

@@ -1,67 +0,0 @@
-
-1.3.5 / 2020-12-09
-==================
-
- * handle request timeout properly
-
-1.3.4 / 2020-11-29
-==================
-
- * add support for large (> 50 zones) accounts
- * use `got`  instead of `fetch` for Cloudflare API
-
-1.3.3 / 2020-11-28
-==================
-
- * optimize requests for zone data
- * cache DNS requests for servers
-
-1.3.2 / 2020-11-28
-==================
-
- * throttle request to Cloudflare API
- * fix displaying error massages for CloudFlare API
-
-1.3.1 / 2020-11-26
-==================
-
- * better formating for reports
- * report results grouped by action
- * add debug module
-
-1.3.0 / 2020-11-25
-==================
-
- * use `HTTP HEAD` by default
-
-1.2.1 / 2020-11-24
-==================
-
- * use package.homepage to format User Agent
-
-1.2.0 / 2020-10-29
-==================
-
- * make zgrzyt less verbose
- * add support for multiple API in one config
- * allow for specifying API domain
- * add User-Agent header to HTTP checks
-
-1.1.0 / 2020-10-25
-==================
-
- * handle proxied records properly
-
-1.0.1 / 2020-10-05
-==================
-
- * update dependencies
- * fix docs typos
-
-1.0.0 / 2020-10-04
-==================
-
- * implement switching records when forced
- * add bin/zgrzyt executable
- * add support for switching dbs record
- * add http/https support