feat: Use prefix instead of name.

Fixes #3

Author: adrianprelipcean

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@acpr/rate-limit-postgresql",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "A PostgreSQL store for the `express-rate-limit` middleware",
   "homepage": "https://github.com/adrianprelipcean/express-rate-limit-postgresql",
   "repository": "https://github.com/adrianprelipcean/express-rate-limit-postgresql",
@@ -61,7 +61,7 @@
   ],
   "dependencies": {
     "@types/pg-pool": "2.0.3",
-    "express-rate-limit": "6.11.0",
+    "express-rate-limit": "6.11.1",
     "pg": "8.11.3",
     "pg-pool": "3.6.1",
     "postgres-migrations": "5.3.0"

package.json

@@ -103,8 +103,9 @@ Both types of store take the same input in their constructor
 
 - `config` - The database configuration as specified in the
   [node-postgres](https://node-postgres.com/apis/client) configuration.
-- `name` - The unique name of the session. This is useful when applying multiple
-  rate limiters with multiple stores.
+- `prefix` - The unique name of the session (persisted in the database). Used by
+  the double-count check to avoid false-positives when a key is counted twice,
+  but with different prefixes.
 
 ## Installation
 

readme.md

@@ -18,9 +18,11 @@ class PostgresStoreAggregatedIP implements Store {
 	config: any
 
 	/**
-	 * The name of the session
+	 * Optional value that the store prepends to keys
+	 *
+	 * Used by the double-count check to avoid false-positives when a key is counted twice, but with different prefixes
 	 */
-	name: string
+	prefix: string
 
 	/**
 	 * The type of session (as an enum)
@@ -56,11 +58,11 @@ class PostgresStoreAggregatedIP implements Store {
 	 * @constructor for `PostgresStoreAggregatedIP`.
 	 *
 	 * @param config {any} - The database configuration as specified in https://node-postgres.com/apis/client.
-	 * @param name {string} - The unique name of the session. This is useful when applying multiple rate limiters with multiple stores.
+	 * @param prefix {string} - The unique name of the session. This is useful when applying multiple rate limiters with multiple stores.
 	 */
-	constructor(config: any, name: string) {
+	constructor(config: any, prefix: string) {
 		this.config = config
-		this.name = name
+		this.prefix = prefix
 		applyMigrations(config)
 	}
 
@@ -96,7 +98,7 @@ class PostgresStoreAggregatedIP implements Store {
             `
 		if (!isSessionValid(this.session)) {
 			this.session = await getSession(
-				this.name,
+				this.prefix,
 				this.SESSION_TYPE,
 				this.windowMs,
 				this.pool,

source/stores/aggregated_ip/store_aggregated_ip.ts

@@ -23,9 +23,11 @@ class PostgresStoreIndividualIP implements Store {
 	pool: any
 
 	/**
-	 * The name of the session
+	 * Optional value that the store prepends to keys
+	 *
+	 * Used by the double-count check to avoid false-positives when a key is counted twice, but with different prefixes
 	 */
-	name: string
+	prefix: string
 
 	/**
 	 * The type of session (as an enum)
@@ -56,11 +58,11 @@ class PostgresStoreIndividualIP implements Store {
 	 * @constructor for `PostgresStoreIndividualIP`.
 	 *
 	 * @param config {any} - The database configuration as specified in https://node-postgres.com/apis/client.
-	 * @param name {string} - The unique name of the session. This is useful when applying multiple rate limiters with multiple stores.
+	 * @param prefix {string} - The unique name of the session. This is useful when applying multiple rate limiters with multiple stores.
 	 */
-	constructor(config: any, name: string) {
+	constructor(config: any, prefix: string) {
 		this.config = config
-		this.name = name
+		this.prefix = prefix
 		applyMigrations(config)
 	}
 
@@ -94,7 +96,7 @@ class PostgresStoreIndividualIP implements Store {
 			'SELECT count(id) AS count FROM rate_limit.individual_records WHERE key = $1 AND session_id = $2'
 		if (!isSessionValid(this.session)) {
 			this.session = await getSession(
-				this.name,
+				this.prefix,
 				this.SESSION_TYPE,
 				this.windowMs,
 				this.pool,

source/stores/individual_ip/store_individual_ip.ts

@@ -50,8 +50,9 @@ describe('Postgres Store Aggregated IP', () => {
 		isSessionValidSpy.restore()
 	})
 
-	it('constructor should call correct functions', async () => {
-		new PostgresStore({}, 'test')
+	it('constructor should call correct functions and populate correct fields', async () => {
+		let testStore = new PostgresStore({}, 'test')
+		assert.equal(testStore.prefix, 'test')
 		sinon.assert.callCount(applyMigrationsStub, 1)
 	})
 

test/stores/store_aggregated_ip.spec.ts

@@ -50,9 +50,10 @@ describe('Postgres Store Individual IP', () => {
 		isSessionValidSpy.restore()
 	})
 
-	it('constructor should call correct functions', async () => {
-		new PostgresStoreIndividualIP({}, 'test')
+	it('constructor should call correct functions and populate correct fields', async () => {
+		let testStore = new PostgresStoreIndividualIP({}, 'test')
 		sinon.assert.callCount(applyMigrationsStub, 1)
+		assert.equal(testStore.prefix, 'test')
 	})
 
 	it('increment function should follow expected business logic', async () => {

test/stores/store_individual_ip.spec.ts

@@ -1,5 +1,5 @@
 {
-    "@acpr/[email protected].0": {
+    "@acpr/[email protected].1": {
         "licenses": "MIT",
         "repository": "https://github.com/adrianprelipcean/express-rate-limit-postgresql",
         "publisher": "Adrian C. Prelipcean"

third_party_licenses/dev_detailed.json

@@ -1,5 +1,5 @@
 {
-    "@acpr/[email protected].0": {
+    "@acpr/[email protected].1": {
         "licenses": "MIT",
         "repository": "https://github.com/adrianprelipcean/express-rate-limit-postgresql",
         "publisher": "Adrian C. Prelipcean"
@@ -107,7 +107,7 @@
         "licenses": "MIT",
         "repository": "https://github.com/jshttp/etag"
     },
-    "[email protected].0": {
+    "[email protected].1": {
         "licenses": "MIT",
         "repository": "https://github.com/express-rate-limit/express-rate-limit",
         "publisher": "Nathan Friedly"