refactor(core): Implement a new OnPubSubEvent decorator (#15688)

This commit is contained in:
कारतोफ्फेलस्क्रिप्ट™
2025-06-04 18:32:33 +02:00
committed by GitHub
parent b772462cea
commit 4b11268a6e
38 changed files with 610 additions and 1153 deletions

View File

@@ -94,3 +94,9 @@ export const LDAP_DEFAULT_CONFIGURATION: LdapConfig = {
searchPageSize: 0, searchPageSize: 0,
searchTimeout: 60, searchTimeout: 60,
}; };
export const INSTANCE_TYPES = ['main', 'webhook', 'worker'] as const;
export type InstanceType = (typeof INSTANCE_TYPES)[number];
export const INSTANCE_ROLES = ['unset', 'leader', 'follower'] as const;
export type InstanceRole = (typeof INSTANCE_ROLES)[number];

View File

@@ -1,4 +1,4 @@
import type { InstanceType } from 'n8n-core'; import type { InstanceType } from '@n8n/constants';
import { ALPHABET } from 'n8n-workflow'; import { ALPHABET } from 'n8n-workflow';
import { customAlphabet } from 'nanoid'; import { customAlphabet } from 'nanoid';

View File

@@ -4,6 +4,7 @@ export * from './execution-lifecycle';
export { Memoized } from './memoized'; export { Memoized } from './memoized';
export * from './module'; export * from './module';
export * from './multi-main'; export * from './multi-main';
export * from './pubsub';
export { Redactable } from './redactable'; export { Redactable } from './redactable';
export * from './shutdown'; export * from './shutdown';
export * from './module/module-metadata'; export * from './module/module-metadata';

View File

@@ -0,0 +1,56 @@
import { Container } from '@n8n/di';
import { Service } from '@n8n/di';
import { NonMethodError } from '../../errors';
import { OnPubSubEvent } from '../on-pubsub-event';
import { PubSubMetadata } from '../pubsub-metadata';
describe('@OnPubSubEvent', () => {
let metadata: PubSubMetadata;
beforeEach(() => {
Container.reset();
metadata = new PubSubMetadata();
Container.set(PubSubMetadata, metadata);
});
it('should register methods decorated with @OnPubSubEvent', () => {
jest.spyOn(metadata, 'register');
@Service()
class TestService {
@OnPubSubEvent('reload-external-secrets-providers')
async reloadProviders() {}
@OnPubSubEvent('restart-event-bus', { instanceType: 'worker' })
async restartEventBus() {}
}
expect(metadata.register).toHaveBeenNthCalledWith(1, {
eventName: 'reload-external-secrets-providers',
methodName: 'reloadProviders',
eventHandlerClass: TestService,
});
expect(metadata.register).toHaveBeenNthCalledWith(2, {
eventName: 'restart-event-bus',
methodName: 'restartEventBus',
eventHandlerClass: TestService,
filter: { instanceType: 'worker' },
});
});
it('should throw an error if the decorated target is not a method', () => {
expect(() => {
@Service()
class TestService {
// @ts-expect-error Testing invalid code
@OnPubSubEvent('reload-external-secrets-providers')
notAFunction = 'string';
}
new TestService();
}).toThrowError(NonMethodError);
});
});

View File

@@ -0,0 +1,2 @@
export { PubSubMetadata, PubSubEventName } from './pubsub-metadata';
export { OnPubSubEvent } from './on-pubsub-event';

View File

@@ -0,0 +1,43 @@
import { Container } from '@n8n/di';
import { PubSubMetadata } from './pubsub-metadata';
import type { PubSubEventName, PubSubEventFilter } from './pubsub-metadata';
import { NonMethodError } from '../errors';
import type { EventHandlerClass } from '../types';
/**
* Decorator that registers a method to be called when a specific PubSub event occurs.
* Optionally filters event handling based on instance type and role.
*
* @param eventName - The PubSub event to listen for
* @param filter - Optional filter to limit event handling to specific instance types or roles
*
* @example
*
* ```ts
* @Service()
* class MyService {
* @OnPubSubEvent('community-package-install', { instanceType: 'main', instanceRole: 'leader' })
* async handlePackageInstall() {
* // Handle community package installation
* }
* }
* ```
*/
export const OnPubSubEvent =
(eventName: PubSubEventName, filter?: PubSubEventFilter): MethodDecorator =>
(prototype, propertyKey, descriptor) => {
const eventHandlerClass = prototype.constructor as EventHandlerClass;
const methodName = String(propertyKey);
if (typeof descriptor?.value !== 'function') {
throw new NonMethodError(`${eventHandlerClass.name}.${methodName}()`);
}
Container.get(PubSubMetadata).register({
eventHandlerClass,
methodName,
eventName,
filter,
});
};

View File

@@ -0,0 +1,46 @@
import type { InstanceRole, InstanceType } from '@n8n/constants';
import { Service } from '@n8n/di';
import type { EventHandler } from '../types';
export type PubSubEventName =
| 'add-webhooks-triggers-and-pollers'
| 'remove-triggers-and-pollers'
| 'clear-test-webhooks'
| 'display-workflow-activation'
| 'display-workflow-deactivation'
| 'display-workflow-activation-error'
| 'community-package-install'
| 'community-package-uninstall'
| 'community-package-update'
| 'get-worker-status'
| 'reload-external-secrets-providers'
| 'reload-license'
| 'response-to-get-worker-status'
| 'restart-event-bus'
| 'relay-execution-lifecycle-event';
export type PubSubEventFilter =
| {
instanceType: 'main';
instanceRole?: Omit<InstanceRole, 'unset'>;
}
| {
instanceType: Omit<InstanceType, 'main'>;
instanceRole?: never;
};
type PubSubEventHandler = EventHandler<PubSubEventName> & { filter?: PubSubEventFilter };
@Service()
export class PubSubMetadata {
private readonly handlers: PubSubEventHandler[] = [];
register(handler: PubSubEventHandler) {
this.handlers.push(handler);
}
getHandlers(): PubSubEventHandler[] {
return this.handlers;
}
}

View File

@@ -40,6 +40,7 @@ describe('ActiveWorkflowManager', () => {
instanceSettings, instanceSettings,
mock(), mock(),
mock(), mock(),
mock(),
); );
}); });

View File

@@ -3,7 +3,7 @@ import { Logger } from '@n8n/backend-common';
import { WorkflowsConfig } from '@n8n/config'; import { WorkflowsConfig } from '@n8n/config';
import type { WorkflowEntity, IWorkflowDb } from '@n8n/db'; import type { WorkflowEntity, IWorkflowDb } from '@n8n/db';
import { WorkflowRepository } from '@n8n/db'; import { WorkflowRepository } from '@n8n/db';
import { OnLeaderStepdown, OnLeaderTakeover, OnShutdown } from '@n8n/decorators'; import { OnLeaderStepdown, OnLeaderTakeover, OnPubSubEvent, OnShutdown } from '@n8n/decorators';
import { Service } from '@n8n/di'; import { Service } from '@n8n/di';
import chunk from 'lodash/chunk'; import chunk from 'lodash/chunk';
import { import {
@@ -34,6 +34,7 @@ import {
WorkflowActivationError, WorkflowActivationError,
WebhookPathTakenError, WebhookPathTakenError,
UnexpectedError, UnexpectedError,
ensureError,
} from 'n8n-workflow'; } from 'n8n-workflow';
import { strict } from 'node:assert'; import { strict } from 'node:assert';
@@ -48,6 +49,7 @@ import { executeErrorWorkflow } from '@/execution-lifecycle/execute-error-workfl
import { ExecutionService } from '@/executions/execution.service'; import { ExecutionService } from '@/executions/execution.service';
import { ExternalHooks } from '@/external-hooks'; import { ExternalHooks } from '@/external-hooks';
import { NodeTypes } from '@/node-types'; import { NodeTypes } from '@/node-types';
import { Push } from '@/push';
import { Publisher } from '@/scaling/pubsub/publisher.service'; import { Publisher } from '@/scaling/pubsub/publisher.service';
import { ActiveWorkflowsService } from '@/services/active-workflows.service'; import { ActiveWorkflowsService } from '@/services/active-workflows.service';
import * as WebhookHelpers from '@/webhooks/webhook-helpers'; import * as WebhookHelpers from '@/webhooks/webhook-helpers';
@@ -85,6 +87,7 @@ export class ActiveWorkflowManager {
private readonly instanceSettings: InstanceSettings, private readonly instanceSettings: InstanceSettings,
private readonly publisher: Publisher, private readonly publisher: Publisher,
private readonly workflowsConfig: WorkflowsConfig, private readonly workflowsConfig: WorkflowsConfig,
private readonly push: Push,
) { ) {
this.logger = this.logger.scoped(['workflow-activation']); this.logger = this.logger.scoped(['workflow-activation']);
} }
@@ -620,6 +623,61 @@ export class ActiveWorkflowManager {
return added; return added;
} }
@OnPubSubEvent('display-workflow-activation', { instanceType: 'main' })
handleDisplayWorkflowActivation({ workflowId }: { workflowId: string }) {
this.push.broadcast({ type: 'workflowActivated', data: { workflowId } });
}
@OnPubSubEvent('display-workflow-deactivation', { instanceType: 'main' })
handleDisplayWorkflowDeactivation({ workflowId }: { workflowId: string }) {
this.push.broadcast({ type: 'workflowDeactivated', data: { workflowId } });
}
@OnPubSubEvent('display-workflow-activation-error', { instanceType: 'main' })
handleDisplayWorkflowActivationError({
workflowId,
errorMessage,
}: { workflowId: string; errorMessage: string }) {
this.push.broadcast({
type: 'workflowFailedToActivate',
data: { workflowId, errorMessage },
});
}
@OnPubSubEvent('add-webhooks-triggers-and-pollers', {
instanceType: 'main',
instanceRole: 'leader',
})
async handleAddWebhooksTriggersAndPollers({ workflowId }: { workflowId: string }) {
try {
await this.add(workflowId, 'activate', undefined, {
shouldPublish: false, // prevent leader from re-publishing message
});
this.push.broadcast({ type: 'workflowActivated', data: { workflowId } });
await this.publisher.publishCommand({
command: 'display-workflow-activation',
payload: { workflowId },
}); // instruct followers to show activation in UI
} catch (e) {
const error = ensureError(e);
const { message } = error;
await this.workflowRepository.update(workflowId, { active: false });
this.push.broadcast({
type: 'workflowFailedToActivate',
data: { workflowId, errorMessage: message },
});
await this.publisher.publishCommand({
command: 'display-workflow-activation-error',
payload: { workflowId, errorMessage: message },
}); // instruct followers to show activation error in UI
}
}
/** /**
* A workflow can only be activated if it has a node which has either triggers * A workflow can only be activated if it has a node which has either triggers
* or webhooks defined. * or webhooks defined.
@@ -814,6 +872,20 @@ export class ActiveWorkflowManager {
await this.removeWorkflowTriggersAndPollers(workflowId); await this.removeWorkflowTriggersAndPollers(workflowId);
} }
@OnPubSubEvent('remove-triggers-and-pollers', { instanceType: 'main', instanceRole: 'leader' })
async handleRemoveTriggersAndPollers({ workflowId }: { workflowId: string }) {
await this.removeActivationError(workflowId);
await this.removeWorkflowTriggersAndPollers(workflowId);
this.push.broadcast({ type: 'workflowDeactivated', data: { workflowId } });
// instruct followers to show workflow deactivation in UI
await this.publisher.publishCommand({
command: 'display-workflow-deactivation',
payload: { workflowId },
});
}
/** /**
* Stop running active triggers and pollers for a workflow. * Stop running active triggers and pollers for a workflow.
*/ */

View File

@@ -22,7 +22,7 @@ import { EventService } from '@/events/event.service';
import { ExecutionService } from '@/executions/execution.service'; import { ExecutionService } from '@/executions/execution.service';
import { MultiMainSetup } from '@/scaling/multi-main-setup.ee'; import { MultiMainSetup } from '@/scaling/multi-main-setup.ee';
import { Publisher } from '@/scaling/pubsub/publisher.service'; import { Publisher } from '@/scaling/pubsub/publisher.service';
import { PubSubHandler } from '@/scaling/pubsub/pubsub-handler'; import { PubSubRegistry } from '@/scaling/pubsub/pubsub.registry';
import { Subscriber } from '@/scaling/pubsub/subscriber.service'; import { Subscriber } from '@/scaling/pubsub/subscriber.service';
import { Server } from '@/server'; import { Server } from '@/server';
import { OwnershipService } from '@/services/ownership.service'; import { OwnershipService } from '@/services/ownership.service';
@@ -252,7 +252,7 @@ export class Start extends BaseCommand {
async initOrchestration() { async initOrchestration() {
Container.get(Publisher); Container.get(Publisher);
Container.get(PubSubHandler).init(); Container.get(PubSubRegistry).init();
const subscriber = Container.get(Subscriber); const subscriber = Container.get(Subscriber);
await subscriber.subscribe('n8n.commands'); await subscriber.subscribe('n8n.commands');

View File

@@ -4,7 +4,7 @@ import { Flags } from '@oclif/core';
import { ActiveExecutions } from '@/active-executions'; import { ActiveExecutions } from '@/active-executions';
import config from '@/config'; import config from '@/config';
import { Publisher } from '@/scaling/pubsub/publisher.service'; import { Publisher } from '@/scaling/pubsub/publisher.service';
import { PubSubHandler } from '@/scaling/pubsub/pubsub-handler'; import { PubSubRegistry } from '@/scaling/pubsub/pubsub.registry';
import { Subscriber } from '@/scaling/pubsub/subscriber.service'; import { Subscriber } from '@/scaling/pubsub/subscriber.service';
import { WebhookServer } from '@/webhooks/webhook-server'; import { WebhookServer } from '@/webhooks/webhook-server';
@@ -100,7 +100,7 @@ export class Webhook extends BaseCommand {
async initOrchestration() { async initOrchestration() {
Container.get(Publisher); Container.get(Publisher);
Container.get(PubSubHandler).init(); Container.get(PubSubRegistry).init();
await Container.get(Subscriber).subscribe('n8n.commands'); await Container.get(Subscriber).subscribe('n8n.commands');
} }
} }

View File

@@ -8,7 +8,7 @@ import { EventMessageGeneric } from '@/eventbus/event-message-classes/event-mess
import { MessageEventBus } from '@/eventbus/message-event-bus/message-event-bus'; import { MessageEventBus } from '@/eventbus/message-event-bus/message-event-bus';
import { LogStreamingEventRelay } from '@/events/relays/log-streaming.event-relay'; import { LogStreamingEventRelay } from '@/events/relays/log-streaming.event-relay';
import { Publisher } from '@/scaling/pubsub/publisher.service'; import { Publisher } from '@/scaling/pubsub/publisher.service';
import { PubSubHandler } from '@/scaling/pubsub/pubsub-handler'; import { PubSubRegistry } from '@/scaling/pubsub/pubsub.registry';
import { Subscriber } from '@/scaling/pubsub/subscriber.service'; import { Subscriber } from '@/scaling/pubsub/subscriber.service';
import type { ScalingService } from '@/scaling/scaling.service'; import type { ScalingService } from '@/scaling/scaling.service';
import type { WorkerServerEndpointsConfig } from '@/scaling/worker-server'; import type { WorkerServerEndpointsConfig } from '@/scaling/worker-server';
@@ -130,7 +130,7 @@ export class Worker extends BaseCommand {
async initOrchestration() { async initOrchestration() {
Container.get(Publisher); Container.get(Publisher);
Container.get(PubSubHandler).init(); Container.get(PubSubRegistry).init();
await Container.get(Subscriber).subscribe('n8n.commands'); await Container.get(Subscriber).subscribe('n8n.commands');
} }

View File

@@ -1,13 +1,13 @@
import { Post, RestController, GlobalScope } from '@n8n/decorators'; import { Post, RestController, GlobalScope } from '@n8n/decorators';
import { License } from '@/license'; import { License } from '@/license';
import { Publisher } from '@/scaling/pubsub/publisher.service'; import { WorkerStatusService } from '@/scaling/worker-status.service.ee';
@RestController('/orchestration') @RestController('/orchestration')
export class OrchestrationController { export class OrchestrationController {
constructor( constructor(
private readonly licenseService: License, private readonly licenseService: License,
private readonly publisher: Publisher, private readonly workerStatusService: WorkerStatusService,
) {} ) {}
/** /**
@@ -19,6 +19,6 @@ export class OrchestrationController {
async getWorkersStatusAll() { async getWorkersStatusAll() {
if (!this.licenseService.isWorkerViewLicensed()) return; if (!this.licenseService.isWorkerViewLicensed()) return;
return await this.publisher.publishCommand({ command: 'get-worker-status' }); return await this.workerStatusService.requestWorkerStatus();
} }
} }

View File

@@ -1,6 +1,7 @@
import { Logger } from '@n8n/backend-common'; import { Logger } from '@n8n/backend-common';
import { GlobalConfig } from '@n8n/config'; import { GlobalConfig } from '@n8n/config';
import { EventDestinationsRepository, ExecutionRepository, WorkflowRepository } from '@n8n/db'; import { EventDestinationsRepository, ExecutionRepository, WorkflowRepository } from '@n8n/db';
import { OnPubSubEvent } from '@n8n/decorators';
import { Service } from '@n8n/di'; import { Service } from '@n8n/di';
// eslint-disable-next-line n8n-local-rules/misplaced-n8n-typeorm-import // eslint-disable-next-line n8n-local-rules/misplaced-n8n-typeorm-import
import type { DeleteResult } from '@n8n/typeorm'; import type { DeleteResult } from '@n8n/typeorm';
@@ -263,6 +264,7 @@ export class MessageEventBus extends EventEmitter {
this.logger.debug('EventBus shut down.'); this.logger.debug('EventBus shut down.');
} }
@OnPubSubEvent('restart-event-bus')
async restart() { async restart() {
await this.close(); await this.close();
await this.initialize({ skipRecoveryPass: true }); await this.initialize({ skipRecoveryPass: true });

View File

@@ -3,11 +3,10 @@ import { Service } from '@n8n/di';
import { TypedEmitter } from '@/typed-emitter'; import { TypedEmitter } from '@/typed-emitter';
import type { AiEventMap } from './maps/ai.event-map'; import type { AiEventMap } from './maps/ai.event-map';
import type { PubSubEventMap } from './maps/pub-sub.event-map';
import type { QueueMetricsEventMap } from './maps/queue-metrics.event-map'; import type { QueueMetricsEventMap } from './maps/queue-metrics.event-map';
import type { RelayEventMap } from './maps/relay.event-map'; import type { RelayEventMap } from './maps/relay.event-map';
type EventMap = RelayEventMap & QueueMetricsEventMap & AiEventMap & PubSubEventMap; type EventMap = RelayEventMap & QueueMetricsEventMap & AiEventMap;
@Service() @Service()
export class EventService extends TypedEmitter<EventMap> {} export class EventService extends TypedEmitter<EventMap> {}

View File

@@ -1,6 +1,6 @@
import { Logger } from '@n8n/backend-common'; import { Logger } from '@n8n/backend-common';
import { SettingsRepository } from '@n8n/db'; import { SettingsRepository } from '@n8n/db';
import { OnShutdown } from '@n8n/decorators'; import { OnPubSubEvent, OnShutdown } from '@n8n/decorators';
import { Service } from '@n8n/di'; import { Service } from '@n8n/di';
import { Cipher } from 'n8n-core'; import { Cipher } from 'n8n-core';
import { jsonParse, type IDataObject, ensureError, UnexpectedError } from 'n8n-workflow'; import { jsonParse, type IDataObject, ensureError, UnexpectedError } from 'n8n-workflow';
@@ -77,6 +77,7 @@ export class ExternalSecretsManager {
this.logger.debug('External secrets manager shut down'); this.logger.debug('External secrets manager shut down');
} }
@OnPubSubEvent('reload-external-secrets-providers')
async reloadAllProviders(backoff?: number) { async reloadAllProviders(backoff?: number) {
this.logger.debug('Reloading all external secrets providers'); this.logger.debug('Reloading all external secrets providers');
const providers = this.getProviderNames(); const providers = this.getProviderNames();

View File

@@ -9,7 +9,7 @@ import {
type NumericLicenseFeature, type NumericLicenseFeature,
} from '@n8n/constants'; } from '@n8n/constants';
import { SettingsRepository } from '@n8n/db'; import { SettingsRepository } from '@n8n/db';
import { OnLeaderStepdown, OnLeaderTakeover, OnShutdown } from '@n8n/decorators'; import { OnLeaderStepdown, OnLeaderTakeover, OnPubSubEvent, OnShutdown } from '@n8n/decorators';
import { Container, Service } from '@n8n/di'; import { Container, Service } from '@n8n/di';
import type { TEntitlement, TLicenseBlock } from '@n8n_io/license-sdk'; import type { TEntitlement, TLicenseBlock } from '@n8n_io/license-sdk';
import { LicenseManager } from '@n8n_io/license-sdk'; import { LicenseManager } from '@n8n_io/license-sdk';
@@ -171,6 +171,7 @@ export class License implements LicenseProvider {
this.logger.debug('License activated'); this.logger.debug('License activated');
} }
@OnPubSubEvent('reload-license')
async reload(): Promise<void> { async reload(): Promise<void> {
if (!this.manager) { if (!this.manager) {
return; return;

View File

@@ -1,5 +1,6 @@
import type { InstanceType } from '@n8n/constants';
import { mock } from 'jest-mock-extended'; import { mock } from 'jest-mock-extended';
import type { InstanceSettings, InstanceType } from 'n8n-core'; import type { InstanceSettings } from 'n8n-core';
import type { ModulePreInitContext } from '@/modules/modules.config'; import type { ModulePreInitContext } from '@/modules/modules.config';

View File

@@ -1,7 +1,7 @@
import type { PushMessage } from '@n8n/api-types'; import type { PushMessage } from '@n8n/api-types';
import { inProduction, Logger } from '@n8n/backend-common'; import { inProduction, Logger } from '@n8n/backend-common';
import type { User } from '@n8n/db'; import type { User } from '@n8n/db';
import { OnShutdown } from '@n8n/decorators'; import { OnPubSubEvent, OnShutdown } from '@n8n/decorators';
import { Container, Service } from '@n8n/di'; import { Container, Service } from '@n8n/di';
import type { Application } from 'express'; import type { Application } from 'express';
import { ServerResponse } from 'http'; import { ServerResponse } from 'http';
@@ -205,6 +205,12 @@ export class Push extends TypedEmitter<PushEvents> {
return isWorker || (isMultiMain && !this.hasPushRef(pushRef)); return isWorker || (isMultiMain && !this.hasPushRef(pushRef));
} }
@OnPubSubEvent('relay-execution-lifecycle-event', { instanceType: 'main' })
handleRelayExecutionLifecycleEvent({ pushRef, ...pushMsg }: PushMessage & { pushRef: string }) {
if (!this.hasPushRef(pushRef)) return;
this.send(pushMsg, pushRef);
}
/** /**
* Relay a push message via the `n8n.commands` pubsub channel, * Relay a push message via the `n8n.commands` pubsub channel,
* reducing the payload size if too large. * reducing the payload size if too large.

View File

@@ -1,896 +0,0 @@
import type { WorkerStatus } from '@n8n/api-types';
import type { WorkflowRepository } from '@n8n/db';
import { mock } from 'jest-mock-extended';
import type { InstanceSettings } from 'n8n-core';
import type { IWorkflowBase, Workflow } from 'n8n-workflow';
import type { ActiveWorkflowManager } from '@/active-workflow-manager';
import type { MessageEventBus } from '@/eventbus/message-event-bus/message-event-bus';
import { EventService } from '@/events/event.service';
import type { ExternalSecretsManager } from '@/external-secrets.ee/external-secrets-manager.ee';
import type { License } from '@/license';
import type { Push } from '@/push';
import type { CommunityPackagesService } from '@/services/community-packages.service';
import type { TestWebhooks } from '@/webhooks/test-webhooks';
import type { Publisher } from '../pubsub/publisher.service';
import { PubSubHandler } from '../pubsub/pubsub-handler';
import type { WorkerStatusService } from '../worker-status.service.ee';
const flushPromises = async () => await new Promise((resolve) => setImmediate(resolve));
describe('PubSubHandler', () => {
const eventService = new EventService();
const license = mock<License>();
const eventbus = mock<MessageEventBus>();
const externalSecretsManager = mock<ExternalSecretsManager>();
const communityPackagesService = mock<CommunityPackagesService>();
const publisher = mock<Publisher>();
const workerStatusService = mock<WorkerStatusService>();
const activeWorkflowManager = mock<ActiveWorkflowManager>();
const push = mock<Push>();
const workflowRepository = mock<WorkflowRepository>();
const testWebhooks = mock<TestWebhooks>();
afterEach(() => {
eventService.removeAllListeners();
});
describe('in webhook process', () => {
const instanceSettings = mock<InstanceSettings>({ instanceType: 'webhook' });
it('should set up handlers in webhook process', () => {
// @ts-expect-error Spying on private method
const setupHandlers = jest.spyOn(PubSubHandler.prototype, 'setupHandlers');
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
expect(setupHandlers).toHaveBeenCalledWith({
'reload-license': expect.any(Function),
'restart-event-bus': expect.any(Function),
'reload-external-secrets-providers': expect.any(Function),
'community-package-install': expect.any(Function),
'community-package-update': expect.any(Function),
'community-package-uninstall': expect.any(Function),
});
});
it('should reload license on `reload-license` event', () => {
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
eventService.emit('reload-license');
expect(license.reload).toHaveBeenCalled();
});
it('should restart event bus on `restart-event-bus` event', () => {
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
eventService.emit('restart-event-bus');
expect(eventbus.restart).toHaveBeenCalled();
});
it('should reload providers on `reload-external-secrets-providers` event', () => {
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
eventService.emit('reload-external-secrets-providers');
expect(externalSecretsManager.reloadAllProviders).toHaveBeenCalled();
});
it('should install community package on `community-package-install` event', () => {
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
eventService.emit('community-package-install', {
packageName: 'test-package',
packageVersion: '1.0.0',
});
expect(communityPackagesService.installOrUpdateNpmPackage).toHaveBeenCalledWith(
'test-package',
'1.0.0',
);
});
it('should update community package on `community-package-update` event', () => {
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
eventService.emit('community-package-update', {
packageName: 'test-package',
packageVersion: '1.0.0',
});
expect(communityPackagesService.installOrUpdateNpmPackage).toHaveBeenCalledWith(
'test-package',
'1.0.0',
);
});
it('should uninstall community package on `community-package-uninstall` event', () => {
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
eventService.emit('community-package-uninstall', {
packageName: 'test-package',
});
expect(communityPackagesService.removeNpmPackage).toHaveBeenCalledWith('test-package');
});
});
describe('in worker process', () => {
const instanceSettings = mock<InstanceSettings>({ instanceType: 'worker' });
it('should set up handlers in worker process', () => {
// @ts-expect-error Spying on private method
const setupHandlersSpy = jest.spyOn(PubSubHandler.prototype, 'setupHandlers');
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
expect(setupHandlersSpy).toHaveBeenCalledWith({
'reload-license': expect.any(Function),
'restart-event-bus': expect.any(Function),
'reload-external-secrets-providers': expect.any(Function),
'community-package-install': expect.any(Function),
'community-package-update': expect.any(Function),
'community-package-uninstall': expect.any(Function),
'get-worker-status': expect.any(Function),
});
});
it('should reload license on `reload-license` event', () => {
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
eventService.emit('reload-license');
expect(license.reload).toHaveBeenCalled();
});
it('should restart event bus on `restart-event-bus` event', () => {
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
eventService.emit('restart-event-bus');
expect(eventbus.restart).toHaveBeenCalled();
});
it('should reload providers on `reload-external-secrets-providers` event', () => {
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
eventService.emit('reload-external-secrets-providers');
expect(externalSecretsManager.reloadAllProviders).toHaveBeenCalled();
});
it('should install community package on `community-package-install` event', () => {
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
eventService.emit('community-package-install', {
packageName: 'test-package',
packageVersion: '1.0.0',
});
expect(communityPackagesService.installOrUpdateNpmPackage).toHaveBeenCalledWith(
'test-package',
'1.0.0',
);
});
it('should update community package on `community-package-update` event', () => {
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
eventService.emit('community-package-update', {
packageName: 'test-package',
packageVersion: '1.0.0',
});
expect(communityPackagesService.installOrUpdateNpmPackage).toHaveBeenCalledWith(
'test-package',
'1.0.0',
);
});
it('should uninstall community package on `community-package-uninstall` event', () => {
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
eventService.emit('community-package-uninstall', {
packageName: 'test-package',
});
expect(communityPackagesService.removeNpmPackage).toHaveBeenCalledWith('test-package');
});
it('should generate status on `get-worker-status` event', () => {
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
eventService.emit('get-worker-status');
expect(workerStatusService.generateStatus).toHaveBeenCalled();
});
});
describe('in main process', () => {
const instanceSettings = mock<InstanceSettings>({
instanceType: 'main',
isLeader: true,
isFollower: false,
});
afterEach(() => {
jest.clearAllMocks();
});
it('should set up command and worker response handlers in main process', () => {
// @ts-expect-error Spying on private method
const setupHandlersSpy = jest.spyOn(PubSubHandler.prototype, 'setupHandlers');
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
expect(setupHandlersSpy).toHaveBeenCalledWith({
'reload-license': expect.any(Function),
'restart-event-bus': expect.any(Function),
'reload-external-secrets-providers': expect.any(Function),
'community-package-install': expect.any(Function),
'community-package-update': expect.any(Function),
'community-package-uninstall': expect.any(Function),
'add-webhooks-triggers-and-pollers': expect.any(Function),
'remove-triggers-and-pollers': expect.any(Function),
'display-workflow-activation': expect.any(Function),
'display-workflow-deactivation': expect.any(Function),
'display-workflow-activation-error': expect.any(Function),
'relay-execution-lifecycle-event': expect.any(Function),
'clear-test-webhooks': expect.any(Function),
'response-to-get-worker-status': expect.any(Function),
});
});
it('should reload license on `reload-license` event', () => {
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
eventService.emit('reload-license');
expect(license.reload).toHaveBeenCalled();
});
it('should restart event bus on `restart-event-bus` event', () => {
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
eventService.emit('restart-event-bus');
expect(eventbus.restart).toHaveBeenCalled();
});
it('should reload providers on `reload-external-secrets-providers` event', () => {
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
eventService.emit('reload-external-secrets-providers');
expect(externalSecretsManager.reloadAllProviders).toHaveBeenCalled();
});
it('should install community package on `community-package-install` event', () => {
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
eventService.emit('community-package-install', {
packageName: 'test-package',
packageVersion: '1.0.0',
});
expect(communityPackagesService.installOrUpdateNpmPackage).toHaveBeenCalledWith(
'test-package',
'1.0.0',
);
});
it('should update community package on `community-package-update` event', () => {
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
eventService.emit('community-package-update', {
packageName: 'test-package',
packageVersion: '1.0.0',
});
expect(communityPackagesService.installOrUpdateNpmPackage).toHaveBeenCalledWith(
'test-package',
'1.0.0',
);
});
it('should uninstall community package on `community-package-uninstall` event', () => {
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
eventService.emit('community-package-uninstall', {
packageName: 'test-package',
});
expect(communityPackagesService.removeNpmPackage).toHaveBeenCalledWith('test-package');
});
describe('multi-main setup', () => {
it('if leader, should handle `add-webhooks-triggers-and-pollers` event', async () => {
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
const workflowId = 'test-workflow-id';
eventService.emit('add-webhooks-triggers-and-pollers', { workflowId });
await flushPromises();
expect(activeWorkflowManager.add).toHaveBeenCalledWith(workflowId, 'activate', undefined, {
shouldPublish: false,
});
expect(push.broadcast).toHaveBeenCalledWith({
type: 'workflowActivated',
data: { workflowId },
});
expect(publisher.publishCommand).toHaveBeenCalledWith({
command: 'display-workflow-activation',
payload: { workflowId },
});
});
it('if follower, should skip `add-webhooks-triggers-and-pollers` event', async () => {
new PubSubHandler(
eventService,
mock<InstanceSettings>({ instanceType: 'main', isLeader: false, isFollower: true }),
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
const workflowId = 'test-workflow-id';
eventService.emit('add-webhooks-triggers-and-pollers', { workflowId });
await flushPromises();
expect(activeWorkflowManager.add).not.toHaveBeenCalled();
expect(push.broadcast).not.toHaveBeenCalled();
expect(publisher.publishCommand).not.toHaveBeenCalled();
});
it('if leader, should handle `remove-triggers-and-pollers` event', async () => {
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
const workflowId = 'test-workflow-id';
eventService.emit('remove-triggers-and-pollers', { workflowId });
await flushPromises();
expect(activeWorkflowManager.removeActivationError).toHaveBeenCalledWith(workflowId);
expect(activeWorkflowManager.removeWorkflowTriggersAndPollers).toHaveBeenCalledWith(
workflowId,
);
expect(push.broadcast).toHaveBeenCalledWith({
type: 'workflowDeactivated',
data: { workflowId },
});
expect(publisher.publishCommand).toHaveBeenCalledWith({
command: 'display-workflow-deactivation',
payload: { workflowId },
});
});
it('if follower, should skip `remove-triggers-and-pollers` event', async () => {
new PubSubHandler(
eventService,
mock<InstanceSettings>({ instanceType: 'main', isLeader: false, isFollower: true }),
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
const workflowId = 'test-workflow-id';
eventService.emit('remove-triggers-and-pollers', { workflowId });
await flushPromises();
expect(activeWorkflowManager.removeActivationError).not.toHaveBeenCalled();
expect(activeWorkflowManager.removeWorkflowTriggersAndPollers).not.toHaveBeenCalled();
expect(push.broadcast).not.toHaveBeenCalled();
expect(publisher.publishCommand).not.toHaveBeenCalled();
});
it('should handle `display-workflow-activation` event', () => {
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
const workflowId = 'test-workflow-id';
eventService.emit('display-workflow-activation', { workflowId });
expect(push.broadcast).toHaveBeenCalledWith({
type: 'workflowActivated',
data: { workflowId },
});
});
it('should handle `display-workflow-deactivation` event', () => {
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
const workflowId = 'test-workflow-id';
eventService.emit('display-workflow-deactivation', { workflowId });
expect(push.broadcast).toHaveBeenCalledWith({
type: 'workflowDeactivated',
data: { workflowId },
});
});
it('should handle `display-workflow-activation-error` event', () => {
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
const workflowId = 'test-workflow-id';
const errorMessage = 'Test error message';
eventService.emit('display-workflow-activation-error', { workflowId, errorMessage });
expect(push.broadcast).toHaveBeenCalledWith({
type: 'workflowFailedToActivate',
data: {
workflowId,
errorMessage,
},
});
});
it('should handle `relay-execution-lifecycle-event` event', () => {
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
const pushRef = 'test-push-ref';
const type = 'executionStarted';
const data = {
executionId: '123',
mode: 'webhook' as const,
startedAt: new Date(),
workflowId: '456',
flattedRunData: '[]',
};
push.hasPushRef.mockReturnValue(true);
eventService.emit('relay-execution-lifecycle-event', { type, data, pushRef });
expect(push.send).toHaveBeenCalledWith({ type, data }, pushRef);
});
it('should handle `clear-test-webhooks` event', () => {
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
const webhookKey = 'test-webhook-key';
const workflowEntity = mock<IWorkflowBase>({ id: 'test-workflow-id' });
const pushRef = 'test-push-ref';
push.hasPushRef.mockReturnValue(true);
testWebhooks.toWorkflow.mockReturnValue(mock<Workflow>({ id: 'test-workflow-id' }));
eventService.emit('clear-test-webhooks', { webhookKey, workflowEntity, pushRef });
expect(testWebhooks.clearTimeout).toHaveBeenCalledWith(webhookKey);
expect(testWebhooks.deactivateWebhooks).toHaveBeenCalled();
});
it('should handle `response-to-get-worker-status event', () => {
new PubSubHandler(
eventService,
instanceSettings,
license,
eventbus,
externalSecretsManager,
communityPackagesService,
publisher,
workerStatusService,
activeWorkflowManager,
push,
workflowRepository,
testWebhooks,
).init();
const workerStatus = mock<WorkerStatus>({ senderId: 'worker-1', loadAvg: [123] });
eventService.emit('response-to-get-worker-status', workerStatus);
expect(push.broadcast).toHaveBeenCalledWith({
type: 'sendWorkerStatusMessage',
data: {
workerId: workerStatus.senderId,
status: workerStatus,
},
});
});
});
});
});

View File

@@ -6,8 +6,8 @@ import config from '@/config';
import type { RedisClientService } from '@/services/redis-client.service'; import type { RedisClientService } from '@/services/redis-client.service';
import { mockLogger } from '@test/mocking'; import { mockLogger } from '@test/mocking';
import { Publisher } from '../pubsub/publisher.service'; import { Publisher } from '../publisher.service';
import type { PubSub } from '../pubsub/pubsub.types'; import type { PubSub } from '../pubsub.types';
describe('Publisher', () => { describe('Publisher', () => {
beforeEach(() => { beforeEach(() => {

View File

@@ -0,0 +1,215 @@
import { OnPubSubEvent, PubSubMetadata } from '@n8n/decorators';
import { Container, Service } from '@n8n/di';
import { mock } from 'jest-mock-extended';
import type { InstanceSettings } from 'n8n-core';
import { mockLogger } from '@test/mocking';
import { PubSubEventBus } from '../pubsub.eventbus';
import { PubSubRegistry } from '../pubsub.registry';
describe('PubSubRegistry', () => {
let metadata: PubSubMetadata;
let pubsubEventBus: PubSubEventBus;
let logger: ReturnType<typeof mockLogger>;
const workflowId = 'test-workflow-id';
const createTestServiceClass = () => {
@Service()
class TestService {
@OnPubSubEvent('reload-external-secrets-providers', { instanceType: 'main' })
onMainInstance() {}
@OnPubSubEvent('restart-event-bus', { instanceType: 'worker' })
onWorkerInstance() {}
@OnPubSubEvent('add-webhooks-triggers-and-pollers', {
instanceType: 'main',
instanceRole: 'leader',
})
onLeaderInstance() {}
@OnPubSubEvent('restart-event-bus', {
instanceType: 'main',
instanceRole: 'follower',
})
onFollowerInstance() {}
@OnPubSubEvent('clear-test-webhooks')
onAllInstances() {}
}
return TestService;
};
const workerInstanceSettings = mock<InstanceSettings>({ instanceType: 'worker' });
const leaderInstanceSettings = mock<InstanceSettings>({
instanceType: 'main',
instanceRole: 'leader',
});
const followerInstanceSettings = mock<InstanceSettings>({
instanceType: 'main',
instanceRole: 'follower',
});
beforeEach(() => {
jest.resetAllMocks();
Container.reset();
metadata = Container.get(PubSubMetadata);
pubsubEventBus = Container.get(PubSubEventBus);
logger = mockLogger();
});
it('should call decorated methods when events are emitted', () => {
const TestService = createTestServiceClass();
const testService = Container.get(TestService);
const onMainInstanceSpy = jest.spyOn(testService, 'onMainInstance');
const pubSubRegistry = new PubSubRegistry(
logger,
leaderInstanceSettings,
metadata,
pubsubEventBus,
);
pubSubRegistry.init();
pubsubEventBus.emit('reload-external-secrets-providers');
expect(onMainInstanceSpy).toHaveBeenCalledTimes(1);
});
it('should respect instance type filtering when handling events', () => {
const TestService = createTestServiceClass();
const testService = Container.get(TestService);
const onMainInstanceSpy = jest.spyOn(testService, 'onMainInstance');
const onWorkerInstanceSpy = jest.spyOn(testService, 'onWorkerInstance');
// Test with main leader instance
const mainPubSubRegistry = new PubSubRegistry(
logger,
leaderInstanceSettings,
metadata,
pubsubEventBus,
);
mainPubSubRegistry.init();
pubsubEventBus.emit('reload-external-secrets-providers');
expect(onMainInstanceSpy).toHaveBeenCalledTimes(1);
pubsubEventBus.emit('restart-event-bus');
expect(onWorkerInstanceSpy).not.toHaveBeenCalled();
// Test with worker instance
jest.clearAllMocks();
pubsubEventBus.removeAllListeners();
const workerPubSub = new PubSubRegistry(
logger,
workerInstanceSettings,
metadata,
pubsubEventBus,
);
workerPubSub.init();
pubsubEventBus.emit('reload-external-secrets-providers');
expect(onMainInstanceSpy).not.toHaveBeenCalled();
pubsubEventBus.emit('restart-event-bus');
expect(onWorkerInstanceSpy).toHaveBeenCalledTimes(1);
});
it('should respect instance role filtering when handling events', () => {
const TestService = createTestServiceClass();
const testService = Container.get(TestService);
const onLeaderInstanceSpy = jest.spyOn(testService, 'onLeaderInstance');
const onFollowerInstanceSpy = jest.spyOn(testService, 'onFollowerInstance');
const onAllInstancesSpy = jest.spyOn(testService, 'onAllInstances');
// Test with leader instance
const pubSubRegistry = new PubSubRegistry(
logger,
leaderInstanceSettings,
metadata,
pubsubEventBus,
);
pubSubRegistry.init();
pubsubEventBus.emit('add-webhooks-triggers-and-pollers', { workflowId });
expect(onLeaderInstanceSpy).toHaveBeenCalledTimes(1);
expect(onLeaderInstanceSpy).toHaveBeenCalledWith({ workflowId });
pubsubEventBus.emit('restart-event-bus');
expect(onFollowerInstanceSpy).not.toHaveBeenCalled();
pubsubEventBus.emit('clear-test-webhooks');
expect(onAllInstancesSpy).toHaveBeenCalledTimes(1);
// Test with follower instance
jest.clearAllMocks();
pubsubEventBus.removeAllListeners();
const followerPubSubRegistry = new PubSubRegistry(
logger,
followerInstanceSettings,
metadata,
pubsubEventBus,
);
followerPubSubRegistry.init();
pubsubEventBus.emit('add-webhooks-triggers-and-pollers', { workflowId });
expect(onLeaderInstanceSpy).not.toHaveBeenCalled();
pubsubEventBus.emit('restart-event-bus');
expect(onFollowerInstanceSpy).toHaveBeenCalledTimes(1);
pubsubEventBus.emit('clear-test-webhooks');
expect(onAllInstancesSpy).toHaveBeenCalledTimes(1);
});
it('should handle both instance type and role filtering together', () => {
const TestService = createTestServiceClass();
const testService = Container.get(TestService);
const onLeaderInstanceSpy = jest.spyOn(testService, 'onLeaderInstance');
// Test with main leader instance
const pubSubRegistry = new PubSubRegistry(
logger,
leaderInstanceSettings,
metadata,
pubsubEventBus,
);
pubSubRegistry.init();
pubsubEventBus.emit('add-webhooks-triggers-and-pollers', { workflowId });
expect(onLeaderInstanceSpy).toHaveBeenCalledTimes(1);
expect(onLeaderInstanceSpy).toHaveBeenCalledWith({ workflowId });
});
it('should handle dynamic role changes at runtime', () => {
const TestService = createTestServiceClass();
const testService = Container.get(TestService);
const onLeaderInstanceSpy = jest.spyOn(testService, 'onLeaderInstance');
// Create a mutable instance settings object to simulate role changes
const instanceSettings = mock<InstanceSettings>({
instanceType: 'main',
instanceRole: 'follower',
});
const pubSubRegistry = new PubSubRegistry(logger, instanceSettings, metadata, pubsubEventBus);
pubSubRegistry.init();
// Initially as follower, event should be ignored
pubsubEventBus.emit('add-webhooks-triggers-and-pollers', { workflowId });
expect(onLeaderInstanceSpy).not.toHaveBeenCalled();
// Change role to leader
instanceSettings.instanceRole = 'leader';
pubsubEventBus.emit('add-webhooks-triggers-and-pollers', { workflowId });
expect(onLeaderInstanceSpy).toHaveBeenCalledTimes(1);
expect(onLeaderInstanceSpy).toHaveBeenCalledWith({ workflowId });
// Change back to follower
onLeaderInstanceSpy.mockClear();
instanceSettings.instanceRole = 'follower';
pubsubEventBus.emit('add-webhooks-triggers-and-pollers', { workflowId });
expect(onLeaderInstanceSpy).not.toHaveBeenCalled();
});
});

View File

@@ -4,7 +4,7 @@ import { mock } from 'jest-mock-extended';
import config from '@/config'; import config from '@/config';
import type { RedisClientService } from '@/services/redis-client.service'; import type { RedisClientService } from '@/services/redis-client.service';
import { Subscriber } from '../pubsub/subscriber.service'; import { Subscriber } from '../subscriber.service';
describe('Subscriber', () => { describe('Subscriber', () => {
beforeEach(() => { beforeEach(() => {
@@ -17,14 +17,14 @@ describe('Subscriber', () => {
describe('constructor', () => { describe('constructor', () => {
it('should init Redis client in scaling mode', () => { it('should init Redis client in scaling mode', () => {
const subscriber = new Subscriber(mock(), redisClientService, mock(), mock()); const subscriber = new Subscriber(mock(), mock(), mock(), redisClientService);
expect(subscriber.getClient()).toEqual(client); expect(subscriber.getClient()).toEqual(client);
}); });
it('should not init Redis client in regular mode', () => { it('should not init Redis client in regular mode', () => {
config.set('executions.mode', 'regular'); config.set('executions.mode', 'regular');
const subscriber = new Subscriber(mock(), redisClientService, mock(), mock()); const subscriber = new Subscriber(mock(), mock(), mock(), redisClientService);
expect(subscriber.getClient()).toBeUndefined(); expect(subscriber.getClient()).toBeUndefined();
}); });
@@ -32,7 +32,7 @@ describe('Subscriber', () => {
describe('shutdown', () => { describe('shutdown', () => {
it('should disconnect Redis client', () => { it('should disconnect Redis client', () => {
const subscriber = new Subscriber(mock(), redisClientService, mock(), mock()); const subscriber = new Subscriber(mock(), mock(), mock(), redisClientService);
subscriber.shutdown(); subscriber.shutdown();
expect(client.disconnect).toHaveBeenCalled(); expect(client.disconnect).toHaveBeenCalled();
}); });
@@ -40,7 +40,7 @@ describe('Subscriber', () => {
describe('subscribe', () => { describe('subscribe', () => {
it('should subscribe to pubsub channel', async () => { it('should subscribe to pubsub channel', async () => {
const subscriber = new Subscriber(mock(), redisClientService, mock(), mock()); const subscriber = new Subscriber(mock(), mock(), mock(), redisClientService);
await subscriber.subscribe('n8n.commands'); await subscriber.subscribe('n8n.commands');

View File

@@ -1,177 +0,0 @@
import { WorkflowRepository } from '@n8n/db';
import { Service } from '@n8n/di';
import { InstanceSettings } from 'n8n-core';
import { ensureError } from 'n8n-workflow';
import { ActiveWorkflowManager } from '@/active-workflow-manager';
import { MessageEventBus } from '@/eventbus/message-event-bus/message-event-bus';
import { EventService } from '@/events/event.service';
import type { PubSubEventMap } from '@/events/maps/pub-sub.event-map';
import { ExternalSecretsManager } from '@/external-secrets.ee/external-secrets-manager.ee';
import { License } from '@/license';
import { Push } from '@/push';
import { Publisher } from '@/scaling/pubsub/publisher.service';
import { CommunityPackagesService } from '@/services/community-packages.service';
import { assertNever } from '@/utils';
import { TestWebhooks } from '@/webhooks/test-webhooks';
import type { PubSub } from './pubsub.types';
import { WorkerStatusService } from '../worker-status.service.ee';
/**
* Responsible for handling events emitted from messages received via a pubsub channel.
*/
@Service()
export class PubSubHandler {
constructor(
private readonly eventService: EventService,
private readonly instanceSettings: InstanceSettings,
private readonly license: License,
private readonly eventbus: MessageEventBus,
private readonly externalSecretsManager: ExternalSecretsManager,
private readonly communityPackagesService: CommunityPackagesService,
private readonly publisher: Publisher,
private readonly workerStatusService: WorkerStatusService,
private readonly activeWorkflowManager: ActiveWorkflowManager,
private readonly push: Push,
private readonly workflowRepository: WorkflowRepository,
private readonly testWebhooks: TestWebhooks,
) {}
init() {
switch (this.instanceSettings.instanceType) {
case 'webhook':
this.setupHandlers(this.commonHandlers);
break;
case 'worker':
this.setupHandlers({
...this.commonHandlers,
'get-worker-status': async () =>
await this.publisher.publishWorkerResponse({
senderId: this.instanceSettings.hostId,
response: 'response-to-get-worker-status',
payload: this.workerStatusService.generateStatus(),
}),
});
break;
case 'main':
this.setupHandlers({
...this.commonHandlers,
...this.multiMainHandlers,
'response-to-get-worker-status': async (payload) =>
this.push.broadcast({
type: 'sendWorkerStatusMessage',
data: {
workerId: payload.senderId,
status: payload,
},
}),
});
break;
default:
assertNever(this.instanceSettings.instanceType);
}
}
private setupHandlers<EventNames extends keyof PubSubEventMap>(
map: {
[EventName in EventNames]?: (event: PubSubEventMap[EventName]) => void | Promise<void>;
},
) {
for (const [eventName, handlerFn] of Object.entries(map) as Array<
[EventNames, (event: PubSubEventMap[EventNames]) => void | Promise<void>]
>) {
this.eventService.on(eventName, async (event) => {
await handlerFn(event);
});
}
}
private commonHandlers: {
[EventName in keyof PubSub.CommonEvents]: (event: PubSubEventMap[EventName]) => Promise<void>;
} = {
'reload-license': async () => await this.license.reload(),
'restart-event-bus': async () => await this.eventbus.restart(),
'reload-external-secrets-providers': async () =>
await this.externalSecretsManager.reloadAllProviders(),
'community-package-install': async ({ packageName, packageVersion }) =>
await this.communityPackagesService.installOrUpdateNpmPackage(packageName, packageVersion),
'community-package-update': async ({ packageName, packageVersion }) =>
await this.communityPackagesService.installOrUpdateNpmPackage(packageName, packageVersion),
'community-package-uninstall': async ({ packageName }) =>
await this.communityPackagesService.removeNpmPackage(packageName),
};
private multiMainHandlers: {
[EventName in keyof PubSub.MultiMainEvents]: (
event: PubSubEventMap[EventName],
) => Promise<void>;
} = {
'add-webhooks-triggers-and-pollers': async ({ workflowId }) => {
if (this.instanceSettings.isFollower) return;
try {
await this.activeWorkflowManager.add(workflowId, 'activate', undefined, {
shouldPublish: false, // prevent leader from re-publishing message
});
this.push.broadcast({ type: 'workflowActivated', data: { workflowId } });
await this.publisher.publishCommand({
command: 'display-workflow-activation',
payload: { workflowId },
}); // instruct followers to show activation in UI
} catch (e) {
const error = ensureError(e);
const { message } = error;
await this.workflowRepository.update(workflowId, { active: false });
this.push.broadcast({
type: 'workflowFailedToActivate',
data: { workflowId, errorMessage: message },
});
await this.publisher.publishCommand({
command: 'display-workflow-activation-error',
payload: { workflowId, errorMessage: message },
}); // instruct followers to show activation error in UI
}
},
'remove-triggers-and-pollers': async ({ workflowId }) => {
if (this.instanceSettings.isFollower) return;
await this.activeWorkflowManager.removeActivationError(workflowId);
await this.activeWorkflowManager.removeWorkflowTriggersAndPollers(workflowId);
this.push.broadcast({ type: 'workflowDeactivated', data: { workflowId } });
// instruct followers to show workflow deactivation in UI
await this.publisher.publishCommand({
command: 'display-workflow-deactivation',
payload: { workflowId },
});
},
'display-workflow-activation': async ({ workflowId }) =>
this.push.broadcast({ type: 'workflowActivated', data: { workflowId } }),
'display-workflow-deactivation': async ({ workflowId }) =>
this.push.broadcast({ type: 'workflowDeactivated', data: { workflowId } }),
'display-workflow-activation-error': async ({ workflowId, errorMessage }) =>
this.push.broadcast({ type: 'workflowFailedToActivate', data: { workflowId, errorMessage } }),
'relay-execution-lifecycle-event': async ({ pushRef, ...pushMsg }) => {
if (!this.push.hasPushRef(pushRef)) return;
this.push.send(pushMsg, pushRef);
},
'clear-test-webhooks': async ({ webhookKey, workflowEntity, pushRef }) => {
if (!this.push.hasPushRef(pushRef)) return;
this.testWebhooks.clearTimeout(webhookKey);
const workflow = this.testWebhooks.toWorkflow(workflowEntity);
await this.testWebhooks.deactivateWebhooks(workflow);
},
};
}

View File

@@ -1,8 +1,6 @@
import type { PushMessage, WorkerStatus } from '@n8n/api-types'; import type { PushMessage, WorkerStatus } from '@n8n/api-types';
import type { IWorkflowBase } from 'n8n-workflow'; import type { IWorkflowBase } from 'n8n-workflow';
export type PubSubEventMap = PubSubCommandMap & PubSubWorkerResponseMap;
export type PubSubCommandMap = { export type PubSubCommandMap = {
// #region Lifecycle // #region Lifecycle
@@ -79,3 +77,5 @@ export type PubSubCommandMap = {
export type PubSubWorkerResponseMap = { export type PubSubWorkerResponseMap = {
'response-to-get-worker-status': WorkerStatus; 'response-to-get-worker-status': WorkerStatus;
}; };
export type PubSubEventMap = PubSubCommandMap & PubSubWorkerResponseMap;

View File

@@ -0,0 +1,8 @@
import { Service } from '@n8n/di';
import { TypedEmitter } from '@/typed-emitter';
import type { PubSubEventMap } from './pubsub.event-map';
@Service()
export class PubSubEventBus extends TypedEmitter<PubSubEventMap> {}

View File

@@ -0,0 +1,39 @@
import { Logger } from '@n8n/backend-common';
import { PubSubMetadata } from '@n8n/decorators';
import { Container, Service } from '@n8n/di';
import { InstanceSettings } from 'n8n-core';
import { PubSubEventBus } from './pubsub.eventbus';
@Service()
export class PubSubRegistry {
constructor(
private readonly logger: Logger,
private readonly instanceSettings: InstanceSettings,
private readonly pubSubMetadata: PubSubMetadata,
private readonly pubsubEventBus: PubSubEventBus,
) {
this.logger = this.logger.scoped('pubsub');
}
init() {
const { instanceSettings, pubSubMetadata } = this;
const handlers = pubSubMetadata.getHandlers();
for (const { eventHandlerClass, methodName, eventName, filter } of handlers) {
const handlerClass = Container.get(eventHandlerClass);
if (!filter?.instanceType || filter.instanceType === instanceSettings.instanceType) {
this.logger.debug(
`Registered a "${eventName}" event handler on ${eventHandlerClass.name}#${methodName}`,
);
this.pubsubEventBus.on(eventName, async (...args: unknown[]) => {
// Since the instance role can change, this check needs to be in the event listener
const shouldTrigger =
filter?.instanceType !== 'main' ||
!filter.instanceRole ||
filter.instanceRole === instanceSettings.instanceRole;
if (shouldTrigger) await handlerClass[methodName].call(handlerClass, ...args);
});
}
}
}
}

View File

@@ -1,10 +1,6 @@
import type {
PubSubCommandMap,
PubSubEventMap,
PubSubWorkerResponseMap,
} from '@/events/maps/pub-sub.event-map';
import type { Resolve } from '@/utlity.types'; import type { Resolve } from '@/utlity.types';
import type { PubSubCommandMap, PubSubWorkerResponseMap } from './pubsub.event-map';
import type { COMMAND_PUBSUB_CHANNEL, WORKER_RESPONSE_PUBSUB_CHANNEL } from '../constants'; import type { COMMAND_PUBSUB_CHANNEL, WORKER_RESPONSE_PUBSUB_CHANNEL } from '../constants';
export namespace PubSub { export namespace PubSub {
@@ -104,34 +100,4 @@ export namespace PubSub {
/** Response sent via the `n8n.worker-response` pubsub channel. */ /** Response sent via the `n8n.worker-response` pubsub channel. */
export type WorkerResponse = ToWorkerResponse<'response-to-get-worker-status'>; export type WorkerResponse = ToWorkerResponse<'response-to-get-worker-status'>;
// ----------------------------------
// events
// ----------------------------------
/**
* Of all events emitted from pubsub messages, those whose handlers
* are all present in main, worker, and webhook processes.
*/
export type CommonEvents = Pick<
PubSubEventMap,
| 'reload-license'
| 'restart-event-bus'
| 'reload-external-secrets-providers'
| 'community-package-install'
| 'community-package-update'
| 'community-package-uninstall'
>;
/** Multi-main events emitted from pubsub messages. */
export type MultiMainEvents = Pick<
PubSubEventMap,
| 'add-webhooks-triggers-and-pollers'
| 'remove-triggers-and-pollers'
| 'display-workflow-activation'
| 'display-workflow-deactivation'
| 'display-workflow-activation-error'
| 'relay-execution-lifecycle-event'
| 'clear-test-webhooks'
>;
} }

View File

@@ -7,9 +7,9 @@ import { jsonParse } from 'n8n-workflow';
import type { LogMetadata } from 'n8n-workflow'; import type { LogMetadata } from 'n8n-workflow';
import config from '@/config'; import config from '@/config';
import { EventService } from '@/events/event.service';
import { RedisClientService } from '@/services/redis-client.service'; import { RedisClientService } from '@/services/redis-client.service';
import { PubSubEventBus } from './pubsub.eventbus';
import type { PubSub } from './pubsub.types'; import type { PubSub } from './pubsub.types';
/** /**
@@ -21,9 +21,9 @@ export class Subscriber {
constructor( constructor(
private readonly logger: Logger, private readonly logger: Logger,
private readonly redisClientService: RedisClientService,
private readonly eventService: EventService,
private readonly instanceSettings: InstanceSettings, private readonly instanceSettings: InstanceSettings,
private readonly pubsubEventBus: PubSubEventBus,
private readonly redisClientService: RedisClientService,
) { ) {
// @TODO: Once this class is only ever initialized in scaling mode, throw in the next line instead. // @TODO: Once this class is only ever initialized in scaling mode, throw in the next line instead.
if (config.getEnv('executions.mode') !== 'queue') return; if (config.getEnv('executions.mode') !== 'queue') return;
@@ -34,7 +34,7 @@ export class Subscriber {
const handlerFn = (msg: PubSub.Command | PubSub.WorkerResponse) => { const handlerFn = (msg: PubSub.Command | PubSub.WorkerResponse) => {
const eventName = 'command' in msg ? msg.command : msg.response; const eventName = 'command' in msg ? msg.command : msg.response;
this.eventService.emit(eventName, msg.payload); this.pubsubEventBus.emit(eventName, msg.payload);
}; };
const debouncedHandlerFn = debounce(handlerFn, 300); const debouncedHandlerFn = debounce(handlerFn, 300);

View File

@@ -1,20 +1,51 @@
import type { WorkerStatus } from '@n8n/api-types'; import { WorkerStatus } from '@n8n/api-types';
import { OnPubSubEvent } from '@n8n/decorators';
import { Service } from '@n8n/di'; import { Service } from '@n8n/di';
import { InstanceSettings } from 'n8n-core'; import { InstanceSettings } from 'n8n-core';
import os from 'node:os'; import os from 'node:os';
import { N8N_VERSION } from '@/constants'; import { N8N_VERSION } from '@/constants';
import { Push } from '@/push';
import { JobProcessor } from './job-processor'; import { JobProcessor } from './job-processor';
import { Publisher } from './pubsub/publisher.service';
@Service() @Service()
export class WorkerStatusService { export class WorkerStatusService {
constructor( constructor(
private readonly jobProcessor: JobProcessor, private readonly jobProcessor: JobProcessor,
private readonly instanceSettings: InstanceSettings, private readonly instanceSettings: InstanceSettings,
private readonly publisher: Publisher,
private readonly push: Push,
) {} ) {}
generateStatus(): WorkerStatus { async requestWorkerStatus() {
if (this.instanceSettings.instanceType !== 'main') return;
return await this.publisher.publishCommand({ command: 'get-worker-status' });
}
@OnPubSubEvent('response-to-get-worker-status', { instanceType: 'main' })
handleWorkerStatusResponse(payload: WorkerStatus) {
this.push.broadcast({
type: 'sendWorkerStatusMessage',
data: {
workerId: payload.senderId,
status: payload,
},
});
}
@OnPubSubEvent('get-worker-status', { instanceType: 'worker' })
async publishWorkerResponse() {
await this.publisher.publishWorkerResponse({
senderId: this.instanceSettings.hostId,
response: 'response-to-get-worker-status',
payload: this.generateStatus(),
});
}
private generateStatus(): WorkerStatus {
return { return {
senderId: this.instanceSettings.hostId, senderId: this.instanceSettings.hostId,
runningJobsSummary: this.jobProcessor.getRunningJobsSummary(), runningJobsSummary: this.jobProcessor.getRunningJobsSummary(),

View File

@@ -3,6 +3,7 @@ import { GlobalConfig } from '@n8n/config';
import { LICENSE_FEATURES } from '@n8n/constants'; import { LICENSE_FEATURES } from '@n8n/constants';
import type { InstalledPackages } from '@n8n/db'; import type { InstalledPackages } from '@n8n/db';
import { InstalledPackagesRepository } from '@n8n/db'; import { InstalledPackagesRepository } from '@n8n/db';
import { OnPubSubEvent } from '@n8n/decorators';
import { Service } from '@n8n/di'; import { Service } from '@n8n/di';
import axios from 'axios'; import axios from 'axios';
import { exec } from 'child_process'; import { exec } from 'child_process';
@@ -447,14 +448,28 @@ export class CommunityPackagesService {
} }
} }
async installOrUpdateNpmPackage(packageName: string, packageVersion: string) { @OnPubSubEvent('community-package-install')
@OnPubSubEvent('community-package-update')
async handleInstallEvent({
packageName,
packageVersion,
}: { packageName: string; packageVersion: string }) {
await this.installOrUpdateNpmPackage(packageName, packageVersion);
}
@OnPubSubEvent('community-package-uninstall')
async handleUninstallEvent({ packageName }: { packageName: string }) {
await this.removeNpmPackage(packageName);
}
private async installOrUpdateNpmPackage(packageName: string, packageVersion: string) {
await this.downloadPackage(packageName, packageVersion); await this.downloadPackage(packageName, packageVersion);
await this.loadNodesAndCredentials.loadPackage(packageName); await this.loadNodesAndCredentials.loadPackage(packageName);
await this.loadNodesAndCredentials.postProcessLoaders(); await this.loadNodesAndCredentials.postProcessLoaders();
this.logger.info(`Community package installed: ${packageName}`); this.logger.info(`Community package installed: ${packageName}`);
} }
async removeNpmPackage(packageName: string) { private async removeNpmPackage(packageName: string) {
await this.deletePackageDirectory(packageName); await this.deletePackageDirectory(packageName);
await this.loadNodesAndCredentials.unloadPackage(packageName); await this.loadNodesAndCredentials.unloadPackage(packageName);
await this.loadNodesAndCredentials.postProcessLoaders(); await this.loadNodesAndCredentials.postProcessLoaders();

View File

@@ -1,3 +1,4 @@
import { OnPubSubEvent } from '@n8n/decorators';
import { Service } from '@n8n/di'; import { Service } from '@n8n/di';
import type express from 'express'; import type express from 'express';
import { InstanceSettings } from 'n8n-core'; import { InstanceSettings } from 'n8n-core';
@@ -168,6 +169,25 @@ export class TestWebhooks implements IWebhookManager {
}); });
} }
@OnPubSubEvent('clear-test-webhooks', { instanceType: 'main' })
async handleClearTestWebhooks({
webhookKey,
workflowEntity,
pushRef,
}: {
webhookKey: string;
workflowEntity: IWorkflowBase;
pushRef: string;
}) {
if (!this.push.hasPushRef(pushRef)) return;
this.clearTimeout(webhookKey);
const workflow = this.toWorkflow(workflowEntity);
await this.deactivateWebhooks(workflow);
}
clearTimeout(key: string) { clearTimeout(key: string) {
const timeout = this.timeouts[key]; const timeout = this.timeouts[key];

View File

@@ -41,6 +41,7 @@
"@n8n/backend-common": "workspace:^", "@n8n/backend-common": "workspace:^",
"@n8n/client-oauth2": "workspace:*", "@n8n/client-oauth2": "workspace:*",
"@n8n/config": "workspace:*", "@n8n/config": "workspace:*",
"@n8n/constants": "workspace:*",
"@n8n/decorators": "workspace:*", "@n8n/decorators": "workspace:*",
"@n8n/di": "workspace:*", "@n8n/di": "workspace:*",
"@sentry/node": "catalog:", "@sentry/node": "catalog:",

View File

@@ -1,4 +1,5 @@
import { Logger } from '@n8n/backend-common'; import { Logger } from '@n8n/backend-common';
import type { InstanceType } from '@n8n/constants';
import { Service } from '@n8n/di'; import { Service } from '@n8n/di';
import type { NodeOptions } from '@sentry/node'; import type { NodeOptions } from '@sentry/node';
import type { ErrorEvent, EventHint } from '@sentry/types'; import type { ErrorEvent, EventHint } from '@sentry/types';
@@ -7,8 +8,6 @@ import type { ReportingOptions } from 'n8n-workflow';
import { ApplicationError, ExecutionCancelledError, BaseError } from 'n8n-workflow'; import { ApplicationError, ExecutionCancelledError, BaseError } from 'n8n-workflow';
import { createHash } from 'node:crypto'; import { createHash } from 'node:crypto';
import type { InstanceType } from '@/instance-settings';
type ErrorReporterInitOptions = { type ErrorReporterInitOptions = {
serverType: InstanceType | 'task_runner'; serverType: InstanceType | 'task_runner';
dsn: string; dsn: string;

View File

@@ -1 +1 @@
export { InstanceSettings, InstanceType } from './instance-settings'; export { InstanceSettings } from './instance-settings';

View File

@@ -1,5 +1,6 @@
import { inTest, Logger } from '@n8n/backend-common'; import { inTest, Logger } from '@n8n/backend-common';
import { InstanceSettingsConfig } from '@n8n/config'; import { InstanceSettingsConfig } from '@n8n/config';
import type { InstanceRole, InstanceType } from '@n8n/constants';
import { Memoized } from '@n8n/decorators'; import { Memoized } from '@n8n/decorators';
import { Service } from '@n8n/di'; import { Service } from '@n8n/di';
import { createHash, randomBytes } from 'crypto'; import { createHash, randomBytes } from 'crypto';
@@ -22,10 +23,6 @@ interface WritableSettings {
type Settings = ReadOnlySettings & WritableSettings; type Settings = ReadOnlySettings & WritableSettings;
type InstanceRole = 'unset' | 'leader' | 'follower';
export type InstanceType = 'main' | 'webhook' | 'worker';
@Service() @Service()
export class InstanceSettings { export class InstanceSettings {
/** The path to the n8n folder in which all n8n related data gets saved */ /** The path to the n8n folder in which all n8n related data gets saved */
@@ -60,10 +57,8 @@ export class InstanceSettings {
private readonly config: InstanceSettingsConfig, private readonly config: InstanceSettingsConfig,
private readonly logger: Logger, private readonly logger: Logger,
) { ) {
const command = process.argv[2]; const command = process.argv[2] as InstanceType;
this.instanceType = ['webhook', 'worker'].includes(command) this.instanceType = ['webhook', 'worker'].includes(command) ? command : 'main';
? (command as InstanceType)
: 'main';
this.hostId = `${this.instanceType}-${nanoid()}`; this.hostId = `${this.instanceType}-${nanoid()}`;
this.settings = this.loadOrCreate(); this.settings = this.loadOrCreate();

View File

@@ -22,6 +22,7 @@
{ "path": "../@n8n/decorators/tsconfig.build.json" }, { "path": "../@n8n/decorators/tsconfig.build.json" },
{ "path": "../@n8n/backend-common/tsconfig.build.json" }, { "path": "../@n8n/backend-common/tsconfig.build.json" },
{ "path": "../@n8n/config/tsconfig.build.json" }, { "path": "../@n8n/config/tsconfig.build.json" },
{ "path": "../@n8n/constants/tsconfig.build.json" },
{ "path": "../@n8n/di/tsconfig.build.json" }, { "path": "../@n8n/di/tsconfig.build.json" },
{ "path": "../@n8n/client-oauth2/tsconfig.build.json" } { "path": "../@n8n/client-oauth2/tsconfig.build.json" }
] ]

3
pnpm-lock.yaml generated
View File

@@ -1507,6 +1507,9 @@ importers:
'@n8n/config': '@n8n/config':
specifier: workspace:* specifier: workspace:*
version: link:../@n8n/config version: link:../@n8n/config
'@n8n/constants':
specifier: workspace:*
version: link:../@n8n/constants
'@n8n/decorators': '@n8n/decorators':
specifier: workspace:* specifier: workspace:*
version: link:../@n8n/decorators version: link:../@n8n/decorators