Server: Fixes #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 { afterAllTests, beforeAllDb, beforeEachDb, models } from '../utils/testing/testUtils';
+import { msleep, Week } from '../utils/time';
 
 describe('EventModel', () => {
 
@@ -37,4 +37,21 @@ 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;
+		for (const difference of [-10, -5, 0, 5, 10]) {
+			await models().event().create(EventType.TaskStarted, 'deleteExpiredTokens', aWeekAgo + difference);
+		}
+
+		const allEvents = (await models().event().all());
+		expect(allEvents.length).toBe(5);
+
+		await models().event().deleteOldEvents(aWeekAgo);
+		const remainingEvents = (await models().event().all());
+		expect(remainingEvents.length).toBe(3);
+		for (const event of remainingEvents) {
+			expect(event.created_time).toBeGreaterThanOrEqual(aWeekAgo);
+		}
+	});
 });

packages/server/src/models/EventModel.ts

@@ -1,7 +1,6 @@
 import { Event, EventType } from '../services/database/types';
 import BaseModel, { UuidType } from './BaseModel';
 
-
 export default class EventModel extends BaseModel<Event> {
 
 	public get tableName(): string {
@@ -16,11 +15,11 @@ export default class EventModel extends BaseModel<Event> {
 		return UuidType.Native;
 	}
 
-	public async create(type: EventType, name = '') {
+	public async create(type: EventType, name = '', created_time = Date.now()) {
 		await this.save({
 			name,
 			type,
-			created_time: Date.now(),
+			created_time,
 		});
 	}
 
@@ -33,4 +32,11 @@ export default class EventModel extends BaseModel<Event> {
 			.first();
 	}
 
+	public async deleteOldEvents(before: number) {
+		return this.withTransaction(async () => {
+			await this.db(this.tableName)
+				.where('created_time', '<', before)
+				.delete();
+		}, 'EventModel::deleteOldEvents');
+	}
 }

packages/server/src/services/TaskService.ts

@@ -31,6 +31,7 @@ export const taskIdToLabel = (taskId: TaskId): string => {
 		[TaskId.ProcessOrphanedItems]: 'Process orphaned items',
 		[TaskId.ProcessShares]: 'Process shared items',
 		[TaskId.ProcessEmails]: 'Process emails',
+		[TaskId.DeleteOldEvents]: 'Delete old events',
 	};
 
 	const s = strings[taskId];

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

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

packages/server/src/utils/setupTaskService.ts

@@ -3,6 +3,7 @@ import { TaskId } from '../services/database/types';
 import TaskService, { Task, taskIdToLabel } from '../services/TaskService';
 import { Services } from '../services/types';
 import { Config, Env } from './types';
+import { Week } from './time';
 
 export default async function(env: Env, models: Models, config: Config, services: Services): Promise<TaskService> {
 	const taskService = new TaskService(env, models, config, services);
@@ -74,6 +75,13 @@ export default async function(env: Env, models: Models, config: Config, services
 			schedule: '* * * * *',
 			run: (_models: Models, services: Services) => services.email.runMaintenance(),
 		},
+
+		{
+			id: TaskId.DeleteOldEvents,
+			description: taskIdToLabel(TaskId.DeleteOldEvents),
+			schedule: '0 0 * * *',
+			run: (models: Models) => models.event().deleteOldEvents(Date.now() - Week),
+		},
 	];
 
 	if (config.USER_DATA_AUTO_DELETE_ENABLED) {