rate-limiter-flexible 3.0.1 → 3.0.3

package/lib/RateLimiterPostgres.js

@@ -14,6 +14,7 @@ class RateLimiterPostgres extends RateLimiterStoreAbstract {
    *   storeClient: postgresClient,
    *   storeType: 'knex', // required only for Knex instance
    *   tableName: 'string',
+   *   schemaName: 'string', // optional
    * }
    */
   constructor(opts, cb = null) {
@@ -23,6 +24,7 @@ class RateLimiterPostgres extends RateLimiterStoreAbstract {
     this.clientType = opts.storeType;
 
     this.tableName = opts.tableName;
+    this.schemaName = opts.schemaName;
 
     this.clearExpiredByTimeout = opts.clearExpiredByTimeout;
 
@@ -46,17 +48,24 @@ class RateLimiterPostgres extends RateLimiterStoreAbstract {
           }
         });
     } else {
+      if (this.clearExpiredByTimeout) {
+        this._clearExpiredHourAgo();
+      }
       if (typeof cb === 'function') {
         cb();
       }
     }
   }
 
+  _getTableIdentifier() {
+    return this.schemaName ? `"${this.schemaName}"."${this.tableName}"` : `"${this.tableName}"`;
+  }
+
   clearExpired(expire) {
     return new Promise((resolve) => {
       const q = {
         name: 'rlflx-clear-expired',
-        text: `DELETE FROM "${this.tableName}" WHERE expire < $1`,
+        text: `DELETE FROM ${this._getTableIdentifier()} WHERE expire < $1`,
         values: [expire],
       };
       this._query(q)
@@ -150,7 +159,7 @@ class RateLimiterPostgres extends RateLimiterStoreAbstract {
   }
 
   _getCreateTableStmt() {
-    return `CREATE TABLE IF NOT EXISTS "${this.tableName}" (
+    return `CREATE TABLE IF NOT EXISTS ${this._getTableIdentifier()} (
       key varchar(255) PRIMARY KEY,
       points integer NOT NULL DEFAULT 0,
       expire bigint
@@ -190,8 +199,16 @@ class RateLimiterPostgres extends RateLimiterStoreAbstract {
     this._tableName = typeof value === 'undefined' ? this.keyPrefix : value;
   }
 
+  get schemaName() {
+    return this._schemaName;
+  }
+
+  set schemaName(value) {
+    this._schemaName = value;
+  }
+
   get tableCreated() {
-    return this._tableCreated
+    return this._tableCreated;
   }
 
   set tableCreated(value) {
@@ -252,18 +269,18 @@ class RateLimiterPostgres extends RateLimiterStoreAbstract {
     const expireQ = forceExpire
       ? ' $3 '
       : ` CASE
-             WHEN "${this.tableName}".expire <= $4 THEN $3
-             ELSE "${this.tableName}".expire
+             WHEN ${this._getTableIdentifier()}.expire <= $4 THEN $3
+             ELSE ${this._getTableIdentifier()}.expire
             END `;
 
     return this._query({
       name: forceExpire ? 'rlflx-upsert-force' : 'rlflx-upsert',
       text: `
-            INSERT INTO "${this.tableName}" VALUES ($1, $2, $3)
+            INSERT INTO ${this._getTableIdentifier()} VALUES ($1, $2, $3)
               ON CONFLICT(key) DO UPDATE SET
                 points = CASE
-                          WHEN ("${this.tableName}".expire <= $4 OR 1=${forceExpire ? 1 : 0}) THEN $2
-                          ELSE "${this.tableName}".points + ($2)
+                          WHEN (${this._getTableIdentifier()}.expire <= $4 OR 1=${forceExpire ? 1 : 0}) THEN $2
+                          ELSE ${this._getTableIdentifier()}.points + ($2)
                          END,
                 expire = ${expireQ}
             RETURNING points, expire;`,
@@ -280,7 +297,7 @@ class RateLimiterPostgres extends RateLimiterStoreAbstract {
       this._query({
         name: 'rlflx-get',
         text: `
-            SELECT points, expire FROM "${this.tableName}" WHERE key = $1 AND (expire > $2 OR expire IS NULL);`,
+            SELECT points, expire FROM ${this._getTableIdentifier()} WHERE key = $1 AND (expire > $2 OR expire IS NULL);`,
         values: [rlKey, Date.now()],
       })
         .then((res) => {
@@ -302,7 +319,7 @@ class RateLimiterPostgres extends RateLimiterStoreAbstract {
 
     return this._query({
       name: 'rlflx-delete',
-      text: `DELETE FROM "${this.tableName}" WHERE key = $1`,
+      text: `DELETE FROM ${this._getTableIdentifier()} WHERE key = $1`,
       values: [rlKey],
     })
       .then(res => res.rowCount > 0);

package/lib/index.d.ts

@@ -247,10 +247,14 @@ interface IRateLimiterMongoOptions extends IRateLimiterStoreOptions {
     };
 }
 
+interface IRateLimiterPostgresOptions extends IRateLimiterStoreNoAutoExpiryOptions {
+    schemaName?: string;
+}
+
 interface IRateLimiterRedisOptions extends IRateLimiterStoreOptions {
-  rejectIfRedisNotReady?: boolean;
-  useRedisPackage?: boolean;
-  useRedis3AndLowerPackage?: boolean;
+    rejectIfRedisNotReady?: boolean;
+    useRedisPackage?: boolean;
+    useRedis3AndLowerPackage?: boolean;
 }
 
 interface ICallbackReady {
@@ -283,7 +287,7 @@ export class RateLimiterClusterMasterPM2 {
 }
 
 export class RateLimiterRedis extends RateLimiterStoreAbstract {
-  constructor(opts: IRateLimiterRedisOptions);
+    constructor(opts: IRateLimiterRedisOptions);
 }
 
 export interface IRateLimiterMongoFunctionOptions {
@@ -342,10 +346,10 @@ export class RateLimiterMySQL extends RateLimiterStoreAbstract {
 }
 
 export class RateLimiterPostgres extends RateLimiterStoreAbstract {
-    constructor(opts: IRateLimiterStoreNoAutoExpiryOptions, cb?: ICallbackReady);
+    constructor(opts: IRateLimiterPostgresOptions, cb?: ICallbackReady);
 }
 
-export class RateLimiterMemcache extends RateLimiterStoreAbstract {}
+export class RateLimiterMemcache extends RateLimiterStoreAbstract { }
 
 export class RateLimiterUnion {
     constructor(...limiters: RateLimiterAbstract[]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rate-limiter-flexible",
-  "version": "3.0.1",
+  "version": "3.0.3",
   "description": "Node.js rate limiter by key and protection from DDoS and Brute-Force attacks in process Memory, Redis, MongoDb, Memcached, MySQL, PostgreSQL, Cluster or PM",
   "main": "index.js",
   "scripts": {