@k03mad/ip2geo 6.1.0 → 7.0.1

package/.github/dependabot.yml

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

package/.github/workflows/lint.yml

@@ -7,29 +7,14 @@ on:
   pull_request:
     branches:
       - master
-  schedule:
-    - cron: '00 15 * * 6'
 
 jobs:
   lint:
-    name: Lint
-    permissions:
-      contents: read
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Install NodeJS
-        uses: actions/setup-node@v4
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
           node-version-file: '.nvmrc'
-
-      - name: Install PNPM
-        run: npm i pnpm -g
-
-      - name: Run setup
-        run: npm run setup
-
-      - name: Run lint
-        run: npm run lint
+      - run: npm run setup
+      - run: npm run lint

package/.github/workflows/publish.yml

@@ -0,0 +1,21 @@
+name: Publish
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  publish:
+    environment: npm
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm run setup
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/test.yml

@@ -7,29 +7,14 @@ on:
   pull_request:
     branches:
       - master
-  schedule:
-    - cron: '00 15 * * 6'
 
 jobs:
   test:
-    name: Test
-    permissions:
-      contents: read
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Install NodeJS
-        uses: actions/setup-node@v4
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
           node-version-file: '.nvmrc'
-
-      - name: Install PNPM
-        run: npm i pnpm -g
-
-      - name: Run setup
-        run: npm run setup
-
-      - name: Run test
-        run: npm run test
+      - run: npm run setup
+      - run: npm run test

package/app/helpers/cache.js

@@ -29,7 +29,9 @@ export const collectOutputData = dataArr => {
     const outputData = {};
 
     outputKeys.forEach((key, i) => {
-        outputData[key] = dataArr[i];
+        outputData[key] = key === 'connectionAsn' && dataArr[i]
+            ? Number(dataArr[i])
+            : dataArr[i];
     });
 
     return outputData;
@@ -94,11 +96,10 @@ export const readFromFsCache = async (ip, cacheDir, cacheFileName, cacheFileSepa
  */
 export const writeToFsCache = async (ip, data, cacheDir, cacheFileName, cacheFileSeparator, cacheFileNewline) => {
     const cacheFileFull = getCacheFileFullPath(ip, cacheDir, cacheFileName);
+    debug('set to fs cache: %o %o', cacheFileFull, data);
 
     await fs.mkdir(cacheDir, {recursive: true});
     await fs.appendFile(cacheFileFull, Object.values(data).join(cacheFileSeparator) + cacheFileNewline);
-
-    debug('set to fs cache: %o %o', cacheFileFull, data);
 };
 
 /**
@@ -109,38 +110,25 @@ export const writeToFsCache = async (ip, data, cacheDir, cacheFileName, cacheFil
  */
 export const readFromMapCache = (ip, cacheMap, cacheMapMaxEntries) => {
     if (cacheMapMaxEntries > 0) {
-        const mapCache = cacheMap.get(ip);
+        const value = cacheMap.get(ip);
 
-        if (mapCache) {
-            debug('get from map cache: %o', mapCache);
-            return mapCache;
+        if (value) {
+            debug('get from map cache: %o', value);
+            return value;
         }
     }
 };
 
-/**
- * @param {object} body
- * @param {string} body.ip
- * @param {Map} cacheMap
- * @param {number} cacheMapMaxEntries
- */
-export const writeToMapCache = (body, cacheMap, cacheMapMaxEntries) => {
-    if (cacheMapMaxEntries > 0) {
-        cacheMap.set(body.ip, body);
-        debug('set to map cache: %o', body);
-    }
-};
-
 /**
  * @param {Map} cacheMap
  * @param {number} cacheMapMaxEntries
  */
 export const removeFromMapCacheIfLimit = (cacheMap, cacheMapMaxEntries) => {
     if (cacheMap.size > cacheMapMaxEntries) {
-        debug('remove from map cache by limit: size %o, limit: %o', cacheMap.size, cacheMapMaxEntries);
+        debug('remove from map cache by limit: %o > %o', cacheMap.size, cacheMapMaxEntries);
 
         for (const [key] of cacheMap) {
-            debug('remove from map cache by limit: key %o', key);
+            debug('remove from map cache by limit: %o', key);
             cacheMap.delete(key);
 
             if (cacheMap.size <= cacheMapMaxEntries) {
@@ -149,3 +137,18 @@ export const removeFromMapCacheIfLimit = (cacheMap, cacheMapMaxEntries) => {
         }
     }
 };
+
+/**
+ * @param {object} body
+ * @param {string} body.ip
+ * @param {Map} cacheMap
+ * @param {number} cacheMapMaxEntries
+ */
+export const writeToMapCache = (body, cacheMap, cacheMapMaxEntries) => {
+    if (cacheMapMaxEntries > 0) {
+        debug('set to map cache: %o', body);
+        cacheMap.set(body.ip, body);
+
+        removeFromMapCacheIfLimit(cacheMap, cacheMapMaxEntries);
+    }
+};

package/app/lib/ip2geo.js

@@ -8,7 +8,6 @@ import {
     collectOutputData,
     readFromFsCache,
     readFromMapCache,
-    removeFromMapCacheIfLimit,
     writeToFsCache,
     writeToMapCache,
 } from '../helpers/cache.js';
@@ -75,7 +74,11 @@ export const ip2geo = async ({
             return mapCache;
         }
 
-        const fsCache = await readFromFsCache(ip, cacheDir, cacheFileName);
+        const fsCache = await readFromFsCache(
+            ip,
+            cacheDir, cacheFileName,
+            cacheFileSeparator, cacheFileNewline,
+        );
 
         if (fsCache) {
             writeToMapCache(fsCache, cacheMap, cacheMapMaxEntries);
@@ -87,7 +90,11 @@ export const ip2geo = async ({
     const {body} = await request(reqUrl, {}, {rps});
 
     if (!body?.ip) {
-        logErrorExit(['API error', `request: ${reqUrl}`, `response body: ${body}`]);
+        logErrorExit([
+            'API error',
+            `request: ${reqUrl}`,
+            `response body: ${body}`,
+        ]);
     }
 
     const outputData = collectOutputData([
@@ -107,11 +114,11 @@ export const ip2geo = async ({
     ]);
 
     writeToMapCache(outputData, cacheMap, cacheMapMaxEntries);
-    removeFromMapCacheIfLimit(cacheMap, cacheMapMaxEntries);
 
     await writeToFsCache(
         body.ip, outputData,
-        cacheDir, cacheFileName, cacheFileSeparator, cacheFileNewline,
+        cacheDir, cacheFileName,
+        cacheFileSeparator, cacheFileNewline,
     );
 
     return outputData;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@k03mad/ip2geo",
-  "version": "6.1.0",
+  "version": "7.0.1",
   "description": "GeoIP library",
   "maintainers": [
     "Kirill Molchanov <k03.mad@gmail.com"
@@ -19,25 +19,25 @@
     "node": ">=20"
   },
   "dependencies": {
-    "@k03mad/request": "5.6.0",
-    "@k03mad/simple-log": "2.1.0",
+    "@k03mad/request": "5.6.1",
+    "@k03mad/simple-log": "2.1.1",
     "chalk": "5.3.0",
     "debug": "4.3.4"
   },
   "devDependencies": {
-    "@k03mad/eslint-config": "20.2.0",
+    "@k03mad/eslint-config": "20.3.0",
     "eslint": "8.56.0",
-    "husky": "9.0.7",
-    "mocha": "10.2.0"
+    "husky": "9.0.11",
+    "mocha": "10.3.0"
   },
   "scripts": {
     "lint": "npm run lint:eslint",
     "lint:eslint": "eslint ./ --cache",
-    "test": "mocha tests",
+    "test": "rm -rfv ./.geoip && mocha tests",
     "clean": "npm run clean:modules && npm run clean:eslint:cache",
     "clean:modules": "rm -rf ./node_modules || true",
     "clean:eslint:cache": "rm -rf .eslintcache || true",
-    "setup": "npm run clean && pnpm i",
+    "setup": "npm run clean && npm i pnpm -g && pnpm i",
     "prepare": "husky || true"
   }
 }

package/tests/cache-file-entries.js

@@ -0,0 +1,36 @@
+import assert from 'node:assert/strict';
+
+import {describe, it} from 'mocha';
+
+import {ip2geo} from '../app/index.js';
+
+import {getCurrentFilename, getTestFolder} from './helpers/path.js';
+import {REQUEST_IPV4} from './shared/consts.js';
+import {checkCacheFile, removeCacheFolder} from './shared/fs.js';
+
+const testName = getCurrentFilename(import.meta.url);
+
+describe(testName, () => {
+    const opts = {
+        cacheDir: getTestFolder(testName),
+        cacheMap: new Map(),
+        cacheMapMaxEntries: 0,
+        tries: 5,
+    };
+
+    it('should remove fs cache dir if exist', () => removeCacheFolder(opts.cacheDir));
+
+    Array.from({length: opts.tries}, (_, i) => i + 1).forEach(num => {
+        describe(`Try: ${num}`, () => {
+            it(`should return correct response for IP: "${REQUEST_IPV4.ip}"`, async () => {
+                const data = await ip2geo({ip: REQUEST_IPV4.ip, ...opts});
+                assert.deepEqual(data, REQUEST_IPV4);
+            });
+
+            it('should have cache file', () => checkCacheFile({
+                ...opts,
+                response: REQUEST_IPV4,
+            }));
+        });
+    });
+});

package/tests/cache-file-modify.js

@@ -4,8 +4,8 @@ import {describe, it} from 'mocha';
 
 import {ip2geo} from '../app/index.js';
 
-import {REQUEST_IPV4} from './helpers/consts.js';
 import {getCurrentFilename, getTestFolder} from './helpers/path.js';
+import {REQUEST_IPV4} from './shared/consts.js';
 import {checkCacheFile, removeCacheFolder} from './shared/fs.js';
 
 const testName = getCurrentFilename(import.meta.url);

package/tests/cache-file-subfolder.js

@@ -5,8 +5,8 @@ import {describe, it} from 'mocha';
 
 import {ip2geo} from '../app/index.js';
 
-import {REQUEST_IPV4} from './helpers/consts.js';
 import {getCurrentFilename, getTestFolder} from './helpers/path.js';
+import {REQUEST_IPV4} from './shared/consts.js';
 import {checkCacheFile, removeCacheFolder} from './shared/fs.js';
 
 const testName = getCurrentFilename(import.meta.url);

package/tests/cache-map-entries.js

@@ -4,8 +4,8 @@ import {describe, it} from 'mocha';
 
 import {ip2geo} from '../app/index.js';
 
-import {REQUEST_IPV4, REQUEST_IPV6} from './helpers/consts.js';
 import {getCurrentFilename, getTestFolder} from './helpers/path.js';
+import {REQUEST_IPV4, REQUEST_IPV6} from './shared/consts.js';
 import {removeCacheFolder} from './shared/fs.js';
 
 const testName = getCurrentFilename(import.meta.url);

package/tests/cache-map-off.js

@@ -4,8 +4,8 @@ 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 {REQUEST_IPV4_MAP_OFF_ONLY} from './shared/consts.js';
 import {checkCacheFile, removeCacheFolder} from './shared/fs.js';
 
 const testName = getCurrentFilename(import.meta.url);

package/tests/default.js

@@ -4,8 +4,8 @@ import {describe, it} from 'mocha';
 
 import {cacheStorage, ip2geo} from '../app/index.js';
 
-import {REQUEST_IPV4} from './helpers/consts.js';
 import {getCurrentFilename} from './helpers/path.js';
+import {REQUEST_IPV4} from './shared/consts.js';
 import {checkCacheFile, removeCacheFolder} from './shared/fs.js';
 
 const testName = getCurrentFilename(import.meta.url);

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

@@ -4,8 +4,8 @@ import {describe, it} from 'mocha';
 
 import {ip2geo} from '../app/index.js';
 
-import {REQUEST_IPV4} from './helpers/consts.js';
 import {getCurrentFilename, getTestFolder} from './helpers/path.js';
+import {REQUEST_IPV4} from './shared/consts.js';
 import {checkCacheFile, removeCacheFolder} from './shared/fs.js';
 
 const testName = getCurrentFilename(import.meta.url);

package/tests/ip-no-data.js

@@ -4,8 +4,8 @@ import {describe, it} from 'mocha';
 
 import {ip2geo} from '../app/index.js';
 
-import {REQUEST_IPV4} from './helpers/consts.js';
 import {getCurrentFilename, getTestFolder} from './helpers/path.js';
+import {REQUEST_IPV4} from './shared/consts.js';
 import {removeCacheFolder} from './shared/fs.js';
 
 const testName = getCurrentFilename(import.meta.url);

package/tests/ip-v6.js

@@ -4,8 +4,8 @@ import {describe, it} from 'mocha';
 
 import {ip2geo} from '../app/index.js';
 
-import {REQUEST_IPV6} from './helpers/consts.js';
 import {getCurrentFilename, getTestFolder} from './helpers/path.js';
+import {REQUEST_IPV6} from './shared/consts.js';
 import {checkCacheFile, removeCacheFolder} from './shared/fs.js';
 
 const testName = getCurrentFilename(import.meta.url);

package/tests/{helpers → shared}/consts.js

@@ -21,9 +21,9 @@ export const REQUEST_IPV4_MAP_OFF_ONLY = {
     country: 'United States',
     countryCode: 'US',
     countryEmoji: '🇺🇸',
-    region: 'District of Columbia',
-    regionCode: 'DC',
-    city: 'Washington',
+    region: 'California',
+    regionCode: 'CA',
+    city: 'San Jose',
     connectionAsn: 13_335,
     connectionOrg: 'APNIC and Cloudflare DNS Resolver project',
     connectionIsp: 'Cloudflare, Inc.',