Server: Resolves #9931: Add task to delete events older than a week

packages/server/src/models/EventModel.test.ts

@@ -1,6 +1,6 @@
 import { EventType } from '../services/database/types';
 import { beforeAllDb, afterAllTests, beforeEachDb, models } from '../utils/testing/testUtils';
-import { msleep } from '../utils/time';
+import { msleep, Week } from '../utils/time';
 
 describe('EventModel', () => {
 
@@ -37,4 +37,30 @@ describe('EventModel', () => {
 		expect(latest.id).toBe(allEvents[1].id);
 	});
 
+	test('should delete events older than a week', async () => {
+		const now = Date.now();
+		const aWeekAgo = now - Week;
+		jest.useFakeTimers();
+
+		for (const difference of [-10, -5, 0, 5, 10]) {
+			jest.setSystemTime(aWeekAgo + difference);
+			await models().event().create(EventType.TaskStarted, 'deleteExpiredTokens');
+		}
+
+		const allEvents = (await models().event().all());
+		expect(allEvents.length).toBe(5);
+
+		jest.setSystemTime(now);
+		await models().event().deleteOldEvents();
+
+		const remainingEvents = (await models().event().all());
+		expect(remainingEvents.length).toBe(3);
+
+		for (const event of remainingEvents) {
+			expect(event.created_time).toBeGreaterThanOrEqual(aWeekAgo);
+		}
+
+		jest.useRealTimers();
+	});
+
 });

packages/server/src/models/EventModel.ts

@@ -4,6 +4,8 @@ import BaseModel, { UuidType } from './BaseModel';
 
 export default class EventModel extends BaseModel<Event> {
 
+	private eventTtl_: number = 7 * 24 * 60 * 60 * 1000;
+
 	public get tableName(): string {
 		return 'events';
 	}
@@ -33,4 +35,13 @@ export default class EventModel extends BaseModel<Event> {
 			.first();
 	}
 
+	public async deleteOldEvents() {
+		const cutOffDate = Date.now() - this.eventTtl_;
+		return this.withTransaction(async () => {
+			await this.db(this.tableName)
+				.where('created_time', '<', cutOffDate)
+				.delete();
+		}, 'EventModel::deleteOldEvents');
+	}
+
 }

packages/server/src/services/database/types.ts

@@ -136,6 +136,7 @@ export enum TaskId {
 	ProcessShares,
 	ProcessEmails,
 	LogHeartbeatMessage,
+	DeleteOldEvents,
 }
 
 // AUTO-GENERATED-TYPES

packages/server/src/utils/setupTaskService.ts

@@ -82,6 +82,13 @@ export default async function(env: Env, models: Models, config: Config, services
 			schedule: config.HEARTBEAT_MESSAGE_SCHEDULE,
 			run: (_models: Models, _services: Services) => logHeartbeatMessage(),
 		},
+
+		{
+			id: TaskId.DeleteOldEvents,
+			description: taskIdToLabel(TaskId.DeleteOldEvents),
+			schedule: '0 0 * * *',
+			run: (models: Models) => models.event().deleteOldEvents(),
+		},
 	];
 
 	if (config.USER_DATA_AUTO_DELETE_ENABLED) {