@k03mad/dns-leak 1.1.0 → 2.0.0

package/.github/workflows/eslint.yml

@@ -22,7 +22,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Install NodeJS
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version-file: '.nvmrc'
 

package/README.md

@@ -1,6 +1,8 @@
 # DNS leak test
 
-Based on: [ipleak.net](https://ipleak.net/) / [API](https://airvpn.org/forums/topic/14737-api/)
+Based on:\
+— [ipleak.net](https://ipleak.net) ([API](https://airvpn.org/forums/topic/14737-api))\
+— [ipwhois.io](https://ipwhois.io) ([API](https://ipwhois.io/documentation))
 
 ## Global
 
@@ -17,20 +19,21 @@ npm i @k03mad/dns-leak
 ```
 
 ```js
-import IPLeak from '@k03mad/dns-leak';
+import {IPLeak, IPWhois} from '@k03mad/dns-leak';
 
-// default params (details at the link below)
-const api = new IPLeak();
+// default params (details at the ./app/api folder)
+const LeakApi = new IPLeak();
+const WhoisApi = new IPWhois();
 
 // get current external ip info
-await api.getIpInfo();
+await WhoisApi.getIpInfo();
+await LeakApi.getIpInfo();
 // get other ip info
-await api.getIpInfo({ip: '8.8.8.8'});
+await WhoisApi.getIpInfo({ip: '8.8.8.8'});
+await LeakApi.getIpInfo({ip: '8.8.8.8'});
 
 // dns leak check with one request (one request — fewer dns ips)
-await api.getDnsInfoOnce();
+await LeakApi.getDnsInfoOnce();
 // dns leak check with multi requests
-await api.getDnsInfoMulti();
+await LeakApi.getDnsInfoMulti();
 ```
-
-[Options and parameters with their default values](/app/api/IPLeak.js#L8)

package/app/api/IPLeak.js

@@ -3,12 +3,12 @@ import {customAlphabet} from 'nanoid';
 import {lowercase, numbers} from 'nanoid-dictionary';
 
 import {sleep} from '../helpers/promise.js';
+import * as spinner from '../helpers/spinner.js';
 
 /** */
 export default class IPLeak {
 
     /**
-     * All args are not required, the default ones works fine
      * @param {object} [opts]
      * @param {number} [opts.dnsRequestsCount] dns leak multi requests count with one session
      * @param {number} [opts.dnsRequestsRps] dns leak requests rps
@@ -93,15 +93,25 @@ export default class IPLeak {
     /**
      * @param {object} [opts]
      * @param {string} [opts.session]
+     * @param {boolean} [opts.isSpinnerEnabled]
      * @returns {Promise<object>}
      */
-    async getDnsInfoMulti({session = this._dnsSessionString} = {}) {
-        const arrayFromLen = Array.from({length: this._dnsRequestsCount});
+    async getDnsInfoMulti({isSpinnerEnabled, session = this._dnsSessionString} = {}) {
+        const spinnerName = 'dnsReq';
+        const arrayFromLen = Array.from({length: this._dnsRequestsCount - 1});
 
-        await Promise.all(arrayFromLen.map(() => this.getDnsInfoOnce({session})));
-        await sleep(this._dnsRequestsWaitBeforeLastMs);
+        spinner.start(spinnerName, isSpinnerEnabled);
+
+        await Promise.all(arrayFromLen.map(async () => {
+            await this.getDnsInfoOnce({session});
+            spinner.count(spinnerName, this._dnsRequestsCount);
+        }));
 
+        spinner.text(spinnerName, 'Wait for last request');
+        await sleep(this._dnsRequestsWaitBeforeLastMs);
         const info = await this.getDnsInfoOnce({session});
+
+        spinner.stop(spinnerName);
         return info;
     }
 

package/app/api/IPWhois.js

@@ -0,0 +1,44 @@
+import {requestCache} from '@k03mad/request';
+
+/** */
+export default class IPWhois {
+
+    /**
+     * @param {object} [opts]
+     * @param {number} [opts.ipRequestsCacheExpireMs] ip info requests cache ttl ms for same ip
+     * @param {number} [opts.ipRequestsRps] ip info requests rps
+     */
+    constructor({
+        ipRequestsCacheExpireMs = 3_600_000,
+        ipRequestsRps = 2,
+    } = {}) {
+        this._ipRequestsCacheExpireMs = ipRequestsCacheExpireMs;
+        this._ipRequestsRps = ipRequestsRps;
+    }
+
+    /** */
+    get _endpoints() {
+        return {
+
+            /** @param {string} ip */
+            ip: ip => `https://ipwho.is/${ip}`,
+        };
+    }
+
+    /**
+     * @param {object} [opts]
+     * @param {string} [opts.ip]
+     * @returns {Promise<object>}
+     */
+    async getIpInfo({ip = ''} = {}) {
+        const ipEndpoint = this._endpoints.ip(ip);
+
+        const {body} = await requestCache(ipEndpoint, {}, {
+            expire: this._ipRequestsCacheExpireMs,
+            rps: this._ipRequestsRps,
+        });
+
+        return body;
+    }
+
+}

package/app/api/index.js

@@ -0,0 +1,2 @@
+export {default as IPLeak} from './IPLeak.js';
+export {default as IPWhois} from './IPWhois.js';

package/app/helpers/log.js

@@ -1,14 +1,5 @@
-import chalk from 'chalk';
-
-const {bgBlackBright, magenta} = chalk;
-
 /**
  * @param {any} msg
  */
 // eslint-disable-next-line no-console
-export const log = (...msg) => console.log(...msg);
-
-/**
- * @param {any} header
- */
-export const logHeader = header => log(`\n${bgBlackBright(magenta(` ${header} `))}\n`);
+export const log = (...msg) => msg.forEach(elem => console.log(elem));

package/app/helpers/spinner.js

@@ -0,0 +1,49 @@
+import ora from 'ora';
+
+import {bar} from './text.js';
+
+export const spinner = {};
+
+/**
+ * @param {string} name
+ * @param {boolean} active
+ */
+export const start = (name, active) => {
+    if (active) {
+        spinner[name] = {
+            instance: ora().start(),
+            counter: 0,
+        };
+
+        return spinner[name].instance;
+    }
+
+    spinner[name] = {instance: {stop: () => ''}};
+};
+
+/**
+ * @param {string} name
+ * @param {string} msg
+ */
+export const text = (name, msg) => {
+    spinner[name].instance.text = bar(msg);
+};
+
+/**
+ * @param {string} name
+ * @param {number} total
+ */
+export const count = (name, total) => {
+    spinner[name].counter++;
+
+    const len = `${String(spinner[name].counter).padStart(String(total).length, '0')}/${total}`;
+    const percent = `${String((spinner[name].counter * 100 / total).toFixed(0)).padStart(2, '0')}%`;
+    text(name, `${len} [${percent}]`);
+};
+
+/**
+ * @param {string} name
+ */
+export const stop = name => {
+    spinner[name].instance.stop();
+};

package/app/helpers/text.js

@@ -0,0 +1,62 @@
+import chalk from 'chalk';
+
+const {bgBlackBright, blue, gray, green, magenta, yellow} = chalk;
+
+/**
+ * @param {any} msg
+ */
+export const header = msg => bgBlackBright(magenta(` ${msg} `));
+
+/**
+ * @param {any} msg
+ */
+export const bar = msg => yellow(msg);
+
+/**
+ * @param {object} [ipInfo]
+ * @param {string} [ipInfo.city]
+ * @param {string} [ipInfo.country]
+ * @param {string} [ipInfo.ip]
+ * @param {string} [ipInfo.region]
+ * @param {object} [ipInfo.flag]
+ * @param {object} [ipInfo.connection]
+ */
+export const formatIpInfo = ({city, connection, country, flag, ip, region} = {}) => {
+    let output = '';
+
+    if (ip) {
+        output += `${blue(ip)}\n`;
+    }
+
+    if (connection?.org) {
+        output += `${green(connection.org)} `;
+    }
+
+    if (connection?.isp && !connection?.org?.includes(connection?.isp)) {
+        if (connection?.org) {
+            output += green('/ ');
+        }
+
+        output += `${green(connection.isp)} `;
+    }
+
+    if (connection?.domain) {
+        output += gray(`(${connection.domain})`);
+    }
+
+    output += '\n';
+
+    if (flag?.emoji) {
+        output += `${flag.emoji}  `;
+    }
+
+    output += [
+        ...new Set([
+            country,
+            region,
+            city,
+        ]),
+    ].filter(Boolean).join(' :: ');
+
+    return output;
+};

package/app/run.js

@@ -0,0 +1,37 @@
+#!/usr/bin/env node
+import {IPLeak, IPWhois} from './api/index.js';
+import {log} from './helpers/log.js';
+import * as spinner from './helpers/spinner.js';
+import {formatIpInfo, header} from './helpers/text.js';
+
+const LeakApi = new IPLeak();
+const WhoisApi = new IPWhois();
+
+const currentIpInfo = await WhoisApi.getIpInfo();
+
+log(
+    '',
+    header('IP'),
+    '',
+    formatIpInfo(currentIpInfo),
+    '',
+    header('DNS'),
+    '',
+);
+
+const dnsInfo = await LeakApi.getDnsInfoMulti({isSpinnerEnabled: true});
+const dnsIps = [...new Set(Object.keys(dnsInfo.ip))];
+
+spinner.start(currentIpInfo.ip, true);
+
+const dnsData = await Promise.all(dnsIps.map(async ip => {
+    const data = await WhoisApi.getIpInfo({ip});
+    spinner.count(currentIpInfo.ip, dnsIps.length);
+    return data;
+}));
+
+spinner.stop(currentIpInfo.ip);
+
+dnsData
+    .sort((a, b) => a?.ip?.localeCompare(b?.ip))
+    .forEach(data => log(formatIpInfo(data), ''));

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@k03mad/dns-leak",
-  "version": "1.1.0",
+  "version": "2.0.0",
   "description": "DNS leak test",
   "maintainers": [
     "Kirill Molchanov <k03.mad@gmail.com"
   ],
-  "main": "app/api/IPLeak.js",
-  "bin": "app/index.js",
+  "main": "app/api/index.js",
+  "bin": "app/run.js",
   "repository": "k03mad/dns-leak",
   "license": "MIT",
   "type": "module",
@@ -16,9 +16,9 @@
   "dependencies": {
     "@k03mad/request": "3.2.0",
     "chalk": "5.3.0",
-    "country-locale-map": "1.8.15",
     "nanoid": "5.0.2",
-    "nanoid-dictionary": "5.0.0-beta.1"
+    "nanoid-dictionary": "5.0.0-beta.1",
+    "ora": "7.0.1"
   },
   "devDependencies": {
     "@k03mad/eslint-config": "13.3.1",

package/app/helpers/ip.js

@@ -1,47 +0,0 @@
-/* eslint-disable camelcase */
-
-import chalk from 'chalk';
-import clm from 'country-locale-map';
-
-const {blue, green} = chalk;
-
-/**
- * @param {object} [ipInfo]
- * @param {string} [ipInfo.city_name]
- * @param {string} [ipInfo.country_code]
- * @param {string} [ipInfo.country_name]
- * @param {string} [ipInfo.ip]
- * @param {string} [ipInfo.isp_name]
- * @param {string} [ipInfo.region_name]
- */
-export const formatIpInfo = ({city_name, country_code, country_name, ip, isp_name, region_name} = {}) => {
-    let output = '';
-
-    if (ip) {
-        output += `${blue(ip)} `;
-    }
-
-    if (isp_name) {
-        output += green(isp_name);
-    }
-
-    output += '\n';
-
-    if (country_code) {
-        const {emoji} = clm.getCountryByAlpha2(country_code);
-
-        if (emoji) {
-            output += `${emoji}  `;
-        }
-    }
-
-    output += [
-        ...new Set([
-            country_name,
-            region_name,
-            city_name,
-        ]),
-    ].filter(Boolean).join(' :: ');
-
-    return output;
-};

package/app/index.js

@@ -1,22 +0,0 @@
-#!/usr/bin/env node
-
-import IPLeak from './api/IPLeak.js';
-import {formatIpInfo} from './helpers/ip.js';
-import {log, logHeader} from './helpers/log.js';
-
-const api = new IPLeak();
-
-const currentIpInfo = await api.getIpInfo();
-
-logHeader('IP');
-log(formatIpInfo(currentIpInfo));
-logHeader('DNS');
-
-const dnsInfo = await api.getDnsInfoMulti();
-const dnsIps = [...new Set(Object.keys(dnsInfo.ip))];
-
-const dnsData = await Promise.all(dnsIps.map(ip => api.getIpInfo({ip})));
-
-dnsData
-    .sort((a, b) => a?.ip?.localeCompare(b?.ip))
-    .forEach(data => log(formatIpInfo(data), '\n'));