mudhorn/n8n
1
0
Fork 0
mirror of https://github.com/n8n-io/n8n.git synced 2024-12-24 04:04:06 -08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

chore(core): Bring multi-main setup in line with scaling services (#11289)

Browse source
This commit is contained in:
Iván Ovejero 2024-10-17 10:47:17 +02:00 committed by GitHub
parent fbae17d8fb
commit be50a9ac44
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
15 changed files with 76 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
packages/@n8n/config/src/configs/multi-main-setup.config.ts Normal file
View file

@ -0,0 +1,16 @@
import { Config, Env } from '../decorators';
@Config
export class MultiMainSetupConfig {
/** Whether to enable multi-main setup (if licensed) for scaling mode. */
@Env('N8N_MULTI_MAIN_SETUP_ENABLED')
enabled: boolean = false;
/** Time to live (in seconds) for leader key in multi-main setup. */
@Env('N8N_MULTI_MAIN_SETUP_KEY_TTL')
ttl: number = 10;
/** Interval (in seconds) for leader check in multi-main setup. */
@Env('N8N_MULTI_MAIN_SETUP_CHECK_INTERVAL')
interval: number = 3;
}

4
packages/@n8n/config/src/index.ts
View file

@ -6,6 +6,7 @@ import { EventBusConfig } from './configs/event-bus.config';
import { ExternalSecretsConfig } from './configs/external-secrets.config';
import { ExternalStorageConfig } from './configs/external-storage.config';
import { LoggingConfig } from './configs/logging.config';
import { MultiMainSetupConfig } from './configs/multi-main-setup.config';
import { NodesConfig } from './configs/nodes.config';
import { PublicApiConfig } from './configs/public-api.config';
import { TaskRunnersConfig } from './configs/runners.config';
@ -93,4 +94,7 @@ export class GlobalConfig {
@Nested
taskRunners: TaskRunnersConfig;
@Nested
multiMainSetup: MultiMainSetupConfig;
}

5
packages/@n8n/config/test/config.test.ts
View file

@ -246,6 +246,11 @@ describe('GlobalConfig', () => {
},
scopes: [],
},
multiMainSetup: {
enabled: false,
ttl: 10,
interval: 3,
},
};
it('should use all default values when no env variables are defined', () => {

25
packages/cli/src/__tests__/license.test.ts
View file

@ -1,3 +1,4 @@
import type { GlobalConfig } from '@n8n/config';
import { LicenseManager } from '@n8n_io/license-sdk';
import { mock } from 'jest-mock-extended';
import type { InstanceSettings } from 'n8n-core';
@ -31,7 +32,8 @@ describe('License', () => {
});
beforeEach(async () => {
license = new License(mockLogger(), instanceSettings, mock(), mock(), mock());
const globalConfig = mock<GlobalConfig>({ multiMainSetup: { enabled: false } });
license = new License(mockLogger(), instanceSettings, mock(), mock(), mock(), globalConfig);
await license.init();
});
@ -64,6 +66,7 @@ describe('License', () => {
mock(),
mock(),
mock(),
mock(),
);
await license.init();
expect(LicenseManager).toHaveBeenCalledWith(
@ -197,9 +200,9 @@ describe('License', () => {
describe('in single-main setup', () => {
describe('with `license.autoRenewEnabled` enabled', () => {
it('should enable renewal', async () => {
config.set('multiMainSetup.enabled', false);
const globalConfig = mock<GlobalConfig>({ multiMainSetup: { enabled: false } });
await new License(mockLogger(), mock(), mock(), mock(), mock()).init();
await new License(mockLogger(), mock(), mock(), mock(), mock(), globalConfig).init();
expect(LicenseManager).toHaveBeenCalledWith(
expect.objectContaining({ autoRenewEnabled: true, renewOnInit: true }),
@ -211,7 +214,7 @@ describe('License', () => {
it('should disable renewal', async () => {
config.set('license.autoRenewEnabled', false);
await new License(mockLogger(), mock(), mock(), mock(), mock()).init();
await new License(mockLogger(), mock(), mock(), mock(), mock(), mock()).init();
expect(LicenseManager).toHaveBeenCalledWith(
expect.objectContaining({ autoRenewEnabled: false, renewOnInit: false }),
@ -225,11 +228,11 @@ describe('License', () => {
test.each(['unset', 'leader', 'follower'])(
'if %s status, should disable removal',
async (status) => {
config.set('multiMainSetup.enabled', true);
const globalConfig = mock<GlobalConfig>({ multiMainSetup: { enabled: true } });
config.set('multiMainSetup.instanceType', status);
config.set('license.autoRenewEnabled', false);
await new License(mockLogger(), mock(), mock(), mock(), mock()).init();
await new License(mockLogger(), mock(), mock(), mock(), mock(), globalConfig).init();
expect(LicenseManager).toHaveBeenCalledWith(
expect.objectContaining({ autoRenewEnabled: false, renewOnInit: false }),
@ -240,11 +243,11 @@ describe('License', () => {
describe('with `license.autoRenewEnabled` enabled', () => {
test.each(['unset', 'follower'])('if %s status, should disable removal', async (status) => {
config.set('multiMainSetup.enabled', true);
const globalConfig = mock<GlobalConfig>({ multiMainSetup: { enabled: true } });
config.set('multiMainSetup.instanceType', status);
config.set('license.autoRenewEnabled', false);
await new License(mockLogger(), mock(), mock(), mock(), mock()).init();
await new License(mockLogger(), mock(), mock(), mock(), mock(), globalConfig).init();
expect(LicenseManager).toHaveBeenCalledWith(
expect.objectContaining({ autoRenewEnabled: false, renewOnInit: false }),
@ -252,10 +255,10 @@ describe('License', () => {
});
it('if leader status, should enable renewal', async () => {
config.set('multiMainSetup.enabled', true);
const globalConfig = mock<GlobalConfig>({ multiMainSetup: { enabled: true } });
config.set('multiMainSetup.instanceType', 'leader');
await new License(mockLogger(), mock(), mock(), mock(), mock()).init();
await new License(mockLogger(), mock(), mock(), mock(), mock(), globalConfig).init();
expect(LicenseManager).toHaveBeenCalledWith(
expect.objectContaining({ autoRenewEnabled: true, renewOnInit: true }),
@ -267,7 +270,7 @@ describe('License', () => {
describe('reinit', () => {
it('should reinitialize license manager', async () => {
const license = new License(mockLogger(), mock(), mock(), mock(), mock());
const license = new License(mockLogger(), mock(), mock(), mock(), mock(), mock());
await license.init();
const initSpy = jest.spyOn(license, 'init');

4
packages/cli/src/__tests__/wait-tracker.test.ts
View file

@ -3,7 +3,7 @@ import type { InstanceSettings } from 'n8n-core';
import type { ExecutionRepository } from '@/databases/repositories/execution.repository';
import type { IExecutionResponse } from '@/interfaces';
import type { MultiMainSetup } from '@/services/orchestration/main/multi-main-setup.ee';
import type { MultiMainSetup } from '@/scaling/multi-main-setup.ee';
import { OrchestrationService } from '@/services/orchestration.service';
import { WaitTracker } from '@/wait-tracker';
import { mockLogger } from '@test/mocking';
@ -13,7 +13,7 @@ jest.useFakeTimers();
describe('WaitTracker', () => {
const executionRepository = mock<ExecutionRepository>();
const multiMainSetup = mock<MultiMainSetup>();
const orchestrationService = new OrchestrationService(mock(), multiMainSetup);
const orchestrationService = new OrchestrationService(mock(), multiMainSetup, mock());
const instanceSettings = mock<InstanceSettings>({ isLeader: true });
const execution = mock<IExecutionResponse>({

3
packages/cli/src/commands/start.ts
View file

@ -1,5 +1,6 @@
/* eslint-disable @typescript-eslint/no-unsafe-call */
/* eslint-disable @typescript-eslint/no-unsafe-member-access */
import { GlobalConfig } from '@n8n/config';
import { Flags } from '@oclif/core';
import glob from 'fast-glob';
import { createReadStream, createWriteStream, existsSync } from 'fs';
@ -240,7 +241,7 @@ export class Start extends BaseCommand {
}
if (
config.getEnv('multiMainSetup.enabled') &&
Container.get(GlobalConfig).multiMainSetup.enabled &&
!Container.get(License).isMultipleMainInstancesLicensed()
) {
throw new FeatureNotLicensedError(LICENSE_FEATURES.MULTIPLE_MAIN_INSTANCES);

2
packages/cli/src/commands/webhook.ts
View file

@ -83,7 +83,7 @@ export class Webhook extends BaseCommand {
}
async run() {
if (config.getEnv('multiMainSetup.enabled')) {
if (this.globalConfig.multiMainSetup.enabled) {
throw new ApplicationError(
'Webhook process cannot be started when multi-main setup is enabled.',
);

21
packages/cli/src/config/schema.ts
View file

@ -564,27 +564,6 @@ export const schema = {
},
},
multiMainSetup: {
enabled: {
doc: 'Whether to enable multi-main setup for queue mode (license required)',
format: Boolean,
default: false,
env: 'N8N_MULTI_MAIN_SETUP_ENABLED',
},
ttl: {
doc: 'Time to live (in seconds) for leader key in multi-main setup',
format: Number,
default: 10,
env: 'N8N_MULTI_MAIN_SETUP_KEY_TTL',
},
interval: {
doc: 'Interval (in seconds) for leader check in multi-main setup',
format: Number,
default: 3,
env: 'N8N_MULTI_MAIN_SETUP_CHECK_INTERVAL',
},
},
proxy_hops: {
format: Number,
default: 0,

2
packages/cli/src/events/relays/telemetry.event-relay.ts
View file

@ -780,7 +780,7 @@ export class TelemetryEventRelay extends EventRelay {
license_plan_name: this.license.getPlanName(),
license_tenant_id: config.getEnv('license.tenantId'),
binary_data_s3: isS3Available && isS3Selected && isS3Licensed,
multi_main_setup_enabled: config.getEnv('multiMainSetup.enabled'),
multi_main_setup_enabled: this.globalConfig.multiMainSetup.enabled,
metrics: {
metrics_enabled: this.globalConfig.endpoints.metrics.enable,
metrics_category_default: this.globalConfig.endpoints.metrics.includeDefaultMetrics,

6
packages/cli/src/license.ts
View file

@ -1,3 +1,4 @@
import { GlobalConfig } from '@n8n/config';
import type { TEntitlement, TFeatures, TLicenseBlock } from '@n8n_io/license-sdk';
import { LicenseManager } from '@n8n_io/license-sdk';
import { InstanceSettings, ObjectStoreService } from 'n8n-core';
@ -37,6 +38,7 @@ export class License {
private readonly orchestrationService: OrchestrationService,
private readonly settingsRepository: SettingsRepository,
private readonly licenseMetricsService: LicenseMetricsService,
private readonly globalConfig: GlobalConfig,
) {
this.logger = this.logger.withScope('license');
}
@ -54,7 +56,7 @@ export class License {
* On becoming leader or follower, each will enable or disable renewal, respectively.
* This ensures the mains do not cause a 429 (too many requests) on license init.
*/
if (config.getEnv('multiMainSetup.enabled')) {
if (this.globalConfig.multiMainSetup.enabled) {
return autoRenewEnabled && this.instanceSettings.isLeader;
}
@ -136,7 +138,7 @@ export class License {
async onFeatureChange(_features: TFeatures): Promise<void> {
this.logger.debug('License feature change detected', _features);
if (config.getEnv('executions.mode') === 'queue' && config.getEnv('multiMainSetup.enabled')) {
if (config.getEnv('executions.mode') === 'queue' && this.globalConfig.multiMainSetup.enabled) {
const isMultiMainLicensed = _features[LICENSE_FEATURES.MULTIPLE_MAIN_INSTANCES] as
| boolean
| undefined;

27
packages/cli/src/services/orchestration/main/multi-main-setup.ee.ts → packages/cli/src/scaling/multi-main-setup.ee.ts
View file

@ -1,3 +1,4 @@
import { GlobalConfig } from '@n8n/config';
import { InstanceSettings } from 'n8n-core';
import { Service } from 'typedi';
@ -9,10 +10,22 @@ import { RedisClientService } from '@/services/redis-client.service';
import { TypedEmitter } from '@/typed-emitter';
type MultiMainEvents = {
/**
* Emitted when this instance loses leadership. In response, its various
* services will stop triggers, pollers, pruning, wait-tracking, license
* renewal, queue recovery, etc.
*/
'leader-stepdown': never;
/**
* Emitted when this instance gains leadership. In response, its various
* services will start triggers, pollers, pruning, wait-tracking, license
* renewal, queue recovery, etc.
*/
'leader-takeover': never;
};
/** Designates leader and followers when running multiple main processes. */
@Service()
export class MultiMainSetup extends TypedEmitter<MultiMainEvents> {
constructor(
@ -20,13 +33,15 @@ export class MultiMainSetup extends TypedEmitter<MultiMainEvents> {
private readonly instanceSettings: InstanceSettings,
private readonly publisher: Publisher,
private readonly redisClientService: RedisClientService,
private readonly globalConfig: GlobalConfig,
) {
super();
this.logger = this.logger.withScope('scaling');
}
private leaderKey: string;
private readonly leaderKeyTtl = config.getEnv('multiMainSetup.ttl');
private readonly leaderKeyTtl = this.globalConfig.multiMainSetup.ttl;
private leaderCheckInterval: NodeJS.Timer | undefined;
@ -39,7 +54,7 @@ export class MultiMainSetup extends TypedEmitter<MultiMainEvents> {
this.leaderCheckInterval = setInterval(async () => {
await this.checkLeader();
}, config.getEnv('multiMainSetup.interval') * TIME.SECOND);
}, this.globalConfig.multiMainSetup.interval * TIME.SECOND);
}
async shutdown() {
@ -69,7 +84,7 @@ export class MultiMainSetup extends TypedEmitter<MultiMainEvents> {
if (this.instanceSettings.isLeader) {
this.instanceSettings.markAsFollower();
this.emit('leader-stepdown'); // lost leadership - stop triggers, pollers, pruning, wait-tracking, queue recovery
this.emit('leader-stepdown');
this.logger.warn('[Multi-main setup] Leader failed to renew leader key');
}
@ -84,9 +99,6 @@ export class MultiMainSetup extends TypedEmitter<MultiMainEvents> {
this.instanceSettings.markAsFollower();
/**
* Lost leadership - stop triggers, pollers, pruning, wait tracking, license renewal, queue recovery
*/
this.emit('leader-stepdown');
await this.tryBecomeLeader();
@ -106,9 +118,6 @@ export class MultiMainSetup extends TypedEmitter<MultiMainEvents> {
await this.publisher.setExpiration(this.leaderKey, this.leaderKeyTtl);
/**
* Gained leadership - start triggers, pollers, pruning, wait-tracking, license renewal, queue recovery
*/
this.emit('leader-takeover');
} else {
this.instanceSettings.markAsFollower();

6
packages/cli/src/services/orchestration.service.ts
View file

@ -1,3 +1,4 @@
import { GlobalConfig } from '@n8n/config';
import { InstanceSettings } from 'n8n-core';
import Container, { Service } from 'typedi';
@ -5,13 +6,14 @@ import config from '@/config';
import type { Publisher } from '@/scaling/pubsub/publisher.service';
import type { Subscriber } from '@/scaling/pubsub/subscriber.service';
import { MultiMainSetup } from './orchestration/main/multi-main-setup.ee';
import { MultiMainSetup } from '../scaling/multi-main-setup.ee';
@Service()
export class OrchestrationService {
constructor(
readonly instanceSettings: InstanceSettings,
readonly multiMainSetup: MultiMainSetup,
readonly globalConfig: GlobalConfig,
) {}
private publisher: Publisher;
@ -29,7 +31,7 @@ export class OrchestrationService {
get isMultiMainSetupEnabled() {
return (
config.getEnv('executions.mode') === 'queue' &&
config.getEnv('multiMainSetup.enabled') &&
this.globalConfig.multiMainSetup.enabled &&
this.instanceSettings.instanceType === 'main' &&
this.isMultiMainSetupLicensed
);

4
packages/cli/src/services/pruning.service.ts
View file

@ -1,3 +1,4 @@
import { GlobalConfig } from '@n8n/config';
import { BinaryDataService, InstanceSettings } from 'n8n-core';
import { jsonStringify } from 'n8n-workflow';
import { Service } from 'typedi';
@ -31,6 +32,7 @@ export class PruningService {
private readonly executionRepository: ExecutionRepository,
private readonly binaryDataService: BinaryDataService,
private readonly orchestrationService: OrchestrationService,
private readonly globalConfig: GlobalConfig,
) {}
/**
@ -54,7 +56,7 @@ export class PruningService {
return false;
}
if (config.getEnv('multiMainSetup.enabled') && instanceType === 'main' && isFollower) {
if (this.globalConfig.multiMainSetup.enabled && instanceType === 'main' && isFollower) {
return false;
}

2
packages/cli/test/integration/debug.controller.test.ts
View file

@ -5,7 +5,7 @@ import { ActiveWorkflowManager } from '@/active-workflow-manager';
import type { WorkflowEntity } from '@/databases/entities/workflow-entity';
import { WorkflowRepository } from '@/databases/repositories/workflow.repository';
import { generateNanoId } from '@/databases/utils/generators';
import { MultiMainSetup } from '@/services/orchestration/main/multi-main-setup.ee';
import { MultiMainSetup } from '@/scaling/multi-main-setup.ee';
import { createOwner } from './shared/db/users';
import { randomName } from './shared/random';

1
packages/cli/test/integration/pruning.service.test.ts
View file

@ -38,6 +38,7 @@ describe('softDeleteOnPruningCycle()', () => {
Container.get(ExecutionRepository),
mockInstance(BinaryDataService),
mock(),
mock(),
);
workflow = await createWorkflow();