Start insights collection timer for webhook instances

Author: guillaumejacquart

packages/cli/src/modules/insights/__tests__/insights.module.test.ts

@@ -21,7 +21,17 @@ describe('InsightsModule', () => {
 			instanceSettings = mockInstance(InstanceSettings, { instanceType: 'main', isLeader: true });
 			const insightsModule = new InsightsModule(logger, insightsService, instanceSettings);
 			insightsModule.initialize();
-			expect(insightsService.startTimers).toHaveBeenCalled();
+			expect(insightsService.startTimers).toHaveBeenCalledWith();
+		});
+
+		it('should start background process if instance is webhook', () => {
+			instanceSettings = mockInstance(InstanceSettings, {
+				instanceType: 'webhook',
+				isLeader: false,
+			});
+			const insightsModule = new InsightsModule(logger, insightsService, instanceSettings);
+			insightsModule.initialize();
+			expect(insightsService.startTimers).toHaveBeenCalledWith({ onlyCollection: true });
 		});
 
 		it('should not start background process if instance is main but not leader', () => {

packages/cli/src/modules/insights/__tests__/insights.service.test.ts

@@ -23,7 +23,7 @@ import type { InsightsRaw } from '../database/entities/insights-raw';
 import type { InsightsByPeriodRepository } from '../database/repositories/insights-by-period.repository';
 import { InsightsCollectionService } from '../insights-collection.service';
 import { InsightsCompactionService } from '../insights-compaction.service';
-import type { InsightsPruningService } from '../insights-pruning.service';
+import { InsightsPruningService } from '../insights-pruning.service';
 import { InsightsConfig } from '../insights.config';
 import { InsightsService } from '../insights.service';
 
@@ -47,6 +47,47 @@ afterAll(async () => {
 	await testDb.terminate();
 });
 
+describe.only('startTimers', () => {
+	let insightsService: InsightsService;
+	let compactionService: InsightsCompactionService;
+	let collectionService: InsightsCollectionService;
+	let pruningService: InsightsPruningService;
+
+	beforeAll(() => {
+		compactionService = mock<InsightsCompactionService>();
+		collectionService = mock<InsightsCollectionService>();
+		pruningService = mock<InsightsPruningService>({ isPruningEnabled: true });
+		insightsService = new InsightsService(
+			mock<InsightsByPeriodRepository>(),
+			compactionService,
+			collectionService,
+			pruningService,
+			mock<LicenseState>(),
+			mockLogger(),
+		);
+	});
+
+	beforeEach(() => {
+		jest.clearAllMocks();
+	});
+
+	test('starts compaction, flushing and pruning timers', () => {
+		insightsService.startTimers();
+
+		expect(collectionService.startFlushingTimer).toHaveBeenCalled();
+		expect(compactionService.startCompactionTimer).toHaveBeenCalled();
+		expect(pruningService.startPruningTimer).toHaveBeenCalled();
+	});
+
+	test('starts only collection flushing timer when onlyCollection is true', () => {
+		insightsService.startTimers({ onlyCollection: true });
+
+		expect(collectionService.startFlushingTimer).toHaveBeenCalled();
+		expect(compactionService.startCompactionTimer).not.toHaveBeenCalled();
+		expect(pruningService.startPruningTimer).not.toHaveBeenCalled();
+	});
+});
+
 describe('getInsightsSummary', () => {
 	let insightsService: InsightsService;
 	beforeAll(async () => {

packages/cli/src/modules/insights/insights.module.ts

@@ -19,9 +19,12 @@ export class InsightsModule implements BaseN8nModule {
 
 	initialize() {
 		// We want to initialize the insights background process (schedulers) for the main leader instance
-		// to have only one main instance saving the insights data
 		if (this.instanceSettings.isLeader) {
 			this.insightsService.startTimers();
+		} else if (this.instanceSettings.instanceType === 'webhook') {
+			// Webhook instances collect insights data independently
+			// So we only start the collection timers, compaction and pruning are done by the main instance
+			this.insightsService.startTimers({ onlyCollection: true });
 		}
 	}
 

packages/cli/src/modules/insights/insights.service.ts

@@ -38,13 +38,19 @@ export class InsightsService {
 		this.logger = this.logger.scoped('insights');
 	}
 
-	startTimers() {
-		this.compactionService.startCompactionTimer();
+	startTimers({ onlyCollection } = { onlyCollection: false }) {
 		this.collectionService.startFlushingTimer();
-		if (this.pruningService.isPruningEnabled) {
-			this.pruningService.startPruningTimer();
+		if (!onlyCollection) {
+			this.compactionService.startCompactionTimer();
+			if (this.pruningService.isPruningEnabled) {
+				this.pruningService.startPruningTimer();
+			}
 		}
-		this.logger.debug('Started compaction, flushing and pruning schedulers');
+		this.logger.debug(
+			onlyCollection
+				? 'Starting collection flushing schedulers'
+				: 'Starting compaction, flushing and pruning schedulers',
+		);
 	}
 
 	stopTimers() {