@cryptotaxcalculator/axios-cached-dns-resolve

This library is a fork of the original axios-cached-dns-resolve package but adds/changes the following:

• Adds type safety
• Changes the module resolution to CJS (from ESM)
• Changes the test runner from ava to jest
• Adds support for Redis as a cache

For the complete list of changes, see the CHANGELOG.

Axios uses node.js dns.lookup to resolve host names. dns.lookup is synchronous and executes on limited libuv thread pool. Every axios request will resolve the dns name in kubernetes, openshift, and cloud environments that intentionally set TTL low or to 0 for quick dynamic updates. The dns resolvers can be overwhelmed with the load. There is/was a bug in DNS resolutions that manifests as very long dns.lookups in node.js.

From the kubernetes documentation

Even if apps and libraries did proper re-resolution, the load of every client re-resolving DNS over and over would be difficult to manage.

This library uses dns.resolve and can optionally cache resolutions and round-robin among addresses. The cache size is configurable. If caching is enabled, a background thread will periodically refresh resolutions with dns.resolve rather than every request. There is an idle TTL that evicts background refresh if an address is no longer being used. This lib proxies through the OS resolution mechanism which may provide further caching.

Objectives

• Async requests - dns resolve vs lookup
• Fast - local in-app memory cache lookup
• Fresh - periodically (frequently) updated
• Constant DNS load/latency vs random load/variable latency
• Providing statistics and introspection

Requirements

Node 14+

Getting started

npm i -S @cryptotaxcalculator/axios-cached-dns-resolve

Usage

import { registerInterceptor } from "@cryptotaxcalculator/axios-cached-dns-resolve";

const axiosClient = axios.create(config);

registerInterceptor(axiosClient);

Use axiosClient as normal

Configuration

export const config = {
  disabled: process.env.AXIOS_DNS_CACHE_DISABLE === "true",
  dnsTtlMs: parseInt(process.env.AXIOS_DNS_CACHE_TTL_MS || "5000"), // when to refresh actively used dns entries (5 sec)
  cacheGraceExpireMultiplier: parseInt(
    process.env.AXIOS_DNS_CACHE_EXPIRE_MULTIPLIER || "2"
  ), // maximum grace to use entry beyond TTL
  dnsIdleTtlMs:
    parseInt(process.env.AXIOS_DNS_CACHE_IDLE_TTL_MS || "1000") * 60 * 60, // when to remove entry entirely if not being used (1 hour)
  backgroundScanMs: parseInt(
    process.env.AXIOS_DNS_CACHE_BACKGROUND_SCAN_MS || "2400"
  ), // how frequently to scan for expired TTL and refresh (2.4 sec)
  dnsCacheSize: parseInt(process.env.AXIOS_DNS_CACHE_SIZE || "100"), // maximum number of entries to keep in cache
  // pino logging options
  logging: {
    name: "axios-cache-dns-resolve",
    // enabled: true,
    level: process.env.AXIOS_DNS_CACHE_LOG_LEVEL || "info", // default 'info' others trace, debug, info, warn, error, and fatal
    // timestamp: true,
    prettyPrint: process.env.NODE_ENV === "DEBUG" || false,
    formatters: {
      level: (label: string) => {
        return { level: label };
      },
    },
  },
  redisConfig:
    process.env.AXIOS_DNS_CACHE_USE_REDIS === "true"
      ? {
          url: process.env.AXIOS_DNS_CACHE_REDIS_URL || "localhost:6379",
          password: process.env.AXIOS_DNS_CACHE_REDIS_PASSWORD,
          ttl: parseInt(process.env.AXIOS_DNS_CACHE_REDIS_TTL || "5"), // default 5 seconds
        }
      : undefined,
  cache: undefined as LRUCache<string, DnsEntry> | undefined,
} as Config;

config.lruCacheConfig = {
  max: config.dnsCacheSize,
  ttl: config.dnsTtlMs * config.cacheGraceExpireMultiplier, // grace for refresh
} as LRUCacheConfig;

Statistics

Statistics are available via

getStats()

{
  "dnsEntries": 4,
  "refreshed": 375679,
  "hits": 128689,
  "misses": 393,
  "idleExpired": 279,
  "errors": 0,
  "lastError": 0,
  "lastErrorTs": 0
}

AND

getDnsCacheEntries()

[
  {
    "host": "foo-service.domain.com",
    "ips": [
      "51.210.235.165",
      "181.73.135.40"
    ],
    "nextIdx": 1,
    "lastUsedTs": 1604151366910,
    "updatedTs": 1604152691039
  },
  ...
]

Express Statistics

import {
  getStats,
  getDnsCacheEntries,
} from "@cryptotaxcalculator/axios-cached-dns-resolve";

router.get("/axios-dns-cache-statistics", getAxiosDnsCacheStatistics);

function getAxiosDnsCacheStatistics(req, resp) {
  resp.json(getStats());
}

router.get("/axios-dns-cache-entries", getAxiosDnsCacheEntries);

function getAxiosDnsCacheEntries(req, resp) {
  resp.json(getDnsCacheEntries());
}