@k03mad/ip2geo 7.3.1 → 7.5.0

package/.github/dependabot.yml

@@ -4,7 +4,11 @@ updates:
     directory: /
     schedule:
       interval: monthly
+    assignees:
+      - "k03mad"
   - package-ecosystem: github-actions
     directory: /
     schedule:
       interval: monthly
+    assignees:
+      - "k03mad"

package/app/{lib/ip2geo.js → api.js}

@@ -9,7 +9,7 @@ import {
     readFromMapCache,
     writeToFsCache,
     writeToMapCache,
-} from '../helpers/cache.js';
+} from './helpers/cache.js';
 
 const API = 'https://ipwho.is/';
 

package/app/cli.js

@@ -1,20 +1,24 @@
 #!/usr/bin/env node
 
-import {log} from '@k03mad/simple-log';
+import {log, logErrorExit} from '@k03mad/simple-log';
 
+import {DEFAULT_CACHE_FILE_DIR, DEFAULT_CACHE_FILE_NEWLINE, DEFAULT_CACHE_FILE_SEPARATOR, ip2geo} from './api.js';
+import {pruneCache} from './helpers/cache.js';
 import {codeText, nameText} from './helpers/colors.js';
 
-import {ip2geo} from './index.js';
-
 const args = process.argv.slice(2);
-const argsIps = args.filter(arg => !arg.startsWith('-'));
+const argsExtra = args.filter(arg => !arg.startsWith('-'));
+
+const isHelp = args.includes('-h') || args.includes('--help');
+const isPrune = args.includes('-p') || args.includes('--prune');
 
-if (args.includes('-h') || args.includes('--help')) {
+if (isHelp) {
     const cmd = `${codeText('$')} ${nameText('ip2geo')}`;
 
     log([
         '',
-        `${cmd} ${codeText('# current external ip')}`,
+        codeText('# current external ip'),
+        cmd,
         `${cmd} 1.1.1.1`,
         '',
         `${cmd} -h`,
@@ -26,19 +30,42 @@ if (args.includes('-h') || args.includes('--help')) {
         `${cmd} 1.1.1.1 8.8.8.8`,
         `${cmd} 1.1.1.1,8.8.8.8`,
         '',
+        codeText('# remove duplicate cache entries'),
+        `${cmd} -p`,
+        `${cmd} --prune`,
     ]);
 
     process.exit(0);
 }
 
-const output = argsIps.length === 0
-    ? [await ip2geo()]
-    : await Promise.all(argsIps.map(arg => Promise.all(arg.split(',').map(ip => ip2geo({ip})))));
+if (isPrune) {
+    const cacheFolder = argsExtra[0] || DEFAULT_CACHE_FILE_DIR;
+
+    try {
+        const {removedEntries} = await pruneCache(
+            cacheFolder,
+            DEFAULT_CACHE_FILE_SEPARATOR,
+            DEFAULT_CACHE_FILE_NEWLINE,
+        );
 
-const flatten = output.flat();
+        log(`Removed duplicate cache entries: ${removedEntries}`);
+    } catch (err) {
+        if (err.code !== 'ENOENT') {
+            logErrorExit(err);
+        }
 
-if (args.includes('--json') || args.includes('-j')) {
-    log(JSON.stringify(flatten.length > 1 ? flatten : flatten[0]));
+        log(`Cache folder empty: ${cacheFolder}`);
+    }
 } else {
-    log(flatten);
+    const output = argsExtra.length === 0
+        ? [await ip2geo()]
+        : await Promise.all(argsExtra.map(arg => Promise.all(arg.split(',').map(ip => ip2geo({ip})))));
+
+    const flatten = output.flat();
+
+    if (args.includes('--json') || args.includes('-j')) {
+        log(JSON.stringify(flatten.length > 1 ? flatten : flatten[0]));
+    } else {
+        log(flatten);
+    }
 }

package/app/helpers/cache.js

@@ -152,3 +152,35 @@ export const writeToMapCache = (body, cacheMap, cacheMapMaxEntries) => {
         removeFromMapCacheIfLimit(cacheMap, cacheMapMaxEntries);
     }
 };
+
+/**
+ * @param {string} cacheDir
+ * @param {string} cacheFileSeparator
+ * @param {string} cacheFileNewline
+ */
+export const pruneCache = async (cacheDir, cacheFileSeparator, cacheFileNewline) => {
+    const files = await fs.readdir(cacheDir);
+
+    const cacheLineToNum = line => Number(
+        line.split(cacheFileSeparator)[0]
+            .split('.')
+            .map(num => `00${num}`.slice(-3))
+            .join(''),
+    );
+
+    let removedEntries = 0;
+
+    await Promise.all(files.map(async file => {
+        const fullFilePath = path.join(cacheDir, file);
+
+        const data = await fs.readFile(fullFilePath, {encoding: 'utf8'});
+        const dataArr = data.split(cacheFileNewline);
+
+        const uniq = [...new Set(dataArr)].sort((a, b) => cacheLineToNum(a) - cacheLineToNum(b));
+        await fs.writeFile(fullFilePath, uniq.join(cacheFileNewline));
+
+        removedEntries += dataArr.length - uniq.length;
+    }));
+
+    return {removedEntries};
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@k03mad/ip2geo",
-  "version": "7.3.1",
+  "version": "7.5.0",
   "description": "GeoIP library",
   "maintainers": [
     "Kirill Molchanov <k03.mad@gmail.com"
@@ -8,7 +8,7 @@
   "bin": {
     "ip2geo": "app/cli.js"
   },
-  "main": "app/index.js",
+  "main": "app/api.js",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/k03mad/ip2geo.git"
@@ -19,16 +19,16 @@
     "node": ">=20"
   },
   "dependencies": {
-    "@k03mad/request": "6.0.3",
-    "@k03mad/simple-log": "2.2.1",
+    "@k03mad/request": "6.1.0",
+    "@k03mad/simple-log": "2.3.0",
     "chalk": "5.3.0",
     "debug": "4.3.6"
   },
   "devDependencies": {
-    "@k03mad/eslint-config": "22.5.0",
+    "@k03mad/eslint-config": "23.0.0",
     "eslint": "8.57.0",
     "husky": "9.1.4",
-    "mocha": "10.5.2",
+    "mocha": "10.7.3",
     "npm-run-all": "4.1.5"
   },
   "scripts": {

package/tests/cache-file-entries.js

@@ -2,7 +2,7 @@ import assert from 'node:assert/strict';
 
 import {describe, it} from 'mocha';
 
-import {ip2geo} from '../app/index.js';
+import {ip2geo} from '../app/api.js';
 
 import {getCurrentFilename, getTestFolder} from './helpers/path.js';
 import {REQUEST_IPV4} from './shared/consts.js';

package/tests/cache-file-modify.js

@@ -2,7 +2,7 @@ import assert from 'node:assert/strict';
 
 import {describe, it} from 'mocha';
 
-import {ip2geo} from '../app/index.js';
+import {ip2geo} from '../app/api.js';
 
 import {getCurrentFilename, getTestFolder} from './helpers/path.js';
 import {REQUEST_IPV4} from './shared/consts.js';

package/tests/cache-file-subfolder.js

@@ -3,7 +3,7 @@ import path from 'node:path';
 
 import {describe, it} from 'mocha';
 
-import {ip2geo} from '../app/index.js';
+import {ip2geo} from '../app/api.js';
 
 import {getCurrentFilename, getTestFolder} from './helpers/path.js';
 import {REQUEST_IPV4} from './shared/consts.js';

package/tests/cache-map-entries.js

@@ -2,7 +2,7 @@ import assert from 'node:assert/strict';
 
 import {describe, it} from 'mocha';
 
-import {ip2geo} from '../app/index.js';
+import {ip2geo} from '../app/api.js';
 
 import {getCurrentFilename, getTestFolder} from './helpers/path.js';
 import {REQUEST_IPV4, REQUEST_IPV6} from './shared/consts.js';

package/tests/cache-map-max-entries.js

@@ -2,7 +2,7 @@ import assert from 'node:assert/strict';
 
 import {describe, it} from 'mocha';
 
-import {ip2geo} from '../app/index.js';
+import {ip2geo} from '../app/api.js';
 
 import {getCurrentFilename, getTestFolder} from './helpers/path.js';
 import {removeCacheFolder} from './shared/fs.js';

package/tests/cache-map-off.js

@@ -2,7 +2,7 @@ import assert from 'node:assert/strict';
 
 import {describe, it} from 'mocha';
 
-import {cacheStorage, ip2geo} from '../app/index.js';
+import {cacheStorage, ip2geo} from '../app/api.js';
 
 import {getCurrentFilename, getTestFolder} from './helpers/path.js';
 import {REQUEST_IPV4_MAP_OFF_ONLY} from './shared/consts.js';

package/tests/default.js

@@ -2,7 +2,7 @@ import assert from 'node:assert/strict';
 
 import {describe, it} from 'mocha';
 
-import {cacheStorage, ip2geo} from '../app/index.js';
+import {cacheStorage, ip2geo} from '../app/api.js';
 
 import {getCurrentFilename} from './helpers/path.js';
 import {REQUEST_IPV4} from './shared/consts.js';

package/tests/ip-multi-requests-cache.js

@@ -2,7 +2,7 @@ import assert from 'node:assert/strict';
 
 import {describe, it} from 'mocha';
 
-import {ip2geo} from '../app/index.js';
+import {ip2geo} from '../app/api.js';
 
 import {getCurrentFilename, getTestFolder} from './helpers/path.js';
 import {REQUEST_IPV4} from './shared/consts.js';

package/tests/ip-no-data.js

@@ -2,7 +2,7 @@ import assert from 'node:assert/strict';
 
 import {describe, it} from 'mocha';
 
-import {ip2geo} from '../app/index.js';
+import {ip2geo} from '../app/api.js';
 
 import {getCurrentFilename, getTestFolder} from './helpers/path.js';
 import {REQUEST_IPV4} from './shared/consts.js';

package/tests/ip-v6.js

@@ -2,7 +2,7 @@ import assert from 'node:assert/strict';
 
 import {describe, it} from 'mocha';
 
-import {ip2geo} from '../app/index.js';
+import {ip2geo} from '../app/api.js';
 
 import {getCurrentFilename, getTestFolder} from './helpers/path.js';
 import {REQUEST_IPV6} from './shared/consts.js';

package/tests/shared/fs.js

@@ -7,7 +7,7 @@ import {
     DEFAULT_CACHE_FILE_NAME,
     DEFAULT_CACHE_FILE_NEWLINE,
     DEFAULT_CACHE_FILE_SEPARATOR,
-} from '../../app/index.js';
+} from '../../app/api.js';
 
 /**
  * @param {string} cacheDir

package/app/index.js

@@ -1 +0,0 @@
-export * from './lib/ip2geo.js';