File size: 4,676 Bytes
aec3094 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 | import { mockLogger } from '@n8n/backend-test-utils';
import type { ExecutionsConfig } from '@n8n/config';
import { mock } from 'jest-mock-extended';
import type { InstanceSettings } from 'n8n-core';
import type { DbConnection } from '@/databases/db-connection';
import { ExecutionsPruningService } from '../executions-pruning.service';
describe('PruningService', () => {
const dbConnection = mock<DbConnection>({
connectionState: { migrated: true },
});
describe('init', () => {
it('should start pruning on main instance that is the leader', () => {
const pruningService = new ExecutionsPruningService(
mockLogger(),
mock<InstanceSettings>({ isLeader: true, isMultiMain: true }),
dbConnection,
mock(),
mock(),
mock(),
);
const startPruningSpy = jest.spyOn(pruningService, 'startPruning');
pruningService.init();
expect(startPruningSpy).toHaveBeenCalled();
});
it('should not start pruning on main instance that is a follower', () => {
const pruningService = new ExecutionsPruningService(
mockLogger(),
mock<InstanceSettings>({ isLeader: false, isMultiMain: true }),
dbConnection,
mock(),
mock(),
mock(),
);
const startPruningSpy = jest.spyOn(pruningService, 'startPruning');
pruningService.init();
expect(startPruningSpy).not.toHaveBeenCalled();
});
});
describe('isEnabled', () => {
it('should return `true` based on config if leader main', () => {
const pruningService = new ExecutionsPruningService(
mockLogger(),
mock<InstanceSettings>({ isLeader: true, instanceType: 'main', isMultiMain: true }),
dbConnection,
mock(),
mock(),
mock<ExecutionsConfig>({ pruneData: true }),
);
expect(pruningService.isEnabled).toBe(true);
});
it('should return `false` based on config if leader main', () => {
const pruningService = new ExecutionsPruningService(
mockLogger(),
mock<InstanceSettings>({ isLeader: true, instanceType: 'main', isMultiMain: true }),
dbConnection,
mock(),
mock(),
mock<ExecutionsConfig>({ pruneData: false }),
);
expect(pruningService.isEnabled).toBe(false);
});
it('should return `false` if non-main even if config is enabled', () => {
const pruningService = new ExecutionsPruningService(
mockLogger(),
mock<InstanceSettings>({ isLeader: false, instanceType: 'worker', isMultiMain: true }),
dbConnection,
mock(),
mock(),
mock<ExecutionsConfig>({ pruneData: true }),
);
expect(pruningService.isEnabled).toBe(false);
});
it('should return `false` if follower main even if config is enabled', () => {
const pruningService = new ExecutionsPruningService(
mockLogger(),
mock<InstanceSettings>({
isLeader: false,
isFollower: true,
instanceType: 'main',
isMultiMain: true,
}),
dbConnection,
mock(),
mock(),
mock<ExecutionsConfig>({ pruneData: true }),
);
expect(pruningService.isEnabled).toBe(false);
});
});
describe('startPruning', () => {
it('should not start pruning if service is disabled', () => {
const pruningService = new ExecutionsPruningService(
mockLogger(),
mock<InstanceSettings>({ isLeader: true, instanceType: 'main', isMultiMain: true }),
dbConnection,
mock(),
mock(),
mock<ExecutionsConfig>({ pruneData: false }),
);
const scheduleRollingSoftDeletionsSpy = jest.spyOn(
pruningService,
// @ts-expect-error Private method
'scheduleRollingSoftDeletions',
);
// @ts-expect-error Private method
const scheduleNextHardDeletionSpy = jest.spyOn(pruningService, 'scheduleNextHardDeletion');
pruningService.startPruning();
expect(scheduleRollingSoftDeletionsSpy).not.toHaveBeenCalled();
expect(scheduleNextHardDeletionSpy).not.toHaveBeenCalled();
});
it('should start pruning if service is enabled and DB is migrated', () => {
const pruningService = new ExecutionsPruningService(
mockLogger(),
mock<InstanceSettings>({ isLeader: true, instanceType: 'main', isMultiMain: true }),
dbConnection,
mock(),
mock(),
mock<ExecutionsConfig>({ pruneData: true }),
);
const scheduleRollingSoftDeletionsSpy = jest
// @ts-expect-error Private method
.spyOn(pruningService, 'scheduleRollingSoftDeletions')
.mockImplementation();
const scheduleNextHardDeletionSpy = jest
// @ts-expect-error Private method
.spyOn(pruningService, 'scheduleNextHardDeletion')
.mockImplementation();
pruningService.startPruning();
expect(scheduleRollingSoftDeletionsSpy).toHaveBeenCalled();
expect(scheduleNextHardDeletionSpy).toHaveBeenCalled();
});
});
});
|