ac-ratelimiter 2.0.6 → 2.0.8

package/.github/CODEOWNERS

@@ -0,0 +1,9 @@
+# Code Owners
+#
+# This file defines who is responsible for code in this repository.
+# Reviews from code owners are automatically requested for pull requests.
+#
+# More info: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
+
+# Default owner for everything in the repo
+* @AdmiralCloud/ac-maintainer-backend

package/.github/workflows/node.js.yml

@@ -5,18 +5,21 @@ name: Node.js CI
 
 on:
   push:
-    branches: [ master, develop ]
+    branches: [ master ]
   pull_request:
-    branches: [ master, develop ]
+    branches: [ master ]
 
 jobs:
   build:
 
+    permissions:
+      contents: read    
+    
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        node-version: [16.x, 18.x]
+        node-version: [20.x, 22.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
         redis-version: [6]
 

package/CHANGELOG.md

@@ -1,4 +1,22 @@
 
+## [2.0.8](https://github.com/admiralcloud/ac-ratelimiter/compare/v2.0.7..v2.0.8) (2026-02-24 18:53:30)
+
+
+### Bug Fix
+
+* **Misc:** Package updates | MP | [2c1f50da711acab29e7e5c18c19a3be427c33100](https://github.com/admiralcloud/ac-ratelimiter/commit/2c1f50da711acab29e7e5c18c19a3be427c33100)    
+Package updates incl ESLint 9 -> 10 and lint fixes  
+Related issues:
+
+## [2.0.7](https://github.com/admiralcloud/ac-ratelimiter/compare/v2.0.6..v2.0.7) (2026-02-03 08:30:54)
+
+
+### Bug Fix
+
+* **Limiter:** Package updates | MP | [a4259bd5791eacaf62347bdb24029b67aa956647](https://github.com/admiralcloud/ac-ratelimiter/commit/a4259bd5791eacaf62347bdb24029b67aa956647)    
+Package updates  
+Related issues:
+
 ## [2.0.6](https://github.com/admiralcloud/ac-ratelimiter/compare/v2.0.5..v2.0.6) (2025-09-19 05:24:50)
 
 

package/Makefile

@@ -2,10 +2,10 @@ MOCHA_OPTS= --slow 0 -A
 REPORTER = spec
 
 lint-fix:
-	./node_modules/.bin/eslint --fix index.js test/test.js
+	./node_modules/.bin/eslint --fix
 
 lint-check:
-	./node_modules/.bin/eslint index.js test/test.js
+	./node_modules/.bin/eslint
 
 commit:
 	@node ./node_modules/ac-semantic-release/lib/commit.js

package/SECURITY.md

@@ -0,0 +1,22 @@
+# Security Policy
+
+## Supported Versions
+
+We only provide security updates for the latest version of this project. 
+
+If you are using an older version, please upgrade to the latest release to receive security fixes.
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability, please report it by creating a GitHub issue in this repository.
+
+Please include the following information:
+
+- Description of the vulnerability
+- Steps to reproduce the issue
+- Potential impact
+- Any suggested fixes (if you have them)
+
+We will review your report and respond as soon as possible.
+
+Thank you for helping keep AdmiralCloud and our users safe!

package/index.js

@@ -34,14 +34,14 @@ class RateLimiter {
   }
 
   whichStorage() {
-    if (this.redisInstance) return 'Redis'
-    else return 'NodeCache'
+    if (this.redisInstance) { return 'Redis' }
+    else { return 'NodeCache' }
   }
 
   // private 
   prepareRedisKey({ ip, controller = 'controller', action = 'action', clientId = 'clientId', identifier = 'identifier', redisKey }) {
     let rateLimiterKey = redisKey || (this.environment + ':rateLimiter:' + clientId + ':' + ip + ':' + controller + ':' + action)
-    if (identifier) rateLimiterKey += ':' + identifier
+    if (identifier) { rateLimiterKey += ':' + identifier }
     return rateLimiterKey
   }
 
@@ -60,7 +60,7 @@ class RateLimiter {
     rateLimitCounter
   }) {
 
-    if (this.ignorePrivateIps && acts.isSpecialIP(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)
@@ -81,21 +81,21 @@ class RateLimiter {
 
     const rateLogger = ({ type, rateLimitCounter, currentLimit }) => {
       this.logger.warn('-'.repeat(80))
-      if (debugMode) this.logger.warn('DEBUG MODE - DEBUG MODE - DEBUG MODE')
+      if (debugMode) { this.logger.warn('DEBUG MODE - DEBUG MODE - DEBUG MODE') }
       this.logger.warn('%s | %s | %s | %s | Counter %s/%s', 'ACRateLimiter'.padEnd(15), type.padEnd(12), currentRoute.padEnd(32), (ip + ' ' + (knownIP?.name || '')).padEnd(16), rateLimitCounter, currentLimit)
-      if (logIdentifier) this.logger.warn('%s | Identifier: %s', ' '.padEnd(15), logIdentifier)
+      if (logIdentifier) { this.logger.warn('%s | Identifier: %s', ' '.padEnd(15), logIdentifier) }
     }
 
     let settings = this.routes.find(item => {
-      if (ip && clientId && currentRoute && item.ip === ip && item.clientId === clientId && item.route === currentRoute ) return item
-      else if (ip && currentRoute && item.ip === ip && item.route === currentRoute && !item.clientId ) return item
-      else if (clientId && currentRoute && item.clientId === clientId && item.route === currentRoute && !item.ip) return item
-      else if (currentRoute && item.route === currentRoute && !item.clientId && !item.ip) return item
+      if (ip && clientId && currentRoute && item.ip === ip && item.clientId === clientId && item.route === currentRoute ) { return item }
+      else if (ip && currentRoute && item.ip === ip && item.route === currentRoute && !item.clientId ) { return item }
+      else if (clientId && currentRoute && item.clientId === clientId && item.route === currentRoute && !item.ip) { return item }
+      else if (currentRoute && item.route === currentRoute && !item.clientId && !item.ip) { return item }
     })
     if (!settings) {
       // check fallback route
       settings = this.routes.find(item => {
-        if (item.route === fallbackRoute && !item.clientId && !item.ip) return item
+        if (item.route === fallbackRoute && !item.clientId && !item.ip) { return item }
       })
     }
     
@@ -110,8 +110,8 @@ class RateLimiter {
     props.forEach(prop => {
       if (!Number.isFinite(current[prop])) {
         // use from setting
-        if (Number.isFinite(settings?.[prop])) current[prop] = settings[prop]
-        else current[prop] = this.limits[prop]
+        if (Number.isFinite(settings?.[prop])) { current[prop] = settings[prop] }
+        else { current[prop] = this.limits[prop] }
       }
     })
 
@@ -143,7 +143,7 @@ class RateLimiter {
     }
 
     if (debugMode) {
-      console.log('Route %s | Current Counter %s | Throttle %s | Limit %s | Delay %s | Expires %s', currentRoute, rateLimitCounter, current.throttleLimit, current.limit, current.delay, current.expires) 
+      console.warn('Route %s | Current Counter %s | Throttle %s | Limit %s | Delay %s | Expires %s', currentRoute, rateLimitCounter, current.throttleLimit, current.limit, current.delay, current.expires) 
     }
 
     if (rateLimitCounter > current.limit) {
@@ -159,7 +159,7 @@ class RateLimiter {
       rateLogger({ type: 'Final Throttling', rateLimitCounter, currentLimit: current.limit })
       await setTimeout(current.expires * 1000)
       // do not "taint" process time when deliberately throttline
-      if (req._startTime) req._startTime += current.expires * 1000
+      if (req._startTime) { req._startTime += current.expires * 1000 }
       throw new ACError('finalThrottlingActive_requestsIsDelayed', 900, { counter: rateLimitCounter, expires: current.expires })
     }
     else if (current.throttleLimit && rateLimitCounter > current.throttleLimit) {
@@ -169,15 +169,15 @@ class RateLimiter {
       }
       await setTimeout(current.delay)
       // do not "taint" process time when deliberately throttline
-      if (req._startTime) req._startTime += current.delay
+      if (req._startTime) { req._startTime += current.delay }
       throw new ACError('throttlingActive_requestsIsDelayed', 900, { counter: rateLimitCounter, expires: current.expires })
     }
   }
 
   async updateLimiter({ routes, knownIPs, ignorePrivateIps }) {
-    if (Array.isArray(routes)) this.routes = routes
-    if (Array.isArray(knownIPs)) this.knownIPs = knownIPs
-    if (typeof ignorePrivateIps === 'boolean') this.ignorePrivateIps = ignorePrivateIps
+    if (Array.isArray(routes)) { this.routes = routes }
+    if (Array.isArray(knownIPs)) { this.knownIPs = knownIPs }
+    if (typeof ignorePrivateIps === 'boolean') { this.ignorePrivateIps = ignorePrivateIps }
   }
 
   async resetLimiter() {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ac-ratelimiter",
   "description": "Simple ratelimiter for express",
-  "version": "2.0.6",
+  "version": "2.0.8",
   "author": "Mark Poepping (www.admiralcloud.com)",
   "repository": {
     "type": "git",
@@ -9,16 +9,17 @@
   },
   "homepage": "https://www.admiralcloud.com",
   "dependencies": {
-    "ac-custom-error": "^1.0.5",
-    "ac-ip": "^4.1.6",
+    "ac-custom-error": "^2.0.1",
+    "ac-ip": "^4.1.10",
     "node-cache": "^5.1.2"
   },
   "devDependencies": {
-    "ac-semantic-release": "^0.4.8",
+    "ac-semantic-release": "^0.4.10",
     "chai": "^4.5.0",
-    "eslint": "9.35.0",
-    "ioredis": "^5.7.0",
-    "mocha": "^11.7.2"
+    "eslint": "10.0.2",
+    "globals": "^17.3.0",
+    "ioredis": "^5.9.3",
+    "mocha": "^11.7.5"
   },
   "scripts": {
     "test": "./node_modules/.bin/mocha --slow 1000 --colors --bail ./test/test.js || :",
@@ -29,7 +30,9 @@
     "node": ">=18.0.0"
   },
   "resolutions": {
-    "mocha/chokidar/braces": "^3.0.3"
+    "mocha/chokidar/braces": "^3.0.3",
+    "mocha/diff": "^8.0.3",
+    "minimatch": "^10.2.1"
   },
   "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
 }

package/test/test.js

@@ -45,7 +45,6 @@ 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('code', 900)
         }
@@ -354,8 +353,7 @@ describe('Use Redis', () => {
     it('should trigger immediately', async()  => {
       req.determinedIP = '4.1.4.1'
       try {
-        const x = await ratelimiterRedis.limiter(req, options)
-        console.log(304, x)
+        await ratelimiterRedis.limiter(req, options)
       }
       catch(e) {
         expect(e).to.be.an('error')