@k03mad/ip2geo 4.3.0 → 5.0.1

package/README.md

@@ -45,7 +45,7 @@ const info = await ip2geo('1.1.1.1', {
     cacheFileSeparator: ';;',
     cacheFileNewline: '\n',
     cacheMap: new Map(),
-    cacheMapMaxEntries: 1000, // store last N requests
+    cacheMapMaxEntries: Number.POSITIVE_INFINITY, // store last N requests, 0 — turns cache map off
     rps: 3, // API RPS, useful in Promise.all with IPs array
 });
 

package/app/lib/ip2geo.js

@@ -26,7 +26,7 @@ const DEFAULT_CACHE_FILE_DIR = path.join(os.tmpdir(), '.ip2geo');
 const DEFAULT_CACHE_FILE_NAME = 'ips.log';
 const DEFAULT_CACHE_FILE_SEPARATOR = ';;';
 const DEFAULT_CACHE_FILE_NEWLINE = '\n';
-const DEFAULT_CACHE_MAP_MAX_ENTRIES = 1000;
+const DEFAULT_CACHE_MAP_MAX_ENTRIES = Number.POSITIVE_INFINITY;
 const DEFAULT_RPS = 3;
 
 export const cacheStorage = new Map();
@@ -113,8 +113,8 @@ const writeToFsCache = async (ip, data, cacheDir, cacheFileName, cacheFileSepara
  * @param {string} [opts.cacheFileSeparator]
  * @param {string} [opts.cacheFileNewline]
  * @param {Map} [opts.cacheMap]
- * @param {number} opts.cacheMapMaxEntries
- * @param {number} opts.rps
+ * @param {number} [opts.cacheMapMaxEntries]
+ * @param {number} [opts.rps]
  * @returns {Promise<GeoIpOutput>}
  */
 export const ip2geo = async (ip = '', {
@@ -127,11 +127,13 @@ export const ip2geo = async (ip = '', {
     rps = DEFAULT_RPS,
 } = {}) => {
     if (ip) {
-        const ipData = cacheMap.get(ip);
+        if (cacheMapMaxEntries > 0) {
+            const ipData = cacheMap.get(ip);
 
-        if (ipData) {
-            debug('get from map cache: %o', ipData);
-            return ipData;
+            if (ipData) {
+                debug('get from map cache: %o', ipData);
+                return ipData;
+            }
         }
 
         const fsCache = await readFromFsCache(ip, cacheDir, cacheFileName);
@@ -146,7 +148,11 @@ export const ip2geo = async (ip = '', {
                     const outputData = collectOutputData(fileData);
                     debug('get from fs cache: %o', outputData);
 
-                    cacheMap.set(ip, outputData);
+                    if (cacheMapMaxEntries > 0) {
+                        cacheMap.set(ip, outputData);
+                        debug('set to map cache: %o', outputData);
+                    }
+
                     return outputData;
                 }
             }
@@ -173,8 +179,10 @@ export const ip2geo = async (ip = '', {
 
     const outputData = collectOutputData(usedData);
 
-    cacheMap.set(body.ip, outputData);
-    debug('set to map cache: %o', outputData);
+    if (cacheMapMaxEntries > 0) {
+        cacheMap.set(body.ip, outputData);
+        debug('set to map cache: %o', outputData);
+    }
 
     await writeToFsCache(
         body.ip, usedData,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@k03mad/ip2geo",
-  "version": "4.3.0",
+  "version": "5.0.1",
   "description": "GeoIP library",
   "maintainers": [
     "Kirill Molchanov <k03.mad@gmail.com"
@@ -25,7 +25,7 @@
     "debug": "4.3.4"
   },
   "devDependencies": {
-    "@k03mad/eslint-config": "19.4.0",
+    "@k03mad/eslint-config": "19.5.0",
     "eslint": "8.56.0",
     "husky": "8.0.3",
     "mocha": "10.2.0"

package/tests/cache-map-off.js

@@ -0,0 +1,34 @@
+import assert from 'node:assert/strict';
+
+import {describe, it} from 'mocha';
+
+import {cacheStorage, ip2geo} from '../app/index.js';
+
+import {REQUEST_IPV4_MAP_OFF_ONLY} from './helpers/consts.js';
+import {getCurrentFilename, getTestFolder} from './helpers/path.js';
+import {checkCacheFile, removeCacheFolder} from './shared/fs.js';
+
+const testName = getCurrentFilename(import.meta.url);
+
+describe(testName, () => {
+    const opts = {
+        cacheDir: getTestFolder(testName),
+        cacheMapMaxEntries: 0,
+    };
+
+    it('should remove fs cache dir if exist', () => removeCacheFolder(opts.cacheDir));
+
+    it(`should return correct response for IP: "${REQUEST_IPV4_MAP_OFF_ONLY.ip}"`, async () => {
+        const data = await ip2geo(REQUEST_IPV4_MAP_OFF_ONLY.ip, opts);
+        assert.deepEqual(data, REQUEST_IPV4_MAP_OFF_ONLY);
+    });
+
+    it('should have cache file', () => checkCacheFile({
+        ...opts,
+        response: REQUEST_IPV4_MAP_OFF_ONLY,
+    }));
+
+    it('should not have cache entries', () => {
+        assert.equal(cacheStorage.size, 0);
+    });
+});

package/tests/helpers/consts.js

@@ -20,6 +20,18 @@ export const REQUEST_IPV4 = {
     ispDomain: 'google.com',
 };
 
+export const REQUEST_IPV4_MAP_OFF_ONLY = {
+    ip: '1.1.1.1',
+    emoji: '🇺🇸',
+    country: 'United States',
+    countryA2: 'US',
+    region: 'District of Columbia',
+    city: 'Washington',
+    org: 'APNIC and Cloudflare DNS Resolver project',
+    isp: 'Cloudflare, Inc.',
+    ispDomain: 'cloudflare.com',
+};
+
 export const REQUEST_IPV6 = {
     ip: '2a00:dd80:40:100::',
     emoji: '🇳🇱',