ac-geoip 1.4.2 → 3.0.0

package/CHANGELOG.md

@@ -1,3 +1,41 @@
+<a name="3.0.0"></a>
+ 
+# [3.0.0](https://github.com/admiralcloud/ac-geoip/compare/v2.0.0..v3.0.0) (2022-12-18 08:36:22)
+
+
+### Bug Fix
+
+* **App:** Package updates | MP | [e3278aa2ee04c529eebdee3c1f37ad1f8fd19425](https://github.com/admiralcloud/ac-geoip/commit/e3278aa2ee04c529eebdee3c1f37ad1f8fd19425)    
+Package updates - ac-geoip now requires Node 16+  
+Related issues: [/issues#undefined](https://github.com//issues/undefined)
+## BREAKING CHANGES
+* **App:** Node > 16 is required
+<a name="2.0.0"></a>
+ 
+# [2.0.0](https://github.com/admiralcloud/ac-geoip/compare/v1.4.2..v2.0.0) (2022-01-29 11:56:17)
+
+
+### Bug Fix
+
+* **App:** Open geolite DB during initialisation | VD | [37b6981913f08798c1b764021d528497f8cc238f](https://github.com/admiralcloud/ac-geoip/commit/37b6981913f08798c1b764021d528497f8cc238f)    
+Open geolite DB during initialisation  
+Related issues: [undefined/undefined#AC-2500](undefined/browse/AC-2500)
+* **App:** Cache geoip2 Reader object | VD | [54a67bb2d186ccf10ec72e8b370ce9a51c2ab89c](https://github.com/admiralcloud/ac-geoip/commit/54a67bb2d186ccf10ec72e8b370ce9a51c2ab89c)    
+Store object to re-use instead of opening DB file each time it's needed.  
+Related issues: [undefined/undefined#AC-2500](undefined/browse/AC-2500)
+* **App:** Remove callbacks from async functions | VD | [6c4a6ecd0ce8f8350eb206b41be0d90ddaf09ee5](https://github.com/admiralcloud/ac-geoip/commit/6c4a6ecd0ce8f8350eb206b41be0d90ddaf09ee5)    
+Mixing async and callback functions makes code read hard, misunderstand the results and make function behave unpredictably.  
+Related issues: [undefined/undefined#AC-2500](undefined/browse/AC-2500)
+### Style
+
+* **App:** Get rid of semicollons, code re-aligning | VD | [e27005f2001a0da06d12fe272a3e007937f1604b](https://github.com/admiralcloud/ac-geoip/commit/e27005f2001a0da06d12fe272a3e007937f1604b)    
+Get rid of semicollons, code re-aligning
+### Chores
+
+* **App:** Updated packages | MP | [49f68ab1575163f6b9e9a845a23cd779195d9a41](https://github.com/admiralcloud/ac-geoip/commit/49f68ab1575163f6b9e9a845a23cd779195d9a41)    
+Updated packages
+## BREAKING CHANGES
+* **App:** * lookupLocal, lookup functions fully async and doesn't have callback parameters
 <a name="1.4.2"></a>
 
 ## [1.4.2](https://github.com/admiralcloud/ac-geoip/compare/v1.4.1..v1.4.2) (2021-10-09 10:25:40)

package/README.md

@@ -28,7 +28,7 @@ async() {
 const acgeoip = require('./index')
 
 let geoip = {
-  geolite: {
+  geolite: { 
     enabled: true,
     path: '/path/to/GeoLite2-City.mmdb'
   }

package/index.js

@@ -2,14 +2,14 @@ const _ = require('lodash')
 const ipPackage = require('ip')
 const fs = require('fs')
 
-const WebServiceClient = require('@maxmind/geoip2-node').WebServiceClient;
-const Reader = require('@maxmind/geoip2-node').Reader;
+const WebServiceClient = require('@maxmind/geoip2-node').WebServiceClient
+const Reader = require('@maxmind/geoip2-node').Reader
 
-const NodeCache = require( "node-cache" );
-const geoCache = new NodeCache( { stdTTL: 7*86400, checkperiod: 3600 } );
+const NodeCache = require("node-cache")
+const geoCache = new NodeCache({ stdTTL: 7 * 86400, checkperiod: 3600 })
 
 const acgeoip = () => {
-  
+
   let geoip = {
     userId: 'userId',
     licenseKey: 'licenseKey',
@@ -45,22 +45,22 @@ const acgeoip = () => {
       const dbBuffer = fs.readFileSync(_.get(geoip, 'geolite.path'))
       geoip.reader = Reader.openBuffer(dbBuffer)
     }
+    else {
+      Reader.open(_.get(geoip, 'geolite.path')).then(geoipReader => {
+        geoip.geolite.reader = geoipReader
+      })
+    }
   }
 
-
-
-  const lookupLocal = async(params, cb) => {
+  const lookupLocal = async (params) => {
     const functionName = 'ac-geoip | lookupLocal'
     if (!_.get(geoip, 'geolite.enabled')) {
-      let message = 'acgeoip_geolite_notEnabled'
-      if (_.isFunction(cb)) return cb({ message })
+      const message = 'acgeoip_geolite_notEnabled'
       throw Error(message)
     }
+
     const ip = _.get(params, 'ip')
-    if (ipPackage.isPrivate(ip)) {
-      if (_.isFunction(cb)) return cb()
-      return
-    }
+    if (ipPackage.isPrivate(ip)) return
 
     const mapping = _.get(params, 'mapping', geoip.mapping)
     const debug = _.get(params, 'debug')
@@ -73,11 +73,17 @@ const acgeoip = () => {
     let geoipResponse
 
     if (geoip.redis) {
-      geoipResponse = await checkRedis(params)
+      try {
+        geoipResponse = await checkRedis(params)
+      }
+      catch (err) {
+        console.error('AC-GEOIP | From Geolite | Failed | %j', err)
+      }
     }
     else {
       geoipResponse = getFromMemory({ ip })
     }
+
     if (debugPerformance) console.log('%s | getFromCache %d', functionName, performanceHelper(start, process.hrtime()))
 
     if (!geoipResponse) {
@@ -88,31 +94,34 @@ const acgeoip = () => {
       else {
         try {
           if (_.get(geoip, 'geolite.enabled')) {
-            geoipResponse = await new Promise((resolve, reject) => {
-                Reader.open(_.get(geoip, 'geolite.path')).then(reader => {
-                const response = reader.city(ip)
-                resolve(response)
-              }).catch(reject)
-            })
+            let geoipReader = _.get(geoip, 'geolite.reader')
+            if (!geoipReader) {
+              geoipReader = await Reader.open(_.get(geoip, 'geolite.path'))
+              _.set(geoip, 'geolite.reader', geoipReader)
+            }
+            if (geoipReader) geoipResponse = geoipReader.city(ip)
           }
+
           if (debugPerformance) console.log('%s | readFromDB %d', functionName, performanceHelper(start, process.hrtime()))
 
           if (debug) {
             console.log('AC-GEOIP | From Geolite | %j', geoipResponse)
           }
         }
-        catch(e) {
+        catch (e) {
           console.error('AC-GEOIP | From Geolite | Failed | %j', e)
         }
       }
+
       if (geoipResponse) {
         _.set(geoipResponse, 'origin', 'db')
         if (geoip.redis) {
-          await storeRedis({ ip, geoipResponse })  
+          await storeRedis({ ip, geoipResponse })
         }
         else {
-          storeInMemory({ ip, geoipResponse })          
+          storeInMemory({ ip, geoipResponse })
         }
+
         if (debugPerformance) console.log('%s | storeInCache %d', functionName, performanceHelper(start, process.hrtime()))
       }
     }
@@ -126,24 +135,23 @@ const acgeoip = () => {
     else {
       response = geoipResponse
     }
+
     _.set(response, 'origin', _.get(geoipResponse, 'origin'))
     if (_.get(geoipResponse, 'fromCache')) _.set(response, 'fromCache', true)
 
     if (debugPerformance) console.log('%s | Finished %d', functionName, performanceHelper(start, process.hrtime()))
-    if (_.isFunction(cb)) return cb(null, response)
+
     return response
   }
 
-  const lookup = async(params, cb) => {
+  const lookup = async (params) => {
     const functionName = 'ac-geoip | lookup'
     if (!_.get(geoip, 'licenseKey') || _.get(geoip, 'licenseKey') === 'licenseKey') {
-      let message = 'acgeoip_licenseKey_missing'
-      if (_.isFunction(cb)) return cb({ message })
+      const message = 'acgeoip_licenseKey_missing'
       throw Error(message)
     }
     const ip = _.get(params, 'ip')
     if (ipPackage.isPrivate(ip)) {
-      if (_.isFunction(cb)) return cb()
       return
     }
 
@@ -151,7 +159,7 @@ const acgeoip = () => {
     const debug = _.get(params, 'debug')
     const debugPerformance = _.get(params, 'debugPerforance')
     const start = process.hrtime()
-    
+
     let response = {
       ip
     }
@@ -169,11 +177,7 @@ const acgeoip = () => {
     if (!_.get(geoipResponse, 'country')) {
       try {
         const client = new WebServiceClient(geoip.userId, geoip.licenseKey)
-        geoipResponse = await new Promise((resolve, reject) => {
-            client.city(ip).then(result => {
-              return resolve(result)
-          }).catch(reject)
-        })
+        geoipResponse = await client.city(ip)
         if (debugPerformance) console.log('%s | readFromWebservice %d', functionName, performanceHelper(start, process.hrtime()))
         if (geoipResponse) {
           _.set(geoipResponse, 'origin', 'webservice')
@@ -183,17 +187,17 @@ const acgeoip = () => {
           console.log('AC-GEOIP | From Maxmind | %j', geoipResponse)
         }
       }
-      catch(e) {
+      catch (e) {
         console.error('AC-GEOIP | From Maxmind | Failed | %j', e)
       }
     }
 
     if (geoipResponse) {
       if (geoip.redis) {
-        await storeRedis({ ip, geoipResponse })  
+        await storeRedis({ ip, geoipResponse })
       }
       else {
-        storeInMemory({ ip, geoipResponse })          
+        storeInMemory({ ip, geoipResponse })
       }
       if (debugPerformance) console.log('%s | storeInCache %d', functionName, performanceHelper(start, process.hrtime()))
     }
@@ -211,7 +215,6 @@ const acgeoip = () => {
     _.set(response, 'origin', _.get(geoipResponse, 'origin'))
     if (_.get(geoipResponse, 'fromCache')) _.set(response, 'fromCache', true)
 
-    if (_.isFunction(cb)) return cb(null, response)
     return response
   }
 
@@ -228,13 +231,10 @@ const acgeoip = () => {
     return geoCache.get(storageKey)
   }
 
-
-  const checkRedis = async(params, cb) => {
+  const checkRedis = async (params) => {
     const refresh = _.get(params, 'refresh')
-    if (!geoip.redis || refresh) {
-      if (_.isFunction(cb)) return cb()
-      return
-    }
+    if (!geoip.redis || refresh) return
+
     const ip = _.get(params, 'ip')
     const redisKey = _.get(geoip, 'environment') + ':geoip:' + ip
     const debug = _.get(params, 'debug')
@@ -250,14 +250,14 @@ const acgeoip = () => {
         console.log('AC-GEOIP | From Cache | %j', geoipResponse)
       }
     }
-    catch(e) {
+    catch (e) {
       console.log(e)
       console.error('AC-GEOIP | From Cache | Failed | %j', e)
     }
     return geoipResponse
   }
 
-  const storeRedis = async(params) => {
+  const storeRedis = async (params) => {
     const refresh = _.get(params, 'refresh')
     if (!geoip.redis || refresh) {
       return
@@ -273,10 +273,9 @@ const acgeoip = () => {
     const accuracy = _.get(options, 'accuracy', 1e6)
     const s = t2[0] - t1[0]
     const mms = t2[1] - t1[1]
-    return (s*1e9 + mms)/accuracy
+    return (s * 1e9 + mms) / accuracy
   }
 
-
   return {
     init,
     lookup,

package/package.json

@@ -3,24 +3,24 @@
   "author": "Mark Poepping (https://www.admiralcloud.com)",
   "license": "MIT",
   "repository": "admiralcloud/ac-geoip",
-  "version": "1.4.2",
+  "version": "3.0.0",
   "dependencies": {
-    "@maxmind/geoip2-node": "^3.2.0",
-    "ip": "^1.1.5",
+    "@maxmind/geoip2-node": "^3.5.0",
+    "ip": "^1.1.8",
     "lodash": "^4.17.21",
     "node-cache": "^5.1.2"
   },
   "devDependencies": {
-    "ac-semantic-release": "^0.2.6",
-    "chai": "^4.3.4",
-    "eslint": "^7.32.0",
-    "ioredis": "^4.27.10",
-    "mocha": "^9.1.2"
+    "ac-semantic-release": "^0.3.4",
+    "chai": "^4.3.7",
+    "eslint": "^8.30.0",
+    "ioredis": "^5.2.4",
+    "mocha": "^10.2.0"
   },
   "scripts": {
     "test": "./node_modules/.bin/mocha --bail --exit --slow 1000 ./test/test.js || :"
   },
   "engines": {
-    "node": ">=8.0.0"
+    "node": ">=16.0"
   }
 }