zgrzyt 2.2.4 → 2.3.0

package/Readme.md

@@ -49,6 +49,7 @@ 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
+proxied=treue      ; optional, by default zgrzyt preserves Cloudflare proxy status when updating DNS record
 ```
 
 If `api.domain` is not specified its value is deduced from `api.url`.

package/lib/check.js

@@ -1,13 +1,12 @@
 import http from 'node:http';
 import https from 'node:https';
 import makeDebug from 'debug';
-
-const debug = makeDebug('zgrzyt:check');
-
 import packageJson from '../package.json' with { type: 'json' };
 import { resolve } from './dns.js';
 import { updateHealth } from './state.js';
 
+const debug = makeDebug('zgrzyt:check');
+
 const {
   name,
   version,
@@ -16,10 +15,6 @@ const {
 
 const USER_AGENT = `${name}/${version} (${homepage})`;
 
-/* global URL */
-
-export { checkServices };
-
 async function checkService(server, api) {
   const { ipv4 = true, ipv6 = false } = api;
   const addresses = await resolve(server, { ipv4, ipv6 });
@@ -102,7 +97,7 @@ async function checkApi(api, { address, family }) {
   }
 }
 
-async function checkServices(servers, selected, api, { force, repair }) {
+export 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 (okItems.length === 0) {

package/lib/cloudflare.js

@@ -2,8 +2,6 @@ import makeDebug from 'debug';
 
 const debug = makeDebug('zgrzyt:cloudflare');
 
-export default client;
-
 class CloudflareError extends Error {
   constructor(errors) {
     super(`Cloudflare API error: ${errors[0].message}`);
@@ -48,7 +46,7 @@ function makeFetch({ token, timeout, retry }) {
   }
 }
 
-function client({ token, timeout = 4000, retry = 2 }) {
+export default function client({ token, timeout = 4000, retry = 2 }) {
   const cf = makeFetch({ token, timeout, retry });
   const cacheZones = Object.create(null);
   let pZones;
@@ -61,7 +59,7 @@ function client({ token, timeout = 4000, retry = 2 }) {
     const zone = await getZone(zoneName);
     const record = await getRecord(zone.id, domain);
     if (record.type === 'CNAME') {
-      return updateRecord(zone.id, record.id, record.proxied, domain, good);
+      return updateRecord(zone.id, record.id, good.proxied, domain, good);
     }
     console.error('Cannot only update CNAME records');
   }

package/lib/config.js

@@ -1,8 +1,6 @@
 import { fromUrl, parseDomain } from 'parse-domain';
 import makeClient from './cloudflare.js';
 
-export default prepareConfig;
-
 function getDomainAndZone({ url, domain: apiDomain }) {
   if (!apiDomain) {
     apiDomain = fromUrl(url);
@@ -14,7 +12,7 @@ function getDomainAndZone({ url, domain: apiDomain }) {
   };
 }
 
-function prepareConfig(config) {
+export default function prepareConfig(config) {
   const { cloudflare, api = {}, cluster = {} } = config;
 
   if (!cloudflare?.token) {
@@ -48,6 +46,7 @@ function prepareConfig(config) {
     const timeout = Number.parseInt(api.timeout || config.timeout, 10) || 250;
     const retry = Number.parseInt(api.retry || config.retry, 10) || 2;
     const force = 'force' in api ? api.force : config.force;
+    const proxied = 'proxied' in api ? api.proxied : config.proxied;
     const repair = Number.parseInt(api.repair || config.repair, 10) || 5;
     const ipv6 = Boolean(api.ipv6 ?? config.ipv6);
     const ipv4 = Boolean(api.ipv4 ?? config.ipv4 ?? true);
@@ -71,6 +70,7 @@ function prepareConfig(config) {
       servers,
       api: {
         url: api.url,
+        proxied,
         method: api.method || 'HEAD',
         headers,
         timeout,

package/lib/report.js

@@ -14,19 +14,19 @@ function collect(context, { url, domain, record, good, switched }) {
     context.missing.push(url);
   } else if (switched) {
     const line = sprintf(
-      '%-25s %-25s => %-25s [%s]',
+      '%-25s %-25s => %-25s %s',
       domain,
       record.content,
       good.server,
-      good.address
+      good.proxied ? '[proxied]' : ''
     );
     context.switched.push(line);
   } else {
     const line = sprintf(
-      '%-25s %-25s [%s]',
+      '%-25s %-25s %s',
       record.name,
       good.server,
-      good.address
+      record.proxied ? '[proxied]' : ''
     );
     context.noops.push(line);
   }

package/lib/state.js

@@ -1,19 +1,17 @@
 import { readFile, writeFile } from 'node:fs/promises';
 
-export { updateHealth, onExit };
-
 const { ZGRZYT_STATE = '/var/lib/zgrzyt/state.json' } = process.env;
 
 const state_p = read();
 let hook;
 
-async function onExit() {
+export async function onExit() {
   if (hook) {
     await hook();
   }
 }
 
-async function updateHealth({ url }, serverName, ok) {
+export async function updateHealth({ url }, serverName, ok) {
   const state = await peak(url, serverName);
   let health = 0;
   if (ok) {

package/lib/zgrzyt.js

@@ -1,7 +1,7 @@
 import { checkServices } from './check.js';
 
 export async function zgrzyt({ servers, api, client, force, repair }) {
-  const { domain, zone } = api;
+  const { domain, zone, proxied } = api;
   const record = await client.listRecords(zone, domain);
   const good = await checkServices(servers, record.content, api, {
     force,
@@ -13,7 +13,12 @@ export async function zgrzyt({ servers, api, client, force, repair }) {
     record,
     good
   };
-  if (good && good.server !== record.content) {
+  if (!good) {
+    return result;
+  }
+  good.proxied = proxied ?? record.proxied;
+  // need to switch if different good server is found or different proxied setting
+  if (good.server !== record.content || good.proxied !== record.proxied) {
     result.switched = await client.switchToService(zone, domain, good);
   }
   return result;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zgrzyt",
-  "version": "2.2.4",
+  "version": "2.3.0",
   "description": "Poor man's load balancing DNS switcher.",
   "type": "module",
   "author": {