ac-ratelimiter 2.0.0 → 2.0.2

package/CHANGELOG.md

@@ -1,3 +1,23 @@
+<a name="2.0.2"></a>
+
+## [2.0.2](https://github.com/admiralcloud/ac-ratelimiter/compare/v2.0.1..v2.0.2) (2024-07-06 18:51:38)
+
+
+### Bug Fix
+
+* **Limiter:** Replaced isPrivateIP with isSpecialIP | MP | [d14140a22a00e5a18eb21d286712f21f8daea8f3](https://github.com/admiralcloud/ac-ratelimiter/commit/d14140a22a00e5a18eb21d286712f21f8daea8f3)    
+Replaced isPrivateIP with isSpecialIP  
+Related issues: [undefined/undefined#master](undefined/browse/master)
+<a name="2.0.1"></a>
+
+## [2.0.1](https://github.com/admiralcloud/ac-ratelimiter/compare/v2.0.0..v2.0.1) (2024-07-06 14:32:00)
+
+
+### Bug Fix
+
+* **Limiter:** Updated packages | MP | [6d31ce52d1b300021ba471c3a6261859604ceec5](https://github.com/admiralcloud/ac-ratelimiter/commit/6d31ce52d1b300021ba471c3a6261859604ceec5)    
+Updated packages. Use ACError package. Fixed tests for updated packages  
+Related issues: [undefined/undefined#develop](undefined/browse/develop)
 <a name="2.0.0"></a>
  
 # [2.0.0](https://github.com/admiralcloud/ac-ratelimiter/compare/v1.0.10..v2.0.0) (2024-02-26 07:51:24)

package/index.js

@@ -2,23 +2,7 @@ const  { setTimeout } = require('timers/promises')
 
 const NodeCache = require('node-cache')
 const acts = require('ac-ip')
-
-class ACError extends Error {
-  constructor(message, options = {}) {
-    super(message)
-    
-    if (Error.captureStackTrace) {
-      Error.captureStackTrace(this, ACError)
-    }
-    // info
-    this.code = options.code || -1
-    this.errorMessage = message
-    // show other properties of options object
-    for (const [key, value] of Object.entries(options)) {
-      this[key] = value;
-    }    
-  }
-}
+const { ACError } = require('ac-custom-error') 
 
 class RateLimiter {
   constructor({ redisInstance, logger = console, routes = [], knownIPs = [], ignorePrivateIps } = {}) {
@@ -76,7 +60,7 @@ class RateLimiter {
     rateLimitCounter
   }) {
 
-    if (this.ignorePrivateIps && acts.isPrivate(ip)) return
+    if (this.ignorePrivateIps && acts.isSpecialIP(ip)) return
 
     const logIdentifier = typeof identifier === 'string' && identifier.replace(/(\w{1,4})-(\w{1,4})/g, 'xxxx')
     const knownIP = this.knownIPs.find(({ knownIP }) => knownIP === ip)
@@ -115,7 +99,7 @@ class RateLimiter {
       })
     }
     
-    let current = {
+    const current = {
       expires,
       limit,
       throttleLimit,
@@ -145,7 +129,7 @@ class RateLimiter {
     else {
       // use Node cache (memory) for rate limiting - please see README before using in production!
       rateLimitCounter = this.cache.get(rateLimiterKey)
-      let ts = this.cache.getTtl(rateLimiterKey) // ts in ms when the key will expire
+      const ts = this.cache.getTtl(rateLimiterKey) // ts in ms when the key will expire
       rateLimitCounter = rateLimitCounter + 1 || 1
       if (ts === undefined || ts === 0) {
         // first entry - set expiration
@@ -167,7 +151,7 @@ class RateLimiter {
       if (rateLimitCounter === current.limit || rateLimitCounter % 10 === 0) {
         rateLogger({ type: 'Blocking', rateLimitCounter, currentLimit: current.limit })
       }
-      throw new ACError('tooManyRequestsFromThisIP', { status: 429, logging: false, counter: rateLimitCounter, additionalInfo: { expires: current.expires } })
+      throw new ACError('tooManyRequestsFromThisIP', 429, { logging: false, counter: rateLimitCounter, expires: current.expires })
       
     }
     else if (current.throttleLimit && rateLimitCounter > current.limit * 0.9) {
@@ -176,7 +160,7 @@ class RateLimiter {
       await setTimeout(current.expires * 1000)
       // do not "taint" process time when deliberately throttline
       if (req._startTime) req._startTime += current.expires * 1000
-      throw new ACError('finalThrottlingActive_requestsIsDelayed', { status: 900, additionalInfo: { counter: rateLimitCounter, expires: current.expires } })
+      throw new ACError('finalThrottlingActive_requestsIsDelayed', 900, { counter: rateLimitCounter, expires: current.expires })
     }
     else if (current.throttleLimit && rateLimitCounter > current.throttleLimit) {
       // log the first throttling and every 50th entry
@@ -186,7 +170,7 @@ class RateLimiter {
       await setTimeout(current.delay)
       // do not "taint" process time when deliberately throttline
       if (req._startTime) req._startTime += current.delay
-      throw new ACError('throttlingActive_requestsIsDelayed', { status: 900, additionalInfo: { counter: rateLimitCounter, expires: current.expires } })
+      throw new ACError('throttlingActive_requestsIsDelayed', 900, { counter: rateLimitCounter, expires: current.expires })
     }
   }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ac-ratelimiter",
   "description": "Simple ratelimiter for express",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "author": "Mark Poepping (www.admiralcloud.com)",
   "repository": {
     "type": "git",
@@ -9,22 +9,26 @@
   },
   "homepage": "https://www.admiralcloud.com",
   "dependencies": {
-    "ac-ip": "^3.1.1",
+    "ac-custom-error": "^1.0.0",
+    "ac-ip": "^4.1.0",
     "node-cache": "^5.1.2"
   },
   "devDependencies": {
     "ac-semantic-release": "^0.4.2",
     "chai": "^4.4.1",
-    "eslint": "8.57.0",
-    "ioredis": "^5.3.2",
-    "mocha": "^10.3.0"
+    "eslint": "9.6.0",
+    "ioredis": "^5.4.1",
+    "mocha": "^10.6.0"
   },
   "scripts": {
-    "test": "./node_modules/.bin/mocha --slow 1000 --colors ./test/test.js || :",
-    "test-local": "env TESTMODE=true ./node_modules/.bin/mocha --slow 1000 --colors ./test/test.js || :",
+    "test": "./node_modules/.bin/mocha --slow 1000 --colors --bail ./test/test.js || :",
+    "test-local": "env TESTMODE=true ./node_modules/.bin/mocha --slow 1000 --colors --bail ./test/test.js || :",
     "test-jenkins": "JUNIT_REPORT_PATH=./report.xml mocha --slow 1000 --colors --reporter mocha-jenkins-reporter --reporter-options junit_report_name='RATELIMITER'"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=18.0.0"
+  },
+  "resolutions": {
+    "mocha/chokidar/braces": "^3.0.3"
   }
 }

package/test/test.js

@@ -6,7 +6,7 @@ const ratelimiterModule = require('../index')
 const Redis = require('ioredis')
 const redis = new Redis()
 
-let req = {
+const req = {
   options: {
     controller: 'user',
     action: 'find',
@@ -15,12 +15,12 @@ let req = {
 }
 
 
-let initOptions = {
+const initOptions = {
   routes: [
     { route: 'user/find', throttleLimit: 1, limit: 2, expires: 3, delay: 250 },
   ]
 }
-let options = {}
+const options = {}
 
 const ratelimiter = new ratelimiterModule(initOptions)
 const ratelimiterRedis = new ratelimiterModule({ redisInstance: redis, routes: initOptions.routes })
@@ -37,7 +37,7 @@ describe('Use NodeCache', () => {
       })
 
       it('should not trigger - req #1', async() => {
-        let result = await ratelimiter.limiter(req, options)
+        const result = await ratelimiter.limiter(req, options)
         expect(result).eql(undefined)
       })
       it('should still not trigger - req #2 - but throw 900', async() => {
@@ -45,12 +45,13 @@ describe('Use NodeCache', () => {
           await ratelimiter.limiter(req, options)
         }
         catch(e) {
+          console.log(45, e)
           expect(e).to.have.property('message', 'finalThrottlingActive_requestsIsDelayed')
-          expect(e).to.have.property('status', 900)
+          expect(e).to.have.property('code', 900)
         }
       })
       it('should not trigger - req #3 - rate limiter is reset', async() => {
-        let result = await ratelimiter.limiter(req, options)
+        const result = await ratelimiter.limiter(req, options)
         expect(result).eql(undefined)
       })
     })
@@ -81,7 +82,7 @@ describe('Use NodeCache', () => {
         catch(e) {
           expect(e).to.be.an('error')
           expect(e).to.have.property('message', 'tooManyRequestsFromThisIP')
-          expect(e).to.have.property('status', 429)
+          expect(e).to.have.property('code', 429)
         }
       })
     })
@@ -105,7 +106,7 @@ describe('Use NodeCache', () => {
 
       it('should not trigger req #1', async() => {
         req.determinedIP = '2.3.4.1'
-        let result = await ratelimiter.limiter(req, options)
+        const result = await ratelimiter.limiter(req, options)
         expect(result).eql(undefined)
       })
       it('should still not trigger - delayed req #2', async() => {
@@ -114,7 +115,7 @@ describe('Use NodeCache', () => {
         }
         catch(e) {
           expect(e).to.have.property('message', 'finalThrottlingActive_requestsIsDelayed')
-          expect(e).to.have.property('status', 900)
+          expect(e).to.have.property('code', 900)
         }
       })
       it('should trigger the limiter', async() => {
@@ -123,7 +124,7 @@ describe('Use NodeCache', () => {
         }
         catch(e) {
           expect(e).to.have.property('message', 'tooManyRequestsFromThisIP')
-          expect(e).to.have.property('status', 429)
+          expect(e).to.have.property('code', 429)
         }
       })
     })
@@ -132,7 +133,7 @@ describe('Use NodeCache', () => {
   describe('Test section #4 - routes with clientId', function() {
     describe('RATE LIMITER TEST', function() {
       this.timeout(5000)
-      let req = {
+      const req = {
         options: {
           controller: 'customer',
           action: 'find'
@@ -152,7 +153,7 @@ describe('Use NodeCache', () => {
       })
 
       it('should not trigger - req #1', async() => {
-        let result = await ratelimiter.limiter(req, options)
+        const result = await ratelimiter.limiter(req, options)
         expect(result).eql(undefined)
       })
       it('should still not trigger but delay - req #2', async() => {
@@ -161,11 +162,11 @@ describe('Use NodeCache', () => {
         }
         catch(e) {
           expect(e).to.have.property('message', 'finalThrottlingActive_requestsIsDelayed')
-          expect(e).to.have.property('status', 900)
+          expect(e).to.have.property('code', 900)
         }
       })
       it('should still not trigger as ratelimiter is reset', async() => {
-        let result = await ratelimiter.limiter(req, options)
+        const result = await ratelimiter.limiter(req, options)
         expect(result).eql(undefined)
       })
 
@@ -179,17 +180,17 @@ describe('Use NodeCache', () => {
       })
 
       it('should not trigger #1', async() => {
-        let result = await ratelimiter.limiter(req, options)
+        const result = await ratelimiter.limiter(req, options)
         expect(result).eql(undefined)
       })
 
       it('should not trigger #2', async() => {
-        let result = await ratelimiter.limiter(req, options)
+        const result = await ratelimiter.limiter(req, options)
         expect(result).eql(undefined)
       })
 
       it('should not trigger #3', async() => {
-        let result = await ratelimiter.limiter(req, options)
+        const result = await ratelimiter.limiter(req, options)
         expect(result).eql(undefined)
       })
 
@@ -199,7 +200,7 @@ describe('Use NodeCache', () => {
         }
         catch(e) {
           expect(e).to.have.property('message', 'throttlingActive_requestsIsDelayed')
-          expect(e).to.have.property('status', 900)
+          expect(e).to.have.property('code', 900)
         }
       })
     })
@@ -208,7 +209,7 @@ describe('Use NodeCache', () => {
   describe('Test section #5 - no limiting', function () {
     describe('RATE LIMITER TEST', function() {
       this.timeout(5000)
-      let req = {
+      const req = {
         options: {
           controller: 'search',
           action: 'search'
@@ -221,27 +222,27 @@ describe('Use NodeCache', () => {
       })
 
       it('should not trigger #1', async() => {
-        let result = await ratelimiter.limiter(req, options)
+        const result = await ratelimiter.limiter(req, options)
         expect(result).eql(undefined)
       })
 
       it('should not trigger #2', async() => {
-        let result = await ratelimiter.limiter(req, options)
+        const result = await ratelimiter.limiter(req, options)
         expect(result).eql(undefined)
       })
 
       it('should not trigger #3', async() => {
-        let result = await ratelimiter.limiter(req, options)
+        const result = await ratelimiter.limiter(req, options)
         expect(result).eql(undefined)
       })
 
       it('should not trigger #4', async() => {
-        let result = await ratelimiter.limiter(req, options)
+        const result = await ratelimiter.limiter(req, options)
         expect(result).eql(undefined)
       })
 
       it('should not trigger #5', async() => {
-        let result = await ratelimiter.limiter(req, options)
+        const result = await ratelimiter.limiter(req, options)
         expect(result).eql(undefined)
       })
     })
@@ -251,7 +252,7 @@ describe('Use NodeCache', () => {
     describe('RATE LIMITER TEST - ignorePrivateIps', function() {
       this.timeout(5000)
 
-      let req = {
+      const req = {
         options: {
           controller: 'user',
           action: 'find'
@@ -278,19 +279,19 @@ describe('Use NodeCache', () => {
         }
         catch(e) {
           expect(e).to.have.property('message', 'tooManyRequestsFromThisIP')
-          expect(e).to.have.property('status', 429)
+          expect(e).to.have.property('code', 429)
         }
       })
 
       it('should not trigger', async() => {
         req.determinedIP = '127.0.0.1'
-        let result = await ratelimiter.limiter(req, options)
+        const result = await ratelimiter.limiter(req, options)
         expect(result).eql(undefined)
       })
 
-      it('should not trigger - IPv6', async() => {
-        req.determinedIP = '::ffff:127.0.0.1'
-        let result = await ratelimiter.limiter(req, options)
+      it('should not trigger - private IPv6', async() => {
+        req.determinedIP = 'FD8A:4C5D:3E1F:0001:ABCD:1234:5678:9ABC'
+        const result = await ratelimiter.limiter(req, options)
         expect(result).eql(undefined)
       })
     })
@@ -313,7 +314,7 @@ describe('Use NodeCache', () => {
       })
 
       it('should not trigger', async() => {
-        let result = await ratelimiter.limiter(req, { rateLimitCounter: 0 })
+        const result = await ratelimiter.limiter(req, { rateLimitCounter: 0 })
         expect(result).eql(undefined)
       })
 
@@ -323,7 +324,7 @@ describe('Use NodeCache', () => {
         }
         catch(e) {
           expect(e).to.have.property('message', 'tooManyRequestsFromThisIP')
-          expect(e).to.have.property('status', 429)
+          expect(e).to.have.property('code', 429)
         }
       })
 
@@ -353,13 +354,13 @@ describe('Use Redis', () => {
     it('should trigger immediately', async()  => {
       req.determinedIP = '4.1.4.1'
       try {
-        let x = await ratelimiterRedis.limiter(req, options)
+        const x = await ratelimiterRedis.limiter(req, options)
         console.log(304, x)
       }
       catch(e) {
         expect(e).to.be.an('error')
         expect(e).to.have.property('message', 'tooManyRequestsFromThisIP')
-        expect(e).to.have.property('status', 429)
+        expect(e).to.have.property('code', 429)
       }
     })
 
@@ -376,7 +377,7 @@ describe('Use Redis', () => {
     })
 
     it('req #1 should not trigger', async()  => {
-      let result = await ratelimiterRedis.limiter(req, options)
+      const result = await ratelimiterRedis.limiter(req, options)
       expect(result).eql(undefined)
     })
 
@@ -388,13 +389,13 @@ describe('Use Redis', () => {
       catch(e) {
         expect(e).to.be.an('error')
         expect(e).to.have.property('message', 'finalThrottlingActive_requestsIsDelayed')
-        expect(e).to.have.property('status', 900)
+        expect(e).to.have.property('code', 900)
         expect(e.additionalInfo).to.have.property('counter', 2)
       }
     })
 
     it('req #3 should not trigger the limiter - the throttling has reset the limiter', async()  => {
-      let result = await ratelimiterRedis.limiter(req, options)
+      const result = await ratelimiterRedis.limiter(req, options)
       expect(result).eql(undefined)
     })
 

package/.eslintrc.js

@@ -1,28 +0,0 @@
-const config = {
-  root: true,
-  'env': {
-    'commonjs': true,
-    'es6': true,
-    'node': true
-  },
-  'extends': 'eslint:recommended',
-  "rules": {
-    "space-before-function-paren": 0,
-    "no-extra-semi": 0,
-    "object-curly-spacing": ["error", "always"],
-    "brace-style": ["error", "stroustrup", { "allowSingleLine": true }],
-    "no-useless-escape": 0,
-    "standard/no-callback-literal": 0,
-    "new-cap": 0
-  },
-  globals: {
-    describe: true,
-    it: true,
-    after: true
-  },
-  'parserOptions': {
-    'ecmaVersion': 2022
-},
-}
-
-module.exports = config