test: added tests for aggregated store new implementation

adrianprelipcean · adrianprelipcean · commit 723dc32c2d0d · 2024-02-20T07:29:28.000+01:00
diff --git a/db/tests/performance/aggregated_ip.test.sql b/db/tests/performance/aggregated_ip.test.sql
@@ -28,31 +28,31 @@ VALUES ('test-update', '00000000-0000-0000-0000-000000000000'::uuid, 20),
 
 SELECT performs_ok(
     $bd$
-    SELECT agg_increment as count FROM rate_limit.agg_increment('test-update', '00000000-0000-0000-0000-000000000000');
+    SELECT * from rate_limit.agg_increment('test-update', 'dedicated-test', 1000) AS (count int, expires_at timestamptz);
     $bd$,
     250,
     'inserting record should execute under 250ms'
 );
 
 SELECT performs_ok(
     $bd$
-    SELECT * FROM rate_limit.agg_decrement('test-decrement', '00000000-0000-0000-0000-000000000000');
+    SELECT * FROM rate_limit.agg_decrement('test-decrement', 'dedicated-test');
     $bd$,
     250,
     'decrementing query execute under 250ms'
 );
 
 SELECT performs_ok(
     $bd$
-    SELECT * FROM rate_limit.agg_reset_key('test-reset-key', '00000000-0000-0000-0000-000000000000')
+    SELECT * FROM rate_limit.agg_reset_key('test-reset-key', 'dedicated-test')
     $bd$,
     250,
     'resetting a key should execute under 250ms'
 );
 
 SELECT performs_ok(
     $bd$
-    SELECT * FROM rate_limit.agg_reset_session('00000000-0000-0000-0000-000000000000');
+    SELECT * FROM rate_limit.agg_reset_session('dedicated-test');
     $bd$,
     250,
     'resetting a session should execute under 250ms'
diff --git a/db/tests/unit/agg_decrement.test.sql b/db/tests/unit/agg_decrement.test.sql
@@ -2,11 +2,12 @@ BEGIN;
 -- Plan the tests.
 SELECT plan(2);
 
-INSERT INTO rate_limit.sessions (id, name_, type_)
+INSERT INTO rate_limit.sessions (id, name_, type_, expires_at)
 SELECT
     '00000000-0000-0000-0000-000000000000'::uuid AS id,
     'dedicated-test'::text AS name_,
-    'aggregated'::text AS type_;
+    'aggregated'::text AS type_,
+    '2023-01-01 10:00:00+0' AS expires_at;
 
 INSERT INTO rate_limit.records_aggregated (key, session_id)
 SELECT
@@ -15,7 +16,7 @@ SELECT
 
 SELECT lives_ok(
     $have$
-    SELECT * FROM rate_limit.agg_decrement('existing-key', '00000000-0000-0000-0000-000000000000')
+    SELECT * FROM rate_limit.agg_decrement('existing-key', 'dedicated-test', '2023-01-01 09:00:00+0')
     $have$,
     'rate_limit.agg_decrement does not throw an error'
 );
diff --git a/db/tests/unit/agg_increment.test.sql b/db/tests/unit/agg_increment.test.sql
@@ -1,17 +1,25 @@
 BEGIN;
 -- Plan the tests.
-SELECT plan(3);
+SELECT plan(5);
 
-INSERT INTO rate_limit.sessions (id, name_, type_)
+INSERT INTO rate_limit.sessions (id, name_, type_, expires_at)
 SELECT
     '00000000-0000-0000-0000-000000000000'::uuid AS id,
     'dedicated-test'::text AS name_,
-    'aggregated'::text AS type_
+    'aggregated'::text AS type_,
+    '2023-01-01 10:00:00+0'::timestamptz AS expires_at
 UNION
 SELECT
     '00000000-1111-1111-1111-000000000000'::uuid AS id,
     'dedicated-test-2'::text AS name_,
-    'aggregated'::text AS type_;;
+    'aggregated'::text AS type_,
+    '2023-01-01 10:00:00+0' AS expires_at
+UNION
+SELECT
+    '00000000-2222-2222-2222-000000000000'::uuid AS id,
+    'dedicated-test-expired'::text AS name_,
+    'aggregated'::text AS type_,
+    '2023-01-01 08:00:00+0' AS expires_at;
 
 INSERT INTO rate_limit.records_aggregated (key, session_id)
 SELECT
@@ -20,34 +28,59 @@ SELECT
 
 SELECT results_eq(
     $have$
-    SELECT agg_increment AS count FROM rate_limit.agg_increment('new-key', '00000000-0000-0000-0000-000000000000')
+    SELECT * FROM rate_limit.agg_increment('new-key', 'dedicated-test', 1000, '2023-01-01 09:00:00+0') AS (count int, expires_at timestamptz);
     $have$,
     $want$
-    SELECT 1::int AS count;
+    SELECT 1::int AS count, '2023-01-01 10:00:00+0'::timestamptz as expires_at;
     $want$,
     'rate_limit.agg_increment returns correct count for new key'
 );
 
 SELECT results_eq(
     $have$
-    SELECT agg_increment AS count FROM rate_limit.agg_increment('new-key', '00000000-1111-1111-1111-000000000000')
+    SELECT * FROM rate_limit.agg_increment('new-key', 'dedicated-test-2', 1000, '2023-01-01 09:00:00+0') AS (count int, expires_at timestamptz);
     $have$,
     $want$
-    SELECT 1::int AS count;
+    SELECT 1::int AS count, '2023-01-01 10:00:00+0'::timestamptz as expires_at;
     $want$,
     'rate_limit.agg_increment returns correct count for new key on different session'
 );
 
 SELECT results_eq(
     $have$
-    SELECT agg_increment AS count FROM rate_limit.agg_increment('existing-key', '00000000-0000-0000-0000-000000000000')
+    SELECT * FROM rate_limit.agg_increment('existing-key', 'dedicated-test', 1000, '2023-01-01 09:00:00+0') AS (count int, expires_at timestamptz);
     $have$,
     $want$
-    SELECT 2::int AS count;
+    SELECT 2::int AS count, '2023-01-01 10:00:00+0'::timestamptz as expires_at;
     $want$,
     'rate_limit.agg_increment returns correct count for existing key'
 );
 
+SELECT results_eq(
+    $have$
+    SELECT * FROM rate_limit.agg_increment('existing-key', 'dedicated-test-expired', 1000, '2023-01-01 09:00:00+0') AS (count int, expires_at timestamptz);
+    $have$,
+    $want$
+    SELECT 1::int AS count, '2023-01-01 09:00:01+0'::timestamptz as expires_at;
+    $want$,
+    'rate_limit.agg_increment returns correct count for existing key for expired session'
+);
+
+SELECT bag_hasnt(
+    $have$
+    SELECT id, name_, type_, expires_at FROM rate_limit.sessions
+    $have$,
+    $miss$
+    SELECT
+    '00000000-2222-2222-2222-000000000000'::uuid AS id,
+    'dedicated-test-expired'::text AS name_,
+    'aggregated'::text AS type_,
+    '2023-01-01 08:00:00+0'::timestamptz as expires_at;
+    $miss$,
+    'expired session should not be reset after increment invoke'
+);
+
+
 -- Finish the tests and clean up.
 SELECT finish FROM finish();
 ROLLBACK;
diff --git a/db/tests/unit/agg_reset_key.test.sql b/db/tests/unit/agg_reset_key.test.sql
@@ -2,11 +2,12 @@ BEGIN;
 -- Plan the tests.
 SELECT plan(2);
 
-INSERT INTO rate_limit.sessions (id, name_, type_)
+INSERT INTO rate_limit.sessions (id, name_, type_, expires_at)
 SELECT
     '00000000-0000-0000-0000-000000000000'::uuid AS id,
     'dedicated-test'::text AS name_,
-    'aggregated'::text AS type_;
+    'aggregated'::text AS type_,
+    '2023-01-01 10:00+0'::timestamptz AS expires_at;
 
 INSERT INTO rate_limit.records_aggregated (key, session_id)
 SELECT
@@ -15,7 +16,7 @@ SELECT
 
 SELECT lives_ok(
     $have$
-    SELECT * FROM rate_limit.agg_reset_key('existing-key', '00000000-0000-0000-0000-000000000000')
+    SELECT * FROM rate_limit.agg_reset_key('existing-key', 'dedicated-test', '2023-01-01 09:00+0'::timestamptz )
     $have$,
     'rate_limit.agg_reset_key does not throw an error'
 );
diff --git a/db/tests/unit/agg_reset_session.test.sql b/db/tests/unit/agg_reset_session.test.sql
@@ -2,11 +2,12 @@ BEGIN;
 -- Plan the tests.
 SELECT plan(2);
 
-INSERT INTO rate_limit.sessions (id, name_, type_)
+INSERT INTO rate_limit.sessions (id, name_, type_, expires_at)
 SELECT
     '00000000-0000-0000-0000-000000000000'::uuid AS id,
     'dedicated-test'::text AS name_,
-    'aggregated'::text AS type_;
+    'aggregated'::text AS type_,
+    '2023-01-01 10:00+0'::timestamptz AS expires_at;
 
 INSERT INTO rate_limit.records_aggregated (key, session_id)
 SELECT
@@ -19,7 +20,7 @@ SELECT
 
 SELECT lives_ok(
     $have$
-    SELECT * FROM rate_limit.agg_reset_session('00000000-0000-0000-0000-000000000000')
+    SELECT * FROM rate_limit.agg_reset_session('dedicated-test', '2023-01-01 09:00+0')
     $have$,
     'rate_limit.agg_reset_session does not throw an error'
 );
diff --git a/test/stores/store_aggregated_ip.spec.ts b/test/stores/store_aggregated_ip.spec.ts
@@ -4,8 +4,6 @@ import { assert } from 'chai'
 import { Pool } from 'pg'
 import sinon, { SinonMock, SinonStub } from 'sinon'
 import { PostgresStore } from '../../source'
-import { Session } from '../../source/models/session'
-const session_handler = require('../../source/util/session_handler')
 const migration_handler = require('../../source/util/migration_handler')
 
 class ClientMock {
@@ -17,37 +15,21 @@ describe('Postgres Store Aggregated IP', () => {
 	let query: SinonStub
 	let connect: SinonStub
 	let client: SinonMock
-	let getSessionStub: SinonStub
 	let applyMigrationsStub: SinonStub
-	let isSessionValidSpy: SinonStub
-	let newCreatedSession: Session
+	let expirationDate = new Date()
 
 	beforeEach(() => {
 		query = sinon.stub(Pool.prototype, 'query')
 		connect = sinon.stub(Pool.prototype, 'connect')
 		client = sinon.mock(ClientMock.prototype)
-		getSessionStub = sinon.stub(session_handler, 'getSession')
-		isSessionValidSpy = sinon.stub(session_handler, 'isSessionValid')
 		applyMigrationsStub = sinon.stub(migration_handler, 'applyMigrations')
-		const futureTime = new Date()
-		const timeOffset = 5000
-		futureTime.setMilliseconds(futureTime.getMilliseconds() + timeOffset)
-
-		newCreatedSession = {
-			id: '1',
-			name: 'test-name',
-			type: 'test-type',
-			expires_at: futureTime,
-		}
 	})
 
 	afterEach(() => {
 		query.restore() // reset stub/mock
 		connect.restore()
 		client.restore()
-		getSessionStub.restore()
 		applyMigrationsStub.restore()
-		isSessionValidSpy.restore()
 	})
 
 	it('constructor should call correct functions and populate correct fields', async () => {
@@ -60,34 +42,25 @@ describe('Postgres Store Aggregated IP', () => {
 		let pool = new Pool()
 		let dbCount = 1
 
-		isSessionValidSpy.returns(true)
 		query.onFirstCall().returns({
 			rows: [
 				{
 					count: dbCount,
+					expires_at: expirationDate,
 				},
 			],
 		})
 		let testStore = new PostgresStore({}, 'test')
 		testStore.pool = pool
-		testStore.session = newCreatedSession
-		let recordInsertGetRecordsQuery = `
-			SELECT agg_increment as count FROM rate_limit.agg_increment($1, $2);
-            `
+		let recordInsertGetRecordsQuery = `SELECT * FROM rate_limit.agg_increment($1, $2, $3) AS (count int, expires_at timestamptz);`
 		let incrementCount = await testStore.increment('key')
-		sinon.assert.callCount(isSessionValidSpy, 1)
 		sinon.assert.calledWith(query, recordInsertGetRecordsQuery, [
 			'key',
-			newCreatedSession.id,
+			testStore.prefix,
+			undefined,
 		])
 		assert.equal(incrementCount.totalHits, dbCount)
-		assert.isTrue(
-			(incrementCount.resetTime?.getMilliseconds() ||
-				new Date().getMilliseconds()) -
-				(newCreatedSession.expires_at?.getMilliseconds() ||
-					new Date().getMilliseconds()) <
-				10,
-		)
+		assert.equal(incrementCount.resetTime, expirationDate)
 	})
 
 	it('decrement function should follow expected business logic', async () => {
@@ -98,16 +71,12 @@ describe('Postgres Store Aggregated IP', () => {
 
 		let testStore = new PostgresStore({}, 'test')
 		testStore.pool = pool
-		testStore.session = newCreatedSession
 
 		await testStore.decrement('key')
 		let decrementQuery = `
 			SELECT * FROM rate_limit.agg_decrement($1, $2);
         `
-		sinon.assert.calledWith(query, decrementQuery, [
-			'key',
-			newCreatedSession.id,
-		])
+		sinon.assert.calledWith(query, decrementQuery, ['key', testStore.prefix])
 	})
 
 	it('resetKey function should follow expected business logic', async () => {
@@ -118,13 +87,12 @@ describe('Postgres Store Aggregated IP', () => {
 
 		let testStore = new PostgresStore({}, 'test')
 		testStore.pool = pool
-		testStore.session = newCreatedSession
 
 		await testStore.resetKey('key')
 		let resetQuery = `
 			SELECT * FROM rate_limit.agg_reset_key($1, $2)
             `
-		sinon.assert.calledWith(query, resetQuery, ['key', newCreatedSession.id])
+		sinon.assert.calledWith(query, resetQuery, ['key', testStore.prefix])
 	})
 
 	it('resetAll function should follow expected business logic', async () => {
@@ -135,12 +103,11 @@ describe('Postgres Store Aggregated IP', () => {
 
 		let testStore = new PostgresStore({}, 'test')
 		testStore.pool = pool
-		testStore.session = newCreatedSession
 
 		await testStore.resetAll()
 		let resetAllQuery = `
 			SELECT * FROM rate_limit.agg_reset_session($1);
             `
-		sinon.assert.calledWith(query, resetAllQuery, [newCreatedSession.id])
+		sinon.assert.calledWith(query, resetAllQuery, [testStore.prefix])
 	})
 })
